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

Map panning fix #25977

Closed

Conversation

gegham-khachatryan
Copy link
Contributor

@gegham-khachatryan gegham-khachatryan commented Aug 25, 2023

Details

Fixed Issues

$ #25732

PROPOSAL: #25732 (comment)

Tests

  1. Click the "+" icon next to the chat message text field. Click "Request Money" on the pop up menu that appears.
  2. Check "Distance" tab on the Right Hand Panel that appears
  3. Click the "Start" item from the list of waypoints.
  4. In the text field that appears in the next screen, type "88 Kearny Street". Click the first option "88 Kearny Street, San Francisco, CA, USA" that appears.
  5. Map camera flied to selected address where marker is visible.
  6. Click Add Step button
  7. Click on new added step
  8. In the text field that appears in the next screen, type "Golden Gate Park". Click the first option "Golden Gate Pkwy, Naples, FL, USA" that appears.
  9. Verify that the 2 markers are on the map and camera moved to show both on the screen.
  10. Added Finish step
  11. Verify that the distance was drawn as expected.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Click the "+" icon next to the chat message text field. Click "Request Money" on the pop up menu that appears.
  2. Check "Distance" tab on the Right Hand Panel that appears
  3. Click the "Start" item from the list of waypoints.
  4. In the text field that appears in the next screen, type "88 Kearny Street". Click the first option "88 Kearny Street, San Francisco, CA, USA" that appears.
  5. Map camera flied to selected address where marker is visible.
  6. Click Add Step button
  7. Click on new added step
  8. In the text field that appears in the next screen, type "Golden Gate Park". Click the first option "Golden Gate Pkwy, Naples, FL, USA" that appears.
  9. Verify that the 2 markers are on the map and camera moved to show both on the screen.
  10. Added Finish step
  11. Verify that the distance was drawn as expected.
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Web.-.Screen.Recording.2023-08-26.at.09.52.07.mov
Mobile Web - Chrome
Web.Mobile.Chrome.-.iPhone.14.Pro.MP4
Mobile Web - Safari
Web.Mobile.Safari.-.Simulator.Screen.Recording.-.iPhone.SE.3rd.generation.-.2023-08-26.at.09.39.49.mp4
Desktop
Screen.Recording.2023-08-26.at.10.28.32.mov
iOS
Simulator.Screen.Recording.-.iPhone.SE.3rd.generation.-.2023-08-26.at.00.58.04.mp4
Android
Screen.Recording.2023-08-26.at.16.34.28.mov

Added new props to avoid introducing unnecessary dependencies ('@react-navigation/native') to the 'react-native-x-maps' library.
@gegham-khachatryan gegham-khachatryan requested a review from a team as a code owner August 25, 2023 21:03
@melvin-bot melvin-bot bot removed the request for review from a team August 25, 2023 21:03
@melvin-bot
Copy link

melvin-bot bot commented Aug 25, 2023

@allroundexperts 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]

@melvin-bot melvin-bot bot requested a review from allroundexperts August 25, 2023 21:03
@github-actions
Copy link
Contributor

github-actions bot commented Aug 25, 2023

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@allroundexperts
Copy link
Contributor

Hi @gegham-khachatryan!
Just a heads up. You're required to check all the checkboxes in the checklist. Also, you need to test and upload screen recordings of all of the platforms (not just iOS). Please sign the CLA as well!

@gegham-khachatryan
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@allroundexperts
Copy link
Contributor

allroundexperts commented Aug 26, 2023

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
Screen.Recording.2023-09-01.at.2.30.23.AM.mov
Mobile Web - Chrome
Screen.Recording.2023-09-01.at.2.48.03.AM.mov
Mobile Web - Safari
Screen.Recording.2023-09-01.at.2.37.04.AM.mov
Desktop
Screen.Recording.2023-09-01.at.3.07.59.AM.mov
iOS
Screen.Recording.2023-09-01.at.2.33.23.AM.mov
Android
Screen.Recording.2023-09-01.at.3.03.36.AM.mov

@gegham-khachatryan
Copy link
Contributor Author

gegham-khachatryan commented Aug 26, 2023

