@platformatic/service 0.43.1 → 0.45.0

package/config.d.ts

@@ -108,7 +108,6 @@ export interface PlatformaticService {
       strictPreflight?: boolean;
       hideOptionsRoute?: boolean;
     };
-    [k: string]: unknown;
   };
   plugins?: Plugins;
   metrics?:
@@ -121,8 +120,10 @@ export interface PlatformaticService {
           password: string;
         };
       };
+  telemetry?: OpenTelemetry;
   watch?:
     | {
+        enabled?: boolean | string;
         /**
          * @minItems 1
          */
@@ -175,6 +176,17 @@ export interface Plugins {
         path?: string;
         encapsulate?: boolean;
         maxDepth?: number;
+        autoHooks?: boolean;
+        autoHooksPattern?: string;
+        cascadeHooks?: boolean;
+        overwriteHooks?: boolean;
+        routeParams?: boolean;
+        forceESM?: boolean;
+        ignoreFilter?: string;
+        matchFilter?: string;
+        ignorePattern?: string;
+        scriptPattern?: string;
+        indexPattern?: string;
         options?: {
           [k: string]: unknown;
         };
@@ -193,6 +205,73 @@ export interface Plugins {
     | boolean
     | string;
 }
+export interface OpenTelemetry {
+  /**
+   * The name of the service. Defaults to the folder name if not specified.
+   */
+  serviceName: string;
+  /**
+   * The version of the service (optional)
+   */
+  version?: string;
+  /**
+   * An array of paths to skip when creating spans. Useful for health checks and other endpoints that do not need to be traced.
+   */
+  skip?: {
+    /**
+     * The path to skip. Can be a string or a regex.
+     */
+    path?: string;
+    /**
+     * HTTP method to skip
+     */
+    method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
+    [k: string]: unknown;
+  }[];
+  exporter?:
+    | {
+        type?: "console" | "otlp" | "zipkin" | "memory";
+        /**
+         * Options for the exporter. These are passed directly to the exporter.
+         */
+        options?: {
+          /**
+           * The URL to send the traces to. Not used for console or memory exporters.
+           */
+          url?: string;
+          /**
+           * Headers to send to the exporter. Not used for console or memory exporters.
+           */
+          headers?: {
+            [k: string]: unknown;
+          };
+          [k: string]: unknown;
+        };
+        additionalProperties?: never;
+        [k: string]: unknown;
+      }[]
+    | {
+        type?: "console" | "otlp" | "zipkin" | "memory";
+        /**
+         * Options for the exporter. These are passed directly to the exporter.
+         */
+        options?: {
+          /**
+           * The URL to send the traces to. Not used for console or memory exporters.
+           */
+          url?: string;
+          /**
+           * Headers to send to the exporter. Not used for console or memory exporters.
+           */
+          headers?: {
+            [k: string]: unknown;
+          };
+          [k: string]: unknown;
+        };
+        additionalProperties?: never;
+        [k: string]: unknown;
+      };
+}
 export interface Info {
   title: string;
   summary?: string;
@@ -293,7 +372,6 @@ export interface Operation {
   callbacks?: {
     [k: string]: CallbacksOrReference;
   };
-  deprecated?: boolean;
   security?: SecurityRequirement[];
   servers?: Server[];
   /**

package/index.d.ts

@@ -1,18 +1,17 @@
 /* eslint-disable @typescript-eslint/triple-slash-reference */
-/// <reference types="@platformatic/types" />
 /// <reference types="mercurius" />
 /// <reference types="@fastify/swagger" />
 import { FastifyInstance } from 'fastify'
 import ConfigManager from '@platformatic/config'
 import { PlatformaticService } from './config'
 
-declare module '@platformatic/types' {
-  interface PlatformaticApp {
-    configManager: ConfigManager<PlatformaticService>
-    config: PlatformaticService
-  }
+export interface PlatformaticApp<T> {
+  configManager: ConfigManager<T>
+  config: T
 }
 
+export type PlatformaticServiceConfig = PlatformaticService
+
 export function buildServer (opts: object, app?: object, ConfigManagerContructor?: object): Promise<FastifyInstance>
 
 declare module 'fastify' {

package/index.test-d.ts

@@ -1,11 +1,17 @@
 import { expectType } from 'tsd'
 import { FastifyInstance } from 'fastify'
-import { buildServer } from '.'
+import { buildServer, PlatformaticApp } from '.'
 import ConfigManager from '@platformatic/config'
 import { OpenAPI } from 'openapi-types'
 import type { MercuriusPlugin } from 'mercurius'
 import { PlatformaticService } from './config'
 
+declare module 'fastify' {
+  interface FastifyInstance {
+    platformatic: PlatformaticApp<PlatformaticService>
+  }
+}
+
 const server = await buildServer({
 })
 

package/lib/gen-types.mjs

@@ -0,0 +1,40 @@
+import { join, dirname } from 'path'
+import { createRequire } from 'module'
+import { writeFile } from 'fs/promises'
+import pino from 'pino'
+import pretty from 'pino-pretty'
+import { loadConfig } from '@platformatic/config'
+import { platformaticService } from '../index.js'
+import { checkForDependencies } from '@platformatic/utils'
+
+const GLOBAL_TYPES_TEMPLATE = `
+import { FastifyInstance } from 'fastify'
+import { PlatformaticApp, PlatformaticServiceConfig } from '@platformatic/service'
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    platformatic: PlatformaticApp<PlatformaticServiceConfig>
+  }
+}
+`
+async function execute ({ logger, configManager }) {
+  const fileNameOrThen = join(dirname(configManager.fullPath), 'global.d.ts')
+  await writeFile(fileNameOrThen, GLOBAL_TYPES_TEMPLATE)
+}
+
+async function generateTypes (_args) {
+  const logger = pino(pretty({
+    translateTime: 'SYS:HH:MM:ss',
+    ignore: 'hostname,pid'
+  }))
+
+  const { configManager, args } = await loadConfig({}, _args, platformaticService)
+
+  await configManager.parseAndValidate()
+  const config = configManager.current
+
+  await execute({ logger, configManager })
+  await checkForDependencies(logger, args, createRequire(import.meta.url), config, ['@platformatic/service'])
+}
+
+export { execute, generateTypes }

package/lib/openapi-schema-defs.js

@@ -290,10 +290,6 @@ const $defs = {
           $ref: '#/$defs/callbacks-or-reference'
         }
       },
-      deprecated: {
-        default: false,
-        type: 'boolean'
-      },
       security: {
         type: 'array',
         items: {
@@ -347,10 +343,6 @@ const $defs = {
         default: false,
         type: 'boolean'
       },
-      deprecated: {
-        default: false,
-        type: 'boolean'
-      },
       content: {
         type: 'object',
         $ref: '#/$defs/content',
@@ -712,10 +704,6 @@ const $defs = {
         default: false,
         type: 'boolean'
       },
-      deprecated: {
-        default: false,
-        type: 'boolean'
-      },
       content: {
         type: 'object',
         $ref: '#/$defs/content',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "0.43.1",
+  "version": "0.45.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -65,12 +65,11 @@
     "pino-pretty": "^10.0.0",
     "rfdc": "^1.3.0",
     "ua-parser-js": "^1.0.35",
-    "@platformatic/client": "0.43.1",
-    "@platformatic/config": "0.43.1",
-    "@platformatic/swagger-ui-theme": "0.43.1",
-    "@platformatic/types": "0.43.1",
-    "@platformatic/utils": "0.43.1",
-    "@platformatic/telemetry": "0.43.1"
+    "@platformatic/client": "0.45.0",
+    "@platformatic/config": "0.45.0",
+    "@platformatic/swagger-ui-theme": "0.45.0",
+    "@platformatic/utils": "0.45.0",
+    "@platformatic/telemetry": "0.45.0"
   },
   "standard": {
     "ignore": [

package/service.mjs

@@ -6,7 +6,9 @@ import isMain from 'es-main'
 import helpMe from 'help-me'
 import { readFile } from 'fs/promises'
 import { join } from 'desm'
+import { printAndExitLoadConfigError } from '@platformatic/config'
 import { generateJsonSchemaConfig } from './lib/gen-schema.js'
+import { generateTypes } from './lib/gen-types.mjs'
 
 import { buildCompileCmd } from './lib/compile.js'
 
@@ -18,20 +20,30 @@ const help = helpMe({
   ext: '.txt'
 })
 
+function wrapCommand (fn) {
+  return async function (...args) {
+    try {
+      return await fn(...args)
+      /* c8 ignore next 3 */
+    } catch (err) {
+      printAndExitLoadConfigError(err)
+    }
+  }
+}
+
 const program = commist({ maxDistance: 2 })
 
 program.register('help', help.toStdout)
 program.register('help start', help.toStdout.bind(null, ['start']))
 
 program.register('start', (argv) => {
-  start(platformaticService, argv).catch((err) => {
-    /* c8 ignore next 2 */
-    console.error(err)
-    process.exit(1)
-  })
+  /* c8 ignore next 1 */
+  start(platformaticService, argv).catch(printAndExitLoadConfigError)
 })
+
 program.register('compile', buildCompileCmd(platformaticService))
-program.register('schema config', generateJsonSchemaConfig)
+program.register('types', wrapCommand(generateTypes))
+program.register('schema config', wrapCommand(generateJsonSchemaConfig))
 program.register('schema', help.toStdout.bind(null, ['schema']))
 
 export async function runService (argv) {

package/test/cli/compile-1.test.mjs

@@ -9,8 +9,9 @@ import { cliPath, safeKill } from './helper.mjs'
 import { fileURLToPath } from 'url'
 
 let count = 0
+const isWin = os.platform() === 'win32'
 
-if (os.platform() !== 'win32') {
+if (!isWin) {
   t.jobs = 5
 }
 t.setTimeout(360000)
@@ -266,7 +267,7 @@ t.test('should compile typescript plugin with start command with different cwd',
   t.fail('should compile typescript plugin with start command')
 })
 
-t.test('valid tsconfig file inside an inner folder', async (t) => {
+t.test('valid tsconfig file inside an inner folder', { skip: isWin }, async (t) => {
   const testDir = path.join(urlDirname(import.meta.url), '..', 'fixtures', 'typescript-plugin')
   const cwd = await getCWD(t)
 
@@ -498,3 +499,34 @@ t.test('should not compile typescript plugin with start without tsconfig', async
     t.equal(err.stdout.includes('No typescript configuration file was found, skipping compilation.'), true)
   }
 })
+
+t.test('should compile ts app with config', async (t) => {
+  const testDir = path.join(urlDirname(import.meta.url), '..', 'fixtures', 'hello-ts-with-config')
+  const cwd = await getCWD(t)
+
+  await cp(testDir, cwd, { recursive: true })
+
+  const child = execa('node', [cliPath, 'compile'], { cwd })
+
+  t.teardown(exitOnTeardown(child))
+
+  const splitter = split()
+  child.stdout.pipe(splitter)
+
+  for await (const data of splitter) {
+    const sanitized = stripAnsi(data)
+    if (sanitized.includes('Typescript compilation completed successfully.')) {
+      const jsPluginPath = path.join(cwd, 'dist', 'plugin.js')
+      try {
+        await access(jsPluginPath)
+      } catch (err) {
+        t.fail(err)
+      }
+
+      t.pass()
+      return
+    }
+  }
+
+  t.fail('should compile typescript plugin with a compile command')
+})

package/test/cli/gen-types.test.mjs

@@ -0,0 +1,30 @@
+import { cliPath } from './helper.mjs'
+import { test } from 'tap'
+import { join } from 'desm'
+import { execa } from 'execa'
+import { readFile, unlink } from 'fs/promises'
+
+const GLOBAL_TYPES_TEMPLATE = `
+import { FastifyInstance } from 'fastify'
+import { PlatformaticApp, PlatformaticServiceConfig } from '@platformatic/service'
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    platformatic: PlatformaticApp<PlatformaticServiceConfig>
+  }
+}
+`
+
+test('generate global.d.ts', async ({ equal }) => {
+  const fileNameOrThen = join(import.meta.url, '..', '..', 'fixtures', 'hello', 'global.d.ts')
+  try {
+    await unlink(fileNameOrThen)
+  } catch {}
+
+  await execa('node', [cliPath, 'types', '-c', join(import.meta.url, '..', '..', 'fixtures', 'hello', 'platformatic.service.json')])
+
+  const data = await readFile(fileNameOrThen, 'utf-8')
+  await unlink(fileNameOrThen)
+
+  equal(data, GLOBAL_TYPES_TEMPLATE)
+})

package/test/cli/validations.test.mjs

@@ -3,6 +3,7 @@ import { test } from 'tap'
 import { join } from 'desm'
 import { readFile } from 'fs/promises'
 import { execa } from 'execa'
+import stripAnsi from 'strip-ansi'
 
 const version = JSON.parse(await readFile(join(import.meta.url, '..', '..', 'package.json'))).version
 
@@ -21,7 +22,7 @@ test('print validation errors', async ({ equal, plan }) => {
     await execa('node', [cliPath, 'start', '--config', join(import.meta.url, '..', 'fixtures', 'missing-property.config.json')])
   } catch (err) {
     equal(err.exitCode, 1)
-    equal(err.stdout, `
+    equal(stripAnsi(err.stdout), `
 ┌─────────┬──────┬─────────────────────────────────────────────────────────────────────┐
 │ (index) │ path │                               message                               │
 ├─────────┼──────┼─────────────────────────────────────────────────────────────────────┤

package/test/fixtures/hello-ts-with-config/global.d.ts

@@ -0,0 +1,8 @@
+import { FastifyInstance } from 'fastify'
+import { PlatformaticApp, PlatformaticServiceConfig } from '../../../index'
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    platformatic: PlatformaticApp<PlatformaticServiceConfig>
+  }
+}

package/test/fixtures/hello-ts-with-config/platformatic.service.json

@@ -0,0 +1,16 @@
+{
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": 0,
+    "logger": {
+      "level": "info"
+    },
+    "pluginTimeout": 30000
+  },
+  "plugins": {
+    "paths": ["./plugin.ts"],
+    "typescript": true
+  },
+  "metrics": false,
+  "watch": false
+}

package/test/fixtures/hello-ts-with-config/plugin.ts

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

package/test/fixtures/hello-ts-with-config/tsconfig.json

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