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

Upgrade Node bindings #738

Merged
merged 3 commits into from
Dec 2, 2024
Merged

Upgrade Node bindings #738

merged 3 commits into from
Dec 2, 2024

Conversation

rygine
Copy link
Collaborator

@rygine rygine commented Dec 2, 2024

Summary

  • Upgraded to latest node bindings
  • Updated CHANGELOG with missing info

Summary by CodeRabbit

  • New Features

    • Introduced two new methods in the Client class: isAddressAuthorized and isInstallationAuthorized for enhanced authorization checks.
  • Chores

    • Updated the dependency version of @xmtp/node-bindings to improve SDK functionality.

@rygine rygine requested review from a team as code owners December 2, 2024 18:29
Copy link

changeset-bot bot commented Dec 2, 2024

🦋 Changeset detected

Latest commit: 946f6a4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@xmtp/node-sdk Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

coderabbitai bot commented Dec 2, 2024

Walkthrough

This pull request introduces a patch upgrade for the Node bindings of the @xmtp/node-sdk, specifically updating the dependency @xmtp/node-bindings to version ^0.0.27. Additionally, it updates the changelog to reflect the addition of two new methods, isAddressAuthorized and isInstallationAuthorized, in the Client class. These changes enhance the SDK's functionality and maintain its continuous evolution through version updates.

Changes

File Change Summary
.changeset/smooth-plants-end.md Updated dependency: @xmtp/node-sdk for patch upgrade.
sdks/node-sdk/CHANGELOG.md Added methods: isAddressAuthorized, isInstallationAuthorized in Client class.
sdks/node-sdk/package.json Updated dependency version: @xmtp/node-bindings from ^0.0.25 to ^0.0.27.

Possibly related PRs

  • Upgrade node bindings #709: This PR involves an upgrade to the @xmtp/node-bindings dependency, which is directly related to the main PR's focus on enhancing the Node bindings of the @xmtp/node-sdk.
  • Update Node SDK #715: This PR also updates the @xmtp/node-bindings dependency, indicating a version bump that aligns with the main PR's changes to the Node SDK.
  • Update the node bindings #737: This PR introduces new methods in the Client class and updates the @xmtp/node-bindings dependency, which is relevant to the main PR's focus on enhancing the SDK's functionality.

Suggested reviewers

  • nplasterer

🐇 In the garden where code does bloom,
A patch was made to lift the gloom.
With bindings fresh and methods new,
The SDK hops, as rabbits do!
So let us cheer, with joy and cheer,
For every change that brings us near! 🐇


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a1f27b8 and 946f6a4.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (3)
  • .changeset/smooth-plants-end.md (1 hunks)
  • sdks/node-sdk/CHANGELOG.md (1 hunks)
  • sdks/node-sdk/package.json (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .changeset/smooth-plants-end.md
🔇 Additional comments (2)
sdks/node-sdk/package.json (1)

56-56: Verify the latest version of @xmtp/node-bindings

The upgrade from ^0.0.25 to ^0.0.27 looks good, but let's verify it's the latest stable version.

✅ Verification successful

Version ^0.0.27 is confirmed as the latest release

The verification confirms that version 0.0.27 is indeed the latest version available on the NPM registry, matching exactly with the version being upgraded to in the package.json. While we couldn't access the changelog, the patch version update (0.0.x) typically indicates backward-compatible bug fixes, making this upgrade safe.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check the latest version of @xmtp/node-bindings and its compatibility

# Check NPM registry for latest version
curl -s https://registry.npmjs.org/@xmtp/node-bindings | jq -r '."dist-tags".latest'

# Check if there are any breaking changes in the changelog
gh api graphql -f query='
{
  repository(owner: "xmtp", name: "xmtp-js") {
    object(expression: "main:sdks/node-bindings/CHANGELOG.md") {
      ... on Blob {
        text
      }
    }
  }
}' | jq -r '.data.repository.object.text'

Length of output: 331

sdks/node-sdk/CHANGELOG.md (1)

3-9: LGTM! Changelog update follows the established format

The changelog entry properly documents the new methods added to the Client class and follows the consistent format with:

  • Version number
  • Patch changes section
  • Commit hash reference
  • Clear description of changes

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

cloudflare-workers-and-pages bot commented Dec 2, 2024

Deploying xmtp-js-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 946f6a4
Status: ✅  Deploy successful!
Preview URL: https://fc5d9fb3.xmtp-js.pages.dev
Branch Preview URL: https://rygine-node-sdk-update.xmtp-js.pages.dev

View logs

@rygine rygine merged commit f1b93bb into main Dec 2, 2024
24 checks passed
@rygine rygine deleted the rygine/node-sdk-update branch December 2, 2024 18:49
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