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

Remove V2 JS SDK and other dependencies #1531

Merged
merged 3 commits into from
Jan 16, 2025
Merged

Conversation

rygine
Copy link
Collaborator

@rygine rygine commented Jan 16, 2025

Summary

  • Removed @xmtp/xmtp-js, @xmtp/content-type-reaction, @xmtp/content-type-read-receipt, @xmtp/content-type-remote-attachment, @xmtp/content-type-reply, and @xmtp/content-type-transaction-reference dependencies
  • Upgraded @xmtp/content-type-transaction-reference dependency
  • Added @xmtp/content-type-primitives dependency
  • Removed references to @xmtp/user-preferences-bindings-wasm

Summary by CodeRabbit

Release Notes

  • Dependencies

    • Updated XMTP-related package dependencies
    • Removed several content type packages
    • Added new content type primitives package
  • Configuration

    • Updated Babel configuration
    • Added new environment type for XMTP configuration
  • Type Changes

    • Refined type definitions for XMTP client and environment
    • Simplified client type handling in synchronization utilities
  • Removed Utilities

    • Deleted test utility functions for XMTP wallet and client generation
    • Removed script for WASM file handling

These changes represent updates to the project's XMTP integration and dependency management.

@rygine rygine requested a review from a team as a code owner January 16, 2025 17:43
Copy link
Contributor

coderabbitai bot commented Jan 16, 2025

Walkthrough

This pull request involves significant updates to the project's XMTP (Extensible Message Transport Protocol) integration. The changes include modifying Babel configuration, updating type definitions, removing and adding dependencies, and adjusting import statements. The modifications appear to be part of a broader effort to streamline and update the XMTP-related packages and configurations, focusing on type safety and package management.

Changes

File Change Summary
babel.config.js Removed module resolver configuration for @xmtp/user-preferences-bindings-wasm/web
config.ts Added XmtpEnv type with values "local", "dev", "production"
package.json Removed XMTP-related dependencies:
- @xmtp/content-type-reaction
- @xmtp/content-type-read-receipt
- @xmtp/content-type-remote-attachment
- @xmtp/content-type-reply
- @xmtp/xmtp-js
Added/Updated dependencies:
- @xmtp/content-type-primitives (new)
- @xmtp/content-type-transaction-reference (updated)
utils/xmtpRN/content-types/coinbasePayment.ts Updated imports from @xmtp/xmtp-js to @xmtp/content-type-primitives
utils/xmtpRN/sync.ts Modified type definitions for getXmtpClient and instantiatingClientForAccount
Removed files patches/@xmtp+user-preferences-bindings-wasm+0.3.6.patch
utils/test/xmtp.ts
scripts/wasm.js

Possibly related PRs

Suggested reviewers

  • nplasterer
  • technoplato

Poem

🐰 Hop, hop, through XMTP's maze,
Refactoring code in clever ways,
Dependencies dance, types align,
A rabbit's code review, simply divine!
Packages shuffled with technical grace 🌟


📜 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 506e7d5 and a76e854.

