Skip to content

Conversation

@kingston
Copy link
Collaborator

@kingston kingston commented Sep 3, 2025

Summary by CodeRabbit

  • New Features
    • PgBossQueue is now publicly exportable, enabling direct imports in generated projects and example apps.
  • Chores
    • Added changeset entry to prepare a patch release for the queue plugin.

@changeset-bot
Copy link

changeset-bot bot commented Sep 3, 2025

🦋 Changeset detected

Latest commit: ad06128

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 18 packages
Name Type
@baseplate-dev/plugin-queue Patch
@baseplate-dev/project-builder-common Patch
@baseplate-dev/project-builder-cli Patch
@baseplate-dev/project-builder-test Patch
@baseplate-dev/create-project Patch
@baseplate-dev/code-morph Patch
@baseplate-dev/core-generators Patch
@baseplate-dev/fastify-generators Patch
@baseplate-dev/project-builder-lib Patch
@baseplate-dev/project-builder-server Patch
@baseplate-dev/project-builder-web Patch
@baseplate-dev/react-generators Patch
@baseplate-dev/sync Patch
@baseplate-dev/tools Patch
@baseplate-dev/ui-components Patch
@baseplate-dev/utils Patch
@baseplate-dev/plugin-auth Patch
@baseplate-dev/plugin-storage Patch

Not sure what this means? Click here to learn what changesets are.

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

@coderabbitai
Copy link

coderabbitai bot commented Sep 3, 2025

Walkthrough

Exports PgBossQueue from two service files and adds a changeset entry for a patch release of @baseplate-dev/plugin-queue. No behavior or control-flow changes; only visibility/export and release metadata updates.

Changes

Cohort / File(s) Summary of changes
Export PgBossQueue in services
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
Change class declaration from class PgBossQueue<T> to export class PgBossQueue<T> to make it importable externally; no logic changes.
Release metadata
.changeset/true-times-roll.md
Add changeset for a patch release of @baseplate-dev/plugin-queue describing tweaks to pg-boss implementation; no runtime code changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

✨ 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-840-make-sure-pgbossqueue-is-exported

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@vercel
Copy link

vercel bot commented Sep 3, 2025

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

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • 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 67dba69 and ad06128.

⛔ Files ignored due to path filters (1)
  • examples/blog-with-auth/packages/backend/baseplate/generated/src/services/pg-boss.service.ts is excluded by !**/generated/**, !**/generated/**
📒 Files selected for processing (3)
  • .changeset/true-times-roll.md (1 hunks)
  • examples/blog-with-auth/packages/backend/src/services/pg-boss.service.ts (1 hunks)
  • plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/templates/src/services/pg-boss.service.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
**/*.{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 a particular interface or type is not exported, update the TypeScript file so it is exported

Files:

  • 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
**/*.{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/services/pg-boss.service.ts
  • plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/templates/src/services/pg-boss.service.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/services/pg-boss.service.ts
  • plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/templates/src/services/pg-boss.service.ts
**/*

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

Use kebab-case for file names

Files:

  • 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
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/services/pg-boss.service.ts
.changeset/*.md

📄 CodeRabbit inference engine (CLAUDE.md)

When adding or changing a feature, add a Changeset in .changeset/ with frontmatter using 'package-name': patch and a description

Files:

  • .changeset/true-times-roll.md
🧠 Learnings (1)
📚 Learning: 2025-09-03T17:01:46.369Z
Learnt from: CR
PR: halfdomelabs/baseplate#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-03T17:01:46.369Z
Learning: Applies to .changeset/*.md : When adding or changing a feature, add a Changeset in `.changeset/` with frontmatter using `'package-name': patch` and a description

Applied to files:

  • .changeset/true-times-roll.md
🧬 Code graph analysis (2)
examples/blog-with-auth/packages/backend/src/services/pg-boss.service.ts (2)
plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/templates/src/services/pg-boss.service.ts (1)
  • PgBossQueue (166-291)
plugins/plugin-queue/src/queue/core/generators/queues/templates/src/types/queue.types.ts (1)
  • Queue (8-28)
plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/templates/src/services/pg-boss.service.ts (2)
examples/blog-with-auth/packages/backend/src/services/pg-boss.service.ts (1)
  • PgBossQueue (165-290)
plugins/plugin-queue/src/queue/core/generators/queues/templates/src/types/queue.types.ts (1)
  • Queue (8-28)
🪛 LanguageTool
.changeset/true-times-roll.md

[grammar] ~5-~5: Ensure spelling is correct
Context: ... patch --- Small tweaks to fix pg boss impelementation

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Lint
  • GitHub Check: Test E2E
  • GitHub Check: test
🔇 Additional comments (3)
.changeset/true-times-roll.md (1)

1-3: Changeset frontmatter looks correct.

Package name and patch bump are properly declared.

plugins/plugin-queue/src/pg-boss/core/generators/pg-boss/templates/src/services/pg-boss.service.ts (1)

166-166: Export added for PgBossQueue — LGTM.

This aligns the template with the intended public API.

examples/blog-with-auth/packages/backend/src/services/pg-boss.service.ts (1)

165-165: Export added for PgBossQueue — LGTM.

Makes the class available to consumers within the example app.

'@baseplate-dev/plugin-queue': patch
---

Small tweaks to fix pg boss impelementation
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix typo and clarify description.

Spelling: “impelementation” → “implementation”. Consider explicitly stating the export change.

Apply this diff:

-Small tweaks to fix pg boss impelementation
+Export PgBossQueue class to make it publicly available (pg-boss implementation).
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Small tweaks to fix pg boss impelementation
Export PgBossQueue class to make it publicly available (pg-boss implementation).
🧰 Tools
🪛 LanguageTool

[grammar] ~5-~5: Ensure spelling is correct
Context: ... patch --- Small tweaks to fix pg boss impelementation

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents
In .changeset/true-times-roll.md around line 5, fix the typo "impelementation"
to "implementation" and update the changelog sentence to explicitly state the
export change (e.g., mention which symbol or module export changed or was
added/removed). Ensure the line reads clearly and concisely, correcting spelling
and adding a short phrase like "and clarify export of <name>" or "now exports
<name>" to make the export change explicit.

@kingston kingston merged commit 18bea49 into main Sep 4, 2025
17 checks passed
@kingston kingston deleted the kingston/eng-840-make-sure-pgbossqueue-is-exported branch September 4, 2025 07:02
@github-actions github-actions bot mentioned this pull request Sep 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants