282 changes: 282 additions & 0 deletions packages/composer/test/openapi/routes-composition.test.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,282 @@
'use strict'

const { join } = require('node:path')
const { test } = require('tap')
const { default: OpenAPISchemaValidator } = require('openapi-schema-validator')
const {
createComposer,
createOpenApiService,
testEntityRoutes
} = require('../helper')

const openApiValidator = new OpenAPISchemaValidator({ version: 3 })

test('should compose openapi with prefixes', async (t) => {
const api1 = await createOpenApiService(t, ['users'])
const api2 = await createOpenApiService(t, ['posts'])

await api1.listen({ port: 0 })
await api2.listen({ port: 0 })

const composer = await createComposer(t, {
composer: {
services: [
{
id: 'api1',
origin: 'http://127.0.0.1:' + api1.server.address().port,
openapi: {
url: '/documentation/json',
prefix: '/api1'
}
},
{
id: 'api2',
origin: 'http://127.0.0.1:' + api2.server.address().port,
openapi: {
url: '/documentation/json',
prefix: '/api2'
}
}
]
}
})

const { statusCode, body } = await composer.inject({
method: 'GET',
url: '/documentation/json'
})
t.equal(statusCode, 200)

const openApiSchema = JSON.parse(body)
openApiValidator.validate(openApiSchema)

await testEntityRoutes(t, composer, ['/api1/users', '/api2/posts'])
})

test('should compose openapi without prefixes', async (t) => {
const api1 = await createOpenApiService(t, ['users'])
const api2 = await createOpenApiService(t, ['posts'])

await api1.listen({ port: 0 })
await api2.listen({ port: 0 })

const composer = await createComposer(t, {
composer: {
services: [
{
id: 'api1',
origin: 'http://127.0.0.1:' + api1.server.address().port,
openapi: {
url: '/documentation/json'
}
},
{
id: 'api2',
origin: 'http://127.0.0.1:' + api2.server.address().port,
openapi: {
url: '/documentation/json'
}
}
]
}
})

const { statusCode, body } = await composer.inject({
method: 'GET',
url: '/documentation/json'
})
t.equal(statusCode, 200)

const openApiSchema = JSON.parse(body)
openApiValidator.validate(openApiSchema)

await testEntityRoutes(t, composer, ['/users', '/posts'])
})

test('should read schemas from disk and compose openapi', async (t) => {
const api1 = await createOpenApiService(t, ['users'])
const api2 = await createOpenApiService(t, ['posts'])

await api1.listen({ port: 0 })
await api2.listen({ port: 0 })

const composer = await createComposer(t, {
composer: {
services: [
{
id: 'api1',
origin: 'http://127.0.0.1:' + api1.server.address().port,
openapi: {
url: '/documentation/json'
}
},
{
id: 'api2',
origin: 'http://127.0.0.1:' + api2.server.address().port,
openapi: {
url: '/documentation/json'
}
}
]
}
})

const { statusCode, body } = await composer.inject({
method: 'GET',
url: '/documentation/json'
})
t.equal(statusCode, 200)

const openApiSchema = JSON.parse(body)
openApiValidator.validate(openApiSchema)

await testEntityRoutes(t, composer, ['/users', '/posts'])
})

test('should not proxy request if it is not in a schema file', async (t) => {
const api1 = await createOpenApiService(t, ['users'])
const api2 = await createOpenApiService(t, ['posts'])

api1.get('/not-in-the-schema', async () => {
t.fail('should not proxy request')
})

await api1.listen({ port: 0 })
await api2.listen({ port: 0 })

const composer = await createComposer(t, {
composer: {
services: [
{
id: 'api1',
origin: 'http://127.0.0.1:' + api1.server.address().port,
openapi: {
file: join(__dirname, 'fixtures', 'schemas', 'users.json')
}
},
{
id: 'api2',
origin: 'http://127.0.0.1:' + api2.server.address().port,
openapi: {
file: join(__dirname, 'fixtures', 'schemas', 'posts.json')
}
}
]
}
})

const { statusCode, body } = await composer.inject({
method: 'GET',
url: '/documentation/json'
})
t.equal(statusCode, 200)

const openApiSchema = JSON.parse(body)
openApiValidator.validate(openApiSchema)

t.ok(
!openApiSchema.paths['/not-in-the-schema'],
'should not have the path in the schema'
)

await testEntityRoutes(t, composer, ['/users', '/posts'])

{
const { statusCode } = await composer.inject({
method: 'GET',
url: '/not-in-the-schema'
})
t.equal(statusCode, 404)
}
})

test('should not compose api if there is no openapi config', async (t) => {
const api1 = await createOpenApiService(t, ['users'])
const api2 = await createOpenApiService(t, ['posts'])

await api1.listen({ port: 0 })
await api2.listen({ port: 0 })

const composer = await createComposer(t, {
composer: {
services: [
{
id: 'api1',
origin: 'http://127.0.0.1:' + api1.server.address().port,
openapi: {
url: '/documentation/json',
prefix: '/api1'
}
},
{
id: 'api2',
origin: 'http://127.0.0.1:' + api2.server.address().port
}
]
}
})

const { statusCode, body } = await composer.inject({
method: 'GET',
url: '/documentation/json'
})
t.equal(statusCode, 200)

const openApiSchema = JSON.parse(body)
openApiValidator.validate(openApiSchema)

await testEntityRoutes(t, composer, ['/api1/users'])

{
const { statusCode } = await composer.inject({
method: 'GET',
url: '/api2/posts'
})
t.equal(statusCode, 404)
}
})

test('should allow custom title', async (t) => {
const api1 = await createOpenApiService(t, ['users'])
const api2 = await createOpenApiService(t, ['posts'])

await api1.listen({ port: 0 })
await api2.listen({ port: 0 })

const composer = await createComposer(t, {
composer: {
services: [
{
id: 'api1',
origin: 'http://127.0.0.1:' + api1.server.address().port,
openapi: {
url: '/documentation/json',
prefix: '/api1'
}
},
{
id: 'api2',
origin: 'http://127.0.0.1:' + api2.server.address().port,
openapi: {
url: '/documentation/json',
prefix: '/api2'
}
}
],
openapi: {
title: 'My API',
version: '1.0.42'
}
}
})

const { statusCode, body } = await composer.inject({
method: 'GET',
url: '/documentation/json'
})
t.equal(statusCode, 200)

const openApiSchema = JSON.parse(body)
t.equal(openApiSchema.info.title, 'My API')
t.equal(openApiSchema.info.version, '1.0.42')
})
580 changes: 580 additions & 0 deletions packages/composer/test/openapi/schemas-composition.test.js
View file

Large diffs are not rendered by default.

240 changes: 240 additions & 0 deletions packages/composer/test/openapi/watch-apis.test.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,240 @@
'use strict'

const { setTimeout } = require('node:timers/promises')
const { join } = require('node:path')
const { test } = require('tap')
const { default: OpenAPISchemaValidator } = require('openapi-schema-validator')
const {
createComposer,
createOpenApiService,
testEntityRoutes
} = require('../helper')

const openApiValidator = new OpenAPISchemaValidator({ version: 3 })

test('should compose openapi with prefixes', async (t) => {
const api1 = await createOpenApiService(t, ['users'])
const api2 = await createOpenApiService(t, ['posts'])

await api1.listen({ port: 0 })
await api2.listen({ port: 0 })

const composer = await createComposer(t, {
composer: {
services: [
{
id: 'api1',
origin: 'http://127.0.0.1:' + api1.server.address().port,
openapi: {
url: '/documentation/json',
prefix: '/api1'
}
},
{
id: 'api2',
origin: 'http://127.0.0.1:' + api2.server.address().port,
openapi: {
url: '/documentation/json',
prefix: '/api2'
}
}
],
refreshTimeout: 500
}
})

{
const { statusCode, body } = await composer.inject({
method: 'GET',
url: '/documentation/json'
})
t.equal(statusCode, 200)

const openApiSchema = JSON.parse(body)
openApiValidator.validate(openApiSchema)

await testEntityRoutes(t, composer, ['/api1/users', '/api2/posts'])
}

await api1.close()
await setTimeout(1000)

t.equal(composer.restarted, true)

{
const { statusCode, body } = await composer.inject({
method: 'GET',
url: '/documentation/json'
})
t.equal(statusCode, 200)

const openApiSchema = JSON.parse(body)
openApiValidator.validate(openApiSchema)

await testEntityRoutes(t, composer, ['/api2/posts'])

const { statusCode: statusCode2 } = await composer.inject({
method: 'GET',
url: '/api1/users'
})
t.equal(statusCode2, 404)
}
})

test('should watch api only if it has a url', async (t) => {
const api1 = await createOpenApiService(t, ['users'])
const api2 = await createOpenApiService(t, ['posts'])

await api1.listen({ port: 0 })
await api2.listen({ port: 0 })

const composer = await createComposer(t, {
composer: {
services: [
{
id: 'api1',
origin: 'http://127.0.0.1:' + api1.server.address().port,
openapi: {
url: '/documentation/json',
prefix: '/api1'
}
},
{
id: 'api2',
origin: 'http://127.0.0.1:' + api2.server.address().port,
openapi: {
file: join(__dirname, 'fixtures', 'schemas', 'posts.json'),
prefix: '/api2'
}
}
],
refreshTimeout: 500
}
})

{
const { statusCode, body } = await composer.inject({
method: 'GET',
url: '/documentation/json'
})
t.equal(statusCode, 200)

const openApiSchema = JSON.parse(body)
openApiValidator.validate(openApiSchema)

await testEntityRoutes(t, composer, ['/api1/users', '/api2/posts'])
}

await api2.close()
await setTimeout(1000)

t.equal(composer.restarted, false)

{
const { statusCode, body } = await composer.inject({
method: 'GET',
url: '/documentation/json'
})
t.equal(statusCode, 200)

const openApiSchema = JSON.parse(body)
openApiValidator.validate(openApiSchema)

await testEntityRoutes(t, composer, ['/api1/users'])

const { statusCode: statusCode2 } = await composer.inject({
method: 'GET',
url: '/api2/posts'
})
t.equal(statusCode2, 500)
}
})

test('should compose schema after service restart', async (t) => {
const api1 = await createOpenApiService(t, ['users'])
const api2 = await createOpenApiService(t, ['posts'])

await api1.listen({ port: 0 })
await api2.listen({ port: 0 })

const api1Port = api1.server.address().port
const api2Port = api2.server.address().port

const composer = await createComposer(t, {
composer: {
services: [
{
id: 'api1',
origin: 'http://127.0.0.1:' + api1Port,
openapi: {
url: '/documentation/json',
prefix: '/api1'
}
},
{
id: 'api2',
origin: 'http://127.0.0.1:' + api2Port,
openapi: {
url: '/documentation/json',
prefix: '/api2'
}
}
],
refreshTimeout: 500
}
})

{
const { statusCode, body } = await composer.inject({
method: 'GET',
url: '/documentation/json'
})
t.equal(statusCode, 200)

const openApiSchema = JSON.parse(body)
openApiValidator.validate(openApiSchema)

await testEntityRoutes(t, composer, ['/api1/users', '/api2/posts'])
}

await api1.close()
await setTimeout(1000)

t.equal(composer.restarted, true)

{
const { statusCode, body } = await composer.inject({
method: 'GET',
url: '/documentation/json'
})
t.equal(statusCode, 200)

const openApiSchema = JSON.parse(body)
openApiValidator.validate(openApiSchema)

await testEntityRoutes(t, composer, ['/api2/posts'])

const { statusCode: statusCode2 } = await composer.inject({
method: 'GET',
url: '/api1/users'
})
t.equal(statusCode2, 404)
}

const newApi1 = await createOpenApiService(t, ['users'])
await newApi1.listen({ port: api1Port })
await setTimeout(1000)

{
const { statusCode, body } = await composer.inject({
method: 'GET',
url: '/documentation/json'
})
t.equal(statusCode, 200)

const openApiSchema = JSON.parse(body)
openApiValidator.validate(openApiSchema)

await testEntityRoutes(t, composer, ['/api1/users', '/api2/posts'])
}
})
38 changes: 38 additions & 0 deletions packages/composer/test/runtime.test.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
'use strict'

const { join } = require('path')
const { test } = require('tap')

const { createComposer } = require('./helper')

test('should resolve service ids to the origin', async (t) => {
const composer = await createComposer(t,
{
composer: {
services: [
{
id: 'service1',
openapi: {
file: join(__dirname, 'openapi', 'fixtures', 'schemas', 'users.json')
}
},
{
id: 'service2',
openapi: {
file: join(__dirname, 'openapi', 'fixtures', 'schemas', 'posts.json')
}
}
]
}
}
)

const services = composer.platformatic.config.composer.services
t.equal(services.length, 2)

t.equal(services[0].id, 'service1')
t.equal(services[0].origin, 'http://service1.plt.local')

t.equal(services[1].id, 'service2')
t.equal(services[1].origin, 'http://service2.plt.local')
})
4 changes: 3 additions & 1 deletion packages/config/index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,9 @@ class ConfigManager extends EventEmitter {
// aware of the different application types (but that should be small).
return [
...this.listConfigFiles('service'),
...this.listConfigFiles('db')
...this.listConfigFiles('db'),
...this.listConfigFiles('composer'),
...this.listConfigFiles('runtime')
]
}
}
Expand Down
24 changes: 22 additions & 2 deletions packages/config/test/index.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ test('should look for a .env file in process.cwd() too', async ({ same, fail, pl
})

test('ConfigManager.listConfigFiles() lists possible configs by type', async ({ plan, same }) => {
plan(2)
plan(3)
same(ConfigManager.listConfigFiles('db'), [
'platformatic.db.json',
'platformatic.db.json5',
Expand All @@ -271,6 +271,14 @@ test('ConfigManager.listConfigFiles() lists possible configs by type', async ({
'platformatic.service.toml',
'platformatic.service.tml'
])
same(ConfigManager.listConfigFiles('runtime'), [
'platformatic.runtime.json',
'platformatic.runtime.json5',
'platformatic.runtime.yaml',
'platformatic.runtime.yml',
'platformatic.runtime.toml',
'platformatic.runtime.tml'
])
})

test('ConfigManager.listConfigFiles() lists all possible configs', async ({ plan, same }) => {
Expand All @@ -287,7 +295,19 @@ test('ConfigManager.listConfigFiles() lists all possible configs', async ({ plan
'platformatic.db.yaml',
'platformatic.db.yml',
'platformatic.db.toml',
'platformatic.db.tml'
'platformatic.db.tml',
'platformatic.composer.json',
'platformatic.composer.json5',
'platformatic.composer.yaml',
'platformatic.composer.yml',
'platformatic.composer.toml',
'platformatic.composer.tml',
'platformatic.runtime.json',
'platformatic.runtime.json5',
'platformatic.runtime.yaml',
'platformatic.runtime.yml',
'platformatic.runtime.toml',
'platformatic.runtime.tml'
])
})

Expand Down
5 changes: 3 additions & 2 deletions packages/create-platformatic/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"author": "Marco Piraccini <marco.piraccini@gmail.com>",
"dependencies": {
"@platformatic/config": "workspace:*",
"boring-name-generator": "^1.0.3",
"chalk": "^5.2.0",
"commist": "^3.2.0",
"desm": "^1.3.0",
Expand All @@ -30,13 +31,13 @@
"inquirer": "^9.2.6",
"log-update": "^5.0.1",
"minimist": "^1.2.8",
"mkdirp": "^2.1.6",
"ora": "^6.3.1",
"pino": "^8.14.1",
"pino-pretty": "^10.0.0",
"pupa": "^3.1.0",
"semver": "^7.5.1",
"undici": "^5.22.1"
"undici": "^5.22.1",
"which": "^3.0.1"
},
"devDependencies": {
"@platformatic/db": "workspace:*",
Expand Down
4 changes: 2 additions & 2 deletions ...eate-platformatic/src/ask-project-dir.mjs → packages/create-platformatic/src/ask-dir.mjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ import { validatePath } from './utils.mjs'
import inquirer from 'inquirer'
import { resolve } from 'path'

const askProjectDir = async (logger, defaultName) => {
const askProjectDir = async (logger, defaultName, message = 'Where would you like to create your project?') => {
const options = await inquirer.prompt({
type: 'input',
name: 'dir',
message: 'Where would you like to create your project?',
message,
default: defaultName,
validate: validatePath
})
Expand Down
14 changes: 14 additions & 0 deletions packages/create-platformatic/src/cli-options.mjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,17 @@ export const getUseTypescript = typescript => {
choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
}
}

let port = 3042
export const getPort = (nextPort) => {
if (nextPort === undefined) {
nextPort = port++
}

return {
type: 'input',
name: 'port',
message: 'What port do you want to use?',
default: nextPort
}
}
30 changes: 30 additions & 0 deletions packages/create-platformatic/src/composer/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Platformatic Composer API

This is a generated [Platformatic Composer](https://oss.platformatic.dev/docs/reference/composer/introduction) application.

## Requirements

Platformatic supports macOS, Linux and Windows ([WSL](https://docs.microsoft.com/windows/wsl/) recommended).
You'll need to have [Node.js](https://nodejs.org/) >= v18.8.0

## Setup

1. Install dependencies:

```bash
npm install
```

## Usage

Run the API with:

```bash
npm start
```

### Explore
- âš¡ The Platformatic Composer server is running at http://localhost:3042/
- 📔 View the REST API's Swagger documentation at http://localhost:3042/documentation/


107 changes: 107 additions & 0 deletions packages/create-platformatic/src/composer/create-composer-cli.mjs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
import { getVersion, getDependencyVersion, isFileAccessible } from '../utils.mjs'
import { createPackageJson } from '../create-package-json.mjs'
import { createGitignore } from '../create-gitignore.mjs'
import { getPkgManager } from '../get-pkg-manager.mjs'
import parseArgs from 'minimist'
import { join } from 'path'
import inquirer from 'inquirer'
import { readFile, writeFile, mkdir } from 'fs/promises'
import pino from 'pino'
import pretty from 'pino-pretty'
import { execa } from 'execa'
import ora from 'ora'
import createComposer from './create-composer.mjs'
import askDir from '../ask-dir.mjs'
import { askDynamicWorkspaceCreateGHAction, askStaticWorkspaceGHAction } from '../ghaction.mjs'
import { getRunPackageManagerInstall, getPort } from '../cli-options.mjs'

export const createReadme = async (logger, dir = '.') => {
const readmeFileName = join(dir, 'README.md')
let isReadmeExists = await isFileAccessible(readmeFileName)
if (isReadmeExists) {
logger.debug(`${readmeFileName} found, asking to overwrite it.`)
const { shouldReplace } = await inquirer.prompt([{
type: 'list',
name: 'shouldReplace',
message: 'Do you want to overwrite the existing README.md?',
default: true,
choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
}])
isReadmeExists = !shouldReplace
}

if (isReadmeExists) {
logger.debug(`${readmeFileName} found, skipping creation of README.md file.`)
return
}

const readmeFile = new URL('README.md', import.meta.url)
const readme = await readFile(readmeFile, 'utf-8')
await writeFile(readmeFileName, readme)
logger.debug(`${readmeFileName} successfully created.`)
}

const createPlatformaticComposer = async (_args, opts) => {
const logger = opts.logger || pino(pretty({
translateTime: 'SYS:HH:MM:ss',
ignore: 'hostname,pid'
}))

const args = parseArgs(_args, {
default: {
hostname: '127.0.0.1'
},
alias: {
h: 'hostname',
p: 'port'
}
})

const version = await getVersion()
const pkgManager = getPkgManager()

const projectDir = opts.dir || await askDir(logger, '.')

const toAsk = [getPort(args.port)]

if (!opts.skipPackageJson) {
toAsk.push(getRunPackageManagerInstall(pkgManager))
}

const { runPackageManagerInstall, port } = await inquirer.prompt(toAsk)

// Create the project directory
await mkdir(projectDir, { recursive: true })

const params = {
hostname: args.hostname,
port
}

const env = await createComposer(params, logger, projectDir, version)

const fastifyVersion = await getDependencyVersion('fastify')

// Create the package.json, notes that we don't have the option for TS (yet) so we don't generate
// the package.json with the TS build
if (!opts.skipPackageJson) {
await createPackageJson('composer', version, fastifyVersion, logger, projectDir, false)
}
if (!opts.skipGitignore) {
await createGitignore(logger, projectDir)
}
await createReadme(logger, projectDir)

if (runPackageManagerInstall) {
const spinner = ora('Installing dependencies...').start()
await execa(pkgManager, ['install'], { cwd: projectDir })
spinner.succeed('...done!')
}

if (!opts.skipGitHubActions) {
await askDynamicWorkspaceCreateGHAction(logger, env, 'composer', false, projectDir)
await askStaticWorkspaceGHAction(logger, env, 'composer', false, projectDir)
}
}

export default createPlatformaticComposer
76 changes: 76 additions & 0 deletions packages/create-platformatic/src/composer/create-composer.mjs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
import { readFile, writeFile, appendFile } from 'fs/promises'
import { findComposerConfigFile, isFileAccessible } from '../utils.mjs'
import { join } from 'path'
import * as desm from 'desm'

function generateConfig (version) {
const config = {
$schema: `https://platformatic.dev/schemas/v${version}/composer`,
server: {
hostname: '{PLT_SERVER_HOSTNAME}',
port: '{PORT}',
logger: {
level: '{PLT_SERVER_LOGGER_LEVEL}'
}
},
composer: {
services: [{
id: 'example',
origin: '{PLT_EXAMPLE_ORIGIN}',
openapi: {
url: '/documentation/json'
}
}],
refreshTimeout: 1000
},
watch: true
}

return config
}

function generateEnv (hostname, port) {
const env = `\
PLT_SERVER_HOSTNAME=${hostname}
PORT=${port}
PLT_SERVER_LOGGER_LEVEL=info
PLT_EXAMPLE_ORIGIN=
`

return env
}

async function createComposer ({ hostname, port }, logger, currentDir = process.cwd(), version) {
if (!version) {
const pkg = await readFile(desm.join(import.meta.url, '..', '..', 'package.json'))
version = JSON.parse(pkg).version
}
const accessibleConfigFilename = await findComposerConfigFile(currentDir)

if (accessibleConfigFilename === undefined) {
const config = generateConfig(version)
await writeFile(join(currentDir, 'platformatic.composer.json'), JSON.stringify(config, null, 2))
logger.info('Configuration file platformatic.composer.json successfully created.')

const env = generateEnv(hostname, port)
const envFileExists = await isFileAccessible('.env', currentDir)
await appendFile(join(currentDir, '.env'), env)
await writeFile(join(currentDir, '.env.sample'), env)
/* c8 ignore next 5 */
if (envFileExists) {
logger.info('Environment file .env found, appending new environment variables to existing .env file.')
} else {
logger.info('Environment file .env successfully created.')
}
} else {
logger.info(`Configuration file ${accessibleConfigFilename} found, skipping creation of configuration file.`)
}

return {
PLT_SERVER_LOGGER_LEVEL: 'info',
PORT: port,
PLT_SERVER_HOSTNAME: hostname
}
}

export default createComposer
65 changes: 43 additions & 22 deletions packages/create-platformatic/src/db/create-db-cli.mjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ import { getPkgManager } from '../get-pkg-manager.mjs'
import parseArgs from 'minimist'
import { join } from 'path'
import inquirer from 'inquirer'
import { readFile, writeFile } from 'fs/promises'
import which from 'which'
import { readFile, writeFile, mkdir } from 'fs/promises'
import pino from 'pino'
import pretty from 'pino-pretty'
import { execa } from 'execa'
import ora from 'ora'
import createDB from './create-db.mjs'
import askProjectDir from '../ask-project-dir.mjs'
import askDir from '../ask-dir.mjs'
import { askDynamicWorkspaceCreateGHAction, askStaticWorkspaceGHAction } from '../ghaction.mjs'
import { getRunPackageManagerInstall, getUseTypescript } from '../cli-options.mjs'
import mkdirp from 'mkdirp'
import { getRunPackageManagerInstall, getUseTypescript, getPort } from '../cli-options.mjs'

export const createReadme = async (logger, dir = '.') => {
const readmeFileName = join(dir, 'README.md')
Expand Down Expand Up @@ -42,11 +42,10 @@ export const createReadme = async (logger, dir = '.') => {
logger.debug(`${readmeFileName} successfully created.`)
}

export const parseDBArgs = (_args) => {
export function parseDBArgs (_args) {
return parseArgs(_args, {
default: {
hostname: '127.0.0.1',
port: 3042,
database: 'sqlite',
migrations: 'migrations',
plugin: true,
Expand All @@ -66,16 +65,16 @@ export const parseDBArgs = (_args) => {
})
}

const createPlatformaticDB = async (_args) => {
const logger = pino(pretty({
const createPlatformaticDB = async (_args, opts) => {
const logger = opts.logger || pino(pretty({
translateTime: 'SYS:HH:MM:ss',
ignore: 'hostname,pid'
}))

const args = parseDBArgs(_args)
const version = await getVersion()
const pkgManager = getPkgManager()
const projectDir = await askProjectDir(logger, '.')
const projectDir = opts.dir || await askDir(logger, '.')

const wizardOptions = await inquirer.prompt([{
type: 'list',
Expand All @@ -90,19 +89,20 @@ const createPlatformaticDB = async (_args) => {
default: args.plugin,
choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
},
getUseTypescript(args.typescript)
getUseTypescript(args.typescript),
getPort(args.port)
])

// Create the project directory
await mkdirp(projectDir)
await mkdir(projectDir, { recursive: true })

const generatePlugin = args.plugin || wizardOptions.generatePlugin
const useTypescript = args.typescript || wizardOptions.useTypescript
const useTypes = args.types || generatePlugin // we set this always to true if we want to generate a plugin

const params = {
hostname: args.hostname,
port: args.port,
port: wizardOptions.port,
database: args.database,
migrations: wizardOptions.defaultMigrations ? args.migrations : '',
plugin: generatePlugin,
Expand All @@ -119,17 +119,35 @@ const createPlatformaticDB = async (_args) => {
await createGitignore(logger, projectDir)
await createReadme(logger, projectDir)

const { runPackageManagerInstall } = await inquirer.prompt([
getRunPackageManagerInstall(pkgManager)
])
let hasPlatformaticInstalled = false
if (!opts.skipPackageJson) {
const { runPackageManagerInstall } = await inquirer.prompt([
getRunPackageManagerInstall(pkgManager)
])

if (runPackageManagerInstall) {
const spinner = ora('Installing dependencies...').start()
await execa(pkgManager, ['install'], { cwd: projectDir })
spinner.succeed('...done!')
hasPlatformaticInstalled = true
}
}

if (!hasPlatformaticInstalled) {
try {
const npmLs = JSON.parse(await execa('npm', ['ls', '--json']))
hasPlatformaticInstalled = !!npmLs.dependencies.platformatic
} catch {
// Ignore all errors, this can fail
}
}

if (runPackageManagerInstall) {
const spinner = ora('Installing dependencies...').start()
await execa(pkgManager, ['install'], { cwd: projectDir })
spinner.succeed('...done!')
if (!hasPlatformaticInstalled) {
const exe = await which('platformatic', { noThrow: true })
hasPlatformaticInstalled = !!exe
}

if (runPackageManagerInstall) {
if (hasPlatformaticInstalled) {
// We applied package manager install, so we can:
// - run the migrations
// - generate types
Expand Down Expand Up @@ -166,8 +184,11 @@ const createPlatformaticDB = async (_args) => {
}
}
}
await askDynamicWorkspaceCreateGHAction(logger, env, 'db', useTypescript, projectDir)
await askStaticWorkspaceGHAction(logger, env, 'db', useTypescript, projectDir)

if (!opts.skipGitHubActions) {
await askDynamicWorkspaceCreateGHAction(logger, env, 'db', useTypescript, projectDir)
await askStaticWorkspaceGHAction(logger, env, 'db', useTypescript, projectDir)
}
}

export default createPlatformaticDB
7 changes: 3 additions & 4 deletions packages/create-platformatic/src/ghaction.mjs
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
import mkdirp from 'mkdirp'
import { join } from 'path'
import inquirer from 'inquirer'
import { isFileAccessible } from './utils.mjs'
import { writeFile } from 'fs/promises'
import { writeFile, mkdir } from 'fs/promises'

export const dynamicWorkspaceGHTemplate = (env, config, buildTS = false) => {
const envAsStr = Object.keys(env).reduce((acc, key) => {
Expand Down Expand Up @@ -90,7 +89,7 @@ export const createDynamicWorkspaceGHAction = async (logger, env, config, projec
const ghActionFilePath = join(projectDir, '.github', 'workflows', ghActionFileName)
const isGithubActionExists = await isFileAccessible(ghActionFilePath)
if (!isGithubActionExists) {
await mkdirp(join(projectDir, '.github', 'workflows'))
await mkdir(join(projectDir, '.github', 'workflows'), { recursive: true })
await writeFile(ghActionFilePath, dynamicWorkspaceGHTemplate(env, config, buildTS))
logger.info('Github action successfully created, please add PLATFORMATIC_DYNAMIC_WORKSPACE_ID and PLATFORMATIC_DYNAMIC_WORKSPACE_API_KEY as repository secrets.')
const isGitDir = await isFileAccessible('.git', projectDir)
Expand Down Expand Up @@ -125,7 +124,7 @@ export const createStaticWorkspaceGHAction = async (logger, env, config, project
const ghActionFilePath = join(projectDir, '.github', 'workflows', ghActionFileName)
const isGithubActionExists = await isFileAccessible(ghActionFilePath)
if (!isGithubActionExists) {
await mkdirp(join(projectDir, '.github', 'workflows'))
await mkdir(join(projectDir, '.github', 'workflows'), { recursive: true })
await writeFile(ghActionFilePath, staticWorkspaceGHTemplate(env, config, buildTS))
logger.info('Github action successfully created, please add PLATFORMATIC_STATIC_WORKSPACE_ID and PLATFORMATIC_STATIC_WORKSPACE_API_KEY as repository secret.')
const isGitDir = await isFileAccessible('.git', projectDir)
Expand Down
72 changes: 58 additions & 14 deletions packages/create-platformatic/src/index.mjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,45 @@ import { say } from './say.mjs'
import helpMe from 'help-me'
import { join } from 'desm'
import inquirer from 'inquirer'
import { readdir, readFile } from 'fs/promises'
import createPlatformaticDB from './db/create-db-cli.mjs'
import createPlatformaticService from './service/create-service-cli.mjs'
import createPlatformaticComposer from './composer/create-composer-cli.mjs'
import { createPlatformaticRuntime, createRuntimeService } from './runtime/create-runtime-cli.mjs'
import commist from 'commist'
import { getUsername, getVersion, minimumSupportedNodeVersions, isCurrentVersionSupported } from './utils.mjs'
import { getUsername, getVersion, minimumSupportedNodeVersions, isCurrentVersionSupported, findRuntimeConfigFile } from './utils.mjs'

export async function chooseKind (argv, opts = {}) {
const skip = opts.skip
const choices = [
{ name: 'DB', value: 'db' },
{ name: 'Service', value: 'service' },
{ name: 'Composer', value: 'composer' },
{ name: 'Runtime', value: 'runtime' }
].filter((choice) => !skip || choice.value !== skip)

const options = await inquirer.prompt({
type: 'list',
name: 'type',
message: 'Which kind of project do you want to create?',
choices
})

switch (options.type) {
case 'db':
await createPlatformaticDB(argv, opts)
break
case 'service':
await createPlatformaticService(argv, opts)
break
case 'composer':
await createPlatformaticComposer(argv, opts)
break
case 'runtime':
await createPlatformaticRuntime(argv, opts)
break
}
}

const createPlatformatic = async (argv) => {
const help = helpMe({
Expand All @@ -20,6 +55,8 @@ const createPlatformatic = async (argv) => {
program.register('service help', help.toStdout.bind(null, ['service']))
program.register('db', createPlatformaticDB)
program.register('service', createPlatformaticService)
program.register('composer', createPlatformaticComposer)
program.register('runtime', createPlatformaticRuntime)

const result = program.parse(argv)

Expand All @@ -28,7 +65,6 @@ const createPlatformatic = async (argv) => {
const version = await getVersion()
const greeting = username ? `Hello, ${username}` : 'Hello,'
await say(`${greeting} welcome to ${version ? `Platformatic ${version}!` : 'Platformatic!'}`)
await say('Let\'s start by creating a new project.')

const currentVersion = process.versions.node
const supported = isCurrentVersionSupported(currentVersion)
Expand All @@ -38,18 +74,26 @@ const createPlatformatic = async (argv) => {
await say(`Please use one of the following Node.js versions >= ${supportedVersions}.`)
}

const options = await inquirer.prompt({
type: 'list',
name: 'type',
message: 'Which kind of project do you want to create?',
default: 'db',
choices: [{ name: 'DB', value: 'db' }, { name: 'Service', value: 'service' }]
})

if (options.type === 'db') {
await createPlatformaticDB(argv)
} else if (options.type === 'service') {
await createPlatformaticService(argv)
const runtimeConfig = await findRuntimeConfigFile(process.cwd())
if (runtimeConfig) {
await say(`Found a ${runtimeConfig} file in the current directory.`)
const config = JSON.parse(await readFile(runtimeConfig, 'utf8'))
if (config.autoload?.path) {
const servicesDir = config.autoload.path
const names = []
for (const entry of await readdir(servicesDir)) {
names.push(entry)
}
if (!await createRuntimeService({ servicesDir, names })) {
process.exit(1)
}
} else {
await say('The current project does not have a services directory.')
process.exit(1)
}
} else {
await say('Let\'s start by creating a new project.')
await chooseKind(argv)
}

await say('\nAll done! Please open the project directory and check the README.')
Expand Down
32 changes: 32 additions & 0 deletions packages/create-platformatic/src/runtime/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Platformatic Runtime API

This is a generated [Platformatic Runtime](https://oss.platformatic.dev/docs/reference/runtime/introduction) application.

## Requirements

Platformatic supports macOS, Linux and Windows ([WSL](https://docs.microsoft.com/windows/wsl/) recommended).
You'll need to have [Node.js](https://nodejs.org/) >= v18.8.0

## Setup

1. Install dependencies:

```bash
npm install
```

## Usage

Run the API with:

```bash
npm start
```

## Adding a Service

Adding a new service to this project is as simple as running `create-platformatic` again, like so:

```
npx create-platformatic
```
155 changes: 155 additions & 0 deletions packages/create-platformatic/src/runtime/create-runtime-cli.mjs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
import { getVersion, getDependencyVersion, isFileAccessible } from '../utils.mjs'
import { createPackageJson } from '../create-package-json.mjs'
import { createGitignore } from '../create-gitignore.mjs'
import { getPkgManager } from '../get-pkg-manager.mjs'
import { join } from 'path'
import inquirer from 'inquirer'
import { readFile, writeFile, mkdir } from 'fs/promises'
import pino from 'pino'
import pretty from 'pino-pretty'
import { execa } from 'execa'
import ora from 'ora'
import createRuntime from './create-runtime.mjs'
import askDir from '../ask-dir.mjs'
import { askDynamicWorkspaceCreateGHAction, askStaticWorkspaceGHAction } from '../ghaction.mjs'
import { getRunPackageManagerInstall } from '../cli-options.mjs'
import generateName from 'boring-name-generator'
import { chooseKind } from '../index.mjs'

export const createReadme = async (logger, dir = '.') => {
const readmeFileName = join(dir, 'README.md')
let isReadmeExists = await isFileAccessible(readmeFileName)
if (isReadmeExists) {
logger.debug(`${readmeFileName} found, asking to overwrite it.`)
const { shouldReplace } = await inquirer.prompt([{
type: 'list',
name: 'shouldReplace',
message: 'Do you want to overwrite the existing README.md?',
default: true,
choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
}])
isReadmeExists = !shouldReplace
}

if (isReadmeExists) {
logger.debug(`${readmeFileName} found, skipping creation of README.md file.`)
return
}

const readmeFile = new URL('README.md', import.meta.url)
const readme = await readFile(readmeFile, 'utf-8')
await writeFile(readmeFileName, readme)
logger.debug(`${readmeFileName} successfully created.`)
}

export async function createPlatformaticRuntime (_args) {
const logger = pino(pretty({
translateTime: 'SYS:HH:MM:ss',
ignore: 'hostname,pid'
}))

const version = await getVersion()
const pkgManager = getPkgManager()

const projectDir = await askDir(logger, '.')
const servicesDir = await askDir(logger, 'services', 'Where would you like to load your services from?')

const { runPackageManagerInstall } = await inquirer.prompt([
getRunPackageManagerInstall(pkgManager)
])

// Create the project directory
await mkdir(projectDir, { recursive: true })
await mkdir(servicesDir, { recursive: true })

const fastifyVersion = await getDependencyVersion('fastify')

// Create the package.json, notes that we don't have the option for TS (yet) so we don't generate
// the package.json with the TS build
await createPackageJson('runtime', version, fastifyVersion, logger, projectDir, false)
await createGitignore(logger, projectDir)
await createReadme(logger, projectDir)

if (runPackageManagerInstall) {
const spinner = ora('Installing dependencies...').start()
await execa(pkgManager, ['install'], { cwd: projectDir })
spinner.succeed('...done!')
}

logger.info('Let\'s create a first service!')

const names = []
while (true) {
if (!await createRuntimeService({ servicesDir, names, logger })) {
continue
}

const { shouldBreak } = await inquirer.prompt([
{
type: 'list',
name: 'shouldBreak',
message: 'Do you want to create another service?',
default: false,
choices: [{ name: 'yes', value: false }, { name: 'no', value: true }]
}
])

if (shouldBreak) {
break
}
}

let entrypoint = ''

if (names.length > 1) {
const results = await inquirer.prompt([
{
type: 'list',
name: 'entrypoint',
message: 'Which service should be exposed?',
choices: names.map(name => ({ name, value: name }))
}
])
entrypoint = results.entrypoint
} else {
entrypoint = names[0]
}

const env = await createRuntime(logger, projectDir, version, servicesDir, entrypoint)

await askDynamicWorkspaceCreateGHAction(logger, env, 'service', false, projectDir)
await askStaticWorkspaceGHAction(logger, env, 'service', false, projectDir)
}

export async function createRuntimeService ({ servicesDir, names, logger }) {
logger ||= pino(pretty({
translateTime: 'SYS:HH:MM:ss',
ignore: 'hostname,pid'
}))
const { name } = await inquirer.prompt({
type: 'input',
name: 'name',
message: 'What is the name of the service?',
default: generateName().dashed
})

if (names.includes(name)) {
logger.warn('This name is already used, please choose another one.')
return false
}
names.push(name)

const serviceDir = join(servicesDir, name)

await chooseKind([], {
skip: 'runtime',
dir: serviceDir,
logger,
skipGitHubActions: true,
skipPackageJson: true,
skipGitignore: true,
port: '0'
})

return true
}
40 changes: 40 additions & 0 deletions packages/create-platformatic/src/runtime/create-runtime.mjs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import { readFile, writeFile } from 'fs/promises'
import { findRuntimeConfigFile } from '../utils.mjs'
import { join, relative, isAbsolute } from 'path'
import * as desm from 'desm'

function generateConfig (version, path, entrypoint) {
const config = {
$schema: `https://platformatic.dev/schemas/v${version}/runtime`,
entrypoint,
allowCycles: false,
hotReload: true,
autoload: {
path,
exclude: ['docs']
}
}

return config
}

async function createRuntime (logger, currentDir = process.cwd(), version, servicesDir, entrypoint) {
if (!version) {
const pkg = await readFile(desm.join(import.meta.url, '..', '..', 'package.json'))
version = JSON.parse(pkg).version
}
const accessibleConfigFilename = await findRuntimeConfigFile(currentDir)

if (accessibleConfigFilename === undefined) {
const path = isAbsolute(servicesDir) ? relative(currentDir, servicesDir) : servicesDir
const config = generateConfig(version, path, entrypoint)
await writeFile(join(currentDir, 'platformatic.runtime.json'), JSON.stringify(config, null, 2))
logger.info('Configuration file platformatic.runtime.json successfully created.')
} else {
logger.info(`Configuration file ${accessibleConfigFilename} found, skipping creation of configuration file.`)
}

return {}
}

export default createRuntime
50 changes: 28 additions & 22 deletions packages/create-platformatic/src/service/create-service-cli.mjs
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@

import { getVersion, getDependencyVersion, isFileAccessible } from '../utils.mjs'
import { createPackageJson } from '../create-package-json.mjs'
import { createGitignore } from '../create-gitignore.mjs'
import { getPkgManager } from '../get-pkg-manager.mjs'
import parseArgs from 'minimist'
import { join } from 'path'
import inquirer from 'inquirer'
import { readFile, writeFile } from 'fs/promises'
import { readFile, writeFile, mkdir } from 'fs/promises'
import pino from 'pino'
import pretty from 'pino-pretty'
import { execa } from 'execa'
import ora from 'ora'
import createService from './create-service.mjs'
import askProjectDir from '../ask-project-dir.mjs'
import askDir from '../ask-dir.mjs'
import { askDynamicWorkspaceCreateGHAction, askStaticWorkspaceGHAction } from '../ghaction.mjs'
import { getRunPackageManagerInstall, getUseTypescript } from '../cli-options.mjs'
import mkdirp from 'mkdirp'
import { getRunPackageManagerInstall, getUseTypescript, getPort } from '../cli-options.mjs'

export const createReadme = async (logger, dir = '.') => {
const readmeFileName = join(dir, 'README.md')
Expand Down Expand Up @@ -43,16 +41,15 @@ export const createReadme = async (logger, dir = '.') => {
logger.debug(`${readmeFileName} successfully created.`)
}

const createPlatformaticService = async (_args) => {
const logger = pino(pretty({
const createPlatformaticService = async (_args, opts = {}) => {
const logger = opts.logger || pino(pretty({
translateTime: 'SYS:HH:MM:ss',
ignore: 'hostname,pid'
}))

const args = parseArgs(_args, {
default: {
hostname: '127.0.0.1',
port: 3042
hostname: '127.0.0.1'
},
alias: {
h: 'hostname',
Expand All @@ -63,30 +60,37 @@ const createPlatformaticService = async (_args) => {
const version = await getVersion()
const pkgManager = getPkgManager()

const projectDir = await askProjectDir(logger, '.')
const projectDir = opts.dir || await askDir(logger, '.')

const toAsk = [getUseTypescript(args.typescript), getPort(args.port)]

if (!opts.skipPackageJson) {
toAsk.unshift(getRunPackageManagerInstall(pkgManager))
}

const { runPackageManagerInstall, useTypescript } = await inquirer.prompt([
getRunPackageManagerInstall(pkgManager),
getUseTypescript(args.typescript)
])
const { runPackageManagerInstall, useTypescript, port } = await inquirer.prompt(toAsk)

// Create the project directory
await mkdirp(projectDir)
await mkdir(projectDir, { recursive: true })

const params = {
hostname: args.hostname,
port: args.port,
port,
typescript: useTypescript
}

const env = await createService(params, logger, projectDir, version)

const fastifyVersion = await getDependencyVersion('fastify')

// Create the package.json, notes that we don't have the option for TS (yet) so we don't generate
// the package.json with the TS build
await createPackageJson('service', version, fastifyVersion, logger, projectDir, false)
await createGitignore(logger, projectDir)
if (!opts.skipPackageJson) {
// Create the package.json, notes that we don't have the option for TS (yet) so we don't generate
// the package.json with the TS build
await createPackageJson('service', version, fastifyVersion, logger, projectDir, false)
}
if (!opts.skipGitignore) {
await createGitignore(logger, projectDir)
}
await createReadme(logger, projectDir)

if (runPackageManagerInstall) {
Expand All @@ -95,8 +99,10 @@ const createPlatformaticService = async (_args) => {
spinner.succeed('...done!')
}

await askDynamicWorkspaceCreateGHAction(logger, env, 'service', useTypescript, projectDir)
await askStaticWorkspaceGHAction(logger, env, 'service', useTypescript, projectDir)
if (!opts.skipGitHubActions) {
await askDynamicWorkspaceCreateGHAction(logger, env, 'service', useTypescript, projectDir)
await askStaticWorkspaceGHAction(logger, env, 'service', useTypescript, projectDir)
}
}

export default createPlatformaticService
3 changes: 3 additions & 0 deletions packages/create-platformatic/src/service/create-service.mjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ function generateConfig (version, typescript) {
level: '{PLT_SERVER_LOGGER_LEVEL}'
}
},
service: {
openapi: true
},
plugins
}

Expand Down
2 changes: 2 additions & 0 deletions packages/create-platformatic/src/utils.mjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ export const validatePath = async projectPath => {

export const findDBConfigFile = async (directory) => (ConfigManager.findConfigFile(directory, 'db'))
export const findServiceConfigFile = async (directory) => (ConfigManager.findConfigFile(directory, 'service'))
export const findComposerConfigFile = async (directory) => (ConfigManager.findConfigFile(directory, 'composer'))
export const findRuntimeConfigFile = async (directory) => (ConfigManager.findConfigFile(directory, 'runtime'))

export const getDependencyVersion = async (dependencyName) => {
const require = createRequire(import.meta.url)
Expand Down
44 changes: 43 additions & 1 deletion packages/create-platformatic/test/cli-options.test.mjs
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { test } from 'tap'
import { getRunPackageManagerInstall, getUseTypescript } from '../src/cli-options.mjs'
import { getRunPackageManagerInstall, getUseTypescript, getPort } from '../src/cli-options.mjs'

test('getRunPackageManagerInstall', async ({ same }) => {
same(
Expand Down Expand Up @@ -27,3 +27,45 @@ test('getUseTypescript', async ({ same }) => {
}
)
})

test('getPort', async ({ same }) => {
same(
getPort(undefined),
{
type: 'input',
name: 'port',
message: 'What port do you want to use?',
default: 3042
}
)

same(
getPort(undefined),
{
type: 'input',
name: 'port',
message: 'What port do you want to use?',
default: 3043
}
)

same(
getPort(1234),
{
type: 'input',
name: 'port',
message: 'What port do you want to use?',
default: 1234
}
)

same(
getPort(undefined),
{
type: 'input',
name: 'port',
message: 'What port do you want to use?',
default: 3044
}
)
})
75 changes: 75 additions & 0 deletions packages/create-platformatic/test/composer/create-composer.test.mjs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
import createComposer from '../../src/composer/create-composer.mjs'
import { test, beforeEach, afterEach } from 'tap'
import { tmpdir } from 'os'
import { mkdtempSync, rmSync, readFileSync, writeFileSync } from 'fs'
import { join } from 'path'
import dotenv from 'dotenv'

const base = tmpdir()
let tmpDir
let log = []
beforeEach(() => {
tmpDir = mkdtempSync(join(base, 'test-create-platformatic-'))
})

afterEach(() => {
log = []
rmSync(tmpDir, { recursive: true, force: true })
process.env = {}
})

const fakeLogger = {
debug: msg => log.push(msg),
info: msg => log.push(msg)
}

test('creates composer', async ({ equal, same, ok }) => {
const params = {
hostname: 'myhost',
port: 6666,
typescript: false
}

await createComposer(params, fakeLogger, tmpDir)

const pathToComposerConfigFile = join(tmpDir, 'platformatic.composer.json')
const composerConfigFile = readFileSync(pathToComposerConfigFile, 'utf8')
const composerConfig = JSON.parse(composerConfigFile)
const { server, composer } = composerConfig

equal(server.hostname, '{PLT_SERVER_HOSTNAME}')
equal(server.port, '{PORT}')

const pathToDbEnvFile = join(tmpDir, '.env')
dotenv.config({ path: pathToDbEnvFile })
equal(process.env.PLT_SERVER_HOSTNAME, 'myhost')
equal(process.env.PORT, '6666')
process.env = {}

const pathToDbEnvSampleFile = join(tmpDir, '.env.sample')
dotenv.config({ path: pathToDbEnvSampleFile })
equal(process.env.PLT_SERVER_HOSTNAME, 'myhost')
equal(process.env.PORT, '6666')

same(composer, {
services: [{
id: 'example',
origin: '{PLT_EXAMPLE_ORIGIN}',
openapi: {
url: '/documentation/json'
}
}],
refreshTimeout: 1000
})
})

test('creates project with configuration already present', async ({ ok }) => {
const pathToComposerConfigFileOld = join(tmpDir, 'platformatic.composer.json')
writeFileSync(pathToComposerConfigFileOld, JSON.stringify({ test: 'test' }))
const params = {
hostname: 'myhost',
port: 6666
}
await createComposer(params, fakeLogger, tmpDir)
ok(log.includes('Configuration file platformatic.composer.json found, skipping creation of configuration file.'))
})
7 changes: 3 additions & 4 deletions packages/create-platformatic/test/ghaction-dynamic.test.mjs
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
'use strict'

import { test, beforeEach, afterEach } from 'tap'
import { mkdtemp, rmdir, writeFile, readFile } from 'fs/promises'
import mkdirp from 'mkdirp'
import { mkdtemp, rmdir, writeFile, readFile, mkdir } from 'fs/promises'
import { join } from 'path'
import { tmpdir } from 'os'
import { isFileAccessible } from '../src/utils.mjs'
Expand Down Expand Up @@ -70,7 +69,7 @@ test('creates gh action with TS build step', async ({ end, equal }) => {
})

test('do not create gitignore file because already present', async ({ end, equal }) => {
await mkdirp(join(tmpDir, '.github', 'workflows'))
await mkdir(join(tmpDir, '.github', 'workflows'), { recursive: true })
const ghaction = join(tmpDir, '.github', 'workflows', 'platformatic-dynamic-workspace-deploy.yml')
await writeFile(ghaction, 'TEST')
await createDynamicWorkspaceGHAction(fakeLogger, env, 'db', tmpDir)
Expand All @@ -86,7 +85,7 @@ test('creates gh action with a warn if a .git folder is not present', async ({ e
})

test('creates gh action without a warn if a .git folder is present', async ({ end, equal }) => {
await mkdirp(join(tmpDir, '.git'))
await mkdir(join(tmpDir, '.git'), { recursive: true })
await createDynamicWorkspaceGHAction(fakeLogger, env, 'db', tmpDir)
equal(log[0], 'Github action successfully created, please add PLATFORMATIC_DYNAMIC_WORKSPACE_ID and PLATFORMATIC_DYNAMIC_WORKSPACE_API_KEY as repository secrets.')
const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-dynamic-workspace-deploy.yml'))
Expand Down
7 changes: 3 additions & 4 deletions packages/create-platformatic/test/ghaction-static.test.mjs
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
'use strict'

import { test, beforeEach, afterEach } from 'tap'
import { mkdtemp, rmdir, writeFile, readFile } from 'fs/promises'
import mkdirp from 'mkdirp'
import { mkdtemp, rmdir, writeFile, readFile, mkdir } from 'fs/promises'
import { join } from 'path'
import { tmpdir } from 'os'
import { isFileAccessible } from '../src/utils.mjs'
Expand Down Expand Up @@ -68,7 +67,7 @@ test('creates gh action with TS build step', async ({ end, equal }) => {
})

test('do not create gitignore file because already present', async ({ end, equal }) => {
await mkdirp(join(tmpDir, '.github', 'workflows'))
await mkdir(join(tmpDir, '.github', 'workflows'), { recursive: true })
const ghaction = join(tmpDir, '.github', 'workflows', 'platformatic-static-workspace-deploy.yml')
await writeFile(ghaction, 'TEST')
await createStaticWorkspaceGHAction(fakeLogger, env, 'db', tmpDir)
Expand All @@ -84,7 +83,7 @@ test('creates gh action with a warn if a .git folder is not present', async ({ e
})

test('creates gh action without a warn if a .git folder is present', async ({ end, equal }) => {
await mkdirp(join(tmpDir, '.git'))
await mkdir(join(tmpDir, '.git'), { recursive: true })
await createStaticWorkspaceGHAction(fakeLogger, env, 'db', tmpDir)
equal(log[0], 'Github action successfully created, please add PLATFORMATIC_STATIC_WORKSPACE_ID and PLATFORMATIC_STATIC_WORKSPACE_API_KEY as repository secret.')
const accessible = await isFileAccessible(join(tmpDir, '.github/workflows/platformatic-static-workspace-deploy.yml'))
Expand Down
70 changes: 70 additions & 0 deletions packages/create-platformatic/test/runtime/create-runtime.test.mjs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
import createRuntime from '../../src/runtime/create-runtime.mjs'
import { test, beforeEach, afterEach } from 'tap'
import { tmpdir } from 'os'
import { mkdtempSync, rmSync, readFileSync, writeFileSync } from 'fs'
import { join } from 'path'

const base = tmpdir()
let tmpDir
let log = []
beforeEach(() => {
tmpDir = mkdtempSync(join(base, 'test-create-platformatic-'))
})

afterEach(() => {
log = []
rmSync(tmpDir, { recursive: true, force: true })
process.env = {}
})

const fakeLogger = {
debug: msg => log.push(msg),
info: msg => log.push(msg)
}

test('creates runtime', async ({ equal, same, ok }) => {
await createRuntime(fakeLogger, tmpDir, undefined, 'services', 'foobar')

const pathToRuntimeConfigFile = join(tmpDir, 'platformatic.runtime.json')
const runtimeConfigFile = readFileSync(pathToRuntimeConfigFile, 'utf8')
const runtimeConfig = JSON.parse(runtimeConfigFile)

delete runtimeConfig.$schema

same(runtimeConfig, {
entrypoint: 'foobar',
allowCycles: false,
hotReload: true,
autoload: {
path: 'services',
exclude: ['docs']
}
})
})

test('with a full path for autoload', async ({ equal, same, ok }) => {
await createRuntime(fakeLogger, tmpDir, undefined, join(tmpDir, 'services'), 'foobar')

const pathToRuntimeConfigFile = join(tmpDir, 'platformatic.runtime.json')
const runtimeConfigFile = readFileSync(pathToRuntimeConfigFile, 'utf8')
const runtimeConfig = JSON.parse(runtimeConfigFile)

delete runtimeConfig.$schema

same(runtimeConfig, {
entrypoint: 'foobar',
allowCycles: false,
hotReload: true,
autoload: {
path: 'services',
exclude: ['docs']
}
})
})

test('creates project with configuration already present', async ({ ok }) => {
const pathToRuntimeConfigFileOld = join(tmpDir, 'platformatic.runtime.json')
writeFileSync(pathToRuntimeConfigFileOld, JSON.stringify({ test: 'test' }))
await createRuntime(fakeLogger, tmpDir, 'foobar')
ok(log.includes('Configuration file platformatic.runtime.json found, skipping creation of configuration file.'))
})
24 changes: 23 additions & 1 deletion packages/create-platformatic/test/utils.test.mjs
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { test } from 'tap'
import { randomBetween, sleep, validatePath, getDependencyVersion, findDBConfigFile, findServiceConfigFile, isFileAccessible, isCurrentVersionSupported, minimumSupportedNodeVersions } from '../src/utils.mjs'
import { randomBetween, sleep, validatePath, getDependencyVersion, findDBConfigFile, findServiceConfigFile, isFileAccessible, isCurrentVersionSupported, minimumSupportedNodeVersions, findRuntimeConfigFile, findComposerConfigFile } from '../src/utils.mjs'
import { mkdtempSync, rmSync, writeFileSync } from 'fs'
import { tmpdir, platform } from 'os'
import { join } from 'path'
Expand Down Expand Up @@ -158,6 +158,28 @@ test('findServiceConfigFile', async ({ end, equal, mock }) => {
rmSync(tmpDir2, { recursive: true, force: true })
})

test('findComposerConfigFile', async ({ end, equal, mock }) => {
const tmpDir1 = mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
const tmpDir2 = mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
const config = join(tmpDir1, 'platformatic.composer.yml')
writeFileSync(config, 'TEST')
equal(await findComposerConfigFile(tmpDir1), 'platformatic.composer.yml')
equal(await findComposerConfigFile(tmpDir2), undefined)
rmSync(tmpDir1, { recursive: true, force: true })
rmSync(tmpDir2, { recursive: true, force: true })
})

test('findRuntimeConfigFile', async ({ end, equal, mock }) => {
const tmpDir1 = mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
const tmpDir2 = mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
const config = join(tmpDir1, 'platformatic.runtime.yml')
writeFileSync(config, 'TEST')
equal(await findRuntimeConfigFile(tmpDir1), 'platformatic.runtime.yml')
equal(await findRuntimeConfigFile(tmpDir2), undefined)
rmSync(tmpDir1, { recursive: true, force: true })
rmSync(tmpDir2, { recursive: true, force: true })
})

test('isFileAccessible', async ({ end, equal, mock }) => {
const tmpDir1 = mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
const config = join(tmpDir1, 'platformatic.db.yml')
Expand Down
22 changes: 19 additions & 3 deletions packages/deploy-client/index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ const tar = require('tar')
const { request } = require('undici')

const ConfigManager = require('@platformatic/config')
const { getConfigType } = require('@platformatic/start')
const { getConfigType, getApp } = require('@platformatic/start')
const { loadConfig } = require('@platformatic/service')
const { platformaticRuntime } = require('@platformatic/runtime')

const makePrewarmRequest = require('./lib/prewarm.js')

Expand Down Expand Up @@ -83,7 +85,7 @@ class DeployClient {
}
}

async createDeployment (token, label, variables, secrets) {
async createDeployment (token, label, metadata, variables, secrets) {
const url = this.deployServiceHost + '/deployments'

const { statusCode, body } = await request(url, {
Expand All @@ -97,7 +99,7 @@ class DeployClient {
accept: 'application/json'
},

body: JSON.stringify({ label, variables, secrets })
body: JSON.stringify({ label, metadata, variables, secrets })
})

if (statusCode !== 200) {
Expand Down Expand Up @@ -194,6 +196,10 @@ async function deploy ({

const args = ['-c', join(pathToProject, pathToConfig)]
const appType = await getConfigType(args, pathToProject)
const app = appType === 'runtime' ? platformaticRuntime : getApp(appType)

const { configManager } = await loadConfig({}, args, app)
const config = configManager.current

logger.info(`Found Platformatic config file: ${pathToConfig}`)

Expand Down Expand Up @@ -238,9 +244,19 @@ async function deploy ({
const secretsFromFile = await getEnvFileVariables(secretsFilePath)
const mergedSecrets = { ...secretsFromFile, ...secrets }

const appMetadata = { appType }
if (appType === 'runtime') {
const services = config.services.map(service => ({
id: service.id,
entrypoint: service.entrypoint
}))
appMetadata.services = services
}

const { entryPointUrl } = await deployClient.createDeployment(
token,
label,
appMetadata,
mergedEnvVars,
mergedSecrets
)
Expand Down
4 changes: 3 additions & 1 deletion packages/deploy-client/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"scripts": {
"lint": "standard | snazzy",
"test": "standard | snazzy && c8 --100 tap -j1 test/*test.js",
"license": "license-checker --production --onlyAllow 'Apache-2.0;MIT;ISC;BSD-2-Clause'"
"license": "license-checker --production --onlyAllow 'Apache-2.0;MIT;ISC;BSD-2-Clause;BSD-3-Clause'"
},
"repository": {
"type": "git",
Expand All @@ -29,6 +29,8 @@
"dependencies": {
"@platformatic/config": "workspace:*",
"@platformatic/start": "workspace:*",
"@platformatic/service": "workspace:*",
"@platformatic/runtime": "workspace:*",
"tar": "^6.1.15",
"undici": "^5.22.1"
}
Expand Down
91 changes: 91 additions & 0 deletions packages/deploy-client/test/composer-deploy.test.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
'use strict'

const { join } = require('path')
const { test } = require('tap')

const { deploy } = require('../index')
const { startMachine, startDeployService } = require('./helper')

test('should deploy platformatic composer project without github metadata', async (t) => {
t.plan(12)

const bundleId = 'test-bundle-id'
const token = 'test-upload-token'

const workspaceId = 'test-workspace-id'
const workspaceKey = 'test-workspace-key'

const entryPointUrl = await startMachine(t, () => {
t.pass('Action should make a prewarm request to the machine')
})

const pathToProject = join(__dirname, 'fixtures', 'composer-basic')
const pathToConfig = './platformatic.composer.json'
const pathToEnvFile = './.env'

const label = 'github-pr:1'

const variables = {
ENV_VARIABLE_1: 'value1',
ENV_VARIABLE_2: 'value2'
}

const secrets = {
SECRET_VARIABLE_1: 'value3'
}

const metadata = {
appType: 'composer'
}

await startDeployService(
t,
{
createBundleCallback: (request, reply) => {
t.equal(request.headers['x-platformatic-workspace-id'], workspaceId)
t.equal(request.headers['x-platformatic-api-key'], workspaceKey)

const { bundle } = request.body

t.equal(bundle.appType, 'composer')
t.equal(bundle.configPath, pathToConfig)
t.ok(bundle.checksum)

t.ok(request.body.bundle.checksum)

reply.code(200).send({ id: bundleId, token, isBundleUploaded: false })
},
createDeploymentCallback: (request, reply) => {
t.equal(request.headers['x-platformatic-workspace-id'], workspaceId)
t.equal(request.headers['x-platformatic-api-key'], workspaceKey)
t.equal(request.headers.authorization, `Bearer ${token}`)
t.same(
request.body,
{ label, metadata, variables, secrets }
)
reply.code(200).send({ entryPointUrl })
},
uploadCallback: (request) => {
t.equal(request.headers.authorization, `Bearer ${token}`)
}
}
)

const logger = {
info: () => {},
warn: () => t.fail('Should not log a warning')
}

await deploy({
deployServiceHost: 'http://localhost:3042',
workspaceId,
workspaceKey,
label,
pathToProject,
pathToConfig,
pathToEnvFile,
secrets,
variables,
logger
})
})
27 changes: 26 additions & 1 deletion packages/deploy-client/test/deploy.test.js → ...ages/deploy-client/test/deploy-db.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ test('should deploy platformatic project without github metadata', async (t) =>
request.body,
{
label,
metadata: {
appType: 'db'
},
variables: {
...variables,
FILE_ENV_VARIABLE1: 'platformatic_variable1',
Expand Down Expand Up @@ -170,6 +173,9 @@ test('should successfully deploy platformatic project with PR context', async (t
request.body,
{
label,
metadata: {
appType: 'db'
},
variables: {
...variables,
FILE_ENV_VARIABLE1: 'platformatic_variable1',
Expand Down Expand Up @@ -279,6 +285,9 @@ test('should successfully deploy platformatic project with branch context', asyn
request.body,
{
label,
metadata: {
appType: 'db'
},
variables: {
...variables,
FILE_ENV_VARIABLE1: 'platformatic_variable1',
Expand Down Expand Up @@ -369,6 +378,9 @@ test('should successfully deploy platformatic project without github metadata',
request.body,
{
label,
metadata: {
appType: 'db'
},
variables: {
...variables,
FILE_ENV_VARIABLE1: 'platformatic_variable1',
Expand Down Expand Up @@ -476,6 +488,9 @@ test('should successfully deploy platformatic project with branch context', asyn
request.body,
{
label,
metadata: {
appType: 'db'
},
variables: {
...variables,
FILE_ENV_VARIABLE1: 'platformatic_variable1',
Expand Down Expand Up @@ -584,6 +599,9 @@ test('should not deploy bundle of it already exists', async (t) => {
request.body,
{
label,
metadata: {
appType: 'db'
},
variables: {
...variables,
FILE_ENV_VARIABLE1: 'platformatic_variable1',
Expand Down Expand Up @@ -674,6 +692,9 @@ test('should successfully deploy platformatic project without github metadata',
request.body,
{
label,
metadata: {
appType: 'db'
},
variables: {
...variables,
FILE_ENV_VARIABLE1: 'platformatic_variable1',
Expand Down Expand Up @@ -741,6 +762,10 @@ test('should show a warning if platformatic dep is not in the dev section', asyn
SECRET_VARIABLE_1: 'value3'
}

const metadata = {
appType: 'db'
}

await startDeployService(
t,
{
Expand All @@ -761,7 +786,7 @@ test('should show a warning if platformatic dep is not in the dev section', asyn
t.equal(request.headers.authorization, `Bearer ${token}`)
t.same(
request.body,
{ label, variables, secrets }
{ label, metadata, variables, secrets }
)
reply.code(200).send({ entryPointUrl })
},
Expand Down
101 changes: 101 additions & 0 deletions packages/deploy-client/test/deploy-runtime.test.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
'use strict'

const { join } = require('path')
const { test } = require('tap')

const { deploy } = require('../index')
const { startMachine, startDeployService } = require('./helper')

test('should deploy platformatic runtime project without github metadata', async (t) => {
t.plan(12)

const bundleId = 'test-bundle-id'
const token = 'test-upload-token'

const workspaceId = 'test-workspace-id'
const workspaceKey = 'test-workspace-key'

const entryPointUrl = await startMachine(t, () => {
t.pass('Action should make a prewarm request to the machine')
})

const pathToProject = join(__dirname, 'fixtures', 'runtime-basic')
const pathToConfig = './platformatic.runtime.json'
const pathToEnvFile = './.env'

const label = 'github-pr:1'

const variables = {
ENV_VARIABLE_1: 'value1',
ENV_VARIABLE_2: 'value2'
}

const secrets = {
SECRET_VARIABLE_1: 'value3'
}

const metadata = {
appType: 'runtime',
services: [
{
id: 'serviceApp',
entrypoint: true
},
{
id: 'with-logger',
entrypoint: false
}
]
}

await startDeployService(
t,
{
createBundleCallback: (request, reply) => {
t.equal(request.headers['x-platformatic-workspace-id'], workspaceId)
t.equal(request.headers['x-platformatic-api-key'], workspaceKey)

const { bundle } = request.body

t.equal(bundle.appType, 'runtime')
t.equal(bundle.configPath, pathToConfig)
t.ok(bundle.checksum)

t.ok(request.body.bundle.checksum)

reply.code(200).send({ id: bundleId, token, isBundleUploaded: false })
},
createDeploymentCallback: (request, reply) => {
t.equal(request.headers['x-platformatic-workspace-id'], workspaceId)
t.equal(request.headers['x-platformatic-api-key'], workspaceKey)
t.equal(request.headers.authorization, `Bearer ${token}`)
t.same(
request.body,
{ label, metadata, variables, secrets }
)
reply.code(200).send({ entryPointUrl })
},
uploadCallback: (request) => {
t.equal(request.headers.authorization, `Bearer ${token}`)
}
}
)

const logger = {
info: () => {},
warn: () => t.fail('Should not log a warning')
}

await deploy({
deployServiceHost: 'http://localhost:3042',
workspaceId,
workspaceKey,
label,
pathToProject,
pathToConfig,
pathToEnvFile,
secrets,
variables,
logger
})
})
65 changes: 65 additions & 0 deletions packages/deploy-client/test/fixtures/composer-basic/api1.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"openapi": "3.0.3",
"info": {
"version": "8.3.1",
"title": "@fastify/swagger"
},
"components": {
"schemas": {}
},
"paths": {
"/users": {
"get": {
"responses": {
"200": {
"description": "Default Response"
}
}
},
"post": {
"responses": {
"200": {
"description": "Default Response"
}
}
},
"put": {
"responses": {
"200": {
"description": "Default Response"
}
}
}
},
"/users/{id}": {
"get": {
"responses": {
"200": {
"description": "Default Response"
}
}
},
"post": {
"responses": {
"200": {
"description": "Default Response"
}
}
},
"put": {
"responses": {
"200": {
"description": "Default Response"
}
}
},
"delete": {
"responses": {
"200": {
"description": "Default Response"
}
}
}
}
}
}
23 changes: 23 additions & 0 deletions packages/deploy-client/test/fixtures/composer-basic/platformatic.composer.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"$schema": "https://platformatic.dev/schemas/v0.23.2/composer",
"server": {
"hostname": "127.0.0.1",
"port": 0,
"logger": {
"level": "info"
}
},
"composer": {
"services": [
{
"id": "api1",
"origin": "http://127.0.0.1",
"openapi": {
"file": "./api1.json"
}
}
],
"refreshTimeout": 1000
},
"watch": false
}
10 changes: 10 additions & 0 deletions ...s/deploy-client/test/fixtures/runtime-basic/packages/serviceApp/platformatic.service.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/service",
"server": {
"hostname": "127.0.0.1",
"port": 0
},
"service": {
"openapi": true
}
}
10 changes: 10 additions & 0 deletions ...lient/test/fixtures/runtime-basic/packages/serviceAppWithLogger/platformatic.service.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/service",
"server": {
"hostname": "127.0.0.1",
"port": 0
},
"service": {
"openapi": true
}
}
14 changes: 14 additions & 0 deletions packages/deploy-client/test/fixtures/runtime-basic/platformatic.runtime.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
"entrypoint": "serviceApp",
"autoload": {
"path": "./packages",
"exclude": ["docs"],
"mappings": {
"serviceAppWithLogger": {
"id": "with-logger",
"config": "platformatic.service.json"
}
}
}
}
18 changes: 18 additions & 0 deletions packages/metaconfig/test/from-eighteen-to-will-see.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,21 @@ test('specified version is bigger than the current version (major)', async (t) =
const meta = new FromZeroEighteenToWillSee({ version, config: {} })
t.equal(meta.up, undefined)
})

test('handles composer apps', async (t) => {
const version = semver.inc(pkg.version, 'major')
const meta = new FromZeroEighteenToWillSee({
version,
config: { composer: {} }
})
t.equal(meta.kind, 'composer')
})

test('handles runtime apps', async (t) => {
const version = semver.inc(pkg.version, 'major')
const meta = new FromZeroEighteenToWillSee({
version,
config: { entrypoint: 'foo' }
})
t.equal(meta.kind, 'runtime')
})
4 changes: 4 additions & 0 deletions packages/metaconfig/versions/simple-zero-config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ class SimpleZeroConfig {

if (config.db) {
this.kind = 'db'
} else if (config.composer) {
this.kind = 'composer'
} else if (config.entrypoint) {
this.kind = 'runtime'
} else {
this.kind = 'service'
}
Expand Down
2 changes: 2 additions & 0 deletions packages/runtime/.npmignore
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.nyc_output
coverage
201 changes: 201 additions & 0 deletions packages/runtime/LICENSE
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
13 changes: 13 additions & 0 deletions packages/runtime/NOTICE
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Copyright 2022 Platformatic

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
13 changes: 13 additions & 0 deletions packages/runtime/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# @platformatic/runtime

Check out the full documentation for Platformatic Runtime on [our website](https://oss.platformatic.dev/docs/getting-started/quick-start-guide).

## Install

```sh
npm install @platformatic/runtime
```

## License

Apache 2.0
14 changes: 14 additions & 0 deletions packages/runtime/fixtures/configs/invalid-entrypoint.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
"entrypoint": "invalid",
"autoload": {
"path": "../monorepo",
"exclude": ["docs", "composerApp"],
"mappings": {
"serviceAppWithLogger": {
"id": "with-logger",
"config": "platformatic.service.json"
}
}
}
}
13 changes: 13 additions & 0 deletions packages/runtime/fixtures/configs/missing-property.config.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
"entrypoint": "serviceApp",
"autoload": {
"exclude": ["docs", "composerApp"],
"mappings": {
"serviceAppWithMultiplePlugins": {
"id": "multi-plugin-service",
"config": "platformatic.service.json"
}
}
}
}
7 changes: 7 additions & 0 deletions packages/runtime/fixtures/configs/missing-service-config.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
"entrypoint": "serviceApp",
"autoload": {
"path": "../monorepo"
}
}
19 changes: 19 additions & 0 deletions packages/runtime/fixtures/configs/monorepo-composer.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
"entrypoint": "composerApp",
"hotReload": false,
"autoload": {
"path": "../monorepo",
"exclude": ["docs"],
"mappings": {
"serviceAppWithLogger": {
"id": "with-logger",
"config": "platformatic.service.json"
},
"serviceAppWithMultiplePlugins": {
"id": "multi-plugin-service",
"config": "platformatic.service.json"
}
}
}
}
21 changes: 21 additions & 0 deletions packages/runtime/fixtures/configs/monorepo-create-cycle.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
"entrypoint": "with-logger",
"allowCycles": false,
"hotReload": false,
"autoload": {
"path": "../monorepo",
"exclude": [
"composerApp",
"docs",
"serviceAppWithMultiplePlugins",
"serviceAppWithLogger"
],
"mappings": {
"serviceApp": {
"id": "with-logger",
"config": "platformatic.service.json"
}
}
}
}
20 changes: 20 additions & 0 deletions packages/runtime/fixtures/configs/monorepo-no-cycles.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
"entrypoint": "serviceApp",
"allowCycles": false,
"hotReload": false,
"autoload": {
"path": "../monorepo",
"exclude": ["docs", "composerApp"],
"mappings": {
"serviceAppWithLogger": {
"id": "with-logger",
"config": "platformatic.service.json"
},
"serviceAppWithMultiplePlugins": {
"id": "multi-plugin-service",
"config": "platformatic.service.json"
}
}
}
}
20 changes: 20 additions & 0 deletions packages/runtime/fixtures/configs/monorepo.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
"entrypoint": "serviceApp",
"allowCycles": true,
"hotReload": false,
"autoload": {
"path": "../monorepo",
"exclude": ["docs", "composerApp"],
"mappings": {
"serviceAppWithLogger": {
"id": "with-logger",
"config": "platformatic.service.json"
},
"serviceAppWithMultiplePlugins": {
"id": "multi-plugin-service",
"config": "platformatic.service.json"
}
}
}
}
5 changes: 5 additions & 0 deletions packages/runtime/fixtures/configs/no-services.config.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
"entrypoint": "doesNotExist",
"services": []
}
4 changes: 4 additions & 0 deletions packages/runtime/fixtures/configs/no-sources.config.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
"entrypoint": ""
}
11 changes: 11 additions & 0 deletions packages/runtime/fixtures/configs/service-throws-on-start.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/runtime",
"entrypoint": "serviceThrowsOnStart",
"services": [
{
"id": "serviceThrowsOnStart",
"path": "../serviceAppThrowsOnStart",
"config": "platformatic.service.json"
}
]
}
39 changes: 39 additions & 0 deletions packages/runtime/fixtures/monorepo/composerApp/platformatic.composer.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"$schema": "https://platformatic.dev/schemas/v0.23.2/composer",
"server": {
"hostname": "127.0.0.1",
"port": 0,
"logger": {
"level": "info"
},
"pluginTimeout": 0
},
"composer": {
"services": [
{
"id": "with-logger",
"openapi": {
"url": "/documentation/json",
"prefix": "/with-logger"
}
},
{
"id": "multi-plugin-service",
"origin": "{PLT_ORIGIN_BUT_NOT_PROVIDED}",
"openapi": {
"url": "/documentation/json",
"prefix": "/multi-plugin-service"
}
},
{
"id": "serviceApp",
"openapi": {
"url": "/documentation/json",
"prefix": "/service-app"
}
}
],
"refreshTimeout": 5000
},
"watch": false
}
1 change: 1 addition & 0 deletions packages/runtime/fixtures/monorepo/docs/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This package should be excluded.
7 changes: 7 additions & 0 deletions packages/runtime/fixtures/monorepo/serviceApp/deps/dep1.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
async function getGreeting () {
const dep2 = await import('./dep2.mjs')

return dep2.default.greeting
}

module.exports = { getGreeting }
2 changes: 2 additions & 0 deletions packages/runtime/fixtures/monorepo/serviceApp/deps/dep2.mjs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
import dep3 from './dep3.mjs'
export default dep3
2 changes: 2 additions & 0 deletions packages/runtime/fixtures/monorepo/serviceApp/deps/dep3.mjs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
import dep4 from './dep4.js'
export default dep4
1 change: 1 addition & 0 deletions packages/runtime/fixtures/monorepo/serviceApp/deps/dep4.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = { greeting: 'hello' }
22 changes: 22 additions & 0 deletions packages/runtime/fixtures/monorepo/serviceApp/platformatic.service.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/service",
"server": {
"hostname": "127.0.0.1",
"port": 0
},
"service": {
"openapi": true
},
"plugins": {
"hotReload": true,
"paths": [
"plugin.js"
]
},
"clients": [
{
"path": "./with-logger",
"url": "{PLT_WITH_LOGGER_URL}"
}
]
}
25 changes: 25 additions & 0 deletions packages/runtime/fixtures/monorepo/serviceApp/plugin.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
'use strict'

const { request } = require('undici')
const { getGreeting } = require('./deps/dep1')

/** @param {import('fastify').FastifyInstance} app */
module.exports = async function (app) {
app.get('/', async () => {
return { hello: await getGreeting() + '123' }
})

app.get('/upstream', async () => {
const res = await request('http://with-logger.plt.local')
const text = await res.body.text()
return text
})

app.get('/crash', () => {
setImmediate(() => {
throw new Error('boom')
})

return 'ok'
})
}
5 changes: 5 additions & 0 deletions packages/runtime/fixtures/monorepo/serviceApp/with-logger/package.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"name": "with-logger",
"main": "./with-logger.cjs",
"types": "./with-logger.d.ts"
}
25 changes: 25 additions & 0 deletions packages/runtime/fixtures/monorepo/serviceApp/with-logger/with-logger.cjs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
'use strict'

// const pltClient = require('@platformatic/client')
const { join } = require('path')

async function plugin () {

}

async function generateWithLoggerClientPlugin (app, opts) {
app.register(plugin, {
type: 'openapi',
name: 'withLogger',
path: join(__dirname, 'with-logger.openapi.json'),
url: opts.url
})
}

generateWithLoggerClientPlugin[Symbol.for('plugin-meta')] = {
name: 'withLogger OpenAPI Client'
}
generateWithLoggerClientPlugin[Symbol.for('skip-override')] = true

module.exports = generateWithLoggerClientPlugin
module.exports.default = generateWithLoggerClientPlugin
38 changes: 38 additions & 0 deletions packages/runtime/fixtures/monorepo/serviceApp/with-logger/with-logger.d.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import { FastifyPluginAsync } from 'fastify'

interface GetRequest {
}

interface GetResponse {
}

interface WithLogger {
get(req: GetRequest): Promise<GetResponse>;
}

type WithLoggerPlugin = FastifyPluginAsync<NonNullable<withLogger.WithLoggerOptions>>

declare module 'fastify' {
interface ConfigureWithLogger {
async getHeaders(req: FastifyRequest, reply: FastifyReply): Promise<Record<string,string>>;
}
interface FastifyInstance {
'withLogger': WithLogger;
configureWithLogger(opts: ConfigureWithLogger): unknown
}

interface FastifyRequest {
'withLogger': WithLogger;
}
}

declare namespace withLogger {
export interface WithLoggerOptions {
url: string
}
export const withLogger: WithLoggerPlugin;
export { withLogger as default };
}

declare function withLogger(...params: Parameters<WithLoggerPlugin>): ReturnType<WithLoggerPlugin>;
export = withLogger;
22 changes: 22 additions & 0 deletions packages/runtime/fixtures/monorepo/serviceApp/with-logger/with-logger.openapi.json
View file
Original file line number Diff line number Diff line change
@@ -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"
}
}
}
}
}
}
19 changes: 19 additions & 0 deletions packages/runtime/fixtures/monorepo/serviceAppWithLogger/platformatic.service.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/service",
"server": {
"hostname": "127.0.0.1",
"port": 0,
"logger": {
"name": "service-with-logger",
"level": "trace"
}
},
"service": {
"openapi": true
},
"plugins": {
"paths": [
"plugin.js"
]
}
}
8 changes: 8 additions & 0 deletions packages/runtime/fixtures/monorepo/serviceAppWithLogger/plugin.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
'use strict'

/** @param {import('fastify').FastifyInstance} app */
module.exports = async function (app) {
app.get('/', async () => {
return { hello: 'world' }
})
}
26 changes: 26 additions & 0 deletions packages/runtime/fixtures/monorepo/serviceAppWithMultiplePlugins/platformatic.service.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/service",
"server": {
"hostname": "127.0.0.1",
"port": 0
},
"service": {
"openapi": true
},
"plugins": {
"paths": [
{
"path": "plugin.js",
"options": {
"name": "plugin1"
}
},
{
"path": "plugin2.mjs",
"options": {
"name": "plugin2"
}
}
]
}
}
8 changes: 8 additions & 0 deletions packages/runtime/fixtures/monorepo/serviceAppWithMultiplePlugins/plugin.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
'use strict'

/** @param {import('fastify').FastifyInstance} app */
module.exports = async function (app, options) {
app.get('/plugin1', async () => {
return { hello: options.name }
})
}
5 changes: 5 additions & 0 deletions packages/runtime/fixtures/monorepo/serviceAppWithMultiplePlugins/plugin2.mjs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export default async function (app, options) {
app.get('/plugin2', async () => {
return { hello: options.name }
})
}
13 changes: 13 additions & 0 deletions packages/runtime/fixtures/serviceAppThrowsOnStart/platformatic.service.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"$schema": "https://platformatic.dev/schemas/v0.20.0/service",
"server": {
"hostname": "127.0.0.1",
"port": 0
},
"plugins": {
"hotReload": true,
"paths": [
"plugin.js"
]
}
}
6 changes: 6 additions & 0 deletions packages/runtime/fixtures/serviceAppThrowsOnStart/plugin.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
'use strict'

/** @param {import('fastify').FastifyInstance} app */
module.exports = async function (app) {
throw new Error('boom')
}
Loading