[No QA] [TS migration] Migrate 'Environment' lib to TypeScript by BartoszGrajdek · Pull Request #28600 · Expensify/App

BartoszGrajdek · 2023-10-02T11:33:34Z

Details

Migrate 'Environment' lib file to TypeScript

Fixed Issues

$ #24922

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

Web

web.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

ios.mov

Android

android.mov

…ent-lib

src/libs/Environment/Environment.ts

kubabutkiewicz · 2023-10-09T06:43:54Z

@BartoszGrajdek I see that there are env specific file and for those we should follow specific pattern mentioned here

blazejkustra

Add types.ts files for betaChecker and getEnvironment

kubabutkiewicz

@BartoszGrajdek Changes lgtm but there is ts check fail

…ent-lib

BartoszGrajdek · 2023-10-23T06:58:48Z

@jjcoffee bump :)

jjcoffee · 2023-10-23T17:13:13Z

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

Web

chrome-desktop-2023-10-23_19.18.51.mp4

Mobile Web - Chrome

android-chrome.mp4

Mobile Web - Safari

ios-safari-2023-10-25_14.23.10.mp4

Desktop

mac-desktop-2023-10-23_19.21.24.mp4

iOS

ios-native-2023-10-25_14.21.24.mp4

Android

android-native.mp4

jjcoffee · 2023-10-23T17:13:48Z

@BartoszGrajdek Looks like you're missing screenshots for mWeb and desktop, could you add?

jjcoffee · 2023-10-23T18:03:04Z

Having some iOS build issues, I'll have to complete tomorrow unfortunately!

BartoszGrajdek · 2023-10-24T10:41:04Z

Done! @jjcoffee

jjcoffee · 2023-10-24T14:19:40Z

Thanks! Sorry didn't manage to resolve my iOS issues today, will switch to a different provider tomorrow if I can't get it resolved.

jjcoffee

LGTM & tests well! Sorry again for the delay 🙇

melvin-bot · 2023-10-25T12:29:40Z

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

neil-marcellini

Looks great, but I have one small request.

neil-marcellini · 2023-10-25T17:28:48Z

src/libs/Environment/Environment.ts

-function isInternalTestBuild() {
-    return lodashGet(Config, 'ENVIRONMENT', CONST.ENVIRONMENT.DEV) === CONST.ENVIRONMENT.ADHOC && lodashGet(Config, 'PULL_REQUEST_NUMBER', '');
+function isInternalTestBuild(): boolean {
+    return !!((Config?.ENVIRONMENT ?? CONST.ENVIRONMENT.DEV) === CONST.ENVIRONMENT.ADHOC && (Config?.PULL_REQUEST_NUMBER ?? ''));


NAB: I think the !! here could just be around the pull request number part

src/libs/Environment/getEnvironment/index.ts

src/libs/Environment/betaChecker/index.android.ts

OSBotify · 2023-10-30T18:07:57Z

✋ 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-10-31T22:00:19Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.3.94-0 🚀

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

OSBotify · 2023-11-01T08:52:18Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.3.94-0 🚀

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

OSBotify · 2023-11-02T10:15:39Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.94-2 🚀

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

OSBotify · 2023-11-02T10:40:29Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.3.95-0 🚀

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

OSBotify · 2023-11-06T22:10:32Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.95-9 🚀

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

BartoszGrajdek added 2 commits September 29, 2023 11:39

Migrate environment lib to TS

d7b9c81

Merge remote-tracking branch 'origin/main' into ts-migration/environm…

2952776

…ent-lib

BartoszGrajdek requested a review from a team as a code owner October 2, 2023 11:33

melvin-bot bot requested review from jjcoffee and removed request for a team October 2, 2023 11:33

BartoszGrajdek marked this pull request as draft October 3, 2023 11:31

kubabutkiewicz reviewed Oct 3, 2023

View reviewed changes

src/libs/Environment/Environment.ts Outdated Show resolved Hide resolved

src/libs/Environment/Environment.ts Outdated Show resolved Hide resolved

Create types for environment urls keys

89173ee

Remove assertion

e2738d3

blazejkustra approved these changes Oct 11, 2023

View reviewed changes

blazejkustra suggested changes Oct 11, 2023

View reviewed changes

Add IsBetaBuild type

cb7efb9

kubabutkiewicz approved these changes Oct 12, 2023

View reviewed changes

BartoszGrajdek added 2 commits October 13, 2023 15:13

Merge remote-tracking branch 'origin/main' into ts-migration/environm…

0ef2dfb

…ent-lib

Resolve typecheck errors

86e1ef1

BartoszGrajdek marked this pull request as ready for review October 18, 2023 09:20

jjcoffee approved these changes Oct 25, 2023

View reviewed changes

melvin-bot bot requested a review from neil-marcellini October 25, 2023 12:29

neil-marcellini requested changes Oct 25, 2023

View reviewed changes

BartoszGrajdek added 3 commits October 29, 2023 19:13

Resolve merge conflicts

bceb7d2

Fix lint problems for Environment lib

cca1382

Resolve prettier error

91dcf2b

neil-marcellini approved these changes Oct 30, 2023

View reviewed changes

neil-marcellini merged commit a2dc22f into Expensify:main Oct 30, 2023

OSBotify mentioned this pull request Oct 31, 2023

Deploy Checklist: New Expensify 2023-10-31 #30662

Closed

97 tasks

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

[HOLD for payment 2023-11-09] [TS migration] Migrate 'Environment' lib to TypeScript #24922

Closed

OSBotify mentioned this pull request Nov 2, 2023

Deploy Checklist: New Expensify 2023-11-02 #30752

Closed

Conversation

BartoszGrajdek commented Oct 2, 2023 • 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!

kubabutkiewicz commented Oct 9, 2023

Uh oh!

blazejkustra left a comment

Choose a reason for hiding this comment

Uh oh!

kubabutkiewicz left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BartoszGrajdek commented Oct 23, 2023

Uh oh!

jjcoffee commented Oct 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

jjcoffee commented Oct 23, 2023

Uh oh!

jjcoffee commented Oct 23, 2023

Uh oh!

BartoszGrajdek commented Oct 24, 2023

Uh oh!

jjcoffee commented Oct 24, 2023

Uh oh!

jjcoffee left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Oct 25, 2023

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

neil-marcellini Oct 25, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

OSBotify commented Oct 30, 2023

Uh oh!

OSBotify commented Oct 31, 2023

Uh oh!

OSBotify commented Nov 1, 2023

Uh oh!

OSBotify commented Nov 2, 2023

Uh oh!

OSBotify commented Nov 2, 2023

Uh oh!

OSBotify commented Nov 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

BartoszGrajdek commented Oct 2, 2023 •

edited

Loading

kubabutkiewicz left a comment •

edited

Loading

jjcoffee commented Oct 23, 2023 •

edited

Loading