[NoQA] [Wave8] Workspace List Items #32817

MaciejSWM · 2023-12-11T15:01:45Z

Details

This PR creates a new component: WorkspacesListRow.tsx.
This PR doesn't render this component anywhere. To render it , go to WorkspacesListPage.js and override return statement:

Step 1:
Add:
ownerAccountID: policy.ownerAccountID,
to .map((policy) => ({

Step 2:

// import
import React, {useMemo, useRef, useState} from 'react';
import {View} from 'react-native';
import variables from '@styles/variables';
import WorkspacesListRow from './WorkspacesListRow';
// import
    const [layout, setLayout] = useState();
    const containerRef = useRef();

    return (
        <View
            ref={containerRef}
            style={[styles.dFlex, styles.gap3, styles.m5]}
            onLayout={(event) => {
                setLayout(event.nativeEvent.layout.width > variables.extraSmallMobileResponsiveHeightBreakpoint ? CONST.LAYOUT_WIDTH.WIDE : CONST.LAYOUT_WIDTH.NARROW);
            }}
        >
            {_.isEmpty(workspaces) ? (
                <FeatureList
                    menuItems={workspaceFeatures}
                    headline="workspace.emptyWorkspace.title"
                    description="workspace.emptyWorkspace.subtitle"
                />
            ) : (
                _.map(workspaces, (item, index) => (
                    <WorkspacesListRow
                        key={`${item.title}${index}`}
                        title={item.title}
                        workspaceIcon={item.icon}
                        fallbackWorkspaceIcon={item.fallbackIcon}
                        // Real data
                        ownerAccountID={item.ownerAccountID}
                        workspaceType={CONST.POLICY.TYPE.FREE}
                        // Randomized data for testing
                        // ownerAccountID={personalDetails ? Object.keys(personalDetails)[Math.floor(Math.random() * Object.keys(personalDetails).length)] : 1}
                        // workspaceType={[CONST.POLICY.TYPE.CORPORATE, CONST.POLICY.TYPE.TEAM, CONST.POLICY.TYPE.FREE][Math.floor(Math.random() * 3)]}
                        layoutWidth={layout}
                        menuItems={[]}
                    />
                ))
            )}
        </View>
    );

Fixed Issues

$ #32956
PROPOSAL:

Tests

Verify that no errors appear in the JS console
Compare the list items to Figma designs.
[Web+Desktop] Resize the window to test switching between desktop and mobile layouts
Three dots menu is not implemented - makes more sense to implement it in the parent component during actual screen creation instead of this PR.

Offline tests

Same as Tests

QA Steps

Same as Tests

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2023-12-12.at.22.22.28.mov

Android: mWeb Chrome

Screen.Recording.2023-12-12.at.22.26.03.mov

iOS: Native

Screen.Recording.2023-12-12.at.22.16.52.mov

iOS: mWeb Safari

Screen.Recording.2023-12-12.at.22.28.39.mov

MacOS: Chrome / Safari

Screen.Recording.2023-12-12.at.22.29.10.mov

MacOS: Desktop

Screen.Recording.2023-12-12.at.22.25.13.mov

MaciejSWM · 2023-12-12T21:56:50Z

Translations: https://expensify.slack.com/archives/C01GTK53T8Q/p1702073914385499?thread_ts=1702035515.118689&cid=C01GTK53T8Q

aimane-chnaif · 2023-12-21T11:25:17Z

@aimane-chnaif what is here to fix?

I am not sure. Best to ask @Expensify/design about popover position

aimane-chnaif · 2023-12-23T23:26:39Z

There's conflict

aimane-chnaif · 2023-12-24T19:00:08Z

Let's consider anchorPosition issue out of scope (as happening on main) and fix it in separate PR
if @mountiny agrees

blazejkustra · 2023-12-27T13:04:07Z

Typecheck is failing, will look into it

blazejkustra · 2023-12-27T13:06:46Z

@aimane-chnaif Should be fine now, resolved conflicts and fixed failing typecheck

mountiny · 2023-12-27T13:07:32Z

@aimane-chnaif Can you look into this one after the chat switching performance PR?

mountiny · 2023-12-27T13:08:03Z

Let's consider anchorPosition issue out of scope (as happening on main) and fix it in separate PR

Yep if its happening in main lets keep it out of this PR

aimane-chnaif · 2023-12-27T13:11:00Z

@aimane-chnaif Can you look into this one after the chat switching performance PR?

This will be the first one as I already prepared checklist. Just waiting for OOS confirmation 🙂

aimane-chnaif · 2023-12-27T13:11:43Z

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 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 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 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.
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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

src/pages/workspace/WorkspacesListRow.tsx

melvin-bot · 2023-12-27T13:13:30Z

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

aimane-chnaif · 2023-12-27T13:14:21Z

@aimane-chnaif uff you found something really strange:

ThreeDotsMenu/index.js:

    /** The anchor position of the menu */
    anchorPosition: PropTypes.shape({
        top: PropTypes.number,
        right: PropTypes.number,
        bottom: PropTypes.number,
        left: PropTypes.number,
    }).isRequired,

PopoverMenu/popoverMenuPropTypes.js:

    /** The anchor position of the CreateMenu popover */
    anchorPosition: PropTypes.shape({
        top: PropTypes.number,
        right: PropTypes.number,
        bottom: PropTypes.number,
        left: PropTypes.number,
    }).isRequired,

but when popoverMenuPropTypes.js is used in PopoverMenu/index.js it gets overridden:

    /** The horizontal and vertical anchors points for the popover */
    anchorPosition: PropTypes.shape({
        horizontal: PropTypes.number.isRequired,
        vertical: PropTypes.number.isRequired,
    }).isRequired,

once overridden, it then is passed to PopoverWithMeasuredContent.js where it's being used like this:

    // All popover props except:
    // 1) anchorPosition (which is overridden for this component)
    // 2) windowDimensionsPropTypes - we exclude them because we use useWindowDimensions hook instead
    ..._.omit(popoverPropTypes, ['anchorPosition', ..._.keys(windowDimensionsPropTypes)]),

    /** How the popover should be aligned. The value you passed will is the part of the component that will be aligned to the
     * anchorPosition. ie: vertical:top means the top of the menu will be positioned in the anchorPosition */
    anchorAlignment: PropTypes.shape({
        horizontal: PropTypes.oneOf(_.values(CONST.MODAL.ANCHOR_ORIGIN_HORIZONTAL)),
        vertical: PropTypes.oneOf(_.values(CONST.MODAL.ANCHOR_ORIGIN_VERTICAL)),
    }),

Let's create new GH to fix this

mountiny · 2023-12-27T13:34:50Z

@aimane-chnaif

Let's create new GH to fix this

Can you summarize the issue and post in expensify-bugs please in the problem/ possible solution format? I can create the issue based on that

mountiny · 2023-12-27T13:40:59Z

src/pages/workspace/WorkspacesListRow.tsx

+            )}
+        </View>
+    );
+}


