[HOLD for payment 2023-05-05] [$1000] Workspace list sorting order breaks if the name starts with lower case alphabet

[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
2. Open settings
3. Open workspaces
4. Add new workspace with first letter as small

Expected Result:

App should either auto capitalize first letter or should sort alphabetically considering both workspaces with capital first letter and workspaces with small first letter

Actual Result:

Sorting breaks if workspace list has both names with capital first letter and small first letter

Workaround:

unknown

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.2.94-0
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

sorting.break.issue.mp4

Expensify/Expensify Issue URL:
Issue reported by: @dhanashree-sawant
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1680598452709389

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01230caf1a05f03e9c
• Upwork Job ID: 1648184589918076928
• Last Price Increase: 2023-04-25

[MelvinBot]

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

[MelvinBot]

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

[MelvinBot]

@JmillsExpensify Eep! 4 days overdue now. Issues have feelings too...

[MelvinBot]

@JmillsExpensify Eep! 4 days overdue now. Issues have feelings too...

[JmillsExpensify]

I think this is more accurately a feature. Going to post in the linked thread.

[MelvinBot]

@JmillsExpensify Eep! 4 days overdue now. Issues have feelings too...

[JmillsExpensify]

Based on the discussion in Slack, I'm going to add the external label and get this issue moving again. Many apologies for the delay!

[MelvinBot]

Job added to Upwork: https://www.upwork.com/jobs/~01230caf1a05f03e9c

[MelvinBot]

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

[MelvinBot]

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

[dukenv0307]

Proposal

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

Workspace list sorting order breaks if the name starts with lower case alphabet

What is the root cause of that problem?

We are sorting workspace by the original name

App/src/pages/workspace/WorkspacesListPage.js

Line 134 in 56c27de

.sortBy(policy => policy.title)

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

We should change the workspace's name to lowercase before sorting like this

 .sortBy(policy => policy.title.toLowerCase())

Optional: For consistency, we also should update the same in here:

App/src/pages/settings/InitialSettingsPage.js

Line 154 in 56c27de

.sortBy(policy => policy.name)

What alternative solutions did you explore? (Optional)

NA

Result

[PrashantMangukiya]

Proposal

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

Workspace list sorting order breaks if the name starts with lower case alphabet chars.

What is the root cause of that problem?

Workspace render via this code block

App/src/pages/workspace/WorkspacesListPage.js

Lines 191 to 193 in aa1e2ed

	<ScrollView style={styles.flex1}>
	{_.map(workspaces, (item, index) => this.getMenuItem(item, index))}
	</ScrollView>

We can see at line 192 there is not any sorting done on workspace list. This is the root cause of the problem.

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

We have to sort workspace by title as shown below.

<ScrollView style={styles.flex1}> 
   {_.map(_.sortBy(workspaces, value => value.title.toLowerCase()), (item, index) => this.getMenuItem(item, index))}
</ScrollView> 

It will solve problem i.e. Sort workspace by title no matter capital or small letter in title. As shown in results.

What alternative solutions did you explore? (Optional)

None.

Results

Workspace.mov

[MelvinBot]

Triggered auto assignment to @madmax330 (External), see https://stackoverflow.com/c/expensify/questions/7972 for more details.

[Pujan92]

Proposal

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

Workspaces list sorting order incorrectly which places the workspaces with a small first letter at the bottom

What is the root cause of that problem?

Currently, the sort which is applied to the workspaces list is case-sensitive which causes this issue.

App/src/pages/workspace/WorkspacesListPage.js

Line 134 in 313c575

.sortBy(policy => policy.title)

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

We should apply lowerCase(policy.title.toLowerCase()) to workspace title to make it case-insensitive while sorting the list.

App/src/pages/workspace/WorkspacesListPage.js

Line 134 in 313c575

.sortBy(policy => policy.title)

[MelvinBot]

@JmillsExpensify @madmax330 @eVoloshchak this issue was created 2 weeks ago. Are we close to approving a proposal? If not, what's blocking us from getting this issue assigned? Don't hesitate to create a thread in #expensify-open-source to align faster in real time. Thanks!

[madmax330]

@eVoloshchak have you had a chance to look at the proposals? I think @dukenv0307's proposal is good, thoughts?

[MelvinBot]

📣 It's been a week! Do we have any satisfactory proposals yet? Do we need to adjust the bounty for this issue? 💸

[MelvinBot]

📣 @dukenv0307 You have been assigned to this job by @madmax330!
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 📖

[dukenv0307]

@eVoloshchak @madmax330 The PR is ready for review

[MelvinBot]

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

[MelvinBot]

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

• Fix: Convert workspace name to lower case before sort #18008

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

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

[MelvinBot]

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] The PR that introduced the bug has been identified. Link to the PR:
• [@eVoloshchak] 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] 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] Determine if we should create a regression test for this bug.
• [@eVoloshchak] 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.
• [@JmillsExpensify] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[JmillsExpensify]

Alright, with the PR on production, let's summarize where we're at for payments. This PR is eligible for a 50% bonus, so that means we have the following.

• Issue reporter: @dhanashree-sawant $250
• Contributor: @dukenv0307 $1,500
• Contributor+: @eVoloshchak $1,500

The Upwork link is here: https://www.upwork.com/jobs/~01230caf1a05f03e9c. @dukenv0307 would you mind applying or sharing your Upwork profile?

[JmillsExpensify]

Then @eVoloshchak let's get the BZ checklist kicked off ahead of the regression period passing. Thank you all!

[dukenv0307]

@JmillsExpensify I've applied, thanks!

[eVoloshchak]

• The PR that introduced the bug has been identified. Link to the PR: Workspaces list #11784

• 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: Workspaces list #11784 (comment)

• 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: I dpn't think additionlal steps are needed, it's a standart practise we're using throughout the app, it was just missed during the initial implementation of WorkspacesListPage

• 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? (For example, adding a bank account)

  No

  Is it an impactful bug?

  No

  I think the regression test isn't necessary in this case, the bug has a very low impact

[JmillsExpensify]

Thanks for all those. I agree with that and that a regression test doesn't seem necessary.

[JmillsExpensify]

Then all contributors have been hired at this point, so we're down to waiting for the regression period to end in a couple of days. I'll pay out the relevant bonuses when issuing final payment. Stay tuned until then!

[madmax330]

Still waiting on payment

[JmillsExpensify]

All contributors paid out and no regression test required. Closing!