Feat: Add company card feed flow #48119

waterim · 2024-08-27T20:02:43Z

Details

Fixed Issues

$ #47376
PROPOSAL: N/A

Tests

Test with collect Plan:

Open any workspace in which you are an admin
Go to More Features
Verify that user sees a new item "Company Cards"
Switch on - verify that upgrade plan right panel will be shown
Upgrade to a new plan
Switch on -> verify that a new row appears in left menu item
Verify that the new menu item is highlighted
Click in Company Cards - Verify that a new screen is opened
Click "Add company cards" or just navigate to 'policyID//company-cards/add-card-feed'
Go through the flow (NOTE: API is not ready yet)

Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

None

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

Screen.Recording.2024-08-28.at.20.53.19.mov

melvin-bot · 2024-08-28T18:55:58Z

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

joekaufmanexpensify · 2024-08-28T20:16:16Z

@Pujan92 can you prioritize review on this PR? We're looking to make progress on this project quickly.

src/ROUTES.ts

src/libs/Navigation/linkingConfig/config.ts

src/languages/en.ts

src/pages/workspace/companyCards/addNew/CardTypeStep.tsx

src/CONST.ts

Pujan92 · 2024-08-30T06:47: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 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

andabc1.webm

Android: mWeb Chrome

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-08-30.at.13.39.21.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-08-30.at.22.14.19.mov

Screen.Recording.2024-09-02.at.22.12.13.mov

MacOS: Desktop

Screen.Recording.2024-09-03.at.20.40.58.mov

waterim · 2024-09-09T11:25:13Z

@iwiznia Agree with your comments, removed unneeded hooks as we use new react compiler and fixed translations

src/CONST.ts

src/pages/workspace/companyCards/addNew/CardInstructionsStep.tsx

src/pages/workspace/companyCards/addNew/CardNameStep.tsx

src/pages/workspace/companyCards/addNew/CardTypeStep.tsx

iwiznia · 2024-09-09T12:34:08Z

src/pages/workspace/companyCards/addNew/DetailsStep.tsx

+
+    const [addNewCard] = useOnyx(ONYXKEYS.ADD_NEW_COMPANY_CARD);
+    const feedProvider = addNewCard?.data.cardType;
+    const submit = () => {};


I don't get it, we do nothing when you submit the form?

Yes, because we don't have an API, at least didnt have when I was developing that

Oh got it, so we will fill this up when the API is done?

Yes, will raise new PR or will add it here if we don't merge before APi will appear

joekaufmanexpensify · 2024-09-10T16:56:20Z

@iwiznia sounds like this one is ready for re-review based on this!

dannymcclain · 2024-09-10T19:40:21Z

@dubielzyk-expensify did you get added to the beta for this? Mind giving it a look through when you're back online?

dubielzyk-expensify · 2024-09-10T22:50:31Z

Pulled the PR and tested locally. I couldn't get it working by clicking "Add company cards" btw only by manually entering the route.

Looking great though. No notes 🥲

dubielzyk-expensify

LGTM

robertjchen

Awesome, thanks!

OSBotify · 2024-09-11T00:35:24Z

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

Pujan92 · 2024-09-12T20:07:27Z

assets/images/companyCards/card-amex-blue.svg

@waterim I think we need to re-export correct SVG where some space has been there in top/bottom, consistent with other icons. ref

OSBotify · 2024-09-12T21:18:47Z

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.33-4 🚀

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

allgandalf · 2024-11-12T08:53:39Z

src/pages/workspace/companyCards/addNew/CardNameStep.tsx

+                    inputID={INPUT_IDS.CARD_TITLE}
+                    label={translate('workspace.companyCards.addNewCard.enterNameOfBank')}
+                    role={CONST.ROLE.PRESENTATION}
+                    defaultValue={addNewCard?.data?.cardTitle}


We didn't add the max length for card name this caused #51564

allgandalf · 2024-11-17T15:12:32Z

src/pages/workspace/companyCards/addNew/CardTypeStep.tsx

+                data: {
+                    cardType: typeSelected,
+                },


We should had cleared the Bank name, Bank name used to persist between different banks in the "Other" card feed. This missed added bankName variable here to update for the same, this caused #51860

DylanDylann · 2024-11-27T01:25:02Z

src/pages/workspace/companyCards/addNew/DetailsStep.tsx

+                <Text style={[styles.textHeadlineLineHeightXXL, styles.ph5, styles.mv3]}>
+                    {feedProvider ? translate(`workspace.companyCards.addNewCard.feedDetails.${feedProvider}.title`) : ''}
+                </Text>
+                <FormProvider


In native, pressing a button normally doesn't blur the active input. But in our case, the page is wrapped with a ScrollView with no keyboardShouldPersistTaps

It caused this bug #52144

waterim added 17 commits August 27, 2024 21:55

add translations

739618e

update const

60827be

add new form and key for adding card to the onyx

0a8da42

add new routes

e5b12f6

add screens and navigations

fa81496

new companyCardUtils

abfa5b9

CompanyCards actions file

df253a9

initial page

d874d0b

instructions page

06c4a30

name step page

40cd9e4

type step page

679cb22

details step

2cf779d

types for form and new onyx key for adding a card

d8e9a1f

update translations

477dd2f

update utils

a1a9a03

update navigation

07a4c2a

update steps

d1240ef

waterim marked this pull request as ready for review August 28, 2024 18:55

waterim requested a review from a team as a code owner August 28, 2024 18:55

melvin-bot bot requested a review from Pujan92 August 28, 2024 18:55

melvin-bot bot removed the request for review from a team August 28, 2024 18:55

Pujan92 suggested changes Aug 29, 2024

View reviewed changes

waterim added 5 commits August 29, 2024 14:40

remove unused CONST

9675c7a

change data to not use unneeded array push

495a908

remove unused routes

8c191e3

fix linter

a05246f

remove policyID

97a6a1e

waterim added 3 commits September 9, 2024 13:23

remove unused functions

a441561

remove unused translation function

3c3350e

remove useCallbacks and useMemos as we have react compiler for that

92fb88d

fix lint

96a5d68

iwiznia requested changes Sep 9, 2024

View reviewed changes

waterim added 5 commits September 9, 2024 14:36

remove unused code

919cb16

remove unused code

4323c19

update translations

7caf812

removed unnecessary validation code

1641d03

update translations and validation

695f2a8

iwiznia approved these changes Sep 10, 2024

View reviewed changes

Pujan92 mentioned this pull request Sep 10, 2024

[NO QA] Feat: Pending state with no feed #48489

Merged

58 tasks

dubielzyk-expensify approved these changes Sep 10, 2024

View reviewed changes

robertjchen approved these changes Sep 11, 2024

View reviewed changes

robertjchen merged commit 7766b7b into Expensify:main Sep 11, 2024
17 checks passed

github-actions bot mentioned this pull request Sep 11, 2024

Deploy Checklist: New Expensify 2024-09-11 #49025

Closed

49 tasks

This was referenced Sep 12, 2024

Company cards - "What's the Amex delivery file name" is missing a question mark #49046

Closed

Company cards - AMEX icon is cut off on Android and iOS app #49047

Closed

Pujan92 reviewed Sep 12, 2024

View reviewed changes

allgandalf reviewed Nov 12, 2024

View reviewed changes

allgandalf mentioned this pull request Nov 12, 2024

[HOLD for payment 2024-11-11] [Custom feeds] The freeform fields have incorrect limit #51564

Closed

allgandalf reviewed Nov 17, 2024

View reviewed changes

DylanDylann reviewed Nov 27, 2024

View reviewed changes

DylanDylann mentioned this pull request Nov 27, 2024

[HOLD for payment 2024-11-26] [$250] Company cards - Error appears after tapping the explanation link for the first time #52144

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: Add company card feed flow #48119

Feat: Add company card feed flow #48119

waterim commented Aug 27, 2024 •

edited

Loading

melvin-bot bot commented Aug 28, 2024

joekaufmanexpensify commented Aug 28, 2024

Pujan92 commented Aug 30, 2024 •

edited

Loading

waterim commented Sep 9, 2024

iwiznia Sep 9, 2024

waterim Sep 9, 2024

iwiznia Sep 9, 2024

waterim Sep 9, 2024

joekaufmanexpensify commented Sep 10, 2024

dannymcclain commented Sep 10, 2024

dubielzyk-expensify commented Sep 10, 2024

dubielzyk-expensify left a comment

robertjchen left a comment

OSBotify commented Sep 11, 2024

Pujan92 Sep 12, 2024

OSBotify commented Sep 12, 2024

allgandalf Nov 12, 2024

allgandalf Nov 17, 2024

DylanDylann Nov 27, 2024

Feat: Add company card feed flow #48119

Feat: Add company card feed flow #48119

Conversation

waterim commented Aug 27, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 28, 2024

joekaufmanexpensify commented Aug 28, 2024

Pujan92 commented Aug 30, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

waterim commented Sep 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joekaufmanexpensify commented Sep 10, 2024

dannymcclain commented Sep 10, 2024

dubielzyk-expensify commented Sep 10, 2024

dubielzyk-expensify left a comment

Choose a reason for hiding this comment

robertjchen left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 11, 2024

Choose a reason for hiding this comment

OSBotify commented Sep 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

waterim commented Aug 27, 2024 •

edited

Loading

Pujan92 commented Aug 30, 2024 •

edited

Loading