@platformatic/service 0.28.1 → 0.29.0

package/fixtures/hello-client-ts-without-deps/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-without-deps/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-without-deps/platformatic.service.json

@@ -0,0 +1,23 @@
+{
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": 0,
+    "logger": {
+      "level": "warn",
+      "name": "hello client ts"
+    },
+    "pluginTimeout": 30000
+  },
+  "plugins": {
+    "paths": ["./plugin.ts"],
+    "typescript": true
+  },
+  "clients": [{
+    "schema": "./hello.openapi.json",
+    "name": "hello",
+    "type": "openapi",
+    "url": "{PLT_CLIENT_URL}"
+  }],
+  "metrics": false,
+  "watch": false
+}

package/fixtures/hello-client-ts-without-deps/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-without-deps/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/fixtures/hello-client-without-deps/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-without-deps/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-without-deps/platformatic.service.json

@@ -0,0 +1,21 @@
+{
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": 0,
+    "logger": {
+      "level": "warn",
+      "name": "hello client"
+    }
+  },
+  "plugins": {
+    "paths": ["./plugin.js"]
+  },
+  "clients": [{
+    "schema": "./hello.openapi.json",
+    "name": "hello",
+    "type": "openapi",
+    "url": "{PLT_CLIENT_URL}"
+  }],
+  "metrics": false,
+  "watch": false
+}

package/fixtures/hello-client-without-deps/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/help/compile.txt

@@ -1,9 +1,10 @@
 Compile typescript plugins.
+
 ``` bash
   $ platformatic service compile
 ```
 
-As a result of executing this command, the Platformatic DB will compile typescript
+As a result of executing this command, Platformatic Service will compile typescript
 plugins in the `outDir` directory. 
 
 If not specified, the configuration specified will be loaded from

package/lib/plugins/clients.js

@@ -1,11 +1,15 @@
 'use strict'
 
 const fp = require('fastify-plugin')
+const client = require('@platformatic/client')
 
 async function setupClients (app, opts) {
-  const clientsConfig = opts
-  for (const { path, url } of clientsConfig) {
-    app.register(require(path), { url })
+  for (const { path, url, serviceId, name, schema, type } of opts) {
+    if (path) {
+      app.register(require(path), { url, serviceId })
+    } else {
+      app.register(client, { url, serviceId, name, path: schema, type })
+    }
   }
 }
 

package/lib/plugins/plugins.js

@@ -12,24 +12,26 @@ async function loadPlugins (app) {
   const configManager = app.platformatic.configManager
   const config = configManager.current
 
-  if (config.plugins.typescript) {
-    const workingDir = configManager.dirname
-    const tsConfigPath = join(workingDir, 'tsconfig.json')
-
-    const isTsConfigAccessible = await isFileAccessible(tsConfigPath)
-    if (!isTsConfigAccessible) {
-      throw new Error('Cannot load typescript plugin, tsconfig.json not found')
-    }
+  const workingDir = configManager.dirname
+  const tsConfigPath = join(workingDir, 'tsconfig.json')
 
+  // If the tsconfig.json file exists, then we need to adjust the plugin paths
+  // to point to the compiled JS files.
+  const isTsConfigAccessible = await isFileAccessible(tsConfigPath)
+  if (isTsConfigAccessible) {
     const tsConfig = JSON.parse(await readFile(tsConfigPath, 'utf8'))
     const outDir = resolve(workingDir, tsConfig.compilerOptions.outDir)
 
-    config.plugins.paths = config.plugins.paths.map((plugin) => {
-      /* c8 ignore next 3 */
-      return typeof plugin === 'string'
-        ? getJSPluginPath(workingDir, plugin, outDir)
-        : { ...plugin, path: getJSPluginPath(workingDir, plugin.path, outDir) }
-    })
+    const isOutDirAccessible = await isFileAccessible(outDir)
+
+    if (isOutDirAccessible) {
+      config.plugins.paths = config.plugins.paths.map((plugin) => {
+        /* c8 ignore next 3 */
+        return typeof plugin === 'string'
+          ? getJSPluginPath(workingDir, plugin, outDir)
+          : { ...plugin, path: getJSPluginPath(workingDir, plugin.path, outDir) }
+      })
+    }
   }
 
   await app.register(require(wrapperPath), { paths: config.plugins.paths })

package/lib/schema.js

@@ -390,7 +390,11 @@ const plugins = {
       type: 'integer'
     },
     typescript: {
-      type: 'boolean'
+      anyOf: [{
+        type: 'boolean'
+      }, {
+        type: 'string'
+      }]
     }
   },
   additionalProperties: false,
@@ -403,7 +407,12 @@ const metrics = {
     {
       type: 'object',
       properties: {
-        port: { type: 'integer' },
+        port: {
+          anyOf: [
+            { type: 'integer' },
+            { type: 'string' }
+          ]
+        },
         hostname: { type: 'string' },
         auth: {
           type: 'object',
@@ -515,16 +524,26 @@ const clients = {
       serviceId: {
         type: 'string'
       },
+      name: {
+        type: 'string'
+      },
+      type: {
+        type: 'string',
+        enum: ['openapi', 'graphql']
+      },
       path: {
         type: 'string',
         resolvePath: true
       },
+      schema: {
+        type: 'string',
+        resolvePath: true
+      },
       url: {
         type: 'string'
       }
     },
-    additionalProperties: false,
-    required: ['path', 'url']
+    additionalProperties: false
   }
 }
 
@@ -538,6 +557,8 @@ const platformaticServiceSchema = {
     watch: {
       anyOf: [watch, {
         type: 'boolean'
+      }, {
+        type: 'string'
       }]
     },
     $schema: {

package/package.json

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

package/test/cli/compile.test.mjs

@@ -284,3 +284,100 @@ t.test('should compile typescript plugin with start command from a folder', asyn
   }
   t.fail('should compile typescript plugin with start command')
 })
+
+t.test('should start the service if it was precompiled and typescript is `false`', async (t) => {
+  const testDir = path.join(urlDirname(import.meta.url), '..', 'fixtures', 'typescript-plugin-nocompile')
+  const cwd = path.join(urlDirname(import.meta.url), '..', 'tmp', 'typescript-plugin-clone-9')
+
+  await cp(testDir, cwd, { recursive: true })
+
+  await execa('node', [cliPath, 'compile'], { cwd })
+
+  const child = execa('node', [cliPath, 'start'], { cwd })
+
+  const splitter = split()
+  child.stdout.pipe(splitter)
+
+  for await (const data of splitter) {
+    const sanitized = stripAnsi(data)
+    if (sanitized.includes('Typescript plugin loaded')) {
+      t.pass()
+      return
+    }
+  }
+  t.fail('should load the typescript plugin without compiling it')
+})
+
+t.test('should not start the service if it was not precompiled and typescript is `false`', async (t) => {
+  const testDir = path.join(urlDirname(import.meta.url), '..', 'fixtures', 'typescript-plugin-nocompile')
+  const cwd = path.join(urlDirname(import.meta.url), '..', 'tmp', 'typescript-plugin-clone-10')
+
+  await cp(testDir, cwd, { recursive: true })
+
+  const child = execa('node', [cliPath, 'start'], { cwd })
+
+  const splitter = split()
+  child.stdout.pipe(splitter)
+  child.stderr.pipe(splitter)
+
+  for await (const data of splitter) {
+    const sanitized = stripAnsi(data)
+    if (sanitized.includes('Unknown file extension ".ts" for')) {
+      t.pass()
+      return
+    }
+  }
+  t.fail('should load the typescript plugin without compiling it')
+})
+
+t.test('should compile typescript plugin with string config', async (t) => {
+  const testDir = path.join(urlDirname(import.meta.url), '..', 'fixtures', 'typescript-plugin-string')
+  const cwd = path.join(urlDirname(import.meta.url), '..', 'tmp', 'typescript-plugin-clone-11')
+
+  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')
+})
+
+t.test('should not start the service if it was not precompiled and typescript is `"false"`', async (t) => {
+  const testDir = path.join(urlDirname(import.meta.url), '..', 'fixtures', 'typescript-plugin-nocompile')
+  const cwd = path.join(urlDirname(import.meta.url), '..', 'tmp', 'typescript-plugin-clone-12')
+
+  await cp(testDir, cwd, { recursive: true })
+
+  const child = execa('node', [cliPath, 'start'], { cwd })
+
+  const splitter = split()
+  child.stdout.pipe(splitter)
+  child.stderr.pipe(splitter)
+
+  for await (const data of splitter) {
+    const sanitized = stripAnsi(data)
+    if (sanitized.includes('Unknown file extension ".ts" for')) {
+      t.pass()
+      return
+    }
+  }
+  t.fail('should load the typescript plugin without compiling it')
+})

package/test/clients.test.js

@@ -60,3 +60,56 @@ test('client is loaded (ts)', async ({ teardown, equal, pass, same }) => {
   const data = await res.body.json()
   same(data, { hello: 'world' })
 })
+
+test('client is loaded dependencyless', async ({ teardown, equal, same }) => {
+  const app1 = await buildServer(join(__dirname, '..', 'fixtures', 'hello', 'warn-log.service.json'))
+
+  teardown(async () => {
+    await app1.close()
+  })
+  await app1.start()
+
+  process.env.PLT_CLIENT_URL = app1.url
+
+  const app2 = await buildServer(join(__dirname, '..', 'fixtures', 'hello-client-without-deps', 'platformatic.service.json'))
+
+  teardown(async () => {
+    await app2.close()
+  })
+  await app2.start()
+
+  const res = await request(`${app2.url}/`)
+  equal(res.statusCode, 200, 'status code')
+  const data = await res.body.json()
+  same(data, { hello: 'world' })
+})
+
+test('client is loaded (ts) depencyless', async ({ teardown, equal, pass, same }) => {
+  const app1 = await buildServer(join(__dirname, '..', 'fixtures', 'hello', 'warn-log.service.json'))
+
+  teardown(async () => {
+    await app1.close()
+  })
+  await app1.start()
+
+  process.env.PLT_CLIENT_URL = app1.url
+
+  const targetDir = join(__dirname, '..', 'fixtures', 'hello-client-ts-without-deps')
+
+  try {
+    await rmdir(join(targetDir, 'dist'))
+  } catch {}
+
+  await compile(targetDir, { server: { logger: { level: 'warn' } } })
+
+  const app2 = await buildServer(join(targetDir, 'platformatic.service.json'))
+  teardown(async () => {
+    await app2.close()
+  })
+  await app2.start()
+
+  const res = await request(`${app2.url}/`)
+  equal(res.statusCode, 200, 'status code')
+  const data = await res.body.json()
+  same(data, { hello: 'world' })
+})

package/test/fixtures/typescript-plugin-nocompile-string/platformatic.service.json

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

package/test/fixtures/typescript-plugin-nocompile-string/plugin.ts

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

package/test/fixtures/typescript-plugin-nocompile-string/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/fixtures/typescript-plugin-string/platformatic.service.json

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

package/test/fixtures/typescript-plugin-string/plugin.ts

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

package/test/fixtures/typescript-plugin-string/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"
+    ]
+  }
+}