feat(api): Introduce WorkflowResumptionContext for pause state management

[QuantumGhost]

Summary

Certain metadata (including but not limited to InvokeFrom, call_depth, and streaming) is required when resuming a paused workflow. However, these fields are not part of GraphRuntimeState and were not saved in the previous
implementation of PauseStatePersistenceLayer.

This commit addresses this limitation by introducing a WorkflowResumptionContext model that wraps both the *GenerateEntity and GraphRuntimeState. This approach provides:

• A structured container for all necessary resumption data
• Better separation of concerns between execution state and persistence
• Enhanced extensibility for future metadata additions
• Clearer naming that distinguishes from GraphRuntimeState

The WorkflowResumptionContext model makes extending the pause state easier while maintaining backward compatibility and proper version management for the entire execution state ecosystem.

Resolves #28121.

Screenshots

N/A

Checklist

• This change requires a documentation update, included: Dify Document
• I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
• I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
• I've updated the documentation accordingly.
• I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

[QuantumGhost]

/gemini review

[gemini-code-assist]

Code Review

This pull request introduces WorkflowResumptionContext to properly manage and persist the state required for resuming paused workflows. The new model encapsulates both the GraphRuntimeState and the GenerateEntity, which is a great improvement for structuring resumption data and ensuring all necessary metadata is saved. The implementation is solid, and the changes are well-tested with both unit and integration tests. I've left a few minor comments to improve documentation and code clarity. Overall, this is a well-executed feature.

[Copilot]

Pull Request Overview

This pull request introduces WorkflowResumptionContext to improve pause state management for workflows by capturing all necessary metadata (including InvokeFrom, call_depth, and streaming) that was previously not being saved. The implementation wraps both the generate entity and the graph runtime state in a versioned container for better extensibility and maintainability.

Key changes:

• Introduces WorkflowResumptionContext model with version management and discriminated union support for different entity types
• Updates PauseStatePersistenceLayer to serialize/deserialize the new context instead of just the graph runtime state
• Adds comprehensive test coverage for serialization roundtrips and persistence flows

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
api/core/app/layers/pause_state_persist_layer.py	Introduces WorkflowResumptionContext and wrapper classes for entity type discrimination; updates PauseStatePersistenceLayer.__init__ to require generate_entity parameter
api/core/app/entities/app_invoke_entities.py	Adds documentation comment clarifying that user_id corresponds to Account.id or EndUser.id
api/tests/unit_tests/core/app/layers/test_pause_state_persist_layer.py	Updates all test cases to pass generate_entity to layer constructor; adds parametrized roundtrip tests for serialization
api/tests/test_containers_integration_tests/core/app/layers/test_pause_state_persist_layer.py	Updates integration tests to create and pass generate_entity; verifies WorkflowResumptionContext in persisted state

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.