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 temporal #2954

Merged
merged 3 commits into from
Jan 14, 2025
Merged

Upgrade temporal #2954

merged 3 commits into from
Jan 14, 2025

Conversation

ochrstn
Copy link
Contributor

@ochrstn ochrstn commented Jan 10, 2025

Resolves #2641

Summary by CodeRabbit

  • Dependencies

    • Updated Temporal.io library dependencies to version 1.11.6
    • Upgraded @temporalio/client, @temporalio/testing, and @temporalio/worker packages
    • Updated peer dependency requirements for Temporal.io packages
  • Testing

    • Modified test assertion method for checking worker activities

Copy link

coderabbitai bot commented Jan 10, 2025

Walkthrough

The pull request updates the Temporal.io dependencies in the @tsed/temporal package. Specifically, the versions of @temporalio/client, @temporalio/testing, and @temporalio/worker have been upgraded from 1.8.4 to 1.11.6 in both dev and peer dependencies. Additionally, a modification was made to the worker integration test to change how the greet activity is verified, using a method-based check instead of a direct property access.

Changes

File Change Summary
packages/third-parties/temporal/package.json Updated dependency versions:
- @temporalio/client: 1.8.41.11.6
- @temporalio/testing: 1.8.41.11.6
- @temporalio/worker: 1.8.41.11.6
Peer dependencies also updated to ^1.11.6
packages/third-parties/temporal/test/worker.integration.spec.ts Modified activity existence assertion to use .has() method instead of direct property access

Assessment against linked issues

Objective Addressed Explanation
Update Temporal.io dependencies
Ensure tests work after dependency update Actual test success not confirmed in the provided diff

The changes directly address the dependency update requirement from issue #2641, but without full test run evidence, the complete resolution cannot be definitively confirmed.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c9f572d and 7505b04.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (2)
  • packages/third-parties/temporal/package.json (2 hunks)
  • packages/third-parties/temporal/test/worker.integration.spec.ts (1 hunks)
🔇 Additional comments (3)
packages/third-parties/temporal/package.json (2)

48-49: LGTM! Peer dependencies are correctly aligned

The peer dependency versions are correctly aligned with the devDependencies, using the caret range ^1.11.6 to allow compatible updates.


34-36: Verify compatibility with Temporal.io v1.11.6

The upgrade from v1.8.4 to v1.11.6 is significant. Please ensure you've reviewed the Temporal.io changelog for any breaking changes or deprecations.

Let's verify the latest stable version and any potential issues:

✅ Verification successful

Temporal.io SDK upgrade appears safe to proceed

The codebase uses Temporal SDK primarily for infrastructure setup through stable APIs (connections and workers). No complex workflow implementations or deprecated features were found that could be affected by the version upgrade.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check latest @temporalio versions and recent releases
npm view @temporalio/client versions --json | jq -r '.[-5:]'
npm view @temporalio/worker versions --json | jq -r '.[-5:]'

# Check for any security advisories
gh api graphql -f query='
{
  securityVulnerabilities(first: 5, ecosystem: NPM, package: "@temporalio/client") {
    nodes {
      advisory {
        summary
        severity
        publishedAt
      }
      vulnerableVersionRange
    }
  }
}'

Length of output: 548


Script:

#!/bin/bash
# Search for Temporal SDK imports and usage patterns
rg -g '!package*.json' -g '!*.lock' "@temporalio/(client|worker|testing)" -A 2

# Look for Temporal workflow definitions
ast-grep --pattern 'export class $_ implements Workflow {'

# Look for Temporal activity definitions
ast-grep --pattern 'export class $_ implements Activities {'

Length of output: 3732

packages/third-parties/temporal/test/worker.integration.spec.ts (1)

36-36: LGTM! Improved activity verification method

The change to use has() method for checking activity registration is a more robust approach compared to direct property access. This aligns well with the Temporal.io API best practices.

Let's verify if this change was required by the upgrade:

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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.

@ochrstn ochrstn requested review from Romakita and Copilot January 10, 2025 09:14

Choose a reason for hiding this comment

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

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

Files not reviewed (1)
  • packages/third-parties/temporal/package.json: Language not supported
@Romakita
Copy link
Collaborator

@ochrstn Finally it was simple XD. Thanks a lot @ochrstn !

@Romakita Romakita merged commit 68f358a into tsedio:production Jan 14, 2025
12 checks passed
@Romakita
Copy link
Collaborator

🎉 This PR is included in version 8.4.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Update temporal.io dependencies causing issue
2 participants