feat: use read-env-value #11

fengmk2 · 2025-05-16T10:15:55Z

Summary by CodeRabbit

New Features
- Introduced pre-commit hooks to enforce linting and formatting on staged files.
- Added configuration files for OXLint and Prettier to standardize code quality and style.
- Added a runtime dependency for safer environment variable handling.
Bug Fixes
- Improved error handling and type safety in log message processing.
Refactor
- Replaced ESLint with OXLint and switched from Egg.js test runner to Vitest.
- Modernized imports and assertion styles in tests.
- Updated code formatting and logging consistency throughout the codebase.
Chores
- Updated and added dependencies, including test and linting tools.
- Expanded Node.js version support in CI and improved workflow formatting.
- Updated README usage examples to use ES module syntax.
- Simplified TypeScript configuration.

coderabbitai · 2025-05-16T10:16:04Z

Walkthrough

This update introduces new linting and formatting tools, removes the existing ESLint setup, and transitions the codebase to use OXLint and Prettier for code quality and style enforcement. The testing framework is switched from Egg to Vitest, with updated scripts and dependencies. The pre-commit workflow is enhanced with Husky and lint-staged, and the documentation and code samples are modernized to use ES module syntax.

Changes

File(s)	Change Summary
`.eslintrc`	Removed ESLint configuration file, discontinuing TypeScript and node prefix linting rules.
`.oxlintrc.json`	Added OXLint configuration with strict rules, plugin integrations, and ignore patterns for Node.js/TypeScript.
`.prettierrc`, `.prettierignore`	Added Prettier configuration and ignore file to standardize formatting and exclude certain files.
`.husky/pre-commit`	Added pre-commit hook to run `npx lint-staged` for staged file linting and formatting.
`.github/workflows/nodejs.yml`, `.github/workflows/release.yml`	Reformatted branch arrays and updated Node.js versions tested in CI; no logic changes.
`package.json`	Added and updated dependencies, replaced ESLint with OXLint, switched from Egg to Vitest for testing, added Husky and lint-staged, updated scripts, and introduced lint-staged config.
`tsconfig.json`	Simplified to extend only from `@eggjs/tsconfig`, removing explicit compiler options.
`README.md`	Updated usage instructions and code samples from CommonJS `require` to ES module `import` syntax.
`src/exit.ts`, `src/index.ts`, `src/types.ts`	Reformatted code, improved type safety and error handling, clarified logging, and added linter suppression comments; no logic or API changes.
`test/fixtures/before-exit.cjs`, `test/fixtures/child.cjs`, `test/fixtures/cluster.cjs`	Reformatted server creation and logging for readability; no logic changes.
`test/fixtures/master-spawn.js`	Removed extra spaces in array argument formatting.
`test/index.test.ts`	Updated imports to named imports, switched assertions to `assert.ok`, added linter comments, and improved formatting; no test logic changes.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant Husky
    participant lint-staged
    participant OXLint
    participant Prettier

    Developer->>Husky: git commit
    Husky->>lint-staged: Run on staged files
    lint-staged->>Prettier: Format staged files
    lint-staged->>OXLint: Lint staged files
    Prettier-->>lint-staged: Formatting complete
    OXLint-->>lint-staged: Linting complete
    lint-staged-->>Husky: All checks passed
    Husky-->>Developer: Commit proceeds

Poem

In the burrow, code is neat,
With Prettier and OXLint, no defeat!
Husky hops before each commit,
Staging files, making sure they fit.
Vitest runs, the tests all pass—
This rabbit’s code is first in class!
🐇✨

✨ Finishing Touches

📝 Generate Docstrings

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.

❤️ Share

🪧 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.
- Explain this complex logic.
- 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. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
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 src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai 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.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

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.

Copilot

Pull Request Overview

This PR implements the "read-env-value" package to improve the parsing of environment variables and refactors test cases to utilize the new API from urllib. Key changes include updating environment variable extraction in src/index.ts, refactoring test assertions and import styles in test files, and several formatting and dependency version updates.

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
test/index.test.ts	Refactored import and assertions using request from urllib and adjusted test titles.
test/fixtures/cluster.cjs	Improved formatting for better readability.
test/fixtures/child.cjs	Enhanced formatting of the HTTP server creation.
test/fixtures/before-exit.cjs	Reformatted the HTTP server creation for consistency.
src/types.ts	Added oxlint disable comments for explicit any usage on logger methods.
src/index.ts	Updated timeout extraction using read-env-value and refined conditional logging.
src/exit.ts	Improved error handling in the exit function with clearer error message extraction.
package.json	Upgraded dependency versions and updated scripts.
.prettierrc, .prettierignore, .oxlintrc.json, .husky/pre-commit, .github/workflows/nodejs.yml	Added and updated configuration files for code formatting, linting, hooks, and CI workflows.
.eslintrc	Removed in favor of newer lint configurations.

Copilot · 2025-05-16T10:16:21Z

test/index.test.ts

    });

-    it('should don\'t print info log', async () => {
+    it("should don't print info log", async () => {


[nitpick] The test description 'should don't print info log' is grammatically awkward; consider using a more correct phrasing such as 'should not print info log'.

Suggested change

it("should don't print info log", async () => {

it("should not print info log", async () => {

socket-security · 2025-05-16T10:16:25Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Package	Supply Chain Security	Quality
husky@9.1.7
@vitest/coverage-v8@3.1.3
read-env-value@1.1.0
@eggjs/tsconfig@1.3.3 ⏵ 2.0.0	⁺¹	⁺³
fkill@7.2.1 ⏵ 9.0.0	⁺¹
vitest@3.1.3
oxlint@0.16.11
mm@3.4.0 ⏵ 4.0.2	⁺¹
prettier@3.5.3
@arethetypeswrong/cli@0.17.4 ⏵ 0.18.1
lint-staged@15.5.2

View full report

pkg-pr-new · 2025-05-16T10:16:29Z

Open in StackBlitz

npm i https://pkg.pr.new/node-modules/graceful-process@11

commit: f5caf16

codecov · 2025-05-16T10:23:23Z

Codecov Report

Attention: Patch coverage is 0% with 41 lines in your changes missing coverage. Please review.

Project coverage is 0.78%. Comparing base (8551bae) to head (f5caf16).
Report is 5 commits behind head on master.

Files with missing lines	Patch %	Lines
src/index.ts	0.00%	28 Missing ⚠️
src/exit.ts	0.00%	13 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #11       +/-   ##
==========================================
- Coverage   93.75%   0.78%   -92.97%     
==========================================
  Files           2       3        +1     
  Lines          96     127       +31     
  Branches       30       3       -27     
==========================================
- Hits           90       1       -89     
- Misses          6     124      +118     
- Partials        0       2        +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

coderabbitai

Actionable comments posted: 0

🔭 Outside diff range comments (1)

src/index.ts (1)
2-108: 💡 Verification agent
❓ Verification inconclusive

Add test coverage for new lines

The static analysis tools indicate that several changed lines are not covered by tests, including the environment variable reading, conditional logging blocks, and some error scenarios.

🏁 Script executed:
#!/bin/bash
# Check test coverage for the graceful module
grep -r "graceful(" --include="*.ts" --include="*.js" test/
Length of output: 61
Add unit tests for all new code paths in src/index.ts

Several of the conditionals and event-handlers added in this PR aren’t covered by existing tests. Please add tests to explicitly cover:

Reading and defaulting of GRACEFUL_TIMEOUT via env()

Logger level overrides when using a custom logger vs. console

Branches for logLevel === 'warn' and 'error'

sigterm: 'always' vs. default once SIGTERM handlers

The exit callback invoked with code 0 on SIGTERM

The process.once('exit') handler for both success (code 0) and error exit codes

Cluster mode disconnect logic under cluster.worker

Child‐process disconnect event path and the setImmediate error log

Covering these scenarios will ensure your graceful‐shutdown logic behaves as expected under all combinations of options.

🧰 Tools

🪛 GitHub Check: codecov/patch

[warning] 3-3: src/index.ts#L3
Added line #L3 was not covered by tests

[warning] 38-38: src/index.ts#L38
Added line #L38 was not covered by tests

[warning] 41-43: src/index.ts#L41-L43
Added lines #L41 - L43 were not covered by tests

[warning] 56-61: src/index.ts#L56-L61
Added lines #L56 - L61 were not covered by tests

[warning] 65-67: src/index.ts#L65-L67
Added lines #L65 - L67 were not covered by tests

[warning] 72-74: src/index.ts#L72-L74
Added lines #L72 - L74 were not covered by tests

[warning] 81-83: src/index.ts#L81-L83
Added lines #L81 - L83 were not covered by tests

[warning] 94-97: src/index.ts#L94-L97
Added lines #L94 - L97 were not covered by tests

[warning] 105-108: src/index.ts#L105-L108
Added lines #L105 - L108 were not covered by tests

♻️ Duplicate comments (1)

test/index.test.ts (1)
49-49: Improve grammatical correctness in test description.

The test description "should don't print info log" is grammatically awkward.
    it("should not print info log", async () => {

🧹 Nitpick comments (4)

src/types.ts (3)

4-5: Suppress no-explicit-any for warn method
The inline disable allows dynamic logger arguments but weakens type safety. Consider using unknown or a generic parameter instead of any for stronger typings.

6-7: Suppress no-explicit-any for info method
Same as above: the disable is necessary under the new lint rules, but you could use unknown or generics for improved type safety.

8-9: Suppress no-explicit-any for error method
Consistent with other methods, but worth considering a more precise type (e.g., unknown) or a generic to reduce reliance on any.
.oxlintrc.json (1)
99-100: Remove commented-out rule.

There's a commented rule on line 99 that duplicates the rule on line 92. This creates confusion about which rule should be applied.
-    // "unicorn/no-null": "error",
🧰 Tools

🪛 Biome (1.9.4)

[error] 100-100: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 100-100: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 100-100: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

[error] 100-100: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 90661bc and f5caf16.

📒 Files selected for processing (18)

.eslintrc (0 hunks)
.github/workflows/nodejs.yml (1 hunks)
.github/workflows/release.yml (1 hunks)
.husky/pre-commit (1 hunks)
.oxlintrc.json (1 hunks)
.prettierignore (1 hunks)
.prettierrc (1 hunks)
README.md (1 hunks)
package.json (1 hunks)
src/exit.ts (2 hunks)
src/index.ts (4 hunks)
src/types.ts (1 hunks)
test/fixtures/before-exit.cjs (1 hunks)
test/fixtures/child.cjs (1 hunks)
test/fixtures/cluster.cjs (2 hunks)
test/fixtures/master-spawn.js (1 hunks)
test/index.test.ts (11 hunks)
tsconfig.json (1 hunks)

💤 Files with no reviewable changes (1)

.eslintrc

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/exit.ts (1)

src/types.ts (2)

Logger (3-10)

BeforeExit (1-1)

🪛 GitHub Check: codecov/patch

src/exit.ts

[warning] 8-13: src/exit.ts#L8-L13
Added lines #L8 - L13 were not covered by tests

[warning] 15-18: src/exit.ts#L15-L18
Added lines #L15 - L18 were not covered by tests

[warning] 43-45: src/exit.ts#L43-L45
Added lines #L43 - L45 were not covered by tests

src/index.ts

[warning] 3-3: src/index.ts#L3
Added line #L3 was not covered by tests

[warning] 38-38: src/index.ts#L38
Added line #L38 was not covered by tests

[warning] 41-43: src/index.ts#L41-L43
Added lines #L41 - L43 were not covered by tests

[warning] 56-61: src/index.ts#L56-L61
Added lines #L56 - L61 were not covered by tests

[warning] 65-67: src/index.ts#L65-L67
Added lines #L65 - L67 were not covered by tests

[warning] 72-74: src/index.ts#L72-L74
Added lines #L72 - L74 were not covered by tests

[warning] 81-83: src/index.ts#L81-L83
Added lines #L81 - L83 were not covered by tests

[warning] 94-97: src/index.ts#L94-L97
Added lines #L94 - L97 were not covered by tests

[warning] 105-108: src/index.ts#L105-L108
Added lines #L105 - L108 were not covered by tests

🪛 Biome (1.9.4)

.oxlintrc.json

[error] 26-26: Expected a property but instead found '// eslint'.

Expected a property here.

(parse)

[error] 27-27: End of file expected