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

Tag settings: Billable #47019 #48184

Conversation

Guccio163
Copy link
Contributor

@Guccio163 Guccio163 commented Aug 28, 2024

Details

This PR adds new switch do Tag settings that allows user to easily enable/disable tracking billing expenses:
Screenshot 2024-08-28 at 10 40 33

It also changes Tags description in Workspace settings and fixes some bugs with alignment and API props.
Screenshot 2024-08-28 at 10 40 50

Fixed Issues

$ #47019
PROPOSAL:

Tests

  1. Go to /settings/workspaces/:policyID/tags/settings
  2. Check if switches are aligned correctly
  3. Switch Track billable expenses couple times - DisablePolicyBillableExpenses on off and SetPolicyBillableMode on on should be visible in network debugger, switch should stay on\off after changing
  4. Switch to offline mode - Track billable expenses switch should grey out after clicking (but not without click)
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

  • 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
mWeb-android.mov
iOS: Native
ios.mov
iOS: mWeb Safari
mWeb-ios.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@Guccio163
Copy link
Contributor Author

Guccio163 commented Aug 28, 2024

PR is working correctly like it should, there are 3 issues to clarify and 1 to correct:

To clarify:

  1. Function for disabling Billable Expenses is called DisableWorkspaceBillableExpenses in doc, but API accepts only DisablePolicyBillableExpenses, I left it with the working name.
  2. In doc there is written that function above shouldn't take any parameters; I left it with 1 parameter which is policyID to identify workspace.
  3. In doc there is written that "If [policy.disabledFields.defaultBillable is] true this toggle would be disabled "; I suppose it means that it should be off, not disabled then and that's how it works right now; should this button be disabled in some condition?

To correct:

  1. Need to add translations to Classify costs and track billable expenses. and Track billable expenses, second one is hardcoded right now

cc: @marcaaron

@Guccio163
Copy link
Contributor Author

Guccio163 commented Aug 29, 2024

After change in /settings/workspaces/{policyID}/tags/settings Switches are not aligned correctly yet, I'll fix it in a while; Is:
Screenshot 2024-08-29 at 10 21 24
Should be:
Screenshot 2024-08-28 at 10 40 33
The misalignment is visible only the button above is hovered 🔎

Screenshot 2024-08-29 at 10 24 00

Copy link
Contributor

@WojtekBoman WojtekBoman left a comment

Choose a reason for hiding this comment

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

LGTM, left some small comments

@Guccio163 Guccio163 marked this pull request as ready for review August 29, 2024 13:09
@Guccio163 Guccio163 requested a review from a team as a code owner August 29, 2024 13:09
@melvin-bot melvin-bot bot requested review from situchan and removed request for a team August 29, 2024 13:09
Copy link

melvin-bot bot commented Aug 29, 2024

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

@Guccio163
Copy link
Contributor Author

Also @shawnborton if you could take a peek if the switches look good 👀🙏
Screenshot 2024-08-29 at 15 11 32

@shawnborton
Copy link
Contributor

Design-wise this looks okay. Why does the toggle become locked out of curiosity?

@Guccio163
Copy link
Contributor Author

I'm not sure about the top switch because I didn't get into it; this PR is only about 'Track billable expenses' one

@shawnborton
Copy link
Contributor

Cool cool, well that toggle looks good to me :)

@situchan
Copy link
Contributor

situchan 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
mchrome.mp4
iOS: Native
ios.mov
iOS: mWeb Safari
msafari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@marcaaron
Copy link
Contributor

Function for disabling Billable Expenses is called DisableWorkspaceBillableExpenses in doc, but API accepts only DisablePolicyBillableExpenses, I left it with the working name.

👍

In doc there is written that function above shouldn't take any parameters; I left it with 1 parameter which is policyID to identify workspace.

👍

In doc there is written that "If [policy.disabledFields.defaultBillable is] true this toggle would be disabled "; I suppose it means that it should be off, not disabled then and that's how it works right now; should this button be disabled in some condition?

Right, we really meant, "toggled off". And no, it should never be "disabled".

Copy link
Contributor

@situchan situchan 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 marcaaron August 30, 2024 02:21
@Guccio163
Copy link
Contributor Author

Guccio163 commented Aug 30, 2024

Also, on the request of @WojtekBoman I quickly fixed #48266 bug, it required changing list items' order, but doesn't affect this PR :)

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

Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

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

LGTM, had a couple of small notes. Also, I'm not sure we have had the translations reviewed yet. I'll ask again for some help.

if (policy?.disabledFields?.defaultBillable) {
return policy?.pendingFields?.disabledFields ?? policy?.pendingFields?.defaultBillable;
}
return policy?.pendingFields?.disabledFields;
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we add some comment here to explain the slightly confusing interaction between disabledFields.defaultBillable and defaultBillable? In particular, it's hard to see why we would fallback to a pendingFields.defaultBillable.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just added, please take a peek if it's clear

Copy link
Contributor

Choose a reason for hiding this comment

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

I was looking more for something like "why" it works this way. I am not sure if I understood why we have a billableExpensesPending() method instead of checking for our possible "pending" situations.

To give some explanation of the feature itself:

if we ever have policy.disabledFields.defaultBillable that means the feature is disabled entirely. If we have policy.defaultBillable === true then policy.disabledFields.defaultBillable must be false and that means we will always "default to billable". If policy.defaultBillable === false then we will default to "non-billable".

After explaining that, does it make sense to have a fallback to policy?.pendingFields?.defaultBillable when we are "disabled"? I would think not because the only value that matters is the policy.pendingFields.disabledFields.defaultBillable for that particular case.

