Skip to content
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

FEA-2771 Add ActionV2 w/o null safety #188

Merged
merged 7 commits into from
Nov 3, 2023
Merged

Conversation

sorenthompson-wk
Copy link
Contributor

Motivation

Adding APIs in major versions introduces risk, since consumers with opened ranges could accidentally consume new APIs. So instead of exposing Action2 in w_flux 3.0, we will backpatch Action2 to a w_flux 2.x minor, so that it won't be an API addition in w_flux 3.0. This option enables us to start work on the Action migration before the w_flux major release has finished rolling out

Changes

Add Action2 and appropriate test coverage without null safety work.

Release Notes

Review

See CONTRIBUTING.md for more details on review types (+1 / QA +1 / +10) and code review process.

Please review:

QA Checklist

  • Tests were updated and provide good coverage of the changeset and other affected code
  • Manual testing was performed if needed

Merge Checklist

While we perform many automated checks before auto-merging, some manual checks are needed:

  • A Frontend Architecture member has reviewed these changes
  • There are no unaddressed comments - this check can be automated if reviewers use the "Request Changes" feature
  • For release PRs - Version metadata in Rosie comment is correct

@aviary2-wf
Copy link

Security Insights

No security relevant content was detected by automated scans.

Action Items

  • Review PR for security impact; comment "security review required" if needed or unsure
  • Verify aviary.yaml coverage of security relevant code

Questions or Comments? Reach out on Slack: #support-infosec.

Copy link
Contributor

@evanweible-wf evanweible-wf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some nits, otherwise LGTM. I'm also still working on a spike with Action0 and Action1 (for arity 0 and arity 1 since we talked about that alternative - we can compare them and see what we think.

test/action_test.dart Outdated Show resolved Hide resolved
test/action_test.dart Outdated Show resolved Hide resolved
test/action_test.dart Outdated Show resolved Hide resolved
test/action_test.dart Outdated Show resolved Hide resolved
@sorenthompson-wk sorenthompson-wk changed the title FEA-2771 Add Action2 w/o null safety FEA-2771 Add ActionV2 w/o null safety Nov 1, 2023
Copy link
Member

@todbachman-wf todbachman-wf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've just got some nits around the tests.

lib/src/action.dart Show resolved Hide resolved
test/action_test.dart Outdated Show resolved Hide resolved
test/action_test.dart Outdated Show resolved Hide resolved
test/action_test.dart Outdated Show resolved Hide resolved
test/action_test.dart Outdated Show resolved Hide resolved
test/action_test.dart Outdated Show resolved Hide resolved
test/action_test.dart Outdated Show resolved Hide resolved
test/action_test.dart Outdated Show resolved Hide resolved
test/action_test.dart Outdated Show resolved Hide resolved
todbachman-wf
todbachman-wf previously approved these changes Nov 1, 2023
todbachman-wf
todbachman-wf previously approved these changes Nov 2, 2023
evanweible-wf
evanweible-wf previously approved these changes Nov 2, 2023
@@ -153,7 +153,7 @@ class Store extends Stream<Store> with Disposable {
/// called until that future has resolved.
///
/// If the `Store` has been disposed, this method throws a [StateError].
void triggerOnActionV2<T>(Action<T> action,
void triggerOnActionV2<T>(ActionV2<T> action,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😆 this method name now works on two different levels

@sorenthompson-wk
Copy link
Contributor Author

QA +1

  • I saw the deprecation message for Action in my IDE.
  • I ran the example app of w_outline with this branch of w_flux and the example app performed as expected.

@sorenthompson-wk
Copy link
Contributor Author

@Workiva/release-management-p ready to merge

Copy link
Contributor

@rmconsole-wf rmconsole-wf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 from RM

@rmconsole5-wk rmconsole5-wk merged commit 124b42f into master Nov 3, 2023
6 checks passed
@rmconsole5-wk rmconsole5-wk deleted the FEA-2771_action2 branch November 3, 2023 21:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants