#47927: Export Categories CSV #48687

Guccio163 · 2024-09-06T08:40:17Z

Details

This PR focuses on adding export function to Workspace Categories section. Similar exports for Tags and Members will probably be incorporated into their import PRs after this PR gets approved.

User should have an option to click Download CSV button from three-dot option in the right-top corner. After that a file with categories in .csv format should be downloaded locally.

Fixed Issues

$ #47927
PROPOSAL:

Tests

[Non-android]

Navigate into workspace.
Enter Categories section.
Add some categories if you don'e have any.
Click the three-dot icon in top-right corner (Import Spreadsheet and Download CSV options should appear)
Select Download CSV.
"Categories-[time] [date]" file should be downloaded with all categories in .csv format.

[Android]

Check if there is 'Expensify' folder in 'Downloads' folder on the device.
Navigate into workspace.
Enter Categories section.
Add some categories if you don'e have any.
Click the three-dot icon in top-right corner (Import Spreadsheet and Download CSV options should appear)
Select Download CSV.
"Categories-[time] [date]" file should be downloaded with all categories in .csv format in the Expensify folder.
Repeat steps 2-5, the exported .csv file should be placed in the same Expensify folder as previous file.

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

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

Screen.Recording.2024-09-06.at.13.04.11.mov

MacOS: Desktop

Screen.Recording.2024-09-06.at.13.01.51.mov

filip-solecki

LGTM, small adjustments to be done ✅

src/pages/workspace/categories/WorkspaceCategoriesPage.tsx

src/libs/actions/Policy/Category.ts

melvin-bot · 2024-09-06T10:27:25Z

@rushatgabhane 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 · 2024-09-06T21:36:37Z

Update: today I found a bug in exporting on Android; I've found a fix for it, but have to investigate further whether it will cause some problems. Have a great weekend!

Guccio163 · 2024-09-09T08:47:17Z

Downloading on android works well, I changed the downloading function for android: it works and tests well, looks like it solves this and possible problems in future. Ready for review @rushatgabhane 👌

Screen.Recording.2024-09-09.at.10.38.35.mov

rushatgabhane · 2024-09-09T18:13:38Z

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-09-09.at.23.40.59.mov

Android: mWeb Chrome

iOS: Native

Screen.Recording.2024-09-09.at.22.42.34.mov

iOS: mWeb Safari

Screen.Recording.2024-09-09.at.22.00.47.mov

MacOS: Chrome / Safari

Screen.Recording.2024-09-09.at.21.35.39.mov

MacOS: Desktop

Screen.Recording.2024-09-09.at.21.50.29.mov

…-fork into Guccio163/47927-ExportCSV

melvin-bot · 2024-09-09T20:42:55Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #47927 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

mountiny

One NAB, but that can be addressed in a follow up

mountiny · 2024-09-09T20:51:10Z

src/libs/actions/Policy/Category.ts

+        formData.append(key, String(value));
+    });
+
+    fileDownload(ApiUtils.getCommandURL({command: WRITE_COMMANDS.EXPORT_CATEGORIES_CSV}), 'Categories.csv', '', false, formData, CONST.NETWORK.METHOD.POST);


Can you make the 'Categories.csv' a CONST?

Sure, I'll try to remember to add it in Members or Tags import/export 👍

OSBotify · 2024-09-09T21:04:22Z

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

Categories export done

9e76b69

filip-solecki approved these changes Sep 6, 2024

View reviewed changes

src/pages/workspace/categories/WorkspaceCategoriesPage.tsx Outdated Show resolved Hide resolved

src/pages/workspace/categories/WorkspaceCategoriesPage.tsx Outdated Show resolved Hide resolved

src/libs/actions/Policy/Category.ts Show resolved Hide resolved

swm review fixes

b35465e

Guccio163 changed the title ~~#47927: Export CSV~~ #47927: Export Categories CSV Sep 6, 2024

Guccio163 marked this pull request as ready for review September 6, 2024 10:27

Guccio163 requested a review from a team as a code owner September 6, 2024 10:27

melvin-bot bot requested a review from rushatgabhane September 6, 2024 10:27

melvin-bot bot removed the request for review from a team September 6, 2024 10:27

add solve for imports from Expensify#48623

4f695c6

downloading on Android solved

0b87e4f

mountiny assigned Guccio163 Sep 9, 2024

Guccio163 mentioned this pull request Sep 9, 2024

[Support CSV] Add Export CSV to Categories, Tags and Members #47927

Closed

Guccio163 added 2 commits September 9, 2024 20:47

Merge branch 'main' of github.com:software-mansion-labs/expensify-app…

9edd3cb

…-fork into Guccio163/47927-ExportCSV

Merge branch 'main' of github.com:software-mansion-labs/expensify-app…

dc9cd2d

…-fork into Guccio163/47927-ExportCSV

rushatgabhane approved these changes Sep 9, 2024

View reviewed changes

mountiny approved these changes Sep 9, 2024

View reviewed changes

mountiny merged commit 7e04e86 into Expensify:main Sep 9, 2024
17 checks passed

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

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

Closed

58 tasks

blimpich mentioned this pull request Sep 11, 2024

[Payment due Oct 7][$250] [Support CSV] Categories - File contains errors when downloading CSV with no category #49022

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#47927: Export Categories CSV #48687

#47927: Export Categories CSV #48687

Guccio163 commented Sep 6, 2024 •

edited

Loading

filip-solecki left a comment

melvin-bot bot commented Sep 6, 2024

Guccio163 commented Sep 6, 2024

Guccio163 commented Sep 9, 2024

rushatgabhane commented Sep 9, 2024 •

edited

Loading

melvin-bot bot commented Sep 9, 2024

mountiny left a comment

mountiny Sep 9, 2024

Guccio163 Sep 9, 2024

OSBotify commented Sep 9, 2024

#47927: Export Categories CSV #48687

#47927: Export Categories CSV #48687

Conversation

Guccio163 commented Sep 6, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

filip-solecki left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 6, 2024

Guccio163 commented Sep 6, 2024

Guccio163 commented Sep 9, 2024

rushatgabhane commented Sep 9, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Sep 9, 2024

mountiny left a comment

Choose a reason for hiding this comment

mountiny Sep 9, 2024

Choose a reason for hiding this comment

Guccio163 Sep 9, 2024

Choose a reason for hiding this comment

OSBotify commented Sep 9, 2024

Guccio163 commented Sep 6, 2024 •

edited

Loading

rushatgabhane commented Sep 9, 2024 •

edited

Loading