[No QA][TS migration][g21] Migrate multiple Github utils by ruben-rebelo · Pull Request #38800 · Expensify/App

ruben-rebelo · 2024-03-22T12:07:44Z

Details

Migrate multiple files related with Github Utils

Fixed Issues

$#25376
$#25377
$#25378
$#25379
$#25380
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 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.

Screenshots/Videos

Android: Native

N/a

Android: mWeb Chrome

N/a

iOS: Native

N/a

iOS: mWeb Safari

N/a

MacOS: Chrome / Safari

N/a

MacOS: Desktop

N/a

…roup21

fabioh8010 · 2024-03-28T16:18:50Z

.github/actions/javascript/awaitStagingDeploys/awaitStagingDeploys.ts

    return promiseDoWhile(
-        () => !_.isEmpty(currentStagingDeploys),
-        _.throttle(
+        () => currentStagingDeploys.length,


Suggested change

() => currentStagingDeploys.length,

() => !!currentStagingDeploys.length,

Shouldn't be like this?

fabioh8010 · 2024-03-28T16:20:25Z

.github/actions/javascript/createOrUpdateStagingDeploy/createOrUpdateStagingDeploy.ts

+import type {EmptyObject} from '@src/types/utils/EmptyObject';

-async function run() {
+async function run(): Promise<Awaited<ReturnType<typeof GithubUtils.octokit.issues.create>>['data'] | void> {


Let's extract Awaited<ReturnType<typeof GithubUtils.octokit.issues.create>>['data'] to a separate type?

fabioh8010 · 2024-03-28T16:28:14Z

.github/actions/javascript/createOrUpdateStagingDeploy/createOrUpdateStagingDeploy.ts

        // Parse the data from the previous and current checklists into the format used to generate the checklist
        const previousChecklistData = GithubUtils.getStagingDeployCashData(previousChecklist);
-        const currentChecklistData = shouldCreateNewDeployChecklist ? {} : GithubUtils.getStagingDeployCashData(mostRecentChecklist);
+        const currentChecklistData: StagingDeployCashData | EmptyObject = shouldCreateNewDeployChecklist ? {} : GithubUtils.getStagingDeployCashData(mostRecentChecklist);


Suggested change

const currentChecklistData: StagingDeployCashData | EmptyObject = shouldCreateNewDeployChecklist ? {} : GithubUtils.getStagingDeployCashData(mostRecentChecklist);

const currentChecklistData: StagingDeployCashData | undefined = shouldCreateNewDeployChecklist ? undefined : GithubUtils.getStagingDeployCashData(mostRecentChecklist);

Let's remove EmptyObject from our lives 😛

fabioh8010 · 2024-03-28T16:29:10Z

.github/actions/javascript/createOrUpdateStagingDeploy/createOrUpdateStagingDeploy.ts

+                newVersionTag,
+                mergedPRs.map((value) => GithubUtils.getPullRequestURLFromNumber(value)),
+            );
+            if (stagingDeployCashBodyAndAssignees !== undefined) {


Suggested change

if (stagingDeployCashBodyAndAssignees !== undefined) {

if (stagingDeployCashBodyAndAssignees) {

fabioh8010 · 2024-03-28T16:29:40Z

.github/actions/javascript/createOrUpdateStagingDeploy/createOrUpdateStagingDeploy.ts

+                const indexOfPRInCurrentChecklist = currentChecklistData.PRList.findIndex((pr) => pr.number === prNum);
+                const isVerified = indexOfPRInCurrentChecklist >= 0 ? currentChecklistData.PRList[indexOfPRInCurrentChecklist].isVerified : false;


Suggested change

const indexOfPRInCurrentChecklist = currentChecklistData.PRList.findIndex((pr) => pr.number === prNum);

const isVerified = indexOfPRInCurrentChecklist >= 0 ? currentChecklistData.PRList[indexOfPRInCurrentChecklist].isVerified : false;

const indexOfPRInCurrentChecklist = currentChecklistData?.PRList.findIndex((pr) => pr.number === prNum) ?? -1;

const isVerified = indexOfPRInCurrentChecklist >= 0 ? currentChecklistData?.PRList[indexOfPRInCurrentChecklist].isVerified : false;

fabioh8010 · 2024-03-28T16:31:00Z

.github/actions/javascript/createOrUpdateStagingDeploy/createOrUpdateStagingDeploy.ts

-            }
+            });

            const didVersionChange = newVersionTag !== currentChecklistData.tag;


Suggested change

const didVersionChange = newVersionTag !== currentChecklistData.tag;

const didVersionChange = newVersionTag !== currentChecklistData?.tag;

fabioh8010 · 2024-03-28T16:31:18Z

.github/actions/javascript/createOrUpdateStagingDeploy/createOrUpdateStagingDeploy.ts

+                PRList.filter((pr) => pr.isVerified).map((pr) => pr.url),
+                deployBlockers.map((blocker) => blocker.url),
+                deployBlockers.filter((blocker) => blocker.isResolved).map((blocker) => blocker.url),
+                currentChecklistData.internalQAPRList.filter((pr) => pr.isResolved).map((pr) => pr.url),


Suggested change

currentChecklistData.internalQAPRList.filter((pr) => pr.isResolved).map((pr) => pr.url),

currentChecklistData?.internalQAPRList.filter((pr) => pr.isResolved).map((pr) => pr.url),

fabioh8010 · 2024-03-28T16:33:14Z

.github/actions/javascript/createOrUpdateStagingDeploy/createOrUpdateStagingDeploy.ts

            );
-            checklistBody = issueBody;
-            checklistAssignees = issueAssignees;
+            if (stagingDeployCashBodyAndAssignees !== undefined) {


Suggested change

if (stagingDeployCashBodyAndAssignees !== undefined) {

if (stagingDeployCashBodyAndAssignees) {

fabioh8010 · 2024-03-28T16:33:45Z

.github/actions/javascript/createOrUpdateStagingDeploy/createOrUpdateStagingDeploy.ts

        const {data: updatedChecklist} = await GithubUtils.octokit.issues.update({
            ...defaultPayload,
+            // eslint-disable-next-line @typescript-eslint/naming-convention
            issue_number: currentChecklistData.number,


Suggested change

issue_number: currentChecklistData.number,

issue_number: currentChecklistData?.number ?? 0,

.github/actions/javascript/getDeployPullRequestList/getDeployPullRequestList.ts

melvin-bot · 2024-04-02T13:41:33Z

@Pujan92 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 · 2024-04-02T13:43:08Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #25376 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

Beamanator

I've got a few questions and a few changes recommended, please 🙏

.github/libs/CONST.ts

.github/actions/javascript/authorChecklist/index.js

.github/actions/javascript/awaitStagingDeploys/awaitStagingDeploys.ts

.github/actions/javascript/createOrUpdateStagingDeploy/createOrUpdateStagingDeploy.ts

.github/actions/javascript/getDeployPullRequestList/getDeployPullRequestList.ts

fabioh8010 · 2024-04-03T08:28:57Z

@Beamanator Ready to review again!

Beamanator

LGTM!

Beamanator · 2024-04-03T09:13:08Z

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

OSBotify · 2024-04-03T09:21:03Z

✋ 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-08T10:54:53Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.60-13 🚀

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

ruben-rebelo and others added 15 commits March 22, 2024 12:07

[TS migration][g21] Migrate multiple github utils files

55b9f2e

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into g…

4c1e770

…roup21

fix: wip

cb175ae

fix: wip

4b7e411

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into g…

5719f9f

…roup21

fix: typecheck

0a3a188

Merge branch 'main' of github.com:ruben-rebelo/App into group21

76bcd9a

fix: run gh-actions-build

c36db27

fix: run gh-actions-build

2819878

Merge branch 'main' of github.com:ruben-rebelo/App into group21

da71a7f

fix: run gh-actions-build

b924938

fix: github actions test

5c89a97

fix: run gh-actions-build

1f85166

fix: import of core gh actions

37306f5

fix: import of github from @actions/github

884ae54

ruben-rebelo changed the title ~~[TS migration][g21] Migrate multiple Github utils~~ [No QA][TS migration][g21] Migrate multiple Github utils Mar 28, 2024

fabioh8010 reviewed Mar 28, 2024

View reviewed changes

kubabutkiewicz added 7 commits March 29, 2024 10:40

Merge branch 'main' of github.com:ruben-rebelo/App into group21

bdfc612

fix: run gh-actions-build

f606405

fix: resolve comments

d3ea94a

fix: workflow tests

ccf4749

Merge branch 'main' of github.com:ruben-rebelo/App into group21

8325ec9

fix: run gh-actions-build

b9de026

Merge branch 'main' of github.com:ruben-rebelo/App into group21

027ac4b

fabioh8010 approved these changes Apr 2, 2024

View reviewed changes

blazejkustra approved these changes Apr 2, 2024

View reviewed changes

ruben-rebelo marked this pull request as ready for review April 2, 2024 13:41

ruben-rebelo requested a review from a team as a code owner April 2, 2024 13:41

melvin-bot bot requested review from Pujan92 and removed request for a team April 2, 2024 13:41

Pujan92 approved these changes Apr 2, 2024

View reviewed changes

melvin-bot bot requested a review from Beamanator April 2, 2024 13:43

Beamanator requested changes Apr 2, 2024

View reviewed changes

kubabutkiewicz added 3 commits April 3, 2024 10:14

Merge branch 'main' of github.com:ruben-rebelo/App into group21

d0de973

fix: resolve comments

896d39b

fix: run gh-actions-build

4a0cdf6

Beamanator approved these changes Apr 3, 2024

View reviewed changes

Beamanator merged commit 9d5fef3 into Expensify:main Apr 3, 2024

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

[INCORRECT] (used to be a checklist but was incorrectly triggered) #39573

Closed

44 tasks

Beamanator mentioned this pull request Apr 4, 2024

Attempt to fix deploy script #39580

Merged

50 tasks

mountiny mentioned this pull request Apr 4, 2024

Deploy Checklist: New Expensify 2024-04-04 #39588

Closed

48 tasks

	() => currentStagingDeploys.length,
	() => !!currentStagingDeploys.length,

	const currentChecklistData: StagingDeployCashData \| EmptyObject = shouldCreateNewDeployChecklist ? {} : GithubUtils.getStagingDeployCashData(mostRecentChecklist);
	const currentChecklistData: StagingDeployCashData \| undefined = shouldCreateNewDeployChecklist ? undefined : GithubUtils.getStagingDeployCashData(mostRecentChecklist);

	if (stagingDeployCashBodyAndAssignees !== undefined) {
	if (stagingDeployCashBodyAndAssignees) {

		const indexOfPRInCurrentChecklist = currentChecklistData.PRList.findIndex((pr) => pr.number === prNum);
		const isVerified = indexOfPRInCurrentChecklist >= 0 ? currentChecklistData.PRList[indexOfPRInCurrentChecklist].isVerified : false;

	const didVersionChange = newVersionTag !== currentChecklistData.tag;
	const didVersionChange = newVersionTag !== currentChecklistData?.tag;

	currentChecklistData.internalQAPRList.filter((pr) => pr.isResolved).map((pr) => pr.url),
	currentChecklistData?.internalQAPRList.filter((pr) => pr.isResolved).map((pr) => pr.url),

	issue_number: currentChecklistData.number,
	issue_number: currentChecklistData?.number ?? 0,

Conversation

ruben-rebelo commented Mar 22, 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

Screenshots/Videos

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!

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!

Uh oh!

melvin-bot bot commented Apr 2, 2024

Uh oh!

melvin-bot bot commented Apr 2, 2024

Uh oh!

Beamanator left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fabioh8010 commented Apr 3, 2024

Uh oh!

Beamanator left a comment

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

OSBotify commented Apr 3, 2024

Uh oh!

OSBotify commented Apr 8, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

ruben-rebelo commented Mar 22, 2024 •

edited

Loading

Beamanator commented Apr 3, 2024 •

edited

Loading