pockethost 1.5.0 → 1.6.1

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # pockethost
 
+## 1.6.1
+
+### Patch Changes
+
+- dc8f70b: Updated docs
+
+## 1.6.0
+
+### Minor Changes
+
+- 40bbb3c: Improve tryFetch by accepting node-fetch params
+- 12f029a: Add changeset maker
+- b7277cf: Add public instance URL calculators and refactor HTTP protocol detection
+- 45a8f45: Add internal app (remote control) support
+- 55b43a1: Remove unneeded params from GetOrProvisionInstanceUrl filter
+- 5be2c9e: Initial commit
+- a236f3e: Added several more filters
+- 35edc77: Enhancement: actions execute sequentially
+- 879845a: Enhancement: unsubscribe from filters
+- c473ed9: Added support for priorities in actions
+- 795fcd7: New action: KillInstance
+- c32b845: Added support for Settings filter whereby all settings are collected and displayed in DEBUG() mode
+- cce72b3: New action: AfterPluginsLoaded
+- 82dde2d: Enhancement: filters now have extensible data types
+
+### Patch Changes
+
+- b55c585: Clean up dead code
+- 0e4bf43: Updated commit parser deps
+- f79b067: Added serve command details
+- dd3ceaa: Added filter debugging
+- 7931204: Fixed a bug where adding plugins was not saved correctly
+- 6e14f57: Updated plugin authoring guide
+- 7604930: Minor fix to GetOrProvisionInstanceUrl filter
+- 52b70cb: Fixed bug where --extra-plugins was not defaulting to '' correctly
+- Updated dependencies [c32b845]
+  - @pockethost/plugin-launcher-spawn@1.0.0
+  - @pockethost/plugin-auto-admin@1.0.0
+  - @pockethost/plugin-console-logger@1.0.0
+
 ## 1.5.0
 
 ### Minor Changes

package/changesetx.ts

@@ -0,0 +1,110 @@
+#!/usr/bin/env tsx
+import { execSync } from 'child_process'
+import { sync } from 'conventional-commits-parser'
+import fs, { readFileSync } from 'fs'
+import minimist from 'minimist'
+import { dirname, join } from 'path'
+import { fileURLToPath } from 'url'
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+const repoRootDir = join(__dirname, `../..`)
+
+const argv = minimist(process.argv.slice(2))
+const commitMessage = argv._[0]!
+const { type, subject } = sync(commitMessage)
+if (!type) {
+  console.log('Invalid commit message type')
+  process.exit(1)
+}
+
+function getStagedPackageNames(filePaths: string[]): string[] {
+  const packageNames = new Set<string>()
+
+  filePaths.forEach((filePath) => {
+    const packageName = getPackageName(filePath)
+    if (packageName) {
+      packageNames.add(packageName)
+    }
+  })
+
+  return Array.from(packageNames)
+}
+
+function getPackageName(filePath: string): string | null {
+  const packagePath = filePath.split('/').slice(0, 2).join('/')
+  const packageJsonPath = join(repoRootDir, `${packagePath}/package.json`)
+  const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8'))
+  try {
+    return packageJson.name
+  } catch (error) {
+    return null
+  }
+}
+
+function getStagedFileNames(): string[] {
+  const output = execSync('git diff --name-only --cached').toString()
+  const fileNames = output
+    .trim()
+    .split('\n')
+    .filter((fileName) => fileName.startsWith(`packages/`))
+  return fileNames
+}
+
+async function createChangesetFile() {
+  const fileNames = getStagedFileNames()
+  const packageNames = getStagedPackageNames(fileNames)
+
+  if (packageNames.length === 0) {
+    console.log('No packages staged for commit')
+    process.exit(0)
+  }
+  console.log('Staged packages:', packageNames)
+
+  const prefixMap = {
+    feat: 'minor',
+    enh: 'minor',
+    fix: 'patch',
+    docs: 'patch',
+    chore: 'patch',
+  } as const
+
+  if (!(type! in prefixMap)) {
+    console.log('Invalid prefix found in commit message')
+    process.exit(1)
+  }
+
+  const versionType = prefixMap[type as keyof typeof prefixMap]
+
+  const changesetFile = [
+    `---`,
+    ...packageNames.map((packageName) => `'${packageName}': ${versionType}`),
+    `---`,
+    ``,
+    subject,
+  ].join('\n')
+  return changesetFile
+}
+
+async function writeChangesetFile(changesetFile: string) {
+  const filePath = join(repoRootDir, `.changeset`, `${+new Date()}.md`)
+  try {
+    fs.writeFileSync(filePath, changesetFile)
+    console.log(`Changeset file written successfully at ${filePath}`)
+    execSync(`git add ${filePath}`)
+    console.log(`Changeset file added to git`)
+  } catch (error) {
+    console.error(`Error writing changeset file: ${error}`)
+  }
+}
+
+function commit() {
+  execSync(`git commit -m "${commitMessage}"`)
+}
+
+async function main() {
+  const changesetFile = await createChangesetFile()
+  await writeChangesetFile(changesetFile)
+  commit()
+}
+
+main()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pockethost",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "author": {
     "name": "Ben Allfree",
     "url": "https://github.com/benallfree"
