[No QA] [TS migration] Migrate 'E2E' lib to TypeScript #28896

VickyStash · 2023-10-05T08:41:18Z

Details

[TS migration] Migrate 'E2E' lib to TypeScript

Fixed Issues

$ #24933
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

To test that it works as expected, you need to run E2E tests locally.
More information about E2E tests can be found in the related README file and the testRunner file.
Some steps of the easiest way to test from me:

Make sure you have android simulator named test and apktool installed
Launch android test simulator
Make sure Fastlane was initialized by running bundle install
If you don't have $ANDROID_SDK_ROOT defined, update it manually to your Android SDK path in this line. You can find the actual location of the SDK in the Android Studio "Settings" dialog, under Languages & Frameworks → Android SDK.
Run npm run test:e2e , it will take some time for the builds to be generated and tests to pass.
Make sure tests passed successfully, you can find the result in the tests/e2e/results/output.md file.

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console

N/A

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 / Chrome
- iOS / native
- iOS / 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
  - 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

output.md

# Conflicts: # src/types/onyx/Report.ts

rezkiy37

LGTM

kubabutkiewicz · 2023-10-05T11:10:18Z

src/libs/E2E/apiMocks/openApp.ts

@@ -1,4 +1,7 @@
-export default () => ({
+/* eslint-disable @typescript-eslint/naming-convention */


There is a discussion
which I assume that will resolve issues with bad naming convention and we will be able to sent proper vars names to backed. Just an FYI

@kubabutkiewicz In this file bad naming is caused by mocked data fields like report_98258458, for example, so I guess we can't do anything

# Conflicts: # src/types/onyx/Policy.ts # src/types/onyx/ReportAction.ts

# Conflicts: # src/CONST.ts

kubabutkiewicz

LGTM

metro.config.js

blazejkustra · 2023-10-17T15:45:25Z

src/CONST.ts

@@ -244,6 +244,76 @@ const CONST = {
        NEW_DOT_CATEGORIES: 'newDotCategories',
        NEW_DOT_TAGS: 'newDotTags',
        NEW_DOT_SAML: 'newDotSAML',
+        PDF_META_STORE: 'pdfMetaStore',


Can you give a bit of context here? What is the source of all these new properties?

@blazejkustra CONST.BETAS is used in Beta type
There are two apiMocks that set betas, inside openApp.ts and signinUser.ts

So without these new properties, it gives an error like this:

I am working on removing all useless ones, and this change made it 10x harder in this repo 😞

@flodnv Why it made harder for you? Can you give a bit more context?

Because now I have to check if all of these betas are used, which they probably are not...

It would have been better to update the mocks to match the code instead of the opposite, which I think is probably almost always preferred (why mock something that does not exist / is not used?)

Fixed here: #31783

melvin-bot · 2023-10-18T08:12:21Z

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

blazejkustra

LGTM!

# Conflicts: # src/ONYXKEYS.ts # src/types/onyx/Report.ts # src/types/onyx/ReportAction.ts

# Conflicts: # metro.config.js # src/libs/E2E/API.mock.ts # src/libs/E2E/isE2ETestSession.native.js # src/libs/E2E/reactNativeLaunchingTest.ts # src/libs/E2E/tests/appStartTimeTest.e2e.ts

VickyStash · 2023-10-31T07:20:37Z

@eVoloshchak I guess this PR has run out of your radar, it would be great if you could take a look at it this week

# Conflicts: # src/CONST.ts

tests/e2e/testRunner.js

# Conflicts: # src/libs/E2E/API.mock.ts # src/libs/E2E/apiMocks/openReport.ts # src/libs/E2E/client.ts # src/types/onyx/Response.ts # tests/e2e/ADDING_TESTS.md

VickyStash · 2023-11-07T11:09:09Z

@hannojg After merging the last main with updates from your PR I have the next error at the end of running E2E tests. I've tried to run E2E tests on main branch and got the same result, so it looks like it's not TS updates related. It would be great if you could provide me with your thoughts on it!

kubabutkiewicz

lgtm 😄

VickyStash · 2023-11-08T10:35:08Z

ON HOLD till #30793 is merged

# Conflicts: # src/libs/E2E/tests/appStartTimeTest.e2e.ts

VickyStash · 2023-11-09T18:03:02Z

I've merged the latest main and updated tests steps, now it's all yours @eVoloshchak :)

# Conflicts: # src/libs/E2E/apiMocks/openReport.ts # src/types/onyx/Report.ts

VickyStash · 2023-11-13T10:57:53Z

@eVoloshchak kind bump 😄

eVoloshchak · 2023-11-13T19:18: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 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

output.md

eVoloshchak

LGTM

melvin-bot · 2023-11-13T19:27:34Z

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

OSBotify · 2023-11-14T11:21:07Z

✋ 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-14T22:09:18Z

🚀 Deployed to staging by https://github.com/madmax330 in version: 1.3.99-0 🚀

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

OSBotify · 2023-11-15T20:52:34Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.99-0 🚀

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

OSBotify · 2023-11-15T21:07:57Z

🚀 Deployed to staging by https://github.com/madmax330 in version: 1.4.0-0 🚀

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

[TS migration] Migrate 'E2E' lib

65c2205

VickyStash changed the title ~~[TS migration] Migrate 'E2E' lib~~ [No QA] [TS migration] Migrate 'E2E' lib to TypeScript Oct 5, 2023

VickyStash added 2 commits October 5, 2023 10:47

Merge branch 'main' into ts-migration/e2e-lib

cbf918c

# Conflicts: # src/types/onyx/Report.ts

Add errors field to report action type

61aa3d8

rezkiy37 approved these changes Oct 5, 2023

View reviewed changes

kubabutkiewicz reviewed Oct 5, 2023

View reviewed changes

VickyStash added 3 commits October 16, 2023 16:34

Merge branch 'main' into ts-migration/e2e-lib

ba6802d

# Conflicts: # src/types/onyx/Policy.ts # src/types/onyx/ReportAction.ts

Migrate e2e files to TS

354cd4c

Merge branch 'main' into ts-migration/e2e-lib

82fb834

# Conflicts: # src/CONST.ts

kubabutkiewicz approved these changes Oct 17, 2023

View reviewed changes

Update files extension in docs

af68ede

blazejkustra approved these changes Oct 17, 2023

View reviewed changes

VickyStash added 2 commits October 18, 2023 08:21

Merge branch 'main' into ts-migration/e2e-lib

8b9f6ff

Remove todo

bc08d2a

VickyStash marked this pull request as ready for review October 18, 2023 08:12

VickyStash requested a review from a team as a code owner October 18, 2023 08:12

melvin-bot bot requested review from eVoloshchak and removed request for a team October 18, 2023 08:12

blazejkustra approved these changes Oct 18, 2023

View reviewed changes

VickyStash added 6 commits October 23, 2023 14:39

Merge branch 'main' into ts-migration/e2e-lib

ed0bfd3

# Conflicts: # src/ONYXKEYS.ts # src/types/onyx/Report.ts # src/types/onyx/ReportAction.ts

Fix ts error

21bf425

Merge branch 'main' into ts-migration/e2e-lib

61c5075

# Conflicts: # metro.config.js # src/libs/E2E/API.mock.ts # src/libs/E2E/isE2ETestSession.native.js # src/libs/E2E/reactNativeLaunchingTest.ts # src/libs/E2E/tests/appStartTimeTest.e2e.ts

Update imports after merging main, fix ts errors

551e96a

Merge branch 'main' into ts-migration/e2e-lib

5bf3423

Fix prettier

3e0627a

VickyStash added 2 commits November 6, 2023 12:41

Merge branch 'main' into ts-migration/e2e-lib

e912bc2

# Conflicts: # src/CONST.ts

Fix NaN in cooling down logs

1eaac4c

VickyStash commented Nov 6, 2023

View reviewed changes

tests/e2e/testRunner.js Outdated Show resolved Hide resolved

VickyStash added 2 commits November 7, 2023 08:53

Merge branch 'main' into ts-migration/e2e-lib

a3361ca

# Conflicts: # src/libs/E2E/API.mock.ts # src/libs/E2E/apiMocks/openReport.ts # src/libs/E2E/client.ts # src/types/onyx/Response.ts # tests/e2e/ADDING_TESTS.md

Migrate new files to TS; fix TS issues after merging main

581dfcd

kubabutkiewicz approved these changes Nov 7, 2023

View reviewed changes

VickyStash added 3 commits November 9, 2023 17:38

Merge branch 'main' into ts-migration/e2e-lib

fe890c9

# Conflicts: # src/libs/E2E/tests/appStartTimeTest.e2e.ts

Fix ts issues after main merging

7d0075e

Update file extension

876fc14

VickyStash added 2 commits November 13, 2023 11:24

Merge branch 'main' into ts-migration/e2e-lib

f7763cf

# Conflicts: # src/libs/E2E/apiMocks/openReport.ts # src/types/onyx/Report.ts

Remove extra params from Report type

a5d2248

VickyStash added 2 commits November 13, 2023 18:26

Merge branch 'main' into ts-migration/e2e-lib

4479acc

Fix ts issues

d790b48

eVoloshchak approved these changes Nov 13, 2023

View reviewed changes

melvin-bot bot requested a review from madmax330 November 13, 2023 19:27

madmax330 approved these changes Nov 14, 2023

View reviewed changes

madmax330 merged commit d82dc7a into Expensify:main Nov 14, 2023
16 checks passed

OSBotify mentioned this pull request Nov 14, 2023

Deploy Checklist: New Expensify 2023-11-14 #31324

Closed

OSBotify mentioned this pull request Nov 15, 2023

Deploy Checklist: New Expensify 2023-11-15 #31404

Closed

37 tasks

melvin-bot bot mentioned this pull request Nov 15, 2023

[HOLD for payment 2023-11-22] [TS migration] Migrate 'E2E' lib to TypeScript #24933

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] [TS migration] Migrate 'E2E' lib to TypeScript #28896

[No QA] [TS migration] Migrate 'E2E' lib to TypeScript #28896

VickyStash commented Oct 5, 2023 •

edited by github-actions bot

Loading

rezkiy37 left a comment

kubabutkiewicz Oct 5, 2023

VickyStash Oct 17, 2023

kubabutkiewicz left a comment

blazejkustra Oct 17, 2023

VickyStash Oct 17, 2023

flodnv Nov 22, 2023

blazejkustra Nov 22, 2023

flodnv Nov 22, 2023

flodnv Nov 23, 2023

melvin-bot bot commented Oct 18, 2023

blazejkustra left a comment

VickyStash commented Oct 31, 2023

VickyStash commented Nov 7, 2023

kubabutkiewicz left a comment

VickyStash commented Nov 8, 2023

VickyStash commented Nov 9, 2023

VickyStash commented Nov 13, 2023

eVoloshchak commented Nov 13, 2023 •

edited

Loading

eVoloshchak left a comment

melvin-bot bot commented Nov 13, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 15, 2023

OSBotify commented Nov 15, 2023

		@@ -1,4 +1,7 @@
		export default () => ({
		/* eslint-disable @typescript-eslint/naming-convention */

[No QA] [TS migration] Migrate 'E2E' lib to TypeScript #28896

[No QA] [TS migration] Migrate 'E2E' lib to TypeScript #28896

Conversation

VickyStash commented Oct 5, 2023 • edited by github-actions bot Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

rezkiy37 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kubabutkiewicz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 18, 2023

blazejkustra left a comment

Choose a reason for hiding this comment

VickyStash commented Oct 31, 2023

VickyStash commented Nov 7, 2023

kubabutkiewicz left a comment

Choose a reason for hiding this comment

VickyStash commented Nov 8, 2023

VickyStash commented Nov 9, 2023

VickyStash commented Nov 13, 2023

eVoloshchak commented Nov 13, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

eVoloshchak left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Nov 13, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 15, 2023

OSBotify commented Nov 15, 2023

VickyStash commented Oct 5, 2023 •

edited by github-actions bot

Loading

eVoloshchak commented Nov 13, 2023 •

edited

Loading