@platformatic/service 0.32.0 → 0.33.1

package/config.d.ts

@@ -0,0 +1,390 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface PlatformaticService {
+  server: {
+    hostname: string;
+    port: number | string;
+    pluginTimeout?: number;
+    healthCheck?:
+      | boolean
+      | {
+          enabled?: boolean;
+          interval?: number;
+          [k: string]: unknown;
+        };
+    ignoreTrailingSlash?: boolean;
+    ignoreDuplicateSlashes?: boolean;
+    connectionTimeout?: number;
+    keepAliveTimeout?: number;
+    maxRequestsPerSocket?: number;
+    forceCloseConnections?: boolean | string;
+    requestTimeout?: number;
+    bodyLimit?: number;
+    maxParamLength?: number;
+    disableRequestLogging?: boolean;
+    exposeHeadRoutes?: boolean;
+    logger?:
+      | boolean
+      | {
+          level?: string;
+          [k: string]: unknown;
+        };
+    serializerOpts?: {
+      schema?: {
+        [k: string]: unknown;
+      };
+      ajv?: {
+        [k: string]: unknown;
+      };
+      rounding?: "floor" | "ceil" | "round" | "trunc";
+      debugMode?: boolean;
+      mode?: "debug" | "standalone";
+      largeArraySize?: number | string;
+      largeArrayMechanism?: "default" | "json-stringify";
+      [k: string]: unknown;
+    };
+    caseSensitive?: boolean;
+    requestIdHeader?: string | false;
+    requestIdLogLabel?: string;
+    jsonShorthand?: boolean;
+    trustProxy?: boolean | string | string[] | number;
+    https?: {
+      key:
+        | string
+        | {
+            path?: string;
+          }
+        | (
+            | string
+            | {
+                path?: string;
+              }
+          )[];
+      cert:
+        | string
+        | {
+            path?: string;
+          }
+        | (
+            | string
+            | {
+                path?: string;
+              }
+          )[];
+      requestCert?: boolean;
+      rejectUnauthorized?: boolean;
+    };
+    cors?: {
+      origin?:
+        | boolean
+        | string
+        | (
+            | string
+            | {
+                regexp: string;
+                [k: string]: unknown;
+              }
+          )[]
+        | {
+            regexp: string;
+            [k: string]: unknown;
+          };
+      methods?: string[];
+      /**
+       * Comma separated string of allowed headers.
+       */
+      allowedHeaders?: string;
+      exposedHeaders?: string[] | string;
+      credentials?: boolean;
+      maxAge?: number;
+      preflightContinue?: boolean;
+      optionsSuccessStatus?: number;
+      preflight?: boolean;
+      strictPreflight?: boolean;
+      hideOptionsRoute?: boolean;
+    };
+    [k: string]: unknown;
+  };
+  plugins?: Plugins;
+  metrics?:
+    | boolean
+    | {
+        port?: number | string;
+        hostname?: string;
+        auth?: {
+          username: string;
+          password: string;
+        };
+      };
+  watch?:
+    | {
+        /**
+         * @minItems 1
+         */
+        allow?: [string, ...string[]];
+        ignore?: string[];
+      }
+    | boolean
+    | string;
+  $schema?: string;
+  service?: {
+    openapi?:
+      | {
+          info?: Info;
+          jsonSchemaDialect?: string;
+          servers?: Server[];
+          paths?: Paths;
+          webhooks?: {
+            [k: string]: PathItemOrReference;
+          };
+          components?: Components;
+          security?: SecurityRequirement[];
+          tags?: Tag[];
+          externalDocs?: ExternalDocumentation;
+          /**
+           * Base URL for the OpenAPI
+           */
+          prefix?: string;
+        }
+      | boolean;
+    graphql?:
+      | boolean
+      | {
+          graphiql?: boolean;
+          [k: string]: unknown;
+        };
+  };
+  clients?: {
+    serviceId?: string;
+    name?: string;
+    type?: "openapi" | "graphql";
+    path?: string;
+    schema?: string;
+    url?: string;
+  }[];
+}
+export interface Plugins {
+  paths: (
+    | string
+    | {
+        path?: string;
+        encapsulate?: boolean;
+        maxDepth?: number;
+        options?: {
+          [k: string]: unknown;
+        };
+        [k: string]: unknown;
+      }
+  )[];
+  stopTimeout?: number;
+  typescript?:
+    | {
+        enabled?: boolean | string;
+        tsConfig?: string;
+        outDir?: string;
+        flags?: string[];
+        [k: string]: unknown;
+      }
+    | boolean
+    | string;
+}
+export interface Info {
+  title: string;
+  summary?: string;
+  description?: string;
+  termsOfService?: string;
+  contact?: Contact;
+  license?: License;
+  version: string;
+  /**
+   * This interface was referenced by `Info`'s JSON-Schema definition
+   * via the `patternProperty` "^x-".
+   */
+  [k: string]: unknown;
+}
+export interface Contact {
+  name?: string;
+  url?: string;
+  email?: string;
+  /**
+   * This interface was referenced by `Contact`'s JSON-Schema definition
+   * via the `patternProperty` "^x-".
+   */
+  [k: string]: unknown;
+}
+export interface License {
+  name: string;
+  identifier?: string;
+  url?: string;
+  /**
+   * This interface was referenced by `License`'s JSON-Schema definition
+   * via the `patternProperty` "^x-".
+   */
+  [k: string]: unknown;
+}
+export interface Server {
+  url: string;
+  description?: string;
+  variables?: {
+    [k: string]: ServerVariable;
+  };
+  /**
+   * This interface was referenced by `Server`'s JSON-Schema definition
+   * via the `patternProperty` "^x-".
+   */
+  [k: string]: unknown;
+}
+export interface ServerVariable {
+  /**
+   * @minItems 1
+   */
+  enum?: [string, ...string[]];
+  default: string;
+  description?: string;
+  /**
+   * This interface was referenced by `ServerVariable`'s JSON-Schema definition
+   * via the `patternProperty` "^x-".
+   */
+  [k: string]: unknown;
+}
+export interface Paths {
+  [k: string]: PathItem;
+}
+/**
+ * This interface was referenced by `Paths`'s JSON-Schema definition
+ * via the `patternProperty` "^/".
+ */
+export interface PathItem {
+  summary?: string;
+  description?: string;
+  servers?: Server[];
+  parameters?: ParameterOrReference[];
+  get?: Operation;
+  put?: Operation;
+  post?: Operation;
+  delete?: Operation;
+  options?: Operation;
+  head?: Operation;
+  patch?: Operation;
+  trace?: Operation;
+  /**
+   * This interface was referenced by `PathItem`'s JSON-Schema definition
+   * via the `patternProperty` "^x-".
+   */
+  [k: string]: unknown;
+}
+export interface ParameterOrReference {
+  [k: string]: unknown;
+}
+export interface Operation {
+  tags?: string[];
+  summary?: string;
+  description?: string;
+  externalDocs?: ExternalDocumentation;
+  operationId?: string;
+  parameters?: ParameterOrReference[];
+  requestBody?: RequestBodyOrReference;
+  responses?: Responses;
+  callbacks?: {
+    [k: string]: CallbacksOrReference;
+  };
+  deprecated?: boolean;
+  security?: SecurityRequirement[];
+  servers?: Server[];
+  /**
+   * This interface was referenced by `Operation`'s JSON-Schema definition
+   * via the `patternProperty` "^x-".
+   */
+  [k: string]: unknown;
+}
+export interface ExternalDocumentation {
+  description?: string;
+  url: string;
+  /**
+   * This interface was referenced by `ExternalDocumentation`'s JSON-Schema definition
+   * via the `patternProperty` "^x-".
+   */
+  [k: string]: unknown;
+}
+export interface RequestBodyOrReference {
+  [k: string]: unknown;
+}
+export interface Responses {
+  [k: string]: ResponseOrReference;
+}
+export interface ResponseOrReference {
+  [k: string]: unknown;
+}
+export interface CallbacksOrReference {
+  [k: string]: unknown;
+}
+export interface SecurityRequirement {
+  [k: string]: string[];
+}
+export interface PathItemOrReference {
+  [k: string]: unknown;
+}
+export interface Components {
+  schemas?: {
+    [k: string]: unknown;
+  };
+  responses?: {
+    [k: string]: ResponseOrReference;
+  };
+  parameters?: {
+    [k: string]: ParameterOrReference;
+  };
+  examples?: {
+    [k: string]: ExampleOrReference;
+  };
+  requestBodies?: {
+    [k: string]: RequestBodyOrReference;
+  };
+  headers?: {
+    [k: string]: HeaderOrReference;
+  };
+  securitySchemes?: {
+    [k: string]: SecuritySchemeOrReference;
+  };
+  links?: {
+    [k: string]: LinkOrReference;
+  };
+  callbacks?: {
+    [k: string]: CallbacksOrReference;
+  };
+  pathItems?: {
+    [k: string]: PathItemOrReference;
+  };
+  /**
+   * This interface was referenced by `Components`'s JSON-Schema definition
+   * via the `patternProperty` "^x-".
+   */
+  [k: string]: unknown;
+}
+export interface ExampleOrReference {
+  [k: string]: unknown;
+}
+export interface HeaderOrReference {
+  [k: string]: unknown;
+}
+export interface SecuritySchemeOrReference {
+  [k: string]: unknown;
+}
+export interface LinkOrReference {
+  [k: string]: unknown;
+}
+export interface Tag {
+  name: string;
+  description?: string;
+  externalDocs?: ExternalDocumentation;
+  /**
+   * This interface was referenced by `Tag`'s JSON-Schema definition
+   * via the `patternProperty` "^x-".
+   */
+  [k: string]: unknown;
+}

package/index.d.ts

@@ -4,11 +4,12 @@
 /// <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
-    config: object
+    configManager: ConfigManager<PlatformaticService>
+    config: PlatformaticService
   }
 }
 

package/index.js

@@ -11,6 +11,7 @@ const setupMetrics = require('./lib/plugins/metrics')
 const setupTsCompiler = require('./lib/plugins/typescript')
 const setupHealthCheck = require('./lib/plugins/health-check')
 const loadPlugins = require('./lib/plugins/plugins')
+const { telemetry } = require('@platformatic/telemetry')
 
 const { schema } = require('./lib/schema')
 const { loadConfig } = require('./lib/load-config')
@@ -41,6 +42,10 @@ async function platformaticService (app, opts, toLoad = []) {
     await app.register(setupGraphQL, serviceConfig.graphql)
   }
 
+  if (config.telemetry) {
+    app.register(telemetry, config.telemetry)
+  }
+
   if (isKeyEnabled('clients', config)) {
     app.register(setupClients, config.clients)
   }

package/index.test-d.ts

@@ -4,13 +4,15 @@ import { buildServer } from '.'
 import ConfigManager from '@platformatic/config'
 import { OpenAPI } from 'openapi-types'
 import type { MercuriusPlugin } from 'mercurius'
+import { PlatformaticService } from './config'
 
 const server = await buildServer({
 })
 
 expectType<FastifyInstance>(server)
