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

Allow data store upsearch to work from within a parallel gateway #1002

Merged
merged 2 commits into from
Feb 8, 2024
Merged

Conversation

jbirddog
Copy link
Contributor

@jbirddog jbirddog commented Feb 8, 2024

One of the issues found yesterday ended up being that data store upsearches did not work properly when the data store was referenced from within a parallel gateway. This was because the spawned thread did not have the process model identifier in thread local data.

Summary by CodeRabbit

  • Refactor
    • Enhanced the workflow execution service by ensuring the process_model_identifier is set and passed correctly during task execution.

Copy link
Contributor

coderabbitai bot commented Feb 8, 2024

Warning

Rate Limit Exceeded

@jbirddog has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 56 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between abb6ba3 and f1959e6.

Walkthrough

The update involves enhancing the workflow execution process by integrating the process_model_identifier into the execution context. This identifier is now set within the thread-local data before a task is executed, ensuring that the execution context is properly configured with necessary identifiers. The modification facilitates better tracking and management of workflow processes by linking tasks back to their respective process models.

Changes

File Change Summary
.../services/workflow_execution_service.py The _run function sets the process_model_identifier in thread-local data before task execution. The spiff_run function now passes the process_model_identifier from the process_instance_model to the _run function.

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 2

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between d1e30f9 and abb6ba3.
Files selected for processing (1)
  • spiffworkflow-backend/src/spiffworkflow_backend/services/workflow_execution_service.py (2 hunks)

Comment on lines 118 to 123
process_model_identifier: str | None,
) -> SpiffTask:
with app.app_context():
tld = current_app.config.get("THREAD_LOCAL_DATA")
if tld:
tld.process_model_identifier = process_model_identifier
Copy link
Contributor

Choose a reason for hiding this comment

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

Ensure that process_model_identifier is validated or sanitized before being assigned to tld.process_model_identifier to prevent potential security issues.

@@ -159,6 +164,7 @@
spiff_task,
current_app._get_current_object(),
user,
process_instance_model.process_model_identifier,
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 8, 2024

Choose a reason for hiding this comment

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

The passing of process_instance_model.process_model_identifier directly to _run is correct in terms of functionality. However, consider adding a check or fallback mechanism in case process_instance_model.process_model_identifier is None or invalid, to ensure robustness.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated the type hint to remove | None since that field has nullable=False in the process instance model.

Copy link
Contributor

Choose a reason for hiding this comment

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

@jbirddog: Acknowledged. Given that the process_model_identifier field in the process instance model is non-nullable, as enforced by the database schema, the approach you've taken is sound. This ensures that the value will always be present when accessed in the code, aligning with the robustness of the implementation. Thank you for the clarification.

@jbirddog jbirddog merged commit 886f1f5 into main Feb 8, 2024
22 checks passed
@jbirddog jbirddog deleted the pgds branch February 8, 2024 17:04
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