pi-migration-use-correct-git-rev

[jasquat]

Fixes #1908

This updates the process instance migration process to use the old git revision on revert for both the process instance and the migration event.

Summary by CodeRabbit

• New Features

  • Implemented logic to determine the appropriate Git revision for process instance migration.

• Bug Fixes

  • Enhanced process instance migration to correctly handle version control identifiers and associated hashes.

• Refactor

  • Removed unnecessary console.log statements from the Process Instance Migration page.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes across the spiffworkflow backend and frontend primarily focus on improving the process instance migration functionality. The backend now includes a new method to determine the appropriate git revision during migration, with corresponding updates and new assertions in the unit tests. On the frontend, a console log statement was removed from the migration page to clean up the code.

Changes

Files/Paths	Change Summary
.../services/process_instance_service.py	Added get_appropriate_git_revision method, refactored migrate_process_instance.
.../tests/unit/test_process_instance_service.py	Added assertions for bpmn_version_control_identifier in test_it_can_migrate_a_process_instance.
.../routes/ProcessInstanceMigratePage.tsx	Removed console.log statement from rows mapping function.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Frontend as ProcessInstanceMigratePage
    participant Backend as ProcessInstanceService
    participant Git as GitRepository

    User->>Frontend: Initiate migration
    Frontend->>Backend: Call migrate_process_instance()
    Backend->>Backend: Invoke get_appropriate_git_revision()
    Backend->>Git: Fetch appropriate git revision
    Git-->>Backend: Return git revision
    Backend-->>Frontend: Migration result
    Frontend-->>User: Display migration result

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 2e1ee93 and 8e9e377.

Files selected for processing (3)

• spiffworkflow-backend/src/spiffworkflow_backend/services/process_instance_service.py (3 hunks)
• spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_instance_service.py (4 hunks)
• spiffworkflow-frontend/src/routes/ProcessInstanceMigratePage.tsx (1 hunks)

Files skipped from review due to trivial changes (1)

• spiffworkflow-frontend/src/routes/ProcessInstanceMigratePage.tsx

Additional context used

Learnings (1)

spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_instance_service.py (1)

Learnt from: jasquat
PR: sartography/spiff-arena#1902
File: spiffworkflow-backend/tests/spiffworkflow_backend/integration/test_process_instances_controller.py:164-167
Timestamp: 2024-07-11T14:28:31.783Z
Learning: When reviewing test cases, ensure not to add redundant assertions if the condition is already verified elsewhere in the code.

Additional comments not posted (6)

spiffworkflow-backend/tests/spiffworkflow_backend/unit/test_process_instance_service.py (4)

179-179: Assertion Approved: Verify bpmn_version_control_identifier.

The assertion ensures that the bpmn_version_control_identifier is correctly set to "rev1" after creating the process instance.

---

246-246: Assertion Approved: Verify bpmn_version_control_identifier.

The assertion ensures that the bpmn_version_control_identifier is correctly updated to "rev2" after migrating the process instance.

---

297-297: Assertion Approved: Verify bpmn_version_control_identifier.

The assertion ensures that the bpmn_version_control_identifier is correctly updated to "rev2" after migrating the process instance.

---

320-335: Assertions Approved: Verify migration details.

The assertions ensure that the migration details are correctly logged and consistent with the expected values during the migration and reversion processes.

spiffworkflow-backend/src/spiffworkflow_backend/services/process_instance_service.py (2)

261-264: Refactoring Approved: Use get_appropriate_git_revision.

The refactoring correctly uses the new method get_appropriate_git_revision to determine the appropriate git revision during the migration process.

---

282-310: New Method Approved: get_appropriate_git_revision.

The new method correctly determines the appropriate git revision during the migration process, handling both normal migrations and reversions.