platformatic 0.15.1 → 0.17.0

package/README.md

@@ -1,21 +1,26 @@
-# Platformatic
+![The Platformatic logo](../../assets/banner-light.png 'The Platformatic logo')
 
-Platformatic is a set a Open Source tools that you can use to build your own
-_Internal Developer Platform_.
-
-The first of these tools is **Platformatic DB** — more will follow!
+<p align="center">
+  <br/>
+  <a href="https://platformatic.dev/">Platformatic</a> open-source tools simplify
+	building and
+  <br/>
+  running Node.js applications, with best practices baked in.
+  <br/><br/>
+</p>
 
 ## Install
 
 ```bash
-npm install platformatic
+# Create a new application
+npm create platformatic@latest
 
-# Start a new project
-npx platformatic db init
+# Or install manually:
+npm install platformatic
 ```
 
 Follow our [Quick Start Guide](https://oss.platformatic.dev/docs/getting-started/quick-start-guide)
-guide to get up and running with Platformatic DB.
+guide to get up and running with Platformatic.
 
 ## Documentation
 
@@ -32,4 +37,4 @@ for help.
 
 ## License
 
-Apache 2.0
+[Apache 2.0](LICENSE)

package/cli.js

@@ -9,6 +9,7 @@ import { readFile } from 'fs/promises'
 import { join } from 'desm'
 import { isColorSupported } from 'colorette'
 import helpMe from 'help-me'
+import { upgrade } from './lib/upgrade.js'
 
 import { logo } from './lib/ascii.js'
 
@@ -34,6 +35,7 @@ const ensureCommand = async ({ output, help }) => {
 
 program.register('db', async (args) => ensureCommand(await runDB(args)))
 program.register('service', async (args) => ensureCommand(await runService(args)))
+program.register('upgrade', upgrade)
 program.register('help', help.toStdout)
 program.register('help db', async (args) => runDB(['help', ...args]))
 program.register('help service', async (args) => runService(['help', ...args]))

package/help/help.txt

@@ -4,3 +4,4 @@ Welcome to Platformatic. Available commands are:
 * help <command> - shows more information about a command.
 * db - start Platformatic DB; type `platformatic db help` to know more.
 * service - start Platformatic Service; type `platformatic service help` to know more.
+* upgrade - upgrade the Platformatic configuration to the latest version.

package/help/upgrade.txt

@@ -0,0 +1,16 @@
+Upgrade the Platformatic configuration to the latest version.
+
+``` bash
+ $ platformatic upgrade
+```
+
+Options:
+
+  -c, --config FILE      Specify a configuration file to use
+
+If not specified, the configuration specified will be loaded from `platformatic.db.json`,
+`platformatic.db.yml`, or `platformatic.db.tml`, `platformatic.service.json`,
+`platformatic.service.yml`, or `platformatic.service.tml` in the current directory. You can find more details about
+the configuration format at:
+https://oss.platformatic.dev/docs/reference/db/configuration and 
+https://oss.platformatic.dev/docs/reference/service/configuration.

package/lib/upgrade.js

@@ -0,0 +1,62 @@
+import { analyze, write } from '@platformatic/metaconfig'
+import parseArgs from 'minimist'
+import { access } from 'fs/promises'
+import { resolve } from 'path'
+
+const configFileNames = [
+  './platformatic.db.json',
+  './platformatic.db.json5',
+  './platformatic.db.yaml',
+  './platformatic.db.yml',
+  './platformatic.db.toml',
+  './platformatic.db.tml',
+  './platformatic.service.json',
+  './platformatic.service.json5',
+  './platformatic.service.yaml',
+  './platformatic.service.yml',
+  './platformatic.service.toml',
+  './platformatic.service.tml'
+]
+
+async function isFileAccessible (filename) {
+  try {
+    await access(filename)
+    return true
+  } catch (err) {
+    return false
+  }
+}
+
+export async function upgrade (argv) {
+  const args = parseArgs(argv, {
+    alias: {
+      config: 'c'
+    }
+  })
+
+  let accessibleConfigFilename = args.config
+
+  if (!accessibleConfigFilename) {
+    const configFilesAccessibility = await Promise.all(configFileNames.map((fileName) => isFileAccessible(fileName)))
+    accessibleConfigFilename = configFileNames.find((value, index) => configFilesAccessibility[index])
+  }
+
+  if (!accessibleConfigFilename) {
+    console.error('No config file found')
+    process.exitCode = 1
+    return
+  }
+
+  accessibleConfigFilename = resolve(accessibleConfigFilename)
+
+  let meta = await analyze({ file: accessibleConfigFilename })
+
+  console.log(`Found ${meta.version} for Platformatic ${meta.kind} in ${meta.format} format`)
+
+  while (typeof meta.up === 'function') {
+    meta = meta.up()
+  }
+
+  await write(meta)
+  console.log('Upgraded to', meta.version)
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "platformatic",
-  "version": "0.15.1",
+  "version": "0.17.0",
   "description": "Platformatic CLI",
   "main": "cli.js",
   "type": "module",
@@ -27,26 +27,28 @@
     "mercurius"
   ],
   "devDependencies": {
-    "c8": "^7.12.0",
+    "c8": "^7.13.0",
     "execa": "^7.0.0",
+    "license-checker": "^25.0.1",
     "snazzy": "^9.0.0",
     "split2": "^4.1.0",
     "standard": "^17.0.0",
-    "tap": "^16.3.2",
-    "undici": "^5.14.0"
+    "tap": "^16.3.4",
+    "undici": "^5.20.0"
   },
   "dependencies": {
     "colorette": "^2.0.19",
     "commist": "^3.2.0",
-    "desm": "^1.3.0",
     "help-me": "^4.2.0",
-    "minimist": "^1.2.7",
-    "@platformatic/authenticate": "0.15.1",
-    "@platformatic/db": "0.15.1",
-    "@platformatic/service": "0.15.1"
+    "minimist": "^1.2.8",
+    "@platformatic/db": "0.17.0",
+    "@platformatic/authenticate": "0.17.0",
+    "@platformatic/metaconfig": "0.17.0",
+    "@platformatic/service": "0.17.0"
   },
   "scripts": {
     "test": "standard | snazzy && c8 --100 tap --no-coverage test/*.test.js",
-    "lint": "standard | snazzy"
+    "lint": "standard | snazzy",
+    "license": "license-checker --production --onlyAllow 'Apache-2.0;MIT;ISC;BSD-2-Clause'"
   }
 }

package/test/fixtures/v0.16.0.db.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "./platformatic.db.schema.json",
+  "server": {
+    "hostname": "{PLT_SERVER_HOSTNAME}",
+    "port": "{PORT}",
+    "logger": {
+      "level": "{PLT_SERVER_LOGGER_LEVEL}"
+    }
+  },
+  "core": {
+    "connectionString": "{DATABASE_URL}",
+    "graphql": true,
+    "openapi": true,
+    "events": false
+  },
+  "authorization": {
+    "adminSecret": "{PLT_ADMIN_SECRET}",
+    "rules": [{
+      "role": "anonymous",
+      "entity": "queue",
+      "find": false,
+      "save": false,
+      "delete": false
+    }, {
+      "role": "anonymous",
+      "entity": "message",
+      "find": false,
+      "save": false,
+      "delete": false
+    }]
+  },
+  "migrations": {
+    "dir": "migrations"
+  },
+  "plugin": {
+    "path": "plugin.js"
+  },
+  "types": {
+    "autogenerate": true
+  }
+}

