rwsdk 0.1.16 → 0.1.17

package/dist/lib/smokeTests/templates/SmokeTest.template.js

@@ -0,0 +1,81 @@
+export function getSmokeTestTemplate(skipClient = false) {
+    return `
+import React from "react";
+import { RequestInfo } from "rwsdk/worker";
+${skipClient ? "" : 'import { SmokeTestClient } from "./__SmokeTestClient";'}
+import { getSmokeTestTimestamp } from "./__smokeTestFunctions";
+
+export const SmokeTestInfo: React.FC = async () => {
+  const currentTime = Date.now();
+  let status = "error";
+  let timestamp = 0;
+
+  try {
+    const result = await getSmokeTestTimestamp();
+    status = result.status || "error";
+    timestamp = result.timestamp;
+  } catch (error) {
+    console.error("Smoke test failed:", error);
+    status = "error";
+  }
+
+  return (
+    <div
+      id="smoke-test-container"
+      data-testid="health-status"
+      data-status={status}
+      data-timestamp={timestamp}
+      data-server-timestamp={currentTime}
+      style={{
+        fontFamily: "system-ui, -apple-system, sans-serif",
+        margin: "20px",
+        padding: "15px",
+        border: "1px solid #ddd",
+        borderRadius: "4px",
+        background: "#f9f9f9",
+      }}
+    >
+      <h2
+        style={{
+          color: status === "ok" ? "#0c9" : "#f44",
+          margin: "0 0 10px 0",
+        }}
+      >
+        Smoke Test: {status}
+      </h2>
+      <div
+        id="smoke-test-result"
+      >
+        Server Timestamp: {timestamp}
+      </div>
+      
+      {/* HMR Testing Marker - Do not modify this comment */}
+      <div 
+        id="server-hmr-marker"
+        data-testid="server-hmr-marker"
+        data-hmr-text="original"
+        data-hmr-timestamp={Date.now()}
+      >
+        Server Component HMR: <span>Original Text</span>
+      </div>
+      
+      <details style={{ marginTop: "10px" }}>
+        <summary>Details</summary>
+        <pre
+          style={{
+            background: "#f5f5f5",
+            padding: "10px",
+            borderRadius: "4px",
+            fontSize: "12px",
+            overflow: "auto",
+          }}
+        >
+          {JSON.stringify({ currentTime, serverTimestamp: timestamp, status }, null, 2)}
+        </pre>
+      </details>
+
+      ${!skipClient ? "<SmokeTestClient/>" : ""}
+    </div>
+  );
+};`;
+}

package/dist/lib/smokeTests/templates/SmokeTestClient.template.d.ts

@@ -0,0 +1 @@
+export declare function getSmokeTestClientTemplate(): string;

package/dist/lib/smokeTests/templates/SmokeTestClient.template.js

@@ -0,0 +1,159 @@
+export function getSmokeTestClientTemplate() {
+    return `"use client";
+
+import React, { useState } from "react";
+import { smokeTestAction } from "./__smokeTestFunctions";
+
+interface SmokeTestStatus {
+  status: string;
+  verificationPassed: boolean;
+  timestamp: number;
+  rawResult?: unknown;
+  error?: string;
+}
+
+interface SmokeTestResponse {
+  status: string;
+  timestamp?: number;
+  [key: string]: unknown;
+}
+
+export const SmokeTestClient: React.FC = () => {
+  const [loading, setLoading] = useState(false);
+  const [lastCheck, setLastCheck] = useState<SmokeTestStatus | null>(null);
+
+  const runSmokeTest = async () => {
+    setLoading(true);
+    const clientTimestamp = Date.now();
+
+    try {
+      // Update the server timestamp with our client timestamp
+      const result = await smokeTestAction(clientTimestamp);
+      const status = result.status || "error";
+      const verificationPassed = result.timestamp === clientTimestamp;
+
+      setLastCheck({
+        status,
+        verificationPassed,
+        timestamp: clientTimestamp,
+        rawResult: result,
+      });
+    } catch (error) {
+      setLastCheck({
+        status: "error",
+        verificationPassed: false,
+        timestamp: clientTimestamp,
+        error: error instanceof Error ? error.message : String(error),
+      });
+    } finally {
+      setLoading(false);
+    }
+  };
+
+  return (
+    <div
+      className="smoke-test-client"
+      style={{
+        margin: "20px 0",
+        padding: "15px",
+        border: "1px solid #ddd",
+        borderRadius: "4px",
+        background: "#f9f9f9",
+        fontFamily: "system-ui, -apple-system, sans-serif",
+      }}
+    >
+      <h3>Manual Smoke Test</h3>
+      <button
+        data-testid="refresh-health"
+        onClick={runSmokeTest}
+        disabled={loading}
+        style={{
+          padding: "8px 16px",
+          background: loading ? "#ccc" : "#0070f3",
+          color: "white",
+          border: "none",
+          borderRadius: "4px",
+          cursor: loading ? "not-allowed" : "pointer",
+          fontWeight: "bold",
+        }}
+      >
+        {loading ? "Checking..." : "Run Smoke Test"}
+      </button>
+
+      {/* HMR Testing Marker - Do not modify this comment */}
+      <div 
+        id="client-hmr-marker"
+        data-testid="client-hmr-marker"
+        data-hmr-text="original"
+        data-hmr-timestamp={Date.now()}
+      >
+        Client Component HMR: <span>Original Text</span>
+      </div>
+
+      {lastCheck && (
+        <div style={{ marginTop: "15px" }}>
+          <div
+            style={{
+              padding: "10px",
+              borderRadius: "4px",
+              background: lastCheck.status === "ok" ? "#e6f7ee" : "#ffeded",
+              border: \`1px solid \${
+                lastCheck.status === "ok" ? "#0c9" : "#f44"
+              }\`,
+            }}
+          >
+            <h4
+              style={{
+                margin: "0 0 10px 0",
+                color: lastCheck.status === "ok" ? "#0c9" : "#f44",
+              }}
+            >
+              Status: {lastCheck.status}
+            </h4>
+            <p>
+              Server timestamp updated to: {lastCheck.timestamp}
+            </p>
+            <p>
+              Timestamp verification:{" "}
+              {lastCheck.verificationPassed ? "Passed ✅" : "Failed ⚠️"}
+            </p>
+            {lastCheck.error && (
+              <p style={{ color: "#f44" }}>Error: {lastCheck.error}</p>
+            )}
+            <details style={{ marginTop: "10px" }}>
+              <summary>Raw Result</summary>
+              <pre
+                style={{
+                  background: "#f5f5f5",
+                  padding: "10px",
+                  borderRadius: "4px",
+                  fontSize: "12px",
+                  overflow: "auto",
+                }}
+              >
+                {JSON.stringify(
+                  {
+                    timestamp: lastCheck.timestamp,
+                    result: lastCheck.rawResult,
+                    verificationPassed: lastCheck.verificationPassed,
+                  },
+                  null,
+                  2
+                )}
+              </pre>
+            </details>
+          </div>
+        </div>
+      )}
+
+      <div 
+        id="smoke-test-client-timestamp"
+        data-client-timestamp={lastCheck?.timestamp ?? ""}
+        data-status={lastCheck?.status ?? ""}
+        data-verified={lastCheck?.verificationPassed ? "true" : "false"}
+        style={{ display: "none" }}
+      />
+    </div>
+  );
+};`;
+}

package/dist/lib/smokeTests/templates/smokeTestFunctions.template.d.ts

@@ -0,0 +1 @@
+export declare function getSmokeTestFunctionsTemplate(): string;

package/dist/lib/smokeTests/templates/smokeTestFunctions.template.js

@@ -0,0 +1,19 @@
+export function getSmokeTestFunctionsTemplate() {
+    return `"use server";
+
+// Module-level variable to store the timestamp set by client
+// Initialize with a fixed value to verify initial server render
+let serverTimestamp: number = 23;
+
+// Function to retrieve the current server timestamp
+export async function getSmokeTestTimestamp(): Promise<{ timestamp: number, status: string }> {
+  return { timestamp: serverTimestamp, status: "ok" };
+}
+
+export async function smokeTestAction(timestamp: number): Promise<unknown> {
+  await new Promise((resolve) => setTimeout(resolve, 0));
+  serverTimestamp = timestamp;
+  return { status: "ok", timestamp };
+}
+`;
+}

package/dist/lib/smokeTests/types.d.mts

