Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: task not working in self dm through shortcut #39107

Closed
wants to merge 10 commits into from

Conversation

nexarvo
Copy link
Contributor

@nexarvo nexarvo commented Mar 27, 2024

Details

Fixed Issues

$#39049
PROPOSAL: #39049 (comment)

Tests

  1. Go to self-DM
  2. Create a task and assigned to self
  3. Go to FAB
  4. Click Assign task shortcut
  5. Create another task which is assigned to self
  6. Verify that no error appears in self DM report for creating second task
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Go to self-DM
  2. Create a task and assigned to self
  3. Go to FAB
  4. Click Assign task shortcut
  5. Create another task which is assigned to self
  6. Verify that no error appears for creating second task
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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.

Screenshots/Videos

Android: Native
WhatsApp.Video.2024-03-28.at.12.47.03.AM.mp4
Android: mWeb Chrome
WhatsApp.Video.2024-03-28.at.12.47.05.AM.mp4
iOS: Native
ios-3.mp4
iOS: mWeb Safari
ios-3-web.mp4
MacOS: Chrome / Safari
2f93d786-c077-4943-a9b7-00433e040ee6.mp4
MacOS: Desktop
d2854dfd-f72e-407a-b7c0-8a9489909b44.mp4

@nexarvo nexarvo requested a review from a team as a code owner March 27, 2024 21:09
@melvin-bot melvin-bot bot requested review from Santhosh-Sellavel and removed request for a team March 27, 2024 21:09
Copy link

melvin-bot bot commented Mar 27, 2024

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

return (
Object.values(reports ?? {}).find((report) => {
return report?.reportID === reportID;
}) ?? null
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am very confused by this... I think it's doing nothing? ie: if it is null then default to null

Copy link
Contributor

@ishpaul777 ishpaul777 Mar 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not allReports[${ONYXKEYS.COLLECTION.REPORT}${reportID}] ?

return (
 allReports[`${ONYXKEYS.COLLECTION.REPORT}${reportID}`]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it sends null then the existing behaviour create new optimistic report which is expected because there is no report found with that reportID

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ishpaul777 changing it to your suggestion as it returns in O(1) and works as expected also

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am just curious, why do we need a reports param 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I copied the above function and forgot to remove the reports param 😅

Copy link
Contributor

@ishpaul777 ishpaul777 Mar 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ishpaul777 I tested every case where we create task. And in one case the shareToReportID is empty:

function setAssigneeValue(assigneeEmail: string, assigneeAccountID: number, shareToReportID: string, isCurrentUser = false): OnyxEntry<OnyxTypes.Report> {

In that case we can use the old existing behaviour. And if shareToReportID is available we will get report directly by ID using utility function which is the cases we are solving i.e. selfDM

The code:

chatReport = ReportUtils.getChatByParticipants([assigneeAccountID]);

will become:
Screenshot 2024-03-28 at 3 03 16 AM

@@ -653,7 +653,8 @@ function setAssigneeValue(assigneeEmail: string, assigneeAccountID: number, shar
let chatReport: OnyxEntry<OnyxTypes.Report> = null;

if (!isCurrentUser) {
chatReport = ReportUtils.getChatByParticipants([assigneeAccountID]);
const reportID = shareDestination;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The param name shareDestination is a reportID? If so, can we rename this to something like shareToReportID?

Copy link
Contributor Author

@nexarvo nexarvo Mar 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it's reportID. Changing that to shareToReportID

Copy link
Contributor

@iwiznia iwiznia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good but there's a lint error

@nexarvo
Copy link
Contributor Author

nexarvo commented Mar 27, 2024

Testing other task use cases to make sure everything is working as expected.

Copy link
Contributor

@iwiznia iwiznia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually now that I am thinking about this more... I think this might be wrong.

Nothing ensures that the report is loaded here, so we should not assume it is.

Also, we already have the report object in the (all?) callers of setAssigneeValue, so instead of what we did here, we should change setAssigneeValue to receive the full report object directly from its callers. No?

let chatReport: OnyxEntry<OnyxTypes.Report> = null;

if (!isCurrentUser) {
chatReport = ReportUtils.getChatByParticipants([assigneeAccountID]);
const reportID = shareToReportID;
chatReport = ReportUtils.getChatByReportID(reportID);
Copy link
Contributor

@ishpaul777 ishpaul777 Mar 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

orrr we already load allReports in actions/Task we can just use it here

Suggested change
chatReport = ReportUtils.getChatByReportID(reportID);
chatReport = allReports[`${ONYXKEYS.COLLECTION.REPORT}${reportID}`]

@nexarvo
Copy link
Contributor Author

nexarvo commented Mar 27, 2024

@iwiznia I have tested all conditions for task and for some case we have shareToReportID in setAssigneeValue as empty. In that case we can use the existing behaviour and If shareToReportID is available then we can directly get report from the ID instead of comparing the participantIDs as we are doing in ReportUtils.getChatByParticipants This way the old behaviour still exist and the condition specific to selfDM will be added too.

Screenshot 2024-03-28 at 3 03 16 AM

@nexarvo
Copy link
Contributor Author

nexarvo commented Mar 27, 2024

we already have the report object in the (all?) callers of setAssigneeValue

Actually we don't have report available at some places and we are passing task?.shareDestination for that like:

if (report) {
if (option.accountID !== report.managerID) {
const assigneeChatReport = TaskActions.setAssigneeValue(
option?.login ?? '',
option?.accountID ?? -1,
report.reportID,
OptionsListUtils.isCurrentUser({...option, accountID: option?.accountID ?? -1, login: option?.login ?? ''}),
);
// Pass through the selected assignee
TaskActions.editTaskAssignee(report, session?.accountID ?? 0, option?.login ?? '', option?.accountID, assigneeChatReport);
}
Navigation.dismissModal(report.reportID);
// If there's no report, we're creating a new task
} else if (option.accountID) {
TaskActions.setAssigneeValue(
option?.login ?? '',
option.accountID,
task?.shareDestination ?? '',
OptionsListUtils.isCurrentUser({...option, accountID: option?.accountID ?? -1, login: option?.login ?? undefined}),
);
Navigation.goBack(ROUTES.NEW_TASK);
}
},

@iwiznia
Copy link
Contributor

iwiznia commented Mar 28, 2024

Actually we don't have report available at some places and we are passing task?.shareDestination for that like:

Yeah and isn't that a problem? Your code assumes the report will be loaded, but nothing is ensuring that, so the users of this component need to ensure we are loading the needed reports... no?

@nexarvo
Copy link
Contributor Author

nexarvo commented Mar 28, 2024

@iwiznia I have just updated setAssigneeValue to take report as param. Please take a look and let me know.

@@ -652,11 +652,16 @@ function setAssigneeChatReport(chatReport: OnyxTypes.Report) {
* If there is no existing chat, it creates an optimistic chat report
* It also sets the shareDestination as that chat report if a share destination isn't already set
*/
function setAssigneeValue(assigneeEmail: string, assigneeAccountID: number, shareDestination: string, isCurrentUser = false): OnyxEntry<OnyxTypes.Report> {
function setAssigneeValue(assigneeEmail: string, assigneeAccountID: number, shareToReportID: string, isCurrentUser = false, report: OnyxEntry<OnyxTypes.Report>): OnyxEntry<OnyxTypes.Report> {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
function setAssigneeValue(assigneeEmail: string, assigneeAccountID: number, shareToReportID: string, isCurrentUser = false, report: OnyxEntry<OnyxTypes.Report>): OnyxEntry<OnyxTypes.Report> {
function setAssigneeValue(assigneeEmail: string, assigneeAccountID: number, shareToReportID: string, isCurrentUser = false, chatReport: OnyxEntry<OnyxTypes.Report>): OnyxEntry<OnyxTypes.Report> {

chatReport = report;
}
else {
chatReport = ReportUtils.getChatByParticipants([assigneeAccountID]);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how I feel about this. Is this correct in any real cases or is this always going to be wrong?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one case where report is not available like in this cases:

if (report) {
if (option.accountID !== report.managerID) {
const assigneeChatReport = TaskActions.setAssigneeValue(
option?.login ?? '',
option?.accountID ?? -1,
report.reportID,
OptionsListUtils.isCurrentUser({...option, accountID: option?.accountID ?? -1, login: option?.login ?? ''}),
);
// Pass through the selected assignee
TaskActions.editTaskAssignee(report, session?.accountID ?? 0, option?.login ?? '', option?.accountID, assigneeChatReport);
}
Navigation.dismissModal(report.reportID);
// If there's no report, we're creating a new task
} else if (option.accountID) {
TaskActions.setAssigneeValue(
option?.login ?? '',
option.accountID,
task?.shareDestination ?? '',
OptionsListUtils.isCurrentUser({...option, accountID: option?.accountID ?? -1, login: option?.login ?? undefined}),
);
Navigation.goBack(ROUTES.NEW_TASK);
}
},

We are getting the report from route.param and they are null here:

const report: OnyxEntry<Report> = useMemo(() => {
if (!route.params?.reportID) {
return null;
}
if (report && !ReportUtils.isTaskReport(report)) {
Navigation.isNavigationReady().then(() => {
Navigation.dismissModal(report.reportID);
});
}
return reports?.[`${ONYXKEYS.COLLECTION.REPORT}${route.params?.reportID}`] ?? null;
}, [reports, route]);

Example Screenshot 2024-03-28 at 9 55 04 PM Screenshot 2024-03-28 at 9 57 32 PM

In this example the above else condition is triggered. If we don't have this else condition then, it will assume that no report exists for this participant and it will create new optimistic report, which is wrong.

@iwiznia iwiznia requested a review from Gonals March 28, 2024 16:36
@nexarvo
Copy link
Contributor Author

nexarvo commented Mar 28, 2024

Closing this PR due to signed commits issue. This will be handled in #39215

@nexarvo nexarvo closed this Mar 28, 2024
@nexarvo nexarvo deleted the fix/39049-self-dm-task-shortcut branch March 28, 2024 21:40
@nexarvo nexarvo mentioned this pull request Mar 28, 2024
50 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants