[No QA][TS migration] Migrate postTestBuildComment to typescript by ruben-rebelo · Pull Request #37027 · Expensify/App

ruben-rebelo · 2024-02-21T15:53:08Z

Details

[TS migration] Migrate *postTestBuildComment to TypeScript

Fixed Issues

$ #25296
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console
Run postTestBuildComment unit test should run successfully

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console

Same as in the Tests section.

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 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

kubabutkiewicz · 2024-02-22T08:31:04Z


 const mockGetInput = jest.fn();
-const mockCreateComment = jest.fn();
+const createCommentMock = jest.spyOn(GithubUtils, 'createComment');


why this is changed?

This was changed because we couldn't assign a jest.mock into GithubUtils.createComment, this way we mock the createComment correctly and avoid TS errors.

kubabutkiewicz · 2024-02-22T08:31:58Z

 :eyes: [View the workflow run that generated this build](https://github.com/Expensify/App/actions/runs/1234) :eyes:
 `;

+const asMutable = <T>(value: T): Writable<T> => value as Writable<T>;


I see you are creating this function in second PR , maybe its worth to move it to some utils folder?

I agree, suggested the same in another PR

kubabutkiewicz · 2024-02-22T08:32:38Z

-        when(core.getInput).calledWith('PR_NUMBER', {required: true}).mockReturnValue(12);
+        when(core.getInput)
+            .calledWith('PR_NUMBER', {required: true})
+            .mockReturnValue(12 as unknown as string);


why number is casted to string?

This is casted to string to comply with TS as the return type of code.getInput is a string and if we just change 12 to string the test is not passing, so this was the best solution I could find without changing the logic.

fabioh8010 · 2024-02-27T09:56:30Z

Could we rename to asMutable.ts?

fabioh8010 · 2024-02-27T10:54:44Z

-        when(core.getInput).calledWith('PR_NUMBER', {required: true}).mockReturnValue(12);
+        when(core.getInput)
+            .calledWith('PR_NUMBER', {required: true})
+            .mockReturnValue(12 as unknown as string);


Suggested change

.mockReturnValue(12 as unknown as string);

.mockReturnValue('12');

See my next comment

fabioh8010 · 2024-02-27T10:55:02Z

-        expect(GithubUtils.createComment).toBeCalledTimes(1);
-        expect(GithubUtils.createComment).toBeCalledWith('App', 12, message);
+        expect(createCommentMock).toBeCalledTimes(1);
+        expect(createCommentMock).toBeCalledWith('App', 12, message);


Suggested change

expect(createCommentMock).toBeCalledWith('App', 12, message);

expect(createCommentMock).toBeCalledWith('App', '12', message);

With this change the test should pass correctly

…ub.com/ruben-rebelo/App into ts-migration/unit-postTestBuildComment

blazejkustra · 2024-03-11T15:12:10Z

+import type {Writable} from 'type-fest';
+
+const asMutable = <T>(value: T): Writable<T> => value as Writable<T>;
+
+export default asMutable;


asMutable is already on main, right? Let's sync main here

Synced, thank you!

melvin-bot · 2024-03-12T10:00:24Z

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

paultsimura

No QA

melvin-bot · 2024-03-12T10:06:40Z

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

jasperhuangg · 2024-03-13T02:27:25Z

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-03-15T10:29:28Z

🚀 Deployed to staging by https://github.com/jasperhuangg in version: 1.4.53-0 🚀

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

OSBotify · 2024-03-18T16:19:06Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.53-2 🚀

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

ruben-rebelo added 2 commits February 21, 2024 15:52

[TS migration] Migrate postTestBuildComment to typescript

7064cfe

[TS migration][postTestBuildComment] Added last ts issue fix

0ead9f4

kubabutkiewicz reviewed Feb 22, 2024

View reviewed changes

ruben-rebelo added 2 commits February 22, 2024 09:05

[TS migration][postTestBuildComment] Updated asMutable to the util

a5ea70b

[TS migration][postTestBuildComment] Changed file location and name

dfad426

fabioh8010 reviewed Feb 27, 2024

View reviewed changes

ruben-rebelo and others added 4 commits February 28, 2024 08:33

Rename AsMutable.ts to asMutable.ts

14f652c

[TS migration][postTestBuildComments] Feedback

5a33f68

Merge branch 'ts-migration/unit-postTestBuildComment' of https://gith…

c4a3b32

…ub.com/ruben-rebelo/App into ts-migration/unit-postTestBuildComment

[TS migration][postTestBuildComment] Issue fixed

96dc9e0

blazejkustra approved these changes Mar 11, 2024

View reviewed changes

Merge branch 'main' into ts-migration/unit-postTestBuildComment

3a9f784

ruben-rebelo changed the title ~~[TS migration] Migrate postTestBuildComment to typescript~~ [No QA][TS migration] Migrate postTestBuildComment to typescript Mar 12, 2024

ruben-rebelo marked this pull request as ready for review March 12, 2024 10:00

ruben-rebelo requested a review from a team as a code owner March 12, 2024 10:00

melvin-bot Bot removed the request for review from a team March 12, 2024 10:00

melvin-bot Bot requested a review from paultsimura March 12, 2024 10:00

paultsimura approved these changes Mar 12, 2024

View reviewed changes

melvin-bot Bot requested a review from jasperhuangg March 12, 2024 10:06

jasperhuangg approved these changes Mar 13, 2024

View reviewed changes

jasperhuangg merged commit eb6ad50 into Expensify:main Mar 14, 2024

github-actions Bot mentioned this pull request Mar 15, 2024

Deploy Checklist: New Expensify 2024-03-15 #38382

Closed

35 tasks

melvin-bot Bot mentioned this pull request Mar 18, 2024

[$500] [HOLD for payment 2024-03-25] [TS migration] Migrate 'postTestBuildComment.js' test to TypeScript #25296

Closed

	.mockReturnValue(12 as unknown as string);
	.mockReturnValue('12');

	expect(createCommentMock).toBeCalledWith('App', 12, message);
	expect(createCommentMock).toBeCalledWith('App', '12', message);

Uh oh!

Conversation

ruben-rebelo commented Feb 21, 2024

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Mar 12, 2024

Uh oh!

paultsimura left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot Bot commented Mar 12, 2024

Uh oh!

jasperhuangg commented Mar 13, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

OSBotify commented Mar 15, 2024

Uh oh!

OSBotify commented Mar 18, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants