[Storybook] Correct passing global setup variables (#136)

Co-authored-by: Logan Graham <[email protected]>
saucelabs · Sep 12, 2024 · 40cf18e · 40cf18e
1 parent 69838f7
commit 40cf18e
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 16 deletions.
diff --git a/visual-js/.changeset/dry-timers-reply.md b/visual-js/.changeset/dry-timers-reply.md
@@ -0,0 +1,6 @@
+---
+"@saucelabs/visual-playwright": patch
+"@saucelabs/visual-storybook": patch
+---
+
+Correct passing options to global setup
diff --git a/visual-js/visual-playwright/src/api.ts b/visual-js/visual-playwright/src/api.ts
@@ -319,13 +319,21 @@ ${e instanceof Error ? e.message : JSON.stringify(e)}
     });
   }
 
-  public async setup(opts?: VisualEnvOpts) {
+  /**
+   * Method to parse ENVs and bootstrap settings for the runners -- executed once globally.
+   */
+  public globalSetup<T extends VisualEnvOpts>(opts?: Partial<T>) {
     parseOpts();
 
     if (opts) {
       setOpts(opts);
     }
+  }
 
+  /**
+   * Method to instantiate and create a build if not present during worker setup.
+   */
+  public async setup() {
     await downloadDomScript(this.api);
 
     const { buildId: passedBuildId, customId } = getOpts();

diff --git a/visual-js/visual-playwright/src/playwright.ts b/visual-js/visual-playwright/src/playwright.ts
@@ -2,8 +2,12 @@ import VisualPlaywright from './api';
 import type { Page } from 'playwright-core';
 import { TestInfo } from '@playwright/test';
 import { SauceVisualParams } from './types';
+import { VisualEnvOpts } from '@saucelabs/visual';
 
-export const sauceVisualSetup = VisualPlaywright.setup.bind(VisualPlaywright);
+export const sauceVisualSetup = async (opts?: Partial<VisualEnvOpts>) => {
+  VisualPlaywright.globalSetup(opts);
+  return VisualPlaywright.setup();
+};
 export const sauceVisualTeardown =
   VisualPlaywright.teardown.bind(VisualPlaywright);
 export const sauceVisualCheck = async (

diff --git a/visual-js/visual-storybook/src/config.ts b/visual-js/visual-storybook/src/config.ts
@@ -1,18 +1,11 @@
 import type { Config } from '@jest/types';
-import { internals } from '@saucelabs/visual-playwright';
 import { VisualOpts } from './types';
-
-const { setOpts, parseOpts } = internals;
+import { VisualStorybook } from './api';
 
 export const getVisualTestConfig = (
   opts?: Partial<VisualOpts>,
 ): Partial<Config.InitialOptions> => {
-  parseOpts();
-
-  if (opts) {
-    setOpts(opts);
-  }
-
+  VisualStorybook.globalSetup(opts);
   return {
     globalSetup: require.resolve(
       '@saucelabs/visual-storybook/build/config/global-setup.js',

diff --git a/visual-js/yarn.lock b/visual-js/yarn.lock
@@ -3577,13 +3577,13 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@saucelabs/visual-playwright@^0.1.0, @saucelabs/visual-playwright@workspace:visual-playwright":
+"@saucelabs/visual-playwright@^0.1.1, @saucelabs/visual-playwright@workspace:visual-playwright":
   version: 0.0.0-use.local
   resolution: "@saucelabs/visual-playwright@workspace:visual-playwright"
   dependencies:
     "@jest/globals": ^28.0.0 || ^29.0.0
     "@playwright/test": ^1.42.1
-    "@saucelabs/visual": ^0.8.1
+    "@saucelabs/visual": ^0.8.2
     "@storybook/types": ^8.0.2
     "@tsconfig/node18": ^2.0.0
     "@types/node": ^18.13.0
@@ -3612,8 +3612,8 @@ __metadata:
   resolution: "@saucelabs/visual-storybook@workspace:visual-storybook"
   dependencies:
     "@jest/globals": ^28.0.0 || ^29.0.0
-    "@saucelabs/visual": ^0.8.0
-    "@saucelabs/visual-playwright": ^0.1.0
+    "@saucelabs/visual": ^0.8.2
+    "@saucelabs/visual-playwright": ^0.1.1
     "@storybook/test-runner": ">=0.13.0"
     "@storybook/types": ^8.0.2
     "@tsconfig/node18": ^2.0.0
@@ -3642,7 +3642,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@saucelabs/visual@^0.8.0, @saucelabs/visual@^0.8.1, @saucelabs/visual@workspace:visual":
+"@saucelabs/visual@^0.8.0, @saucelabs/visual@^0.8.2, @saucelabs/visual@workspace:visual":
   version: 0.0.0-use.local
   resolution: "@saucelabs/visual@workspace:visual"
   dependencies: