1910848 - Rework QuotaManagerService methods for getting usage to use async messages with async responses

Status: RESOLVED FIXED

(Core :: Storage: Quota Manager, task, P2)

Description

[Jan Varga [:janv]]

The main goal is the ability to get usages asynchronously without using IPC, so it can be easily used in gtests.
This bug also covers some related refactorings, code modernization and cleanup.

Comment 1

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Pull out TraverseRepositoryHelper::GetIsCanceledFlag method into a new base class; r=#dom-storage

Multiple helper classes will need to call this method.

Comment 2

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Pull out GetUsageForOrigin and GetUsageForOriginEntries methods from QuotaUsageRequestBase into a new base class; r=#dom-storage

This is one of the things which are needed for making GetUsageOp and
GetOriginUsageOp independent from the actor. In practise, for changing the main
base class of the operations from QuotaUsageRequestBase to
ResolvableNormalOriginOp.

Comment 3

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Align QuotaUsageRequestBase::SendResults and ResolvableNormalOriginOp::SendResults; r=#dom-storage

ResolvableNormalOriginOp::SendResults currently doesn't check the mCanceled
flag despite that it inherits from NormalOriginOperationBase which allows
setting mCanceled to true.

Comment 4

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Encapsulate NormalOriginOperationBase::mCanceled; r=#dom-storage

Comment 5

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Pull out OriginOperationBase::mActorDestroyed to actor classes; r=#dom-storage

OriginOperationBase is finally fully abstract.

Comment 6

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Make PQuotaUsageRequest protocol refcounted; r=#dom-storage

The class which implements the protocol is already refcounted, but the
interaction with IPC still uses manual deallocation.

Comment 7

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Replace custom OriginUsage with a common OriginUsageMetadata struct; r=#dom-storage

This is a prerequisite to make GetUsageOp independent from the actor.

Comment 8

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Move BackgroundThreadObject to separate files; r=#dom-storage

This will allow to include QuotaCommon.h in header files less often.

Comment 9

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Make it easy to define new ResponsePromiseResolveOrRejectCallback based types; r=#dom-storage

Comment 10

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Make it easy to define new PromiseResolveOrRejectCallback based callbacks; r=#dom-storage

It's now also possible to define callbacks for move-only types.

Comment 11

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Make it possible to use ResolvableNormalOriginOp with move-only types; r=#dom-storage

Comment 12

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Add a test for nsIQuotaManagerService::GetUsageForPrincipal; r=#dom-storage

This test is needed for making sure that upcoming refactoring doesn't regress
getting origin usage, especially the cancelling of requests.

Comment 13

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Convert test_getUsage.js from using generator functions to using async functions instead; r=#dom-storage

Comment 14

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Add support for pausing QM IO thread after finishing directory work; r=#dom-storage

Comment 15

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Add testing for nsIQuotaUsageRequest.cancel(); r=#dom-storage

Comment 16

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Rework QuotaManagerService methods for getting usage to use async messages with async responses; r=#dom-storage

Sub actors are still created, but their only purpose is to allow cancellation
of alreaady created requests. Actual results are now returned as asynchronous
responses to the asynchronous messages.

Comment 17

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Remove unused PQuotaUsageRequest constructor; r=#dom-storage

PQuotaUsageRequest is now only used for cancellation of requests, constructed
using managed endpoints.

Comment 18

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Remove unused __delete__ argument; r=#dom-storage

Actual results are now returned as asynchronous responses to the asynchronous
messages.

Comment 19

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Remove unneeded QuotaUsageRequestBase::mActorDestroyed flag; r=#dom-storage

CanSend can be used instead of custom tracking of the actor state.

Comment 20

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Rename QuotaUsageRequestBase to QuotaUsageRequestParent; r=#dom-storage

The class is not used as a base for other classes anymore.

Comment 21

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Move QuotaUsageRequestChild to separate files; r=#dom-storage

Comment 22

[Jan Varga [:janv]]

Attachment: Bug 1910848 - Switch PQuotaUsageRequest to non-virtual implementation; r=#dom-storage

