How to refresh wired service getRecord manually?

Question

Please note that this is not duplicate of LWC Force Refresh Wire getRecord - this question and answer specifically speaks about changes in front-end/UI and capturing that in front-end BUT LDS cannot listen to database changes to record and so we need to manually refresh LDS record cache.

Question:

According to documentation of refreshApex, if we know that record has been updated in database, we can invoke refreshApex to re-invoke and refresh the cached response of Apex method response.

But for wired service getRecord, there is no such method to manually refresh the cache and it refreshes the cache only after 30 seconds from last fetching the record ( - if invoked within or after 30 seconds). If I know that the record has been updated in the database through some backend transaction (like workflow), how can we manually refresh cache of getRecord?

Answer 1

To make refreshApex clear the client-side cache it is necessary to capture and store the entire result from the getRecord wire. In this case you cannot define your handler to accept an anonymous object with data and error properties.

You need to do something like the following. First add a private property to hold the result:

_getRecordResponse;

Then update the handling of the getRecord wire response from something like:

@wire(getRecord, {...})
receiveRecord({error, data}) {
    ...
}

to:

@wire(getRecord, {...})
receiveRecord(response) {
    this._getRecordResponse = response;
    let error = response && response.error;
    let data = response && response.data;
    ...
}

Now that you have the _getRecordResponse, you can force the record to be reloaded by calling:

refreshApex(this._getRecordResponse);

Answer 2

Extending answer from @Phil W,

For below Sample LWC Js:

@api recordId = '00128000009j45tAAA';
@track wiredAccount;

fields = [ACCOUNT_NAME_FIELD, ACCOUNT_DESCRIPTION_FIELD];

@wire(getRecord, { recordId: '$recordId', fields: '$fields' })
fetchAcc(response) {
    console.log('Account => ', JSON.stringify(response));
    this.wiredAccount = response;
}

refreshWire() {
    refreshApex(this.wiredAccount);
}

Although we invoke refreshWire, the wired method fetchAcc will be invoked ONLY if new record and UI record in this.wiredAccount are not same and consecutively see the console log. If the new record is same as UI record this.wiredAccount, the method fetchAcc will not be invoked (even after 30 seconds) and we will not see any console log. Finally, refreshApex should have been named refreshWire as it not just updates apex method response but also wired service response.

Answer 3

We can use notifyRecordUpdateAvailable to refresh data from getRecord.

notifyRecordUpdateAvailable([{recordId: this.theRecordId}]);

About notifyRecordUpdateAvailable: To refresh stale Apex data, invoke the Apex method and then call notifyRecordUpdateAvailable(recordIds) to update the Lightning Data Service (LDS) cache. Lightning Data Service doesn’t manage data provisioned by imperative Apex calls. After you invoke the Apex method, call notifyRecordUpdateAvailable(recordIds) to signal to Lightning Data Service that some records are stale and refresh those records in the cache.

For detail: you can refer to https://developer.salesforce.com/docs/platform/lwc/guide/apex-result-caching.html