rwsdk 1.0.0-beta.0 → 1.0.0-beta.10

package/dist/lib/e2e/constants.d.mts

@@ -0,0 +1,13 @@
+export declare const IS_DEBUG_MODE: string | boolean;
+export declare const SETUP_PLAYGROUND_ENV_TIMEOUT: number;
+export declare const DEPLOYMENT_TIMEOUT: number;
+export declare const DEPLOYMENT_MIN_TRIES: number;
+export declare const DEPLOYMENT_CHECK_TIMEOUT: number;
+export declare const PUPPETEER_TIMEOUT: number;
+export declare const HYDRATION_TIMEOUT: number;
+export declare const DEV_SERVER_TIMEOUT: number;
+export declare const DEV_SERVER_MIN_TRIES: number;
+export declare const SETUP_WAIT_TIMEOUT: number;
+export declare const TEST_MAX_RETRIES: number;
+export declare const TEST_MAX_RETRIES_PER_CODE: number;
+export declare const INSTALL_DEPENDENCIES_RETRIES: number;

package/dist/lib/e2e/constants.mjs

@@ -0,0 +1,67 @@
+export const IS_DEBUG_MODE = process.env.RWSDK_E2E_DEBUG
+    ? process.env.RWSDK_E2E_DEBUG
+    : !process.env.CI;
+export const SETUP_PLAYGROUND_ENV_TIMEOUT = process.env
+    .RWSDK_SETUP_PLAYGROUND_ENV_TIMEOUT
+    ? parseInt(process.env.RWSDK_SETUP_PLAYGROUND_ENV_TIMEOUT, 10)
+    : IS_DEBUG_MODE
+        ? 10 * 60 * 1000
+        : 15 * 60 * 1000;
+export const DEPLOYMENT_TIMEOUT = process.env.RWSDK_DEPLOYMENT_TIMEOUT
+    ? parseInt(process.env.RWSDK_DEPLOYMENT_TIMEOUT, 10)
+    : IS_DEBUG_MODE
+        ? 5 * 30 * 1000
+        : 5 * 60 * 1000;
+export const DEPLOYMENT_MIN_TRIES = process.env.RWSDK_DEPLOYMENT_MIN_TRIES
+    ? parseInt(process.env.RWSDK_DEPLOYMENT_MIN_TRIES, 10)
+    : IS_DEBUG_MODE
+        ? 1
+        : 5;
+export const DEPLOYMENT_CHECK_TIMEOUT = process.env
+    .RWSDK_DEPLOYMENT_CHECK_TIMEOUT
+    ? parseInt(process.env.RWSDK_DEPLOYMENT_CHECK_TIMEOUT, 10)
+    : IS_DEBUG_MODE
+        ? 30 * 1000
+        : 5 * 60 * 1000;
+export const PUPPETEER_TIMEOUT = process.env.RWSDK_PUPPETEER_TIMEOUT
+    ? parseInt(process.env.RWSDK_PUPPETEER_TIMEOUT, 10)
+    : IS_DEBUG_MODE
+        ? 30 * 1000
+        : 60 * 1000 * 2;
+export const HYDRATION_TIMEOUT = process.env.RWSDK_HYDRATION_TIMEOUT
+    ? parseInt(process.env.RWSDK_HYDRATION_TIMEOUT, 10)
+    : IS_DEBUG_MODE
+        ? 2000
+        : 5000;
+export const DEV_SERVER_TIMEOUT = process.env.RWSDK_DEV_SERVER_TIMEOUT
+    ? parseInt(process.env.RWSDK_DEV_SERVER_TIMEOUT, 10)
+    : IS_DEBUG_MODE
+        ? 60 * 1000
+        : 5 * 60 * 1000;
+export const DEV_SERVER_MIN_TRIES = process.env.RWSDK_DEV_SERVER_MIN_TRIES
+    ? parseInt(process.env.RWSDK_DEV_SERVER_MIN_TRIES, 10)
+    : IS_DEBUG_MODE
+        ? 1
+        : 5;
+export const SETUP_WAIT_TIMEOUT = process.env.RWSDK_SETUP_WAIT_TIMEOUT
+    ? parseInt(process.env.RWSDK_SETUP_WAIT_TIMEOUT, 10)
+    : IS_DEBUG_MODE
+        ? 60 * 1000
+        : 10 * 60 * 1000;
+export const TEST_MAX_RETRIES = process.env.RWSDK_TEST_MAX_RETRIES
+    ? parseInt(process.env.RWSDK_TEST_MAX_RETRIES, 10)
+    : IS_DEBUG_MODE
+        ? 1
+        : 10;
+export const TEST_MAX_RETRIES_PER_CODE = process.env
+    .RWSDK_TEST_MAX_RETRIES_PER_CODE
+    ? parseInt(process.env.RWSDK_TEST_MAX_RETRIES_PER_CODE, 10)
+    : IS_DEBUG_MODE
+        ? 0
+        : 6;
+export const INSTALL_DEPENDENCIES_RETRIES = process.env
+    .RWSDK_INSTALL_DEPENDENCIES_RETRIES
+    ? parseInt(process.env.RWSDK_INSTALL_DEPENDENCIES_RETRIES, 10)
+    : IS_DEBUG_MODE
+        ? 1
+        : 10;

