Fix inconsistent workspace tooltip #32325

chie2727 · 2023-12-01T01:50:50Z

Details

Fix for archived workspace name in tooltip showing up as 'Unavailable workspace' while the workspace name in the header banner shows correctly

Fixed Issues

$ #31894
PROPOSAL: #31894 (comment)

Tests

Create a new workspace
In the new workspace send a message
Click 'Request money' and make a request
Delete the workspace
In the now archived workspace, go to the message sent earlier and click 'Reply in thread'
In the thread verify that the tooltip shows the correct workspace name

Verify that no errors appear in the JS console

Offline tests

QA Steps

Create a new workspace
In the new workspace send a message
Click 'Request money' and make a request
Delete the workspace
In the now archived workspace, go to the message sent earlier and click 'Reply in thread'
In the thread verify that the tooltip shows the correct workspace name

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

expensify_31894_solution.mp4

MacOS: Desktop

melvin-bot · 2023-12-01T01:50:55Z

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

github-actions · 2023-12-01T01:51:03Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

chie2727 · 2023-12-01T09:08:08Z

I have read the CLA Document and I hereby sign the CLA

cubuspl42

Looks good 👍

cubuspl42 · 2023-12-12T10:45:35Z

@chie2727 Please fix the "Lint code" check

See if reordering the functions will do the trick.

cubuspl42 · 2023-12-12T10:50:08Z

I'm sorry for this situation.

C+s and internal engineers have multiple assignments. Issues sometimes fall out of the radar. Feel free to ping C+ every day during the C+ review phase, and during the internal engineer review phase (now) you can also directly ping the assigned internal engineer every two days or so.

Of course, ideally, this would never be necessary, and quite often it isn't.

nkuoch · 2023-12-13T16:47:11Z

@chie2727 Please fix the "Lint code" check

chie2727 · 2023-12-20T00:36:25Z

@nkuoch I've fixed the Lint Code check by moving getRootParentReport() up in the script. (I also moved up getParentReport() for ease of findability.)

cubuspl42 · 2023-12-20T10:46:16Z

@chie2727 Please pay attention to the checks section and iterate as long as needed.

nkuoch · 2023-12-20T13:53:37Z

chie2727 · 2023-12-21T00:42:35Z

@nkuoch @cubuspl42
I've moved up the getReport() function as well. This should fix the second Lint Code check.

cubuspl42 · 2023-12-21T11:36:38Z

@chie2727

The "PR Author Checklist" checklist is failing. Is it possible that the checklist template has changed in the meantime?

chie2727 · 2023-12-26T00:25:55Z

@cubuspl42
That seems to have been the case..! I've updated the checklist now and the PR Author check is passing.

src/libs/ReportUtils.ts

+    /**
+     * Using typical string concatenation here due to performance issues
+     * with template literals.
+     */


src/libs/ReportUtils.ts

+ */
+function getReport(reportID: string | undefined): OnyxEntry<Report> | EmptyObject {
+    /**
+     * Using typical string concatenation here due to performance issues


src/libs/ReportUtils.ts

+    if (!report?.parentReportID) {
+        return {};
+    }
+    return allReports?.[`${ONYXKEYS.COLLECTION.REPORT}${report.parentReportID}`] ?? {};


src/libs/ReportUtils.ts

+
+/**
+ * Returns the root parentReport if the given report is nested.
+ * Uses recursion to iterate any depth of nested reports.


src/libs/ReportUtils.ts

+ * Returns the root parentReport if the given report is nested.
+ * Uses recursion to iterate any depth of nested reports.
+ */
+function getRootParentReport(report: OnyxEntry<Report> | undefined | EmptyObject): OnyxEntry<Report> | EmptyObject {


src/libs/ReportUtils.ts

+}
+
+/**
+ * Returns the root parentReport if the given report is nested.


src/libs/ReportUtils.ts

+        return {};
+    }
+
+    // Returns the current report as the root report, because it does not have a parentReportID


src/libs/ReportUtils.ts

+
+    const parentReport = getReport(report?.parentReportID);
+
+    // Runs recursion to iterate a parent report


chie2727 · 2023-12-28T03:48:37Z

@cubuspl42
All of the in-code comments were not made by me - I simply moved the existing functions up the script in order to solve the previously occurring Lint Code checks.
If you check the last 2 commits you can see that I have not made any changes to the descriptions so I cannot give you any answer as to why the descriptions/function names are like so.

cubuspl42 · 2023-12-28T10:05:08Z

@chie2727 I'm sorry. I went through my queue and started commenting without noticing that you moved this stuff to satisfy the linter. We always handle multiple issues simultaneously and sometimes become victims of context switching. Also, I could be tired.

cubuspl42 · 2023-12-28T12:42:07Z

@chie2727 Next time, please fill in the "Screenshots/Videos" section. Please don't check off checkboxes without reading them.

cubuspl42 · 2023-12-28T12:48:47Z

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

Web

archived-workspace-tooltip-web.mp4

Mobile Web - Chrome

archived-workspace-tooltip-android-web-compressed.mp4

Mobile Web - Safari

archived-workspace-tooltip-ios-web.mp4

Desktop

iOS

archived-workspace-tooltip-ios.mp4

Android

translate-invite-member-android-compressed.mp4

cubuspl42

@chie2727 Please merge main

chie2727 · 2023-12-29T00:07:07Z

@cubuspl42
I've just updated the Screenshots/Videos section. Will remember to do this early on next time!

The "PR Reviewer Checklist" seems to be failing due to missing checkboxes. I believe after it's been updated I'll be able to merge.

cubuspl42 · 2023-12-29T08:59:52Z

@chie2727 Have you merged main? (as per this request)

Merging main ensures that all lints are passing on the newest version of the code and reduces the risk of "breaking main".

cubuspl42 · 2023-12-29T09:03:00Z

The "PR Reviewer Checklist" seems to be failing due to missing checkboxes.

I think it just needs to re-run. I think it still processed the old checklist comment before I deleted it.

chie2727 · 2023-12-29T09:15:48Z

@cubuspl42
You mean merging this PR into main, yes?
I'm unable to make any merge until the PR Reviewer Check runs again and goes through.

cubuspl42 · 2023-12-29T09:37:53Z

You mean merging this PR into main, yes?

No, I mean merging the upstream main. This is a common practice, and if the PR diverges too much from main (let's say above 500 commits), main should be merged in.

This is what this checkbox is talking about:

 If the main branch was merged into this PR after a review, [...]

It can be done with these commands (when the feature branch is checked out):

git fetch upstream
git merge upstream/main

...assuming the Expensify/App remote is named upstream.

chie2727 · 2024-01-02T23:58:10Z

I see! Sorry for the confusion. I've merged main now!

melvin-bot · 2024-01-03T10:21:47Z

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

OSBotify · 2024-01-03T13:25:08Z

✋ 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-01-04T19:02:54Z

🚀 Deployed to staging by https://github.com/nkuoch in version: 1.4.22-0 🚀

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

OSBotify · 2024-01-04T20:10:31Z

🚀 Deployed to staging by https://github.com/nkuoch in version: 1.4.22-0 🚀

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

OSBotify · 2024-01-09T05:19:11Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.22-6 🚀

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

Fix inconsistent workspace tooltip

819e1d3

chie2727 requested a review from a team as a code owner December 1, 2023 01:50

melvin-bot bot requested review from cubuspl42 and removed request for a team December 1, 2023 01:50

chie2727 mentioned this pull request Dec 1, 2023

[HOLD for payment 2024-01-16][$500] Web - Workspace - Inconsistent tooltip for workspace name in thread and IOU #31894

Closed

6 tasks

cubuspl42 approved these changes Dec 1, 2023

View reviewed changes

melvin-bot bot requested a review from nkuoch December 1, 2023 11:45

nkuoch previously approved these changes Dec 1, 2023

View reviewed changes

Solve lint error

384ed2a

chie2727 dismissed nkuoch’s stale review via 384ed2a December 20, 2023 00:30

Solve lint error 2

35d5921

cubuspl42 suggested changes Dec 27, 2023

View reviewed changes

cubuspl42 suggested changes Dec 28, 2023

View reviewed changes

Merge branch 'Expensify:main' into tooltip-31894

654bbf0

cubuspl42 approved these changes Jan 3, 2024

View reviewed changes

nkuoch approved these changes Jan 3, 2024

View reviewed changes

nkuoch merged commit 53afb94 into Expensify:main Jan 3, 2024
16 checks passed

github-actions bot mentioned this pull request Jan 4, 2024

Deploy Checklist: New Expensify 2024-01-04 #33973

Closed

74 tasks


		const parentReport = getReport(report?.parentReportID);

		// Runs recursion to iterate a parent report

Fix inconsistent workspace tooltip #32325

Fix inconsistent workspace tooltip #32325

Conversation

chie2727 commented Dec 1, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 1, 2023

github-actions bot commented Dec 1, 2023 • edited Loading

chie2727 commented Dec 1, 2023

cubuspl42 left a comment

Choose a reason for hiding this comment

cubuspl42 commented Dec 12, 2023 • edited Loading

cubuspl42 commented Dec 12, 2023

nkuoch commented Dec 13, 2023

chie2727 commented Dec 20, 2023

cubuspl42 commented Dec 20, 2023

nkuoch commented Dec 20, 2023

chie2727 commented Dec 21, 2023

cubuspl42 commented Dec 21, 2023

chie2727 commented Dec 26, 2023

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

chie2727 commented Dec 28, 2023 • edited Loading

cubuspl42 commented Dec 28, 2023

cubuspl42 commented Dec 28, 2023

cubuspl42 commented Dec 28, 2023

Reviewer Checklist

Screenshots/Videos

cubuspl42 left a comment

Choose a reason for hiding this comment

chie2727 commented Dec 29, 2023

cubuspl42 commented Dec 29, 2023

cubuspl42 commented Dec 29, 2023

chie2727 commented Dec 29, 2023

cubuspl42 commented Dec 29, 2023

chie2727 commented Jan 2, 2024 • edited Loading

melvin-bot bot commented Jan 3, 2024

OSBotify commented Jan 3, 2024

OSBotify commented Jan 4, 2024

OSBotify commented Jan 4, 2024

OSBotify commented Jan 9, 2024

chie2727 commented Dec 1, 2023 •

edited

Loading

github-actions bot commented Dec 1, 2023 •

edited

Loading

cubuspl42 commented Dec 12, 2023 •

edited

Loading

chie2727 commented Dec 28, 2023 •

edited

Loading

chie2727 commented Jan 2, 2024 •

edited

Loading