You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
What
Update current logic so that time-sync applies aggregationMethod == None when it encounters an unknown parametr, rather than having to have parameters explicitly defined in the manifest and passed as arguments.
Why
The current behaviour requires users to pass unknown parameters by name to the timeSync plugin in order to avoid time-sync erroring out. This means affected users have to go through a mini-debugging process to get time sync to execute. Instead, we should just fallback to a default behaviour where unspecified values are just copied into each new timestep and a simple warning is emitted.
Note that this is to fix an edge case scenario where values are provided in defaults but not actually used in pipelines, so metadata is not available for them. Most scenarios are handled via the happy path which is that parameter metadata is available in plugin source code or the manifest's initialize block.
Context
n/a
Prerequisites/resources
n/a
SoW (scope of work)
update time-sync logic to fallback to none where metadata cannot be found
documentation updated
test cases added
Acceptance criteria
Given (Setup): the time-sync logic falls back to aggregation-method == None where no metadata can be found for a parameter.
What
Update current logic so that time-sync applies
aggregationMethod == None
when it encounters an unknown parametr, rather than having to have parameters explicitly defined in the manifest and passed as arguments.Why
The current behaviour requires users to pass unknown parameters by name to the
timeSync
plugin in order to avoid time-sync erroring out. This means affected users have to go through a mini-debugging process to get time sync to execute. Instead, we should just fallback to a default behaviour where unspecified values are just copied into each new timestep and a simple warning is emitted.Note that this is to fix an edge case scenario where values are provided in
defaults
but not actually used in pipelines, sometadata
is not available for them. Most scenarios are handled via the happy path which is that parameter metadata is available in plugin source code or the manifest's initialize block.Context
n/a
Prerequisites/resources
n/a
SoW (scope of work)
none
where metadata cannot be foundAcceptance criteria
Given (Setup): the time-sync logic falls back to
aggregation-method == None
where no metadata can be found for a parameter.When (Action): I run the following manifest:
Then (Assertion): Defines the expected outcome or behavior of the system after the action in the "When" step is performed.
The text was updated successfully, but these errors were encountered: