[HOLD for payment 2024-04-15] [$250] Remove deprecated `ReportUtils.getPolicy()` method

[tgolen]

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

Problem

ReportUtils.getPolicy() is called from a view component 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 policy data, then it needs to subscribe to the policy in Onyx so that it's garaunteed that the data will never be stale or out-of-date.

Solution

• Use withOnyx() to load the data in view components
• Use Onyx.connect() to load the data in other action files
• Remove the usage of ReportUtils.getPolicy() or at least 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/~010ae8bb081ab888f1
• Upwork Job ID: 1772360821776945152
• Last Price Increase: 2024-03-25
• Automatic offers:
• DylanDylann | Contributor | 0

Issue Owner

Current Issue Owner: @CortneyOfstad

[melvin-bot]

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

[melvin-bot]

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

[melvin-bot]

Triggered auto assignment to @CortneyOfstad (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

[Krishna2323]

Proposal

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

Remove deprecated ReportUtils.getPolicy() method

What is the root cause of that problem?

Remove deprecated ReportUtils.getPolicy() method

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

Steps:

1. Need to remove getPolicy from here:
   

   App/src/libs/ReportUtils.ts

   Lines 570 to 579 in c1947c2

   	/**
   	* @deprecated Use withOnyx or Onyx.connect() instead
   	*/
   	function getPolicy(policyID: string | undefined): Policy | EmptyObject {
   	if (!allPolicies || !policyID) {
   	return {};
   	}
   	return allPolicies[`${ONYXKEYS.COLLECTION.POLICY}${policyID}`] ?? {};
   	}

2. There are total 2 components & 18 util functions which uses getPolicy, from there we need to remove the use of getPolicy and add extra parameter for policy.

Note: For components we will use withOnyx()

Result

[abzokhattab]

Proposal

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

Remove deprecated ReportUtils.getPolicy() method

What is the root cause of that problem?

Remove deprecated ReportUtils.getPolicy() method.

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

we need to remove the ReportUtil.getPolicy()

App/src/components/SettlementButton.tsx

Line 142 in 0047ad2

const policy = ReportUtils.getPolicy(policyID);

and, here

App/src/pages/workspace/WorkspaceJoinUserPage.tsx

Line 32 in 058f2d9

const policy = ReportUtils.getPolicy(policyID);

and replace it with oynx similar to the following snippet

withOnyx({
  policy: {
        key: ({route}) => `${ONYXKEYS.COLLECTION.POLICY}${route.params.policyID}`,
    },
})

then here

App/src/libs/NextStepUtils.ts

Line 75 in cb71f33

const policy = ReportUtils.getPolicy(policyID);

, we should use Onyx.connect on top to get the policy using the given id.

also we need to the do same in all the occurencies inside the IOU.js and in the Policy.ts files

Proposal

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

Remove deprecated ReportUtils.getPolicy() method

What is the root cause of that problem?

Identify the usage of ReportUtils.getPolicy() method.

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

After that we need to :

• Use withOnyx() to load the data in view components
• Use Onyx.connect() to load the data in other action files

What alternative solutions did you explore? (Optional)

N/A

[nayabatir1]

Proposal

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

Remove deprecated ReportUtils.getPolicy().

What is the root cause of that problem?

Since ReportUtils.getPolicy() is deprecated need to replace it everywhere with withOnyx or Onyx.connect() to get data

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

• List of files for implementing this change
  • SettlementButton.tsx
  • NextStepUtils.ts
  • ReportUtils.ts
  • Policy.ts
  • WorkspaceJoinUserPage.tsx
• add test case to check getPolicy is not exported from ReportUtils.ts

What alternative solutions did you explore? (Optional)