[TS Migration] Update EnvironmentContext default value #31824

VickyStash · 2023-11-24T13:13:06Z

Details

With current EnvironmentContext default null value it makes it possible for environment values to be undefined. That turns them into optional on the TS side which doesn't look right.
This PR replace null default value with values that are used as default in the state of EnvironmentProvider.
Related discussion: #31478 (comment)

Fixed Issues

$ #25084
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

Open the app on the Login page.
Make sure Expensify wordmark shows your environment.
Log into the app.
Check if a badge next to the Expensify logo shows your environment.

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console

Open the app on the Login page.
Make sure Expensify wordmark shows your environment.
Log into the app.
Check if a badge next to the Expensify logo shows your environment.

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

kubabutkiewicz

lgtm 😄

melvin-bot · 2023-11-24T14:23:07Z

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

fedirjh · 2023-11-24T23:14:10Z

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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

fedirjh

Looks good and tests well.

fedirjh · 2023-11-24T23:38:01Z

src/components/EnvironmentBadge.tsx

@@ -18,7 +18,7 @@ function EnvironmentBadge() {
    const {environment} = useEnvironment();

    // If we are on production, don't show any badge
-    if (environment === CONST.ENVIRONMENT.PRODUCTION || environment === undefined) {
+    if (environment === CONST.ENVIRONMENT.PRODUCTION) {


Suggested change

if (environment === CONST.ENVIRONMENT.PRODUCTION) {

if (isProduction) {

NAB: I guess this can be simplified. we need to destruct isProduction from useEnvironment.

@fedirjh Done!

Julesssss · 2023-11-28T08:52:32Z

Generating an AdHoc build to test the iconmark logic still works.

OSBotify · 2023-11-28T09:15:07Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/31824/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/31824/index.html

Desktop 💻	Web 🕸️
❌ FAILED ❌	https://31824.pr-testing.expensify.com
The QR code can't be generated, because the Desktop build failed

OSBotify · 2023-11-28T09:15:21Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/31824/index.html	❌ FAILED ❌
	The QR code can't be generated, because the iOS build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/31824/NewExpensify.dmg	https://31824.pr-testing.expensify.com

Julesssss

LGTM

OSBotify · 2023-11-28T09:26:12Z

✋ 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-30T12:16:06Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.5-7 🚀

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

Update EnvironmentContext default value

8537b73

kubabutkiewicz approved these changes Nov 24, 2023

View reviewed changes

fabioh8010 approved these changes Nov 24, 2023

View reviewed changes

blazejkustra approved these changes Nov 24, 2023

View reviewed changes

VickyStash marked this pull request as ready for review November 24, 2023 14:23

VickyStash requested a review from a team as a code owner November 24, 2023 14:23

melvin-bot bot requested review from fedirjh and removed request for a team November 24, 2023 14:23

Merge branch 'main' into ts-migration/update-environment-context

6412a59

fedirjh approved these changes Nov 24, 2023

View reviewed changes

melvin-bot bot requested a review from Julesssss November 24, 2023 23:39

Use isProduction param

afea2b2

fedirjh approved these changes Nov 27, 2023

View reviewed changes

Julesssss assigned VickyStash Nov 28, 2023

Julesssss added the Ready To Build label Nov 28, 2023

Julesssss approved these changes Nov 28, 2023

View reviewed changes

Julesssss merged commit 6bfef02 into Expensify:main Nov 28, 2023

github-actions bot mentioned this pull request Nov 29, 2023

Deploy Checklist: New Expensify 2023-11-29 #32175

Closed

55 tasks

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

[$500] [HOLD for payment 2023-12-07] [TS migration] Migrate 'ExpensifyWordmark.js' component to TypeScript #25084

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS Migration] Update EnvironmentContext default value #31824

[TS Migration] Update EnvironmentContext default value #31824

VickyStash commented Nov 24, 2023 •

edited

Loading

kubabutkiewicz left a comment

melvin-bot bot commented Nov 24, 2023

fedirjh commented Nov 24, 2023 •

edited

Loading

fedirjh left a comment

fedirjh Nov 24, 2023

VickyStash Nov 27, 2023

Julesssss commented Nov 28, 2023

OSBotify commented Nov 28, 2023

OSBotify commented Nov 28, 2023

Julesssss left a comment

OSBotify commented Nov 28, 2023

OSBotify commented Nov 30, 2023

	if (environment === CONST.ENVIRONMENT.PRODUCTION) {
	if (isProduction) {

[TS Migration] Update EnvironmentContext default value #31824

[TS Migration] Update EnvironmentContext default value #31824

Conversation

VickyStash commented Nov 24, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

kubabutkiewicz left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Nov 24, 2023

fedirjh commented Nov 24, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

fedirjh left a comment

Choose a reason for hiding this comment

fedirjh Nov 24, 2023

Choose a reason for hiding this comment

VickyStash Nov 27, 2023

Choose a reason for hiding this comment

Julesssss commented Nov 28, 2023

OSBotify commented Nov 28, 2023

OSBotify commented Nov 28, 2023

Julesssss left a comment

Choose a reason for hiding this comment

OSBotify commented Nov 28, 2023

OSBotify commented Nov 30, 2023

VickyStash commented Nov 24, 2023 •

edited

Loading

fedirjh commented Nov 24, 2023 •

edited

Loading