-expectType<ConfigManager>(server.platformatic.configManager)
-expectType<ConfigManager>(server.platformatic.configManager)
+expectType<ConfigManager<PlatformaticService>>(server.platformatic.configManager)
+expectType<PlatformaticService>(server.platformatic.configManager.current)
+expectType<PlatformaticService>(server.platformatic.config)
 expectType<OpenAPI.Document>(server.swagger())
 expectType<MercuriusPlugin>(server.graphql)
 expectType<Promise<void>>(server.restart())

package/lib/openapi-schema-defs.js

@@ -545,31 +545,11 @@ const $defs = {
   responses: {
     $comment: 'https://spec.openapis.org/oas/v3.1.0#responses-object',
     type: 'object',
-    properties: {
-      default: {
-        $ref: '#/$defs/response-or-reference'
-      }
-    },
-    patternProperties: {
-      '^[1-5](?:[0-9]{2}|XX)$': {
-        $ref: '#/$defs/response-or-reference'
-      }
+    additionalProperties: {
+      $ref: '#/$defs/response-or-reference'
     },
     minProperties: 1,
-    $ref: '#/$defs/specification-extensions',
-
-    if: {
-      $comment: 'either default, or at least one response code property must exist',
-      type: 'object',
-      patternProperties: {
-        '^[1-5](?:[0-9]{2}|XX)$': false
-      }
-    },
-    then: {
-      required: [
-        'default'
-      ]
-    }
+    $ref: '#/$defs/specification-extensions'
   },
   response: {
     $comment: 'https://spec.openapis.org/oas/v3.1.0#response-object',

package/lib/schema.js

@@ -5,6 +5,7 @@
 const pkg = require('../package.json')
 const version = 'v' + pkg.version
 const openApiDefs = require('./openapi-schema-defs')
+const telemetry = require('@platformatic/telemetry').schema
 
 const cors = {
   type: 'object',
@@ -574,11 +575,13 @@ const clients = {
 
 const platformaticServiceSchema = {
   $id: `https://platformatic.dev/schemas/${version}/service`,
+  title: 'Platformatic Service',
   type: 'object',
   properties: {
     server,
     plugins,
     metrics,
+    telemetry,
     watch: {
       anyOf: [watch, {
         type: 'boolean'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "0.32.0",
+  "version": "0.33.1",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -20,6 +20,7 @@
     "@fastify/aws-lambda": "^3.2.0",
     "bindings": "^1.5.0",
     "c8": "^8.0.0",
+    "json-schema-to-typescript": "^13.0.2",
     "openapi-types": "^12.1.3",
     "self-cert": "^2.0.0",
     "snazzy": "^9.0.0",
@@ -64,11 +65,12 @@
     "pino-pretty": "^10.0.0",
     "rfdc": "^1.3.0",
     "ua-parser-js": "^1.0.35",
-    "@platformatic/client": "0.32.0",
-    "@platformatic/config": "0.32.0",
-    "@platformatic/swagger-ui-theme": "0.32.0",
-    "@platformatic/types": "0.32.0",
-    "@platformatic/utils": "0.32.0"
+    "@platformatic/client": "0.33.1",
+    "@platformatic/config": "0.33.1",
+    "@platformatic/swagger-ui-theme": "0.33.1",
+    "@platformatic/types": "0.33.1",
+    "@platformatic/utils": "0.33.1",
+    "@platformatic/telemetry": "0.33.1"
   },
   "standard": {
     "ignore": [
@@ -84,6 +86,7 @@
   },
   "scripts": {
     "test": "pnpm run lint && c8 --100 tap test/*test.js test/*/*.test.mjs && tsd",
+    "build": "node lib/schema.js | json2ts > config.d.ts",
     "lint": "standard | snazzy && ts-standard | snazzy"
   }
 }

package/test/telemetry.test.js

@@ -0,0 +1,87 @@
+'use strict'
+
+const { buildConfig } = require('./helper')
+const { test } = require('tap')
+const { buildServer } = require('..')
+const { request } = require('undici')
+const { join } = require('path')
+const os = require('os')
+const { writeFile } = require('fs/promises')
+
+test('should not configure telemetry if not configured', async ({ teardown, equal, pass, same }) => {
+  const app = await buildServer(buildConfig({
+    server: {
+      hostname: '127.0.0.1',
+      port: 0
+    }
+  }))
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+  equal(app.openTelemetry, undefined)
+})
+
+test('should setup telemetry if configured', async ({ teardown, equal, pass, same }) => {
+  const file = join(os.tmpdir(), `${process.pid}-1.js`)
+
+  await writeFile(file, `
+    module.exports = async function (app, options) {
+      app.get('/', () => options.message)
+    }`)
+
+  const app = await buildServer(buildConfig({
+    server: {
+      hostname: '127.0.0.1',
+      port: 0
+    },
+
+    telemetry: {
+      serviceName: 'test-service',
+      version: '1.0.0',
+      exporter: {
+        type: 'memory'
+      }
+    },
+    plugins: {
+      paths: [{
+        path: file,
+        options: {
+          message: 'hello'
+        }
+      }]
+    }
+  }))
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
+  const res = await request(`${app.url}/`, {
+    method: 'GET',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify({
+      query: `
+          mutation {
+            savePage(input: { title: "Hello" }) {
+              id
+              title
+            }
+          }
+        `
+    })
+  })
+  equal(res.statusCode, 200, 'savePage status code')
+  const { exporter } = app.openTelemetry
+  const finishedSpans = exporter.getFinishedSpans()
+  equal(finishedSpans.length, 1)
+  const span = finishedSpans[0]
+  equal(span.name, 'GET /')
+  equal(span.attributes['req.method'], 'GET')
+  equal(span.attributes['req.url'], '/')
+  equal(span.attributes['reply.statusCode'], 200)
+})