WIP Switch from lockfile to proper-lockfile #517

alexeyr-ci · 2025-02-14T11:56:33Z

proper-lockfile has better API and some improvements.

Once CI passes:

need to check if it helps with locking errors in HiChee.
check with TEST_LOCKFILE_THREADING.

Summary by CodeRabbit

Chores
- Updated dependency packages to integrate a more reliable solution for managing resource locking.
Refactor
- Streamlined the internal resource locking process, improving error handling and operational stability.
Tests
- Modernized the testing approach to align with the new locking strategy, ensuring enhanced reliability.

coderabbitai · 2025-02-14T11:56:40Z

Walkthrough

This pull request updates the project's locking mechanism by replacing the legacy lockfile package with proper-lockfile throughout the codebase. The changes include updating dependencies in the package file, refactoring lock acquisition and release logic in shared modules, and revising the usage patterns in worker and request handler modules. Additionally, the tests have been modified to reflect the new promise-based locking approach. Error handling and configuration options for locks have been adjusted to provide a more robust and streamlined implementation.

Changes

File(s)	Change Summary
`package.json`	Removed `"lockfile": "^1.0.4"` and `"@types/lockfile": "^1.0.4"`; added `"proper-lockfile": "^4.1.2"` and `"@types/proper-lockfile": "^4.1.4"`.
`packages/node-renderer/src/shared/locks.ts`	Refactored locking logic: replaced legacy functions with `proper-lockfile`'s API; updated options structure and error handling; introduced an asynchronous `release` method in the lock result.
`packages/node-renderer/src/worker.ts` `packages/node-renderer/src/worker/handleRenderRequest.ts`	Removed the `unlock` import and usage; streamlined lock acquisition to use the new `lock` method and its `release` function; simplified conditional checks and error handling in the asset upload workflow.
`packages/node-renderer/tests/handleRenderRequest.test.ts`	Updated import from `lockfile` to `lockSync` from `proper-lockfile`; modified tests to accommodate promise-based unlocking and removed obsolete callback logic.

Sequence Diagram(s)

sequenceDiagram
    participant Worker as Worker Module
    participant Locks as Locks Module (proper-lockfile)
    participant Task as Asset Upload / Render Handler

    Worker->>Locks: Request lock for resource
    Locks-->>Worker: Return lockResult { wasLockAcquired, release() }
    Worker->>Task: Proceed with asset upload / rendering
    Task-->>Worker: Processing complete
    Worker->>Locks: Invoke release() to unlock resource
    Locks-->>Worker: Confirm resource unlocked

Poem

Oh, how I hop with glee in the code land bright,
For proper locks now hold our resources tight.
No more tangled callbacks to confuse my way,
Each release sings softly at the end of day.
I nibble on these changes with a joyful heart,
Celebrating clear paths where new locks play!
🐰✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between c808823 and 4235b0d.

⛔ Files ignored due to path filters (1)

yarn.lock is excluded by !**/yarn.lock, !**/*.lock

📒 Files selected for processing (5)

package.json (2 hunks)
packages/node-renderer/src/shared/locks.ts (1 hunks)
packages/node-renderer/src/worker.ts (3 hunks)
packages/node-renderer/src/worker/handleRenderRequest.ts (3 hunks)
packages/node-renderer/tests/handleRenderRequest.test.ts (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

package.json
packages/node-renderer/src/worker/handleRenderRequest.ts

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 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.
- Generate unit testing code for this file.
- 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 generate unit testing code for this file.
- @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 generate unit testing code.
- @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.

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. (Beta)
@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.

alexeyr-ci · 2025-02-14T12:00:24Z

packages/node-renderer/tests/handleRenderRequest.test.ts

-    // so make it use that instead of ctime.
-    // Probably you should never do this in production!
-    // @ts-expect-error Not allowed by the types
-    lockfile.filetime = 'mtime';


proper-lockfile already uses mtime. But this test fails...

alexeyr-ci · 2025-02-14T12:05:07Z

packages/node-renderer/src/worker.ts

    const taskDescription = `Uploading files ${assetsDescription} to ${bundlePath}`;
+    const lockfileName = 'transferring-assets';
+    // lock already catches errors internally, so it's safe to call without try/catch
+    const lockResult = await lock(lockfileName);


I could keep the call inside try/catch, but that complicates code unnecessarily.

alexeyr-ci · 2025-02-14T12:05:20Z

packages/node-renderer/src/worker/handleRenderRequest.ts

-  let lockAcquired = false;
-  let lockfileName: string | undefined;
+  // lock already catches errors internally, so it's safe to call without try/catch
+  const lockResult = await lock(bundleFilePathPerTimestamp);


Same as https://github.com/shakacode/react_on_rails_pro/pull/517/files#r1956042299.

alexeyr-ci · 2025-02-14T12:12:38Z

packages/node-renderer/tests/handleRenderRequest.test.ts


-    const lockfileOptions = { pollPeriod: 100, stale: 10000 };
-    lockfile.lockSync(lockfilePathForTest(), lockfileOptions);
+    const release = lockSync(


It was probably lockSync for simplicity, here we have a normal Promise-based API and can use lock instead. But it should wait until the other tests pass.

alexeyr-ci force-pushed the alexeyr/proper-lockfile branch from 9e31047 to c808823 Compare February 14, 2025 11:58

alexeyr-ci commented Feb 14, 2025

View reviewed changes

WIP Switch from lockfile to proper-lockfile

4235b0d

alexeyr-ci force-pushed the alexeyr/proper-lockfile branch from c808823 to 4235b0d Compare February 14, 2025 12:01

alexeyr-ci commented Feb 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

WIP Switch from lockfile to proper-lockfile #517

WIP Switch from lockfile to proper-lockfile #517

Uh oh!

alexeyr-ci commented Feb 14, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Feb 14, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

alexeyr-ci Feb 14, 2025

Uh oh!

alexeyr-ci Feb 14, 2025

Uh oh!

alexeyr-ci Feb 14, 2025

Uh oh!

alexeyr-ci Feb 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

WIP Switch from lockfile to proper-lockfile #517

Are you sure you want to change the base?

WIP Switch from lockfile to proper-lockfile #517

Uh oh!

Conversation

alexeyr-ci commented Feb 14, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

alexeyr-ci Feb 14, 2025

Choose a reason for hiding this comment

Uh oh!

alexeyr-ci Feb 14, 2025

Choose a reason for hiding this comment

Uh oh!

alexeyr-ci Feb 14, 2025

Choose a reason for hiding this comment

Uh oh!

alexeyr-ci Feb 14, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

alexeyr-ci commented Feb 14, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 14, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)