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

UI: Plan step numbering starts at 1. Other references start at 0. #351

Closed
wleese opened this issue Jan 16, 2018 · 4 comments
Closed

UI: Plan step numbering starts at 1. Other references start at 0. #351

wleese opened this issue Jan 16, 2018 · 4 comments

Comments

@wleese
Copy link
Contributor

wleese commented Jan 16, 2018

When using the plan view, steps are always counted starting at 1.
However, when looking at an incident or an overview of incidents, what was step 1 is actually referred to as step 0 ("Current Step: 0").

@dwang159
Copy link
Contributor

Can you give steps to repro? I think this only happens immediately after an incident is created, before the first notification is sent out (e.g. testing a plan, then immediately looking at the incident page). Here, "step 0" is a little confusing, but technically correct, since Iris hasn't started executing step 1 yet.

@wleese
Copy link
Contributor Author

wleese commented Jan 17, 2018

  • Use 'Test Plan' with any plan
  • Switch to Incidents tab
  • Note that in the list view, your incident notes "Current Step: 0"
  • Wait until iris-sender comes by, note that in the list view "Current Step: 1"

In the individual incident view, "$planname: step $n" is used.

I think the confusion is with the language usage. The current wording implies "you are at step X". Which in my understanding means "you are anywhere between the start and the end of step X".

Really, what the current step value means, and the language should reflect: "Completed step X". By using such wording it would be silly to say "Completed step 0". Instead something like "To be processed" would be more appropriate.

If we can agree on that the current language usage suggests we are at step X rather than we've completed step X, I'd suggest keeping the wording and changing the step value displayed (current/"at" vs completed step number).

Thoughts?

@dwang159
Copy link
Contributor

I'm a little confused by this. When I create a plan with multiple steps (specifically, one notification per step with wait == 1 and count == 2), things seem to behave as one would expect (i.e. "You are at step 1"). For example, after receiving the first message in step 1 but before receiving the second one, going to the incident page resulted in a "Current step: 1". Is the plan you're testing with a little more complicated?

Another nuance with plan steps is that the plan will proceed to step 2 after the first notification in step 1 completes. For example, if I have notification A in step 1 with count == 5, wait == 5 and notification B with count == 1, wait == 5, the plan will proceed to step 2 5 minutes after notification B is sent. Could this account for what you're seeing?

@wleese
Copy link
Contributor Author

wleese commented Jan 24, 2018

For example, after receiving the first message in step 1 but before receiving the second one,
going to the incident page resulted in a "Current step: 1".
Is the plan you're testing with a little more complicated?

No, this is exactly what I'm seeing with a plan similar to what you describe.
What you're saying is completely correct. My point is that it's not intuitive - because there's no such thing as a "step 0"

It's like giving someone instructions and later you ask how far along they are. Currently Iris responds:
"I'm at step 0"
Where as a more logical response would be:
"Oh sorry John, I haven't started yet" ;)

Anyway, in the end this is just a nitpick. If I fail to convince anyone then that's fine too :)

@wleese wleese closed this as completed Jan 26, 2018
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

No branches or pull requests

2 participants