pockethost 1.3.2 → 1.5.0

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # pockethost
 
+## 1.5.0
+
+### Minor Changes
+
+- 5e9ed51: Added `--extra-plugins` global switch to temporarily load extra plugins from CLI
+- 2376b0d: Add InstanceConfig filter, fix instance logger namespace, add core instance app lib
+- 737b4b8: logSettings now exported from core
+- 114b1d2: Add namespace() export to core Logger service
+
+### Patch Changes
+
+- 211fba6: Plugin authoring docs update
+- 675e634: Added docs and updated maildev with plugin hook guards
+- 3daf7f5: Fix: [INFO] logging prefixes
+- 139468f: Updated documentation
+- 1e5321b: Fix: improve plugin loading order
+- Updated dependencies [517f602]
+  - @pockethost/plugin-launcher-spawn@0.3.0
+  - @pockethost/plugin-console-logger@0.2.1
+  - @pockethost/plugin-auto-admin@0.1.1
+
+## 1.4.0
+
+### Minor Changes
+
+- b7e4323: Added ability for plugins to respond to `pockethost serve`
+
 ## 1.3.2
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pockethost",
-  "version": "1.3.2",
+  "version": "1.5.0",
   "author": {
     "name": "Ben Allfree",
     "url": "https://github.com/benallfree"
@@ -26,8 +26,10 @@
     "express-async-errors": "^3.1.1",
     "get-port": "^6.1.2",
     "http-proxy": "^1.18.1",
+    "immer": "^10.1.1",
     "json-stringify-safe": "^5.0.1",
     "listr2": "^8.2.3",
+    "minimist": "^1.2.8",
     "nanoid": "^5.0.2",
     "node-fetch": "^3.3.2",
     "pocketbase": "^0.21.3",
@@ -39,14 +41,15 @@
     "typescript": "^5.4.5",
     "update-notifier": "^7.0.0",
     "url-pattern": "^1.0.3",
-    "@pockethost/plugin-launcher-spawn": "^0.2.0",
-    "@pockethost/plugin-auto-admin": "^0.1.0",
-    "@pockethost/plugin-console-logger": "^0.2.0"
+    "@pockethost/plugin-auto-admin": "^0.1.1",
+    "@pockethost/plugin-console-logger": "^0.2.1",
+    "@pockethost/plugin-launcher-spawn": "^0.3.0"
   },
   "devDependencies": {
     "@types/express": "^4.17.21",
     "@types/http-proxy": "^1.17.13",
     "@types/json-stringify-safe": "^5.0.2",
+    "@types/minimist": "^1.2.5",
     "@types/node": "^20.8.10",
     "@types/semver": "^7.5.4",
     "@types/tmp": "^0.2.5",

package/readme.md

@@ -48,11 +48,12 @@ PocketHost uses a hook architecture and features a growing list plugins. Some pl
 
 Current plugins:
 
-| name                  | description                                                                                       |
-| --------------------- | ------------------------------------------------------------------------------------------------- |
-| plugin-console-logger | Routes log messages to the console                                                                |
-| plugin-auto-admin     | Auto-creates a default admin account on instance launch                                           |
-| plugin-launcher-spawn | Launches PocketBase instances via `spawn()` on the local machine. PocketHost uses this by default |
+| name                             | description                                                                                       |
+| -------------------------------- | ------------------------------------------------------------------------------------------------- |
+| plugin-console-logger            | Routes log messages to the console                                                                |
+| plugin-auto-admin                | Auto-creates a default admin account on instance launch                                           |
+| plugin-launcher-spawn            | Launches PocketBase instances via `spawn()` on the local machine. PocketHost uses this by default |
+| plugin-cloudflare-request-logger | Log additional data when running behind Cloudflare                                                |
 
 Coming soon:
 | name | description |
@@ -63,7 +64,7 @@ Coming soon:
 | plugin-waf-enforce-ssl | Enforce SSL at the
 WAF
 
-See the [./plugin-guide.md](Plugin Authoring Guide) for details about what hooks and filters are available.
+See the [Plugin Authoring Guide](https://github.com/pockethost/pockethost/blob/master/packages/pockethost/plugin-guide.md) for details about what hooks and filters are available.
 
 ## Support
 

package/src/cli/commands/ServeCommand/index.ts

@@ -1,20 +1,36 @@
 import { Command } from 'commander'
-import { LoggerService } from '../../../common'
-import { serve } from '../../../server'
+import {
+  LoggerService,
+  doServeAction,
+  doServeSlugsFilter,
+} from '../../../common'
 
 type Options = {
-  isolate: boolean
+  only: string[]
 }
 
-export const ServeCommand = () => {
+export const ServeCommand = async () => {
+  const serveSlugs = await doServeSlugsFilter([])
+
   const cmd = new Command(`serve`)
     .description(`Run PocketHost`)
-    .action(async (options: Options) => {
+    .option(
+      `-o, --only <only>`,
+      `Only run the specified services`,
+      (s) =>
+        s
+          .split(/,/)
+          .map((s) => s.trim())
+          .filter((s) => serveSlugs.includes(s)),
+      serveSlugs,
+    )
+    .action(async (options: Options, cmd: Command) => {
       const logger = LoggerService().create(`ServeCommand`)
       const { dbg, error, info, warn } = logger
       info(`Starting`)
 
-      await serve()
+      const { only } = options
+      await doServeAction({ only })
     })
   return cmd
 }

package/src/cli/index.ts

@@ -3,6 +3,7 @@
 import { uniq } from '@s-libs/micro-dash'
 import { program } from 'commander'
 import { readFileSync } from 'fs'
+import minimist from 'minimist'
 import updateNotifier from 'update-notifier'
 import { PH_PLUGINS, PH_PROJECT_DIR } from '../../core'
 import {
@@ -12,6 +13,7 @@ import {
   doCliCommandsFilter,
   loadPlugins,
 } from '../common'
+import { pockethost } from '../plugin'
 import { ConfigCommand } from './commands/ConfigCommand'
 import { PluginCommand } from './commands/PluginCommand'
 import { ServeCommand } from './commands/ServeCommand'
@@ -20,8 +22,11 @@ export const { dbg, info, error } = LoggerService({
   level: DEBUG() ? LogLevelName.Debug : LogLevelName.Info,
 })
 
+export type GlobalOptions = {
+  extraPlugins: string[]
+}
+
 export const main = async () => {
-  await loadPlugins(uniq(PH_PLUGINS()))
   const pkg = await JSON.parse(
     readFileSync(PH_PROJECT_DIR(`package.json`), 'utf8').toString(),
   )
@@ -29,13 +34,23 @@ export const main = async () => {
 
   const { version } = pkg
 
+  const argv = minimist<{ e: string }>(process.argv.slice(2), {
+    alias: { e: 'extra-plugins' },
+  })
+  const extraPlugins = argv.e
+    .split(/,/)
+    .map((s) => s.trim())
+    .filter((v) => !!v)
+  await loadPlugins([pockethost, ...uniq(PH_PLUGINS()), ...extraPlugins])
+
   program
     .name('pockethost')
     .description('Multitenant PocketBase hosting')
     .version(version)
+    .option(`-e, --extra-plugins <plugins...>`, `Extra plugins to load`, [])
 
   const commands = await doCliCommandsFilter([
-    ServeCommand(),
+    await ServeCommand(),
     ConfigCommand(),
     PluginCommand(),
   ])

package/src/common/Logger.ts

@@ -53,6 +53,12 @@ export const LogLevels = {
   [LogLevelName.Abort]: 6,
 } as const
 
+export const namespace = (...names: string[]) =>
+  names
+    .filter((v) => !!v)
+    .map((p) => `[${p}]`)
+    .join(' ')
+
 export const createLogger = (config: Partial<LoggerConfig>) => {
   const _config = mergeConfig<LoggerConfig>(
     {
@@ -67,11 +73,7 @@ export const createLogger = (config: Partial<LoggerConfig>) => {
     _config.level = level
   }
 
-  const _pfx = (s: string) =>
-    [s, ...pfx]
-      .filter((v) => !!v)
-      .map((p) => `[${p}]`)
-      .join(' ')
+  const _pfx = (s: string) => namespace(s, ...pfx)
 
   const _log = (levelIn: LogLevelName, ...args: any[]) => {
     doLogAction({
@@ -96,7 +98,7 @@ export const createLogger = (config: Partial<LoggerConfig>) => {
   const info = (...args: any[]) => {
     const _args = (() => {
       if (isLevelGt(LogLevelName.Info, _config.level)) {
-        return [chalk.gray(`INFO`), ...args]
+        return [_pfx(chalk.gray(`INFO`)), ...args]
       }
       return [...args]
     })()

package/src/common/plugin/action.ts

@@ -5,6 +5,7 @@ import { InstanceFields } from '../schema'
 
 enum CoreActions {
   Init = 'core_init',
+  Serve = 'core_serve',
   AppMounted = 'core_on_app_mount',
   AfterServeStart = 'core_after_serve_start',
 
@@ -125,3 +126,7 @@ export const [doAfterInstanceStoppedAction, onAfterInstanceStoppedAction] =
   createCustomActionWithContext<{ instance: InstanceFields; url: string }>(
     CoreActions.AfterInstanceStopped,
   )
+
+export const [doServeAction, onServeAction] = createCustomActionWithContext<{
+  only: string[]
+}>(CoreActions.Serve)

package/src/common/plugin/filter.ts

@@ -5,9 +5,11 @@ import { InstanceFields, InstanceId } from '../schema'
 
 export enum CoreFilters {
   CliCommands = 'core_cli_commands',
+  ServeSlugs = 'core_serve_slugs',
   SpawnConfig = 'core_spawn_config',
   GetInstanceByRequestInfo = 'core_get_instance_by_request_info',
   GetInstanceById = 'core_get_instance_by_id',
+  InstanceConfig = 'core_instance_config',
   ErrorSpawningInstanceMessage = 'core_error_spawning_instance_message',
   FailedToLaunchInstanceMessage = 'core_failed_to_launch_instance_message',
   AuthenticateRequest = 'core_authenticate_request',
@@ -113,3 +115,24 @@ export const [
     instance: InstanceFields
   }
 >(CoreFilters.GetOrProvisionInstanceUrl)
+
+export const [doServeSlugsFilter, onServeSlugsFilter] = createCustomFilter<
+  string[]
+>(CoreFilters.ServeSlugs)
+
+export type Bind = {
+  base: string
+  src: string
+}
+export type Binds = {
+  data: Bind[]
+  hooks: Bind[]
+  migrations: Bind[]
+  public: Bind[]
+}
+export type InstanceConfig = {
+  binds: Binds
+  env: { [_: string]: string }
+}
+export const [doInstanceConfigFilter, onInstanceConfigFilter] =
+  createCustomFilter<InstanceConfig>(CoreFilters.InstanceConfig)

package/src/constants.ts

@@ -1,4 +1,3 @@
-import { forEach } from '@s-libs/micro-dash'
 import { config } from 'dotenv'
 import envPaths from 'env-paths'
 import { dirname, join } from 'path'
@@ -8,6 +7,7 @@ import { mkBoolean, mkCsvString, mkNumber, mkPath, mkString } from '../core'
 import { InstanceId } from './common'
 import { DEBUG, IS_DEV } from './common/debug'
 import { Settings } from './core/Settings'
+import { logSettings } from './core/logSettings'
 
 const __dirname = dirname(fileURLToPath(import.meta.url))
 
@@ -58,12 +58,6 @@ export const NODE_ENV = () => process.env.NODE_ENV
 export const INSTANCE_DATA_DIR = (id: InstanceId, ...paths: string[]) =>
   join(DATA_DIR(), id, ...paths)
 
-export const logConstants = () => {
-  forEach(settings, (v, k) => {
-    console.log(`${k}: ${v}`)
-  })
-}
-
 if (DEBUG()) {
-  logConstants()
+  logSettings(settings)
 }

package/src/core/index.ts

@@ -3,5 +3,6 @@ export * from './Settings'
 export * from './asyncExecutionGuard'
 export * from './exit'
 export * from './internal'
+export * from './logSettings'
 export * from './smartFetch'
 export * from './tryFetch'

package/src/core/logSettings.ts

@@ -0,0 +1,7 @@
+import { forEach } from '@s-libs/micro-dash'
+
+export const logSettings = (settings: { [_: string]: any }) => {
+  forEach(settings, (v, k) => {
+    console.log(`${k}: ${v}`)
+  })
+}

package/src/instance-app/types/all.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="./lib.d.ts" />
+/// <reference path="./goja.d.ts" />
+/// <reference path="./types.d.ts" />

package/src/instance-app/types/goja.d.ts

@@ -0,0 +1,58 @@
+interface Require {
+  (id: string): any
+}
+declare var require: Require
+
+/** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console) */
+interface Console {
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/assert) */
+  assert(condition?: boolean, ...data: any[]): void
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/clear) */
+  clear(): void
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/count) */
+  count(label?: string): void
+  /**
+   * [MDN
+   * Reference](https://developer.mozilla.org/docs/Web/API/console/countReset)
+   */
+  countReset(label?: string): void
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/debug) */
+  debug(...data: any[]): void
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dir) */
+  dir(item?: any, options?: any): void
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/dirxml) */
+  dirxml(...data: any[]): void
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/error) */
+  error(...data: any[]): void
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/group) */
+  group(...data: any[]): void
+  /**
+   * [MDN
+   * Reference](https://developer.mozilla.org/docs/Web/API/console/groupCollapsed)
+   */
+  groupCollapsed(...data: any[]): void
+  /**
+   * [MDN
+   * Reference](https://developer.mozilla.org/docs/Web/API/console/groupEnd)
+   */
+  groupEnd(): void
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/info) */
+  info(...data: any[]): void
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/log) */
+  log(...data: any[]): void
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/table) */
+  table(tabularData?: any, properties?: string[]): void
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/time) */
+  time(label?: string): void
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeEnd) */
+  timeEnd(label?: string): void
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/timeLog) */
+  timeLog(label?: string, ...data: any[]): void
+  timeStamp(label?: string): void
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/trace) */
+  trace(...data: any[]): void
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/warn) */
+  warn(...data: any[]): void
+}
+
+declare var console: Console

package/src/instance-app/types/lib.d.ts

@@ -0,0 +1,5 @@
+type Logger = (...args: any[]) => void
+
+interface Lib {
+  mkLog: (namespace: string) => Logger
+}