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

fix navigation for different assignees in confirmation flow #56732

Open
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

twilight2294
Copy link
Contributor

@twilight2294 twilight2294 commented Feb 12, 2025

Explanation of Change

This PR fixes the navigation logic for company cards page, whenever a card is assigned from the workspace members profile page but we select a different member on the confirmation screen, we now redirect to the company cards page than workspace member details page.

Fixed Issues

$ #56009
PROPOSAL: #56009 (comment)

Tests

Same as QA

  • Verify that no errors appear in the JS console

Offline tests

Cannot test offline

QA Steps

Precondition: workspace with several members, with enabled Company cards. Some company cards are added.

  1. Go to ws > Members
  2. Click on member with already assigned company card (if no, assign card to member)
  3. Click on 'New card'
  4. Proceed to the 4th step 'Let’s double check that everything looks right.'
  5. Click on Cardholder field
  6. Select another ws member > Click 'Assign card'

Verify that: User lands to Company cards page, rather than the workspace member profile he was previously on (as you assigned the card to someone else)

  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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

@twilight2294 twilight2294 marked this pull request as ready for review February 12, 2025 06:35
@twilight2294 twilight2294 requested a review from a team as a code owner February 12, 2025 06:35
@melvin-bot melvin-bot bot requested a review from s77rt February 12, 2025 06:35
Copy link

melvin-bot bot commented Feb 12, 2025

@s77rt 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 February 12, 2025 06:35
@twilight2294
Copy link
Contributor Author

@s77rt , I can only test with mocking the data, can you test with some real data please ?

Comment on lines 39 to 41
const parts = backTo?.split('/');
const membersIndex = parts?.indexOf('members') ?? -1;
const workspaceMemberAccountID = parts?.[membersIndex + 1] ?? '';
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a hacky solution. We don't want to assume that the string members is always followed by. the account id. Can we instead extract the account id from assignCard?.data first value?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

okay, I will try that today and update back, thanks for the feedback

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can we instead extract the account id from assignCard?.data first value?

@s77rt we get the assignCard?.data email value for cardholderAccountID, already, and it will keep changing everytime the assingee will change, so i guess our option is to extract the account ID from the URL itself, I will still think through this one, but let me know if you have any idea around this

Copy link
Contributor

Choose a reason for hiding this comment

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

I meant to use the first valid value from assignCard?.data. You can try use useRef or usePrevious hooks.

PS: Only store the first valid value i.e. check that assignedData is not undefined (e.g. onyx data is not loaded yet)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah, usePrevious was the first thing that came in my mind, thanks for the input, I will try implementing it and report back!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@s77rt how about we add a new prop to AssignCardData :

type AssignCardData = {
/** The email address of the assignee */
email: string;

As workspaceMemberEmail, so everytime in WorkspaceMemberNewCardPage, when we set initial data below:

} else {
const data: Partial<AssignCardData> = {
email: memberLogin,
bankName: selectedFeed,

We set this value and later compare this value with cardholder email ? , what do you think of this approach

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's not do that as that info is not part of the card data

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can we instead pass an extra param to the WORKSPACE_EXPENSIFY_CARD_ISSUE_NEW route and use it for comparison with the selected account id

the routes will only take backTo as an extra param by using getUrlWithBackToParam:

App/src/ROUTES.ts

Lines 17 to 20 in edef703

function getUrlWithBackToParam<TUrl extends string>(url: TUrl, backTo?: string, shouldEncodeURIComponent = true): `${TUrl}` {
const backToParam = backTo ? (`${url.includes('?') ? '&' : '?'}backTo=${shouldEncodeURIComponent ? encodeURIComponent(backTo) : backTo}` as const) : '';
return `${url}${backToParam}` as `${TUrl}`;
}

So i guess for this one we would need to build a new similar function which would work for the company cards redirection route, currently it used getUrlWithBackToParam, should i proceed with this approach ?

Copy link
Contributor

Choose a reason for hiding this comment

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

No need for a new function. You can add the param before calling getUrlWithBackToParam. Please refer to SETTINGS_2FA or SETTINGS_EXIT_SURVEY_RESPONSE

Copy link
Contributor Author

@twilight2294 twilight2294 Feb 21, 2025

Choose a reason for hiding this comment

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

Oh sorry i misunderstood what you meant here, yeah, it is a lot more reliable to follow the approach you suggested, updating the code now

@s77rt
Copy link
Contributor

s77rt commented Feb 12, 2025

Also please merge main to take into account the new navigation refactor

@twilight2294
Copy link
Contributor Author

@s77rt done with merging, I'll update the requested change today

Comment on lines 48 to 49
const workspaceMemberAccountID = getPersonalDetailByEmail(firstValidEmail ?? '')?.accountID?.toString() ?? '';
const cardholderAccountID = getPersonalDetailByEmail(data?.email ?? '')?.accountID?.toString() ?? '';
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@s77rt last question, I think we should directly compare numerical values here instead of converting it to a string, it saves extra compute, what do you think ?

@@ -27,10 +27,17 @@ function AssignCardFeedPage({route, policy}: AssignCardFeedPageProps) {
const backTo = route.params?.backTo;
const policyID = policy?.id;
const [isActingAsDelegate] = useOnyx(ONYXKEYS.ACCOUNT, {selector: (account) => !!account?.delegatedAccess?.delegate});
const [firstValidEmail, setFirstValidEmail] = useState<string | null>(null);
useEffect(() => {
if (firstValidEmail || !assignCard?.data?.email) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@s77rt should we disable this error ?, in useState i can initialise the value to empty string and then silence the error here, what do you think ?

@twilight2294 twilight2294 requested a review from s77rt February 21, 2025 06:11
Comment on lines 78 to 82
<ConfirmationStep
policyID={policyID}
backTo={backTo}
workspaceMemberAccountID={workspaceMemberAccountID}
/>
Copy link
Contributor

Choose a reason for hiding this comment

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

I missed that we pass route params here. In that case we shouldn't use the current approach as we are still passing through AssignCardFeedPage. Instead we should store the first valid assignee email and compare it with the current one and if they are not the same let's not pass the backTo param. Something like this:

    const firstAssigneeEmail = useRef(issueNewCard?.data.assigneeEmail);
    if (!firstAssigneeEmail.current) {
        firstAssigneeEmail.current = issueNewCard?.data.assigneeEmail;
    }
    const shouldUseBackToParam = !firstAssigneeEmail.current || firstAssigneeEmail.current === issueNewCard?.data.assigneeEmail;

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@s77rt I tried this one and Confirmation page re-renders each time clearing the firstAssigneeEmail ref, we had to pass it via AssignCardFeedPage only for the value of the ref to persist, you can take a look at 867522c commit of the previous implementation.

Its late for me now, but i will again try to take a look at this tomorrow morning, thanks

Copy link
Contributor

Choose a reason for hiding this comment

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

That code should go in AssignCardFeedPage

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Alright!, I am OoO for today, I will update this PR tomorrow morning, thanks for the patience

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.

2 participants