Fix cypress

Author: ajworkos

cypress/README.md

@@ -66,16 +66,6 @@ describe("Public Features", () => {
 });
 ```
 
-## Test Endpoint
-
-The tests use the following API endpoint for programmatic authentication and session creation:
-
-**Endpoint:** `POST /api/test/set-session`
-
-- **Purpose:** Create session from authentication tokens
-- **Body:** `{ user, accessToken, refreshToken }`
-- **Response:** Uses WorkOS AuthKit's `saveSession` method to create encrypted session cookie
-
 The endpoint is to be used for testing purposes only and is recommended to be disabled in production environments.
 
 ## Files

cypress/plugins/workos.ts

@@ -1,30 +1,20 @@
-import type { PluginEvents, PluginConfigOptions } from "cypress";
-
-interface AuthenticateParams {
-  email: string;
-  password: string;
-  workosApiKey: string;
-  workosClientId: string;
-}
-
+import { WorkOS } from "@workos-inc/node";
 /**
  * WorkOS authentication plugin for Cypress
  * Provides tasks for programmatic authentication using WorkOS SDK
  */
 export function registerWorkOSTasks(
-  on: PluginEvents,
-  config: PluginConfigOptions
+  on: Cypress.PluginEvents,
+  config: Cypress.PluginConfigOptions,
 ) {
   on("task", {
-    authenticateWithWorkOS({
+    async authenticateWithWorkOS({
       email,
       password,
       workosApiKey,
       workosClientId,
-    }: AuthenticateParams) {
-      // Import WorkOS SDK in Node.js context (can't be imported in browser context)
-      const { WorkOS } = require("@workos-inc/node");
-
+      cookiePassword,
+    }) {
       const workos = new WorkOS(workosApiKey, {
         apiHostname: process.env.WORKOS_API_HOSTNAME,
       });
@@ -33,6 +23,10 @@ export function registerWorkOSTasks(
         clientId: workosClientId,
         email,
         password,
+        session: {
+          sealSession: true,
+          cookiePassword: process.env.WORKOS_COOKIE_PASSWORD,
+        },
       });
     },
   });

cypress/support/commands.ts

@@ -1,24 +1,9 @@
-/// <reference types="cypress" />
-
-declare global {
-  namespace Cypress {
-    interface Chainable {
-      /**
-       * Login as the specified user using programmatic authentication
-       * @param username - Username (email) to authenticate as
-       * @param password - Password to authenticate with
-       */
-      login(username: string, password: string): Chainable<void>;
-    }
-  }
-}
-
 /**
  * Custom command for programmatic authentication
  * Uses cy.session for caching per username-password combination
  * Follows the same pattern as Playwright tests
  */
-Cypress.Commands.add("login", (username: string, password: string) => {
+Cypress.Commands.add("login", (username, password) => {
   if (!username || !password) {
     throw new Error("Both username and password are required");
   }
@@ -29,14 +14,16 @@ Cypress.Commands.add("login", (username: string, password: string) => {
   cy.session(
     sessionId,
     () => {
-      const workosApiKey = Cypress.env("WORKOS_API_KEY");
-      const workosClientId = Cypress.env("WORKOS_CLIENT_ID");
-      const baseURL = Cypress.env("TEST_BASE_URL");
+      const workosApiKey = String(Cypress.env("WORKOS_API_KEY"));
+      const workosClientId = String(Cypress.env("WORKOS_CLIENT_ID"));
+      const cookieName =
+        String(Cypress.env("WORKOS_COOKIE_NAME")) ?? "wos-session";
 
-      if (!workosApiKey || !workosClientId) {
-        throw new Error(
-          "Missing WORKOS_API_KEY or WORKOS_CLIENT_ID in Cypress environment"
-        );
+      if (!workosApiKey) {
+        throw new Error("Missing WORKOS_API_KEY Cypress environment");
+      }
+      if (!workosClientId) {
+        throw new Error("Missing WORKOS_CLIENT_ID Cypress environment");
       }
 
       cy.log(`Authenticating user: ${username}`);
@@ -47,25 +34,10 @@ Cypress.Commands.add("login", (username: string, password: string) => {
         password: password,
         workosApiKey,
         workosClientId,
-      }).then((authResponse: any) => {
+      }).then((authResponse) => {
         cy.log("API authentication successful");
-
-        // Step 2: Call our test endpoint to save the session (same as Playwright)
-        cy.request({
-          method: "POST",
-          url: `${baseURL}/api/test/set-session`,
-          body: {
-            user: authResponse.user,
-            accessToken: authResponse.accessToken,
-            refreshToken: authResponse.refreshToken,
-          },
-        }).then((response) => {
-          expect(response.status).to.eq(200);
-          cy.log("Session saved successfully");
-
-          // The endpoint sets the cookie
-          // Cypress handles cookies from cy.request responses automatically
-        });
+        // set the wos-session cookie
+        cy.setCookie(cookieName, authResponse.sealedSession!);
       });
     },
     {
@@ -74,8 +46,6 @@ Cypress.Commands.add("login", (username: string, password: string) => {
         cy.visit("/");
         cy.get("body").should("contain.text", "Welcome back");
       },
-    }
+    },
   );
 });
-
-export {};

cypress/support/index.d.ts

@@ -0,0 +1,25 @@
+interface AuthenticateWithWorkOSParams {
+  email: string;
+  password: string;
+  workosApiKey: string;
+  workosClientId: string;
+}
+
+interface AuthenticateWithWorkOSResponse {
+  user: Record<string, unknown>;
+  accessToken: string;
+  refreshToken: string;
+  sealedSession?: string;
+}
+
+declare namespace Cypress {
+  interface Chainable {
+    login(username: string, password: string): Chainable<void>;
+
+    task(
+      event: "authenticateWithWorkOS",
+      arg: AuthenticateWithWorkOSParams,
+      options?: Partial<Loggable & Timeoutable>,
+    ): Chainable<AuthenticateWithWorkOSResponse>;
+  }
+}

cypress/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["es5", "dom", "dom.iterable", "esnext"],
+    "types": ["cypress", "node"],
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "strict": true
+  },
+  "include": ["./**/*.ts"]
+}

tests/README.md

@@ -23,18 +23,6 @@ TEST_BASE_URL=http://localhost:3000
 npm run test:playwright
 ```
 
-## Test Endpoint
-
-The tests use the following API endpoint for programmatic authentication and session creation:
-
-**Endpoint:** `POST /api/test/set-session`
-
-- **Purpose:** Create session from authentication tokens
-- **Body:** `{ user, accessToken, refreshToken }`
-- **Response:** Uses WorkOS AuthKit's `saveSession` method to create encrypted session cookie
-
-The endpoint is to be used for testing purposes only and is recommended to be disabled in production environments.
-
 ## Usage
 
 **Import fixtures:**