Add "Create Tag" page by allroundexperts · Pull Request #38158 · Expensify/App

allroundexperts · 2024-03-12T18:10:26Z

Details

This PR adds the ability to add a new tag to the workspace in ND.

Fixed Issues

$ #37311
PROPOSAL: N/A

Tests

Create a Control workspace in OD.
Enter the following in the console, while the workspace is open:

var p = Policy.getActive();
p.policy.areTagsEnabled = true;
p.save();

Open ND and go to workspace settings -> tags.
Verify that you can create a new tag.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Create a Control workspace in OD.
Enter the following in the console, while the workspace is open:

var p = Policy.getActive();
p.policy.areTagsEnabled = true;
p.save();

Open ND and go to workspace settings -> tags.
Verify that you can create a new tag.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-03-12.at.10.59.28.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-03-12.at.10.48.42.PM.mov

iOS: Native

Screen.Recording.2024-03-12.at.11.02.44.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-03-12.at.10.44.28.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-03-12.at.10.40.11.PM.mov

MacOS: Desktop

Screen.Recording.2024-03-12.at.10.42.44.PM.mov

melvin-bot · 2024-03-12T18:10:31Z

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

ishpaul777 · 2024-03-12T18:25:50Z

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-03-13.at.1.41.31.AM.mov

Android: mWeb Chrome

Record_2024-03-13-02-00-07.mp4

iOS: Native

RPReplay_Final1710274708.MP4

iOS: mWeb Safari

Screen.Recording.2024-03-13.at.2.35.44.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-03-13.at.1.37.51.AM.mov

MacOS: Desktop

Screen.Recording.2024-03-13.at.2.03.01.AM.mov

ishpaul777 · 2024-03-12T18:29:01Z

src/languages/es.ts

+            tagRequiredError: 'Tag name is required.',
+            existingTagError: 'A tag with this name already exists.',
+            invalidTagName: 'Invalid tag name.',


Can you please ask for translation in slack?

Yes, my bad 😄

still waiting for translations

github-actions · 2024-03-12T18:39:48Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/38158/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/38158/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/38158/NewExpensify.dmg	https://38158.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

ishpaul777 · 2024-03-12T18:58:53Z

@mountiny What should be the offline behaviour here? shouldn't we greyout the newly created tag ?

Screen.Recording.2024-03-13.at.12.27.23.AM.mov

allroundexperts · 2024-03-12T19:00:18Z

@mountiny What should be the offline behaviour here? shouldn't we greyout the newly created tag ?

Screen.Recording.2024-03-13.at.12.27.23.AM.mov

Not within the scope of this ticket. This ticket does not involve the list that displays the tags.

luacmartins · 2024-03-12T19:01:49Z

I think so and I do think it's the scope here since we'd add the pendingAction to the call to createPolicyTag here

ishpaul777 · 2024-03-12T19:04:07Z

Same question for where do we show the error for failure scenario. What is expected ?

allroundexperts · 2024-03-12T19:08:29Z

Same question for where do we show the error for failure scenario. What is expected ?

It would / should show up as a red brick below the list item. Again, I think this should be picked up from the error object inside the policyTagsList object.

ishpaul777 · 2024-03-12T19:16:00Z

src/libs/actions/Policy.ts

+                    Tag: {
+                        errors: ErrorUtils.getMicroSecondOnyxError('workspace.tags.genericFailureMessage'),
+                    },


for failure scenario shouldn't we remove the tag from the onyx?

I don't think we do that. We just show an error and once the user clicks on the x beside the red brick, only then we remove it.

Once the X button is clicked confirming the user read the error the tag should be removed

makes sense.. but i dont see the error appear yet in this pattern do you think that out of scope too?

cc @luacmartins

ishpaul777 · 2024-03-12T19:35:22Z

src/pages/workspace/tags/WorkspaceCreateTagPage.tsx

+                            accessibilityLabel={translate('common.name')}
+                            inputID={INPUT_IDS.TAG_NAME}
+                            role={CONST.ROLE.PRESENTATION}
+                            autoFocus