Comment 23

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/72b53501cca5
Pull out TraverseRepositoryHelper::GetIsCanceledFlag method into a new base class; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/5d8fd18370e7
Pull out GetUsageForOrigin and GetUsageForOriginEntries methods from QuotaUsageRequestBase into a new base class; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/08be1ab6e06c
Align QuotaUsageRequestBase::SendResults and ResolvableNormalOriginOp::SendResults; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/b9dd09204dc4
Encapsulate NormalOriginOperationBase::mCanceled; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/e3de2b0a2e0f
Pull out OriginOperationBase::mActorDestroyed to actor classes; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/939d52810d28
Make PQuotaUsageRequest protocol refcounted; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/eda61190c54b
Replace custom OriginUsage with a common OriginUsageMetadata struct; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/ca7aa8c8e72a
Move BackgroundThreadObject to separate files; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/0b0b31a5f645
Make it easy to define new ResponsePromiseResolveOrRejectCallback based types; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/59ca51a26b82
Make it easy to define new PromiseResolveOrRejectCallback based callbacks; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/1aeb44dece37
Make it possible to use ResolvableNormalOriginOp with move-only types; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/e5b7405feb4e
Add a test for nsIQuotaManagerService::GetUsageForPrincipal; r=hsingh
https://hg.mozilla.org/integration/autoland/rev/ac5c4d9fb58b
Convert test_getUsage.js from using generator functions to using async functions instead; r=dom-storage-reviewers,hsingh,asuth
https://hg.mozilla.org/integration/autoland/rev/0938096af589
Add support for pausing QM IO thread after finishing directory work; r=dom-storage-reviewers,hsingh,asuth
https://hg.mozilla.org/integration/autoland/rev/3567287b0cb3
Add testing for nsIQuotaUsageRequest.cancel(); r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/6a3e71fe97e7
Rework QuotaManagerService methods for getting usage to use async messages with async responses; r=dom-storage-reviewers,jari

Comment 24

[Norisz Fay [:noriszfay]]

https://hg.mozilla.org/mozilla-central/rev/72b53501cca5
https://hg.mozilla.org/mozilla-central/rev/5d8fd18370e7
https://hg.mozilla.org/mozilla-central/rev/08be1ab6e06c
https://hg.mozilla.org/mozilla-central/rev/b9dd09204dc4
https://hg.mozilla.org/mozilla-central/rev/e3de2b0a2e0f
https://hg.mozilla.org/mozilla-central/rev/939d52810d28
https://hg.mozilla.org/mozilla-central/rev/eda61190c54b
https://hg.mozilla.org/mozilla-central/rev/ca7aa8c8e72a
https://hg.mozilla.org/mozilla-central/rev/0b0b31a5f645
https://hg.mozilla.org/mozilla-central/rev/59ca51a26b82
https://hg.mozilla.org/mozilla-central/rev/1aeb44dece37
https://hg.mozilla.org/mozilla-central/rev/e5b7405feb4e
https://hg.mozilla.org/mozilla-central/rev/ac5c4d9fb58b
https://hg.mozilla.org/mozilla-central/rev/0938096af589
https://hg.mozilla.org/mozilla-central/rev/3567287b0cb3
https://hg.mozilla.org/mozilla-central/rev/6a3e71fe97e7

Comment 25

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/a5ac64e161f5
Remove unused PQuotaUsageRequest constructor; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/a67df5b4972d
Remove unused __delete__ argument; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/26144668242c
Remove unneeded QuotaUsageRequestBase::mActorDestroyed flag; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/f79c7abbd765
Rename QuotaUsageRequestBase to QuotaUsageRequestParent; r=hsingh
https://hg.mozilla.org/integration/autoland/rev/ce838f1d824b
Move QuotaUsageRequestChild to separate files; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/881e972d3b14
Switch PQuotaUsageRequest to non-virtual implementation; r=dom-storage-reviewers,asuth

Comment 26

[Cosmin Sabou [:CosminS]]

https://hg.mozilla.org/mozilla-central/rev/a5ac64e161f5
https://hg.mozilla.org/mozilla-central/rev/a67df5b4972d
https://hg.mozilla.org/mozilla-central/rev/26144668242c
https://hg.mozilla.org/mozilla-central/rev/f79c7abbd765
https://hg.mozilla.org/mozilla-central/rev/ce838f1d824b
https://hg.mozilla.org/mozilla-central/rev/881e972d3b14