[HOLD for payment 2024-07-10] [HOLD for payment 2024-07-02] [$500] Remove exported `ReportUtils.getReport()`

[tgolen]

This is coming from #27262. You can read the issue description there to get the context behind the problem being solved and the mess being cleaned up.

Problem

ReportActionUtils.getReport() is called from many view components and other action files which is an anti-pattern.

Why this is important to fix

It maintains a more pure and exact flow of data through the react application. If the view is using report action data, then it needs to subscribe to the data in Onyx so that it's guaranteed that the data will never be stale or out-of-date.

Solution

• Use useOnyx() to load the data in view components
• Use Onyx.connect() to load the data in other action files
• Remove the usage of ReportUtils.getReport() and prevent it from being exported by adding a test to https://github.com/Expensify/App/blob/main/tests/actions/EnforceActionExportRestrictions.ts

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~014f8c2e6e8d2c1390
• Upwork Job ID: 1780353316902400000
• Last Price Increase: 2024-06-12
• Automatic offers:
• s77rt | Reviewer | 0
• gijoe0295 | Contributor | 0
• nkdengineer | Contributor | 102706170

Issue Owner

Current Issue Owner: @MitchExpensify

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~014f8c2e6e8d2c1390

[melvin-bot]

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

[melvin-bot]

Triggered auto assignment to @MitchExpensify (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.

[gijoe0295]

Proposal

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

Remove exported ReportUtils.getReport()

What is the root cause of that problem?

This is a polish issue.

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

There are currently 28 places using getReport(), we should either use withOnyx (12 places) or Onyx.connect instead. Note that we should keep it inside ReportUtils file, just no longer export it. Then add a test to EnforceActionExportRestrictions to make sure we won't use it in the future.

let allReports: OnyxCollection<Report>;
Onyx.connect({
    key: ONYXKEYS.COLLECTION.REPORT,
    waitForCollectionCallback: true,
    callback: (value) => (allReports = value),
});

withOnyx(
  report: {
      key: ({chatReportID}) => `${ONYXKEYS.COLLECTION.REPORT}${chatReportID}`,
  },
)

What alternative solutions did you explore? (Optional)

NA

[nkdengineer]

Proposal

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

Remove deprecated ReportUtils.getReport() method

What is the root cause of that problem?

This is refactor issue

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

1. For component we should get report via withOnyx of if the component already subscribe the report collection, we will get the report from this

report: {
    key: ({reportID}) =>  `${ONYXKEYS.COLLECTION.REPORT}${reportID}`
}

2. For the libs action, we should use Onyx.connect to get allReports and then use this to get the report

let allReports: OnyxCollection<Report>;
Onyx.connect({
    key: ONYXKEYS.COLLECTION.REPORT,
    waitForCollectionCallback: true,
    callback: (value) => (allReports = value),
});

OPTION: We can create a local function in action file to get the report with reportID and use this in other place of this file that we want.

3. Add a test here to verify that we do not export getReport function in ReportUtils

it('does not export getReport', () => {
    // @ts-expect-error the test is asserting that it's undefined, so the TS error is normal
    expect(ReportUtils.getReport).toBeUndefined();
});

App/tests/actions/EnforceActionExportRestrictions.ts

Line 8 in d8361ee

describe('ReportUtils', () => {

What alternative solutions did you explore? (Optional)

NA