chore: unblock local development without paid/private credentials#1543
Open
ketanwani wants to merge 2 commits intoopengovsg:develop-v2from
Open
chore: unblock local development without paid/private credentials#1543ketanwani wants to merge 2 commits intoopengovsg:develop-v2from
ketanwani wants to merge 2 commits intoopengovsg:develop-v2from
Conversation
## Problem
The BullMQ Pro package (@taskforcesh/bullmq-pro) requires a paid licence
and a private registry token (NPM_TASKFORCESH_TOKEN). This blocks local
development for contributors who don't have access to the token.
## Solution
Introduce a compatibility shim at packages/backend/src/lib/bullmq-pro-compat.ts
that re-exports the free bullmq package using the same class and type names
as the Pro package. All Pro-only features that are not needed for local dev
are stubbed as no-ops.
## Architecture
```
Production (with @taskforcesh/bullmq-pro)
─────────────────────────────────────────
queues / workers / helpers
│
▼
@taskforcesh/bullmq-pro
├── QueuePro (group pause/resume, concurrency, rate-limit)
├── WorkerPro (rateLimitGroup, group-aware processing)
├── JobPro (attemptsStarted, group opts)
└── GroupStatus (Waiting / Paused / Running)
Local development (free bullmq + compat shim)
─────────────────────────────────────────────
queues / workers / helpers
│
▼ (same import path: @/lib/bullmq-pro-compat)
bullmq-pro-compat.ts
├── QueuePro extends Queue + stub group methods (no-op)
├── WorkerPro extends Worker + stub rateLimitGroup (no-op)
├── JobPro = Job + optional Pro fields
└── GroupStatus enum stub
│
▼
bullmq (free, MIT)
```
Stubbed Pro features (acceptable trade-offs for local dev):
- Group concurrency / rate-limit config silently ignored
- rateLimitGroup() is a no-op — RetriableErrors fall through to normal retry
- pauseGroup / resumeGroup / setGroupConcurrency are no-ops
- getGroupsByStatus() always returns []
## Files changed
- packages/backend/src/lib/bullmq-pro-compat.ts [NEW] compat shim
- packages/backend/package.json @taskforcesh/bullmq-pro → bullmq
- .npmrc remove private registry config
- packages/types/index.d.ts inline Pro types (no longer from Pro pkg)
- packages/backend/src/queues/* update imports → @/lib/bullmq-pro-compat
- packages/backend/src/workers/* update imports → @/lib/bullmq-pro-compat
- packages/backend/src/helpers/* update imports → @/lib/bullmq-pro-compat
- packages/backend/src/services/* update imports → @/lib/bullmq-pro-compat
- packages/backend/src/graphql/admin/* update imports → @/lib/bullmq-pro-compat
- packages/backend/src/helpers/package.json fix Windows-incompatible db script
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…r credentials
Prevents backend crash on startup when PAIR_ROME_* and LAUNCH_DARKLY_SDK_KEY
are set to placeholder values ('...') in .env during local development.
- instrumentation.ts: skip LangfuseSpanProcessor/NodeSDK init if any Pair
Rome key is missing or still a placeholder — tracing silently disabled
- launch-darkly.ts: skip LD client init if SDK key is missing or placeholder
— all flag evaluations return their fallback values; moved init() call
inside getClient() so the SDK is never contacted at module load time
Production behaviour is unchanged: real deployments never have '...' values.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR makes it possible to run Plumber locally without needing paid or private credentials that are unavailable to most contributors.
@taskforcesh/bullmq-prowith freebullmq+ compat shim — the Pro package requires a paid licence and a private registry token (NPM_TASKFORCESH_TOKEN). A drop-in shim atsrc/lib/bullmq-pro-compat.tsre-exports freebullmqclasses/types under the same names. Pro-only features (group concurrency, rate limiting, pause/resume) are stubbed as no-ops — acceptable for local dev.instrumentation.tsagainst placeholder Pair Rome credentials —LangfuseSpanProcessorcrashed at startup whenPAIR_ROME_*keys were set to.... Tracing is now skipped silently when keys are unconfigured.launch-darkly.tsagainst placeholder SDK key — the LD client crashed at startup with a...key. All flag evaluations now return their fallback values when unconfigured, andinit()was moved insidegetClient()so the SDK is never contacted at module load time.dbscript for Windows —DOTENV_CONFIG_PATH=.env knexis Unix-only syntax; replaced with justknexsincedotenv/configis already imported viaapp.ts.Production impact
None. All guards are keyed on the literal string
'...'which only appears in.envplaceholder files, never in real deployments.Test plan
npm run -w backend lintpassesnpm run -w backend test:unit— 1485 tests pass (2 pre-existing failures unrelated to these changes).envvalues without crashing🤖 Generated with Claude Code