[HOLD for payment 2023-06-02] [$1000] The ordering of the last two keyboard shortcuts is not consistent across different browsers

[kavimuru]

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

---

Action Performed:

1. Open the app in Chrome
2. Press CMD + J to open the keyboard shortcuts dialog
3. Observe the CMD + J shortcut is in the last row
4. Open the app in Safari
5. Press CMD + J to open the keyboard shortcuts dialog
6. Observe the CMD + J shortcut is in the second last row

Expected Result:

The ordering of the keyboard shortcuts is consistent across different browsers.

Actual Result:

The ordering of the keyboard shortcuts is not consistent across different browsers.

Workaround:

Can the user still use Expensify without this being fixed?

Yes.

Have you informed them of the workaround?

No actual user cares about this.

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android / native
• Android / Chrome
• iOS / native
• iOS / Safari
• MacOS / Chrome / Safari
• MacOS / Desktop

Version Number: 1.3.11-2
Reproducible in staging?: y
Reproducible in production?: y
If this was caught during regression testing, add the test name, ID and link from TestRail:
Email or phone of affected tester (no customers):
Logs: https://stackoverflow.com/c/expensify/questions/4856
Notes/Photos/Videos: Any additional supporting documentation

Screen.Recording.2023-05-05.at.6.56.06.PM.mov

Uploading Recording #182.mp4…

Expensify/Expensify Issue URL:
Issue reported by: @adeel0202
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1683295067148079

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01cbc0a7bdb5971dcf
• Upwork Job ID: 1658160595766345728
• Last Price Increase: 2023-05-15

[melvin-bot]

Triggered auto assignment to @sonialiap (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

[melvin-bot]

Bug0 Triage Checklist (Main S/O)

• This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
• This bug is not a duplicate report (check E/App issues and #expensify-bugs)
  • If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
• This bug is reproducible using the reproduction steps in the OP. S/O
  • If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
  • If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
• This issue is filled out as thoroughly and clearly as possible
  • Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
• I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

[allroundexperts]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Keyboard shortcuts modal does not display the shortcuts in a fixed order.

What is the root cause of that problem?

This is a side effect of a bigger problem. We're showing the shortcuts in the modal depending if they've been subscribed to or not. If they are subscribed, we're saving those in a static file here. This approach has multiple issues:

1. If a listener gets subscribed to AFTER the modal has loaded, it never shows up because the KeyboardShortcutsModal doesn't re-render since the documentedShortcuts is not stored in a state.
2. The order of the listeners, as they are subscribed, can't be guaranteed across browsers.

What changes do you think we should make in order to solve the problem?

We should use a Context that exposes the functions in this file. Using it, will cause our model to re-render whenever a shortcut gets subscribed.

The Context should also return the subscribed shortcuts in a sorted order such that the order always remains the same.

What alternative solutions did you explore? (Optional)

We can just sort the results in this file if using a context is not an option.

[kavimuru]

Keyboard shortcut bugs are not in scope. Closing the bug as per this comment

[sonialiap]

Issue reopened per this comment and the following ones

[melvin-bot]

Triggered auto assignment to @marcaaron (Engineering), see https://stackoverflow.com/c/expensify/questions/4319 for more details.

[marcaaron]

I can't think of a reason why the order of these things would change. I have some suggestions about the clarity of the issue description.

The positioning of the keyboard shortcuts is consistent across different browsers

I would change "positioning" to "ordering". I spent a while looking at the modal and wondering why we care about it's "position" changing a few pixels. Then saw it. Which maybe gives an idea about how urgent this issue is :D

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~01cbc0a7bdb5971dcf

[melvin-bot]

Current assignee @sonialiap is eligible for the External assigner, not assigning anyone new.

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @eVoloshchak (External)

[melvin-bot]

Current assignee @marcaaron is eligible for the External assigner, not assigning anyone new.

[melvin-bot]

📣 @eVoloshchak You have been assigned to this job by @marcaaron!
Please apply to this job in Upwork and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Keep in mind: Code of Conduct | Contributing 📖

[melvin-bot]

📣 @allroundexperts You have been assigned to this job by @marcaaron!
Please apply to this job in Upwork and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Keep in mind: Code of Conduct | Contributing 📖

[allroundexperts]

PR created #19305

[melvin-bot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 1.3.18-2 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• fix: consistent order of keyboard shortcuts #19305

If no regressions arise, payment will be issued on 2023-06-02. 🎊

After the hold period is over and BZ checklist items are completed, please complete any of the applicable payments for this issue, and check them off once done.

• External issue reporter
• Contributor that fixed the issue
• Contributor+ that helped on the issue and/or PR

As a reminder, here are the bonuses/penalties that should be applied for any External issue:

• Merged PR within 3 business days of assignment - 50% bonus
• Merged PR more than 9 business days after assignment - 50% penalty

[melvin-bot]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@eVoloshchak / @allroundexperts] The PR that introduced the bug has been identified. Link to the PR:
• [@eVoloshchak / @allroundexperts] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:
• [@eVoloshchak / @allroundexperts] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:
• [@eVoloshchak / @allroundexperts] Determine if we should create a regression test for this bug.
• [@eVoloshchak / @allroundexperts] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.
• [@sonialiap] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[sonialiap]

Not overdue, will issue payment on June 2

[eVoloshchak]

• The PR that introduced the bug has been identified. Link to the PR: Added Keyboard shortcuts modal #6112

• The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment: https://github.com/Expensify/App/pull/6112/files#r1214592096

• A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion: This is a visual bug, not much we can improve besides paying more attention during the PR review. This can be reproduced when using desktop Safari, but it's not a part of the standard review process

• Determine if we should create a regression test for this bug.
  Is it easy to test for this bug? Yes
  Is the bug related to an important user flow? No
  Is it an impactful bug? No
  Don't think a regression test is needed here, the bug is very minor

[sonialiap]

@adeel0202 offer sent for reporting issue - paid
@allroundexperts offer sent for the fix + 3 day merge bonus - paid
@eVoloshchak offer sent for the review + 3 day merge bonus - paid

[sonialiap]

Whoops, @eVoloshchak the Upwork job got closed early 🤦 recreating it and sending you a new offer

Edit: Sent

[eVoloshchak]

@sonialiap, accepted, thanks!

[sonialiap]

Everyone has been paid ✅