[HOLD for payment 2024-08-05] [$125] Chat - Onyx and DOMException console errors appear when sending an image in a DM

[m-natarajan]

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!

---

Issue found when validating #42592
Version Number: 9.0.3-1
Reproducible in staging?: y
Reproducible in production?: n
If this was caught during regression testing, add the test name, ID and link from TestRail:
Email or phone of affected tester (no customers):
Logs: https://stackoverflow.com/c/expensify/questions/4856
Expensify/Expensify Issue URL:
Issue reported by: Applause internal team
Slack conversation:

Action Performed:

Preconditions: Be a workspace member as a new Gmail account.

1. Navigate to https://staging.new.expensify.com/
2. Log in as the member account
3. Click on FAB - Start chat
4. Select any existing Gmail account
5. Open Chrome console
6. Send an image attachment in the chat

Expected Result:

There shouldn't be any console errors when sending an image.

Actual Result:

"Onyx" and "Uncaught (in promise) DOMException" console errors appear when sending an image in a DM. The "Onyx" error only appears when the user is part of a workspace.

Workaround:

unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Bug6527021_1719554233249!staging.new.expensify.com-1719553282882.txt

Bug6527021_1719554233211.bandicam_2024-06-28_07-40-50-491.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~010b91b6cb691a5c72
• Upwork Job ID: 1806791265391666720
• Last Price Increase: 2024-07-05
• Automatic offers:
• hoangzinh | Reviewer | 103033509
• nkdengineer | Contributor | 103033510

Issue Owner

Current Issue Owner: @dylanexpensify

[melvin-bot]

Triggered auto assignment to @dylanexpensify (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[melvin-bot]

Triggered auto assignment to @iwiznia (DeployBlockerCash), see https://stackoverflowteams.com/c/expensify/questions/9980/ for more details.

[github-actions]

👋 Friendly reminder that deploy blockers are time-sensitive ⏱ issues! Check out the open `StagingDeployCash` deploy checklist to see the list of PRs included in this release, then work quickly to do one of the following:

1. Identify the pull request that introduced this issue and revert it.
2. Find someone who can quickly fix the issue.
3. Fix the issue yourself.

[m-natarajan]

@iwiznia FYI I haven't added the External label as I wasn't 100% sure about this issue. Please take a look and add the label if you agree it's a bug and can be handled by external contributors

[m-natarajan]

We think that this bug might be related to #vip-vsb

[dylanexpensify]

@iwiznia confirmed reproducible

[iwiznia]

In dev I have a billion errors, but not this one.... but also images are not working properly not sure why.

[iwiznia]

I kept struggling with my dev env and still could not make images work there. Will look more on monday

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~010b91b6cb691a5c72

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @hoangzinh (External)

[mountiny]

@kavimuru @m-natarajan @izarutskaya I have tested and the image got sent. I think if it's just a console error without affecting the user, we do not have to block the deploy on it

[melvin-bot]

Upwork job price has been updated to $125

[nkdengineer]

Proposal

Please re-state the problem that we are trying to solve in this issue.

"Onyx" and "Uncaught (in promise) DOMException" console errors appear when sending an image in a DM. The "Onyx" error only appears when the user is part of a workspace.

What is the root cause of that problem?

When saving attachmentInfo to Onyx when sending attachment, the file is being saved to Onyx as is

App/src/libs/ReportUtils.ts

Line 3675 in 4622e19

const attachmentInfo = file ?? {};

However the file selected from the image picker is not a purely JSON-compatible object, it contains functions too (eg. function arrayBuffer as in the error log).

When we attempt to save such function to Onyx, it cannot be serialized and will throw error.

What changes do you think we should make in order to solve the problem?

Before using the saving the file data to Onyx here

App/src/libs/ReportUtils.ts

Line 3675 in 4622e19

const attachmentInfo = file ?? {};

, we need to sanitize it to a JSON-compatible object, the functions are not needed so can be stripped.

const attachmentInfo = file ? {
      name: file?.name,
      source: file?.source,
      uri: file?.uri,
      height: file?.height,
      size: file?.size,
      type: file?.type,
      width: file?.width,
  } : {};

Actually we don't need all the fields of the attachmentInfo because we typically only check the field's existence like in

App/src/libs/ReportActionsUtils.ts

Line 1047 in 55546bb

return reportAction?.isAttachment ?? !!reportAction?.attachmentInfo ?? false;

So we can replace attachmentInfo with a boolean hasAttachmentInfo which indicates attachmentInfo's existence

The same needs to be done for the updateParams here we need to map the JSON-compatible fields like above, or use the sanitizeObject method in the alternative solution. Also same for any location (if any) that could saves objects with functions to Onyx.

What alternative solutions did you explore? (Optional)

Alternate solution 1:

So we can replace attachmentInfo with a boolean hasAttachmentInfo which indicates attachmentInfo's existence

Building on top of the above, a clearer naming could be isAttachmentOnly and isAttachmentWithText, we can handle the naming of variables in PR phase.

Alternate solution 2:
We can write and use a method sanitizeObject that will iterate through all object propoperties and remove all functions or other non-serializable values, leaving only primitive values that can be serialized.

Example implementation pseudo code

function sanitizeObject(obj) {
  return JSON.parse(JSON.stringify(obj, (key, value) => {
    if (value === undefined || typeof value === 'function') {
      return undefined;
    }
    return value;
  }));
}

Manual iteration should also work well.

We can even do this sanitization inside react-native-onyx, before saving anything to local storage, but I prefer being explicit as in the main solution.

[nkdengineer]

Proposal updated with 2nd solution

[hoangzinh]

@nkdengineer thanks for proposing. Are you able to find the offending PR? Moreover, when I test your solution in Web, it raises another error:

[hoangzinh]

@nkdengineer can you put into an alternative solution 1, alternative solution 2 so it's clearer to select?

[nkdengineer]

@hoangzinh Sure, I've done that

[hoangzinh]

@nkdengineer's alternative solution 1 looks good to me #44603 (comment)

🎀👀🎀 C+ reviewed

[melvin-bot]

Current assignee @iwiznia is eligible for the choreEngineerContributorManagement assigner, not assigning anyone new.

[iwiznia]

Looks good to me too

[melvin-bot]

📣 @hoangzinh 🎉 An offer has been automatically sent to your Upwork account for the Reviewer role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job

[melvin-bot]

📣 @nkdengineer 🎉 An offer has been automatically sent to your Upwork account for the Contributor role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job
Please accept the offer and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Keep in mind: Code of Conduct | Contributing 📖

[nkdengineer]

@hoangzinh The PR is here.

[melvin-bot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 9.0.13-4 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• fix: replace attachmentInfo with isAttachmentWithText #45043

If no regressions arise, payment will be issued on 2024-08-05. 🎊

For reference, here are some details about the assignees on this issue:

• @hoangzinh requires payment automatic offer (Reviewer)
• @nkdengineer requires payment automatic offer (Contributor)

[melvin-bot]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@hoangzinh] The PR that introduced the bug has been identified. Link to the PR:
• [@hoangzinh] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:
• [@hoangzinh] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:
• [@hoangzinh] Determine if we should create a regression test for this bug.
• [@hoangzinh] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.
• [@dylanexpensify] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[dylanexpensify]

Payment summary:

• Contributor: @nkdengineer $125
• Contributor+: @hoangzinh $125

Please apply/request!

[dylanexpensify]

@nkdengineer please accept offer when you can!

[nkdengineer]

@dylanexpensify Thanks for the offer, I accepted it 👍

[dylanexpensify]

Nice - paying now!

[dylanexpensify]

Done!