@@ -41,19 +41,22 @@
     "typescript": "^5.4.5",
     "update-notifier": "^7.0.0",
     "url-pattern": "^1.0.3",
-    "@pockethost/plugin-auto-admin": "^0.1.1",
-    "@pockethost/plugin-console-logger": "^0.2.1",
-    "@pockethost/plugin-launcher-spawn": "^0.3.0"
+    "@pockethost/plugin-auto-admin": "^0.2.0",
+    "@pockethost/plugin-console-logger": "^0.3.0",
+    "@pockethost/plugin-launcher-spawn": "^0.4.0"
   },
   "devDependencies": {
+    "@types/conventional-commits-parser": "^5.0.0",
     "@types/express": "^4.17.21",
     "@types/http-proxy": "^1.17.13",
+    "@types/inquirer": "^9.0.7",
     "@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",
-    "@types/update-notifier": "^6.0.8"
+    "@types/update-notifier": "^6.0.8",
+    "conventional-commits-parser": "^5.0.0"
   },
   "scripts": {
     "check-types": "tsc --noEmit ",

package/readme.md

@@ -10,21 +10,75 @@ Extend PocketHost with its Plugin ecosystem. Start with the bare-bones dev serve
 
 ---
 
+<!-- @import "[TOC]" {cmd="toc" depthFrom=2 depthTo=2 orderedList=false} -->
+
+<!-- code_chunk_output -->
+
+- [Quickstart](#quickstart)
+- [Introduction](#introduction)
+- [The magic `serve` command](#the-magic-serve-command)
+- [Configuration](#configuration)
+- [Plugins Directory](#plugins-directory)
+- [Writing Plugins](#writing-plugins)
+- [Support](#support)
+
+<!-- /code_chunk_output -->
+
+---
+
 ## Quickstart
 
 ```
 npx pockethost serve
 ```
 
+## Introduction
+
+PocketHost is a multitenant PocketBase hosting system. With it, you can run multiple instances of PocketBase on different subdomains, all on the same server.
+
+Use PocketHost for development or production purposes.
+
+PocketHost can be easily extended using its thoughtful plugin architecture. By choosing additional plugins, PocketHost's features can be extended according to your exact needs. You can even write your own plugins.
+
+## The magic `serve` command
+
+`pockethost serve` is a special command that can be decorated with plugins. Plugins can respond to the `serve` command by running their own services.
+
+By convention, plugins that have some kind of `serve` functionality such as running a server, will make it available in two ways.
+
+The first way runs ONLY the plugin's `serve` functionality:
+
+```bash
+pockethost <plugin-name> serve
+```
+
+The second way runs ALL `serve` functionality from ALL plugins:
+
+```bash
+pockethost serve
+```
+
+The exact plugins can also be narrowed:
+
+```bash
+pockethost serve --only=plugin1,plugin2,plugin3
+```
+
+See the plugin authoring guide for more information on how to make a plugin that responds to both methods.
+
 ## Configuration
 
-PocketHost supports configuration by environment variable. All PocketHost environment variables begin with `PH_`.
+PocketHost supports configuration by environment variable, `.env` file, and also built-in settings via `pockethost config`.
+
+All PocketHost variables begin with `PH_`.
 
 PocketHost will search the current directory for an `.env` when it loads. Anything in `.env` will be merged with and override any `<PH_HOME>/.env` that may exist.
 
-Use `pockethost config` to set global defaults stored in `<PH_HOME>/.env`.
+Use `pockethost config` to list and set global defaults.
 
-### Variables
+### Core Variables
+
+See `pockethost config ls` for a full list of variables. Plugin variables will also be listed for loaded plugins.
 
 | Name           | Default                    | Discussion                                                                    |
 | -------------- | -------------------------- | ----------------------------------------------------------------------------- |
@@ -42,29 +96,33 @@ Use `pockethost config` to set global defaults stored in `<PH_HOME>/.env`.
 - `@pockethost/plugin-launcher-spawn`
 - `@pockethost/plugin-auto-admin`
 
-## Plugins
+## Plugins Directory
+
+PocketHost uses an action/filter architecture to support a growing list plugins. Some plugins have a CLI component, whereas others add purely programmatic support to alter how PocketHost works.
 
-PocketHost uses a hook architecture and features a growing list plugins. Some plugins have a CLI component, whereas others add purely programmatic support to alter how PocketHost works:
+### Core plugins
 
-Current plugins:
+These plugins are maintained by the PocketHost project.
 
-| 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                                                |
+| Name                                           | Description                                                                                                             |
+| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| `@pockethost/plugin-console-logger`            | Routes log messages to the console                                                                                      |
+| `@pockethost/plugin-auto-admin`                | Auto-creates a default admin account on instance launch                                                                 |
+| `@pockethost/plugin-launcher-spawn`            | Launches PocketBase instances via `spawn()` on the local machine. PocketHost uses this by default                       |
+| `@pockethost/plugin-cloudflare-request-logger` | Log additional data when running behind Cloudflare                                                                      |
+| `@pockethost/plugin-ftp-server`                | Used to provide secure FTPS access to PocketBase instance data. This FTP server can run along-side a PocketHost server. |
+| `@pockethost/plugin-local-auth`                | A light-weight username/password auth provider for associating instances with users.                                    |
 
 Coming soon:
 | name | description |
 | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
-| plugin-ftp-server | Used to provide secure FTPS access to PocketBase instance data. This FTP server can run along-side a PocketHost server. |
 | plugin-launcher-docker | Launches PocketBase instances via Docker. This is useful for running untrusted PocketBase code and instances. pockethost.io uses this. |
 | plugin-waf | A Web Application Firewall |
-| plugin-waf-enforce-ssl | Enforce SSL at the
-WAF
+| plugin-waf-enforce-ssl | Enforce SSL at the WAF
+
+## Writing Plugins
 
-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.
+See the [Plugin Authoring Guide](https://github.com/pockethost/pockethost/blob/master/packages/pockethost/plugin-guide.md) for details about how to write your own plugins.
 
 ## Support
 

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

@@ -1,20 +1,5 @@
-import { forEach, keys, omit } from '@s-libs/micro-dash'
 import { Command } from 'commander'
-import { parse } from 'dotenv'
-import { existsSync, readFileSync, writeFileSync } from 'fs'
-import { info } from '../..'
-import { PH_HOME, isSettingKey, settings } from '../../../constants'
-
-const envFile = () => {
-  const envFile = PH_HOME(`.env`)
-  if (!existsSync(envFile)) {
-    writeFileSync(envFile, '')
-  }
-  return envFile
-}
-
-const _parse = () =>
-  parse(readFileSync(envFile(), { encoding: 'utf8' }).toString())
+import { listConfig, setConfig, unsetConfig } from '../../../core'
 
 export const ConfigCommand = () => {
   const cmd = new Command(`config`)
@@ -24,76 +9,20 @@ export const ConfigCommand = () => {
         .argument(`<name>`, `Config name`)
         .argument(`<value>`, `Config value`)
         .description(`Set a config value`)
-        .action((name, value) => {
-          if (!isSettingKey(name))
-            throw new Error(`Invalid setting name ${name}`)
-
-          if (value === '=') throw new Error(`Invalid value ${value}`)
-
-          const values = _parse()
-          values[name] = value
-          writeFileSync(
-            envFile(),
-            Object.entries(values)
-              .map(([k, v]) => `${k}=${v}`)
-              .join('\n'),
-          )
-          info(`Set ${name}=${value}`)
-          info(`Written to ${envFile()}`)
-        }),
+        .action(setConfig),
     )
 
     .addCommand(
       new Command(`unset`)
         .argument(`<name>`, `Config name`)
         .description(`Unset a config value`)
-        .action((name) => {
-          if (!isSettingKey(name))
-            throw new Error(`Invalid setting name ${name}`)
-
-          const values = _parse()
-          delete values[name]
-          writeFileSync(
-            envFile(),
-            Object.entries(values)
-              .map(([k, v]) => `${k}=${v}`)
-              .join('\n'),
-          )
-          info(`Unset ${name}`)
-          info(`Written to ${envFile()}`)
-        }),
+        .action(unsetConfig),
     )
     .addCommand(
       new Command(`list`)
         .description(`List all config values`)
         .alias(`ls`)
-        .action(() => {
-          const values = _parse()
-
-          if (keys(values).length > 0) {
-            info()
-            info(`Config values from ${envFile()}:`)
-            forEach(values, (v, k) => {
-              info(`\t${k}=${v}`)
-            })
-            info()
-          } else {
-            info(`No config values found in ${envFile()}`)
-          }
-
-          const defaults = omit(settings, keys(values) as any)
-          if (keys(defaults).length > 0) {
-            info(`Default values:`)
-            forEach(settings, (v, k) => {
-              if (k in values) return
-              info(`\t${k}=${v}`)
-            })
-          } else {
-            info(
-              `No default values because all values are defined in ${envFile()}`,
-            )
-          }
-        }),
+        .action(listConfig),
     )
   return cmd
 }

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

@@ -1,22 +1,10 @@
-import { uniq } from '@s-libs/micro-dash'
 import { Command } from 'commander'
-import { parse } from 'dotenv'
-import { existsSync, readFileSync, writeFileSync } from 'fs'
+import { readFileSync } from 'fs'
 import { error, info } from '../..'
-import { PH_HOME, PH_PLUGINS, PH_PROJECT_DIR } from '../../../constants'
+import { PH_PLUGINS, PH_PROJECT_DIR } from '../../../constants'
+import { appendConfig, filterConfig } from '../../../core'
 import { getCompatibleVersions, getPackageJson, removePackage } from './util'
 
-const envFile = () => {
-  const envFile = PH_HOME(`.env`)
-  if (!existsSync(envFile)) {
-    writeFileSync(envFile, '')
-  }
-  return envFile
-}
-
-const _parse = () =>
-  parse(readFileSync(envFile(), { encoding: 'utf8' }).toString())
-
 export const PluginCommand = () => {
   const cmd = new Command(`plugin`)
     .description(`Manage PocketHost plugins`)
@@ -33,22 +21,7 @@ export const PluginCommand = () => {
             const { version } = pkg
             await getCompatibleVersions(`pockethost`, version, [name])
 
-            const values = _parse()
-            values[`PH_PLUGINS`] = uniq([
-              ...(values[`PH_PLUGINS`]
-                ?.split(/,/)
-                .map((v) => v.trim())
-                .filter((v) => !!v) || []),
-              name,
-            ]).join(`,`)
-            writeFileSync(
-              envFile(),
-              Object.entries(values)
-                .map(([k, v]) => `${k}=${v}`)
-                .join('\n'),
-            )
-            info(`Installed ${name}`)
-            info(`Written to ${envFile()}`)
+            appendConfig(`PH_PLUGINS`, name)
           } catch (e) {
             error(`${e}`)
           }
@@ -81,21 +54,7 @@ export const PluginCommand = () => {
         .action(async (name) => {
           try {
             await removePackage(name)
-            const values = _parse()
-            values[`PH_PLUGINS`] = uniq([
-              ...(values[`PH_PLUGINS`]
-                ?.split(/,/)
-                .map((v) => v.trim())
-                .filter((v) => v !== name) || []),
-            ]).join(`,`)
-            writeFileSync(
-              envFile(),
-              Object.entries(values)
-                .map(([k, v]) => `${k}=${v}`)
-                .join('\n'),
-            )
-            info(`Removed ${name}`)
-            info(`Written to ${envFile()}`)
+            filterConfig(`PH_PLUGINS`, name)
           } catch (e) {
             error(`${e}`)
           }

package/src/cli/index.ts

@@ -10,6 +10,7 @@ import {
   DEBUG,
   LogLevelName,
   LoggerService,
+  doAfterPluginsLoadedAction,
   doCliCommandsFilter,
   loadPlugins,
 } from '../common'
@@ -36,13 +37,17 @@ export const main = async () => {
 
   const argv = minimist<{ e: string }>(process.argv.slice(2), {
     alias: { e: 'extra-plugins' },
+    default: { e: '' },
   })
   const extraPlugins = argv.e
     .split(/,/)
     .map((s) => s.trim())
     .filter((v) => !!v)
+
   await loadPlugins([pockethost, ...uniq(PH_PLUGINS()), ...extraPlugins])
 
+  await doAfterPluginsLoadedAction()
+
   program
     .name('pockethost')
     .description('Multitenant PocketBase hosting')

package/src/common/plugin/action.ts

@@ -1,9 +1,12 @@
+import { uniqueId } from '@s-libs/micro-dash'
 import { Express, Request, Response } from 'express'
+import { dbg } from '../../cli'
 import { LogLevelName } from '../Logger'
 import { DEBUG } from '../debug'
 import { InstanceFields } from '../schema'
 
 enum CoreActions {
+  AfterPluginsLoaded = 'core_after_plugins_loaded',
   Init = 'core_init',
   Serve = 'core_serve',
   AppMounted = 'core_on_app_mount',
@@ -18,6 +21,8 @@ enum CoreActions {
   BeforeInstanceStarted = 'core_before_instance_started',
   AfterInstanceStarted = 'core_after_instance_started',
 
+  KillInstance = 'core_kill_instance',
+
   BeforeInstanceStopped = 'core_before_instance_stopped',
   AfterInstanceStopped = 'core_after_instance_stopped',
 
@@ -27,20 +32,34 @@ enum CoreActions {
   Request = 'core_edge_request',
 }
 
-const actions: {
-  [key: string]: ActionHandler<any>[]
-} = {}
-
 export type ActionHandler<TContext = {}> = (
   context: TContext extends never ? [] : TContext,
 ) => Promise<void>
 
-async function registerAction(
+interface Action {
+  priority: number
+  handler: ActionHandler<any>
+}
+
+const actions: {
+  [key: string]: Action[]
+} = {}
+
+function registerAction(
   action: string,
   handler: (...args: any[]) => Promise<void>,
-) {
+  priority: number = 10,
+): () => void {
   if (!(action in actions)) actions[action] = []
-  actions[action]!.push(handler)
+  const uid = uniqueId(`a:${action}:`)
+  dbg(`${uid}:subscribe`)
+  actions[action]!.push({ priority, handler })
+  actions[action]!.sort((a, b) => a.priority - b.priority)
+
+  return () => {
+    dbg(`${uid}:unsubscribe`)
+    actions[action] = actions[action]!.filter((a) => a.handler !== handler)
+  }
 }
 
 async function action(actionName: string, context: any) {
@@ -49,7 +68,9 @@ async function action(actionName: string, context: any) {
   }
   const action = actions[actionName]
   if (!action) return false
-  await Promise.all(action.map((handler) => handler(context)))
+  for (const { handler } of action) {
+    await handler(context)
+  }
   return true
 }
 
@@ -58,18 +79,22 @@ export function createCustomActionWithContext<TContext extends {}>(
 ) {
   return [
     async (context: TContext) => action(actionName, context),
-    async (handler: ActionHandler<TContext>) =>
-      registerAction(actionName, handler),
+    (handler: ActionHandler<TContext>, priority = 10) =>
+      registerAction(actionName, handler, priority),
   ] as const
 }
 
 export function createCustomAction(actionName: CoreActions) {
   return [
     async () => action(actionName, {}),
-    async (handler: ActionHandler) => registerAction(actionName, handler),
+    (handler: ActionHandler, priority = 10) =>
+      registerAction(actionName, handler, priority),
   ] as const
 }
 
+export const [doAfterPluginsLoadedAction, onAfterPluginsLoadedAction] =
+  createCustomAction(CoreActions.AfterPluginsLoaded)
+
 export const [doRequestErrorAction, onRequestErrorAction] =
   createCustomActionWithContext<{
     err: Error
@@ -92,7 +117,9 @@ export const [doInstanceLogAction, onInstanceLogAction] =
   }>(CoreActions.InstanceLog)
 
 export const [doAppMountedAction, onAppMountedAction] =
-  createCustomActionWithContext<{ app: Express }>(CoreActions.AppMounted)
+  createCustomActionWithContext<{ app: Express; internalApp: Express }>(
+    CoreActions.AppMounted,
+  )
 
 export const [doIncomingRequestAction, onIncomingRequestAction] =
   createCustomActionWithContext<{ req: Request; res: Response; host: string }>(
@@ -117,6 +144,11 @@ export const [doAfterInstanceStartedAction, onAfterInstanceStartedAction] =
     CoreActions.AfterInstanceStarted,
   )
 
+export const [doKillInstanceAction, onKillInstanceAction] =
+  createCustomActionWithContext<{ instance: InstanceFields }>(
+    CoreActions.KillInstance,
+  )
+
 export const [doBeforeInstanceStoppedAction, onBeforeInstanceStoppedAction] =
   createCustomActionWithContext<{ instance: InstanceFields; url: string }>(
     CoreActions.BeforeInstanceStopped,