@platformatic/generators 1.17.0 → 1.19.0

package/lib/base-generator.d.ts

@@ -88,7 +88,7 @@ export namespace BaseGenerator {
     getFastifyVersion(): Promise<string>
     getPlatformaticVersion(): Promise<string>
 
-    addPackage(pkg: PackageDefinition): void
+    addPackage(pkg: PackageDefinition): Promise<void>
 
     prepare(): Promise<GeneratorMetadata>
     run(): Promise<GeneratorMetadata>

package/lib/base-generator.js

@@ -1,7 +1,15 @@
 'use strict'
 
 const { readFile } = require('node:fs/promises')
-const { stripVersion, convertServiceNameToPrefix, addPrefixToEnv, extractEnvVariablesFromText, getPackageConfigurationObject, PLT_ROOT } = require('./utils')
+const {
+  stripVersion,
+  convertServiceNameToPrefix,
+  addPrefixToEnv,
+  extractEnvVariablesFromText,
+  getPackageConfigurationObject,
+  PLT_ROOT,
+  getLatestNpmVersion
+} = require('./utils')
 const { join } = require('node:path')
 const { FileGenerator } = require('./file-generator')
 const { generateTests, generatePlugins } = require('./create-plugin')
@@ -388,9 +396,17 @@ class BaseGenerator extends FileGenerator {
     return metadata
   }
 
-  addPackage (pkg) {
-    this.packages.push(pkg)
+  async addPackage (pkg) {
     this.config.dependencies[pkg.name] = 'latest'
+    try {
+      const version = await getLatestNpmVersion(pkg.name)
+      if (version) {
+        this.config.dependencies[pkg.name] = version
+      }
+    } catch (err) {
+      this.logger.warn(`Could not get latest version for ${pkg.name}, setting it to latest`)
+    }
+    this.packages.push(pkg)
   }
 
   // implement in the subclass

package/lib/utils.js

@@ -3,6 +3,8 @@
 const { mkdir } = require('node:fs/promises')
 const { WrongTypeError } = require('./errors')
 const { join } = require('node:path')
+const { request } = require('undici')
+const { setTimeout } = require('timers/promises')
 const PLT_ROOT = 'PLT_ROOT'
 
 async function safeMkdir (dir) {
@@ -133,6 +135,22 @@ function getPackageConfigurationObject (config, serviceName = '') {
   }
   return output
 }
+
+async function getLatestNpmVersion (pkg) {
+  const npmCall = request(`https://registry.npmjs.org/${pkg}`)
+  const timeout = setTimeout(1000, null)
+  const res = await Promise.race([npmCall, timeout])
+  if (!res) {
+    return null
+  }
+  clearTimeout(timeout)
+  if (res.statusCode === 200) {
+    const json = await res.body.json()
+    return json['dist-tags'].latest
+  }
+  return null
+}
+
 module.exports = {
   addPrefixToEnv,
   addPrefixToString,
@@ -142,5 +160,6 @@ module.exports = {
   extractEnvVariablesFromText,
   safeMkdir,
   stripVersion,
-  PLT_ROOT
+  PLT_ROOT,
+  getLatestNpmVersion
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/generators",
-  "version": "1.17.0",
+  "version": "1.19.0",
   "description": "Main classes and utils for generators.",
   "main": "index.js",
   "keywords": [],
@@ -10,7 +10,8 @@
     "@fastify/error": "^3.4.1",
     "boring-name-generator": "^1.0.3",
     "fastify": "^4.24.3",
-    "pino": "^8.16.1"
+    "pino": "^8.16.1",
+    "undici": "^6.3.0"
   },
   "devDependencies": {
     "@types/inquirer": "^9.0.7",

package/test/base-generator.test.js

@@ -8,6 +8,11 @@ const { join } = require('node:path')
 const { fakeLogger, getTempDir } = require('./helpers')
 const { BaseGenerator } = require('../lib/base-generator')
 const { convertServiceNameToPrefix } = require('../lib/utils')
+const { MockAgent, setGlobalDispatcher } = require('undici')
+
+const mockAgent = new MockAgent()
+setGlobalDispatcher(mockAgent)
+mockAgent.disableNetConnect()
 
 afterEach(async () => {
   try {
@@ -398,7 +403,7 @@ test('should add package', async () => {
       }
     ]
   }
-  bg.addPackage(packageDefinition)
+  await bg.addPackage(packageDefinition)
 
   assert.equal(bg.packages.length, 1)
   assert.deepEqual(bg.packages[0], packageDefinition)
@@ -431,7 +436,7 @@ test('support packages', async (t) => {
       isRuntimeContext: true,
       serviceName: 'my-service'
     })
-    svc.addPackage(packageDefinitions[0])
+    await svc.addPackage(packageDefinitions[0])
     await svc.prepare()
 
     const platformaticConfigFile = svc.getFileObject('platformatic.json')
@@ -450,7 +455,12 @@ test('support packages', async (t) => {
     })
 
     assert.equal(svc.config.env.PLT_MY_SERVICE_FST_PLUGIN_STATIC_FOOBAR, 123)
+
+    const packageJsonFile = svc.getFileObject('package.json')
+    const packageJson = JSON.parse(packageJsonFile.contents)
+    assert.equal(packageJson.dependencies['@fastify/compress'], 'latest')
   }
+
   {
     // with standard platformatic plugin
     const svc = new BaseGenerator({
@@ -471,7 +481,7 @@ test('support packages', async (t) => {
         ]
       }
     ]
-    svc.addPackage(packageDefinitions[0])
+    await svc.addPackage(packageDefinitions[0])
     await svc.prepare()
 
     const platformaticConfigFile = svc.getFileObject('platformatic.json')
@@ -510,7 +520,7 @@ test('support packages', async (t) => {
         ]
       }
     ]
-    svc.addPackage(packageDefinitions[0])
+    await svc.addPackage(packageDefinitions[0])
     await svc.prepare()
 
     const platformaticConfigFile = svc.getFileObject('platformatic.json')
@@ -527,6 +537,7 @@ test('support packages', async (t) => {
       ]
     })
   }
+
   {
     // with relative path type and name
     const svc = new BaseGenerator({
@@ -550,7 +561,7 @@ test('support packages', async (t) => {
         ]
       }
     ]
-    svc.addPackage(packageDefinitions[0])
+    await svc.addPackage(packageDefinitions[0])
     await svc.prepare()
 
     const platformaticConfigFile = svc.getFileObject('platformatic.json')
@@ -567,6 +578,143 @@ test('support packages', async (t) => {
       ]
     })
   }
+
+  {
+    // should get the version from npm
+    mockAgent
+      .get('https://registry.npmjs.org')
+      .intercept({
+        method: 'GET',
+        path: '/foobar'
+      })
+      .reply(200, {
+        'dist-tags': {
+          latest: '1.42.0'
+        }
+      })
+
+    const svc = new BaseGenerator({
+      module: '@platformatic/service'
+    })
+    const packageDefinitions = [
+      {
+        name: 'foobar',
+        options: []
+      }
+    ]
+    svc.setConfig({
+      isRuntimeContext: true,
+      serviceName: 'my-service'
+    })
+    await svc.addPackage(packageDefinitions[0])
+    await svc.prepare()
+
+    const packageJsonFile = svc.getFileObject('package.json')
+    const packageJson = JSON.parse(packageJsonFile.contents)
+    assert.equal(packageJson.dependencies.foobar, '1.42.0')
+  }
+
+  {
+    // should default to `latest` if getting the version from npm fails
+    mockAgent
+      .get('https://registry.npmjs.org')
+      .intercept({
+        method: 'GET',
+        path: '/foobar'
+      })
+      .reply(500, {
+        message: 'Internal Server Error'
+      })
+
+    const svc = new BaseGenerator({
+      module: '@platformatic/service'
+    })
+    const packageDefinitions = [
+      {
+        name: 'foobar',
+        options: []
+      }
+    ]
+    svc.setConfig({
+      isRuntimeContext: true,
+      serviceName: 'my-service'
+    })
+    await svc.addPackage(packageDefinitions[0])
+    await svc.prepare()
+
+    const packageJsonFile = svc.getFileObject('package.json')
+    const packageJson = JSON.parse(packageJsonFile.contents)
+    assert.equal(packageJson.dependencies.foobar, 'latest')
+  }
+
+  {
+    // should set latest on timeout
+    mockAgent
+      .get('https://registry.npmjs.org')
+      .intercept({
+        method: 'GET',
+        path: '/foobarxxx'
+      })
+      .reply(200, {
+        'dist-tags': {
+          latest: '1.42.0'
+        }
+      }).delay(3000)
+
+    const svc = new BaseGenerator({
+      module: '@platformatic/service'
+    })
+    const packageName = 'foobarxxx'
+    const packageDefinitions = [
+      {
+        name: packageName,
+        options: []
+      }
+    ]
+    svc.setConfig({
+      isRuntimeContext: true,
+      serviceName: 'my-service'
+    })
+    await svc.addPackage(packageDefinitions[0])
+    await svc.prepare()
+
+    const packageJsonFile = svc.getFileObject('package.json')
+    const packageJson = JSON.parse(packageJsonFile.contents)
+    assert.equal(packageJson.dependencies[packageName], 'latest')
+  }
+
+  {
+    // should default to `latest` if getting the version from npm fails
+    mockAgent
+      .get('https://registry.npmjs.org')
+      .intercept({
+        method: 'GET',
+        path: '/foobar'
+      })
+      .reply(500, {
+        message: 'Internal Server Error'
+      })
+
+    const svc = new BaseGenerator({
+      module: '@platformatic/service'
+    })
+    const packageDefinitions = [
+      {
+        name: 'foobar',
+        options: []
+      }
+    ]
+    svc.setConfig({
+      isRuntimeContext: true,
+      serviceName: 'my-service'
+    })
+    await svc.addPackage(packageDefinitions[0])
+    await svc.prepare()
+
+    const packageJsonFile = svc.getFileObject('package.json')
+    const packageJson = JSON.parse(packageJsonFile.contents)
+    assert.equal(packageJson.dependencies.foobar, 'latest')
+  }
 })
 
 describe('runtime context', () => {