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

update-ht-task-fk-for-mysql-8-4 #1950

Merged
merged 1 commit into from
Jul 18, 2024
Merged

Conversation

jasquat
Copy link
Contributor

@jasquat jasquat commented Jul 18, 2024

This updates the migration that adds a foreign key from human_task.task_guid to task.guid. This migration had issues with mysql 8.4 which no longer allows foreign keys on non-standard keys.

More info:
https://dev.mysql.com/doc/refman/8.4/en/server-system-variables.html#sysvar_restrict_fk_on_non_standard_key
https://bugs.mysql.com/bug.php?id=114838

Copy link
Contributor

coderabbitai bot commented Jul 18, 2024

Walkthrough

Walkthrough

The recreate_db script in the spiffworkflow-backend was enhanced to include validation for the SPIFFWORKFLOW_BACKEND_ENV variable, restricting it to 'local_development' and 'unit_testing'. It also introduced the databases_to_run_on variable for managing multiple databases, and a new function run_command_on_mysql_databases for executing commands on these databases. The script now handles database operations more efficiently and adjusts the database URI for unit testing under specific conditions.

Changes

File Change Summary
spiffworkflow-backend/bin/recreate_db Validated SPIFFWORKFLOW_BACKEND_ENV, introduced databases_to_run_on, added run_command_on_mysql_databases function, and refactored database operations.

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5cdf74e and bc64802.

Files ignored due to path filters (1)
  • spiffworkflow-backend/migrations/versions/3191627ae224_.py is excluded by !spiffworkflow-backend/migrations/**
Files selected for processing (1)
  • spiffworkflow-backend/bin/recreate_db (4 hunks)
Additional comments not posted (6)
spiffworkflow-backend/bin/recreate_db (6)

29-32: Validation for SPIFFWORKFLOW_BACKEND_ENV is correct.

The validation ensures that the environment variable is set to either 'local_development' or 'unit_testing', preventing misconfiguration.


38-38: Introduction of databases_to_run_on variable is correct.

The variable databases_to_run_on is used to manage multiple databases, which is useful for handling different environments.


47-50: Modification of database_name_from_uri is correct.

The logic extracts the database name from the URI and updates databases_to_run_on if the extracted name is not already in the list, ensuring the correct database is targeted.


64-69: Addition of run_command_on_mysql_databases function is correct.

The function iterates over databases_to_run_on and executes the given command on each database, efficiently handling multiple databases.


85-85: Usage of run_command_on_mysql_databases function is correct.

The function is used to drop and create databases based on the specified environment, ensuring consistent database management.

Also applies to: 119-119


126-128: Adjustment of database URI for unit testing is correct.

The conditional block ensures that the database URI is correctly set for unit testing, preventing potential issues during testing.

@jasquat jasquat merged commit 5277360 into main Jul 18, 2024
24 checks passed
@jasquat jasquat deleted the update-ht-task-fk-for-mysql-8-4 branch July 18, 2024 17:20
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