@platformatic/service 0.12.0 → 0.13.0

package/index.js

@@ -22,6 +22,16 @@ function createServerConfig (config) {
   return serverConfig
 }
 
+function originToRegexp (origin) {
+  if (typeof origin === 'object') {
+    if (origin.regexp) {
+      origin = new RegExp(origin.regexp)
+    }
+  }
+
+  return origin
+}
+
 async function platformaticService (app, opts, toLoad = []) {
   if (isKeyEnabled('metrics', opts)) {
     app.register(require('./lib/metrics-plugin'), opts.metrics)
@@ -62,6 +72,15 @@ async function platformaticService (app, opts, toLoad = []) {
 
   // Enable CORS
   if (opts.cors) {
+    let origin = opts.cors.origin
+    if (Array.isArray(origin)) {
+      origin = origin.map(originToRegexp)
+    } else {
+      origin = originToRegexp(origin)
+    }
+
+    opts.cors.origin = origin
+
     app.register(require('@fastify/cors'), opts.cors)
   }
   if (isKeyEnabled('healthCheck', opts)) {
@@ -127,17 +146,51 @@ async function loadPlugin (app, config, pluginOptions) {
 }
 
 platformaticService[Symbol.for('skip-override')] = true
+platformaticService.schema = schema
+
+function adjustConfigBeforeMerge (cm) {
+  // This function and adjustConfigAfterMerge() are needed because there are
+  // edge cases that deepmerge() does not handle properly. This code does not
+  // live in the generic config manager because that object is not aware of
+  // these schema dependent details.
+  const stash = new Map()
+
+  // If a pino instance is passed as the logger, it will contain a child()
+  // function that is not enumerable. Non-enumerables are not copied by
+  // deepmerge(), so stash the logger here.
+  /* c8 ignore next 5 */
+  if (typeof cm.server?.logger?.child === 'function' &&
+      !Object.prototype.propertyIsEnumerable.call(cm.server.logger, 'child')) {
+    stash.set('server.logger', cm.server.logger)
+    cm.server.logger = null
+  }
+
+  return stash
+}
+
+function adjustConfigAfterMerge (options, stash) {
+  // Restore any config that needed to be stashed prior to merging.
+  const pinoLogger = stash.get('server.logger')
+
+  /* c8 ignore next 4 */
+  if (pinoLogger) {
+    options.server.logger = pinoLogger
+    options.configManager.current.server.logger = pinoLogger
+  }
+}
 
 async function buildServer (options, app = platformaticService) {
   if (!options.configManager) {
     // instantiate a new config manager from current options
     const cm = new ConfigManager({
       source: options,
-      schema
+      schema: app?.schema ?? schema
     })
     await cm.parseAndValidate()
+    const stash = adjustConfigBeforeMerge(cm.current)
     options = deepmerge({}, options, cm.current)
     options.configManager = cm
+    adjustConfigAfterMerge(options, stash)
   }
   const serverConfig = createServerConfig(options)
 

package/lib/schema.js

@@ -11,8 +11,27 @@ const cors = {
         {
           type: 'array',
           items: {
-            type: 'string'
+            anyOf: [{
+              type: 'string'
+            }, {
+              type: 'object',
+              properties: {
+                regexp: {
+                  type: 'string'
+                }
+              },
+              required: ['regexp']
+            }]
           }
+        },
+        {
+          type: 'object',
+          properties: {
+            regexp: {
+              type: 'string'
+            }
+          },
+          required: ['regexp']
         }
       ]
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "",
   "main": "index.js",
   "author": "Matteo Collina <hello@matteocollina.com>",
@@ -55,8 +55,8 @@
     "pino": "^8.8.0",
     "pino-pretty": "^9.1.1",
     "rfdc": "^1.3.0",
-    "@platformatic/config": "0.12.0",
-    "@platformatic/utils": "0.12.0"
+    "@platformatic/config": "0.13.0",
+    "@platformatic/utils": "0.13.0"
   },
   "standard": {
     "ignore": [

package/test/config.test.js

@@ -184,3 +184,31 @@ test('config reloads from a written file from a route', async ({ teardown, equal
     same(await res.body.text(), 'ciao mondo', 'response')
   }
 })
+
+test('config is adjusted to handle custom loggers', async (t) => {
+  const options = {
+    server: {
+      hostname: '127.0.0.1',
+      port: 0,
+      logger: {
+        info () {},
+        error () {},
+        debug () {},
+        fatal () {},
+        warn () {},
+        trace () {}
+      }
+    }
+  }
+
+  let called = false
+  Object.defineProperty(options.server.logger, 'child', {
+    value: function child () {
+      called = true
+    },
+    enumerable: false
+  })
+
+  await buildServer(options)
+  t.equal(called, true)
+})

package/test/cors.test.js

@@ -47,14 +47,227 @@ test('CORS can be enabled', async ({ teardown, equal, pass, same }) => {
   })
   teardown(server.stop)
   await server.listen()
-  const res = await (request(`${server.url}/_admin/login`, {
-    method: 'OPTIONS',
-    headers: {
-      'Access-Control-Request-Method': 'POST',
-      Origin: 'https://foo.bar.org'
-    }
-  }))
-  equal(res.statusCode, 204)
-  equal(res.headers['access-control-allow-origin'], 'https://foo.bar.org')
-  equal(res.headers['access-control-allow-methods'], 'GET, POST')
+
+  {
+    const res = await (request(`${server.url}/_admin/login`, {
+      method: 'OPTIONS',
+      headers: {
+        'Access-Control-Request-Method': 'POST',
+        Origin: 'https://foo.bar.org'
+      }
+    }))
+    equal(res.statusCode, 204)
+    equal(res.headers['access-control-allow-origin'], 'https://foo.bar.org')
+    equal(res.headers['access-control-allow-methods'], 'GET, POST')
+  }
+})
+
+test('CORS with a regexp', async ({ teardown, equal, pass, same }) => {
+  const server = await buildServer({
+    server: {
+      hostname: '127.0.0.1',
+      port: 0,
+      cors: {
+        origin: {
+          regexp: 'https://[a-z-]*.deploy.space|https://platformatic.cloud'
+        },
+        methods: ['GET', 'POST']
+      }
+    },
+    metrics: false
+  }, async function (app, opts) {
+    app.register(platformaticService, opts)
+    app.post('/login', (req, reply) => {})
+  })
+  teardown(server.stop)
+  await server.listen()
+
+  {
+    const res = await (request(`${server.url}/_admin/login`, {
+      method: 'OPTIONS',
+      headers: {
+        'Access-Control-Request-Method': 'POST',
+        Origin: 'https://platformatic.cloud'
+      }
+    }))
+    equal(res.statusCode, 204)
+    equal(res.headers['access-control-allow-origin'], 'https://platformatic.cloud')
+    equal(res.headers['access-control-allow-methods'], 'GET, POST')
+  }
+
+  {
+    const res = await (request(`${server.url}/_admin/login`, {
+      method: 'OPTIONS',
+      headers: {
+        'Access-Control-Request-Method': 'POST',
+        Origin: 'https://foo.deploy.space'
+      }
+    }))
+    equal(res.statusCode, 204)
+    equal(res.headers['access-control-allow-origin'], 'https://foo.deploy.space')
+    equal(res.headers['access-control-allow-methods'], 'GET, POST')
+  }
+
+  {
+    const res = await (request(`${server.url}/_admin/login`, {
+      method: 'OPTIONS',
+      headers: {
+        'Access-Control-Request-Method': 'POST',
+        Origin: 'https://foo.space'
+      }
+    }))
+    equal(res.statusCode, 204)
+    equal(res.headers['access-control-allow-origin'], undefined)
+    equal(res.headers['access-control-allow-methods'], 'GET, POST')
+  }
+})
+
+test('CORS with an array of strings', async ({ teardown, equal, pass, same }) => {
+  const server = await buildServer({
+    server: {
+      hostname: '127.0.0.1',
+      port: 0,
+      cors: {
+        origin: ['https://foo.deploy.space', 'https://platformatic.cloud'],
+        methods: ['GET', 'POST']
+      }
+    },
+    metrics: false
+  }, async function (app, opts) {
+    app.register(platformaticService, opts)
+    app.post('/login', (req, reply) => {})
+  })
+  teardown(server.stop)
+  await server.listen()
+
+  {
+    const res = await (request(`${server.url}/_admin/login`, {
+      method: 'OPTIONS',
+      headers: {
+        'Access-Control-Request-Method': 'POST',
+        Origin: 'https://platformatic.cloud'
+      }
+    }))
+    equal(res.statusCode, 204)
+    equal(res.headers['access-control-allow-origin'], 'https://platformatic.cloud')
+    equal(res.headers['access-control-allow-methods'], 'GET, POST')
+  }
+
+  {
+    const res = await (request(`${server.url}/_admin/login`, {
+      method: 'OPTIONS',
+      headers: {
+        'Access-Control-Request-Method': 'POST',
+        Origin: 'https://foo.deploy.space'
+      }
+    }))
+    equal(res.statusCode, 204)
+    equal(res.headers['access-control-allow-origin'], 'https://foo.deploy.space')
+    equal(res.headers['access-control-allow-methods'], 'GET, POST')
+  }
+
+  {
+    const res = await (request(`${server.url}/_admin/login`, {
+      method: 'OPTIONS',
+      headers: {
+        'Access-Control-Request-Method': 'POST',
+        Origin: 'https://foo.cloud'
+      }
+    }))
+    equal(res.statusCode, 204)
+    equal(res.headers['access-control-allow-origin'], undefined)
+    equal(res.headers['access-control-allow-methods'], 'GET, POST')
+  }
+})
+
+test('CORS with an array and a regexp', async ({ teardown, equal, pass, same }) => {
+  const server = await buildServer({
+    server: {
+      hostname: '127.0.0.1',
+      port: 0,
+      cors: {
+        origin: [{
+          regexp: 'https://[a-z-]*.deploy.space'
+        }, 'https://platformatic.cloud'],
+        methods: ['GET', 'POST']
+      }
+    },
+    metrics: false
+  }, async function (app, opts) {
+    app.register(platformaticService, opts)
+    app.post('/login', (req, reply) => {})
+  })
+  teardown(server.stop)
+  await server.listen()
+
+  {
+    const res = await (request(`${server.url}/_admin/login`, {
+      method: 'OPTIONS',
+      headers: {
+        'Access-Control-Request-Method': 'POST',
+        Origin: 'https://platformatic.cloud'
+      }
+    }))
+    equal(res.statusCode, 204)
+    equal(res.headers['access-control-allow-origin'], 'https://platformatic.cloud')
+    equal(res.headers['access-control-allow-methods'], 'GET, POST')
+  }
+
+  {
+    const res = await (request(`${server.url}/_admin/login`, {
+      method: 'OPTIONS',
+      headers: {
+        'Access-Control-Request-Method': 'POST',
+        Origin: 'https://foo.deploy.space'
+      }
+    }))
+    equal(res.statusCode, 204)
+    equal(res.headers['access-control-allow-origin'], 'https://foo.deploy.space')
+    equal(res.headers['access-control-allow-methods'], 'GET, POST')
+  }
+
+  {
+    const res = await (request(`${server.url}/_admin/login`, {
+      method: 'OPTIONS',
+      headers: {
+        'Access-Control-Request-Method': 'POST',
+        Origin: 'https://foo.cloud'
+      }
+    }))
+    equal(res.statusCode, 204)
+    equal(res.headers['access-control-allow-origin'], undefined)
+    equal(res.headers['access-control-allow-methods'], 'GET, POST')
+  }
+})
+
+test('CORS with a string', async ({ teardown, equal, pass, same }) => {
+  const server = await buildServer({
+    server: {
+      hostname: '127.0.0.1',
+      port: 0,
+      cors: {
+        origin: 'https://platformatic.cloud',
+        methods: ['GET', 'POST']
+      }
+    },
+    metrics: false
+  }, async function (app, opts) {
+    app.register(platformaticService, opts)
+    app.post('/login', (req, reply) => {})
+  })
+  teardown(server.stop)
+  await server.listen()
+
+  {
+    const res = await (request(`${server.url}/_admin/login`, {
+      method: 'OPTIONS',
+      headers: {
+        'Access-Control-Request-Method': 'POST',
+        Origin: 'https://foo.cloud'
+      }
+    }))
+    equal(res.statusCode, 204)
+    equal(res.headers['access-control-allow-origin'], 'https://platformatic.cloud')
+    equal(res.headers['access-control-allow-methods'], 'GET, POST')
+  }
 })

package/test/tmp/typescript-plugin-clone-2/dist/plugin.js

@@ -0,0 +1,18 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+function default_1(app) {
+    return __awaiter(this, void 0, void 0, function* () {
+        app.log.info('Typescript plugin loaded');
+    });
+}
+exports.default = default_1;
+//# sourceMappingURL=plugin.js.map

package/test/tmp/typescript-plugin-clone-2/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../plugin.ts"],"names":[],"mappings":";;;;;;;;;;;AAEA,mBAA+B,GAAoB;;QACjD,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAA;IAC1C,CAAC;CAAA;AAFD,4BAEC"}

package/test/tmp/typescript-plugin-clone-2/platformatic.service.json

@@ -9,7 +9,8 @@
   "plugin": {
     "path": "plugin.ts",
     "typescript": {
-      "outDir": "dist"
+      "outDir": "dist",
+      "build": false
     }
   }
 }

package/test/tmp/typescript-plugin-clone-2/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "target": "es6",
+    "moduleResolution": "node",
+    "sourceMap": true,
+    "pretty": true,
+    "noEmitOnError": true,
+    "outDir": "dist"
+  },
+  "watchOptions": {
+    "watchFile": "fixedPollingInterval",
+    "watchDirectory": "fixedPollingInterval",
+    "fallbackPolling": "dynamicPriority",
+    "synchronousWatchDirectory": true,
+    "excludeDirectories": [
+      "**/node_modules",
+      "dist"
+    ]
+  }
+}

package/test/tmp/typescript-plugin-clone-5/platformatic.service.json

@@ -0,0 +1,15 @@
+{
+  "server": {
+    "logger": {
+      "level": "info"
+    },
+    "hostname": "127.0.0.1",
+    "port": "0"
+  },
+  "plugin": {
+    "path": "plugin.ts",
+    "typescript": {
+      "outDir": "dist"
+    }
+  }
+}

package/test/tmp/typescript-plugin-clone-5/plugin.ts

@@ -0,0 +1,5 @@
+import { FastifyInstance } from 'fastify'
+
+export default async function (app: FastifyInstance) {
+  app.log.info('Typescript plugin loaded')
+}

package/test/tmp/typescript-plugin-clone-5/tsconfig.json.backup

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "target": "es6",
+    "moduleResolution": "node",
+    "sourceMap": true,
+    "pretty": true,
+    "noEmitOnError": true,
+    "outDir": "dist"
+  },
+  "watchOptions": {
+    "watchFile": "fixedPollingInterval",
+    "watchDirectory": "fixedPollingInterval",
+    "fallbackPolling": "dynamicPriority",
+    "synchronousWatchDirectory": true,
+    "excludeDirectories": [
+      "**/node_modules",
+      "dist"
+    ]
+  }
+}

package/test/tmp/typescript-plugin-clone-6/platformatic.service.json

@@ -0,0 +1,16 @@
+{
+  "server": {
+    "logger": {
+      "level": "info"
+    },
+    "hostname": "127.0.0.1",
+    "port": "0"
+  },
+  "plugin": {
+    "path": "plugin.ts",
+    "typescript": {
+      "outDir": "dist",
+      "build": false
+    }
+  }
+}

package/test/tmp/typescript-plugin-clone-6/plugin.ts

@@ -0,0 +1,5 @@
+import { FastifyInstance } from 'fastify'
+
+export default async function (app: FastifyInstance) {
+  app.log.info('Typescript plugin loaded')
+}

package/test/tmp/typescript-plugin-clone-6/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "target": "es6",
+    "moduleResolution": "node",
+    "sourceMap": true,
+    "pretty": true,
+    "noEmitOnError": true,
+    "outDir": "dist"
+  },
+  "watchOptions": {
+    "watchFile": "fixedPollingInterval",
+    "watchDirectory": "fixedPollingInterval",
+    "fallbackPolling": "dynamicPriority",
+    "synchronousWatchDirectory": true,
+    "excludeDirectories": [
+      "**/node_modules",
+      "dist"
+    ]
+  }
+}