@data-fair/lib-node 2.2.2 → 2.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@data-fair/lib-node",
-  "version": "2.2.2",
+  "version": "2.3.0",
   "description": "Small nodejs related utility functions for the data-fair stack.",
   "main": "index.js",
   "files": [

package/test-spies.js

@@ -1,4 +1,6 @@
 import { register } from 'node:module'
+import debugModule from 'debug'
+const debug = debugModule('test-spies')
 export function registerModuleHooks () {
   register('@data-fair/lib-node/test-module-hooks.js', { parentURL: import.meta.url })
 }
@@ -8,6 +10,7 @@ let i = 0
 export function waitFor (eventName, timeout = 2000) {
   i++
   const id = i
+  debug(`Waiting for test spy ${eventName} (id=${id}, timeout: ${timeout}ms)`)
   // better stack traces
   // see https://github.com/axios/axios/issues/2387#issuecomment-652242713
   Error.stackTraceLimit = 0
@@ -17,16 +20,21 @@ export function waitFor (eventName, timeout = 2000) {
   const p = new Promise((resolve, reject) => {
     pendingPromises[eventName] = pendingPromises[eventName] ?? []
     pendingPromises[eventName].push({ resolve, id })
-    setTimeout(() => reject(new Error(`Timeout waiting for test spy ${eventName}`)), timeout)
+    setTimeout(() => reject(timeoutError), timeout)
   })
   p.finally(() => {
+    debug(`Cleaning up test spy ${eventName} (id=${id})`)
     pendingPromises[eventName] = pendingPromises[eventName].filter(p => p.id !== id)
     if (pendingPromises[eventName].length === 0) { delete pendingPromises[eventName] }
   })
   return p
 }
 export function emit (eventName, data) {
-  if (!pendingPromises[eventName]) { return }
+  debug(`Emitting test spy ${eventName} (${pendingPromises[eventName]?.length} listeners)`)
+  if (!pendingPromises[eventName]?.length) {
+    console.debug(`No listener for test spy ${eventName}`)
+    return
+  }
   for (const p of pendingPromises[eventName]) {
     p.resolve(data)
   }

package/upgrade-scripts.d.ts

@@ -5,4 +5,4 @@ export interface UpgradeScript {
     description: string;
     exec: (db: Db, debug: Debugger) => Promise<void>;
 }
-export default function (db: Db, locks: Locks, basePath?: string): Promise<void>;
+export default function (db: Db, locks: Locks, basePath?: string, bootstrap?: () => Promise<undefined | string>): Promise<void>;

package/upgrade-scripts.js

@@ -4,7 +4,7 @@ import { readdirSync, readFileSync } from 'fs'
 import Debug from 'debug'
 const debug = Debug('upgrade')
 // chose the proper scripts to execute, then run them
-export default async function (db, locks, basePath = './') {
+export default async function (db, locks, basePath = './', bootstrap) {
   const ack = await locks.acquire('upgrade')
   if (!ack) {
     console.warn('upgrade scripts lock is already acquired, skip them')
@@ -15,13 +15,13 @@ export default async function (db, locks, basePath = './') {
     // are not considered "up" and the previous versions keep running in the mean time
   } else {
     try {
-      await runScripts(db, basePath)
+      await runScripts(db, basePath, bootstrap)
     } finally {
       await locks.release('upgrade')
     }
   }
 }
-async function runScripts (db, basePath) {
+async function runScripts (db, basePath, bootstrap) {
   const dir = path.resolve(basePath)
   const pjsonPath = path.join(dir, 'package.json')
   debug('read service info from ' + pjsonPath)
@@ -30,22 +30,33 @@ async function runScripts (db, basePath) {
   debug(`service=${pjson.name} version=${pjson.version}`)
   const services = db.collection('services')
   const service = await services.findOne({ id: pjson.name })
-  const version = service?.version
+  let previousPersion = service?.version
   debug('list scripts from ' + scriptsRoot)
   let scripts = await listScripts(scriptsRoot)
-  if (!version) {
-    debug('No service version found in database, this is probably a fresh install')
-    scripts = scripts.filter(scriptDef => scriptDef.version === 'init')
+  if (previousPersion) {
+    debug(`Current service version from database : ${previousPersion}`)
   } else {
-    debug(`Current service version from database : ${version}`)
-    scripts = scripts.filter(scriptDef => scriptDef.version !== 'init')
+    debug('No service version found in database, this is the first time the upgrade system is run')
+    scripts = scripts.filter(scriptDef => scriptDef.version === 'init')
+    if (bootstrap) {
+      previousPersion = await bootstrap()
+      if (previousPersion) {
+        debug('Bootstrap function returned version %s', previousPersion)
+      } else {
+        debug('Bootstrap function returned no version, this is fresh install, do not run any script')
+      }
+    } else {
+      debug('No bootstrap function, it could be a fresh install, do not run any script')
+    }
   }
-  for (const scriptDef of scripts) {
-    if (semver.gte(scriptDef.version, version)) {
-      for (const scriptName of scriptDef.names) {
-        const script = (await import(path.join(scriptsRoot, scriptDef.version, scriptName))).default
-        debug('Apply script %s/%s : %s', scriptDef.version, scriptName, script.description)
-        await script.exec(db, Debug(`upgrade:${scriptDef.version}:${scriptName}`))
+  if (previousPersion) {
+    for (const scriptDef of scripts) {
+      if (semver.gte(scriptDef.version, previousPersion)) {
+        for (const scriptName of scriptDef.names) {
+          const script = (await import(path.join(scriptsRoot, scriptDef.version, scriptName))).default
+          debug('Apply script %s/%s : %s', scriptDef.version, scriptName, script.description)
+          await script.exec(db, Debug(`upgrade:${scriptDef.version}:${scriptName}`))
+        }
       }
     }
   }