Streamline logging

.changeset/hip-years-bake.md

@@ -0,0 +1,16 @@
+---
+"zemble-plugin-auth-otp": patch
+"zemble-plugin-auth": patch
+"zemble-plugin-cms-users": patch
+"zemble-plugin-cms": patch
+"@zemble/core": patch
+"create-zemble-app": patch
+"create-zemble-plugin": patch
+"@zemble/graphql": patch
+"zemble-plugin-kv": patch
+"zemble-plugin-logger-graphql": patch
+"minimal": patch
+"supplement-stack": patch
+---
+
+Streamline logging

.eslintrc

@@ -3,7 +3,7 @@
       "eslint-config-kingstinct/react-native"
   ],
   "rules": {
-      "no-console": 1,
+      "no-console": 2,
       "@typescript-eslint/sort-type-union-intersection-members": 0,
       "@typescript-eslint/no-unused-vars": 1,
       "import/no-unresolved": 0,

.github/workflows/test.yml

@@ -13,17 +13,14 @@ on:
       bun-version:
         description: 'Bun Version'
         required: false
-        default: 'latest'
         type: string
       os:
         description: 'Operating System'
         required: false
-        default: 'ubuntu-latest'
         type: string
       mongo-version:
         description: 'MongoDB Version'
         required: false
-        default: '7.0.4'
         type: string
   workflow_dispatch:
     inputs:
@@ -53,16 +50,18 @@ on:
       - "**" # matches every branch
       - "!main" # excludes the master branch
 
+env:
+  BUN_VERSION: ${{ inputs.bun-version || 'latest' }}
+  MONGOMS_PREFER_GLOBAL_PATH: true
+  MONGOMS_VERSION: ${{ inputs.mongo-version || '7.0.4' }}
+  RUNS_ON: ${{ inputs.os || 'ubuntu-latest' }}
+
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
   test:
     # The type of runner that the job will run on
     runs-on: ${{ inputs.os || 'ubuntu-latest' }}
     timeout-minutes: 10
-    env:
-      MONGOMS_PREFER_GLOBAL_PATH: true
-      MONGOMS_VERSION: ${{ inputs.mongo-version || '7.0.4' }}
-      BUN_VERSION: ${{ inputs.bun-version || 'latest' }}
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
@@ -73,7 +72,7 @@ jobs:
         id: cache-mongodb-binaries
         name: Cache MongoDB binaries
         with:
-          key: ${{ runner.os }}-mongodb-${{ inputs.bun-version }}-${{ env.MONGOMS_VERSION }}
+          key: ${{ runner.os }}-mongodb-${{ env.BUN_VERSION }}-${{ env.MONGOMS_VERSION }}
           path: ~/.cache/mongodb-binaries
 
       - uses: oven-sh/setup-bun@v1
@@ -94,9 +93,6 @@ jobs:
     env:
       SUPABASE_ACCESS_TOKEN: ${{ secrets.SUPABASE_ACCESS_TOKEN }}
       PROJECT_ID: ${{ secrets.SUPABASE_PROJECT_ID }}
-      MONGOMS_PREFER_GLOBAL_PATH: true
-      MONGOMS_VERSION: ${{ inputs.mongo-version || '7.0.4' }}
-      BUN_VERSION: ${{ inputs.bun-version || 'latest' }}
     timeout-minutes: 10
     # disable for now - since it for some reason fails on CI
     if: false 
@@ -110,7 +106,7 @@ jobs:
         id: cache-mongodb-binaries
         name: Cache MongoDB binaries
         with:
-          key: ${{ runner.os }}-mongodb-${{ inputs.bun-version }}-${{ env.MONGOMS_VERSION }}
+          key: ${{ runner.os }}-mongodb-${{ env.BUN_VERSION }}-${{ env.MONGOMS_VERSION }}
           path: ~/.cache/mongodb-binaries
 
       - uses: oven-sh/setup-bun@v1
@@ -125,15 +121,14 @@ jobs:
         working-directory: ./packages/supabase/supabase-app
 
       - name: Test
-        run: bun run codegen && bun test
+        run: bun test
         working-directory: ./packages/supabase
 
   typecheck:
     runs-on: ${{ inputs.os || 'ubuntu-latest' }}
     timeout-minutes: 10
     env:
       MONGOMS_DISABLE_POSTINSTALL: true
-      BUN_VERSION: ${{ inputs.bun-version || 'latest' }}
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
@@ -156,7 +151,6 @@ jobs:
     timeout-minutes: 10
     env:
       MONGOMS_DISABLE_POSTINSTALL: true
-      BUN_VERSION: ${{ inputs.bun-version || 'latest' }}
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
@@ -179,7 +173,6 @@ jobs:
     timeout-minutes: 10
     env:
       MONGOMS_DISABLE_POSTINSTALL: true
-      BUN_VERSION: ${{ inputs.bun-version || 'latest' }}
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:

apps/minimal/app.ts

@@ -2,13 +2,17 @@ import { createApp } from '@zemble/core'
 import GraphQL from '@zemble/graphql'
 import Migrations from '@zemble/migrations'
 import dryrunAdapter from '@zemble/migrations/adapters/dryrun'
+import Logger from '@zemble/pino'
 import Routes from '@zemble/routes'
+import GraphQLLogger from 'zemble-plugin-logger-graphql'
 
 import MyRoutes from './plugins/files/plugin'
 
 export default createApp({
   plugins: [
     Routes.configure(),
+    Logger.configure(),
+    GraphQLLogger,
     GraphQL.configure({ }),
     MyRoutes.configure(),
     Migrations.configure({

apps/minimal/graphql/Subscription/randomNumber.ts

@@ -2,14 +2,11 @@ import type { SubscriptionResolvers } from '../schema.generated'
 
 const randomNumber: SubscriptionResolvers['randomNumber'] = {
   // subscribe to the randomNumber event
-  subscribe: (_, __, { pubsub }) => {
-    console.log('subscribing to randomNumber')
+  subscribe: (_, __, { pubsub, logger }) => {
+    logger.info('subscribing to randomNumber')
     return pubsub.subscribe('randomNumber')
   },
-  resolve: (payload: number) => {
-    console.log('resolving randomNumber', payload)
-    return payload
-  },
+  resolve: (payload: number) => payload,
 }
 
 export default randomNumber

apps/minimal/graphql/Subscription/tick.ts

@@ -11,9 +11,9 @@ const initializeOnce = (pubsub: Zemble.PubSubType) => {
 
 const tick: SubscriptionResolvers['tick'] = {
   // subscribe to the tick event
-  subscribe: (_, __, { pubsub }) => {
+  subscribe: (_, __, { pubsub, logger }) => {
     initializeOnce(pubsub)
-    console.log('subscribing to tick')
+    logger.info('subscribing to tick')
     return pubsub.subscribe('tick')
   },
   resolve: (payload: number) => payload,

apps/minimal/package.json

@@ -41,7 +41,9 @@
     "@zemble/migrations": "workspace:*",
     "@zemble/bun": "workspace:*",
     "zemble-plugin-auth": "workspace:*",
-    "@zemble/routes": "workspace:*"
+    "@zemble/routes": "workspace:*",
+    "@zemble/pino": "workspace:*",
+    "zemble-plugin-logger-graphql": "workspace:*"
   },
   "devDependencies": {
     "@tsconfig/node20": "^20.1.2",

apps/supplement-stack/app.ts

@@ -1,4 +1,5 @@
 import bunRunner from '@zemble/bun'
+import zembleContext from '@zemble/core/zembleContext'
 import YogaGraphQL from '@zemble/graphql'
 import AuthOTP from 'zemble-plugin-auth-otp'
 
@@ -49,4 +50,4 @@ void bunRunner({
   ],
 })
 
-void connect()
+void connect({ logger: zembleContext.logger })

apps/supplement-stack/clients/papr.ts

@@ -1,30 +1,31 @@
-import zembleContext from '@zemble/core/zembleContext'
 import { MongoClient } from 'mongodb'
 import Papr from 'papr'
 
+import type { IStandardLogger } from '@zemble/core'
+
 // eslint-disable-next-line import/no-mutable-exports
 export let client: MongoClient | undefined
 
 const papr = new Papr()
 
-export async function connect() {
+export async function connect({ logger }: {readonly logger: IStandardLogger}) {
   const mongoUrl = process.env.MONGO_URL
 
   if (!mongoUrl) throw new Error('MONGO_URL not set')
 
-  zembleContext.logger.log('Connecting to MongoDB...', mongoUrl)
+  logger.info('Connecting to MongoDB...', mongoUrl)
 
   client = await MongoClient.connect(mongoUrl)
 
-  zembleContext.logger.log('Connected to MongoDB!')
+  logger.info('Connected to MongoDB!')
 
   const db = client.db()
 
   papr.initialize(db)
 
-  zembleContext.logger.log(`Registering ${papr.models.size} models...`)
+  logger.info(`Registering ${papr.models.size} models...`)
   papr.models.forEach((model) => {
-    zembleContext.logger.log(`Registering model: ${model.collection.collectionName}`)
+    logger.info(`Registering model: ${model.collection.collectionName}`)
   })
 
   await papr.updateSchemas()

apps/supplement-stack/graphql/Mutation/addIngredient.ts

@@ -10,7 +10,7 @@ import type { WithoutId } from 'mongodb'
 
 const addIngredient: MutationResolvers['addIngredient'] = async (parent, {
   title, imageUrls, nutrientsPer100g, servingSizes, ingredientId,
-}) => {
+}, { logger }) => {
   const _id = ingredientId ? new ObjectId(ingredientId) : new ObjectId()
   const ingredient: WithoutId<typeof Ingredient> = {
     __typename: 'Ingredient',
@@ -23,7 +23,7 @@ const addIngredient: MutationResolvers['addIngredient'] = async (parent, {
     })) ?? [],
   }
 
-  console.log(ingredient)
+  logger.info(ingredient)
 
   const eatable = await Eatables.findOneAndUpdate({ _id }, {
     $set: ingredient,

apps/todo-app-with-auth-backend/queues/hello-world.ts

@@ -1,5 +1,5 @@
 import { ZembleQueue } from 'zemble-plugin-bull'
 
-export default new ZembleQueue((job) => {
-  console.log(job.data)
+export default new ZembleQueue((job, { logger }) => {
+  logger.info(job.data)
 })

build.ts

@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 import { readdirSync, statSync } from 'node:fs'
 import { join } from 'node:path'
 

package.json

@@ -13,7 +13,7 @@
     "postinstall": "cp manual-patches/sofa-api/package.json node_modules/sofa-api/",
     "pre-push": "bunx turbo run lint test typecheck --continue",
     "generate-cms-json-schema": "typescript-json-schema ./packages/cms/tsconfig.json CmsConfigFile --include ./packages/cms/types.ts --out ./packages/cms/entities-json-schema.json --required --strictNullChecks --rejectDateType",
-    "fix-workspace-dependencies": "find . -type f -name 'package.json' -not -path './package.json' -not -path '*/node_modules/*' -exec perl -pi -e 's/\"workspace:[^\"]*\"/\"*\"/g' {} \\;",
+    "fix-workspace-dependencies": "find . -type f -name 'package.json' -not -path './package.json' -not -path '*/node_modules/*' -exec perl -pi -e 's/\"workspace:.*\"/\"*\"/g' {} \\;",
     "changeset-release": "bun run fix-workspace-dependencies && bunx changeset publish",
     "create-changeset": "bunx changeset && bunx changeset version",
     "reinstall": "rm -rf node_modules/ && find . -name 'node_modules' -type d -prune -exec rm -rf '{}' + && bun install --force",
@@ -76,6 +76,7 @@
     "eslint-plugin-yml": "^1.11.0",
     "husky": "^8.0.3",
     "lint-staged": "^15.2.0",
+    "pino-pretty": "^10.3.1",
     "turbo": "^1.11.2",
     "typescript-json-schema": "^0.62.0"
   },

packages/auth-otp/plugin.ts

@@ -79,7 +79,7 @@ const defaultConfig = {
         to,
       })
     } else {
-      logger.log(`handleAuthRequest for ${to.email}`, twoFactorCode)
+      logger.info(`handleAuthRequest for ${to.email}`, twoFactorCode)
     }
   },
 } satisfies Partial<OtpAuthConfig>
@@ -95,7 +95,7 @@ const plugin = new Plugin<OtpAuthConfig, typeof defaultConfig>(import.meta.dir,
   ],
   defaultConfig,
   devConfig: {
-    handleAuthRequest: ({ email }, code, { logger }) => { logger.log(`handleAuthRequest for ${email}`, code) },
+    handleAuthRequest: ({ email }, code, { logger }) => { logger.info(`handleAuthRequest for ${email}`, code) },
     generateTokenContents,
     from: { email: 'noreply@zemble.com' },
   },

packages/auth/bin/generate-keys.ts

@@ -1,4 +1,5 @@
 #!/usr/bin/env bun
+import zembleContext from '@zemble/core/zembleContext'
 import * as fs from 'node:fs/promises'
 import * as path from 'node:path'
 
@@ -15,8 +16,8 @@ await generateKeys().then(async ({ publicKey, privateKey }) => {
 
   if (!data.includes('PUBLIC_KEY') && !data.includes('PRIVATE_KEY')) {
     await fs.appendFile(envPath, `\nPUBLIC_KEY='${publicKey.trim()}'\nPRIVATE_KEY='${privateKey.trim()}'`)
-    console.log('PUBLIC_KEY and PRIVATE_KEY was appended to your local .env file!')
+    zembleContext.logger.info('PUBLIC_KEY and PRIVATE_KEY was appended to your local .env file!')
   } else {
-    console.log('The "PUBLIC_KEY" and/or "PRIVATE_KEY" already exists in .env file, will not overwrite!')
+    zembleContext.logger.info('The "PUBLIC_KEY" and/or "PRIVATE_KEY" already exists in .env file, will not overwrite!')
   }
 })

packages/bull/ZembleQueueBull.ts

@@ -1,5 +1,6 @@
 import { Queue, Worker } from 'bullmq'
 
+import type { IStandardLogger } from '@zemble/core'
 import type {
   Job, JobsOptions, QueueOptions, RedisOptions, RepeatOptions,
 } from 'bullmq'
@@ -20,13 +21,19 @@ export type ZembleQueueConfig = {
   readonly defaultJobOptions?: JobsOptions
 }
 
+export type ZembleJobOpts = {
+  readonly logger: IStandardLogger
+}
+
+export type ZembleWorker<DataType = unknown, ReturnType = unknown> = (job: Job<DataType, ReturnType>, opts: ZembleJobOpts) => Promise<void> | void
+
 export class ZembleQueueBull<DataType = unknown, ReturnType = unknown> {
-  readonly #worker: (job: Job<DataType, ReturnType>) => Promise<void> | void
+  readonly #worker: ZembleWorker<DataType, ReturnType>
 
   readonly #config?: ZembleQueueConfig
 
   constructor(
-    readonly worker: (job: Job<DataType, ReturnType>) => Promise<void> | void,
+    readonly worker: ZembleWorker<DataType, ReturnType>,
     config?: ZembleQueueConfig,
   ) {
     this.#worker = worker

packages/bull/ZembleQueueMock.ts

@@ -1,7 +1,9 @@
 /* eslint-disable functional/immutable-data */
 /* eslint-disable functional/prefer-readonly-type */
 
-import type { ZembleQueueBull, ZembleQueueConfig } from './ZembleQueueBull'
+import zembleContext from '@zemble/core/zembleContext'
+
+import type { ZembleQueueBull, ZembleQueueConfig, ZembleWorker } from './ZembleQueueBull'
 import type {
   Job, JobsOptions, Queue,
 } from 'bullmq'
@@ -13,14 +15,14 @@ interface IZembleQueue<DataType = unknown, ReturnType = unknown> {
 
 class ZembleQueueMock<DataType = unknown, ReturnType = unknown> implements IZembleQueue<DataType, ReturnType> {
   constructor(
-    readonly worker: (job: Job<DataType, ReturnType>) => Promise<void> | void,
+    readonly worker: ZembleWorker,
     config?: ZembleQueueConfig,
   ) {
     this.#worker = worker
     this.#config = config
   }
 
-  readonly #worker: (job: Job<DataType, ReturnType>) => Promise<void> | void
+  readonly #worker: ZembleWorker
 
   readonly #config?: ZembleQueueConfig
 
@@ -39,7 +41,7 @@ class ZembleQueueMock<DataType = unknown, ReturnType = unknown> implements IZemb
       await prev
       await new Promise((resolve) => {
         setTimeout(() => {
-          void this.#worker(job)
+          void this.#worker(job, { logger: zembleContext.logger })
           resolve(undefined)
         }, 0)
       })
@@ -71,7 +73,7 @@ class ZembleQueueMock<DataType = unknown, ReturnType = unknown> implements IZemb
 
   async add(name: string, data: DataType, opts?: JobsOptions | undefined): Promise<Job<DataType, ReturnType, string>> {
     const job = this.#createMockJob(name, data, opts)
-    setTimeout(async () => this.#worker(job), 0)
+    setTimeout(async () => this.#worker(job, { logger: zembleContext.logger }), 0)
     return job
   }
 }