adapt-authoring-server 2.3.1 → 2.3.2

package/.github/workflows/new.yml

@@ -1,13 +1,13 @@
-# Calls the org-level reusable workflow to add PRs to the TODO Board
-
-name: Add PR to Project
-
+name: Add to project
 on:
+  issues:
+    types:
+      - opened
+      - reopened
   pull_request:
     types:
       - opened
       - reopened
-
 jobs:
   add-to-project:
     uses: adapt-security/.github/.github/workflows/new.yml@main

package/README.md

@@ -0,0 +1,9 @@
+# adapt-authoring-server
+
+Provides the Express application that fronts the Adapt authoring tool — routing, the middleware stack and the static/API serving other modules attach their routers to.
+
+Extends `AbstractModule` from [adapt-authoring-core](../adapt-authoring-core).
+
+## Documentation
+
+- [Server requests](docs/server-requests.md) — the request/response lifecycle and routing

package/lib/ServerModule.js

@@ -2,6 +2,7 @@ import express from 'express'
 import { AbstractModule, Hook } from 'adapt-authoring-core'
 import Router from './Router.js'
 import ServerUtils from './ServerUtils.js'
+import { mapHandler } from './utils/mapHandler.js'
 /**
  * Adds an Express server to the authoring tool
  * @memberof server
@@ -20,7 +21,21 @@ class ServerModule extends AbstractModule {
      * @type {Router}
      */
     this.api = new Router('/api', this.expressApp, [], [ServerUtils.debugRequestTime])
-    this.api.expressRouter.get('/', (req, res) => res.json(this.api?.map))
+    this.api.addRoute({
+      route: '/',
+      handlers: { get: mapHandler(this.api) },
+      meta: {
+        get: {
+          summary: 'Retrieve a map of the available API endpoints',
+          responses: {
+            200: {
+              description: 'The API endpoint map',
+              content: { 'application/json': { schema: { type: 'object' } } }
+            }
+          }
+        }
+      }
+    })
     /**
      * The default/'root' router for the application
      * @type {Router}

package/lib/utils/generateRouterMap.js

@@ -32,7 +32,7 @@ function getEndpoints (r) {
 /** @ignore */
 function getRelativeRoute (relFrom, relTo) {
   if (relFrom === relTo) {
-    return `${relFrom.route}_`
+    return 'general_'
   }
   let route = ''
   for (let r = relTo; r !== relFrom; r = r.parentRouter) route = `${r.root}_${route}`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-server",
-  "version": "2.3.1",
+  "version": "2.3.2",
   "description": "Provides an Express application routing and more",
   "homepage": "https://github.com/adapt-security/adapt-authoring-server",
   "license": "GPL-3.0",

package/tests/ServerUtils.spec.js

@@ -1,4 +1,4 @@
-import { describe, it, before } from 'node:test'
+import { describe, it, before, beforeEach } from 'node:test'
 import assert from 'node:assert/strict'
 import { App } from 'adapt-authoring-core'
 
@@ -16,6 +16,11 @@ describe('ServerUtils', () => {
     ServerUtils = (await import('../lib/ServerUtils.js')).default
   })
 
+  beforeEach(() => {
+    // real errors expose registered codes as non-configurable getters, so stub with a plain object
+    App.instance.errors = {}
+  })
+
   describe('#addErrorHandler()', () => {
     /** Set up a res with addErrorHandler + status/json capture */
     function createSendErrorSetup (reqOverrides = {}) {
@@ -57,7 +62,6 @@ describe('ServerUtils', () => {
     })
 
     it('sendError should fall back to SERVER_ERROR for unknown errors', () => {
-      App.instance.errors = App.instance.errors || {}
       App.instance.errors.SERVER_ERROR = {
         constructor: { name: 'AdaptError' },
         statusCode: 500,
@@ -74,7 +78,6 @@ describe('ServerUtils', () => {
     })
 
     it('sendError should look up known error codes on non-AdaptError', () => {
-      App.instance.errors = App.instance.errors || {}
       App.instance.errors.CUSTOM_CODE = {
         statusCode: 422,
         code: 'CUSTOM_CODE',
@@ -92,7 +95,6 @@ describe('ServerUtils', () => {
     })
 
     it('sendError should copy data from non-AdaptError to looked-up error', () => {
-      App.instance.errors = App.instance.errors || {}
       App.instance.errors.VALIDATION_FAILED = {
         statusCode: 400,
         code: 'VALIDATION_FAILED',
@@ -190,7 +192,6 @@ describe('ServerUtils', () => {
 
     it('should call next with METHOD_NOT_ALLOWED when path exists but method does not match', () => {
       const mockError = { code: 'METHOD_NOT_ALLOWED' }
-      App.instance.errors = App.instance.errors || {}
       App.instance.errors.METHOD_NOT_ALLOWED = { setData: () => mockError }
 
       const mockRouter = {
@@ -215,7 +216,6 @@ describe('ServerUtils', () => {
 
   describe('#rootNotFoundHandler()', () => {
     it('should respond with NOT_FOUND status code', () => {
-      App.instance.errors = App.instance.errors || {}
       App.instance.errors.NOT_FOUND = { statusCode: 404 }
 
       let statusCode
@@ -235,7 +235,6 @@ describe('ServerUtils', () => {
   describe('#apiNotFoundHandler()', () => {
     it('should call next with ENDPOINT_NOT_FOUND error', () => {
       const mockError = { code: 'ENDPOINT_NOT_FOUND' }
-      App.instance.errors = App.instance.errors || {}
       App.instance.errors.ENDPOINT_NOT_FOUND = { setData: () => mockError }
 
       let nextArg

package/tests/utils-generateRouterMap.spec.js

@@ -42,7 +42,6 @@ describe('generateRouterMap()', () => {
   it('should include endpoint URLs and accepted methods', () => {
     const mockRouter = {
       root: 'api',
-      route: '/api',
       path: '/api',
       url: 'http://localhost:5000/api',
       routes: [
@@ -59,6 +58,7 @@ describe('generateRouterMap()', () => {
     const keys = Object.keys(map)
 
     assert.ok(keys.length > 0)
+    assert.equal(keys[0], 'general_endpoints')
     const endpoints = map[keys[0]]
     assert.ok(Array.isArray(endpoints))
     assert.equal(endpoints[0].url, 'http://localhost:5000/api/users')
@@ -81,7 +81,6 @@ describe('generateRouterMap()', () => {
     }
     const mockRouter = {
       root: 'api',
-      route: '/api',
       path: '/api',
       url: 'http://localhost:5000/api',
       routes: [],
@@ -117,7 +116,6 @@ describe('generateRouterMap()', () => {
     }
     const mockRouter = {
       root: 'api',
-      route: '/api',
       path: '/api',
       url: 'http://localhost:5000/api',
       routes: [],