package/dist/lib/e2e/environment.d.mts

@@ -3,7 +3,7 @@ import { PackageManager } from "./types.mjs";
 /**
  * Copy project to a temporary directory with a unique name
  */
-export declare function copyProjectToTempDir(projectDir: string, resourceUniqueKey: string, packageManager?: PackageManager, monorepoRoot?: string): Promise<{
+export declare function copyProjectToTempDir(projectDir: string, resourceUniqueKey: string, packageManager?: PackageManager, monorepoRoot?: string, installDependenciesRetries?: number): Promise<{
     tempDir: tmp.DirectoryResult;
     targetDir: string;
     workerName: string;

package/dist/lib/e2e/environment.mjs

@@ -8,9 +8,26 @@ import { basename, join, relative, resolve } from "path";
 import tmp from "tmp-promise";
 import { $ } from "../../lib/$.mjs";
 import { ROOT_DIR } from "../constants.mjs";
+import { INSTALL_DEPENDENCIES_RETRIES } from "./constants.mjs";
 import { retry } from "./retry.mjs";
 const log = debug("rwsdk:e2e:environment");
+const getTempDir = async () => {
+    return tmp.dir({ unsafeCleanup: true });
+};
 const createSdkTarball = async () => {
+    const existingTarballPath = process.env.RWSKD_SMOKE_TEST_TARBALL_PATH;
+    if (existingTarballPath) {
+        if (!fs.existsSync(existingTarballPath)) {
+            throw new Error(`Provided tarball path does not exist: ${existingTarballPath}`);
+        }
+        log(`📦 Using existing tarball: ${existingTarballPath}`);
+        return {
+            tarballPath: existingTarballPath,
+            cleanupTarball: async () => {
+                /* no-op */
+            }, // No-op cleanup
+        };
+    }
     const packResult = await $({ cwd: ROOT_DIR, stdio: "pipe" }) `npm pack`;
     const tarballName = packResult.stdout?.trim();
     const tarballPath = path.join(ROOT_DIR, tarballName);
@@ -33,12 +50,11 @@ const setTarballDependency = async (targetDir, tarballName) => {
 /**
  * Copy project to a temporary directory with a unique name
  */
-export async function copyProjectToTempDir(projectDir, resourceUniqueKey, packageManager, monorepoRoot) {
+export async function copyProjectToTempDir(projectDir, resourceUniqueKey, packageManager, monorepoRoot, installDependenciesRetries) {
     const { tarballPath, cleanupTarball } = await createSdkTarball();
     try {
         log("Creating temporary directory for project");
-        // Create a temporary directory
-        const tempDir = await tmp.dir({ unsafeCleanup: true });
+        const tempDir = await getTempDir();
         // Determine the source directory to copy from
         const sourceDir = monorepoRoot || projectDir;
         // Create unique project directory name
@@ -117,7 +133,6 @@ export async function copyProjectToTempDir(projectDir, resourceUniqueKey, packag
         log("⚙️  Configuring temp project to not use frozen lockfile...");
         const npmrcPath = join(targetDir, ".npmrc");
         await fs.promises.writeFile(npmrcPath, "frozen-lockfile=false\n");
-        // For yarn, create .yarnrc.yml to disable PnP and allow lockfile changes
         if (packageManager === "yarn") {
             const yarnrcPath = join(targetDir, ".yarnrc.yml");
             const yarnCacheDir = path.join(os.tmpdir(), "yarn-cache");
@@ -131,11 +146,19 @@ export async function copyProjectToTempDir(projectDir, resourceUniqueKey, packag
             await fs.promises.writeFile(yarnrcPath, yarnConfig);
             log("Created .yarnrc.yml to allow lockfile changes for yarn");
         }
+        if (packageManager === "yarn-classic") {
+            const yarnrcPath = join(targetDir, ".yarnrc");
+            const yarnCacheDir = path.join(os.tmpdir(), "yarn-classic-cache");
+            await fs.promises.mkdir(yarnCacheDir, { recursive: true });
+            const yarnConfig = `cache-folder "${yarnCacheDir}"`;
+            await fs.promises.writeFile(yarnrcPath, yarnConfig);
+            log("Created .yarnrc with cache-folder for yarn-classic");
+        }
         await setTarballDependency(targetDir, tarballFilename);
         // Install dependencies in the target directory
         const installDir = monorepoRoot ? tempCopyRoot : targetDir;
         await retry(() => installDependencies(installDir, packageManager), {
-            retries: 3,
+            retries: INSTALL_DEPENDENCIES_RETRIES,
             delay: 1000,
         });
         // Return the environment details
@@ -172,7 +195,7 @@ async function installDependencies(targetDir, packageManager = "pnpm") {
             }
             else if (packageManager === "yarn-classic") {
                 log(`Preparing yarn@1.22.19 with corepack...`);
-                await $("corepack", ["prepare", "yarn@1.22.19", "--activate"], {
+                await $("corepack", ["prepare", "yarn@1.x", "--activate"], {
                     cwd: targetDir,
                     stdio: "pipe",
                 });

package/dist/lib/e2e/index.d.mts

@@ -1,3 +1,4 @@
+export * from "../$.mjs";
 export * from "./browser.mjs";
 export * from "./dev.mjs";
 export * from "./environment.mjs";

package/dist/lib/e2e/index.mjs

@@ -1,3 +1,4 @@
+export * from "../$.mjs";
 export * from "./browser.mjs";
 export * from "./dev.mjs";
 export * from "./environment.mjs";

package/dist/lib/e2e/tarball.mjs

@@ -6,6 +6,30 @@ import { adjectives, animals, uniqueNamesGenerator, } from "unique-names-generat
 import { ROOT_DIR } from "../constants.mjs";
 import { copyProjectToTempDir } from "./environment.mjs";
 const log = (message) => console.log(message);
+async function verifyPackedContents(targetDir) {
+    log("  - Verifying installed package contents...");
+    const packageName = "rwsdk";
+    const installedDistPath = path.join(targetDir, "node_modules", packageName, "dist");
+    if (!fs.existsSync(installedDistPath)) {
+        throw new Error(`dist/ directory not found in installed package at ${installedDistPath}.`);
+    }
+    const { stdout: originalDistChecksumOut } = await $("find . -type f | sort | md5sum", {
+        shell: true,
+        cwd: path.join(ROOT_DIR, "dist"),
+    });
+    const originalDistChecksum = originalDistChecksumOut.split(" ")[0];
+    const { stdout: installedDistChecksumOut } = await $("find . -type f | sort | md5sum", {
+        shell: true,
+        cwd: installedDistPath,
+    });
+    const installedDistChecksum = installedDistChecksumOut.split(" ")[0];
+    log(`    - Original dist checksum: ${originalDistChecksum}`);
+    log(`    - Installed dist checksum: ${installedDistChecksum}`);
+    if (originalDistChecksum !== installedDistChecksum) {
+        throw new Error("File list in installed dist/ does not match original dist/.");
+    }
+    log("  ✅ Installed package contents match the local build.");
+}
 /**
  * Copies wrangler cache from monorepo to temp directory for deployment tests
  */
@@ -80,6 +104,7 @@ export async function setupTarballEnvironment({ projectDir, monorepoRoot, packag
     const resourceUniqueKey = `${uniqueNameSuffix}-${hash}`;
     try {
         const { tempDir, targetDir } = await copyProjectToTempDir(projectDir, resourceUniqueKey, packageManager, monorepoRoot);
+        await verifyPackedContents(targetDir);
         // Copy wrangler cache to improve deployment performance
         const sdkRoot = ROOT_DIR;
         await copyWranglerCache(targetDir, sdkRoot);

package/dist/lib/e2e/testHarness.d.mts

@@ -1,8 +1,11 @@
 import { type Browser, type Page } from "puppeteer-core";
 import { test } from "vitest";
+import { DEPLOYMENT_CHECK_TIMEOUT, DEPLOYMENT_MIN_TRIES, DEPLOYMENT_TIMEOUT, DEV_SERVER_MIN_TRIES, DEV_SERVER_TIMEOUT, HYDRATION_TIMEOUT, INSTALL_DEPENDENCIES_RETRIES, PUPPETEER_TIMEOUT, SETUP_PLAYGROUND_ENV_TIMEOUT, SETUP_WAIT_TIMEOUT, TEST_MAX_RETRIES, TEST_MAX_RETRIES_PER_CODE } from "./constants.mjs";
 export type { Browser, Page } from "puppeteer-core";
+export { DEPLOYMENT_CHECK_TIMEOUT, DEPLOYMENT_MIN_TRIES, DEPLOYMENT_TIMEOUT, DEV_SERVER_MIN_TRIES, DEV_SERVER_TIMEOUT, HYDRATION_TIMEOUT, INSTALL_DEPENDENCIES_RETRIES, PUPPETEER_TIMEOUT, SETUP_PLAYGROUND_ENV_TIMEOUT, SETUP_WAIT_TIMEOUT, TEST_MAX_RETRIES, TEST_MAX_RETRIES_PER_CODE, };
 interface DevServerInstance {
     url: string;
+    projectDir: string;
     stopDev: () => Promise<void>;
 }
 interface DeploymentInstance {
@@ -41,17 +44,29 @@ export interface SetupPlaygroundEnvironmentOptions {
  * and installs dependencies using a tarball of the SDK.
  * This ensures that tests run in a clean, isolated environment.
  */
-export declare function setupPlaygroundEnvironment(options?: string | SetupPlaygroundEnvironmentOptions): void;
+export declare function setupPlaygroundEnvironment(options: SetupPlaygroundEnvironmentOptions | string): void;
 /**
  * Creates a dev server instance using the shared playground environment.
  * Automatically registers cleanup to run after the test.
  */
-export declare function createDevServer(projectDir: string): Promise<DevServerInstance>;
+export declare function createDevServer(): {
+    projectDir: string;
+    start: () => Promise<DevServerInstance>;
+};
 /**
  * Creates a deployment instance using the shared playground environment.
  * Automatically registers cleanup to run after the test.
  */
-export declare function createDeployment(projectDir: string): Promise<DeploymentInstance>;
+export declare function createDeployment(): {
+    projectDir: string;
+    start: () => Promise<{
+        url: string;
+        workerName: string;
+        resourceUniqueKey: string;
+        projectDir: string;
+        cleanup: () => Promise<void>;
+    }>;
+};
 /**
  * Executes a test function with a retry mechanism for specific error codes.
  * @param name - The name of the test, used for logging.
@@ -61,13 +76,25 @@ export declare function createDeployment(projectDir: string): Promise<Deployment
  *                     called automatically on failure.
  */
 export declare function runTestWithRetries(name: string, attemptFn: () => Promise<void>): Promise<void>;
+type SDKRunner = (name: string, testLogic: (context: {
+    createDevServer: () => Promise<DevServerInstance>;
+    createDeployment: () => Promise<DeploymentInstance>;
+    browser: Browser;
+    page: Page;
+    projectDir: string;
+}) => Promise<void>) => void;
 declare function createTestRunner(testFn: (typeof test | typeof test.only)["concurrent"], envType: "dev" | "deploy"): (name: string, testLogic: (context: {
     devServer?: DevServerInstance;
     deployment?: DeploymentInstance;
     browser: Browser;
     page: Page;
     url: string;
+    projectDir: string;
 }) => Promise<void>) => void;
+export declare const testSDK: SDKRunner & {
+    only: SDKRunner;
+    skip: typeof test.skip;
+};
 /**
  * High-level test wrapper for dev server tests.
  * Automatically skips if RWSDK_SKIP_DEV=1
@@ -81,6 +108,7 @@ export declare namespace testDev {
         browser: Browser;
         page: Page;
         url: string;
+        projectDir: string;
     }) => Promise<void>) => void;
 }
 /**
@@ -96,6 +124,7 @@ export declare namespace testDeploy {
         browser: Browser;
         page: Page;
         url: string;
+        projectDir: string;
     }) => Promise<void>) => void;
 }
 /**
@@ -108,6 +137,7 @@ export declare function testDevAndDeploy(name: string, testFn: (context: {
     browser: Browser;
     page: Page;
     url: string;
+    projectDir: string;
 }) => Promise<void>): void;
 export declare namespace testDevAndDeploy {
     var skip: (name: string, testFn?: any) => void;