are we not adding a displayName for these?

I think we should for function component.
I remember we added lint rule for this but now disabled?

mountiny

Appreciated the review @aimane-chnaif and hard work on this one @MaciejSWM! thanks!

mountiny · 2023-12-27T14:44:36Z

Given this is not touching any exsiting flow in the app I am going to merge this now I think Hayata might be out for the holidays too

OSBotify · 2023-12-27T14:48:45Z

✋ 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 · 2023-12-28T21:19:03Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.18-8 🚀

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

MaciejSWM added 28 commits December 5, 2023 17:01

Add border radius 3 style

6ed9bcb

Create WorkspacesListRow

4346c84

Add Avatar; style Title

c1e3d60

Add unique key; rename and type props

64b8143

Add icons

e4aaaec

Render workspace type icons

11bf35f

Drop height and width from svgs

b8f3bde

Remove explicit fill from icons

3cc533c

Friendly workspace type names

4ac804d

Syntactic name for style

b48be5a

Strong label style

97f5c1b

More accurate types from Policy type

0545dd7

Do not allow PERSONAL workspace type

2db6405

Styles; data; commented props

a4ce86e

Randomized input for testing

d5182e8

Make fallback icon required

6927f9f

Three dots menu UI

d4aeb3f

Merge branch 'main' into wave8/workspace-settings-row

175b74c

Text ellipsis and proper margins

31fc5fe

Workspace type and plan translations

bbb1cb9

Use translate function

0ba4a29

Screen width dependent styles

a5da6e5

Flat flex structure

a897973

Apply flex1 only on wide layout

760c924

Merge branch 'main' into wave8/workspace-settings-row

8aae624

Add isWide prop; add missing attributes

5832829

Merge branch 'main' into wave8/workspace-settings-row

91545df

Fix merge

2dfe4aa

Add validated spanish translations

81aad00

Merge branch 'main' into wave8/workspace-settings-row

20eb6ba

MaciejSWM requested a review from aimane-chnaif December 21, 2023 11:28

Make ownerAccountID optional

102cbbd

Merge branch 'main' into wave8/workspace-settings-row

7048a20

blazejkustra added 2 commits December 27, 2023 14:04

Merge branch 'main' into wave8/workspace-settings-row

a0b55e0

Fix typecheck

4d7cc3a

aimane-chnaif reviewed Dec 27, 2023

View reviewed changes

src/pages/workspace/WorkspacesListRow.tsx Outdated Show resolved Hide resolved

aimane-chnaif approved these changes Dec 27, 2023

View reviewed changes

Fix conditional rendering logic

0502b00

mountiny reviewed Dec 27, 2023

View reviewed changes

Add a displayName

2498c82

mountiny approved these changes Dec 27, 2023

View reviewed changes

mountiny merged commit 7480ed7 into Expensify:main Dec 27, 2023
15 checks passed

mountiny changed the title ~~[Wave8] Workspace List Items~~ [NoQA] [Wave8] Workspace List Items Dec 27, 2023

github-actions bot mentioned this pull request Dec 27, 2023

Deploy Checklist: New Expensify 2023-12-27 #33644

Closed

41 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NoQA] [Wave8] Workspace List Items #32817

[NoQA] [Wave8] Workspace List Items #32817

MaciejSWM commented Dec 11, 2023 •

edited

Loading

MaciejSWM commented Dec 12, 2023

aimane-chnaif commented Dec 21, 2023

aimane-chnaif commented Dec 23, 2023

aimane-chnaif commented Dec 24, 2023

blazejkustra commented Dec 27, 2023

blazejkustra commented Dec 27, 2023

mountiny commented Dec 27, 2023

mountiny commented Dec 27, 2023

aimane-chnaif commented Dec 27, 2023

aimane-chnaif commented Dec 27, 2023

melvin-bot bot commented Dec 27, 2023

aimane-chnaif commented Dec 27, 2023

mountiny commented Dec 27, 2023

mountiny Dec 27, 2023

aimane-chnaif Dec 27, 2023

mountiny left a comment

mountiny commented Dec 27, 2023

OSBotify commented Dec 27, 2023

OSBotify commented Dec 28, 2023

[NoQA] [Wave8] Workspace List Items #32817

[NoQA] [Wave8] Workspace List Items #32817

Conversation

MaciejSWM commented Dec 11, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MaciejSWM commented Dec 12, 2023

aimane-chnaif commented Dec 21, 2023

aimane-chnaif commented Dec 23, 2023

aimane-chnaif commented Dec 24, 2023

blazejkustra commented Dec 27, 2023

blazejkustra commented Dec 27, 2023

mountiny commented Dec 27, 2023

mountiny commented Dec 27, 2023

aimane-chnaif commented Dec 27, 2023

aimane-chnaif commented Dec 27, 2023

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Dec 27, 2023

aimane-chnaif commented Dec 27, 2023

mountiny commented Dec 27, 2023

mountiny Dec 27, 2023

Choose a reason for hiding this comment

aimane-chnaif Dec 27, 2023

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

mountiny commented Dec 27, 2023

OSBotify commented Dec 27, 2023

OSBotify commented Dec 28, 2023

MaciejSWM commented Dec 11, 2023 •

edited

Loading