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 - Domain Card - User can edit the date in expenses related to the assigned domain card #39244

Merged

Conversation

FitseTLT
Copy link
Contributor

@FitseTLT FitseTLT commented Mar 29, 2024

Details

Fixed Issues

$#36616
PROPOSAL: #36616 (comment)

Tests

  1. On any arbitrary transaction identified the transactionID
  2. In Money Request View following this instruction added a useEffect code that will set the transaction as ECardTransaction
useEffect(() => {
Onyx.merge('cardList',
{
  4: {
    "bank": "Expensify Card",
    "lastFourPAN": 3458,
  }
}
);

Onyx.merge('transactions_<TRANSACTIONID>', {amount: 1000, currency: 'USD', cardID: 4,  modifiedMerchant: null, merchant: "Test ECard Transaction", mccGroup: "Airlines", status:"Posted", hasEReceipt: true, receipt: {}, reimbursable: false });
},[])
  1. Verify the field "Date" is not editable
  • Verify that no errors appear in the JS console

Offline tests

  1. Open App or go to staging.new.expensify.com
  2. Log in with [email protected]
  3. Navigate to the workspace chat for "Domain Card tests - DO NOT DELETE"
  4. Verify there's a report that contains the expenses related to the assigned domain card
  5. Click on the report
  6. Verify you can see the individual expenses
  7. Click on an individual expense to navigate to the detail view
  8. Verify the field "Date" is not editable

