diff --git a/commitlint.config.cjs b/commitlint.config.cjs index ad940fcc..7fabea8a 100644 --- a/commitlint.config.cjs +++ b/commitlint.config.cjs @@ -12,6 +12,7 @@ module.exports = { 'pockethost', 'common', 'ga', + 'plugin-console-logger', ], ], 'scope-empty': [2, 'never'], diff --git a/packages/common/src/Logger.ts b/packages/common/src/Logger.ts index c30def6d..fc9766a0 100644 --- a/packages/common/src/Logger.ts +++ b/packages/common/src/Logger.ts @@ -4,6 +4,7 @@ import chalk from 'chalk' import stringify from 'json-stringify-safe' import { mergeConfig } from '../../pockethost/src/util/mergeConfig' import { mkSingleton } from './mkSingleton' +import { PocketHostAction, action } from './plugin' export type Config = { level: LogLevelName @@ -44,16 +45,6 @@ export const LEVEL_NAMES = [ LogLevelName.Abort, ] -export const LogLevelConsoleMap = { - [LogLevelName.Trace]: console.trace, - [LogLevelName.Raw]: console.log, - [LogLevelName.Debug]: console.debug, - [LogLevelName.Info]: console.info, - [LogLevelName.Warn]: console.warn, - [LogLevelName.Error]: console.error, - [LogLevelName.Abort]: console.error, -} as const - export const LogLevels = { [LogLevelName.Trace]: 0, [LogLevelName.Raw]: 1, @@ -85,32 +76,7 @@ export const createLogger = (config: Partial) => { .join(' ') const _log = (levelIn: LogLevelName, ...args: any[]) => { - if (isLevelGte(levelIn, _config.level)) { - const pfx = args.shift() - while (args.length > 0) { - let arg = args.shift() - const t = typeof arg - if (arg instanceof Error) { - args.unshift(...[arg.name, arg.message.toString()]) - if (isLevelLte(levelIn, LogLevelName.Debug) && arg.stack) { - args.unshift(...arg.stack.split(/\n/)) - } - continue - } - if (t === 'string' && !!arg.match(/\n/)) { - args.unshift(...arg.split(/\n/)) - continue - } - if (t === 'object') { - args.unshift(...stringify(arg, null, 2).split(/\n/)) - continue - } - if (t === 'function') { - arg = `<>` - } - LogLevelConsoleMap[levelIn](...[pfx, arg]) - } - } + action(PocketHostAction.Log, _config.level, levelIn, args) } const raw = (...args: any[]) => { diff --git a/packages/dashboard/package.json b/packages/dashboard/package.json index 4c342f2b..6826b9a4 100644 --- a/packages/dashboard/package.json +++ b/packages/dashboard/package.json @@ -14,6 +14,7 @@ "type": "module", "devDependencies": { "@microsoft/fetch-event-source": "https://github.com/pockethost/fetch-event-source.git#ebe3b7122647b48b93fd11effbbfb915d98956b0", + "@pockethost/common": "workspace:../common", "@s-libs/micro-dash": "^16.1.0", "@sveltejs/adapter-static": "^2.0.3", "@sveltejs/kit": "^1.25.2", @@ -37,7 +38,9 @@ "svelte-highlight": "^7.3.0", "svelte-preprocess": "^5.0.4", "tailwindcss": "^3.3.3", - "vite": "^4.4.9", - "@pockethost/common": "workspace:../common" + "vite": "^4.4.9" + }, + "dependencies": { + "@pockethost/plugin-console-logger": "link:../plugin-console-logger" } } diff --git a/packages/dashboard/src/util/stores.ts b/packages/dashboard/src/util/stores.ts index 0a6093b6..02cc75e8 100644 --- a/packages/dashboard/src/util/stores.ts +++ b/packages/dashboard/src/util/stores.ts @@ -2,15 +2,19 @@ import { client } from '$src/pocketbase-client' import { SubscriptionType, UserFields, + loadPlugins, type InstanceFields, type InstanceId, type UnsubscribeFunc, } from '@pockethost/common' +import consoleLogger from '@pockethost/plugin-console-logger' import { writable } from 'svelte/store' // TODO: Removing this will cause the app to crash // Theres a reference inside of `createPocketbaseClient.ts` that needs the information that comes from this file import '../services' +await loadPlugins([consoleLogger]) + const { onAuthChange } = client() export const isUserLegacy = writable(false) diff --git a/packages/plugin-console-logger/package.json b/packages/plugin-console-logger/package.json new file mode 100644 index 00000000..6921e654 --- /dev/null +++ b/packages/plugin-console-logger/package.json @@ -0,0 +1,16 @@ +{ + "name": "@pockethost/plugin-console-logger", + "version": "1.0.0", + "description": "", + "main": "src/index.ts", + "module": "src/index.ts", + "types": "src/index.ts", + "type": "module", + "scripts": {}, + "keywords": [], + "author": "", + "license": "ISC", + "dependencies": { + "@pockethost/common": "workspace:../common" + } +} diff --git a/packages/plugin-console-logger/src/index.ts b/packages/plugin-console-logger/src/index.ts new file mode 100644 index 00000000..4797d6eb --- /dev/null +++ b/packages/plugin-console-logger/src/index.ts @@ -0,0 +1,52 @@ +import { + LogLevelName, + PocketHostAction, + PocketHostPlugin, + isLevelGte, + isLevelLte, + stringify, +} from '@pockethost/common' + +export const LogLevelConsoleMap = { + [LogLevelName.Trace]: console.trace, + [LogLevelName.Raw]: console.log, + [LogLevelName.Debug]: console.debug, + [LogLevelName.Info]: console.info, + [LogLevelName.Warn]: console.warn, + [LogLevelName.Error]: console.error, + [LogLevelName.Abort]: console.error, +} as const + +const plugin: PocketHostPlugin = async ({ registerAction }) => { + registerAction(PocketHostAction.Log, (currentLevel, levelIn, args) => { + if (!isLevelGte(levelIn, currentLevel)) return + const finalArgs = [args.shift()] + while (args.length > 0) { + let arg = args.shift() + const t = typeof arg + if (arg instanceof Error) { + finalArgs.push(...[arg.name, arg.message.toString()]) + if (isLevelLte(levelIn, LogLevelName.Debug) && arg.stack) { + finalArgs.push(...arg.stack.split(/\n/)) + } + continue + } + if (t === 'string' && !!arg.match(/\n/)) { + finalArgs.push(...arg.split(/\n/)) + continue + } + if (t === 'object') { + finalArgs.push(...stringify(arg, undefined, 2).split(/\n/)) + continue + } + if (t === 'function') { + finalArgs.push(`<>`) + continue + } + finalArgs.push(arg) + } + LogLevelConsoleMap[levelIn](...finalArgs) + }) +} + +export default plugin diff --git a/packages/plugin-console-logger/tsconfig.json b/packages/plugin-console-logger/tsconfig.json new file mode 100644 index 00000000..bb2f7f66 --- /dev/null +++ b/packages/plugin-console-logger/tsconfig.json @@ -0,0 +1,109 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */, + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "commonjs" /* Specify what module code is generated. */, + // "rootDir": "./", /* Specify the root folder within your source files. */ + // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + // "outDir": "./", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */, + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */, + + /* Type Checking */ + "strict": true /* Enable all strict type-checking options. */, + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +} diff --git a/packages/pockethost/package.json b/packages/pockethost/package.json index bbb2ca45..12b3f24d 100644 --- a/packages/pockethost/package.json +++ b/packages/pockethost/package.json @@ -21,6 +21,7 @@ "dependencies": { "@dotenvx/dotenvx": "^0.44.1", "@pockethost/common": "workspace:../common", + "@pockethost/plugin-console-logger": "workspace:../plugin-console-logger", "@s-libs/micro-dash": "^16.1.0", "@types/node-os-utils": "^1.3.4", "@types/winston-syslog": "^2.4.3", diff --git a/packages/pockethost/src/cli/index.ts b/packages/pockethost/src/cli/index.ts index 67d9ac02..674639da 100644 --- a/packages/pockethost/src/cli/index.ts +++ b/packages/pockethost/src/cli/index.ts @@ -1,7 +1,7 @@ #!/usr/bin/env node -import { DEBUG, DefaultSettingsService, SETTINGS } from '$constants' -import { LogLevelName, LoggerService } from '@pockethost/common' +import { DEBUG, DefaultSettingsService, PH_PLUGINS, SETTINGS } from '$constants' +import { LogLevelName, LoggerService, loadPlugins } from '@pockethost/common' import { program } from 'commander' import EventSource from 'eventsource' import { EdgeCommand } from './commands/EdgeCommand' @@ -23,6 +23,7 @@ LoggerService({ level: DEBUG() ? LogLevelName.Debug : LogLevelName.Info }) global.EventSource = EventSource export const main = async () => { + await loadPlugins(PH_PLUGINS()) program.name('pockethost').description('Multitenant PocketBase hosting') program diff --git a/packages/pockethost/src/constants.ts b/packages/pockethost/src/constants.ts index 5b87c4c2..e05812d3 100644 --- a/packages/pockethost/src/constants.ts +++ b/packages/pockethost/src/constants.ts @@ -60,6 +60,7 @@ if (_IS_DEV) { } export const SETTINGS = { + PH_PLUGINS: mkCsvString([`@pockethost/plugin-console-logger`]), UPGRADE_MODE: mkBoolean(false), PH_HOME: mkPath(_PH_HOME), @@ -181,6 +182,7 @@ export const mothership = () => ioc.service('mothership') export const instanceLogger = () => ioc.service('instanceLogger') /** Accessors */ +export const PH_PLUGINS = () => settings().PH_PLUGINS export const UPGRADE_MODE = () => settings().UPGRADE_MODE export const PH_HOME = () => settings().PH_HOME diff --git a/packages/superadmin/package.json b/packages/superadmin/package.json index 7cac3c67..d1a4b358 100644 --- a/packages/superadmin/package.json +++ b/packages/superadmin/package.json @@ -14,6 +14,7 @@ "type": "module", "devDependencies": { "@microsoft/fetch-event-source": "https://github.com/pockethost/fetch-event-source.git#ebe3b7122647b48b93fd11effbbfb915d98956b0", + "@pockethost/common": "workspace:../common", "@s-libs/micro-dash": "^16.1.0", "@sveltejs/adapter-static": "^2.0.3", "@sveltejs/kit": "^1.25.2", @@ -37,7 +38,9 @@ "svelte-highlight": "^7.3.0", "svelte-preprocess": "^5.0.4", "tailwindcss": "^3.3.3", - "vite": "^4.4.9", - "@pockethost/common": "workspace:../common" + "vite": "^4.4.9" + }, + "dependencies": { + "@pockethost/plugin-console-logger": "link:../plugin-console-logger" } } diff --git a/packages/superadmin/src/util/stores.ts b/packages/superadmin/src/util/stores.ts index 1979b5e6..4e7f8516 100644 --- a/packages/superadmin/src/util/stores.ts +++ b/packages/superadmin/src/util/stores.ts @@ -1,10 +1,18 @@ import { client } from '$src/pocketbase-client' -import { type InstanceFields, type InstanceId } from '@pockethost/common' +import { + loadPlugins, + type InstanceFields, + type InstanceId, +} from '@pockethost/common' +import consoleLogger from '@pockethost/plugin-console-logger' import { writable } from 'svelte/store' + // TODO: Removing this will cause the app to crash // Theres a reference inside of `createPocketbaseClient.ts` that needs the information that comes from this file import '../services' +await loadPlugins([consoleLogger]) + const { onAuthChange } = client() export const isUserLoggedIn = writable(false) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 0ee77f56..98db7bc1 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -215,6 +215,10 @@ importers: version: 5.0.2 packages/dashboard: + dependencies: + '@pockethost/plugin-console-logger': + specifier: link:../plugin-console-logger + version: link:../plugin-console-logger devDependencies: '@microsoft/fetch-event-source': specifier: https://github.com/pockethost/fetch-event-source.git#ebe3b7122647b48b93fd11effbbfb915d98956b0 @@ -350,6 +354,12 @@ importers: specifier: ^3.0.3 version: 3.0.3 + packages/plugin-console-logger: + dependencies: + '@pockethost/common': + specifier: workspace:../common + version: link:../common + packages/pockethost: dependencies: '@dotenvx/dotenvx': @@ -358,6 +368,9 @@ importers: '@pockethost/common': specifier: workspace:../common version: link:../common + '@pockethost/plugin-console-logger': + specifier: workspace:../plugin-console-logger + version: link:../plugin-console-logger '@s-libs/micro-dash': specifier: ^16.1.0 version: 16.1.0 @@ -579,6 +592,10 @@ importers: packages/pockethost-instance: {} packages/superadmin: + dependencies: + '@pockethost/plugin-console-logger': + specifier: link:../plugin-console-logger + version: link:../plugin-console-logger devDependencies: '@microsoft/fetch-event-source': specifier: https://github.com/pockethost/fetch-event-source.git#ebe3b7122647b48b93fd11effbbfb915d98956b0