Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-structure styles and theme switching components #32679

Merged

Conversation

chrispader
Copy link
Contributor

@chrispader chrispader commented Dec 7, 2023

@grgia

Details

This PR implements a new file/folder structure for styles and especially theme switching components.

The src/styles folder now follows the following structure:

  • theme: all themes, colors and theme-dependent items for styling like illustrations.
    • context: contexts used for theme switching
    • illustrations: central definition of all theme-dependent illustrations
      • themes: all illustration lists for different themes
    • themes: different theme color palettes
    • colors.ts: all colors used across different themes
    • types.ts: types used for theme switching
    • index.ts: central definition of all available themes
  • utils: all utility functions for styling.
    • index.ts: contains generator function for StyleUtils, which will contain all of the style utils and be the only location from which we should use utils (via useStyleUtils hook, finished in a follow-up PR)
  • index.ts: all static but theme-dependent styles (used via useThemeStyles hook)

Multiple components have been moved to different locations for consistency:

  • Theme switching hooks: useTheme, useThemeStyles, useStyleUtils, useThemeIllustrations, useThemePreference and useThemePreferenceWithStaticOverride have all been moved to src/hooks.
  • Theme switching providers: ThemeProvider, ThemeStylesProvider and ThemeIllustrationsProvider have been moved to src/components.
  • Theme switching HOCs: withTheme, withThemeStyles, withStyleUtils and useThemeIllustrations have been moved to src/components.

Fixed Issues

$ #32664
PROPOSAL:

Tests

Full Regression Suite was done on this PR by QA

Offline tests

QA Steps

NO QA

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

Copy link

melvin-bot bot commented Dec 7, 2023

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@chrispader chrispader changed the title Re-structure styles and theme switching components [HOLD on #32498] Re-structure styles and theme switching components Dec 7, 2023
@OSBotify

This comment was marked as outdated.

@OSBotify

This comment was marked as outdated.

@OSBotify
Copy link
Contributor

🧪🧪 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/32679/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/32679/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/32679/NewExpensify.dmg https://32679.pr-testing.expensify.com
Desktop Web

@lanitochka17
Copy link

lanitochka17 commented Dec 12, 2023

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!


Web- Chat - Placeholder "Write something..." is not centered in Message Composer

Action Performed:

  1. Open https://32679.pr-testing.expensify.com/
  2. Navigate to any conversation
  3. Refresh the page and notify the placeholder "Write something..." in Message Composer

Expected Result:

"Write something..." should be centered in Message Composer

Actual Result:

Placeholder "Write something..." is not centered in Message Composer

Platforms:

Which of our officially supported platforms is this issue occurring on?

  • Android / native
  • Android / Chrome
  • iOS / native
  • iOS / Safari
  • Windows / Chrome
  • MacOS / Desktop

Version Number: 1.4.11-1

Reproducible in staging?: No

Reproducible in production?: No

If this was caught during regression testing, add the test name, ID and link from TestRail:

Email or phone of affected tester (no customers):

Logs: https://stackoverflow.com/c/expensify/questions/4856

Notes/Photos/Videos: Any additional supporting documentation

Bug6310771_1702403529404!Capture

Recording.705.mp4

Expensify/Expensify Issue URL:

Issue reported by: Applause - Internal Team

Slack conversation:

View all open jobs on GitHub

@lanitochka17
Copy link

lanitochka17 commented Dec 12, 2023

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!


Web - Notification - User does not receive notification when new message arrive

Action Performed:

  1. Open https://32679.pr-testing.expensify.com/
  2. User B send new message to user A

Expected Result:

User A should receive notification for all new messages

Actual Result:

User does not receive notification when new message arrive

Platforms:

Which of our officially supported platforms is this issue occurring on?

  • Android / native
  • Android / Chrome
  • iOS / native
  • iOS / Safari
  • Windows / Chrome
  • MacOS / Desktop

Version Number: 1.4.11-1

Reproducible in staging?: No

Reproducible in production?: No

If this was caught during regression testing, add the test name, ID and link from TestRail:

Email or phone of affected tester (no customers):

Logs: https://stackoverflow.com/c/expensify/questions/4856

Notes/Photos/Videos: Any additional supporting documentation

Bug6310782_1702404096233.Recording__1545.1.mp4

Expensify/Expensify Issue URL:

Issue reported by: Applause - Internal Team

Slack conversation:

View all open jobs on GitHub

@lanitochka17
Copy link

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!


IOU- User able to select email id while creating distance request

Action Performed:

  1. Go to https://32679.pr-testing.expensify.com/
  2. Tap fab
  3. Tap distance
  4. Enter start and finish waypoints and tap next
  5. Search for a contact by typing any email id
  6. Note results are displayed when user search for email id
  7. Select the user
  8. Tap request
  9. Note distance request is created with red dot and unexpected error message
  10. Tap on distance request created
  11. Note receipt missing details with red dot is shown in preview.

Expected Result:

For distance request, workspace only user should be allowed to select. When user search for email, no results found message must be displayed. User should be allowed to search and select only workspace while making distance request

Actual Result:

When user search for email, results are shown and user is allowed to select email for making distance request. After selecting email, on tapping request, a distance request is created with red dot and unexpected error message .Opening distance request created displays receipt missing details with red dot is shown in request preview

Platforms:

Which of our officially supported platforms is this issue occurring on?

  • Android / native
  • Android / Chrome
  • iOS / native
  • iOS / Safari
  • Windows / Chrome
  • MacOS / Desktop

Version Number: 1.4.11-1

Reproducible in staging?: No

Reproducible in production?: No

If this was caught during regression testing, add the test name, ID and link from TestRail:

Email or phone of affected tester (no customers):

Logs: https://stackoverflow.com/c/expensify/questions/4856

Notes/Photos/Videos: Any additional supporting documentation

Bug6310797_1702404779857.full_video.mp4

Expensify/Expensify Issue URL:

Issue reported by: Applause - Internal Team

Slack conversation:

View all open jobs on GitHub

@lanitochka17
Copy link

lanitochka17 commented Dec 12, 2023

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!


IOU-Split bill created in announce room is not displayed

Action Performed:

  1. Go to https://32679.pr-testing.expensify.com/
  2. Tap on announce room
  3. Tap plus icon
  4. Tap split bill
  5. Enter an amount
  6. Tap next
  7. Tap Split

Expected Result:

Split bill created in announce room must be displayed

Actual Result:

Split bill created in announce room is not displayed

Platforms:

Which of our officially supported platforms is this issue occurring on?

  • Android / native
  • Android / Chrome
  • iOS / native
  • iOS / Safari
  • Windows / Chrome
  • MacOS / Desktop

Version Number: 1.4.11-1

Reproducible in staging?: No

Reproducible in production?: No

If this was caught during regression testing, add the test name, ID and link from TestRail:

Email or phone of affected tester (no customers):

Logs: https://stackoverflow.com/c/expensify/questions/4856

Notes/Photos/Videos: Any additional supporting documentation

Bug6310980_1702417152330.announce.mp4

Expensify/Expensify Issue URL:

Issue reported by: Applause - Internal Team

Slack conversation:

View all open jobs on GitHub

@grgia grgia removed the request for review from sobitneupane December 13, 2023 18:47
@OSBotify
Copy link
Contributor

🧪🧪 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/32679/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/32679/index.html
Android iOS
Desktop 💻 Web 🕸️
❌ FAILED ❌ https://32679.pr-testing.expensify.com
The QR code can't be generated, because the Desktop build failed Web

@grgia
Copy link
Contributor

grgia commented Dec 13, 2023

retrying desktop ^

@OSBotify
Copy link
Contributor

🧪🧪 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/32679/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/32679/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/32679/NewExpensify.dmg https://32679.pr-testing.expensify.com
Desktop Web

grgia
grgia previously approved these changes Dec 13, 2023
Copy link
Contributor

@grgia grgia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've done a full regression suite and have addressed or dismissed all bugs linked in this PR.

Lint is failing due to unused styles in style util files that are never touched. I don't think we should remove these in this PR so I will merge with these lint errors as they are non-blocking/not necessary for these files.

@grgia

This comment was marked as resolved.

@grgia grgia merged commit 3df907c into Expensify:main Dec 13, 2023
19 of 21 checks passed
@melvin-bot melvin-bot bot added the Emergency label Dec 13, 2023
Copy link

melvin-bot bot commented Dec 13, 2023

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

@grgia grgia removed the Emergency label Dec 13, 2023
@grgia
Copy link
Contributor

grgia commented Dec 13, 2023

^
Lint was failing due to unused styles in style util files that are never touched. I don't think we should remove these in this PR so I merged with these lint errors as they are non-blocking/not necessary for these files.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/grgia in version: 1.4.13-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/grgia in version: 1.4.13-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.13-8 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants