@platformatic/service 0.17.1 → 0.18.0

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.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,25 @@ 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)
+    }
+  }
+
   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 +144,7 @@ async function platformaticService (app, opts, toLoad = []) {
 
     app.register(require('@fastify/cors'), opts.cors)
   }
+
   if (isKeyEnabled('healthCheck', opts)) {
     app.register(underPressure, {
       exposeStatusRoute: '/status',

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/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)
   }