Reorganising schemas (#382)

* referencing schemas

* updated search schema

* articles updated

* collections

* refactored schemas used in public services, added validation

* deleted unused files

* updated collectable items

* removed unused schemas

* added still used schema

* generated types

README.md

@@ -188,6 +188,14 @@ $ feathers generate model                 # Generate a new Model
 $ feathers help                           # Show all commands
 ```
 
+## Generating Typescipt types from JSON schemas
+
+When a schema is updated, the typescript types should be regenerated. This can be done by running the following command:
+
+```
+npm run generate-types
+```
+
 ## Help
 
 For more information on all the things you can do with Feathers visit [docs.feathersjs.com](http://docs.feathersjs.com).

package.json

@@ -112,6 +112,7 @@
     "node-fetch": "2.7.0",
     "node-http-proxy-json": "^0.1.6",
     "passport-github": "^1.1.0",
+    "express-openapi-validator": "5.1.6",
     "pg": "^8.11.3",
     "pg-hstore": "^2.3.2",
     "redis": "4.6.13",

scripts/generate-types.js

@@ -1,23 +1,22 @@
 const { execSync } = require('node:child_process')
 const fs = require('node:fs')
 
-const basePath = './src/services'
+const basePath = './src/schema'
 
-// for now support only the followin services until we migrate everything:
-const supportedServices = ['text-reuse-clusters']
+const schemaBits = ['schemas', 'parameters', 'requestBodies', 'responses']
 
 const directories = fs
-  .readdirSync('./src/services')
+  .readdirSync(basePath)
   .filter(item => {
     return fs.statSync(`${basePath}/${item}`).isDirectory()
   })
-  .filter(item => supportedServices.includes(item))
+  .filter(item => schemaBits.includes(item))
 
-directories.forEach(service => {
+directories.forEach(dir => {
   // eslint-disable-next-line no-console
-  console.log(`Generating types for service ${service}...`)
+  console.log(`Generating types for service ${dir}...`)
   const command =
-    `quicktype --src-lang schema --src ${basePath}/${service}/schema/**/*.json` +
-    ` --out ${basePath}/${service}/models/generated.ts --lang ts --just-types`
+    `quicktype --src-lang schema --src ${basePath}/${dir}/*.json` +
+    ` --out ./src/models/generated/${dir}.ts --lang ts --just-types`
   execSync(command)
 })

src/app.ts

@@ -10,7 +10,9 @@ import sequelize from './sequelize'
 import solr from './solr'
 import media from './services/media'
 import proxy from './services/proxy'
+import schemas from './services/schemas'
 import { ensureServiceIsFeathersCompatible } from './util/feathers'
+import openApiValidator from './middleware/openApiValidator'
 
 const path = require('path')
 const compress = require('compression')
@@ -87,5 +89,7 @@ app.configure(appHooks)
 // configure express services
 app.configure(media)
 app.configure(proxy)
+app.configure(schemas)
+app.configure(openApiValidator)
 
 module.exports = app

src/authentication.js

@@ -46,13 +46,15 @@ class HashedPasswordVerifier extends LocalStrategy {
 }
 
 module.exports = app => {
+  const isPublicApi = app.get('isPublicApi')
   const authentication = new CustomisedAuthenticationService(app)
 
   authentication.register('jwt', new JWTStrategy())
   authentication.register('local', new HashedPasswordVerifier())
 
   app.use('/authentication', authentication, {
-    methods: ['create', 'remove'],
+    methods: isPublicApi ? ['create'] : undefined,
+    events: [],
     docs: createSwaggerServiceOptions({ schemas: {}, docs }),
   })
 }

src/middleware/openApiValidator.ts

@@ -0,0 +1,38 @@
+import type { OpenAPIV3 } from 'express-openapi-validator/dist/framework/types'
+import RefParser, { FileInfo } from '@apidevtools/json-schema-ref-parser'
+import type { ImpressoApplication } from '../types'
+import type { Application } from '@feathersjs/express'
+import * as OpenApiValidator from 'express-openapi-validator'
+import fs from 'fs'
+
+export default async (app: ImpressoApplication & Application) => {
+  const isPublicApi = app.get('isPublicApi')
+  if (!isPublicApi) return
+
+  if (!('docs' in app)) throw new Error('`docs` property not found in app object. Is swagger initialized?')
+  const spec = (app as any)['docs'] as unknown as OpenAPIV3.Document
+
+  const dereferencedOpenApiSpec = await RefParser.dereference(spec, {
+    resolve: {
+      file: {
+        /**
+         * All JSON schema files are relative to the
+         * `src` / `dist` directory. Adding it here.
+         */
+        read: (file: FileInfo) => {
+          const cwd = process.cwd()
+          const filePath = file.url.replace(cwd, `${cwd}/dist`)
+          return fs.readFileSync(filePath, 'utf-8')
+        },
+      },
+    },
+  })
+
+  const middlewares = OpenApiValidator.middleware({
+    apiSpec: dereferencedOpenApiSpec as unknown as OpenAPIV3.Document,
+    validateRequests: true, // (default)
+    validateResponses: true, // false by default
+    validateApiSpec: false,
+  })
+  middlewares.forEach(middleware => app.use(middleware))
+}

