← All questions

record --user stops with: auth.strategy "custom" needs an auth export

auth:
  strategy: custom
  storageState: true

✖ CONFIG_INVALID: auth.strategy "custom" needs an `auth` export in projects/demo-shop/steps/auth.ts.
  hint: export const auth = defineAuth({ strategy: 'custom', login: async ({ page, user }) => { ... } })

2 answers

• 24votes✓

  Accepted answer

  The export, not the file. SDODS looks for steps/auth.ts, steps/auth.js or auth.ts under the project root, imports whichever it finds first, and takes the auth named export or the default export — but only accepts it if it has a login function on it. A module that exports a plain config object, or exports the class instead of an instance, does not match, and you fall through to the yaml strategy. For custom there is nothing to fall through to, hence the error.

  So the fix is usually one line in that file. A full example:

  tsCopy

  import { defineAuth } from '@sdods/core/auth';
  
  export const auth = defineAuth({
    strategy: 'custom',
    async login({ browser, config, user }) {
      const context = await browser.newContext({ baseURL: config.env.ui.baseUrl });
      const page = await context.newPage();
      await page.goto('/');
      await page.getByLabel('Username').fill(user.username);
      await page.getByLabel('Password').fill(user.password);
      await page.getByRole('button', { name: 'Login' }).click();
      await page.waitForURL('**/inventory.html');
      return context;
    },
  });

  Return the context and stop there — SDODS saves the storage state off it and closes it. Once that resolves, --user works for the recorder and for the runner, because both read the same cached file.

  Credentials come off the pool row on user, so nothing in that file is a literal.

  RNanswered by Reeta Nandalmaintainer41,280 · 30 Sept 2022
• 9votes

  One thing to check before you write any of that: if your login is interactive — a second factor, a consent screen, anything a script cannot get through — you do not want custom at all. Declare sso and capture the state with a person in the loop:

  bashCopy

  sdods auth capture -p demo-shop -e staging -u standard --interactive

  That opens codegen, waits for you to finish the login, and saves the storage state.

  Rough rule: custom is for logins you can automate, sso is for the ones you cannot.

  TSanswered by Tobi Schrader97 · 3 Oct 2022