⛔ Files ignored due to path filters (1)
  • public/wasm/user_preferences_bindings_wasm_bg.wasm is excluded by !**/*.wasm
📒 Files selected for processing (2)
  • package.json (2 hunks)
  • scripts/wasm.js (0 hunks)
💤 Files with no reviewable changes (1)
  • scripts/wasm.js
🚧 Files skipped from review as they are similar to previous changes (1)
  • package.json
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: tsc
  • GitHub Check: test
  • GitHub Check: performance-test
  • GitHub Check: build
  • GitHub Check: build
  • GitHub Check: lint

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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
utils/xmtpRN/sync.ts (1)

54-56: Consider removing unnecessary type assertion.

The type assertion to Promise<ConverseXmtpClientType> might be unnecessary since the types should already align based on the type definition on line 20.

-  return instantiatingClientForAccount[
-    lowerCaseAccount
-  ] as Promise<ConverseXmtpClientType>;
+  return instantiatingClientForAccount[lowerCaseAccount];
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between eb0495a and 506e7d5.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (7)
  • babel.config.js (0 hunks)
  • config.ts (1 hunks)
  • package.json (1 hunks)
  • patches/@xmtp+user-preferences-bindings-wasm+0.3.6.patch (0 hunks)
  • utils/test/xmtp.ts (0 hunks)
  • utils/xmtpRN/content-types/coinbasePayment.ts (1 hunks)
  • utils/xmtpRN/sync.ts (2 hunks)
💤 Files with no reviewable changes (3)
  • babel.config.js
  • utils/test/xmtp.ts
  • patches/@xmtp+user-preferences-bindings-wasm+0.3.6.patch
✅ Files skipped from review due to trivial changes (1)
  • utils/xmtpRN/content-types/coinbasePayment.ts
🔇 Additional comments (3)
package.json (1)

80-81: LGTM! Dependencies updated to remove V2 JS SDK.

The changes align with the PR objective by removing the V2 JS SDK (@xmtp/xmtp-js) and related packages while adding the necessary V2 replacements.

config.ts (1)

7-7: LGTM! Type safety improvement for XMTP environment configuration.

The addition of the XmtpEnv type enhances type safety by constraining environment values to valid options.

utils/xmtpRN/sync.ts (1)

20-20: LGTM! Type simplification aligns with V2 SDK removal.

The removal of the Client type from union types streamlines the type system and aligns with the V2 SDK removal.

Also applies to: 25-25

Copy link
Contributor

Performance Comparison Report

  • Current: 7b87f46 - 2025-01-16 18:28:05Z
  • Baseline: main (eb0495a) - 2025-01-16 18:26:55Z

Significant Changes To Duration

There are no entries

Meaningless Changes To Duration

Show entries
Name Type Duration Count
Avatar Image 10 runs render 0.8 ms → 0.7 ms (-0.1 ms, -12.5%) 1 → 1
Avatar Image 50 runs render 0.6 ms → 0.7 ms (+0.1 ms, +23.3%) 🔴 1 → 1
Empty Avatar 10 runs render 1.1 ms → 1.0 ms (-0.1 ms, -9.1%) 1 → 1
Empty Avatar 50 runs render 1.0 ms → 0.9 ms (-0.1 ms, -14.0%) 1 → 1
Text Component with color prop - 10 runs render 0.7 ms → 0.7 ms 1 → 1
Text Component with default props - 10 runs render 1.1 ms → 0.8 ms (-0.3 ms, -27.3%) 🟢 1 → 1
Text Component with translation key - 10 runs render 0.7 ms → 0.8 ms (+0.1 ms, +14.3%) 1 → 1
Text Component with weight and size - 10 runs render 0.5 ms → 0.6 ms (+0.1 ms, +20.0%) 🔴 1 → 1
Show details
Name Type Duration Count
Avatar Image 10 runs render Baseline
Mean: 0.8 ms
Stdev: 0.4 ms (52.7%)
Runs: 1 1 1 1 1 0 1 1 1 0
Warmup runs: 0

Current
Mean: 0.7 ms
Stdev: 0.5 ms (69.0%)
Runs: 1 0 1 0 0 1 1 1 1 1
Warmup runs: 1
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:
Avatar Image 50 runs render Baseline
Mean: 0.6 ms
Stdev: 0.5 ms (82.5%)
Runs: 0 1 0 1 0 1 1 1 1 0 1 1 1 0 0 0 0 1 1 0 0 0 1 0 0 1 1 0 0 0 0 1 1 1 1 1 0 0 1 1 1 1 1 1 1 0 1 1 1 1
Warmup runs: 0

Current
Mean: 0.7 ms
Stdev: 0.4 ms (59.9%)
Runs: 1 1 1 1 1 0 1 1 1 1 1 0 1 1 1 1 1 1 1 1 1 0 0 0 1 0 1 0 1 1 1 1 1 0 1 1 1 1 0 1 0 1 0 1 0 1 1 1 0 1
Warmup runs: 0
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
Render issues:

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
Render issues:
Empty Avatar 10 runs render Baseline
Mean: 1.1 ms
Stdev: 0.3 ms (28.7%)
Runs: 1 1 1 1 2 1 1 1 1 1
Warmup runs: 2

Current
Mean: 1.0 ms
Stdev: 0.0 ms (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Warmup runs: 2
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:
Empty Avatar 50 runs render Baseline
Mean: 1.0 ms
Stdev: 0.0 ms (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
Warmup runs: 1

Current
Mean: 0.9 ms
Stdev: 0.4 ms (40.8%)
Runs: 1 1 0 1 1 1 1 1 1 1 1 1 1 0 1 1 1 1 1 1 1 1 1 1 1 1 0 0 1 1 1 1 0 1 1 1 1 1 1 1 0 0 1 1 1 1 1 1 1 1
Warmup runs: 1
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
Render issues:

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
Render issues:
Text Component with color prop - 10 runs render Baseline
Mean: 0.7 ms
Stdev: 0.5 ms (69.0%)
Runs: 1 1 0 1 0 1 1 0 1 1
Warmup runs: 1

Current
Mean: 0.7 ms
Stdev: 0.5 ms (69.0%)
Runs: 1 1 0 1 1 0 1 0 1 1
Warmup runs: 0
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:
Text Component with default props - 10 runs render Baseline
Mean: 1.1 ms
Stdev: 0.6 ms (51.6%)
Runs: 2 2 1 1 1 1 1 1 0 1
Warmup runs: 3

Current
Mean: 0.8 ms
Stdev: 0.6 ms (79.1%)
Runs: 2 1 1 1 1 1 1 0 0 0
Warmup runs: 3
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:
Text Component with translation key - 10 runs render Baseline
Mean: 0.7 ms
Stdev: 0.5 ms (69.0%)
Runs: 1 1 1 0 1 0 0 1 1 1
Warmup runs: 1

Current
Mean: 0.8 ms
Stdev: 0.4 ms (52.7%)
Runs: 0 1 0 1 1 1 1 1 1 1
Warmup runs: 1
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:
Text Component with weight and size - 10 runs render Baseline
Mean: 0.5 ms
Stdev: 0.5 ms (105.4%)
Runs: 0 1 0 1 0 1 1 0 0 1
Warmup runs: 1

Current
Mean: 0.6 ms
Stdev: 0.5 ms (86.1%)
Runs: 1 0 1 0 1 0 0 1 1 1
Warmup runs: 0
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Render issues:

Render Count Changes

There are no entries

Render Issues

There are no entries

Added Scenarios

There are no entries

Removed Scenarios

There are no entries

Generated by 🚫 dangerJS against a76e854

Copy link
Collaborator

@technoplato technoplato left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm - did you double check things still work?

@rygine rygine merged commit 0b719dc into main Jan 16, 2025
12 checks passed
@rygine rygine deleted the rygine/remove-v2-js-sdk branch January 16, 2025 20:05
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