package/test/upgrade.test.js

@@ -0,0 +1,45 @@
+import { test } from 'tap'
+import { tmpdir } from 'os'
+import { execa } from 'execa'
+import { cp, readFile } from 'fs/promises'
+import { cliPath } from './helper.js'
+import { fileURLToPath } from 'url'
+import { dirname, join } from 'path'
+
+const pkg = JSON.parse(await readFile(join(dirname(fileURLToPath(import.meta.url)), '..', 'package.json'), 'utf8'))
+
+let count = 0
+
+test('writes a config file', async (t) => {
+  const dest = join(tmpdir(), `test-cli-${process.pid}-${count++}`)
+
+  await cp(
+    join(dirname(fileURLToPath(import.meta.url)), 'fixtures', 'v0.16.0.db.json'),
+    join(dest, 'platformatic.db.json'))
+
+  await execa('node', [cliPath, 'upgrade'], {
+    cwd: dest
+  })
+
+  const config = JSON.parse(await readFile(join(dest, 'platformatic.db.json'), 'utf8'))
+
+  t.equal(config.$schema, `https://platformatic.dev/schemas/v${pkg.version.replace('-dev', '')}/db`)
+})
+
+test('writes a config file with a config option', async (t) => {
+  const dest = join(tmpdir(), `test-cli-${process.pid}-${count++}`)
+
+  await cp(
+    join(dirname(fileURLToPath(import.meta.url)), 'fixtures', 'v0.16.0.db.json'),
+    join(dest, 'platformatic.db.json'))
+
+  await execa('node', [cliPath, 'upgrade', '-c', join(dest, 'platformatic.db.json')])
+
+  const config = JSON.parse(await readFile(join(dest, 'platformatic.db.json'), 'utf8'))
+
+  t.equal(config.$schema, `https://platformatic.dev/schemas/v${pkg.version.replace('-dev', '')}/db`)
+})
+
+test('no config file no party', async (t) => {
+  await t.rejects(execa('node', [cliPath, 'upgrade']))
+})