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

chore(state) expose __none__ state #60

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

lidio601
Copy link
Contributor

@lidio601 lidio601 commented Apr 3, 2020

Motivation

I'm listening to a state onEnter event to perform some database changes when a transition happens.

I noticed that this event was triggered also just after the stm.start(initialState); line.

To cope with this event and ignore this first initial transition I checked the source code and found that this event has a stub __none__ state.

So in my code I ended up with this:

state.onEnter((change) {
  if (change.from.name != '__none__') {
    // do something
  }
});

I think this is not the best approach as I'm relying on some internal representation.
That's why I'm exposing this State.isNone getter.

Changes

  • State.isNone getter added
  • StateChange.isInitial

Release Notes

Exposed State.isNone and StateChange.isInitial to distinguish initial state change events.

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 Client Platform 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

@aviary-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
Member

@maxwellpeterson-wf maxwellpeterson-wf left a comment

Choose a reason for hiding this comment

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

@lidio601
Copy link
Contributor Author

hi there, how's going with this one?

/// bool, true if this state is None,
/// false otherwise
bool get isNone {
return name == _NONE_STATE_NAME;
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of adding isNone to the API for every State instance, could we add a static field to represent the none state and use that? Then the isInitial getter below could be:

bool get isInitial => from == State.none

Copy link
Contributor Author

@lidio601 lidio601 Jun 19, 2020

Choose a reason for hiding this comment

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

should looks better now

@evanweible-wf
Copy link
Contributor

@lidio601 if you could run dartfmt and commit the changes, we should be able to get this merged. Thanks!

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.

4 participants