Conversation
Contributor
|
Warning Review limit reached
More reviews will be available in 27 minutes and 36 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (9)
📝 WalkthroughWalkthroughThis PR adds AES-256-GCM encrypted backup support with a new ChangesSecurity Hardening
Sequence Diagram(s)sequenceDiagram
rect rgba(173, 216, 230, 0.5)
note over CLI,disk: Encrypted Backup Creation
participant CLI as index.ts (--encrypt)
participant handleBackup
participant gzipSync
participant encryptBuffer
participant disk
CLI->>handleBackup: destination, {encrypt: true}
handleBackup->>gzipSync: compress SQLite export buffer
gzipSync-->>handleBackup: compressed bytes
handleBackup->>encryptBuffer: encrypt compressed bytes
encryptBuffer-->>handleBackup: iv+tag+ciphertext
handleBackup->>disk: openSync .db.enc (0o600, exclusive)
handleBackup->>disk: writeBackupHash → .sha256 sidecar
end
rect rgba(144, 238, 144, 0.5)
note over handleRestore,disk: Restore with Integrity Verification
participant handleRestore
participant verifyBackupHash
participant decryptBuffer
participant gunzipSync
handleRestore->>verifyBackupHash: check .sha256 sidecar
verifyBackupHash-->>handleRestore: match or mismatch
handleRestore->>user: warn + confirm if mismatch
handleRestore->>decryptBuffer: decrypt if isEncrypted
decryptBuffer-->>handleRestore: compressed or raw bytes
handleRestore->>gunzipSync: decompress if .gz or magic bytes
handleRestore->>disk: write restored DB encrypted (0o600)
end
Estimated code review effort🎯 5 (Critical) | ⏱️ ~120 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 10
🧹 Nitpick comments (2)
subtrack/src/crypto.ts (1)
77-85: ⚡ Quick winAdd minimum length validation before slicing ciphertext.
If
ciphertextis shorter thanIV_LENGTH + TAG_LENGTH(32 bytes), thesubarraycalls will produce empty or incomplete buffers, leading to cryptic errors from the crypto module. A guard would provide a clearer error message.🛡️ Suggested validation
export function decryptBuffer(ciphertext: Buffer): Buffer { + const minLength = IV_LENGTH + TAG_LENGTH + if (ciphertext.length < minLength) { + throw new Error(`Ciphertext too short: expected at least ${minLength} bytes`) + } const key = getOrCreateKey() const iv = ciphertext.subarray(0, IV_LENGTH)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@subtrack/src/crypto.ts` around lines 77 - 85, The decryptBuffer function does not validate that the ciphertext parameter has the minimum required length before slicing it with subarray calls. If ciphertext is shorter than IV_LENGTH + TAG_LENGTH (32 bytes), the subarray operations will produce empty or incomplete buffers, leading to cryptic errors from the crypto module. Add a guard clause at the beginning of the decryptBuffer function that checks if ciphertext.length is less than the required minimum (IV_LENGTH + TAG_LENGTH) and throws an Error with a clear descriptive message indicating the minimum required length before proceeding with the iv, tag, and data subarray operations.subtrack/src/commands.ts (1)
7-8: Remove unused import:gunzipSyncis imported but not used in this file.
gunzipSyncis imported fromnode:zlibbut onlygzipSyncis used incommands.ts(lines 238, 405). Decompression happens indb.ts'srestoreDbfunction.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@subtrack/src/commands.ts` around lines 7 - 8, Remove the unused import `gunzipSync` from the import statement at the top of the file where you import from "node:zlib". Keep only `gzipSync` in that import since it is the only function from that module that is actually used in commands.ts (gzipSync is used in the compression operations on lines 238 and 405). The decompression operation using gunzipSync occurs in a different file (db.ts) in the restoreDb function.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/release.yml:
- Around line 58-60: The "Audit dependencies" step is currently missing a
working-directory specification, causing it to audit the root lockfile instead
of the ./subtrack package. Add working-directory: ./subtrack to the audit step
to match the configuration of the other steps in this workflow (install, build,
shrinkwrap, publish) and ensure the audit correctly targets the subtrack package
being published.
- Around line 52-57: The workflow currently uses pnpm install --frozen-lockfile
to install dependencies during build and test, but then generates the
npm-shrinkwrap.json using npm install --package-lock-only, which can produce
different dependency resolution results. To fix this, either generate the
shrinkwrap directly from pnpm's lockfile instead of running npm install
--package-lock-only, or alternatively switch the entire workflow to use npm
consistently throughout for building, testing, and generating the shrinkwrap to
ensure the reproducibility guarantee is met with a single package manager's
resolution algorithm.
In `@subtrack/src/commands.test.ts`:
- Around line 375-396: The test "handleExport escapes CSV injection vectors in
name" is missing a test case for the tab character prefix that the production
regex includes as a dangerous CSV injection vector. Add a new writeSubscription
call with a name starting with a tab character (such as "\tTab"), and add
corresponding expect statements to verify that this tab-prefixed name is also
safely escaped with a backslash prefix in the output, consistent with how the
other dangerous prefixes (=, +, -, @) are being tested.
In `@subtrack/src/crypto.test.ts`:
- Around line 72-82: The test "key file is created with restricted permissions
(0o600)" is failing on Windows because Unix-style file permissions are not
enforced the same way on Windows systems. Skip this test when running on Windows
by checking if process.platform is "win32" at the start of the test function,
and either return early or use a conditional skip mechanism to prevent the test
from running on that platform. The rest of the test logic remains the same.
In `@subtrack/src/db.ts`:
- Around line 56-97: In the acquireLock function, when the EEXIST error is
caught (indicating another instance already holds the lock), the code currently
logs a warning but allows execution to continue, enabling concurrent access.
Replace the warning behavior with either throwing an error or calling
process.exit() to prevent the application from continuing when a lock already
exists. This ensures only one subtrack instance can run at a time and prevents
database corruption from concurrent access.
In `@subtrack/src/export.ts`:
- Around line 35-38: The escapeMdCell function currently escapes pipe characters
and newlines but does not handle carriage return characters, which can still
disrupt Markdown table formatting when processing CRLF-originated content.
Update the replace chain in escapeMdCell to also escape carriage return
characters (\r) to spaces, alongside the existing newline character handling,
ensuring both \r and \n are normalized in the same pass.
In `@subtrack/src/fx.ts`:
- Line 8: The exported function fetchFxRates is missing JSDoc documentation. Add
a JSDoc comment block above the fetchFxRates function declaration that documents
the function's purpose, return type, and any parameters. The JSDoc should
clearly describe what the function does, what it returns (Promise<FxRates>), and
provide relevant details for developers using this public API.
- Around line 12-20: Replace the `return res.json() as Promise<FxRates>`
statement in the fetchFxRates function with `return await
safeResponseJson<FxRates>(res)` to ensure response body parsing is awaited and
completes within the timeout window before the finally block clears the timer.
Additionally, add JSDoc documentation to the exported fetchFxRates function that
describes its purpose, parameters, and return type to meet public API
documentation standards.
In `@subtrack/src/import-csv.ts`:
- Around line 56-64: The statSync and readFileSync operations in the import-csv
file are not protected with error handling, which can cause the import command
to crash if file permissions are denied or if a race condition occurs during
file access. Wrap both the statSync(file) call and the readFileSync(file,
"utf-8") call in a try-catch block that catches any thrown errors and uses
consola.error to log the error message before returning, ensuring a controlled
CLI error response instead of an abrupt failure.
In `@subtrack/src/index.ts`:
- Around line 272-283: The signal handlers registered in db.ts during module
initialization (at lines 96-97) execute before the handleSignal function defined
here and call process.exit(0) before the saveDb() call in this file can run. To
fix this, either modify the signal handlers in db.ts to call saveDb() before
releaseLock() and process.exit(0), or consolidate all signal handling logic into
a single location in index.ts after CLI setup completes, removing the duplicate
handler registrations from db.ts. This ensures saveDb() is guaranteed to execute
during shutdown before the process terminates.
---
Nitpick comments:
In `@subtrack/src/commands.ts`:
- Around line 7-8: Remove the unused import `gunzipSync` from the import
statement at the top of the file where you import from "node:zlib". Keep only
`gzipSync` in that import since it is the only function from that module that is
actually used in commands.ts (gzipSync is used in the compression operations on
lines 238 and 405). The decompression operation using gunzipSync occurs in a
different file (db.ts) in the restoreDb function.
In `@subtrack/src/crypto.ts`:
- Around line 77-85: The decryptBuffer function does not validate that the
ciphertext parameter has the minimum required length before slicing it with
subarray calls. If ciphertext is shorter than IV_LENGTH + TAG_LENGTH (32 bytes),
the subarray operations will produce empty or incomplete buffers, leading to
cryptic errors from the crypto module. Add a guard clause at the beginning of
the decryptBuffer function that checks if ciphertext.length is less than the
required minimum (IV_LENGTH + TAG_LENGTH) and throws an Error with a clear
descriptive message indicating the minimum required length before proceeding
with the iv, tag, and data subarray operations.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c1e2e70f-d3e2-4e25-93f2-c0271c91de37
📒 Files selected for processing (15)
.github/workflows/release.ymlsubtrack/package.jsonsubtrack/src/commands.test.tssubtrack/src/commands.tssubtrack/src/crypto.test.tssubtrack/src/crypto.tssubtrack/src/db.test.tssubtrack/src/db.tssubtrack/src/export.tssubtrack/src/fx.tssubtrack/src/import-csv.tssubtrack/src/index.tssubtrack/src/pricing.tssubtrack/src/prompts.tssubtrack/src/safe-json.ts
This was referenced Jun 22, 2026
Merged
This was referenced Jul 2, 2026
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
Comprehensive security hardening for subtrack across all risk categories.
Data-at-Rest (P1)
crypto.ts. Auto-generates key on first use (0o600). SupportsSUBSC_CLI_DB_PASSPHRASEfor passphrase-based key derivation via scrypt..sha256) with verification on restore.Network (P1)
safe-json.tsstrips__proto__,constructor,prototypefrom parsed JSON.Input Validation (P2)
=,+,-,@with\tin CSV export.String(e)instead ofeor template literal).Concurrency & Integrity (P1-3, P2-2, P2-6)
.subtrack.lockwith PID) prevents concurrent instances.Supply Chain
npm-shrinkwrap.jsonfor reproducible installs. Usesnpm publishfor provenance attestation.lint:securityrunspnpm audit --audit-level=high.Signal Handling (P1-2)
index.tscallsaveDb()before exit.Directory Validation (P3-1)
SUBSC_CLI_DB_DIRrejects system directories (/,/etc,/dev,/proc,/sys,/tmp).Testing
__setDbbypasses file I/O changes)Closes: subtrack-commit
Summary by CodeRabbit
New Features
--encryptoptionSecurity & Improvements