adapt-authoring-server 1.0.0 → 1.0.2

package/.github/workflows/releases.yml

@@ -3,10 +3,16 @@ on:
   push:
     branches:
       - master
+
 jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for trusted publishing and npm provenance
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -16,10 +22,11 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 'lts/*'
+      - name: Update npm
+        run: npm install -g npm@latest
       - name: Install dependencies
         run: npm ci
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.AAT_NPM_TOKEN }}
-        run: npx semantic-release
+        run: npx semantic-release

package/.github/workflows/standardjs.yml

@@ -0,0 +1,13 @@
+name: Standard.js formatting check
+on: push
+jobs:
+  default:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: actions/setup-node@master
+        with:
+          node-version: 'lts/*'
+          cache: 'npm'
+      - run: npm ci
+      - run: npx standard

package/conf/config.schema.json

@@ -23,11 +23,6 @@
       "type": ["number", "boolean"],
       "default": 0
     },
-    "debugRequestTime": {
-      "description": "Will log the execution time of each request",
-      "type": "boolean",
-      "default": false
-    },
     "verboseErrorLogging": {
       "description": "Whether to log errors in their entirety",
       "type": "boolean",

package/lib/Router.js

@@ -221,7 +221,7 @@ class Router {
       this.routes.forEach(r => {
         Object.entries(r.handlers).forEach(([method, handler]) => {
           this.expressRouter[method](r.route, ServerUtils.cacheRouteConfig(r), ...this.getHandlerMiddleware(), handler)
-          this.log('debug', 'ADD_ROUTE', method.toUpperCase(), `${this.path !== '/' ? this.path : ''}${r.route}`)
+          this.log('verbose', 'ADD_ROUTE', method.toUpperCase(), `${this.path !== '/' ? this.path : ''}${r.route}`)
         })
       })
     }

package/lib/ServerModule.js

@@ -120,11 +120,13 @@ class ServerModule extends AbstractModule {
    */
   listen () {
     return new Promise((resolve, reject) => {
-      this.httpServer = this.expressApp.listen(this.port, this.host, () => {
-        this.isListening = true
-        this.listeningHook.invoke()
-        resolve(this.httpServer)
-      }).once('error', e => reject(this.app.errors.SERVER_START.setData({ error: e })))
+      this.httpServer = this.expressApp.listen(this.port, this.host)
+        .on('error', e => reject(this.app.errors.SERVER_START.setData({ error: e })))
+        .on('listening', () => {
+          this.isListening = true
+          this.listeningHook.invoke()
+          resolve(this.httpServer)
+        })
     })
   }
 

package/lib/ServerUtils.js

@@ -91,10 +91,8 @@ class ServerUtils {
    */
   static async debugRequestTime (req, res, next) {
     const server = await App.instance.waitForModule('server')
-    if (server.getConfig('debugRequestTime')) {
-      const start = new Date()
-      res.on('finish', () => server.log('debug', 'REQUEST_DURATION', req.method, req.originalUrl, new Date() - start))
-    }
+    const start = new Date()
+    res.on('finish', () => server.log('verbose', 'REQUEST_DURATION', req.method, req.originalUrl, new Date() - start, req.auth?.user?._id?.toString()))
     next()
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-server",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Provides an Express application routing and more",
   "homepage": "https://github.com/adapt-security/adapt-authoring-server",
   "license": "GPL-3.0",
@@ -16,16 +16,15 @@
     "adapt-authoring-core": "github:adapt-security/adapt-authoring-core"
   },
   "devDependencies": {
-    "eslint": "^9.12.0",
-    "standard": "^17.1.0",
-    "@semantic-release/commit-analyzer": "^9.0.2",
+    "@semantic-release/commit-analyzer": "^13.0.1",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/github": "^8.0.5",
-    "@semantic-release/npm": "^9.0.1",
-    "@semantic-release/release-notes-generator": "^10.0.3",
-    "conventional-changelog-eslint": "^3.0.9",
-    "semantic-release": "^21.0.1",
-    "semantic-release-replace-plugin": "^1.2.7"
+    "@semantic-release/github": "^12.0.2",
+    "@semantic-release/npm": "^13.1.2",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "conventional-changelog-eslint": "^6.0.0",
+    "semantic-release": "^25.0.2",
+    "semantic-release-replace-plugin": "^1.2.7",
+    "standard": "^17.1.0"
   },
   "release": {
     "plugins": [

package/.eslintignore

@@ -1 +0,0 @@
-node_modules

package/.eslintrc

@@ -1,14 +0,0 @@
-{
-  "env": {
-      "browser": false,
-      "node": true,
-      "commonjs": false,
-      "es2020": true
-  },
-  "extends": [
-      "standard"
-  ],
-  "parserOptions": {
-      "ecmaVersion": 2020
-  }
-}

package/tests/router.spec.js

@@ -1,142 +0,0 @@
-const { App } = require('adapt-authoring-core');
-const express = require('express');
-const Router = require('../lib/Router');
-const should = require('should');
-const supertest = require('supertest');
-
-describe('Server router', function() {
-  before(function() {
-    this.createRouter = (r = 'test') => new Router(r, express());
-    this.testRequest = (router, done, expectedStatus = 200) => {
-      const l = router.parentRouter.listen(undefined, function() {
-        supertest(router.parentRouter)
-          .get(`${router.path}`)
-          .expect(expectedStatus)
-          .end((e, res) => l.close(done))
-      });
-    };
-  });
-  describe('#addRoute()', function() {
-    const r1 = { route: 'test1', handlers: { get: () => {} } };
-    const r2 = { route: 'test2', handlers: { get: () => {} } };
-    const r3 = { route: 'test3', handlers: { get: () => {} } };
-    it('should add a route function to the stack', function() {
-      const router = this.createRouter();
-      router.addRoute(r1);
-      router.routes.should.containEql(r1);
-    });
-    it('should add multiple routes to the stack', function() {
-      const router = this.createRouter();
-      router.addRoute(r1, r2);
-      router.routes.should.containEql(r2);
-    });
-    it('should return router reference so as to be chainable', function() {
-      const router = this.createRouter();
-      const r = router.addRoute(r2);
-      r.should.equal(router);
-    });
-    it('should call route handler on client request', function(done) {
-      const router = this.createRouter();
-      router.addRoute({
-        route: '/',
-        handlers: { get: (req, res, next) => res.end() }
-      });
-      router.init();
-      this.testRequest(router, done);
-    });
-  });
-  describe('#addMiddleware()', function() {
-    const m1 = (req, res, next) => next();
-    const m2 = (req, res, next) => next();
-    it('should add a middleware function to the stack', function() {
-      const router = this.createRouter();
-      router.addMiddleware(m1);
-      router.middleware.should.containEql(m1);
-    });
-    it('should add multiple middleware functions to the stack', function() {
-      const router = this.createRouter();
-      router.addMiddleware(m1, m2);
-      router.middleware.should.containEql(m2);
-    });
-    it('should return router reference so as to be chainable', function() {
-      const router = this.createRouter();
-      const r = router.addMiddleware(m2);
-      r.should.equal(router);
-    });
-    it('should call custom middleware on client request', function(done) {
-      const router = this.createRouter();
-      router.addRoute({
-        route: '/',
-        handlers: { get: (req, res, next) => res.status(500).end() }
-      });
-      router.addMiddleware((req, res, next) => res.status(200).end());
-      router.init();
-      this.testRequest(router, done);
-    });
-  });
-  describe('#createChildRouter()', function() {
-    let parent, child;
-    before(function() {
-      parent = this.createRouter();
-      child = parent.createChildRouter('child');
-    });
-    it('should return a router instance', function() {
-      child.should.be.instanceof(Router);
-    });
-    it('should expose specified route', function() {
-      child.route.should.equal('child');
-    });
-    it('should be added to child routers', function() {
-      parent.childRouters.should.containEql(child);
-    });
-    it('should reference current router as parent', function() {
-      child.parentRouter.should.equal(parent);
-    });
-  });
-  describe('#path()', function() {
-    it('should generate the endpoint of the router', function() {
-      const child = new Router('child', new Router('parent', {}));
-      child.path.should.equal('/parent/child');
-    });
-  });
-  describe('#handleRequest()', function() {
-    it('should invoke listeners to Server#requestHook', function(done) {
-      let isDone = false;
-      App.instance.getModule('server').requestHook.tap(() => {
-        if(!isDone) done();
-        isDone = true;
-      });
-      const router = this.createRouter();
-      router.addRoute({
-        route: '/',
-        handlers: { get: (req, res, next) => {} }
-      });
-      router.init();
-      this.testRequest(router, () => {}, 500);
-    });
-  });
-  describe('#genericNotFoundHandler()', function() {
-    it('should return 404 HTTP status', function(done) {
-      const router = this.createRouter();
-      router.addRoute({
-        route: '/',
-        handlers: { get: (req, res, next) => res.end() }
-      });
-      router.addMiddleware(router.genericNotFoundHandler);
-      router.init();
-      this.testRequest(router, done, 404);
-    });
-  });
-  describe('#genericErrorHandler()', function() {
-    it('should return error HTTP status', function(done) {
-      const router = this.createRouter();
-      router.addRoute({
-        route: '/',
-        handlers: { get: (req, res, next) => next(new Error('Something bad happened')) }
-      });
-      router.addMiddleware(router.genericErrorHandler);
-      router.init();
-      this.testRequest(router, done, 500);
-    });
-  });
-});

package/tests/serverModule.spec.js

@@ -1,51 +0,0 @@
-const { Hook } = require('adapt-authoring-core');
-const Router = require('../lib/Router');
-const ServerModule = require('../lib/ServerModule');
-const should = require('should');
-const supertest = require('supertest');
-
-describe('Server module', function() {
-  before(function() {
-    this.server = new ServerModule(global.ADAPT.app, { name: require('../package.json').name });
-  });
-  describe('#constructor()', function() {
-    it('should expose the Express application', function() {
-      false.should.be.true();
-    });
-    it('should expose a `root` Router', function() {
-      this.server.root.should.be.an.instanceof(Router);
-    });
-    it('should expose an `api` Router', function() {
-      this.server.api.should.be.an.instanceof(Router);
-    });
-    it('should expose a hook to modify requests', function() {
-      this.server.requestHook.should.be.an.instanceof(Hook);
-    });
-  });
-  describe('#url()', function() {
-    it('should return the URL of the server', function() {
-      this.server.url.should.be.a.String();
-    });
-  });
-  describe('#static()', function() {
-    it('should expose Express#static', function() {
-      false.should.be.true();
-    });
-  });
-  describe('#listen()', function() {
-    it('should accept requests on the specified URL/port', function(done) {
-      supertest(this.server.expressApp)
-        .get(`${this.server.api.path}`)
-        .expect(200)
-        .end(done);
-    });
-    it('should not accept requests on unspecified URLs/ports', function(done) {
-      false.should.be.true();
-    });
-  });
-  describe('#close()', function() {
-    it('should stop accepting requests', function() {
-      false.should.be.true();
-    });
-  });
-});