Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ct): vue type safe mount props #23151

Merged
merged 2 commits into from
Aug 1, 2023
Merged

feat(ct): vue type safe mount props #23151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e1720d
feat(ct): vue type safe mount props
sand4rt May 18, 2023
3f42ed6
chore(vue): remove vue-component-type-helpers
sand4rt Jul 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions packages/playwright-ct-vue/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,21 +35,31 @@ export type PlaywrightTestConfig<T = {}, W = {}> = Omit<BasePlaywrightTestConfig
};
};

type Slot = string | string[];
type ComponentSlot = string | string[];
type ComponentSlots = Record<string, ComponentSlot> & { default?: ComponentSlot };

export interface MountOptions<
HooksConfig extends JsonObject,
Props extends Record<string, unknown>
> {
props?: Props;
slots?: Record<string, Slot> & { default?: Slot };
on?: Record<string, Function>;
type ComponentEvents = Record<string, Function>;

// Copied from: https://github.com/vuejs/language-tools/blob/master/packages/vue-component-type-helpers/index.d.ts#L10-L13
type ComponentProps<T> =
T extends new () => { $props: infer P; } ? NonNullable<P> :
T extends (props: infer P, ...args: any) => any ? P :
{};

export interface MountOptions<HooksConfig extends JsonObject, Component> {
props?: ComponentProps<Component>;
slots?: ComponentSlots;
on?: ComponentEvents;
hooksConfig?: HooksConfig;
}

interface MountResult<Props extends Record<string, unknown>> extends Locator {
interface MountResult<Component> extends Locator {
unmount(): Promise<void>;
update(options: Omit<MountOptions<never, Props>, 'hooksConfig'>): Promise<void>;
update(options: {
props?: Partial<ComponentProps<Component>>;
slots?: Partial<ComponentSlots>;
on?: Partial<ComponentEvents>;
}): Promise<void>;
}

interface MountResultJsx extends Locator {
Expand All @@ -59,27 +69,17 @@ interface MountResultJsx extends Locator {

export interface ComponentFixtures {
mount(component: JSX.Element): Promise<MountResultJsx>;
mount<HooksConfig extends JsonObject>(
component: any,
options?: MountOptions<HooksConfig, Record<string, unknown>>
): Promise<MountResult<Record<string, unknown>>>;
mount<
HooksConfig extends JsonObject,
Props extends Record<string, unknown> = Record<string, unknown>
>(
component: any,
options: MountOptions<HooksConfig, never> & { props: Props }
): Promise<MountResult<Props>>;
mount<HooksConfig extends JsonObject, Component = unknown>(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you think this will break existing clients? or do we want to break them with these stricter types?

Copy link
Collaborator Author

@sand4rt sand4rt May 23, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you think this will break existing clients?

A subset of existing clients using the Vue object API could see some type errors:

  1. When the prop is manually passed to the mount<_, Props>() generic.

  2. When a required prop is missing or when a wrong prop type passed to the mount().

  3. When a invalid prop or non existing type is passed to component.update()

do we want to break them with these stricter types?

IMO yes. It is cumbersome to specify prop types manually.

When a wrong prop type is passed I think it would be good to know that immediately instead of running the test and checking if Vue logged anything to the console.

I think it's also useful to have autocompletion on both mount() and component.update().

component: Component,
options?: MountOptions<HooksConfig, Component>
): Promise<MountResult<Component>>;
}

export const test: TestType<
PlaywrightTestArgs & PlaywrightTestOptions & ComponentFixtures,
PlaywrightWorkerArgs & PlaywrightWorkerOptions
>;

/**
* Defines Playwright config
*/
export function defineConfig(config: PlaywrightTestConfig): PlaywrightTestConfig;
export function defineConfig<T>(config: PlaywrightTestConfig<T>): PlaywrightTestConfig<T>;
export function defineConfig<T, W>(config: PlaywrightTestConfig<T, W>): PlaywrightTestConfig<T, W>;
Expand Down
2 changes: 1 addition & 1 deletion tests/components/ct-vue-vite/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"extends": "@vue/tsconfig/tsconfig.web.json",
"include": ["env.d.ts", "src/**/*", "src/**/*.vue", "playwright"],
"include": ["env.d.ts", "src/**/*", "src/**/*.vue", "tests/**/*", "playwright"],
"compilerOptions": {
"baseUrl": ".",
"paths": {
Expand Down