@@ -0,0 +1,75 @@
+import { WriteStream } from "fs";
+export interface SmokeTestResult {
+    status: string;
+    verificationPassed: boolean;
+    timestamp?: number;
+    rawResult?: unknown;
+    error?: string;
+    serverTimestamp?: number;
+    clientTimestamp?: number;
+}
+export interface SmokeTestOptions {
+    customPath?: string;
+    skipDev?: boolean;
+    skipRelease?: boolean;
+    skipClient?: boolean;
+    projectDir?: string;
+    artifactDir?: string;
+    keep?: boolean;
+    headless?: boolean;
+    sync?: boolean;
+    ci?: boolean;
+    bail?: boolean;
+    copyProject?: boolean;
+    realtime?: boolean;
+    skipHmr?: boolean;
+}
+export interface TestResources {
+    tempDirCleanup?: () => Promise<void>;
+    workerName?: string;
+    originalCwd: string;
+    targetDir?: string;
+    workerCreatedDuringTest: boolean;
+    stopDev?: () => Promise<void>;
+    resourceUniqueKey: string;
+}
+export interface StreamCapturer {
+    stdoutLogFile: WriteStream | null;
+    stderrLogFile: WriteStream | null;
+    combinedLogFile: WriteStream | null;
+    originalStdoutWrite: (chunk: Uint8Array | string, encoding?: BufferEncoding, callback?: (error?: Error | null) => void) => boolean;
+    originalStderrWrite: (chunk: Uint8Array | string, encoding?: BufferEncoding, callback?: (error?: Error | null) => void) => boolean;
+    start: (artifactDir: string) => void;
+    stop: () => void;
+}
+export interface TestStatus {
+    dev: {
+        overall: string;
+        initialServerSide: string;
+        initialClientSide: string;
+        initialServerRenderCheck: string;
+        realtimeUpgrade: string;
+        realtimeServerSide: string;
+        realtimeClientSide: string;
+        realtimeServerRenderCheck: string;
+        initialServerHmr: string;
+        initialClientHmr: string;
+        realtimeServerHmr: string;
+        realtimeClientHmr: string;
+    };
+    production: {
+        overall: string;
+        releaseCommand: string;
+        initialServerSide: string;
+        initialClientSide: string;
+        initialServerRenderCheck: string;
+        realtimeUpgrade: string;
+        realtimeServerSide: string;
+        realtimeClientSide: string;
+        realtimeServerRenderCheck: string;
+        initialServerHmr: string;
+        initialClientHmr: string;
+        realtimeServerHmr: string;
+        realtimeClientHmr: string;
+    };
+}

package/dist/lib/smokeTests/types.mjs

@@ -0,0 +1 @@
+export {};

package/dist/lib/smokeTests/utils.d.mts

@@ -0,0 +1,15 @@
+import { log } from "./constants.mjs";
+export { log };
+export declare function isRunningInCI(ciFlag?: boolean): boolean;
+/**
+ * Handles test failure by logging the error and initiating teardown
+ */
+export declare function fail(error: unknown, exitCode?: number, step?: string): Promise<never>;
+/**
+ * Handles resource teardown and exits the process with appropriate exit code
+ */
+export declare function teardown(): Promise<void>;
+/**
+ * Formats the path suffix from a custom path
+ */
+export declare function formatPathSuffix(customPath?: string): string;

package/dist/lib/smokeTests/utils.mjs

