pockethost 1.3.1 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # pockethost
 
+## 1.4.0
+
+### Minor Changes
+
+- b7e4323: Added ability for plugins to respond to `pockethost serve`
+
+## 1.3.2
+
+### Patch Changes
+
+- b0a78d8: Updated plugin authoring guide
+- ac63ea7: Updated plugin documentation
+- Updated dependencies [eb0d011]
+- Updated dependencies [38d2c93]
+  - @pockethost/plugin-launcher-spawn@0.2.0
+  - @pockethost/plugin-console-logger@0.2.0
+  - @pockethost/plugin-auto-admin@0.1.0
+
 ## 1.3.1
 
 ### Patch Changes

package/core.ts

@@ -1,2 +1 @@
-export * from './src/common'
 export * from './src/core'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pockethost",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "author": {
     "name": "Ben Allfree",
     "url": "https://github.com/benallfree"
@@ -39,9 +39,9 @@
     "typescript": "^5.4.5",
     "update-notifier": "^7.0.0",
     "url-pattern": "^1.0.3",
-    "@pockethost/plugin-console-logger": "^0.1.0",
-    "@pockethost/plugin-launcher-spawn": "^0.1.0",
-    "@pockethost/plugin-auto-admin": "^0.0.1"
+    "@pockethost/plugin-console-logger": "^0.2.0",
+    "@pockethost/plugin-auto-admin": "^0.1.0",
+    "@pockethost/plugin-launcher-spawn": "^0.2.0"
   },
   "devDependencies": {
     "@types/express": "^4.17.21",

package/readme.md

@@ -63,7 +63,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,35 @@
 import { Command } from 'commander'
-import { LoggerService } from '../../../common'
-import { serve } from '../../../server'
+import {
+  LoggerService,
+  doServeAction,
+  doServeSlugsFilter,
+} from '../../../common'
 
 type Options = {
   isolate: boolean
 }
 
-export const ServeCommand = () => {
+export const ServeCommand = async () => {
+  const serveSlugs = await doServeSlugsFilter([])
+
   const cmd = new Command(`serve`)
     .description(`Run PocketHost`)
+    .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) => {
       const logger = LoggerService().create(`ServeCommand`)
       const { dbg, error, info, warn } = logger
       info(`Starting`)
 
-      await serve()
+      await doServeAction({ only: serveSlugs })
     })
   return cmd
 }

package/src/cli/index.ts

@@ -4,15 +4,15 @@ import { uniq } from '@s-libs/micro-dash'
 import { program } from 'commander'
 import { readFileSync } from 'fs'
 import updateNotifier from 'update-notifier'
+import { PH_PLUGINS, PH_PROJECT_DIR } from '../../core'
 import {
   DEBUG,
   LogLevelName,
   LoggerService,
-  PH_PLUGINS,
-  PH_PROJECT_DIR,
   doCliCommandsFilter,
   loadPlugins,
-} from '../../core'
+} from '../common'
+import { pockethost } from '../server'
 import { ConfigCommand } from './commands/ConfigCommand'
 import { PluginCommand } from './commands/PluginCommand'
 import { ServeCommand } from './commands/ServeCommand'
@@ -22,7 +22,8 @@ export const { dbg, info, error } = LoggerService({
 })
 
 export const main = async () => {
-  await loadPlugins(uniq(PH_PLUGINS()))
+  await loadPlugins([pockethost, ...uniq(PH_PLUGINS())])
+
   const pkg = await JSON.parse(
     readFileSync(PH_PROJECT_DIR(`package.json`), 'utf8').toString(),
   )
@@ -36,7 +37,7 @@ export const main = async () => {
     .version(version)
 
   const commands = await doCliCommandsFilter([
-    ServeCommand(),
+    await ServeCommand(),
     ConfigCommand(),
     PluginCommand(),
   ])

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,6 +5,7 @@ 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',
@@ -113,3 +114,7 @@ export const [
     instance: InstanceFields
   }
 >(CoreFilters.GetOrProvisionInstanceUrl)
+
+export const [doServeSlugsFilter, onServeSlugsFilter] = createCustomFilter<
+  string[]
+>(CoreFilters.ServeSlugs)

package/src/constants.ts

@@ -4,14 +4,8 @@ import envPaths from 'env-paths'
 import { dirname, join } from 'path'
 import { cwd } from 'process'
 import { fileURLToPath } from 'url'
-import {
-  InstanceId,
-  mkBoolean,
-  mkCsvString,
-  mkNumber,
-  mkPath,
-  mkString,
-} from '../core'
+import { mkBoolean, mkCsvString, mkNumber, mkPath, mkString } from '../core'
+import { InstanceId } from './common'
 import { DEBUG, IS_DEV } from './common/debug'
 import { Settings } from './core/Settings'
 

package/src/server.ts

@@ -2,10 +2,8 @@ import express, { ErrorRequestHandler } from 'express'
 import 'express-async-errors'
 import { default as httpProxy } from 'http-proxy'
 import {
-  APEX_DOMAIN,
   LoggerService,
-  PORT,
-  asyncExitHook,
+  PocketHostPlugin,
   doAfterInstanceFoundAction,
   doAfterServerStartAction,
   doAppMountedAction,
@@ -15,16 +13,16 @@ import {
   doRequestErrorAction,
   doRequestErrorMessageFilter,
   onInstanceLogAction,
-} from '../core'
+  onServeAction,
+  onServeSlugsFilter,
+} from '../common'
+import { APEX_DOMAIN, PORT, asyncExitHook } from '../core'
+import { dbg } from './cli'
 
-export const serve = async () => {
+const serve = async () => {
   const _proxyLogger = LoggerService().create('ProxyService')
   const { dbg, error, info, trace, warn } = _proxyLogger
 
-  onInstanceLogAction(async ({ instance, type, data }) => {
-    dbg(data.toString())
-  })
-
   // registerFilter(
   //   CoreFilters.Waf_VHosts,
   //   async (routes: { [_: string]: string }) => {
@@ -113,3 +111,18 @@ export const serve = async () => {
     info(`Shutting down pockethost`)
   })
 }
+
+export const pockethost: PocketHostPlugin = async ({}) => {
+  onInstanceLogAction(async ({ instance, type, data }) => {
+    dbg(data.toString())
+  })
+
+  onServeAction(async ({ only }) => {
+    if (!only.includes(`pockethost`)) return
+    serve()
+  })
+
+  onServeSlugsFilter(async (slugs) => {
+    return [...slugs, `pockethost`]
+  })
+}