adapt-authoring-sessions 1.0.2 → 1.1.0

package/.github/workflows/tests.yml

@@ -0,0 +1,15 @@
+name: Tests
+on: push
+jobs:
+  default:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+          cache: 'npm'
+      - run: npm ci
+      - run: npm test

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-sessions",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Module which stores users sessions in the MongoDB",
   "homepage": "https://github.com/adapt-security/adapt-authoring-sessions",
   "license": "GPL-3.0",
@@ -8,12 +8,25 @@
   "main": "index.js",
   "repository": "github:adapt-security/adapt-authoring-sessions",
   "dependencies": {
+    "adapt-authoring-core": "^1.7.0",
     "connect-mongo": "^6.0.0",
     "express-session": "^1.18.0"
   },
   "peerDependencies": {
-    "adapt-authoring-auth": "github:adapt-security/adapt-authoring-auth",
-    "adapt-authoring-core": "github:adapt-security/adapt-authoring-core"
+    "adapt-authoring-auth": "^1.0.5",
+    "adapt-authoring-mongodb": "^1.1.3",
+    "adapt-authoring-server": "^1.2.1"
+  },
+  "peerDependenciesMeta": {
+    "adapt-authoring-auth": {
+      "optional": true
+    },
+    "adapt-authoring-mongodb": {
+      "optional": true
+    },
+    "adapt-authoring-server": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "@semantic-release/git": "^10.0.1",
@@ -37,7 +50,18 @@
       ],
       "@semantic-release/npm",
       "@semantic-release/github",
-      "@semantic-release/git"
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "package.json"
+          ],
+          "message": "Chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+        }
+      ]
     ]
+  },
+  "scripts": {
+    "test": "node --test 'tests/**/*.spec.js'"
   }
 }

package/tests/SessionsModule.spec.js

@@ -0,0 +1,106 @@
+import { describe, it, mock } from 'node:test'
+import assert from 'node:assert/strict'
+
+/**
+ * SessionsModule extends AbstractModule and requires express-session, MongoDB, etc.
+ * We test the storeAuthHeader and clearSession methods using extracted logic.
+ */
+
+describe('SessionsModule', () => {
+  describe('#storeAuthHeader()', () => {
+    /* inline helper: extracted storeAuthHeader logic */
+    function storeAuthHeader (req, res, next) {
+      const token = req?.session?.token
+      if (token && !req.headers.Authorization) {
+        req.headers.Authorization = `Bearer ${token}`
+      }
+      next()
+    }
+
+    it('should set Authorization header when session token exists and no header present', () => {
+      const req = {
+        session: { token: 'abc123' },
+        headers: {}
+      }
+      const next = mock.fn()
+      storeAuthHeader(req, {}, next)
+      assert.equal(req.headers.Authorization, 'Bearer abc123')
+      assert.equal(next.mock.calls.length, 1)
+    })
+
+    it('should not override existing Authorization header', () => {
+      const req = {
+        session: { token: 'abc123' },
+        headers: { Authorization: 'Bearer existing' }
+      }
+      const next = mock.fn()
+      storeAuthHeader(req, {}, next)
+      assert.equal(req.headers.Authorization, 'Bearer existing')
+    })
+
+    it('should call next when no session token', () => {
+      const req = {
+        session: {},
+        headers: {}
+      }
+      const next = mock.fn()
+      storeAuthHeader(req, {}, next)
+      assert.equal(req.headers.Authorization, undefined)
+      assert.equal(next.mock.calls.length, 1)
+    })
+
+    it('should call next when session is undefined', () => {
+      const req = { headers: {} }
+      const next = mock.fn()
+      storeAuthHeader(req, {}, next)
+      assert.equal(next.mock.calls.length, 1)
+    })
+
+    it('should call next when req is empty', () => {
+      const next = mock.fn()
+      storeAuthHeader({}, {}, next)
+      assert.equal(next.mock.calls.length, 1)
+    })
+  })
+
+  describe('#clearSession()', () => {
+    /* inline helper: extracted clearSession logic */
+    async function clearSession (req) {
+      if (!req.session) {
+        return
+      }
+      return new Promise((resolve, reject) => {
+        req.session.destroy(e => {
+          if (e) return reject(new Error('DESTROY_SESSION_FAIL'))
+          resolve()
+        })
+      })
+    }
+
+    it('should return early when no session exists', async () => {
+      const result = await clearSession({})
+      assert.equal(result, undefined)
+    })
+
+    it('should resolve when session.destroy succeeds', async () => {
+      const req = {
+        session: {
+          destroy: (cb) => cb(null)
+        }
+      }
+      await clearSession(req)
+    })
+
+    it('should reject when session.destroy fails', async () => {
+      const req = {
+        session: {
+          destroy: (cb) => cb(new Error('fail'))
+        }
+      }
+      await assert.rejects(
+        () => clearSession(req),
+        { message: 'DESTROY_SESSION_FAIL' }
+      )
+    })
+  })
+})