v0.6.0

Dispatch Highlevel Interface Release Notes

Summary

This release introduces a more flexible and powerful mechanism for managing dispatch events with new strategies for merging intervals, enhanced customization options, and better overall alignment with evolving SDK dependencies. It also simplifies actor initialization while maintaining robust support for diverse dispatch scenarios.

Upgrading

A new simplified way to manage actors has been introduced:

Change your code from:

dispatcher = Dispatcher(
    microgrid_id=microgrid_id,
    server_url=url,
    key=key
)
dispatcher.start()

status_receiver = dispatcher.new_running_state_event_receiver("EXAMPLE_TYPE")

managing_actor = ActorDispatcher(
    actor_factory=MyActor.new_with_dispatch,
    running_status_receiver=status_receiver,
)

await run(managing_actor)

to

async with Dispatcher(
    microgrid_id=microgrid_id,
    server_url=url,
    key=key
) as dispatcher:
    await dispatcher.start_managing(
        dispatch_type="EXAMPLE_TYPE",
        actor_factory=MyActor.new_with_dispatch, # now async factory!
        merge_strategy=MergeByType,
    )
    await dispatcher

Further changes:

• Dispatcher.start is no longer async. Remove await when calling it.
• Two properties have been replaced by methods that require a type as parameter.
  • Dispatcher.lifecycle_events has been replaced by the method Dispatcher.new_lifecycle_events_receiver(self, dispatch_type: str).
  • Dispatcher.running_status_change has been replaced by the method Dispatcher.new_running_state_event_receiver(self, dispatch_type: str, merge_strategy: MergeStrategy).
• The managing actor constructor no longer requires the dispatch_type parameter. Instead you're expected to pass the type to the new_receiver function.
• The DispatchManagingActor class has been renamed to DispatchActorsService.
  • It's interface has been simplified and now only requires an actor factory and a running status receiver.
  • It only starts/stops a single actor at a time now instead of a set of actors.
  • Refer to the updated usage example for more information.
• DispatchUpdate was renamed to DispatchInfo.

New Features

• A new feature "merge strategy" (MergeByType, MergeByTypeTarget) has been added to the Dispatcher.new_running_state_event_receiver method. Using it, you can automatically merge consecutive and overlapping dispatch start/stop events of the same type. E.g. dispatch A starting at 10:10 and ending at 10:30 and dispatch B starts at 10:30 until 11:00, with the feature enabled this would in total trigger one start event, one reconfigure event at 10:30 and one stop event at 11:00.
• The SDK dependency was widened to allow versions up to (excluding) v1.0.0-rc1800.
• Actor management with dispatches has been simplified:
  • Dispatcher.start_managing(dispatch_type, actor_factory, merge_strategy, retry_interval) to manage your actor for the given type and merge strategy. All you need provide is an actor factory.
  • Dispatcher.stop_managing(dispatch_type) to stop dispatching for the given type.
  • Dispatcher.is_managed(dispatch_type) to check if dispatching is active for the given type.
  • Dispatches that failed to start will now be retried after a delay.
• A new method Dispatcher.wait_for_initialization() has been added to wait for all actors to be initialized.
• When using async with Dispatcher(..) as dispatcher, the dispatcher will first wait for the dispatch service to be initialized before entering the block.

What's Changed

• Bump types-markdown from 3.7.0.20240822 to 3.7.0.20241204 by @dependabot in #91
• Bump the required group across 1 directory with 7 updates by @dependabot in #92
• Interface enhancements by @Marenz in #89
• Merge & unify running state event intervals by @Marenz in #94
• Clean up API a bit by @Marenz in #97
• Fix flakey tests by @Marenz in #99
• Widen the SDK dependency range to support 1.0.0rc1500 by @llucax in #102
• Bump black from 24.10.0 to 25.1.0 by @dependabot in #106
• Bump the required group with 6 updates by @dependabot in #105
• Bump isort from 5.13.2 to 6.0.0 by @dependabot in #107
• Redesign actor service by @Marenz in #103
• Implement merge strategy based on TYPE+TARGET by @Marenz in #98
• Support multiple target actors for one type of dispatch by @Marenz in #104
• Set cross-arch-ci timeout to 8 minutes by @Marenz in #110
• Widen frequenz-sdk dependency to v1.0.0-rc1800 by @ela-kotulska-frequenz in #109
• Bump nox from 2024.10.9 to 2025.2.9 by @dependabot in #112
• Some final preparations by @Marenz in #108
• Rename stop_dispatching to stop_managing in Dispatcher by @Marenz in #115
• Enhancements from the last PR by @Marenz in #114

New Contributors

• @ela-kotulska-frequenz made their first contribution in #109

Full Changelog: v0.5.0...v0.6.0