[No QA] Add a worker to deploy community > help redirects #30739

coleaeason · 2023-11-01T23:11:47Z

@johnmlee101 @AndrewGable Please review. This builds a CI solution to creating redirects from communityDot pages to helpDot pages using Cloudflare bulk redirects.

The code uses PUT instead of POST so that we replace the entire list everytime, this supports deletions and replacements in the case of typos and the like -- but also prevents us from having to look for existing records everytime we add a new one.

Details

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/332465
PROPOSAL:

Tests

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 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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

OSBotify · 2023-11-01T23:13:20Z

A preview of your ExpensifyHelp changes have been deployed to https://head.helpdot.pages.dev ⚡️

melvin-bot · 2023-11-01T23:50:57Z

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

.github/CODEOWNERS

.github/scripts/createHelpRedirects.sh

.github/workflows/updateHelpDotRedirects.yml

Co-authored-by: Andrew Gable <[email protected]>

…edirects

johnmlee101

very minor questions and changes

.github/scripts/createHelpRedirects.sh

johnmlee101 · 2023-11-06T22:15:58Z

.github/scripts/createHelpRedirects.sh

+
+    STATUS=$(echo "$CHECK_RESULT" | jq -r .result.status)
+
+    # Exit on completed or failed, other options are pending or running, in both cases


We don't need to add a max retry/time limit to this, right?

I don't think so? We could but... i'm inclined to just let it run like this until it becomes a problem. Unless the Cloudflare API just never ran the job and left it queued forever, i think we will eventually exit here.

johnmlee101 · 2023-11-06T22:17:09Z

.github/workflows/updateHelpDotRedirects.yml

+  # Run on any manual trigger
+  workflow_dispatch:
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.


Nice, was about to ask about this 👍

AndrewGable

Would be great to include a description and issue link for us to look back to. Otherwise code looks good 👍

Co-authored-by: John Lee <[email protected]>

…edirects

coleaeason · 2023-11-07T17:29:22Z

@AndrewGable @johnmlee101 updated and ready for re-review

AndrewGable · 2023-11-07T18:43:41Z

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 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

Android: Native

N/A - GitHub action only

Android: mWeb Chrome

N/A - GitHub action only

iOS: Native

N/A - GitHub action only

iOS: mWeb Safari

N/A - GitHub action only

MacOS: Chrome / Safari

N/A - GitHub action only

MacOS: Desktop

N/A - GitHub action only

OSBotify · 2023-11-07T18:53:52Z

✋ 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 · 2023-11-08T08:30:25Z

🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.3.96-6 🚀

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

OSBotify · 2023-11-09T22:46:01Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.96-15 🚀

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

OSBotify · 2023-11-10T16:02:03Z

🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.3.98-0 🚀

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

OSBotify · 2023-11-14T21:55:30Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.98-5 🚀

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

coleaeason added 3 commits November 1, 2023 15:48

A working script that only supports additions

a878d79

A more thorough approach that allows deletions

12836a4

Add worker, add redirects file, fix import line based on cwd in runner

96fc10e

coleaeason requested review from AndrewGable and johnmlee101 November 1, 2023 23:11

coleaeason self-assigned this Nov 1, 2023

coleaeason added 2 commits November 1, 2023 16:14

Add infra as code owner on redirects file

863f1c4

Remove page that is in the wrong place and duplicated elsewhere

1627a69

coleaeason marked this pull request as ready for review November 1, 2023 23:50

coleaeason requested a review from a team as a code owner November 1, 2023 23:50

melvin-bot bot removed the request for review from a team November 1, 2023 23:50

coleaeason added 4 commits November 1, 2023 16:53

use infra not ring0

57de166

Update concurrency group to be unique to this worker

da796e0

Update worker name

3a902ac

Update docs path based on cwd

e0e85ed

AndrewGable reviewed Nov 2, 2023

View reviewed changes

.github/CODEOWNERS Show resolved Hide resolved

.github/scripts/createHelpRedirects.sh Show resolved Hide resolved

.github/workflows/updateHelpDotRedirects.yml Outdated Show resolved Hide resolved

coleaeason and others added 3 commits November 6, 2023 14:01

Update .github/workflows/updateHelpDotRedirects.yml

8556958

Co-authored-by: Andrew Gable <[email protected]>

Add -e

bb81e9c

Merge branch 'cole_redirects' of github.com:Expensify/App into cole_r…

96f426d

…edirects

johnmlee101 requested changes Nov 6, 2023

View reviewed changes

AndrewGable previously approved these changes Nov 6, 2023

View reviewed changes

Update .github/scripts/createHelpRedirects.sh

fffdf95

Co-authored-by: John Lee <[email protected]>

coleaeason dismissed AndrewGable’s stale review via fffdf95 November 6, 2023 22:52

coleaeason and others added 4 commits November 6, 2023 14:53

Update .github/scripts/createHelpRedirects.sh

c793f15

Co-authored-by: John Lee <[email protected]>

Strip https from source url so we match both schemes

eeb937d

Merge branch 'cole_redirects' of github.com:Expensify/App into cole_r…

616ddef

…edirects

Add a comment about the stripping of prefix

bd7ea22

AndrewGable approved these changes Nov 7, 2023

View reviewed changes

johnmlee101 approved these changes Nov 7, 2023

View reviewed changes

AndrewGable changed the title ~~Add a worker to deploy community > help redirects~~ [No QA] Add a worker to deploy community > help redirects Nov 7, 2023

AndrewGable merged commit 76a5ace into main Nov 7, 2023
16 of 17 checks passed

AndrewGable deleted the cole_redirects branch November 7, 2023 18:46

OSBotify mentioned this pull request Nov 8, 2023

Deploy Checklist: New Expensify 2023-11-06 #30929

Closed

OSBotify mentioned this pull request Nov 10, 2023

Deploy Checklist: New Expensify 2023-11-10 #31187

Closed

truph01 mentioned this pull request Oct 19, 2024

[HOLD for payment 2024-11-11] [$250] 2FA - When open the link to 'Authenticator app link' the page shows an error #51095

Closed

8 tasks

truph01 mentioned this pull request Dec 9, 2024

[$250] Login - here link in suspended account message is invalid #53668

Open

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Add a worker to deploy community > help redirects #30739

[No QA] Add a worker to deploy community > help redirects #30739

coleaeason commented Nov 1, 2023 •

edited

Loading

OSBotify commented Nov 1, 2023 •

edited

Loading

melvin-bot bot commented Nov 1, 2023

johnmlee101 left a comment

johnmlee101 Nov 6, 2023

coleaeason Nov 6, 2023

johnmlee101 Nov 6, 2023

AndrewGable left a comment

coleaeason commented Nov 7, 2023

AndrewGable commented Nov 7, 2023 •

edited

Loading

OSBotify commented Nov 7, 2023

OSBotify commented Nov 8, 2023

OSBotify commented Nov 9, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 14, 2023


		STATUS=$(echo "$CHECK_RESULT" \| jq -r .result.status)

		# Exit on completed or failed, other options are pending or running, in both cases

[No QA] Add a worker to deploy community > help redirects #30739

[No QA] Add a worker to deploy community > help redirects #30739

Conversation

coleaeason commented Nov 1, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

OSBotify commented Nov 1, 2023 • edited Loading

melvin-bot bot commented Nov 1, 2023

johnmlee101 left a comment

Choose a reason for hiding this comment

johnmlee101 Nov 6, 2023

Choose a reason for hiding this comment

coleaeason Nov 6, 2023

Choose a reason for hiding this comment

johnmlee101 Nov 6, 2023

Choose a reason for hiding this comment

AndrewGable left a comment

Choose a reason for hiding this comment

coleaeason commented Nov 7, 2023

AndrewGable commented Nov 7, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Nov 7, 2023

OSBotify commented Nov 8, 2023

OSBotify commented Nov 9, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 14, 2023

coleaeason commented Nov 1, 2023 •

edited

Loading

OSBotify commented Nov 1, 2023 •

edited

Loading

AndrewGable commented Nov 7, 2023 •

edited

Loading