[Feature]: Support for Passing Parameters to `workerFixture`

[bubafinder]

🚀 Feature Request

Is it possible to introduce a way to pass parameters to the workerFixture? Maybe it could be done via project settings or some other mechanism.

I haven’t explored in depth how this could technically be achieved or whether it’s currently feasible within the framework, but having this capability would significantly increase the flexibility and usability of worker fixtures, even if it adds a bit of complexity.

Example

Send a parameter to the worker fixture from the project settings in the Playwright config. That parameter should be used for some logic, for example, if true is sent, use one credentials set, if false, use another credentials set.

Motivation

In my test suite, I have multiple test sets scoped by project, and each project uses specific credentials. If I could pass project-specific parameters into the workerFixture, it would simplify credential handling. I don't know how to set it currently.

[agg23]

What would passing this parameter look like? Can you use environment variables?

[dgozman]

@bubafinder Take a look at fixtures-options. To make an option available to a worker fixture, just mark it as scope: 'worker' like you would for a worker fixture itself. Please let me know whether this helps.

[bubafinder]

First, I'm not even sure if this is possible, just throwing out some ideas that I think could help me parameterize certain things.

I'm thinking along the lines that Playwright orchestrates and runs all tests, including handling configurations. So it feels natural to me that I should be able to pass in some kind of parameter to the workerFixture at the beginning through the playwright.config.

Maybe something like:
playwright.config.ts

projects: [
    {
      name: 'adminTests',
      use: {
        role: 'admin'
      },
    },
]

Then, in the extended test, I can pass role value to the workerStorageState (workerFixture):
base.ts

export const test = base.extend
({
role: ['learner', { option: true }],
storageState: ({ workerStorageState }, use) =>
    use(workerStorageState.storagePath),
workerStorageState: [
    async ({ browser }, use) => {
      const signInPage = new SignInPage(page);
      await signInPage.signIn(roleWorkerFixture)
      await use(claimWavePage);,
    { scope: 'worker' },
  ],
});

[agg23]

You almost exactly described how fixture options work:

playwright.config.ts

projects: [
    {
      name: 'adminTests',
      use: {
        role: 'admin'
      },
    },
]

export const test = base.extend
({
// You were missing `scope: 'worker'` to make this option available to the worker fixture
role: ['learner', { option: true, scope: 'worker' }],
workerStorageState: [
    async ({ browser, role }, use) => {
      const signInPage = new SignInPage(page);
      // Actually use the role
      await signInPage.signIn(role)
      await use(claimWavePage);,
    { scope: 'worker' },
  ],
});

[bubafinder]

But I can't set the value inside the projects?

projects: [
    {
      name: 'adminTests',
      use: {
        role: 'admin'
      },
    },
]

[bubafinder]

@bubafinder Take a look at fixtures-options. To make an option available to a worker fixture, just mark it as scope: 'worker' like you would for a worker fixture itself. Please let me know whether this helps.

I tried when @dgozman sent the message.

[agg23]

Are you wrapping your config file in defineConfig with a custom options type? We show an example of that on the Fixtures-options docs.

export type MyOptions = {
  role: string;
};

export const test = base.extend<MyOptions>({
  role: ['learner', { option: true, scope: 'worker' }],
});

defineConfig<MyOptions>({
  projects: [
    {
      name: 'adminTests',
      use: {
        role: 'admin'
      },
    },
  ]
});

[bubafinder]

Was not, but I am now.
Still experiencing some TS error.
It looks like it works as expected when tests are run, so I just need to track the TS error. If anyone has any idea what the problem is 🙏🏻
Thx @agg23 @dgozman

[dgozman]

@bubafinder You probably need to replace base.extend<MyOptions> with base.extend<MyTestScopedOptions, MyWorkerScopedOptions> to indicate which options/fixtures are test-scoped vs worker-scoped.

[bubafinder]

@dgozman I've done it already, this is something I did understand previously. Maybe I need to bump the Playwright version. I am currently on 1.43.1, but I can't bump it because the app node version is v18.

[bubafinder]

Ah, the Playwright version doesn't make sense.
The good thing is, it is working when I run tests, I only have the TS errors now 🤷🏻‍♂️

[dgozman]

@bubafinder Not sure how to help you further. If you would share your whole repro, so that we can see locally, that would be great. Otherwise I'll have to close the issue.

[bubafinder]

Can't share the repo because it is a private repo of the client.

Here is an example of both files. I know it is not the same as you debugging in my project, but I cannot share it, unfortunately.

https://gist.github.com/bubafinder/e98e57d289c92c7fbeb444e214968336

[bubafinder]

Error in lines
https://gist.github.com/bubafinder/e98e57d289c92c7fbeb444e214968336#file-base-ts-L34
https://gist.github.com/bubafinder/e98e57d289c92c7fbeb444e214968336#file-base-ts-L35

Error message:

Type '[false, { option: true; scope: "worker"; }]' is not assignable to type '[WorkerFixtureValue<boolean, WorkerOptions & PlaywrightWorkerArgs & PlaywrightWorkerOptions>, { ...; }] & (TestFixtureValue<...> | [...])'.

Type '[false, { option: true; scope: "worker"; }]' is not assignable to type '[WorkerFixtureValue<boolean, WorkerOptions & PlaywrightWorkerArgs & PlaywrightWorkerOptions>, { ...; }] & [...]'.

Type '[false, { option: true; scope: "worker"; }]' is not assignable to type '[TestFixtureValue<boolean, TestOptions & WorkerOptions & PlaywrightTestArgs & PlaywrightTestOptions & PlaywrightWorkerArgs & PlaywrightWorkerOptions>, { ...; }]'.

Type at position 1 in source is not compatible with type at position 1 in target.

The types of 'scope' are incompatible between these types.

Type '"worker"' is not assignable to type '"test"'.ts(2322)

The expected type comes from property 'isSmokeTest' which is declared here on type 'Fixtures<TestOptions, WorkerOptions, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>'
(property) isSmokeTest?: [WorkerFixtureValue<boolean, WorkerOptions & PlaywrightWorkerArgs & PlaywrightWorkerOptions>, {
    ...;
}] & (TestFixtureValue<...> | [...])

[dgozman]

@bubafinder You've got isSmokeTest and role declared both in WorkerOptions and TestOptions. You should pick just one 😄