Skip to content
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

build(deps): replace nhooyr.io/websocket #2653

Merged
merged 1 commit into from
Dec 25, 2024
Merged

build(deps): replace nhooyr.io/websocket #2653

merged 1 commit into from
Dec 25, 2024

Conversation

robert-zaremba
Copy link
Member

@robert-zaremba robert-zaremba commented Dec 23, 2024

Description

nhooyr.io/websocket is not available any more, and github repo should be used.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • added appropriate labels to the PR
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Summary by CodeRabbit

  • Chores
    • Updated dependency mappings in the project configuration.

@robert-zaremba robert-zaremba requested a review from a team as a code owner December 23, 2024 21:59
Copy link
Contributor

coderabbitai bot commented Dec 23, 2024

Walkthrough

The pull request involves modifications to the go.mod file, specifically adding a new replace directive for the websocket package. The change redirects nhooyr.io/websocket to github.com/coder/websocket at version v1.8.10. Existing replace directives for other dependencies like keyring, JWT, and protobuf remain unchanged. This update appears to be a strategic adjustment in the project's dependency management, potentially addressing compatibility or maintenance concerns.

Changes

File Change Summary
go.mod Added replace directive: nhooyr.io/websocket => github.com/coder/websocket v1.8.10

Poem

🐰 A websocket hop, a dependency swap,
From nhooyr to Coder, without a stop!
Modules dance, versions align,
In Go's garden, dependencies entwine 🌱
A rabbit's leap of code delight! 🚀


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 07f5d8f and 97afcb6.

⛔ Files ignored due to path filters (1)
  • go.sum is excluded by !**/*.sum
📒 Files selected for processing (1)
  • go.mod (1 hunks)
🔇 Additional comments (1)
go.mod (1)

238-238: Verify the replacement websocket package

The replacement of nhooyr.io/websocket with github.com/coder/websocket appears correct, but let's verify:

  1. The authenticity and maintenance status of the fork
  2. Compatibility between v1.8.6 and v1.8.10
  3. Any breaking changes in the newer version

Consider documenting this dependency change in the project's documentation to help other developers understand why this replacement was necessary and any potential implications for future updates.

✅ Verification successful

Based on the results, I can now provide a final response as we have sufficient information about the fork's status and version changes:

Fork replacement is verified and safe to use

The replacement of nhooyr.io/websocket with github.com/coder/websocket is verified to be safe because:

  1. The fork is actively maintained (last updated: Dec 23, 2024) and not archived
  2. The version bump from v1.8.6 to v1.8.10 contains only minor improvements:
    • v1.8.10: Adds support for disabling read limit with -1
    • v1.8.9: Internal fix for noCopy visibility
    • v1.8.8: Various improvements and fixes, all backward compatible
  3. The repository was officially transferred to Coder (as noted in v1.8.12 release notes)
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the websocket package replacement

# Check the fork's status
echo "Checking fork status..."
gh repo view github.com/coder/websocket --json createdAt,updatedAt,isArchived,defaultBranchRef

# Check for breaking changes between versions
echo "Checking for breaking changes..."
gh api graphql -f query='
{
  repository(owner: "coder", name: "websocket") {
    releases(first: 10) {
      nodes {
        name
        tagName
        description
        createdAt
      }
    }
  }
}'

# Check usage patterns to ensure compatibility
echo "Checking usage patterns..."
rg -A 2 "websocket\." --type go

Length of output: 8730


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • 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.

Copy link

codecov bot commented Dec 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.97%. Comparing base (7f05ad4) to head (97afcb6).
Report is 564 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #2653       +/-   ##
===========================================
- Coverage   75.38%   61.97%   -13.42%     
===========================================
  Files         100      275      +175     
  Lines        8025    19643    +11618     
===========================================
+ Hits         6050    12174     +6124     
- Misses       1589     6693     +5104     
- Partials      386      776      +390     

see 217 files with indirect coverage changes

@gsk967 gsk967 added this pull request to the merge queue Dec 25, 2024
Merged via the queue into main with commit 4181d03 Dec 25, 2024
22 of 25 checks passed
@gsk967 gsk967 deleted the robert/fix-gomod branch December 25, 2024 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants