Add integration tests for workflow config persistence and incompatible config handling #535
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This test verifies that starting a workflow via the WorkflowController
stores workflow params in the config store, and that recreating the
adapter via the controller reads those params back correctly.
Changes:
- Enhanced DashboardBackend to support configurable transport ('kafka' or 'none')
to allow testing without Kafka services when not needed
- Added three integration tests:
1. test_workflow_params_stored_and_retrieved_via_config_store
- Verifies complete persistence flow from start_workflow to adapter creation
2. test_adapter_filters_removed_sources
- Verifies adapter filters out sources not in workflow spec
3. test_config_persists_across_adapter_recreations
- Verifies consistent behavior across multiple adapter recreations
Tests use null transport (no Kafka required) since they only test
the config store persistence mechanism through the controller.
Original prompt: In a new worktree (branch off main), please add a new
integration test that checks if starting a workflow via the controller
stores workflow params in the config store, and if recreating the adapter
via the controller reads those params back correctly.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <[email protected]>
When stored configuration params have no field overlap with the current
parameter model (indicating complete incompatibility, e.g., from a
different workflow version), the adapter now returns an empty dict to
fall back to defaults rather than propagating invalid data to the UI.
Changes:
- Modified ConfigurationAdapter.initial_parameter_values to check for
field overlap between stored params and current model fields
- If no overlap is detected, returns {} to trigger default values
- Partial overlaps are handled by Pydantic (ignores extra, uses defaults)
- Added test_incompatible_config_falls_back_to_defaults to verify behavior
This ensures that schema changes between workflow versions don't break
the dashboard - it gracefully falls back to defaults when configs are
completely incompatible.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds integration tests for workflow configuration persistence via the config store and enhances the
ConfigurationAdapterto gracefully handle incompatible stored configurations.Fixes #525 - this worked before, but now we do validation in the adapter instead of relying on the UI components.
Changes
1. Enhanced
DashboardBackendto support configurable transporttransportparameter accepting'kafka'or'none'NullTransportfor tests that only need the controller/config store2. Added integration tests for workflow config persistence
File:
tests/integration/config_persistence_test.py3. Enhanced
ConfigurationAdapterto detect incompatible paramsFile:
src/ess/livedata/dashboard/configuration_adapter.pyModified
initial_parameter_valuesto:{}to trigger defaultsThis ensures schema changes between workflow versions don't break the dashboard - it gracefully falls back to defaults when configs are completely incompatible.
Motivation
These tests verify the critical flow where:
WorkflowControllerstores params in the config store