Fix distance waypoint ordering #29843

neil-marcellini · 2023-10-18T03:36:57Z

Details

The changes here are pretty simple and are fixing things that worked before. First, when there were 10+ waypoints they would get out of order within getValidWaypoints because we were sorting them as strings. That regression is described here. Second, the parameters of a function were changed without updating this use. That regression is noted here.

Fixed Issues

$ #29621
PROPOSAL: N/A

Tests

Test waypoint ordering

Log in with any account
create a workspace if needed
Click the green plus and Request money
Select the distance tab
Enter 12 waypoints total (or use the shortcut below), and make note of the order
Click next
Select a workspace
Click request
Open the expense report
Open the distance request report
Click on the route image
Verify the distance request eReceipt is displayed
Verify the route image is displayed
Verify that the waypoints are in the same order as when creating the request

Note: since it's a pain to enter all those waypoints here's a shortcut.

Open the console and switch to the distance tab
Make sure all log levels are shown
Seach for transactions_ and copy the id number
Paste the following into the JS console to set all the waypoints. Replace the id with the one you copied.

Onyx update

Onyx.merge('transactions_3361518241221798589', {
    comment: {
        waypoints: {
            "waypoint0": {
                "lat": 37.9004816,
                "lng": -122.6444263,
                "address": "Stinson Beach, CA 94970, USA"
            },
            "waypoint1": {
                "lat": 37.8652634,
                "lng": -122.3111483,
                "address": "Berkeley Marina, Berkeley, CA, USA"
            },
            "waypoint2": {
                "lat": 37.8064291,
                "lng": -122.4506915,
                "address": "Crissy Field East Beach, San Francisco, CA 94129, USA"
            },
            "waypoint3": {
                "lat": 37.8727428,
                "lng": -122.4554066,
                "address": "Tiburon, CA 94920, USA"
            },
            "waypoint4": {
                "lat": 37.9445266,
                "lng": -122.5086664,
                "address": "Larkspur, CA 94939, USA"
            },
            "waypoint5": {
                "lat": 37.8974259,
                "lng": -122.4885845,
                "address": "Blackies Pasture, Tiburon, CA 94920, USA"
            },
            "waypoint6": {
                "lat": 36.6002378,
                "lng": -121.8946761,
                "address": "Monterey, CA, USA"
            },
            "waypoint7": {
                "lat": 37.8309974,
                "lng": -122.2919998,
                "address": "4400 Shellmound St, Emeryville, CA 94608, USA"
            },
            "waypoint8": {
                "lat": 37.9435872,
                "lng": -122.5405003,
                "address": "800 Magnolia Ave, Larkspur, CA 94939, USA"
            },
            "waypoint9": {
                "lat": 37.6191671,
                "lng": -122.3816108,
                "address": "San Francisco, CA 94128, USA"
            },
            "waypoint10": {
                "lat": 37.7156188,
                "lng": -122.2143079,
                "address": "1 Airport Dr, Oakland, CA 94621, USA"
            },
            "waypoint11": {
                "lat": 37.7935724,
                "lng": -122.483638,
                "address": "Baker Beach, San Francisco, CA, USA"
            }
        }
    }
});

Verify that no errors appear in the JS console

Offline tests

Go offline
Create the request as described above
Open the eReceipt
Verify that route image shows as pending
Go online
Verify that the waypoints are in the same order as when creating the request

QA Steps

Same as tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

I only tested on Mac web because the changes are very small and platform independent.

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Online

web1080.mov

Offline

offline1080.mov

MacOS: Desktop

cloudflare-workers-and-pages · 2023-10-19T00:38:26Z

Deploying with Cloudflare Pages

Latest commit:	`6013550`
Status:	✅ Deploy successful!
Preview URL:	https://d13853a1.helpdot.pages.dev
Branch Preview URL:	https://neil-waypoint-ordering.helpdot.pages.dev

View logs

melvin-bot · 2023-10-19T01:25:31Z

@situchan Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

grgia

LGTM

situchan · 2023-10-19T07:25:52Z

src/components/DistanceEReceipt.js

@@ -31,7 +31,7 @@ const defaultProps = {
 function DistanceEReceipt({transaction}) {
    const {translate} = useLocalize();
    const {isOffline} = useNetwork();
-    const {thumbnail} = TransactionUtils.hasReceipt(transaction) ? ReceiptUtils.getThumbnailAndImageURIs(transaction.receipt.source, transaction.filename) : {};
+    const {thumbnail} = TransactionUtils.hasReceipt(transaction) ? ReceiptUtils.getThumbnailAndImageURIs(transaction) : {};


Please pull main. I see that this was already fixed in #29863

Ok, but I don't think that prevents you from reviewing right? Will you please review today?

situchan · 2023-10-19T20:37:52Z

Not sure what's happening but I am not able to submit distance request on latest main.
Request button is disabled

Screen.Recording.2023-10-20.at.2.34.09.AM.mov

Edit: I confirmed that #27547 caused above regression. Commented there

I tested after reverting that PR locally and confirmed working well

situchan · 2023-10-19T20:55:29Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

OSBotify · 2023-10-20T09:49:47Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

neil-marcellini · 2023-10-20T17:33:36Z

Thanks for helping me push this one through guys!

OSBotify · 2023-10-20T21:37:39Z

🚀 Deployed to staging by https://github.com/grgia in version: 1.3.88-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-10-23T04:49:51Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.88-11 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

Waypoint indexes must sort as numbers vs string

2715f09

neil-marcellini self-assigned this Oct 18, 2023

neil-marcellini added 2 commits October 18, 2023 17:37

style

1aeb416

Fix eReceipt image by using new param

839c59b

neil-marcellini changed the title ~~Fix waypoint ordering~~ Fix distance waypoint ordering and eReceipt image Oct 19, 2023

neil-marcellini marked this pull request as ready for review October 19, 2023 01:25

neil-marcellini requested a review from a team as a code owner October 19, 2023 01:25

melvin-bot bot requested review from situchan and removed request for a team October 19, 2023 01:25

grgia approved these changes Oct 19, 2023

View reviewed changes

situchan reviewed Oct 19, 2023

View reviewed changes

Merge branch 'main' into neil-waypoint-ordering

6013550

situchan mentioned this pull request Oct 19, 2023

Update LHN/chat header to handle displayName not being set #27547

Merged

67 tasks

grgia changed the title ~~Fix distance waypoint ordering and eReceipt image~~ Fix distance waypoint ordering Oct 20, 2023

grgia merged commit 262c8d0 into main Oct 20, 2023
14 checks passed

grgia deleted the neil-waypoint-ordering branch October 20, 2023 09:43

OSBotify mentioned this pull request Oct 20, 2023

Deploy Checklist: New Expensify 2023-10-20 #30108

Closed

melvin-bot bot mentioned this pull request Oct 23, 2023

[HOLD for payment 2023-10-30] [$250] Distance - Waypoints are not correctly ordered in generated eReceipt #29621

Closed

7 tasks

lukemorawski mentioned this pull request Oct 25, 2023

Update LHN/chat header to handle displayName not being set - MR participants list fix #30342

Merged

67 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix distance waypoint ordering #29843

Fix distance waypoint ordering #29843

neil-marcellini commented Oct 18, 2023 •

edited

Loading

cloudflare-workers-and-pages bot commented Oct 19, 2023 •

edited

Loading

melvin-bot bot commented Oct 19, 2023

grgia left a comment

situchan Oct 19, 2023

neil-marcellini Oct 19, 2023

situchan Oct 19, 2023

situchan commented Oct 19, 2023 •

edited

Loading

situchan commented Oct 19, 2023 •

edited

Loading

OSBotify commented Oct 20, 2023

neil-marcellini commented Oct 20, 2023

OSBotify commented Oct 20, 2023

OSBotify commented Oct 23, 2023

Fix distance waypoint ordering #29843

Fix distance waypoint ordering #29843

Conversation

neil-marcellini commented Oct 18, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

cloudflare-workers-and-pages bot commented Oct 19, 2023 • edited Loading

Deploying with Cloudflare Pages

melvin-bot bot commented Oct 19, 2023

grgia left a comment

Choose a reason for hiding this comment

situchan Oct 19, 2023

Choose a reason for hiding this comment

neil-marcellini Oct 19, 2023

Choose a reason for hiding this comment

situchan Oct 19, 2023

Choose a reason for hiding this comment

situchan commented Oct 19, 2023 • edited Loading

situchan commented Oct 19, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Oct 20, 2023

neil-marcellini commented Oct 20, 2023

OSBotify commented Oct 20, 2023

OSBotify commented Oct 23, 2023

neil-marcellini commented Oct 18, 2023 •

edited

Loading

cloudflare-workers-and-pages bot commented Oct 19, 2023 •

edited

Loading

situchan commented Oct 19, 2023 •

edited

Loading

situchan commented Oct 19, 2023 •

edited

Loading