fix: Add pgboss plugin to server initializers #653

kingston · 2025-09-07T21:40:28Z

Summary by CodeRabbit

New Features
- Integrates the pg-boss job queue plugin into the example backend server.
- Generator now auto-registers the pg-boss plugin in the server configuration.
Refactor
- Switched the pg-boss plugin to a named export without changing runtime behavior.
- Deferred queue initialization until first use to reduce side effects.
Chores
- Added Prettier ignore for pnpm-lock.yaml in example projects.
- Updated AI settings to specify the model used.

changeset-bot · 2025-09-07T21:40:33Z

⚠️ No Changeset found

Latest commit: d66f2d0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai · 2025-09-07T21:40:35Z

Walkthrough

Changes switch pg-boss plugin exports from default to named, add plugin registration to the example server, defer pg-boss initialization in services, and update the pg-boss code generator to inject the plugin into Fastify server config. Minor repository configs added/updated (.prettierignore entries; .claude settings).

Changes

Cohort / File(s)	Summary of Changes
PgBoss Plugin Export Refactor `examples/blog-with-auth/packages/backend/src/plugins/pg-boss.plugin.ts`, `plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/templates/src/plugins/pg-boss.plugin.ts`	Renamed internal callback to pgBossPluginCallback and shifted from default export to named export `pgBossPlugin` via fastifyPlugin wrapper.
PgBoss Service Init Deferral `examples/blog-with-auth/packages/backend/src/services/pg-boss.service.ts`, `plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/templates/src/services/pg-boss.service.ts`	Removed eager initialization call in createQueue; initialization now deferred until enqueue/work paths that access pg-boss.
Server Integration `examples/blog-with-auth/packages/backend/src/server.ts`	Imported and registered `pgBossPlugin` in the server bootstrap sequence.
Code Generator Update `plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/pg-boss.generator.ts`	Added `fastifyServerConfig` task to inject `pgBossPlugin` into Fastify server config using `tsCodeFragment` and `tsImportBuilder`.
Prettier Ignore Entries `examples/blog-with-auth/.prettierignore`, `examples/todo-with-auth0/.prettierignore`	Added `pnpm-lock.yaml` to Prettier ignore lists.
Tooling Config `.claude/settings.json`	Added top-level `model: "opusplan"`; adjusted JSON to include trailing comma after `permissions` block.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Dev as Developer
  participant Gen as PgBoss Generator
  participant Cfg as Fastify Server Config
  Note over Dev,Gen: Build-time generation
  Dev->>Gen: Run generator
  Gen->>Cfg: Inject plugin entry<br/>plugin: import { pgBossPlugin } from '.../pg-boss.plugin'
  Note right of Cfg: pgBossPlugin registered in config

sequenceDiagram
  autonumber
  participant App as Application
  participant S as Fastify Server
  participant P as pgBossPlugin
  participant SV as PgBoss Service
  Note over App,S: Runtime startup
  App->>S: buildServer()
  S->>P: register()
  P->>P: initialize pg-boss instance
  S-->>App: server ready

  Note over S,P: Shutdown
  App-->>S: close()
  S->>P: onClose()
  P->>P: stop pg-boss

  Note over SV: Queue usage paths
  App->>SV: createQueue()
  SV-->>App: returns queue (no init)
  App->>SV: enqueue/work
  SV->>P: getPgBoss() (requires initialized)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

fix: Export PgBossQueue class #647 — Also modifies pg-boss service code, touching initialization/visibility aspects similar to this PR’s pg-boss service and template changes.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch kingston/eng-842-add-pgboss-plugin-to-server-initializers

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

vercel · 2025-09-07T21:40:37Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
baseplate-project-builder-web	Ready	Preview	Comment	Sep 7, 2025 9:40pm

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

examples/blog-with-auth/packages/backend/src/server.ts (1)
14-14: Prefer tsconfig path alias over relative import.

Guidelines call for absolute '@src/' paths.
-import { pgBossPlugin } from './plugins/pg-boss.plugin.js';
+import { pgBossPlugin } from '@src/plugins/pg-boss.plugin.js';
plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/templates/src/plugins/pg-boss.plugin.ts (1)
11-19: Rename to pgBossPluginCallback is fine; consider re-enabling type-checking.

Template has "// @ts-nocheck" on Line 1; recommend removing to keep template type-safe.
-// @ts-nocheck

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 0770931 and d66f2d0.

⛔ Files ignored due to path filters (3)

examples/blog-with-auth/packages/backend/baseplate/generated/src/plugins/pg-boss.plugin.ts is excluded by !**/generated/**, !**/generated/**
examples/blog-with-auth/packages/backend/baseplate/generated/src/server.ts is excluded by !**/generated/**, !**/generated/**
examples/blog-with-auth/packages/backend/baseplate/generated/src/services/pg-boss.service.ts is excluded by !**/generated/**, !**/generated/**

📒 Files selected for processing (9)

.claude/settings.json (1 hunks)
examples/blog-with-auth/.prettierignore (1 hunks)
examples/blog-with-auth/packages/backend/src/plugins/pg-boss.plugin.ts (2 hunks)
examples/blog-with-auth/packages/backend/src/server.ts (2 hunks)
examples/blog-with-auth/packages/backend/src/services/pg-boss.service.ts (0 hunks)
examples/todo-with-auth0/.prettierignore (1 hunks)
plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/pg-boss.generator.ts (2 hunks)
plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/templates/src/plugins/pg-boss.plugin.ts (2 hunks)
plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/templates/src/services/pg-boss.service.ts (0 hunks)

💤 Files with no reviewable changes (2)

examples/blog-with-auth/packages/backend/src/services/pg-boss.service.ts
plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/templates/src/services/pg-boss.service.ts

🧰 Additional context used

📓 Path-based instructions (5)

**/*.{ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/code-style.mdc)

**/*.{ts,tsx}: TypeScript with strict type checking
Always include return types on top-level functions including React components (React.ReactElement)
Include absolute paths in import statements via tsconfig paths (@src/ is the alias for src/)
If a particular interface or type is not exported, change the file so it is exported

If an interface or type is needed publicly but is not exported, modify the TypeScript file so it is exported

Files:

examples/blog-with-auth/packages/backend/src/server.ts
plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/templates/src/plugins/pg-boss.plugin.ts
plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/pg-boss.generator.ts
examples/blog-with-auth/packages/backend/src/plugins/pg-boss.plugin.ts

**/*.{js,ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/code-style.mdc)

Node 16 module resolution - include file extensions in imports (.js)

Files:

examples/blog-with-auth/packages/backend/src/server.ts
plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/templates/src/plugins/pg-boss.plugin.ts
plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/pg-boss.generator.ts
examples/blog-with-auth/packages/backend/src/plugins/pg-boss.plugin.ts

**/*.{ts,tsx,js}

📄 CodeRabbit inference engine (.cursor/rules/code-style.mdc)

**/*.{ts,tsx,js}: Sort imports by group: external libs first, then local imports
Use camelCase for variables/functions, PascalCase for types/classes
Order functions such that functions are placed below the variables/functions they use
We use the prefer using nullish coalescing operator (??) ESLint rule instead of a logical or (||), as it is a safer operator
Use console.info/warn/error instead of console.log

Files:

examples/blog-with-auth/packages/backend/src/server.ts
plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/templates/src/plugins/pg-boss.plugin.ts
plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/pg-boss.generator.ts
examples/blog-with-auth/packages/backend/src/plugins/pg-boss.plugin.ts

**/*

📄 CodeRabbit inference engine (.cursor/rules/code-style.mdc)

Use kebab-case for file names

Files:

examples/blog-with-auth/packages/backend/src/server.ts
plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/templates/src/plugins/pg-boss.plugin.ts
plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/pg-boss.generator.ts
examples/blog-with-auth/packages/backend/src/plugins/pg-boss.plugin.ts

examples/blog-with-auth/packages/**/src/**/*.{ts,tsx}

📄 CodeRabbit inference engine (examples/blog-with-auth/CLAUDE.md)

examples/blog-with-auth/packages/**/src/**/*.{ts,tsx}: Always use .js extensions in import statements (even when importing from TypeScript files)
Use import type for type-only imports
Always specify explicit return types for all functions
Add JSDoc to all exported functions, interfaces, and classes (document parameters, return values, and fields)

Files:

examples/blog-with-auth/packages/backend/src/server.ts
examples/blog-with-auth/packages/backend/src/plugins/pg-boss.plugin.ts

🧠 Learnings (11)

📚 Learning: 2025-09-03T17:03:33.250Z

Learnt from: CR
PR: halfdomelabs/baseplate#0
File: examples/todo-with-auth0/CLAUDE.md:0-0
Timestamp: 2025-09-03T17:03:33.250Z
Learning: Applies to examples/todo-with-auth0/{package.json,packages/**/package.json} : Package manager is pnpm 10+ (enforce via `packageManager` field)

Applied to files:

examples/blog-with-auth/.prettierignore
examples/todo-with-auth0/.prettierignore

📚 Learning: 2025-09-03T17:03:33.250Z

Learnt from: CR
PR: halfdomelabs/baseplate#0
File: examples/todo-with-auth0/CLAUDE.md:0-0
Timestamp: 2025-09-03T17:03:33.250Z
Learning: Applies to examples/todo-with-auth0/**/pnpm-workspace.yaml : Use pnpm workspaces with packages located under `packages/`

Applied to files:

examples/blog-with-auth/.prettierignore
examples/todo-with-auth0/.prettierignore

📚 Learning: 2025-09-03T17:02:31.412Z

Learnt from: CR
PR: halfdomelabs/baseplate#0
File: examples/blog-with-auth/CLAUDE.md:0-0
Timestamp: 2025-09-03T17:02:31.412Z
Learning: Use pnpm 10+ and Node 20+ (Volta pinned)

Applied to files:

examples/blog-with-auth/.prettierignore
examples/todo-with-auth0/.prettierignore