Hi @gegham-khachatryan! Just a heads up. You're required to check all the checkboxes in the checklist. Also, you need to test and upload screen recordings of all of the platforms (not just iOS). Please sign the CLA as well!

Hi @allroundexperts Testing done, screen recordings attached.

@hayata-suenaga
Copy link
Contributor

is this one good to go once this PR is merged?

@allroundexperts
Copy link
Contributor

We'll still need to do a final round of testing IMO.

@melvin-bot
Copy link

melvin-bot bot commented Aug 30, 2023

Hey, I noticed you changed some webpack configuration files. This can break production builds. Did you remember to run a production build locally to verify they still work?

@neil-marcellini
Copy link
Contributor

I added #25977 to the fixed issues. @gegham-khachatryan Would you please include a test a video showing that it's solved?

@gegham-khachatryan
Copy link
Contributor Author

@neil-marcellini screen recordings here #25977 (comment)

@hayata-suenaga
Copy link
Contributor

@gegham-khachatryan is this ready for review?

@gegham-khachatryan
Copy link
Contributor Author

@gegham-khachatryan is this ready for review?

Yes @hayata-suenaga It's ready. I fixed also regression issue.

@allroundexperts
Copy link
Contributor

Thanks. Starting the testing again.

@JmillsExpensify
Copy link

How's testing going?

@allroundexperts
Copy link
Contributor

Good so far!

@gegham-khachatryan Can you make sure that your commits are signed?

This is causing a check to fail.

@gegham-khachatryan
Copy link
Contributor Author

Good so far!

@gegham-khachatryan Can you make sure that your commits are signed?

This is causing a check to fail.
@allroundexperts It seems not 😏 Is there any way to sign them?

@allroundexperts
Copy link
Contributor

Take a look at this guide.

Comment on lines +24 to +36
id="route"
type="geojson"
data={{
type: 'Feature',
properties: {},
geometry: {
type: 'LineString',
coordinates,
},
}}
>
<Layer
id="route"
Copy link
Member

Choose a reason for hiding this comment

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

Use different ids for layer and source and keep these the same as native varient.

Technically, we don't need to pass these ids. given that we are not using this our logic and lib will assign default ones.

<Layer
id="route"
type="line"
source="route"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
source="route"

Beacuse it is nested in a Source so let's remove it for less confusion.

Comment on lines +26 to +33
data={{
type: 'Feature',
properties: {},
geometry: {
type: 'LineString',
coordinates,
},
}}
Copy link
Member

Choose a reason for hiding this comment

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

Better to move this data in mapView utils.ts file as a function which takes coordinates as parameter.

Copy link
Member

Choose a reason for hiding this comment

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

let's rename it to index.tsx. This is also used for desktop right? It is good to follow existing patterns.

Copy link
Member

Choose a reason for hiding this comment

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

Rename it to index.native.tsx.

return (
<View style={style}>
<Mapbox.MapView
style={{flex: 1}}
Copy link
Member

Choose a reason for hiding this comment

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

No line styles , use Styles.flex1

map.fitBounds([northEast, southWest], {padding: mapPadding});
}, [waypoints, mapRef, mapPadding]);

useImperativeHandle(
Copy link
Member

Choose a reason for hiding this comment

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

Same here we can pass type parameters.

return;
}

if (waypoints.length === 1) {
Copy link
Member

Choose a reason for hiding this comment

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

Please add comment for explanation.

src/components/MapView/MapView.web.tsx Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

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

Please create a child folder Direction in Mapview and then create this file as index.tsx. for native file, name would be index.native.tsx

@parasharrajat
Copy link
Member

When we select a very long route, no path line is shown. It might be fine.

Screenshot 2023-09-01 at 3 25 47 PM

@parasharrajat
Copy link
Member

parasharrajat commented Sep 1, 2023

I added the last stop to a far place in the US and Mapbox threw a tile load error. Technically, this is out of our hands.

Bug: Map stopped responding after tile load error.

Steps:

  1. Add three points in US single state.
  2. Add last stop to somewhere in India.
  3. If load error is shown, try deleting waypoints and observe that the map does not pan anymore.
Screenshot 2023-09-01 at 3 28 17 PM

@hayata-suenaga
Copy link
Contributor

When we select a very long route, no path line is shown. It might be fine.

yes it's fine 👍 not a blocker

Add three points in US single state.
Add last stop to somewhere in India.

No one drives from the US to India 😅 It's fine

@hayata-suenaga
Copy link
Contributor

@gegham-khachatryan please urgently address the review comments

@allroundexperts @gegham-khachatryan I think all review comments right now are not blocker. If the CI tests pass, I think it's good to merge. What do you think?

We can address all these review comments in a follow up PR

@allroundexperts
Copy link
Contributor

No one drives from the US to India 😅 It's fine

But people do travel by air. Would that mean that they'll not be able to refund there ticket?

@allroundexperts
Copy link
Contributor

Sounds good to me @hayata-suenaga. Also, I think we're increasing scope of this PR by keep on adding new things to it. Would be best to create a followup PR.

@hayata-suenaga
Copy link
Contributor

But people do travel by air. Would that mean that they'll not be able to refund there ticket?

This distance request is mainly to reimburse expenses for gas when people travel by car

Sounds good to me @hayata-suenaga. Also, I think we're increasing scope of this PR by keep on adding new things to it. Would be best to create a followup PR.

I agree 👍

@hayata-suenaga
Copy link
Contributor

@gegham-khachatryan

Screenshot 2023-09-01 at 7 33 27 AM

@gegham-khachatryan
Copy link
Contributor Author

@gegham-khachatryan please urgently address the review comments

@allroundexperts @gegham-khachatryan I think all review comments right now are not blocker. If the CI tests pass, I think it's good to merge. What do you think?

We can address all these review comments in a follow up PR

Sure, @hayata-suenaga, I'll review the comments. I'm not sure if it's a good time to implement @parasharrajat's recommendations.

@gegham-khachatryan
Copy link
Contributor Author

@gegham-khachatryan

Screenshot 2023-09-01 at 7 33 27 AM

Fixed. I missed import during conflict resolution

@gegham-khachatryan
Copy link
Contributor Author

@allroundexperts I cannot sign previous commits. I would greatly appreciate it if you could assist me in doing so.

@hayata-suenaga
Copy link
Contributor

yes let's open another PR to implement @parasharrajat's suggestions

@allroundexperts
Copy link
Contributor

allroundexperts commented Sep 1, 2023

@allroundexperts I cannot sign previous commits. I would greatly appreciate it if you could assist me in doing so.

@gegham-khachatryan I would use something like git rebase -S -i HEAD~14

Lemme know if this works.

PS: I took this from https://stackoverflow.com/questions/13043357/git-sign-off-previous-commits

@hayata-suenaga
Copy link
Contributor

@gegham-khachatryan ⬆️ 😃

@parasharrajat
Copy link
Member

So I understand that no one will travel from India to the US but that was just a step to reproduce the issue. The main issue is that afterward when we add/remove waypoints in the US itself. The map does not work. Due to an error, it stops functioning.

We should definitely fix my suggestions as there are some architectural gaps which break our standards. It is fine to do this in follow-up.

@gegham-khachatryan
Copy link
Contributor Author

@allroundexperts I looks impossible 😃 need to solve 463 conflicts, I don't know why)) I can create PR inside my fork, merge with squash, and open new PR with single commit to Expensify/main

@allroundexperts
Copy link
Contributor

@allroundexperts I looks impossible 😃 need to solve 463 conflicts, I don't know why)) I can create PR inside my fork, merge with squash, and open new PR with single commit to Expensify/main

@hayata-suenaga Would that work? cc @parasharrajat since you're the more experienced here.

@parasharrajat
Copy link
Member

Yeah, merge with squash is fine. let's try that. It is helpful for the future to keep the original PR where the discussion happened so I won't suggest creating a new one.

…ning-fix

# Conflicts:
#	src/components/DistanceRequest.js
@allroundexperts allroundexperts mentioned this pull request Sep 1, 2023
59 tasks
@hayata-suenaga
Copy link
Contributor

@gegham-khachatryan we have another set of ESLint issues now 😓

@gegham-khachatryan
Copy link
Contributor Author

@hayata-suenaga #26500
New PR opened. Lint errors fixed

@neil-marcellini
Copy link
Contributor

Closed in favor of the new PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants