Add PR number badge for internal builds by staszekscp · Pull Request #16735 · Expensify/App

staszekscp · 2023-03-30T08:35:32Z

Details

This PR customises the environmental badge for internal builds. The internal builds are going to run on staging environment, but there will be a badge with information from which PR the app was built.

The PR doesn't include screenshots, since a real internal builds would have to be checked to test it properly.

@AndrewGable Could you run the testBuild workflow against this PR to see if everything is fine?

Fixed Issues

$ #13993

Tests

Verify that no errors appear in the JS console
Check if the correct badge is visible near "Chats", when building the app directly from a PR

Offline tests

QA Steps

Verify that no errors appear in the JS console
On Staging "Stg" badge should be visible, on production no badge expected

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

MelvinBot · 2023-03-30T08:36:19Z

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

AndrewGable · 2023-03-30T10:18:40Z

Running here: https://github.com/Expensify/App/actions/runs/4563236866

AndrewGable · 2023-03-30T10:22:11Z

        with:
          ref: ${{ github.event.pull_request.head.sha || needs.getBranchRef.outputs.REF }}

+      - name: Add PULL_REQUEST_NUMBER to .env.staging file


I can appreciate the simplicity of this but I wonder if creating a .env.adhoc is more clear?

I took that into consideration, but quoting Rory from this discussion :)

we could create a separate environment file for ad-hoc builds. The downside is that we'd be introducing a new environment file that we have to maintain, and that environment file would be different from the staging environment. In general I think we want these ad-hoc builds to be as similar to staging builds as possible.

@roryabraham - Curious for your thoughts here now that we have a PR up. My sense is adhoc is not a ton to maintain and it's more explicit as we now have two or three different terms to describe "adhoc" "pull request" "internal testing", etc.

staszekscp · 2023-03-30T14:53:48Z

@AndrewGable could you re-run the build workflow? The previous one used the workflow from main branch instead of internal-build-pr-badge, so it didn't have the necessary changes :) The correct workflow branch may be chosen while running the action :)

AndrewGable · 2023-03-30T15:03:12Z

I do not see your branch, I'm thinking it might be missing because it's a fork?

AndrewGable · 2023-03-30T15:04:28Z

I can probably checkout the branch, then push my own version?

staszekscp · 2023-03-30T15:06:07Z

Yep, I think that would be the easiest solution!

AndrewGable · 2023-03-30T15:24:31Z

Ran here https://github.com/Expensify/App/actions/runs/4566142454

Used internal-build-pr-badge and 16735

staszekscp · 2023-03-31T06:25:27Z

@AndrewGable There was a tiny bug I haven't spotted before. The .env.staging file was not edited in the previous build, because double quotes in echo command ended in the wrong place... Could you pull the newest changes and run the workflow again? Sorry for that, and thanks for the help!

staszekscp · 2023-04-03T14:45:09Z

Hey @AndrewGable! Could you rerun the workflow to see if everything is ok? :)

AndrewGable · 2023-04-03T14:47:25Z

Yes, will do. Updated internal-build-pr-badge branch and will re-run now.

AndrewGable · 2023-04-03T14:48:13Z

Build: https://github.com/Expensify/App/actions/runs/4598086291

staszekscp · 2023-04-04T14:23:05Z

Hi @AndrewGable! Thanks for running the workflow, it seems that everything works as expected :)

AndrewGable · 2023-04-06T16:00:51Z

From the QR code I still see the stg badge when logging in:

AndrewGable · 2023-04-06T16:03:15Z

Also the "About" page from settings still shows the non adhoc version

staszekscp · 2023-04-06T16:28:05Z

@AndrewGable, sorry about the About page, I didn't know it has to be changed there too. It won't be a problem, I'll fix it tomorrow. If it comes to the badge on the screen with logging in I can change it. I just want to inform that for now it is an svg, so I'll have to modify this element a bit to use the EnvironmentBadge component instead. Although if you'd like to modify changes the SplashScreen too, the implementation may be more complex :)

AndrewGable · 2023-04-06T16:36:15Z

I think no splash screen is fine for now, I can get you a replacement SVG for AdHoc that looks similar to the Staging one.

staszekscp · 2023-04-06T16:37:56Z

@AndrewGable That would be great!

AndrewGable · 2023-04-06T16:40:50Z

@Expensify/design or @ADeWitt - Would it be possible to get https://github.com/Expensify/App/blob/main/assets/images/new-expensify-dev.svg in another variant? Ideally it would say "AdHoc", if that does not fit, maybe we could do "PR"? The "pill" color could be a different color if we have another brand color to use, otherwise we can use the "Dev" color.

shawnborton · 2023-04-06T16:45:30Z

Do we need that for all of the icon possibilities? Like the desktop icon as well?

Julesssss · 2023-04-18T15:53:54Z

Maybe we can simplify the CI input labels? Even with context I've messed up twice now.

New run: https://github.com/Expensify/App/actions/runs/4734387668

staszekscp · 2023-04-18T18:41:24Z

Hi @Julesssss, thanks for the run! I've just merged the newest main, and the desktop app works, so hopefully it can be finally merged :) Fingers crossed!

Julesssss · 2023-04-19T11:37:51Z

I'm just a bit confused why the Android AdHoc build doesn't contain the purple pill like the other platforms. I can only see the PR info on the settings page 😕

I used this link, from here is that correct?

staszekscp · 2023-04-19T12:01:39Z

The last commit should fix the issue, hopefully it's the last one :)

Julesssss · 2023-04-19T12:32:50Z

Thanks, triggered another build here

staszekscp · 2023-04-19T13:08:21Z

Ok, android is already downloadable, and the fix worked. :) I've probably installed the previous version last time, and I haven't spotted the difference :/

OSBotify · 2023-04-19T13:38:28Z

🧪🧪 Use the links below to test this build in android and iOS. Happy testing! 🧪🧪

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

desktop 💻	web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/16735/NewExpensify.dmg	https://16735.pr-testing.expensify.com

staszekscp · 2023-04-19T13:42:13Z

@Julesssss all of them seem to be working fine now 😄

Julesssss · 2023-04-19T14:15:00Z

Okay, thanks. Confirmed I see the pill now.

I've updated the checklist with all platforms except iOS mWeb -- which I'm struggling with for some reason. Both in Safari and Chrome:

staszekscp · 2023-04-19T14:18:24Z

That is strange, on my iPhone everything works just fine... I've just double checked it to make sure. Could you try a bit later?

staszekscp · 2023-04-19T14:22:51Z

One screenshot is from Safari, second from Chrome

Julesssss · 2023-04-19T14:32:12Z

Yeah, it's weird. It works fine for me still on Android. Anyway, good news... I was able to verify on a simulator, so I think we're good to go.

MelvinBot · 2023-04-19T14:39:28Z

npm has a package.json file and a package-lock.json file. It seems you updated one without the other, which is usually a sign of a mistake. If you are updating a package make sure that you update the version in package.json then run npm install

MelvinBot · 2023-04-19T14:39:32Z

Hey, I noticed you changed some webpack configuration files. This can break production builds. Did you remember to run a production build locally to verify they still work?

Julesssss · 2023-04-19T14:59:45Z

@AndrewGable maybe you wanna review again

OSBotify · 2023-04-20T08:49:13Z

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

mvtglobally · 2023-04-20T22:01:58Z

@staszekscp @AndrewGable We have no easy way to confirm variety of build for this PR. Do you mind QA-ing it internally?

AndrewGable · 2023-04-20T22:15:03Z

Yes, you can mark it off. We tested the steps for this PR before merging.

OSBotify · 2023-04-20T22:33:09Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.3.3-0 🚀

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

OSBotify · 2023-04-21T20:48:43Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.3-2 🚀

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

add pr badge for internal builds

9c22396

staszekscp requested a review from a team as a code owner March 30, 2023 08:35

melvin-bot Bot requested review from francoisl and removed request for a team March 30, 2023 08:36

staszekscp added 2 commits March 30, 2023 10:36

remove console.warn

d363c15

fix gh lint

2b31904

staszekscp mentioned this pull request Mar 30, 2023

On internal test builds, the staging icon can be present #13993

Closed

1 task

AndrewGable self-requested a review March 30, 2023 10:17

AndrewGable added the Ready To Build label Mar 30, 2023

AndrewGable reviewed Mar 30, 2023

View reviewed changes

fix wrong double quote

1f220d6

Merge branch 'main' into internal-build-pr-badge

51c5a1a

staszekscp added 2 commits April 19, 2023 13:54

fix android badge

5e46ce0

logic improvement

14ab7f6

Julesssss mentioned this pull request Apr 19, 2023

TEST PR: 16735 #17651

Merged

Julesssss reviewed Apr 19, 2023

View reviewed changes

Comment thread src/components/EnvironmentBadge.js Outdated

improve formatting

5f6ac8a

Julesssss approved these changes Apr 19, 2023

View reviewed changes

Julesssss merged commit 1cd304c into Expensify:main Apr 20, 2023

OSBotify mentioned this pull request Apr 20, 2023

Deploy Checklist: New Expensify 2023-04-20 #17747

Closed

24 tasks

kowczarz mentioned this pull request Jun 30, 2023

Flavor support #21551

Merged

57 tasks

Uh oh!

Conversation

staszekscp commented Mar 30, 2023 • edited by Julesssss 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!

MelvinBot commented Mar 30, 2023

Uh oh!

AndrewGable commented Mar 30, 2023

Uh oh!

AndrewGable Mar 30, 2023

Choose a reason for hiding this comment

Uh oh!

staszekscp Mar 30, 2023

Choose a reason for hiding this comment

Uh oh!

AndrewGable Mar 30, 2023

Choose a reason for hiding this comment

Uh oh!

staszekscp commented Mar 30, 2023

Uh oh!

AndrewGable commented Mar 30, 2023

Uh oh!

AndrewGable commented Mar 30, 2023

Uh oh!

staszekscp commented Mar 30, 2023

Uh oh!

AndrewGable commented Mar 30, 2023

Uh oh!

staszekscp commented Mar 31, 2023

Uh oh!

staszekscp commented Apr 3, 2023

Uh oh!

AndrewGable commented Apr 3, 2023

Uh oh!

AndrewGable commented Apr 3, 2023

Uh oh!

staszekscp commented Apr 4, 2023

Uh oh!

AndrewGable commented Apr 6, 2023

Uh oh!

AndrewGable commented Apr 6, 2023

Uh oh!

staszekscp commented Apr 6, 2023

Uh oh!

AndrewGable commented Apr 6, 2023

Uh oh!

staszekscp commented Apr 6, 2023

Uh oh!

AndrewGable commented Apr 6, 2023

Uh oh!

shawnborton commented Apr 6, 2023

Uh oh!

Julesssss commented Apr 18, 2023

Uh oh!

staszekscp commented Apr 18, 2023

Uh oh!

Julesssss commented Apr 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

staszekscp commented Apr 19, 2023

Uh oh!

Julesssss commented Apr 19, 2023

Uh oh!

staszekscp commented Apr 19, 2023

Uh oh!

OSBotify commented Apr 19, 2023

Uh oh!

staszekscp commented Apr 19, 2023

Uh oh!

Julesssss commented Apr 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

staszekscp commented Apr 19, 2023

staszekscp commented Mar 30, 2023 •

edited by Julesssss

Loading

Julesssss commented Apr 19, 2023 •

edited

Loading

Julesssss commented Apr 19, 2023 •

edited

Loading

Julesssss commented Apr 19, 2023 •

edited

Loading