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

[NO QA]: Feed Settings #48185

Merged
merged 11 commits into from
Aug 30, 2024
Merged

[NO QA]: Feed Settings #48185

merged 11 commits into from
Aug 30, 2024

Conversation

narefyev91
Copy link
Contributor

@narefyev91 narefyev91 commented Aug 28, 2024

Details

Feed settings

Add this code inside src/pages/workspace/companyCards/WorkspaceCompanyCardsPage.tsx to add mock data for settings

useEffect(() => {
    Onyx.set(`${ONYXKEYS.COLLECTION.SHARED_NVP_PRIVATE_DOMAIN_MEMBER}${workspaceAccountID}`, {
        companyCards: {
            cdfbmo: {
                pending: false,
                asrEnabled: true,
                forceReimbursable: 'force_no',
                liabilityType: 'corporate',
                preferredPolicy: '',
                reportTitleFormat: '{report:card}{report:bank}{report:submit:from}{report:total}{report:enddate:MMMM}',
                statementPeriodEndDay: 'LAST_DAY_OF_MONTH',
            },
        },
        companyCardNicknames: {
            cdfbmo: 'BMO MasterCard',
        },
    });
}, [workspaceAccountID]);`

Fixed Issues

$ #47378
PROPOSAL:

Tests

  1. Open Company Cards inside more feature
  2. Click on Setting button
  3. Verify that there are 3 items - feed name, delete transactions and Remove card feed
  4. Click on card feed name -> change name -> click save -> verify that name optimistically changed
  5. Click on card feed name -> remove name -> click save -> verify that error is shown
  6. Click on delete transactions -> choose any other transaction -> verify that menu item optimistically changed
  7. Click remove card feed -> verify that warning modal is shown -> click delete -> verify that user moves back to Company cards screen -> click on Settings again -> verify that both menu items are empty
  • Verify that no errors appear in the JS console

Offline tests

  1. Open Company Cards inside more feature
  2. Click on Setting button
  3. Verify that there are 3 items - feed name, delete transactions and Remove card feed
  4. Click on card feed name -> change name -> click save -> verify that name optimistically changed
  5. Click on card feed name -> remove name -> click save -> verify that error is shown
  6. Click on delete transactions -> choose any other transaction -> verify that menu item optimistically changed
  7. Click remove card feed -> verify that warning modal is shown -> click delete -> verify that user moves back to Company cards screen -> click on Settings again -> verify that both menu items are empty

QA Steps

  1. Open Company Cards inside more feature
  2. Click on Setting button
  3. Verify that there are 3 items - feed name, delete transactions and Remove card feed
  4. Click on card feed name -> change name -> click save -> verify that name optimistically changed
  5. Click on card feed name -> remove name -> click save -> verify that error is shown
  6. Click on delete transactions -> choose any other transaction -> verify that menu item optimistically changed
  7. Click remove card feed -> verify that warning modal is shown -> click delete -> verify that user moves back to Company cards screen -> click on Settings again -> verify that both menu items are empty
  • 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: 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.mov
Android: mWeb Chrome
android-web.mov
iOS: Native
ios.mov
iOS: mWeb Safari
ios-web.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@narefyev91 narefyev91 requested a review from a team as a code owner August 28, 2024 14:53
@melvin-bot melvin-bot bot requested a review from ZhenjaHorbach August 28, 2024 14:53
Copy link

melvin-bot bot commented Aug 28, 2024

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

@melvin-bot melvin-bot bot removed the request for review from a team August 28, 2024 14:53
# Conflicts:
#	src/SCREENS.ts
#	src/libs/API/parameters/index.ts
#	src/libs/Navigation/linkingConfig/FULL_SCREEN_TO_RHP_MAPPING.ts
#	src/types/onyx/CompanyCards.ts
#	src/types/onyx/index.ts
@ZhenjaHorbach
Copy link
Contributor

@narefyev91
Can you please ping me when PR will be ready ?
Thanks !

@narefyev91
Copy link
Contributor Author

@Expensify/design can i get your eyes here please - standard components - but not worse to double check.

@shawnborton
Copy link
Contributor

For "Delete transactions" - would a toggleRow make more sense basically enabling or disabling that feature? cc @Expensify/design @trjExpensify @JmillsExpensify

@narefyev91
Copy link
Contributor Author

@ZhenjaHorbach hey - you can start reviewing this one. Appreciated!

@dannymcclain
Copy link
Contributor

@shawnborton I think that does make more sense to me. Something like this perhaps?

CleanShot 2024-08-29 at 08 50 03@2x

@shawnborton
Copy link
Contributor

Exactly, that looks great to me! Thoughts @joekaufmanexpensify ?

@ZhenjaHorbach
Copy link
Contributor

ZhenjaHorbach commented Aug 29, 2024

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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(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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.mp4
Android: mWeb Chrome
android-web.mov
iOS: Native
ios.mov
iOS: mWeb Safari
ios-web.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@joekaufmanexpensify
Copy link
Contributor

Exactly, that looks great to me! Thoughts @joekaufmanexpensify ?

Good with me! @dannymcclain mind linking the figma file where that mock came from? I can get this updated in the doc, and then also the V2 doc that uses this pattern too.

@dannymcclain
Copy link
Contributor

@joekaufmanexpensify It's here in Figma!

@joekaufmanexpensify
Copy link
Contributor

Sweet, TY! Will get this updated in the docs.

# Conflicts:
#	src/ROUTES.ts
#	src/pages/workspace/companyCards/WorkspaceCompanyCardsPage.tsx
@narefyev91
Copy link
Contributor Author

@shawnborton could you please review?
Screenshot 2024-08-30 at 12 12 55

@shawnborton
Copy link
Contributor

Looks good to me!

@dannymcclain
Copy link
Contributor

It looks good! But I think we need to update the hint text.

Currently it says:

Choose whether cardholders can delete card transactions. New transactions will follow these rules.

But that's not super helpful for a toggle—it made sense when this control was a select though.

I think it needs to say something like this:

When enabled, cardholders can delete card transactions. New transactions will follow this rule.

@joekaufmanexpensify
Copy link
Contributor

Yep, that makes sense to me.

@ZhenjaHorbach
Copy link
Contributor

Changes looks good to me !
Only waiting for the text update and a small fix for deleteCompanyCardFeed

@joekaufmanexpensify
Copy link
Contributor

@dannymcclain one other Q on the mockup above. Is it expected that delete is using the green trash can icon? In the doc right now we're using the minus circle icon there in the icon color.

So curious if that was an intentional change?

@dannymcclain
Copy link
Contributor

@joekaufmanexpensify Nice catch—it wasn't originally intentional (I was just going by what I was seeing in this PR), but I actually do think the trashcan icon might make more sense here? Because if you remove a card feed, aren't you essentially completely deleting it? Like you'd have to go all the way back through the set up process to get it back, right? If that's the case, I think the trashcan works and follows what we use for "destructively removing" other things in the product.

As far as the color, I was just using the default color that we currently have in the product right now for option rows. I know we've talked about updating the color many times, but since I still saw green in the product, I went with it.

I am not married to any of these choices that I've made! cc @Expensify/design in case anyone feels strongly that I've strayed from The Path™

@shawnborton
Copy link
Contributor

Yeah, all of that checks out to me Danny. The trash can is pretty consistent with what we use everywhere else in the product too I suppose.

@shawnborton shawnborton reopened this Aug 30, 2024
@shawnborton
Copy link
Contributor

(Oops, fat fingered that comment button)

@joekaufmanexpensify
Copy link
Contributor

Sounds good! Good to use the trashcan icon. For the color, I had thought based on this we were still planning to update all of the icons to use the icon color, and using it with new icons going forward. But LMK if that is no longer correct.

As of right now, both docs use the icon color for all the other icons, so I kinda like picking one color consistently (whatever it ends up being)

@shawnborton
Copy link
Contributor

Yeah that one keeps coming up, I'm not entirely sure where we landed with it. I like just sticking to the default colors we have in product for these UI pieces for now?

@narefyev91
Copy link
Contributor Author

@ZhenjaHorbach updated copy and add closing modal before navigating back

@ZhenjaHorbach
Copy link
Contributor

There are no more questions from my side !
LGTM

@melvin-bot melvin-bot bot requested a review from Gonals August 30, 2024 15:52
robertjchen
robertjchen previously approved these changes Aug 30, 2024
Copy link
Contributor

@robertjchen robertjchen left a comment

Choose a reason for hiding this comment

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

Thanks!

# Conflicts:
#	src/languages/en.ts
#	src/languages/es.ts
#	src/pages/workspace/companyCards/WorkspaceCompanyCardsPage.tsx
@narefyev91
Copy link
Contributor Author

@robertjchen resolved merge conflicts - let's wait checks and ready to go

@narefyev91 narefyev91 requested a review from robertjchen August 30, 2024 18:50
@robertjchen
Copy link
Contributor

@narefyev91 Perfect, thanks for the quick turnaround! 🙇

@robertjchen robertjchen merged commit 76f16bc into Expensify:main Aug 30, 2024
15 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

OSBotify commented Sep 2, 2024

🚀 Deployed to staging by https://github.com/robertjchen in version: 9.0.28-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Sep 3, 2024

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.28-3 🚀

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

const [cardFeeds] = useOnyx(`${ONYXKEYS.COLLECTION.SHARED_NVP_PRIVATE_DOMAIN_MEMBER}${workspaceAccountID}`);
// const [lastSelectedFeed] = useOnyx(`${ONYXKEYS.COLLECTION.LAST_SELECTED_FEED}${policyID}`);
const lastSelectedFeed = 'cdfbmo';
const feedName = cardFeeds?.companyCardNicknames[lastSelectedFeed] ?? '';
Copy link
Contributor

Choose a reason for hiding this comment

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

Card feed name field was blank on feed settings page when the feed name is the default. We should have show the default feed name in the field for the fallback, this caused #51570

const policy = usePolicy(policyID);
const workspaceAccountID = policy?.workspaceAccountID ?? -1;
// const [lastSelectedFeed] = useOnyx(`${ONYXKEYS.COLLECTION.LAST_SELECTED_FEED}${policyID}`)
const [cardFeeds] = useOnyx(`${ONYXKEYS.COLLECTION.SHARED_NVP_PRIVATE_DOMAIN_MEMBER}${workspaceAccountID}`);
Copy link
Contributor

Choose a reason for hiding this comment

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

When the Onyx data is loading, we need to implement a loading indicator to avoid displaying undefined that causing this issue

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

Successfully merging this pull request may close these issues.

9 participants