feat: Using temporal shared codes library!

[amindadgar]

Summary by CodeRabbit

• Chores
  • Updated backend service dependencies for improved stability and future support.
• Refactor
  • Unified client integration across key components to streamline operations and enhance maintainability.

[coderabbitai]

Walkthrough

The changes update dependencies and import paths related to the Temporal client. In the requirements.txt, the dependency temporalio==1.8.0 is removed and replaced with tc-temporal-backend==1.0.0. Consequently, import statements in several files have been updated from the old module (utils.temporal_client) to the new one (tc_temporal_backend.client). Additionally, the TemporalClient class has been removed from the local implementation in utils/temporal_client.py, consolidating its functionality under the new dependency.

Changes

Files	Changes Summary
requirements.txt	- Removed dependency temporalio==1.8.0 - Added dependency tc-temporal-backend==1.0.0
test_run_workflow.py, tests/unit/…/test_temporal_client.py, worker.py	- Updated import path for TemporalClient from utils.temporal_client to tc_temporal_backend.client
utils/…/temporal_client.py	- Removed the TemporalClient class and its associated credential loading functionality

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant NewClient as tc-temporal_backend.client
    Caller ->> NewClient: Import & Instantiate TemporalClient
    NewClient -->> Caller: Return client instance

Loading

Poem

I’m skipping through the code so light,
Out with the old, in with backend bright.
No more local hops on a worn-out trail,
The new Temporal path will never fail! 🐰
CodeRabbit cheers with joy and might!

---

📜 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 57c3033 and c552987.

📒 Files selected for processing (5)

• requirements.txt (1 hunks)
• test_run_workflow.py (1 hunks)
• tests/unit/test_temporal_client.py (1 hunks)
• utils/temporal_client.py (0 hunks)
• worker.py (1 hunks)

💤 Files with no reviewable changes (1)

• utils/temporal_client.py

✅ Files skipped from review due to trivial changes (3)

• requirements.txt
• test_run_workflow.py
• tests/unit/test_temporal_client.py

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: ci / test / Test
• GitHub Check: ci / lint / Lint

🔇 Additional comments (2)

worker.py (2)

8-8: LGTM! Import updated to use the shared library.

The import change aligns with the PR objective of using the temporal shared codes library.

---

8-8:

Details

❓ Verification inconclusive

Verify compatibility with temporalio package.

Let's verify:

1. The version compatibility between temporalio and tc-temporal-backend
2. The availability of documentation for the new package

Also applies to: 19-19

---

🏁 Script executed:

#!/bin/bash
# Description: Check package information and dependencies

# Check if tc-temporal-backend package exists and get its metadata
pip show tc-temporal-backend 2>/dev/null || echo "Package not found"

# Check for README or documentation
fd -t f "README.md" | grep -i temporal

Length of output: 114

---

🌐 Web query:

What is the latest version of temporalio Python SDK and its compatibility requirements?

💡 Result:

The latest version of the Temporal Python SDK is v1.9.0, released on December 23, 2024[1]. This version introduces experimental features like update-with-start workflows, user metadata enhancements, and custom slot suppliers for worker tuning[1].

Compatibility Requirements

• Python Versions:
  • v1.9.x requires Python ≥3.8[1][5]
  • Earlier versions:
    • v1.4.x supported Python 3.7-3.11[5]
    • v1.5+ dropped Python 3.7 support[1]

Key Changes

• Breaking Changes:

  • start_update now requires explicit wait_for_stage=WorkflowUpdateStage.ACCEPTED parameter[1]
  • Removed deprecated temporalio.runtime.TelemetryConfig.tracing[1]
  • Replaced asyncio.as_completed/asyncio.wait with workflow-safe alternatives[1]

• Dependencies:

  • Uses Protobuf ≥4.x (earlier versions incompatible)[4]
  • Requires asyncio event loop integration for workflows[4]

For production use cases requiring long-term stability, consider pinning to v1.x releases rather than experimental features marked for potential API changes[1][4].

Citations:

• 1: https://github.com/temporalio/sdk-python/releases
• 2: https://github.com/temporalio/features
• 3: http://athiemann.net/2023/01/16/temporal.html
• 4: https://github.com/temporalio/sdk-python
• 5: https://learn.temporal.io/tutorials/python/background-check/introduction/
• 6: https://pkg.go.dev/go.temporal.io/sdk/temporal
• 7: https://dev.to/temporalio/python-sdk-the-release-2ji9?comments_sort=top
• 8: https://learn.temporal.io/tutorials/python/background-check/project-setup/
• 9: https://pkg.go.dev/go.temporal.io/sdk/client
• 10: https://docs.temporal.io/develop/python/

---

Action Required: Confirm Temporal Package Compatibility and Documentation

• The code still references from tc_temporal_backend.client import TemporalClient (worker.py, lines 8 and 19). However, the check using pip show tc-temporal-backend returned "Package not found" and no related documentation was found in the README.
• A web query confirms that the latest Temporal Python SDK is v1.9.0 (requires Python ≥3.8) with several breaking changes; please verify that tc-temporal-backend (if intended as an internal or alternate package) is fully compatible with these requirements.
• Next Steps:
  • Manually verify if the tc-temporal-backend package is expected to be available (or if its functionality has been superseded by the official temporalio SDK).
  • Ensure the package’s compatibility and update internal documentation accordingly, especially given its usage on lines 8 and 19.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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