Add integration test for plugin discovery and loading

package.json

@@ -45,7 +45,6 @@
     "@types/bcrypt": "^3.0.0",
     "@types/chai": "^4.0.6",
     "@types/events": "^1.2.0",
-    "@types/expect": "^1.20.4",
     "@types/koa": "^2.11.0",
     "@types/koa-bodyparser": "^4.3.0",
     "@types/koa-router": "^7.4.0",
@@ -60,15 +59,17 @@
     "@types/yargs": "^11.0.0",
     "chai": "^4.1.2",
     "del": "^5.1.0",
-    "expect": "^23.5.0",
+    "expect": "^25.3.0",
     "fake-fs": "^0.5.0",
     "mocha": "^4.0.1",
     "nyc": "^13.3.0",
     "sinon": "^4.1.2",
     "source-map-support": "0.5.16",
+    "storex-hub-plugin-internal-selftest": "^0.0.1",
     "ts-node": "^7.0.1",
     "typescript": "^3.7.5",
-    "@types/prompt-sync": "^4.1.0"
+    "@types/prompt-sync": "^4.1.0",
+    "@worldbrain/storex-hub-interfaces": "^0.1.1"
   },
   "resolutions": {
     "**/graphql": "^14.0.0"

ts/main.test.ts

@@ -0,0 +1,17 @@
+import { main } from "./main"
+import expect from "expect"
+
+describe('Main entry point', () => {
+    it('should correctly discover plugins', async () => {
+        const { application, pluginManager } = await main({
+            runtimeConfig: { discoverPlugins: 'true' },
+            confirmPluginInstall: async () => 'install',
+            withoutServer: true,
+        })
+        expect(pluginManager.loadedPlugins).toEqual({
+            'io.worldbrain.storex-hub.internal.self-test': expect.objectContaining({
+                running: true
+            })
+        })
+    })
+})

ts/main.ts

@@ -9,35 +9,56 @@ import { BcryptAccessTokenManager } from "./access-tokens";
 import { createHttpServer } from "./server";
 import { PluginManager } from './plugins/manager';
 import { discoverInstalledPlugins } from './plugins/discovery/main';
+import { PluginInstallConfirmer } from './plugins/discovery';
 
-export async function main() {
-    const application = await setupApplication()
-    await maybeRunPluginDiscovery(application)
-    await startServer(application)
-    await loadPlugins(application)
+export interface RuntimeConfig {
+    dbFilePath?: string
+    discoverPlugins?: string
 }
 
-export async function setupApplication() {
-    const application = new Application(getApplicationDependencies({
+export async function main(options?: {
+    runtimeConfig?: RuntimeConfig,
+    confirmPluginInstall?: PluginInstallConfirmer,
+    withoutServer?: boolean
+}) {
+    const runtimeConfig = options?.runtimeConfig ?? getRuntimeConfig()
+    const application = await setupApplication(runtimeConfig)
+    await maybeRunPluginDiscovery(application, { runtimeConfig, confirmPluginInstall: options?.confirmPluginInstall })
+    if (!options?.withoutServer) {
+        await startServer(application)
+    }
+    const pluginManager = await loadPlugins(application)
+    return { application, pluginManager }
+}
+
+export function getRuntimeConfig(): RuntimeConfig {
+    return {
         dbFilePath: process.env.DB_PATH,
+        discoverPlugins: process.env.STOREX_HUB_DISCOVER_PLUGINS,
+    }
+}
+
+export async function setupApplication(runtimeConfig?: RuntimeConfig) {
+    const application = new Application(getApplicationDependencies({
+        dbFilePath: runtimeConfig?.dbFilePath,
     }))
     await application.setup()
     return application
 }
 
-async function maybeRunPluginDiscovery(application: Application) {
-    if (!process.env.STOREX_HUB_DISCOVER_PLUGINS) {
-        return
-    }
-
-    const patternOrTrue = process.env.STOREX_HUB_DISCOVER_PLUGINS
-    if (patternOrTrue.toLowerCase() === 'false') {
+async function maybeRunPluginDiscovery(application: Application, options?: {
+    runtimeConfig?: RuntimeConfig
+    confirmPluginInstall?: PluginInstallConfirmer,
+}) {
+    const patternOrTrue = options?.runtimeConfig?.discoverPlugins
+    if (!patternOrTrue || patternOrTrue.toLowerCase() === 'false') {
         return
     }
 
     await discoverInstalledPlugins(application, {
         nodeModulesPath: join(process.cwd(), 'node_modules'),
-        pluginDirGlob: patternOrTrue.toLowerCase() !== 'true' ? patternOrTrue : undefined
+        pluginDirGlob: patternOrTrue.toLowerCase() !== 'true' ? patternOrTrue : undefined,
+        confirmPluginInstall: options?.confirmPluginInstall,
     })
 
     // TODO: Don't know why yet, but added plugins do not immediately get stored
@@ -50,6 +71,7 @@ async function loadPlugins(application: Application) {
         pluginManagementStorage: storage.systemModules.plugins,
     })
     await pluginManager.setup(() => application.api())
+    return pluginManager
 }
 
 export async function startServer(application: Application) {

ts/plugins/discovery/index.test.ts

@@ -1,7 +1,7 @@
+import expect from "expect"
+import { PluginInfo } from "@worldbrain/storex-hub-interfaces/lib/plugins"
 import { withTestApplication } from "../../tests/api/index.tests"
 import { discoverPlugins } from "."
-import { PluginInfo } from "../types"
-import expect from "expect"
 import { Application } from "../../application"
 
 const PLUGINS: { [path: string]: PluginInfo } = {

ts/plugins/discovery/index.ts

@@ -1,9 +1,11 @@
-import { PluginInfo } from "../types";
+import { PluginInfo } from "@worldbrain/storex-hub-interfaces/lib/plugins";
 import { PluginManagementStorage } from "../storage";
 
+export type PluginInstallConfirmer = (pluginInfo: PluginInfo, options: { pluginDir: string }) => Promise<'install' | 'skip' | 'abort'>
+
 export async function discoverPlugins(pluginDirs: string[], options: {
     getPluginInfo: (pluginDir: string) => Promise<PluginInfo | null>
-    confirmPluginInstall: (pluginInfo: PluginInfo, options: { pluginDir: string }) => Promise<'install' | 'skip' | 'abort'>
+    confirmPluginInstall: PluginInstallConfirmer
     pluginManagementStorage: PluginManagementStorage
 }) {
     for (const pluginDir of pluginDirs) {

ts/plugins/discovery/main.ts

@@ -2,8 +2,8 @@ import path from 'path'
 import { existsSync, readFileSync } from 'fs'
 import fastGlob from 'fast-glob'
 import createPrompt from 'prompt-sync'
-import { discoverPlugins } from '.'
-import { PluginInfo } from '../types'
+import { PluginInfo } from "@worldbrain/storex-hub-interfaces/lib/plugins";
+import { discoverPlugins, PluginInstallConfirmer } from '.'
 import { Application } from '../../application'
 const prompt = createPrompt()
 
@@ -14,6 +14,7 @@ function validatePluginInfo(untrusted: any): PluginInfo | null {
 export async function discoverInstalledPlugins(application: Application, options: {
     pluginDirGlob?: string
     nodeModulesPath: string
+    confirmPluginInstall?: PluginInstallConfirmer
 }) {
     const pluginDirGlob = (
         options.pluginDirGlob || '<node_modules>/storex-hub-plugin-*'
@@ -42,38 +43,40 @@ export async function discoverInstalledPlugins(application: Application, options
             const pluginInfo = validatePluginInfo(packageInfo['storexHub'])
             return pluginInfo
         },
-        async confirmPluginInstall(pluginInfo: PluginInfo, { pluginDir }) {
-            let result: string | undefined
-            do {
-                console.log([
-                    `Found new plugin in directory ${pluginDir}:`,
-                    `- Description: ${pluginInfo.description}`,
-                    `- Website: ${pluginInfo.siteUrl}`,
-                ].join('\n'))
-                result = prompt(
-                    `Only install plugins you trust. Do you want to install this one? [y/N] `,
-                    'N'
-                )
-                if (!result) {
-                    return 'abort'
-                }
+        confirmPluginInstall: options.confirmPluginInstall ?? confirmPluginInstallByPrompt,
+    })
+}
 
-                if (result) {
-                    result = result.toLowerCase()
-                }
-                if (['y', 'n', 'yes', 'no'].indexOf(result) === -1) {
-                    console.error(`Invalid response: ${result}`)
-                    result = undefined
-                }
-            } while (!result)
+const confirmPluginInstallByPrompt: PluginInstallConfirmer = async (pluginInfo: PluginInfo, { pluginDir }) => {
+    let result: string | undefined
+    do {
+        console.log([
+            `Found new plugin in directory ${pluginDir}:`,
+            `- Description: ${pluginInfo.description}`,
+            `- Website: ${pluginInfo.siteUrl}`,
+        ].join('\n'))
+        result = prompt(
+            `Only install plugins you trust. Do you want to install this one? [y/N] `,
+            'N'
+        )
+        if (!result) {
+            return 'abort'
+        }
 
-            if (result.startsWith('y')) {
-                console.log('Installing plugin...')
-                return 'install'
-            } else {
-                console.log('OK, skipping this plugin...')
-                return 'skip'
-            }
-        },
-    })
+        if (result) {
+            result = result.toLowerCase()
+        }
+        if (['y', 'n', 'yes', 'no'].indexOf(result) === -1) {
+            console.error(`Invalid response: ${result}`)
+            result = undefined
+        }
+    } while (!result)
+
+    if (result.startsWith('y')) {
+        console.log('Installing plugin...')
+        return 'install'
+    } else {
+        console.log('OK, skipping this plugin...')
+        return 'skip'
+    }
 }

ts/plugins/manager.ts

@@ -1,8 +1,10 @@
 import { PluginManagementStorage } from "./storage";
-import { PluginInfo, PluginEntryFunction, PluginInterface } from "./types";
+import { PluginInfo, PluginEntryFunction, PluginInterface } from "@worldbrain/storex-hub-interfaces/lib/plugins";
 import { StorexHubApi_v0 } from "../public-api";
 
 export class PluginManager {
+    loadedPlugins: { [identifier: string]: PluginInterface } = {}
+
     constructor(private options: {
         pluginManagementStorage: PluginManagementStorage
     }) {
@@ -39,15 +41,14 @@ export class PluginManager {
             return null
         }
 
-        let plugin: PluginInterface
         try {
-            plugin = await entryFunction({ api: await createAPI() })
+            this.loadedPlugins[pluginInfo.identifier] = await entryFunction({ api: await createAPI() })
         } catch (e) {
             console.error(`ERROR during initialization plugin '${pluginInfo.identifier}':`)
             console.error(e)
             return null
         }
 
-        return plugin
+        return this.loadedPlugins[pluginInfo.identifier]
     }
 }

ts/plugins/storage/index.ts

@@ -1,7 +1,7 @@
 import * as path from 'path'
 import { StorageModule, StorageModuleConfig } from "@worldbrain/storex-pattern-modules";
 import STORAGE_VERSIONS from "../../storage/versions";
-import { PluginInfo } from "../types";
+import { PluginInfo } from '@worldbrain/storex-hub-interfaces/lib/plugins';
 
 export class PluginManagementStorage extends StorageModule {
     getConfig = (): StorageModuleConfig => ({

ts/public-api/index.ts

@@ -1,3 +1 @@
-export * from './server'
-export * from './client'
-export * from './common'
+export * from '@worldbrain/storex-hub-interfaces/lib/api'