[NO QA] migrate group 5 tests to ts by pasyukevich · Pull Request #37482 · Expensify/App

pasyukevich · 2024-02-29T09:52:09Z

Details

Fixed Issues

$ #25327
#25326
#25325
#25328
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 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.- [x] 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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

fabioh8010 · 2024-03-05T12:16:09Z


 type ReportActions = Record<string, ReportAction>;

+type ReportActionCollectionDataSet = CollectionDataSet<typeof ONYXKEYS.COLLECTION.REPORT_ACTIONS>;


What about using this approach? Other PRs are doing.

Do we already have this helper?

fabioh8010 · 2024-03-15T10:15:27Z

                        value: {
                            1: REPORT_ACTION,
                        },
-                        shouldNotify: true,


WHy this change?

reverted with the comment as it was done in another test

VickyStash · 2024-03-15T11:55:58Z

+                [`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}4`]: null,
+            };
+
+            // @ts-expect-error preset null values


If it's possible to set null values maybe we can update CollectionDataSet type to include null:

type CollectionDataSet<TCollectionKey extends OnyxCollectionKey> = Record<`${TCollectionKey}${string}`, OnyxEntry<OnyxCollectionValuesMapping[TCollectionKey]>>;

After that you can type setQueries var using CollectionDataSet type and get rid of this comment. What do you think?

there is a problem not only with a type.
In this case, we need to specify the key in onyx, since toCollectionDataSet we can set it only from the object data by passing the selector (in this case we will select from the )

I think the current approach is simpler for test purposes

I mean if you update CollectionDataSet type as I mentioned above, you can then type it like

const setQueries: CollectionDataSet<typeof ONYXKEYS.COLLECTION.REPORT_ACTIONS> = { [`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}1`]: null, [`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}2`]: {}, [`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}3`]: {}, [`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}4`]: null, };

No need to use toCollectionDataSet in this case, and you will not have TS error. You can even create a separate type for CollectionDataSet<typeof ONYXKEYS.COLLECTION.REPORT_ACTIONS> as you did here.

But it's up to you

melvin-bot · 2024-03-19T10:45:34Z

@aimane-chnaif 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-03-19T11:48:47Z

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

bondydaa · 2024-03-20T16:01:20Z

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-03-20T16:13:46Z

@bondydaa 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.

OSBotify · 2024-03-20T16:19:38Z

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

bondydaa · 2024-03-20T16:22:57Z

lies, they had all passed.

OSBotify · 2024-03-22T16:19:45Z

🚀 Deployed to staging by https://github.com/bondydaa in version: 1.4.56-0 🚀

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

OSBotify · 2024-03-27T04:48:54Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.56-8 🚀

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

migrate group 5 tests to ts

f9dd242

pasyukevich force-pushed the feature/migration-group-5 branch from 1b59669 to f9dd242 Compare February 29, 2024 09:57

fabioh8010 reviewed Mar 1, 2024

View reviewed changes

pasyukevich added 3 commits March 4, 2024 12:57

address comments

8215b53

Merge branch 'main' into feature/migration-group-5

a2b3b40

fix test

e0813e4

pasyukevich force-pushed the feature/migration-group-5 branch from 73ad1c1 to e0813e4 Compare March 4, 2024 15:34

fabioh8010 reviewed Mar 5, 2024

View reviewed changes

pasyukevich added 5 commits March 12, 2024 14:52

Merge branch 'main' into feature/migration-group-5

cbe4b73

address comments

8de01d0

Merge branch 'main' into feature/migration-group-5

6f66637

fix prettier

1b27795

fix typecheck

ab20e28

fabioh8010 reviewed Mar 15, 2024

View reviewed changes

VickyStash reviewed Mar 15, 2024

View reviewed changes

pasyukevich added 2 commits March 15, 2024 13:31

revert test parameter

594b104

add type to the setQuery

134277c

fabioh8010 reviewed Mar 18, 2024

View reviewed changes

Comment thread tests/actions/ReportTest.ts Outdated

update type

714473e

fabioh8010 approved these changes Mar 18, 2024

View reviewed changes

pasyukevich changed the title ~~migrate group 5 tests to ts~~ [NO QA] migrate group 5 tests to ts Mar 19, 2024

pasyukevich marked this pull request as ready for review March 19, 2024 10:45

pasyukevich requested a review from a team as a code owner March 19, 2024 10:45

melvin-bot Bot requested review from aimane-chnaif and removed request for a team March 19, 2024 10:45

aimane-chnaif approved these changes Mar 19, 2024

View reviewed changes

melvin-bot Bot requested a review from bondydaa March 19, 2024 11:49

bondydaa approved these changes Mar 20, 2024

View reviewed changes

bondydaa merged commit 04d3555 into Expensify:main Mar 20, 2024

melvin-bot Bot added the Emergency label Mar 20, 2024

bondydaa removed the Emergency label Mar 20, 2024

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

Deploy Checklist: New Expensify 2024-03-22 #38811

Closed

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

[HOLD for payment 2024-04-03] [TS migration] Migrate 'NetworkTest.js' test to TypeScript #25327

Closed


		type ReportActions = Record<string, ReportAction>;

		type ReportActionCollectionDataSet = CollectionDataSet<typeof ONYXKEYS.COLLECTION.REPORT_ACTIONS>;

Conversation

pasyukevich commented Feb 29, 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fabioh8010 Mar 5, 2024

Choose a reason for hiding this comment

Uh oh!

pasyukevich Mar 6, 2024

Choose a reason for hiding this comment

Uh oh!

fabioh8010 Mar 15, 2024

Choose a reason for hiding this comment

Uh oh!

pasyukevich Mar 15, 2024

Choose a reason for hiding this comment

Uh oh!

VickyStash Mar 15, 2024

Choose a reason for hiding this comment

Uh oh!

pasyukevich Mar 15, 2024

Choose a reason for hiding this comment

Uh oh!

VickyStash Mar 15, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

melvin-bot Bot commented Mar 19, 2024

Uh oh!

melvin-bot Bot commented Mar 19, 2024

Uh oh!

bondydaa commented Mar 20, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Mar 20, 2024

Uh oh!

OSBotify commented Mar 20, 2024

Uh oh!

bondydaa commented Mar 20, 2024

Uh oh!

OSBotify commented Mar 22, 2024

Uh oh!

OSBotify commented Mar 27, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

pasyukevich commented Feb 29, 2024 •

edited

Loading