@@ -0,0 +1,147 @@
+import { setTimeout } from "node:timers/promises";
+import { join } from "path";
+import { log } from "./constants.mjs";
+import { mkdirp } from "fs-extra";
+import { state } from "./state.mjs";
+import { generateFinalReport } from "./reporting.mjs";
+import { cleanupResources } from "./cleanup.mjs";
+// Re-export log from constants
+export { log };
+// Helper function to detect if running in CI environment
+export function isRunningInCI(ciFlag = false) {
+    return (ciFlag ||
+        !!process.env.CI ||
+        !!process.env.GITHUB_ACTIONS ||
+        !!process.env.GITLAB_CI ||
+        !!process.env.CIRCLECI);
+}
+/**
+ * Handles test failure by logging the error and initiating teardown
+ */
+export async function fail(error, exitCode = 1, step) {
+    state.exitCode = exitCode;
+    const msg = error instanceof Error ? error.message : String(error);
+    console.error(`❌ Smoke test failed: ${msg}`);
+    log("Test failed with error: %O", error);
+    // Record the failure if a step is provided
+    if (step) {
+        // Determine the environment context if not explicitly in the step name
+        let enhancedStep = step;
+        if (!step.toLowerCase().includes("development") &&
+            !step.toLowerCase().includes("production") &&
+            !step.toLowerCase().includes("dev server")) {
+            // For server/client side tests with phase info, add environment context
+            const isInReleasePhase = state.failures.some((f) => f.step.includes("Release Command") ||
+                f.step.includes("Release Test")) || state.options.skipDev; // If dev is skipped, we're in release phase
+            if (isInReleasePhase) {
+                enhancedStep = `Production - ${step}`;
+            }
+            else {
+                enhancedStep = `Development - ${step}`;
+            }
+        }
+        state.failures.push({
+            step: enhancedStep,
+            error: msg,
+            details: error instanceof Error && error.stack ? error.stack : undefined,
+        });
+    }
+    // Ensure artifactDir exists if it's defined but hasn't been created yet
+    if (state.options.artifactDir) {
+        try {
+            // Create the main artifacts directory and reports subdirectory if they don't exist
+            await mkdirp(state.options.artifactDir);
+            await mkdirp(join(state.options.artifactDir, "reports"));
+            log("Ensured artifact directories exist before teardown");
+        }
+        catch (dirError) {
+            log("Error ensuring artifact directories exist: %O", dirError);
+            // Non-fatal, continue to teardown
+        }
+    }
+    try {
+        // Generate a report before starting teardown to ensure we have at least one report
+        await generateFinalReport();
+        // Then proceed with teardown
+        await teardown();
+    }
+    catch (teardownError) {
+        // If teardown itself fails, log the error
+        console.error(`Error during teardown: ${teardownError instanceof Error ? teardownError.message : String(teardownError)}`);
+        // Set a short timeout to allow any pending operations to complete
+        await setTimeout(500);
+    }
+    // Set a short delay to allow report to be written
+    await setTimeout(500);
+    return process.exit(exitCode);
+}
+/**
+ * Handles resource teardown and exits the process with appropriate exit code
+ */
+export async function teardown() {
+    // Prevent multiple teardowns running simultaneously
+    if (state.isTearingDown) {
+        log("Teardown already in progress, skipping duplicate call");
+        return;
+    }
+    state.isTearingDown = true;
+    log("Starting teardown process with exit code: %d", state.exitCode);
+    try {
+        // First, generate a report, before any cleanup happens
+        // This ensures we have at least some report even if cleanup fails
+        await generateFinalReport();
+        // Then try to cleanup resources
+        try {
+            await cleanupResources(state.resources, state.options);
+            log("Resource cleanup completed successfully");
+        }
+        catch (cleanupError) {
+            log("Error during resource cleanup: %O", cleanupError);
+            console.error(`Error during resource cleanup: ${cleanupError instanceof Error ? cleanupError.message : String(cleanupError)}`);
+            // Add this error to our failures list
+            state.failures.push({
+                step: "Resource Cleanup",
+                error: cleanupError instanceof Error
+                    ? cleanupError.message
+                    : String(cleanupError),
+                details: cleanupError instanceof Error && cleanupError.stack
+                    ? cleanupError.stack
+                    : undefined,
+            });
+            // Set exit code to 1 if it wasn't already set
+            if (state.exitCode === 0)
+                state.exitCode = 1;
+        }
+    }
+    catch (error) {
+        log("Error during teardown: %O", error);
+        console.error(`Error during teardown: ${error instanceof Error ? error.message : String(error)}`);
+        // Set exit code to 1 if it wasn't already set
+        if (state.exitCode === 0)
+            state.exitCode = 1;
+        // Try generating report even if an error occurred
+        try {
+            await generateFinalReport();
+        }
+        catch (reportError) {
+            console.error("Failed to generate report after teardown error:", reportError);
+        }
+    }
+    finally {
+        // Make sure log capturing is stopped before exiting
+        log("Log capturing stopped during teardown");
+        process.exit(state.exitCode);
+    }
+}
+/**
+ * Formats the path suffix from a custom path
+ */
+export function formatPathSuffix(customPath) {
+    const suffix = customPath
+        ? customPath.startsWith("/")
+            ? customPath
+            : `/${customPath}`
+        : "";
+    log("Formatted path suffix: %s", suffix);
+    return suffix;
+}

package/dist/llms/index.d.ts

@@ -0,0 +1,3 @@
+import type { PackageRuleItem } from "vibe-rules";
+declare const rules: PackageRuleItem[];
+export default rules;

package/dist/llms/index.js

@@ -0,0 +1,35 @@
+import { interruptors } from "./rules/interruptors.js";
+import { middleware } from "./rules/middleware.js";
+import { react } from "./rules/react.js";
+import { requestResponse } from "./rules/request-response.js";
+const rules = [
+    {
+        name: "rwsdk-interruptors",
+        description: "RedwoodSDK: Request Interruptors",
+        rule: interruptors,
+        alwaysApply: false,
+        globs: ["worker.tsx", "src/app/**/routes.ts", "src/app/**/*/routes.ts"],
+    },
+    {
+        name: "rwsdk-middleware",
+        description: "RedwoodSDK: Middleware",
+        rule: middleware,
+        alwaysApply: false,
+        globs: ["worker.tsx", "middleware.ts", "middleware.tsx"],
+    },
+    {
+        name: "rwsdk-react",
+        description: "RedwoodSDK: React, React Server Components, and React Server Functions Rules",
+        rule: react,
+        alwaysApply: false,
+        globs: ["src/app/**/*/*.tsx", "Document.tsx"],
+    },
+    {
+        name: "rwsdk-request-response",
+        description: "RedwoodSDK: Request handling and responses",
+        rule: requestResponse,
+        alwaysApply: false,
+        globs: ["worker.tsc", "src/app/**/routes.ts", "src/app/**/*/routes.ts"],
+    },
+];
+export default rules;

package/dist/llms/rules/interruptors.d.ts

@@ -0,0 +1 @@
+export declare const interruptors = "\n\n# RedwoodSDK: Request Interruptors\n\nYou're an expert at Cloudflare, TypeScript, and building web apps with RedwoodSDK. Generate high quality **RedwoodSDK interruptors** (middleware functions) that adhere to the following best practices:\n\n## Guidelines\n\n1. Create focused, single-responsibility interruptors\n2. Organize interruptors in dedicated files (e.g., `interruptors.ts`, `interceptors.ts`, or `middleware.ts`)\n3. Compose interruptors to create more complex validation chains\n4. Use typed parameters and return values\n5. Include clear error handling and user feedback\n\n## What are Interruptors?\n\nInterruptors are middleware functions that run before your route handlers. They can:\n\n- Validate user authentication and authorization\n- Transform request data\n- Validate inputs\n- Rate limit requests\n- Log activity\n- Redirect users based on conditions\n- Short-circuit request handling with early responses\n\n## Example Templates\n\n### Basic Interruptor Structure\n\n```tsx\nasync function myInterruptor({ request, params, ctx }) {\n  // Perform checks or transformations here\n\n  // Return modified context to pass to the next interruptor or handler\n  ctx.someAddedData = \"value\";\n\n  // OR return a Response to short-circuit the request\n  // return new Response('Unauthorized', { status: 401 });\n}\n```\n\n### Authentication Interruptors\n\n```tsx\nexport async function requireAuth({ request, ctx }) {\n  if (!ctx.user) {\n    return new Response(null, {\n      status: 302,\n      headers: { Location: \"/user/login\" },\n    });\n  }\n}\n\nexport async function requireAdmin({ request, ctx }) {\n  if (!ctx?.user?.isAdmin) {\n    return new Response(null, {\n      status: 302,\n      headers: { Location: \"/user/login\" },\n    });\n  }\n}\n```\n\n### Input Validation Interruptor\n\n```tsx\nimport { z } from \"zod\";\n\n// Create a reusable validator interruptor\nexport function validateInput(schema) {\n  return async function validateInputInterruptor({ request, ctx }) {\n    try {\n      const data = await request.json();\n      const validated = (ctx.data = schema.parse(data));\n    } catch (error) {\n      return Response.json(\n        { error: \"Validation failed\", details: error.errors },\n        { status: 400 },\n      );\n    }\n  };\n}\n\n// Usage example with a Zod schema\nconst userSchema = z.object({\n  name: z.string().min(2),\n  email: z.string().email(),\n  age: z.number().min(18).optional(),\n});\n\nexport const validateUser = validateInput(userSchema);\n```\n\n### Logging Interruptor\n\n```tsx\nexport async function logRequests({ request, ctx }) {\n  const start = Date.now();\n\n  // Add a function to the context that will log when called\n  ctx.logCompletion: (response) => {\n      const duration = Date.now() - start;\n      const status = response.status;\n      console.log(\n        `${request.method} ${request.url} - ${status} (${duration}ms)`,\n      );\n    },\n  };\n}\n\n// Usage in a route handler\nroute('/', [\n  logRequests,\n  async ({request, ctx}) => {\n    // Call the logging function\n    ctx.logCompletion(response);\n    return Response.json({ success: true });;\n  },\n]);\n```\n\n### Composing Multiple Interruptors\n\n```tsx\nimport { route } from \"rwsdk/router\";\nimport {\n  requireAuth,\n  validateUser,\n  apiRateLimit,\n  logRequests,\n} from \"@/app/interruptors\";\n\n// Combine multiple interruptors\nroute(\"/api/users\", [\n    logRequests, // Log all requests\n    requireAuth, // Ensure user is authenticated\n    validateUser, // Validate user input\n    async ({ request, ctx }) => {\n      // Handler receives validated data and session from interruptors\n      const newUser = await db.user.create({\n        data: {\n          /* ... */,\n          createdBy: ctx.user.userId,\n        },\n      });\n\n      return Response.json(newUser, { status: 201 });\n    },\n  ],\n});\n```\n\n### Role-Based Access Control\n\n```tsx\nimport { getSession } from \"rwsdk/auth\";\n\n// Create a function that generates role-based interruptors\nexport function hasRole(allowedRoles) {\n  return async function hasRoleInterruptor({ request, ctx }) {\n    const session = await getSession(request);\n\n    if (!session) {\n      return Response.redirect(\"/login\");\n    }\n\n    if (!allowedRoles.includes(session.role)) {\n      return Response.json({ error: \"Unauthorized\" }, { status: 403 });\n    }\n\n    return { ...ctx, session };\n  };\n}\n\n// Create specific role-based interruptors\nexport const isAdmin = hasRole([\"ADMIN\"]);\nexport const isEditor = hasRole([\"ADMIN\", \"EDITOR\"]);\nexport const isUser = hasRole([\"ADMIN\", \"EDITOR\", \"USER\"]);\n```\n\n### Organization with Co-located Interruptors\n\nCreate a file at `./src/app/interruptors.ts`:\n\n```tsx\nimport { getSession } from \"rwsdk/auth\";\n\n// Authentication interruptors\nexport async function requireAuth({ request, ctx }) {\n  const session = await getSession(request);\n\n  if (!session) {\n    return Response.redirect(\"/login\");\n  }\n\n  return { ...ctx, session };\n}\n\n// Role-based interruptors\nexport function hasRole(allowedRoles) {\n  return async function hasRoleInterruptor({ request, ctx }) {\n    const session = await getSession(request);\n\n    if (!session) {\n      return Response.redirect(\"/login\");\n    }\n\n    if (!allowedRoles.includes(session.role)) {\n      return Response.json({ error: \"Unauthorized\" }, { status: 403 });\n    }\n\n    return { ...ctx, session };\n  };\n}\n\nexport const isAdmin = hasRole([\"ADMIN\"]);\nexport const isEditor = hasRole([\"ADMIN\", \"EDITOR\"]);\n\n// Other common interruptors\nexport async function logRequests({ request, ctx }) {\n  console.log(`${request.method} ${request.url}`);\n  return ctx;\n}\n```\n\nThen import these interruptors in your route files:\n\n```tsx\n// src/app/pages/admin/routes.ts\nimport { route } from \"rwsdk/router\";\nimport { isAdmin, logRequests } from \"@/app/interruptors\";\n\nimport { AdminDashboard } from \"./AdminDashboard\";\nimport { UserManagement } from \"./UserManagement\";\n\nexport const routes = [\n  route(\"/\", [isAdmin, logRequests, AdminDashboard]),\n  route(\"/users\", [isAdmin, logRequests, UserManagement]),\n];\n```\n\n";