Copy link
Contributor

Choose a reason for hiding this comment

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

So I think the logic would be more like:

// The field is disabled - only show the "pending" for the disabled pending action because the defaultBillable state is not relevant in this case.
if (policy.disabledFields.defaultBillable) {
    return policy.pendingFields.disabledFields;
}

// Otherwise, we are changing the `defaultBillable` so look at this field only.
return policy.pendingFields.defaultBillable;

WDYT?

iwiznia
iwiznia previously requested changes Sep 3, 2024
@Guccio163
Copy link
Contributor Author

The translations were already reviewed on Slack with the help of @pecanoro, but I can change them to fit @iwiznia if you wish 👍

@iwiznia
Copy link
Contributor

iwiznia commented Sep 3, 2024

Did not know that, @marcaaron asked for it in slack. Of course 2 translators means 2 different translations.

Guccio163 and others added 4 commits September 3, 2024 20:24
Co-authored-by: Ionatan Wiznia <iwiznia@hotmail.com>
Co-authored-by: Ionatan Wiznia <iwiznia@hotmail.com>
Co-authored-by: Marc Glasser <marc.aaron.glasser@gmail.com>
@Guccio163
Copy link
Contributor Author

Guccio163 commented Sep 3, 2024

No problem, I just added requested changes, @marcaaron they should pass just passed the tests 👌 Also I just deleted some comments I left in the previous PR, just using the occasion to clean it

@marcaaron
Copy link
Contributor

The translations were already reviewed on Slack with the help of @pecanoro, but I can change them to fit @iwiznia if you wish 👍

Maybe the long weekend confused me, but where did this happen? 😄
AFAICT these have not been reviewed yet, or else we'd see @pecanoro as a reviewer here 🤔

@Guccio163
Copy link
Contributor Author

Guccio163 commented Sep 3, 2024

I asked for them here, but I guess it doesn't matter much anymore since @iwiznia came by, should I tag the translations reviewer in the PR next time?

Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

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

Changes LGTM though I am not so sure about billableExpensesPending()

// },
// ],
// [searchAdvancedFilters, translate, cardList, taxRates, personalDetails, reports],
// );
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, what is happening here? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah yes, like I mentioned above this is a leftover after my previous PR; I was resolving conflicts at the Friday evening and left it by mistake so I'm deleting it here as the first occasion 😅

if (policy?.disabledFields?.defaultBillable) {
return policy?.pendingFields?.disabledFields ?? policy?.pendingFields?.defaultBillable;
}
return policy?.pendingFields?.disabledFields;
Copy link
Contributor

Choose a reason for hiding this comment

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

I was looking more for something like "why" it works this way. I am not sure if I understood why we have a billableExpensesPending() method instead of checking for our possible "pending" situations.

To give some explanation of the feature itself:

if we ever have policy.disabledFields.defaultBillable that means the feature is disabled entirely. If we have policy.defaultBillable === true then policy.disabledFields.defaultBillable must be false and that means we will always "default to billable". If policy.defaultBillable === false then we will default to "non-billable".

After explaining that, does it make sense to have a fallback to policy?.pendingFields?.defaultBillable when we are "disabled"? I would think not because the only value that matters is the policy.pendingFields.disabledFields.defaultBillable for that particular case.

if (policy?.disabledFields?.defaultBillable) {
return policy?.pendingFields?.disabledFields ?? policy?.pendingFields?.defaultBillable;
}
return policy?.pendingFields?.disabledFields;
Copy link
Contributor

Choose a reason for hiding this comment

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

So I think the logic would be more like:

// The field is disabled - only show the "pending" for the disabled pending action because the defaultBillable state is not relevant in this case.
if (policy.disabledFields.defaultBillable) {
    return policy.pendingFields.disabledFields;
}

// Otherwise, we are changing the `defaultBillable` so look at this field only.
return policy.pendingFields.defaultBillable;

WDYT?

@marcaaron
Copy link
Contributor

I asked for them here, but I guess it doesn't matter much anymore since @iwiznia came by, should I tag the translations reviewer in the PR next time?

All good, thanks. Yes, please next time leave either a note on the PR that the translations were approved, or tag the PR reviewers in Slack on the thread, or have the translations reviewer on the PR itself. Any of those would work. Thanks!

@Guccio163
Copy link
Contributor Author

After explaining that, does it make sense to have a fallback to policy?.pendingFields?.defaultBillable when we are "disabled"? I would think not because the only value that matters is the policy.pendingFields.disabledFields.defaultBillable for that particular case.

I left both values to check because both are edited, so I wanted to be sure both are not pending. Moreover I think it looks a bit more understandable for someone without context why we check them both and not only one, but I'm not strongly against change. If you think it would be cleaner with only one check I can change it in no time ;)

Co-authored-by: Marc Glasser <marc.aaron.glasser@gmail.com>
@marcaaron
Copy link
Contributor

I left both values to check because both are edited, so I wanted to be sure both are not pending. Moreover I think it looks a bit more understandable for someone without context why we check them both and not only one, but I'm not strongly against change. If you think it would be cleaner with only one check I can change it in no time ;)

Your reasoning is fine. I think there's enough context here now in case someone is really confused in the future 😄

@marcaaron marcaaron dismissed iwiznia’s stale review September 3, 2024 20:21

changes applied

@marcaaron marcaaron merged commit 227aa13 into Expensify:main Sep 3, 2024
16 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Sep 3, 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 Sep 3, 2024

🚀 Deployed to staging by https://github.com/marcaaron in version: 9.0.29-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Sep 5, 2024

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.29-12 🚀

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.

7 participants