HIGH: [Debugability] [$250] Add logs for network queue length

[arosiclair]

Problem

It's difficult to recognize when there is an issue with the App's network queue especially in production. If the queue gets stuck and fails to process any new requests, it's difficult to recognize when this is happening without logging. This is a critical problem because all reads are blocked on the write queue.

Solution

Add the current length of the network queue to the log whenever another API command is queued. This should make it easy to recognize when the app is failing to clear the queue just by viewing logs.

Specifically, we should

• log the length of persistedRequests when requests get added to the SequentialQueue
• log when a read is being blocked by queued writes here

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~013c1fa89f2e72f914
• Upwork Job ID: 1780254517492736000
• Last Price Increase: 2024-04-16
• Automatic offers:
• tienifr | Contributor | 0

[melvin-bot]

Triggered auto assignment to @strepanier03 (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]

Job added to Upwork: https://www.upwork.com/jobs/~013c1fa89f2e72f914

[melvin-bot]

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

[gijoe0295]

Dibs

[tienifr]

Proposal

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

We want to add logs for network queue length

What is the root cause of that problem?

This is new feature.

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

We should

• log the length of persistedRequests when requests get added to the SequentialQueue
• log when a read is being blocked by queued writes here

More details:

1. Add a method to get persisted request length to PersistedRequests.ts, in here

function getLength(): number {
    return persistedRequests.length;
}

2. In here, log the length of persistedRequests when requests get added to the SequentialQueue

Log.info('[RequestQueue] New request saved to PersistedRequests, the length of queue is currently ' + PersistedRequests.getLength());

3. Log when a read is being blocked by queued writes here, using similar log as 2. We can check if the read is blocked by checking if there's any write request in the PersistedRequests at the time the read is being done:

if (PersistedRequests.getLength() > 0) {
    Log.info('[RequestQueue] The read command ' + command + ' is being blocked by ' + PersistedRequests.getLength() + ' write requests');
}

The message format can be adjusted according to the requirements.

What alternative solutions did you explore? (Optional)

Instead of defining the new method to get length, can just use getAll().length.

As far as I can see, only write requests will end up in the persistedRequests queue. If somehow I'm wrong, then in step 3 we might have to filter out the write requests to get its length

const writeRequests = PersistedRequests.getAll().filter(request => request?.data?.apiRequestType === CONST.API_REQUEST_TYPE.WRITE);

[mananjadhav]

While I understand the job is straight forward, @gijoe0295 @tienifr let's have a basic content on the proposal. Let's not copy-paste GH issue description.