autofocus prop not works as expected on android and keyboard is not popup. can you try https://github.com/Expensify/App/blob/main/contributingGuides/STYLE.md#how-do-i-auto-focus-a-textinput-using-usefocuseffect for autofocus instead

Record_2024-03-13-01-06-09.mp4

we also have useAutoFocusInput hook that has similar implementation as in the docs, maybe use that ?

ishpaul777 · 2024-03-12T19:59:12Z

Could be expected, but when the tags are loading we don't have the setting button and add tags button is left aligned, the layout feels a little odd

allroundexperts · 2024-03-12T20:09:13Z

Could be expected, but when the tags are loading we don't have the setting button and add tags button is left aligned, the layout feels a little odd

Hm... This is similar to how categories page is behaving. @mountiny / @luacmartins do we need any change here?

src/pages/workspace/tags/WorkspaceCreateTagPage.tsx

mountiny · 2024-03-12T20:15:18Z

interesting, I would say we dont have to worry about it now and handle it together with Categories page as a follow up if the issue is same for both

src/pages/workspace/tags/WorkspaceCreateTagPage.tsx

ishpaul777 · 2024-03-12T20:49:25Z

Last one above then we are good tag design team for final review... (new checklist item)

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.

mountiny · 2024-03-12T21:09:57Z

@shawnborton This is ready for a final look, C+ approved, could you have a look please?

allroundexperts · 2024-03-12T21:10:52Z

We're waiting for translations as well @mountiny

shawnborton · 2024-03-12T21:15:01Z

Looks good to me, thanks!

ishpaul777 · 2024-03-12T21:18:53Z

@allroundexperts Your videos seems to be mismatched with platforms can you please fix that

src/CONST.ts

luacmartins · 2024-03-12T21:24:38Z

src/libs/actions/Policy.ts

+                onyxMethod: Onyx.METHOD.MERGE,
+                key: `${ONYXKEYS.COLLECTION.POLICY_TAGS}${policyID}`,
+                value: {
+                    Tag: {


I don't think this is accurate. A user can rename the tagList name and this request would fail. We need to dynamically update this name. Same goes for the other cases below

Any idea how to get that name? We can have multiple items in a tag list. How would that be handled?

Moving this discussion over to Slack.

src/libs/actions/Policy.ts

src/pages/workspace/tags/WorkspaceCreateTagPage.tsx

src/ROUTES.ts

src/libs/actions/Policy.ts

mountiny

Looking good so far +1 to Carlos's comments, but I think we have to align on the policy terminology

mountiny · 2024-03-12T21:30:52Z

src/languages/es.ts

+            tagRequiredError: 'Tag name is required.',
+            existingTagError: 'A tag with this name already exists.',
+            invalidTagName: 'Invalid tag name.',


still waiting for translations

src/libs/API/parameters/CreateWorkspaceTagsParams.ts

src/libs/actions/Policy.ts

src/libs/API/parameters/CreateWorkspaceTagsParams.ts

src/languages/es.ts

Co-authored-by: Carlos Martins <luacmartins@gmail.com>

melvin-bot · 2024-03-12T23:57:16Z

@luacmartins looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

luacmartins · 2024-03-12T23:59:16Z

Tests passed when I merged.

OSBotify · 2024-03-13T00:03:44Z

✋ 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-03-13T20:00:12Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.52-0 🚀

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

OSBotify · 2024-03-15T10:16:33Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.52-6 🚀

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

allroundexperts added 2 commits March 12, 2024 22:33

feat: add tag create page

38f676f

fix tag exists error

44cfe0c

allroundexperts requested a review from a team as a code owner March 12, 2024 18:10

melvin-bot bot requested review from ishpaul777 and removed request for a team March 12, 2024 18:10

Merge branch 'main' into feat-37311

d145d44

mountiny assigned allroundexperts Mar 12, 2024

mountiny added the Ready To Build label Mar 12, 2024

ishpaul777 reviewed Mar 12, 2024

View reviewed changes

luacmartins self-requested a review March 12, 2024 18:32

This comment was marked as duplicate.

Sign in to view

ishpaul777 reviewed Mar 12, 2024

View reviewed changes

mountiny self-requested a review March 12, 2024 19:51

use auto focus hook

ee97811

ishpaul777 reviewed Mar 12, 2024

View reviewed changes

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

ishpaul777 reviewed Mar 12, 2024

View reviewed changes

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

shouldEnableMaxHeight prop addition

cc5f52c

luacmartins requested changes Mar 12, 2024

View reviewed changes

src/ROUTES.ts Outdated Show resolved Hide resolved

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

mountiny reviewed Mar 12, 2024

View reviewed changes

handle carlos comments

6c0d9fd

ishpaul777 reviewed Mar 12, 2024

View reviewed changes

src/libs/API/parameters/CreateWorkspaceTagsParams.ts Outdated Show resolved Hide resolved

allroundexperts added 2 commits March 13, 2024 02:50

fix type errors

b08f305

fix: use dynamic tag list name

0bc0abd

allroundexperts requested a review from luacmartins March 12, 2024 22:59

allroundexperts added 3 commits March 13, 2024 04:08

merge with main

da3abfd

add missing screen map

33ad899

lint fix

77da015

luacmartins requested changes Mar 12, 2024

View reviewed changes

src/languages/es.ts Outdated Show resolved Hide resolved

src/languages/es.ts Outdated Show resolved Hide resolved

allroundexperts and others added 2 commits March 13, 2024 04:41

Update src/languages/es.ts

e6d275d

Co-authored-by: Carlos Martins <luacmartins@gmail.com>

Update src/languages/es.ts

175fa90

Co-authored-by: Carlos Martins <luacmartins@gmail.com>

luacmartins approved these changes Mar 12, 2024

View reviewed changes

luacmartins merged commit 89df622 into Expensify:main Mar 12, 2024

melvin-bot bot added the Emergency label Mar 12, 2024

luacmartins removed the Emergency label Mar 12, 2024

github-actions bot mentioned this pull request Mar 13, 2024

Deploy Checklist: New Expensify 2024-03-13 #38257

Closed

74 tasks

izarutskaya mentioned this pull request Mar 14, 2024

[HOLD for payment 2024-03-25] [Wave Collect] [Tags] Tag - Tag row is not grayed out when created offline #38289

Closed

6 tasks

melvin-bot bot mentioned this pull request Mar 15, 2024

[PAID - Ready for Manual Request] [$500][Simplified Collect][Tags] Create CreateWorkspaceTagPage #37311

Closed

Conversation

allroundexperts commented Mar 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Mar 12, 2024

Uh oh!

ishpaul777 commented Mar 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

ishpaul777 Mar 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 12, 2024

Uh oh!

ishpaul777 commented Mar 12, 2024

Uh oh!

allroundexperts commented Mar 12, 2024

Uh oh!

luacmartins commented Mar 12, 2024

Uh oh!

This comment was marked as duplicate.

ishpaul777 commented Mar 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

allroundexperts commented Mar 12, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ishpaul777 commented Mar 12, 2024

Uh oh!

allroundexperts commented Mar 12, 2024

Uh oh!

Uh oh!

mountiny commented Mar 12, 2024

Uh oh!

Uh oh!

ishpaul777 commented Mar 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mountiny commented Mar 12, 2024

Uh oh!

allroundexperts commented Mar 12, 2024

Uh oh!

shawnborton commented Mar 12, 2024

Uh oh!

ishpaul777 commented Mar 12, 2024

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

allroundexperts commented Mar 12, 2024 •

edited

Loading

ishpaul777 commented Mar 12, 2024 •

edited

Loading

ishpaul777 Mar 12, 2024 •

edited

Loading

ishpaul777 commented Mar 12, 2024 •

edited

Loading

ishpaul777 commented Mar 12, 2024 •

edited

Loading

allroundexperts Mar 12, 2024 •

edited

Loading