Skip to content

feat: support new upgrade execution for modules #3412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

Julusian
Copy link
Member

@Julusian Julusian commented May 3, 2025

Implements bitfocus/companion-module-base#118

This has turned out to be a more complex state machine than I initially expected, so I am wondering if this should be held back for 4.1 (it could still be reverted in the module lib, so that the other changes can be released)

This api change is done so that how the options are stored can be different from how they are used, without needing modules to be the ones doing the parsing.

This is a precursor to #2345, which I expect will build on this by further by changing the structure of the options object that companion and upgrade scripts use, but not for action/feedback execution or subscribe/unsubscribe calls.
At this stage, that means we can pre-parse variables in textinput fields (only those with the useVariables flag set for now) before passing the objects off to the modules.

This should be non-breaking for modules, and only those using the updated base lib will hit the new flows, so any bugs found will have limited impact.

TODO

  • try it with a module
  • thoroughly test it with a module
  • write some unit tests?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant