Add import and export CSV flow for Tags #48877

Guccio163 · 2024-09-10T10:38:09Z

Details

This PR adds the import and export logic to the Tags sections of the workspace. Right now it supports only workspaces with 1 tag list, no more. For workspaces with more than 1 tag list, the whole three-dot menu is invisible. This PR takes into account all raised and fixed bugs for Category section's import/export functions.

Fyi: This PR is created in parallel with PR for Members import/export which operates on similar files - depending on which gets merged earlier there will be few minor conflicts to take care of.

Fixed Issues

$ #47870
PROPOSAL:

Tests

Enter a workspace with multiple tag lists, the 3-dot menu should not be visible.

Import:

Go to any Workspace -> Categories
Press three dots (in header)
Press Import spreadsheet
Press Choose file
Select xls, xlsx, csv or txt file
Select columns to import
Press import
Selected column of chosen file should be imported

Export:

Navigate into workspace with single tag list.
Enter Tags section.
Add some members 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.
"Members-[time] [date]" file should be downloaded with all members in .csv format.

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

web.mov

MacOS: Desktop

desktop.mov

…-fork into Guccio/import-tags-csv

blazejkustra

Looks good too! 🙌

src/pages/workspace/tags/ImportedTagsPage.tsx

src/libs/actions/Policy/Tag.ts

src/pages/workspace/tags/ImportedTagsPage.tsx

…-fork into Guccio/import-tags-csv

Guccio163 · 2024-09-11T15:18:42Z

@Expensify/design PR ready to check out

melvin-bot · 2024-09-11T15:18:51Z

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

…-fork into Guccio/import-tags-csv

blazejkustra · 2024-09-11T16:26:22Z

@rushatgabhane in case of conflicts/change requests please ping me, I'm going to take over from Wiktor as he will be OOO in the next days 😄

blazejkustra · 2024-09-13T07:40:07Z

@rushatgabhane When do you think you'll be able to finish the review on this one?

rushatgabhane · 2024-09-15T18:38:52Z

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-15.at.22.02.57.mov

Android: mWeb Chrome

iOS: Native

Screen.Recording.2024-09-15.at.22.00.24.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-09-15.at.21.44.17.mov

Screen.Recording.2024-09-15.at.21.2.mp4

Screen.Recording.2024-09-15.at.21.3.mp4

MacOS: Desktop

Screen.Recording.2024-09-15.at.21.53.48.mov

rushatgabhane

LGTM

melvin-bot · 2024-09-15T19:05:54Z

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

blazejkustra · 2024-09-16T14:27:11Z

@MonilBhavsar Merged the newest main for you 😄

MonilBhavsar · 2024-09-16T23:35:25Z

src/pages/workspace/tags/ImportedTagsPage.tsx

+            {text: translate('common.enabled'), value: CONST.CSV_IMPORT_COLUMNS.ENABLED, isRequired: true},
+        );
+
+        if (isControl) {


NAB, let's use isControlPolicy(policy) directly

Or we can rename constant to isControlPolicy

MonilBhavsar · 2024-09-16T23:36:52Z

Looks good overall!

blazejkustra · 2024-09-17T06:56:27Z

@MonilBhavsar Moved the condition, so it's used directly now 🚀

MonilBhavsar

Thanks! Looks good 👍

OSBotify · 2024-09-17T17:47:30Z

✋ 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 · 2024-09-17T20:52:04Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 9.0.37-0 🚀

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

OSBotify · 2024-09-19T23:33:56Z

🚀 Deployed to production by https://github.com/grgia in version: 9.0.38-4 🚀

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

filip-solecki and others added 10 commits August 23, 2024 13:57

Add import flow to Tags page

eb39682

Merge branch 'main' into filip-solecki/import-tags-csv

45e000f

Fix Tags importing

a3f54c8

Merge branch 'main' into filip-solecki/import-tags-csv

694fc03

adding fixes after categories

0383f89

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

1b6871d

…-fork into Guccio/import-tags-csv

tagLists non-multiple fixed

c87efbc

add tags export

0a2a025

hiding threeDot behind multipleTags conditional

86cb342

fix typo

4e546d2

blazejkustra approved these changes Sep 11, 2024

View reviewed changes

src/pages/workspace/tags/ImportedTagsPage.tsx Outdated Show resolved Hide resolved

src/libs/actions/Policy/Tag.ts Outdated Show resolved Hide resolved

src/libs/actions/Policy/Tag.ts Outdated Show resolved Hide resolved

src/pages/workspace/tags/ImportedTagsPage.tsx Show resolved Hide resolved

Guccio163 added 3 commits September 11, 2024 10:08

fixes after review

5120cae

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

4088e38

…-fork into Guccio/import-tags-csv

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

8c62f3f

…-fork into Guccio/import-tags-csv

Guccio163 marked this pull request as ready for review September 11, 2024 15:18

Guccio163 requested a review from a team as a code owner September 11, 2024 15:18

melvin-bot bot requested review from rushatgabhane and removed request for a team September 11, 2024 15:18

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

5a96901

…-fork into Guccio/import-tags-csv

Hide the export button when there are no tags

c40c1f4

Merge branch 'main' into Guccio/import-tags-csv

1f1c9a4

rushatgabhane approved these changes Sep 15, 2024

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar September 15, 2024 19:06

Merge branch 'main' into Guccio/import-tags-csv

39d08ac

MonilBhavsar reviewed Sep 16, 2024

View reviewed changes

blazejkustra added 2 commits September 17, 2024 08:54

Merge branch 'main' into Guccio/import-tags-csv

8f4984b

Move isControlPolicy inside if

6674af6

MonilBhavsar approved these changes Sep 17, 2024

View reviewed changes

MonilBhavsar merged commit 9103d8d into Expensify:main Sep 17, 2024
17 checks passed

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

Deploy Checklist: New Expensify 2024-09-17 #49356

Closed

40 tasks

brunovjk mentioned this pull request Oct 7, 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

Add import and export CSV flow for Tags #48877

Add import and export CSV flow for Tags #48877

Guccio163 commented Sep 10, 2024 •

edited

Loading

blazejkustra left a comment

Guccio163 commented Sep 11, 2024

melvin-bot bot commented Sep 11, 2024

blazejkustra commented Sep 11, 2024

blazejkustra commented Sep 13, 2024

rushatgabhane commented Sep 15, 2024 •

edited

Loading

rushatgabhane left a comment

melvin-bot bot commented Sep 15, 2024

blazejkustra commented Sep 16, 2024

MonilBhavsar Sep 16, 2024

MonilBhavsar Sep 16, 2024

MonilBhavsar commented Sep 16, 2024

blazejkustra commented Sep 17, 2024

MonilBhavsar left a comment

OSBotify commented Sep 17, 2024

OSBotify commented Sep 17, 2024

OSBotify commented Sep 19, 2024

Add import and export CSV flow for Tags #48877

Add import and export CSV flow for Tags #48877

Conversation

Guccio163 commented Sep 10, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

blazejkustra left a comment

Choose a reason for hiding this comment

Guccio163 commented Sep 11, 2024

melvin-bot bot commented Sep 11, 2024

blazejkustra commented Sep 11, 2024

blazejkustra commented Sep 13, 2024

rushatgabhane commented Sep 15, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

rushatgabhane left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 15, 2024

blazejkustra commented Sep 16, 2024

MonilBhavsar Sep 16, 2024

Choose a reason for hiding this comment

MonilBhavsar Sep 16, 2024

Choose a reason for hiding this comment

MonilBhavsar commented Sep 16, 2024

blazejkustra commented Sep 17, 2024

MonilBhavsar left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 17, 2024

OSBotify commented Sep 17, 2024

OSBotify commented Sep 19, 2024

Guccio163 commented Sep 10, 2024 •

edited

Loading

rushatgabhane commented Sep 15, 2024 •

edited

Loading