[HelpDot] detect infinite redirect cycles in redirects.csv #40434

rushatgabhane · 2024-04-18T12:56:07Z

Details

When there is a cycle in http redirect, there will be an infinite redirect loop causing the browser tab to crash.

Fixed Issues

$ https://expensify.slack.com/archives/C02QSAC6BJ8/p1713388335103579?thread_ts=1713227886.614229&cid=C02QSAC6BJ8
PROPOSAL:

Tests

Go to docs/redirects.csv
Add a cycle. eg:

a,b
b,c
c,a

Verify that you see the error message, and the cycle is printed:

Verify that no errors appear in the JS console

Offline tests

QA Steps

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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.

melvin-bot · 2024-04-18T12:56:36Z

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

MonilBhavsar

Lint and deployHelp job is failing

rushatgabhane · 2024-04-18T13:59:33Z

Lint and deployHelp job is failing

@MonilBhavsar All resolved.

rushatgabhane · 2024-04-18T14:03:19Z

DeployHelp is expected to fail because my fork doesn't have the cloudflare secrets -

MonilBhavsar · 2024-04-18T18:27:21Z

.github/scripts/detectRedirectCycle.ts

+    const backEdges: Map<string, boolean> = new Map<string, boolean>();
+
+    for (const [node] of Object.entries(adjacencyList)) {
+        if (!visited.has(node)) {


Suggested change

if (!visited.has(node)) {

if (visited.has(node)) {

continue;

}

linter does not like continue, so i had to remove it

I don't like that lint rule tbh, but this is fine for now

MonilBhavsar · 2024-04-18T18:28:23Z

.github/scripts/detectRedirectCycle.ts

+    const visited: Map<string, boolean> = new Map<string, boolean>();
+    const backEdges: Map<string, boolean> = new Map<string, boolean>();


why not make them global variables?

no particular reason. done!

rushatgabhane · 2024-04-19T13:57:12Z

@MonilBhavsar ready for review, thank you!

roryabraham

otherwise LGTM. The only other idea I had was to create a generic graph implementation in src/libs, but I don't think that's a requirement since we only have one usage for now

roryabraham · 2024-04-19T21:05:07Z

.github/scripts/detectRedirectCycle.ts

+
+    // Do a depth first search for all the neighbours. If a node is found in backedge, a cycle is detected.
+    const neighbours = adjacencyList[currentNode];
+    if (neighbours) {


Looks like you could safely remove this if statement

No, there will be nodes that have no neighbours because this is a directed graph.

eg:

urlA, urlB

Graph will look like this
urlA -> urlB

urlB has no neighbours that we can go to. So we'll try to iterate over undefined in next line

roryabraham · 2024-04-19T21:05:55Z

.github/scripts/detectRedirectCycle.ts

+    const backEdges: Map<string, boolean> = new Map<string, boolean>();
+
+    for (const [node] of Object.entries(adjacencyList)) {
+        if (!visited.has(node)) {


I don't like that lint rule tbh, but this is fine for now

roryabraham · 2024-04-19T22:20:59Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-04-19T22:21:33Z

@roryabraham looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

rushatgabhane · 2024-04-19T22:21:43Z

The only other idea I had was to create a generic graph implementation in src/libs, but I don't think that's a requirement since we only have one usage for now

yes this is the only usage, so i felt it's not necessary.
otherwise we could import a library that is battle tested, or create a generic implemention ourselves.

roryabraham · 2024-04-19T22:22:15Z

not an emergency, HelpDot preview was expected to fail: #40434 (comment)

OSBotify · 2024-04-19T22:29:16Z

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

OSBotify · 2024-04-23T23:44:13Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.64-6 🚀

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

rushatgabhane added 4 commits April 18, 2024 12:25

link verify redirect

f31b294

add csv-parse dev dependency

7b8f8b9

detect cycle in redirects.csv

a640d41

remove the found cycle in redirects.csv

104e9e4

rushatgabhane requested a review from a team as a code owner April 18, 2024 12:56

melvin-bot bot requested review from MonilBhavsar and removed request for a team April 18, 2024 12:56

add redirects

6637db8

MonilBhavsar reviewed Apr 18, 2024

View reviewed changes

rushatgabhane added 14 commits April 18, 2024 18:57

rm async

26d8d5e

fix lint

22795da

fix lint

1972309

fix lint

32c569c

fix type

22075e5

fix type

033e6c0

fix lint

e430bb0

fix lint

458bc35

make script executable

08ee704

debug:

da44110

debug:

bfe2096

provide permission

0232f44

provide permission

409b1c1

delete file

eb6c38e

add file as executable

08e2545

rushatgabhane requested a review from MonilBhavsar April 18, 2024 14:02

rushatgabhane added 2 commits April 18, 2024 19:45

fix lint

2b5015f

fix lint

3295539

remove: skip empty lines

1f2abbd

MonilBhavsar reviewed Apr 19, 2024

View reviewed changes

use global vars

188b68d

rushatgabhane requested a review from MonilBhavsar April 19, 2024 13:56

remove .html from sitemap urls for google search

307508e

roryabraham reviewed Apr 19, 2024

View reviewed changes

rushatgabhane requested a review from roryabraham April 19, 2024 22:18

roryabraham approved these changes Apr 19, 2024

View reviewed changes

roryabraham merged commit 4f430c6 into Expensify:main Apr 19, 2024

melvin-bot bot added the Emergency label Apr 19, 2024

roryabraham removed the Emergency label Apr 19, 2024

github-actions bot mentioned this pull request Apr 22, 2024

Deploy Checklist: New Expensify 2024-04-22 #40702

Closed

95 tasks

-        if (!visited.has(node)) {
+        if (visited.has(node)) {
+            continue;
+        }

		const visited: Map<string, boolean> = new Map<string, boolean>();
		const backEdges: Map<string, boolean> = new Map<string, boolean>();

[HelpDot] detect infinite redirect cycles in redirects.csv #40434

[HelpDot] detect infinite redirect cycles in redirects.csv #40434

Uh oh!

Conversation

rushatgabhane commented Apr 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Uh oh!

melvin-bot bot commented Apr 18, 2024

Uh oh!

MonilBhavsar left a comment

Choose a reason for hiding this comment

Uh oh!

rushatgabhane commented Apr 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rushatgabhane commented Apr 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rushatgabhane commented Apr 19, 2024

Uh oh!

roryabraham left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

roryabraham commented Apr 19, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Apr 19, 2024

Uh oh!

rushatgabhane commented Apr 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

roryabraham commented Apr 19, 2024

Uh oh!

OSBotify commented Apr 19, 2024

Uh oh!

OSBotify commented Apr 23, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rushatgabhane commented Apr 18, 2024 •

edited

Loading

rushatgabhane commented Apr 18, 2024 •

edited

Loading

rushatgabhane commented Apr 18, 2024 •

edited

Loading

rushatgabhane commented Apr 19, 2024 •

edited

Loading