QA Steps

  1. Open App or go to staging.new.expensify.com
  2. Log in with [email protected]
  3. Navigate to the workspace chat for "Domain Card tests - DO NOT DELETE"
  4. Verify there's a report that contains the expenses related to the assigned domain card
  5. Click on the report
  6. Verify you can see the individual expenses
  7. Click on an individual expense to navigate to the detail view
  8. Verify the field "Date" is not editable- [x] 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 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(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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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
and.2.mp4
Android: mWeb Chrome
and.web2.mp4
iOS: Native
ios.2.mp4
iOS: mWeb Safari
ios.web.2.mp4
MacOS: Chrome / Safari
web.2.mp4
MacOS: Desktop
desk.2.mp4

@FitseTLT FitseTLT requested a review from a team as a code owner March 29, 2024 15:00
@melvin-bot melvin-bot bot removed the request for review from a team March 29, 2024 15:00
Copy link

melvin-bot bot commented Mar 29, 2024

@allroundexperts 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 requested a review from allroundexperts March 29, 2024 15:00
@allroundexperts
Copy link
Contributor

@FitseTLT I don't have access to the email address you mentioned in test steps. Can you please write proper test steps instead of copying them over from the issue?

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Apr 2, 2024

For dev purpose we follow https://expensify.slack.com/archives/C01GTK53T8Q/p1705450786474319?thread_ts=1705450150.383239&cid=C01GTK53T8Q
But don't think I should include it in the steps b/c they have the access to test it properly but if U want u can use it.

@allroundexperts
Copy link
Contributor

You should mention https://expensify.slack.com/archives/C01GTK53T8Q/p1705450786474319?thread_ts=1705450150.383239&cid=C01GTK53T8Q in test steps. The steps currently there should be in the QA steps section.

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Apr 2, 2024

You should mention https://expensify.slack.com/archives/C01GTK53T8Q/p1705450786474319?thread_ts=1705450150.383239&cid=C01GTK53T8Q in test steps. The steps currently there should be in the QA steps section.

Yep make sense

@allroundexperts
Copy link
Contributor

BUG
Date is editable if the link is opened directly.

Screenshot 2024-04-02 at 5 02 09 PM

@allroundexperts
Copy link
Contributor

allroundexperts commented Apr 2, 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
Screen.Recording.2024-04-02.at.5.08.55.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-04-02.at.5.08.15.PM.mov
iOS: Native
Screen.Recording.2024-04-02.at.5.07.50.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-04-02.at.5.06.35.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-04-02.at.5.01.31.PM.mov
MacOS: Desktop
Screen.Recording.2024-04-02.at.5.05.26.PM.mov

@allroundexperts
Copy link
Contributor

@FitseTLT Conflicts now.

@FitseTLT
Copy link
Contributor Author

FitseTLT commented Apr 3, 2024

U can proceed @allroundexperts

Comment on lines +74 to +79
const parentReportAction = reportActions?.[(isEditingSplitBill ? reportActionID : report?.parentReportActionID) ?? 0];
const canEditingSplitBill =
isEditingSplitBill && session && parentReportAction && session.accountID === parentReportAction.actorAccountID && TransactionUtils.areRequiredFieldsEmpty(transaction);
const canEditMoneyRequest = isEditing && ReportUtils.canEditFieldOfMoneyRequest(parentReportAction ?? null, CONST.EDIT_REQUEST_FIELD.DATE);
// eslint-disable-next-line rulesdir/no-negated-variables
const shouldShowNotFound = !IOUUtils.isValidMoneyRequestType(iouType) || (isEditing && !canEditMoneyRequest && !canEditingSplitBill);
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this change required @FitseTLT? I think this is getting way too complicated.

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 I know. But we need to do it if we want to fix deep link access u mentioned. This is what we did to tag and category pages. It is basically displaying not found page when users are not allowed to edit the date and the logic for permission to edit the field, I took it the logic we use to enable the clicking of the date field in the money request view.

const canEditDate = ReportUtils.canEditFieldOfMoneyRequest(parentReportAction, CONST.EDIT_REQUEST_FIELD.DATE);
const canEditReceipt = ReportUtils.canEditFieldOfMoneyRequest(parentReportAction, CONST.EDIT_REQUEST_FIELD.RECEIPT);

But an additional case we need to consider is for SplitBillDetailsPage (When we create split request with receipt), and for that the logic is taken from
const isEditingSplitBill = session?.accountID === reportAction?.actorAccountID && TransactionUtils.areRequiredFieldsEmpty(transaction);

Copy link
Contributor

Choose a reason for hiding this comment

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

@FitseTLT Isn't ReportUtils.canEditFieldOfMoneyRequest function enough to do the job? Can you share the relevant checks on tags and categories page?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

const isEditing = action === CONST.IOU.ACTION.EDIT;
const isSplitBill = iouType === CONST.IOU.TYPE.SPLIT;
const isEditingSplitBill = isEditing && isSplitBill;
const currentTransaction = isEditingSplitBill && !isEmptyObject(splitDraftTransaction) ? splitDraftTransaction : transaction;
const transactionTag = TransactionUtils.getTag(currentTransaction);
const tag = TransactionUtils.getTag(currentTransaction, tagListIndex);
const reportAction = reportActions?.[report?.parentReportActionID ?? reportActionID];
const canEditSplitBill = isSplitBill && reportAction && session?.accountID === reportAction.actorAccountID && TransactionUtils.areRequiredFieldsEmpty(transaction);
const policyTagLists = useMemo(() => PolicyUtils.getTagLists(policyTags), [policyTags]);
const shouldShowTag = ReportUtils.isGroupPolicy(report) && (transactionTag || OptionsListUtils.hasEnabledTags(policyTagLists));
// eslint-disable-next-line rulesdir/no-negated-variables
const shouldShowNotFoundPage = !shouldShowTag || (isEditing && (isSplitBill ? !canEditSplitBill : reportAction && !canEditMoneyRequest(reportAction)));

Copy link
Contributor

Choose a reason for hiding this comment

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

Isn't ReportUtils.canEditFieldOfMoneyRequest function enough to do the job

Can you please answer above?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nope it is not enough because we have to include the case of split detail page that is what I have included and I have given you a perfect similar example done for tag.

@allroundexperts
Copy link
Contributor

Conflicts again @FitseTLT. Lets try to wrap this up.

@FitseTLT
Copy link
Contributor Author

Conflicts again @FitseTLT. Lets try to wrap this up.

@allroundexperts You can proceed.

@FitseTLT
Copy link
Contributor Author

@allroundexperts Is there anything I can help with? Can we move this forward?

@allroundexperts
Copy link
Contributor

Hi @FitseTLT!

Can you please resolve conflicts?

@FitseTLT
Copy link
Contributor Author

@allroundexperts can u please review it this time?

const policy = getPolicy(moneyRequestReport?.reportID ?? '');
const isAdmin = isExpenseReport(moneyRequestReport) && policy.role === CONST.POLICY.ROLE.ADMIN;
const isManager = isExpenseReport(moneyRequestReport) && currentUserAccountID === moneyRequestReport?.managerID;
if ((fieldToEdit === CONST.EDIT_REQUEST_FIELD.AMOUNT || fieldToEdit === CONST.EDIT_REQUEST_FIELD.CURRENCY) && TransactionUtils.isDistanceRequest(transaction)) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we need to change this condition @FitseTLT?

Copy link
Contributor Author

@FitseTLT FitseTLT May 3, 2024

Choose a reason for hiding this comment

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

This was taken from here

App/src/libs/ReportUtils.ts

Lines 2623 to 2624 in 004b3af

if (TransactionUtils.isDistanceRequest(transaction)) {
const policy = getPolicy(moneyRequestReport?.reportID ?? '');

As we took this

App/src/libs/ReportUtils.ts

Lines 2619 to 2621 in 004b3af

if (TransactionUtils.isCardTransaction(transaction)) {
return false;
}

out of its code block

I had to centralize the condition in one if

@allroundexperts
Copy link
Contributor

Verified it to be still working well.

Screen.Recording.2024-05-06.at.3.03.22.AM.mov

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Looks good!

@melvin-bot melvin-bot bot requested a review from robertjchen May 5, 2024 22:04
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!

@robertjchen robertjchen merged commit 90b67a5 into Expensify:main May 6, 2024
15 of 20 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented May 6, 2024

✋ 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 May 9, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.71-6 🚀

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants