Set process_instance_id when creating a new thread

[jbirddog]

Fix for issue reported in discord where a None process instance id was encountered when trying to run a script.

Summary by CodeRabbit

• New Features
  • Enhanced workflow execution service with support for process instance identification, improving process tracking and management.

[coderabbitai]

Walkthrough

Walkthrough

The changes made to the workflow_execution_service.py file in the Spiffworkflow Backend module involve enhancing the _run method to include a process_instance_id parameter. This update ensures that the process_instance.id is passed to the relevant methods, specifically _run_engine_steps_with_threads and _run_engine_steps_without_threads.

Changes

Files/Paths	Change Summary
spiffworkflow-backend/src/spiffworkflow_backend/services/workflow_execution_service.py	Added process_instance_id parameter to the _run method and included process_instance.id argument in calls to _run_engine_steps_with_threads and _run_engine_steps_without_threads.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant WorkflowService
    
    Client ->> WorkflowService: _run(process_instance_id)
    WorkflowService ->> WorkflowService: _run_engine_steps_with_threads(process_instance.id)
    WorkflowService ->> WorkflowService: _run_engine_steps_without_threads(process_instance.id)

    Note right of WorkflowService: `process_instance.id` passed down<br>through method calls.

Loading

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bcb1248 and 54c8fa4.

Files selected for processing (1)

• spiffworkflow-backend/src/spiffworkflow_backend/services/workflow_execution_service.py (3 hunks)

Additional comments not posted (3)

spiffworkflow-backend/src/spiffworkflow_backend/services/workflow_execution_service.py (3)

216-216: Correct passing of process_instance_id in threaded context.

The process_instance.id is correctly passed as an argument to _run within _run_engine_steps_with_threads. This change ensures that the process instance ID is consistently used across different threads, which is crucial for maintaining state consistency.

---

235-235: Correct passing of process_instance_id in non-threaded context.

The process_instance.id is correctly passed as an argument to _run within _run_engine_steps_without_threads. This change ensures that the process instance ID is consistently used across different execution contexts, which is crucial for maintaining state consistency.

---

121-127: Parameter addition handled correctly in _run method.

The addition of process_instance_id to the _run method is implemented correctly. It is properly used within the method to set thread-local data, which aligns with the PR's objective to fix the None process instance ID issue.