Skip to content

Drop Node 18 support #1927

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

flevi29
Copy link
Collaborator

@flevi29 flevi29 commented Apr 22, 2025

Pull Request

What does this PR do?

Token generation and aborting requests might stop working for Node.js 18 users.

Summary by CodeRabbit

  • Chores
    • Updated Node.js version support to require a minimum of Node.js 20 (previously 18), reflected in documentation, Docker configuration, and test workflows.
    • Adjusted TypeScript and build targets to ES2023 to align with updated Node.js support.
  • Bug Fixes
    • Improved internal error identification for timeout scenarios.
  • Documentation
    • Updated contributing guide to reflect new Node.js version requirements.

@flevi29 flevi29 added the breaking-change The related changes are breaking for the users label Apr 22, 2025
Copy link

codecov bot commented Apr 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.02%. Comparing base (77505c0) to head (30b147e).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1927      +/-   ##
==========================================
- Coverage   99.03%   99.02%   -0.01%     
==========================================
  Files          18       18              
  Lines        1449     1438      -11     
  Branches      305      301       -4     
==========================================
- Hits         1435     1424      -11     
  Misses         14       14              

☔ 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.

@Strift Strift added the dependencies Pull requests that update a dependency file label Apr 22, 2025
@Strift Strift changed the title Remove all Node.js 18 references, adapt code to version 20 Drop Node 18 support Apr 22, 2025
Copy link

coderabbitai bot commented May 19, 2025

Walkthrough

The changes update the minimum supported Node.js version from 18 to 20 across documentation, CI workflows, Docker configuration, TypeScript, and build tooling. Code previously accommodating Node.js 18 polyfills is removed. Build and test targets are updated to ES2023 and Node.js 20/22. Minor internal symbol changes improve timeout error identification.

Changes

File(s) Change Summary
.github/workflows/meilisearch-prototype-tests.yml
.github/workflows/pre-release-tests.yml
.github/workflows/tests.yml
Node.js 18 removed from test matrices; integration tests now run only on Node.js 20 and 22.
CONTRIBUTING.md Updated minimum required Node.js version from 18 to 20 in the development requirements section.
docker-compose.yml Changed Node.js Docker image for package service from node:18 to node:22.
tsconfig.json Compilation target updated from ES2022 to ES2023; comment updated for Node.js 20 context.
vite.config.ts Build target for CJS updated to "es2023"; removed CJS-specific rollup options; UMD footer script adjusted.
src/token.ts Removed Node.js 18 crypto polyfill logic; sign now uses global crypto directly.
src/http-requests.ts Changed TIMEOUT_ID from {} to Symbol("<timeout>") for timeout error identification.
src/task.ts Changed TIMEOUT_ID from {} to Symbol("<task timeout>") for task timeout error identification.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant CI System
    participant Node.js Environment

    Developer->>CONTRIBUTING.md: Reads requirements (Node.js 20+)
    CI System->>Node.js Environment: Runs tests on Node.js 20 and 22
    CI System->>docker-compose.yml: Uses node:22 image
    Developer->>tsconfig.json: Compiles with ES2023 target
    Developer->>vite.config.ts: Builds with ES2023 target
    src/token.ts->>Global Crypto: Uses crypto directly (no polyfill)
Loading

Poem

🐇
Goodbye to Node 18,
Now 20’s on the scene!
Tests and builds are shiny new,
With ES2023 in view.
Crypto’s clear, the code is tight—
This rabbit hops with future’s light!

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent 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 77505c0 and 30b147e.

📒 Files selected for processing (10)
  • .github/workflows/meilisearch-prototype-tests.yml (1 hunks)
  • .github/workflows/pre-release-tests.yml (1 hunks)
  • .github/workflows/tests.yml (1 hunks)
  • CONTRIBUTING.md (1 hunks)
  • docker-compose.yml (1 hunks)
  • src/http-requests.ts (1 hunks)
  • src/task.ts (1 hunks)
  • src/token.ts (0 hunks)
  • tsconfig.json (1 hunks)
  • vite.config.ts (3 hunks)
💤 Files with no reviewable changes (1)
  • src/token.ts
🔇 Additional comments (10)
src/http-requests.ts (1)

73-73: Good improvement using Symbol for error identification

Replacing the empty object {} with a Symbol for timeout error identification is a good modernization. Symbols are designed specifically for creating unique identifiers, making the code more semantically clear and error identification more reliable.

tsconfig.json (1)

6-7: Appropriate TypeScript target update for Node.js 20+

Updating the TypeScript target to ES2023 is the correct approach when dropping Node.js 18 support. This allows the codebase to leverage newer JavaScript features fully supported in Node.js 20 and above, as correctly documented in the updated comment.

src/task.ts (1)

19-19: Consistent improvement using Symbol for task timeout identification

Good change converting the timeout identifier from an empty object to a Symbol. This provides better uniqueness guarantees and makes the code more semantically clear. I appreciate the descriptive name <task timeout> which helps distinguish it from other timeout types in the codebase.

CONTRIBUTING.md (1)

37-37: Documentation correctly updated for new Node.js requirements

The updated Node.js version requirement (v20-22 instead of v18-22) correctly reflects the technical changes in this PR. This clear documentation prevents contributors from attempting to use unsupported Node.js versions and aligns with the broader changes across the codebase.

docker-compose.yml (1)

3-3: Docker image updated to Node.js 22 rather than 20

While the PR objective is to drop Node.js 18 support and move to Node.js 20 as the minimum version, I notice the Docker image has been updated directly to Node.js 22. This isn't necessarily an issue since Node.js 22 is backward compatible with 20, but it's worth confirming if this was intentional to use the latest LTS version rather than the minimum supported version.

Does the project intend to maintain compatibility with both Node.js 20 and 22, with Node.js 20 being the minimum supported version? If so, this change is appropriate.

.github/workflows/pre-release-tests.yml (1)

46-46: Node.js 18 correctly removed from test matrix

The change appropriately removes Node.js 18 from the test matrix, leaving only versions 20 and 22. This aligns with the PR objective to drop Node.js 18 support.

.github/workflows/meilisearch-prototype-tests.yml (1)

49-49: Node.js 18 correctly removed from test matrix

The change appropriately removes Node.js 18 from the test matrix, leaving only versions 20 and 22. This aligns with the PR objective to drop Node.js 18 support.

.github/workflows/tests.yml (1)

39-39: Node.js 18 correctly removed from test matrix

The change appropriately removes Node.js 18 from the test matrix, leaving only versions 20 and 22. This aligns with the PR objective to drop Node.js 18 support.

vite.config.ts (2)

19-20: Build target correctly updated to ES2023

The build target for Node.js has been appropriately updated from ES2022 to ES2023, which aligns with the features supported by Node.js 20. This change correctly reflects the updated minimum Node.js version requirement.


37-52: Rollup configuration simplified and Node.js crypto polyfill removed

The rollup configuration has been improved to only apply to non-CJS (UMD) builds, while setting it to undefined for CJS builds. This removes the external "node:crypto" specification that was previously needed for Node.js 18 compatibility.

This change is appropriate since Node.js 20 has better native support for crypto functionality, eliminating the need for polyfills or special handling that was required in Node.js 18.

✨ 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.

@flevi29 flevi29 requested a review from brunoocasali May 20, 2025 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change The related changes are breaking for the users dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants