shiplightai 0.1.96 → 0.1.97

package/dist/fixture.d.ts

@@ -9,8 +9,9 @@ import './config.js';
 
 /**
  * Per-test auth: path to a login script + optional args passed to the login function.
- * A relative auth path is resolved against the Playwright project root (config.rootDir),
- * not process.cwd() — see resolveProjectRoot for why the two can diverge.
+ * A relative auth path is resolved against the project root (the directory holding
+ * playwright.config.*), not process.cwd() — see resolveProjectRoot for why the two
+ * can diverge, and resolveUserPath for the fallback to the old testDir anchor.
  * The login module must export a login(args, browser?) function that performs the
  * login flow, caches the storageState, and returns the file path. The fixture passes
  * its shared browser instance — the login function must NOT close it, only its context.
@@ -26,9 +27,10 @@ interface AuthSpec {
     args?: Record<string, unknown>;
 }
 /**
- * Resolve the project root used to anchor relative file paths in tests — most
- * notably the `upload_file` action's `paths`, which the SDK joins against the
- * agent context's `testDataDir` (falling back to `process.cwd()` when unset).
+ * Resolve the project root used to anchor relative file paths a test declares —
+ * `auth`, `extensionDir`, `userDataDir` and `extensionStorageState`. The
+ * `upload_file` action's `paths` are NOT anchored here; they keep the older
+ * rootDir anchor, see resolveTestDataDir for why.
  *
  * Playwright does NOT chdir to the project root: `process.cwd()` is the directory
  * the test command was invoked from, which is not guaranteed to equal the project
@@ -37,11 +39,51 @@ interface AuthSpec {
  * monorepo invocation pointing at a sub-package config. Anchoring uploads to
  * `process.cwd()` breaks in exactly those cases.
  *
- * `testInfo.config.rootDir` is Playwright's own anchor — the directory of the
- * resolved config file — so it tracks the project root regardless of cwd. Fall
- * back to `process.cwd()` only if rootDir is somehow unavailable.
+ * The anchor is the directory holding `playwright.config.*`, taken from
+ * `testInfo.config.configFile`.
+ *
+ * This deliberately does NOT use `testInfo.config.rootDir`. Despite the name,
+ * rootDir is not the project root: Playwright computes it as
+ * `path.resolve(configDir, userConfig.testDir) || configDir`, so any config
+ * carrying the conventional `testDir: './tests'` makes rootDir the *test*
+ * directory. Anchoring there resolved `extensionDir: ./dist` to
+ * `<root>/tests/dist` and left the user with a 2-minute browser-launch timeout
+ * and no diagnostic (issue #2208). rootDir remains the fallback for runs with
+ * no config file, where it equals the directory Playwright started from.
  */
 declare function resolveProjectRoot(testInfo: Pick<TestInfo, 'config'>): string;
+/**
+ * The anchor for the `upload_file` action's relative `paths`, which the SDK
+ * joins against the agent context's `testDataDir`.
+ *
+ * Deliberately still `rootDir`, unlike every other user path. The others name a
+ * FILE, so resolveUserPath can check where it actually is and keep the old
+ * location working. This one is a bare DIRECTORY — the filename only appears
+ * later, inside sdk-core, where the join has no fallback and no existence check
+ * (see agentFile.ts and agentServices.getTestDataFilePath). There is nothing to
+ * probe at fixture time, so moving this anchor would silently relocate every
+ * relative upload fixture with no way to rescue it.
+ *
+ * For projects with no `testDir`, rootDir already equals the config directory,
+ * so this is identical to resolveProjectRoot and nothing is left behind by the
+ * #2208 fix. Moving the upload anchor needs its own change, with a fallback
+ * threaded into sdk-core's join and a deprecation period.
+ */
+declare function resolveTestDataDir(testInfo: Pick<TestInfo, 'config'>): string;
+/**
+ * Resolve a user-provided relative path (auth script, extensionDir, userDataDir,
+ * extensionStorageState) against the project root, falling back to the old
+ * rootDir anchor when the file lives only there.
+ *
+ * Correcting the anchor (see resolveProjectRoot) would otherwise break every
+ * project that had these files under `testDir` — they resolved correctly before
+ * and would start failing on an unchanged test. The new location wins whenever
+ * something is actually there, so the fallback cannot shadow a correct path; it
+ * only rescues layouts that used to work. When neither location has the file,
+ * the project-root path is returned so the resulting error names where the file
+ * is now expected.
+ */
+declare function resolveUserPath(userPath: string, projectRoot: string, legacyRoot: string): string;
 /**
  * Calls the auth module's login(args, browser) function.
  * The login function is responsible for performing the login flow,
@@ -54,7 +96,7 @@ declare function resolveProjectRoot(testInfo: Pick<TestInfo, 'config'>): string;
  * The module is cached by Node's module system after the first import,
  * so multiple tests sharing the same auth path reuse the same instance.
  */
-declare function resolveAuthState(spec: AuthSpec, browser?: Browser, baseURL?: string, projectRoot?: string): Promise<string>;
+declare function resolveAuthState(spec: AuthSpec, browser?: Browser, baseURL?: string, projectRoot?: string, legacyRoot?: string): Promise<string>;
 /**
  * Standard Playwright context-option `use:` keys whose resolved (per-test aware)
  * values we overlay onto `testInfo.project.use`. Must stay identical to the
@@ -212,4 +254,4 @@ type ShiplightFixtures = {
 };
 declare const test: _playwright_test.TestType<_playwright_test.PlaywrightTestArgs & _playwright_test.PlaywrightTestOptions & ShiplightFixtures, _playwright_test.PlaywrightWorkerArgs & _playwright_test.PlaywrightWorkerOptions>;
 
-export { type AuthSpec, EXCLUDED_CONTEXT_OPTION_KEYS, HANDLED_CONTEXT_OPTION_KEYS, SDK_ENV_ALLOWLIST, type TestContext, VIEWPORT_INCOMPATIBLE_OPTIONS, applyVarsOverride, buildSdkEnv, createTestContext, dropViewportIncompatibleOptions, isDeclaredSensitive, mergeResolvedContextOptions, parseVarsOverrideEnv, resolveAuthState, resolveProjectRoot, test };
+export { type AuthSpec, EXCLUDED_CONTEXT_OPTION_KEYS, HANDLED_CONTEXT_OPTION_KEYS, SDK_ENV_ALLOWLIST, type TestContext, VIEWPORT_INCOMPATIBLE_OPTIONS, applyVarsOverride, buildSdkEnv, createTestContext, dropViewportIncompatibleOptions, isDeclaredSensitive, mergeResolvedContextOptions, parseVarsOverrideEnv, resolveAuthState, resolveProjectRoot, resolveTestDataDir, resolveUserPath, test };