@platformatic/service 0.17.1 → 0.19.0

package/fixtures/hello/platformatic.service.json

@@ -9,5 +9,8 @@
   "plugins": {
     "paths": ["./plugin.js"]
   },
+  "service": {
+    "openapi": true
+  },
   "metrics": false
 }

package/fixtures/hello-client/hello/hello.cjs

@@ -0,0 +1,21 @@
+'use strict'
+
+const pltClient = require('@platformatic/client')
+const { join } = require('path')
+
+async function generateHelloClientPlugin (app, opts) {
+  app.register(pltClient, {
+    type: 'openapi',
+    name: 'hello',
+    path: join(__dirname, 'hello.openapi.json'),
+    url: opts.url
+  })
+}
+
+generateHelloClientPlugin[Symbol.for('plugin-meta')] = {
+  name: 'hello OpenAPI Client'
+}
+generateHelloClientPlugin[Symbol.for('skip-override')] = true
+
+module.exports = generateHelloClientPlugin
+module.exports.default = generateHelloClientPlugin

package/fixtures/hello-client/hello/hello.d.ts

@@ -0,0 +1,34 @@
+import { FastifyPluginAsync } from 'fastify'
+
+interface GetRequest {
+}
+
+interface GetResponse {
+}
+
+interface Hello {
+  get(req: GetRequest): Promise<GetResponse>;
+}
+
+type HelloPlugin = FastifyPluginAsync<NonNullable<hello.HelloOptions>>
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    'hello': Hello;
+  }
+
+  interface FastifyRequest {
+    'hello': Hello;
+  }
+}
+
+declare namespace hello {
+  export interface HelloOptions {
+    url: string
+  }
+  export const hello: HelloPlugin;
+  export { hello as default };
+}
+
+declare function hello(...params: Parameters<HelloPlugin>): ReturnType<HelloPlugin>;
+export = hello;

package/fixtures/hello-client/hello/hello.openapi.json

@@ -0,0 +1,22 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Platformatic",
+    "description": "This is a service built on top of Platformatic",
+    "version": "1.0.0"
+  },
+  "components": {
+    "schemas": {}
+  },
+  "paths": {
+    "/": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "Default Response"
+          }
+        }
+      }
+    }
+  }
+}

package/fixtures/hello-client/hello/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "hello",
+  "main": "./hello.cjs",
+  "types": "./hello.d.ts"
+}

package/fixtures/hello-client/platformatic.service.json

@@ -0,0 +1,17 @@
+{
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": 0,
+    "logger": {
+      "level": "info"
+    }
+  },
+  "plugins": {
+    "paths": ["./plugin.js"]
+  },
+  "clients": [{
+    "path": "./hello",
+    "url": "{PLT_CLIENT_URL}"
+  }],
+  "metrics": false
+}

package/fixtures/hello-client/plugin.js

@@ -0,0 +1,8 @@
+'use default'
+
+/**  @type {import('fastify').FastifyPluginAsync<{ optionA: boolean, optionB: string }>} */
+module.exports = async function (app) {
+  app.get('/', async () => {
+    return app.hello.get()
+  })
+}

package/fixtures/hello-client-ts/dist/plugin.js

@@ -0,0 +1,21 @@
+"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 });
+/// <reference path="./hello" />
+function default_1(app) {
+    return __awaiter(this, void 0, void 0, function* () {
+        app.get('/', () => __awaiter(this, void 0, void 0, function* () {
+            return app.hello.get({});
+        }));
+    });
+}
+exports.default = default_1;
+//# sourceMappingURL=plugin.js.map

package/fixtures/hello-client-ts/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../plugin.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,gCAAgC;AAEhC,mBAA+B,GAAoB;;QACjD,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAS,EAAE;YACtB,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QAC1B,CAAC,CAAA,CAAC,CAAA;IACJ,CAAC;CAAA;AAJD,4BAIC"}

package/fixtures/hello-client-ts/hello/hello.cjs

@@ -0,0 +1,21 @@
+'use strict'
+
+const pltClient = require('@platformatic/client')
+const { join } = require('path')
+
+async function generateHelloClientPlugin (app, opts) {
+  app.register(pltClient, {
+    type: 'openapi',
+    name: 'hello',
+    path: join(__dirname, 'hello.openapi.json'),
+    url: opts.url
+  })
+}
+
+generateHelloClientPlugin[Symbol.for('plugin-meta')] = {
+  name: 'hello OpenAPI Client'
+}
+generateHelloClientPlugin[Symbol.for('skip-override')] = true
+
+module.exports = generateHelloClientPlugin
+module.exports.default = generateHelloClientPlugin

package/fixtures/hello-client-ts/hello/hello.d.ts

@@ -0,0 +1,34 @@
+import { FastifyPluginAsync } from 'fastify'
+
+interface GetRequest {
+}
+
+interface GetResponse {
+}
+
+interface Hello {
+  get(req: GetRequest): Promise<GetResponse>;
+}
+
+type HelloPlugin = FastifyPluginAsync<NonNullable<hello.HelloOptions>>
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    'hello': Hello;
+  }
+
+  interface FastifyRequest {
+    'hello': Hello;
+  }
+}
+
+declare namespace hello {
+  export interface HelloOptions {
+    url: string
+  }
+  export const hello: HelloPlugin;
+  export { hello as default };
+}
+
+declare function hello(...params: Parameters<HelloPlugin>): ReturnType<HelloPlugin>;
+export = hello;

package/fixtures/hello-client-ts/hello/hello.openapi.json

@@ -0,0 +1,22 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Platformatic",
+    "description": "This is a service built on top of Platformatic",
+    "version": "1.0.0"
+  },
+  "components": {
+    "schemas": {}
+  },
+  "paths": {
+    "/": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "Default Response"
+          }
+        }
+      }
+    }
+  }
+}

package/fixtures/hello-client-ts/hello/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "hello",
+  "main": "./hello.cjs",
+  "types": "./hello.d.ts"
+}

package/fixtures/hello-client-ts/platformatic.service.json

@@ -0,0 +1,18 @@
+{
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": 0,
+    "logger": {
+      "level": "info"
+    }
+  },
+  "plugins": {
+    "paths": ["./plugin.ts"],
+    "typescript": true
+  },
+  "clients": [{
+    "path": "./hello",
+    "url": "{PLT_CLIENT_URL}"
+  }],
+  "metrics": false
+}

package/fixtures/hello-client-ts/plugin.ts

@@ -0,0 +1,8 @@
+import { FastifyInstance } from 'fastify'
+/// <reference path="./hello" />
+
+export default async function (app: FastifyInstance) {
+  app.get('/', async () => {
+    return app.hello.get({})
+  })
+}

package/fixtures/hello-client-ts/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/help/schema.txt

@@ -3,7 +3,7 @@ Update the config schema file:
 * `schema config` - update the JSON schema config available on `platformatic.service.schema.json`
 
 Your configuration on `platformatic.service.json` has a schema defined to improve the developer experience and avoid mistakes when updating the configuration of Platformatic Service.
-When you run `platformatic service init`, a new JSON `$schema` property is added in `platformatic.service.json`. This can allow your IDE to add suggestions (f.e. mandatory/missing fields, types, default values) by opening the config in `platformatic.service.json`.
+When you initialize a new Platformatic service (f.e. running `npm create platformatic@latest`), a new JSON `$schema` property is added in the `platformatic.service.json` config. This can allow your IDE to add suggestions (f.e. mandatory/missing fields, types, default values) by opening the config in `platformatic.service.json`.
 Running `platformatic service schema config` you can update your schema so that it matches well the latest changes available on your config.
 
 

package/index.d.ts

@@ -0,0 +1,18 @@
+import { FastifyInstance, InjectOptions, LightMyRequestResponse } from "fastify"
+
+export type pltServiceHandlerBuildServer = {
+  app: FastifyInstance
+  address: string
+  port: number
+  restart: () => Promise<void>
+  listen: () => Promise<{
+    address: string
+    port: number
+  }>
+  stop: () => Promise<void>
+  inject: (opts: InjectOptions | string) => Promise<LightMyRequestResponse>
+}
+
+declare module '@platformatic/service' {
+  export function buildServer(opts: object, app?: object, ConfigManagerContructor?: object): Promise<pltServiceHandlerBuildServer>
+}

package/index.js

@@ -12,6 +12,8 @@ const compiler = require('./lib/compile')
 const { join, dirname, resolve } = require('path')
 const { readFile } = require('fs/promises')
 const wrapperPath = join(__dirname, 'lib', 'sandbox-wrapper.js')
+const setupOpenAPI = require('./lib/openapi.js')
+const setupGraphQL = require('./lib/graphql.js')
 
 function createServerConfig (config) {
   // convert the config file to a new structure
@@ -49,6 +51,7 @@ async function platformaticService (app, opts, toLoad = []) {
   {
     const fileWatcher = opts.fileWatcher
     const configManager = opts.configManager
+    /* c8 ignore next 3 */
     if (fileWatcher !== undefined) {
       app.platformatic.fileWatcher = fileWatcher
     }
@@ -58,9 +61,31 @@ async function platformaticService (app, opts, toLoad = []) {
     }
   }
 
+  {
+    const serviceConfig = app.platformatic.config?.service
+
+    // for some unknown reason, c8 is not detecting any of this
+    // despite being covered by test/routes.test.js
+    /* c8 ignore next 3 */
+    if (serviceConfig?.openapi) {
+      await setupOpenAPI(app, app.platformatic.config?.service?.openapi)
+    }
+
+    /* c8 ignore next 3 */
+    if (serviceConfig?.graphql) {
+      await setupGraphQL(app, app.platformatic.config?.service?.graphql)
+    }
+  }
+
+  for (const plugin of (app.platformatic.config.clients || [])) {
+    app.register(require(plugin.path), {
+      url: plugin.url
+    })
+  }
+
   if (opts.plugins) {
     // if we don't have a fullPath, let's assume we are in a test and we can use the current working directory
-    const configPath = app.platformatic.configManager.fullPath || process.cwd()
+    const configPath = app.platformatic.configManager.fullPath || join(process.cwd(), 'platformatic.db.json')
     const tsConfigPath = join(dirname(configPath), 'tsconfig.json')
     /* c8 ignore next 21 */
     if (await isFileAccessible(tsConfigPath)) {
@@ -125,6 +150,7 @@ async function platformaticService (app, opts, toLoad = []) {
 
     app.register(require('@fastify/cors'), opts.cors)
   }
+
   if (isKeyEnabled('healthCheck', opts)) {
     app.register(underPressure, {
       exposeStatusRoute: '/status',
@@ -173,6 +199,24 @@ function adjustConfigAfterMerge (options, stash) {
   }
 }
 
+async function adjustHttpsKeyAndCert (arg) {
+  if (typeof arg === 'string') {
+    return arg
+  }
+
+  if (!Array.isArray(arg)) {
+    // { path: pathToKeyOrCert }
+    return readFile(arg.path)
+  }
+
+  // Array of strings or objects.
+  for (let i = 0; i < arg.length; ++i) {
+    arg[i] = await adjustHttpsKeyAndCert(arg[i])
+  }
+
+  return arg
+}
+
 async function buildServer (options, app, ConfigManagerContructor) {
   app = app || platformaticService
   ConfigManagerContructor = ConfigManagerContructor || ConfigManager
@@ -188,6 +232,16 @@ async function buildServer (options, app, ConfigManagerContructor) {
     options = deepmerge({}, options, cm.current)
     options.configManager = cm
     adjustConfigAfterMerge(options, stash)
+
+    if (options.server.https) {
+      options.server.https.key = await adjustHttpsKeyAndCert(options.server.https.key)
+      options.server.https.cert = await adjustHttpsKeyAndCert(options.server.https.cert)
+      options.server = { ...options.server, ...options.server.https }
+      delete options.server.https
+      options.server.protocol = 'https'
+    } else {
+      options.server.protocol = 'http'
+    }
   }
   const serverConfig = createServerConfig(options)
 
@@ -197,9 +251,10 @@ async function buildServer (options, app, ConfigManagerContructor) {
 
   Object.defineProperty(handler, 'url', {
     get () {
+      const protocol = serverConfig.protocol
       const address = handler.address
       const port = handler.port
-      const url = `http://${address}:${port}`
+      const url = `${protocol}://${address}:${port}`
       return url
     }
   })

package/index.test-d.ts

@@ -0,0 +1,27 @@
+import { expectError, expectType } from 'tsd';
+import {
+  FastifyInstance,
+  LightMyRequestResponse,
+} from 'fastify';
+import { pltServiceHandlerBuildServer } from '.';
+
+const server: pltServiceHandlerBuildServer = {
+  app: {} as FastifyInstance,
+  address: 'localhost',
+  port: 3000,
+  restart: async () => {},
+  listen: async () => ({ address: 'localhost', port: 3000 }),
+  stop: async () => {},
+  inject: async () => ({} as LightMyRequestResponse),
+};
+
+expectType<pltServiceHandlerBuildServer>(server);
+expectError<pltServiceHandlerBuildServer>({...server, app: 'WRONG' });
+expectError<pltServiceHandlerBuildServer>({...server, address: 42 });
+expectError<pltServiceHandlerBuildServer>({...server, port: 'WRONG' });
+expectError<pltServiceHandlerBuildServer>({...server, restart: 'WRONG' });
+expectError<pltServiceHandlerBuildServer>({...server, listen: 'WRONG' });
+expectError<pltServiceHandlerBuildServer>({...server, listen: async () => ({ address: 42, port: 3000 }), });
+expectError<pltServiceHandlerBuildServer>({...server, listen: async () => ({ address: 'localhost', port: 'WRONG' }), });
+expectError<pltServiceHandlerBuildServer>({...server, stop: 'WRONG' });
+expectError<pltServiceHandlerBuildServer>({...server, inject: 'WRONG' });

package/lib/compile.js

@@ -64,7 +64,7 @@ async function compile (cwd) {
   }
 
   try {
-    await execa(tscExecutablePath, ['--project', 'tsconfig.json'], { cwd })
+    await execa(tscExecutablePath, ['--project', 'tsconfig.json', '--rootDir', '.'], { cwd })
     logger.info('Typescript compilation completed successfully.')
     return true
   } catch (error) {
@@ -83,7 +83,7 @@ async function compileWatch (cwd) {
   }
 
   try {
-    await execa(tscExecutablePath, ['--project', 'tsconfig.json', '--incremental'], { cwd })
+    await execa(tscExecutablePath, ['--project', 'tsconfig.json', '--incremental', '--rootDir', '.'], { cwd })
     logger.info('Typescript compilation completed successfully. Starting watch mode.')
   } catch (error) {
     throw new Error('Failed to compile typescript files: ' + error)

package/lib/config.js

@@ -1,7 +1,6 @@
 'use strict'
 
 const ConfigManager = require('@platformatic/config')
-const { resolve } = require('path')
 const { schema } = require('./schema')
 
 class ServiceConfigManager extends ConfigManager {
@@ -19,27 +18,6 @@ class ServiceConfigManager extends ConfigManager {
       envWhitelist: ['PORT', ...(opts.envWhitelist || [])]
     })
   }
-
-  _transformConfig () {
-    const fixPluginPath = (plugin) => {
-      // for some reasons c8 does not detect these
-      /* c8 ignore next 3 */
-      if (typeof plugin === 'string') {
-        plugin = { path: plugin }
-      }
-      plugin.path = this._fixRelativePath(plugin.path)
-      return plugin
-    }
-
-    // relative-to-absolute plugin path
-    if (this.current.plugins?.paths) {
-      this.current.plugins.paths = this.current.plugins.paths.map(fixPluginPath)
-    }
-  }
-
-  _fixRelativePath (path) {
-    return resolve(this.dirname, path)
-  }
 }
 
 module.exports = ServiceConfigManager

package/lib/graphql.js

@@ -0,0 +1,21 @@
+'use strict'
+
+const mercurius = require('mercurius')
+const deepmerge = require('@fastify/deepmerge')({ all: true })
+const fp = require('fastify-plugin')
+
+// For some unknown reason, c8 is not detecting any of this
+// despite being covered by test/graphql.test.js
+/* c8 ignore next 12 */
+async function setupGraphQL (app, opts) {
+  if (typeof opts !== 'object') {
+    opts = {}
+  }
+  const graphqlOptions = deepmerge({
+    graphiql: true
+  }, opts)
+
+  app.register(mercurius, graphqlOptions)
+}
+
+module.exports = fp(setupGraphQL)

package/lib/load-config.js

@@ -37,7 +37,12 @@ async function loadConfig (minimistConfig, _args, configOpts = {}, Manager = Con
     }
     await access(args.config)
   } catch (err) {
-    console.error('Missing config file')
+    console.error(`
+Missing config file!
+Be sure to have a config file with one of the following names: ${ourConfigFiles.join('\n')}
+In alternative run "npm create platformatic@latest" to generate a basic plt service config.
+Error: ${err}
+`)
     process.exit(1)
   }