feat: poc integration tests for identities management express.js samples (#2389)

* feat: poc integration tests for identities management express.js samples

* refactor: remove unnecessary blank lines in identity login and signup tests

* test: add integration tests for identity logout and login helpers

* fix: remove unnecessary fallback for location header in identity login and signup tests

* refactor: update routes to use specific paths and simplify server setup

* refactor: improve logout route registration in server setup

* refactor: streamline server setup by organizing middleware and route registrations

Author: wassimoo

.github/workflows/integration-tests.yml

@@ -0,0 +1,33 @@
+name: JavaScript Integration Tests
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test-javascript-integration:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+          cache: "npm"
+      - name: Install dependencies
+        run: npm ci
+      - name: Install test app dependencies
+        run: |
+          cd tests/jest/apps/identity-get-started
+          npm ci
+      - name: Run JavaScript integration tests
+        run: npm run test:integration
+        env:
+          ORY_SDK_URL: ${{ secrets.ORY_SDK_URL }}
+          TEST_USER_EMAIL: ${{ secrets.TEST_USER_EMAIL }}
+          TEST_USER_PASSWORD: ${{ secrets.TEST_USER_PASSWORD }}

docs/identities/get-started/_common/code-examples/js/login.js

@@ -1,8 +1,12 @@
-app.get("/", (req, res) => {
-  ory
-    .toSession({ cookie: req.header("cookie") })
-    .then((data) => res.json(data))
-    .catch(() =>
-      res.redirect(`${process.env.ORY_SDK_URL}/self-service/login/browser`),
-    )
-})
+export const registerLoginRoute = (
+  app,
+  ory,
+  baseUrl = process.env.ORY_SDK_URL,
+) => {
+  app.get("/login", (req, res) => {
+    ory
+      .toSession({ cookie: req.header("cookie") })
+      .then((data) => res.json(data))
+      .catch(() => res.redirect(`${baseUrl}/self-service/login/browser`))
+  })
+}

docs/identities/get-started/_common/code-examples/js/logout.js

@@ -1,13 +1,16 @@
 // Create logout route
-app.get("/logout", async (req, res) => {
-  try {
-    // Create a logout flow
-    const { logout_url } = await ory.createBrowserLogoutFlow({
-      cookie: req.header("cookie"),
-    })
-    // Redirect to logout URL
-    res.redirect(logout_url)
-  } catch (err) {
-    res.redirect("/")
-  }
-})
+export const registerLogoutRoute = (app, ory) => {
+  app.get("/logout", async (req, res) => {
+    try {
+      // Create a logout flow
+      const { data } = await ory.createBrowserLogoutFlow({
+        cookie: req.header("cookie"),
+      })
+      const logoutUrl = data.logout_url || data.logoutUrl
+      // Redirect to logout URL
+      res.redirect(logoutUrl)
+    } catch (err) {
+      res.redirect("/")
+    }
+  })
+}

docs/identities/get-started/_common/code-examples/js/session/check-session.js

@@ -1,13 +1,19 @@
-const requireAuth = async (req, res, next) => {
-  try {
-    const session = await ory.toSession({ cookie: req.header("cookie") })
-    req.session = session
-    next()
-  } catch (error) {
-    res.redirect(`${process.env.ORY_SDK_URL}/self-service/login/browser`)
+export const createRequireAuth = (ory, baseUrl = process.env.ORY_SDK_URL) => {
+  return async (req, res, next) => {
+    try {
+      const { data: session } = await ory.toSession({
+        cookie: req.header("cookie"),
+      })
+      req.session = session
+      next()
+    } catch (error) {
+      res.redirect(`${baseUrl}/self-service/login/browser`)
+    }
   }
 }
 
-app.get("/", requireAuth, (req, res) => {
-  res.json(req.session.identity.traits) // { email: 'newtestuser@gmail.com' }
-})
+export const registerSessionRoute = (app, requireAuth) => {
+  app.get("/session", requireAuth, (req, res) => {
+    res.json(req.session.identity.traits) // { email: 'newtestuser@gmail.com' }
+  })
+}

docs/identities/get-started/_common/code-examples/js/session/refresh-session.js

@@ -1,4 +1,6 @@
-app.get("/refresh-session", async (req, res) => {
-  // Redirect to login with refresh=true parameter
-  res.redirect(`${baseUrl}/ui/login?refresh=true`)
-})
+export const registerRefreshSessionRoute = (app, baseUrl) => {
+  app.get("/refresh-session", async (req, res) => {
+    // Redirect to login with refresh=true parameter
+    res.redirect(`${baseUrl}/ui/login?refresh=true`)
+  })
+}

docs/identities/get-started/_common/code-examples/js/setupDev.js

@@ -1,7 +1,8 @@
 import { Configuration, FrontendApi } from "@ory/client-fetch"
 
-const baseUrl = process.env.ORY_SDK_URL || "http://localhost:4000"
-const ory = new FrontendApi(
+export const baseUrl = process.env.ORY_SDK_URL || "http://localhost:4000"
+
+export const ory = new FrontendApi(
   new Configuration({
     basePath: baseUrl,
   }),

docs/identities/get-started/_common/code-examples/js/sign-up.js

@@ -1,10 +1,8 @@
-app.get("/", (req, res) => {
-  ory
-    .toSession({ cookie: req.header("cookie") })
-    .then((data) => res.json(data))
-    .catch(() =>
-      res.redirect(
-        `${process.env.ORY_SDK_URL}/self-service/registration/browser`,
-      ),
-    )
-})
+export const registerSignUpRoute = (app, ory, baseUrl) => {
+  app.get("/signup", (req, res) => {
+    ory
+      .toSession({ cookie: req.header("cookie") })
+      .then((data) => res.json(data))
+      .catch(() => res.redirect(`${baseUrl}/self-service/registration/browser`))
+  })
+}

docs/identities/get-started/setup.mdx

@@ -38,7 +38,7 @@ npm install @ory/client-fetch --save
 
 ```mdx-code-block
 </TabItem>
-<TabItem value="nextjs">
+<TabItem value="ts-nextjs">
 ```
 
 ```shell

docs/identities/get-started/sign-in.mdx

@@ -35,7 +35,7 @@ to the registration page, it redirects to the login page.
 ```
 
 ```mdx-code-block
-<CodeBlock className="language-js">{nextjsLogin}</CodeBlock>
+<CodeBlock className="language-tsx">{nextjsLogin}</CodeBlock>
 ```
 
 ```mdx-code-block

docs/identities/get-started/sign-up.mdx

@@ -43,7 +43,7 @@ the Ory registration page.
 ```
 
 ```mdx-code-block
-<CodeBlock className="language-js">{nextSignUp}</CodeBlock>
+<CodeBlock className="language-tsx">{nextSignUp}</CodeBlock>
 ```
 
 ```mdx-code-block