src/middleware/swagger.ts

@@ -1,6 +1,32 @@
 import swagger, { swaggerUI } from 'feathers-swagger'
 import { logger } from '../logger'
 import { ImpressoApplication } from '../types'
+import fs from 'fs'
+import path from 'path'
+import { Application } from '@feathersjs/express'
+
+const schemaBaseDir = path.join(__dirname, '../schema')
+
+interface SchemaRef {
+  $ref: string
+}
+
+const getFilesAsSchemaRefs = (dir: string, prefix: string): Record<string, SchemaRef> => {
+  const allFiles = fs.readdirSync(dir)
+
+  return allFiles
+    .filter(f => f.endsWith('.json'))
+    .reduce(
+      (acc, f) => {
+        const key = path.basename(f, '.json')
+        acc[key] = {
+          $ref: `${prefix}/${key}.json`,
+        }
+        return acc
+      },
+      {} as Record<string, SchemaRef>
+    )
+}
 
 function getRedirectPrefix({ req, ctx }: any) {
   const headers = (req && req.headers) || (ctx && ctx.headers) || {}
@@ -33,7 +59,7 @@ function generateSwaggerUIInitializerScript({ docsJsonPath, ctx, req }: any) {
   `
 }
 
-export default (app: ImpressoApplication) => {
+export default (app: ImpressoApplication & Application) => {
   if (!app.get('isPublicApi')) {
     logger.info('Internal API - swagger middleware is disabled')
     return
@@ -51,6 +77,10 @@ export default (app: ImpressoApplication) => {
         version: require('../../package.json').version,
       },
       components: {
+        schemas: getFilesAsSchemaRefs(`${schemaBaseDir}/schemas`, './schema/schemas'),
+        requestBodies: getFilesAsSchemaRefs(`${schemaBaseDir}/requestBodies`, './schema/requestBodies'),
+        responses: getFilesAsSchemaRefs(`${schemaBaseDir}/responses`, './schema/responses'),
+        parameters: getFilesAsSchemaRefs(`${schemaBaseDir}/parameters`, './schema/parameters'),
         securitySchemes: {
           BearerAuth: {
             type: 'http',
@@ -73,5 +103,5 @@ export default (app: ImpressoApplication) => {
       getSwaggerInitializerScript: generateSwaggerUIInitializerScript,
     }),
   })
-  return app.configure(swaggerItem)
+  app.configure(swaggerItem)
 }

src/models/generated/parameters.ts

@@ -0,0 +1,6 @@
+/**
+ * Add-ons for text reuse passages find method.
+ */
+export interface Parameters {
+    newspaper?: any;
+}

src/models/generated/requestBodies.ts

@@ -0,0 +1,15 @@
+export interface AuthenticationCreateRequest {
+    email:    string;
+    password: string;
+    strategy: Strategy;
+}
+
+export enum Strategy {
+    Local = "local",
+}
+
+export interface NewCollection {
+    description?: string;
+    name:         string;
+    status?:      string;
+}