1904562 - Refactor directory lock implementation to eliminate virtual methods and multiple inheritance

Status: RESOLVED FIXED

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

Description

[Jan Varga [:janv]]

There are currently DirectoryLock, OriginDirectoryLock, ClientDirectoryLock and UniversalDirectoryLock base classes with pure virtual functions only and then there's DirectoryLockImpl which implements those kind of interfaces. This was an attempt to hide implementation details.
The abstraction has its cost obviously, especially caused by virtual calls. Most of other classes used by quota clients don't have abstraction like that. Besides aligning the design and elimination of virtual methods, the current design makes it hard to add a new method for preparing a directory lock before Acquire is actually called (there will be a separate bug for that).

Comment 1

[Jan Varga [:janv]]

Attachment: Bug 1904562 - Clean up include directives in directory lock related source files; r=#dom-storage

These files will serve as a base for new source files, so it's better to clean
them up before that.

Comment 2

[Jan Varga [:janv]]

Attachment: Bug 1904562 - ClientImpl.h shouldn't include DirectoryLock.h; r=#dom-storage

Consumers should include corresponding headers for concrete type instead. This
will be especially needed when there will be separate includes for different
types of locks.

Comment 3

[Jan Varga [:janv]]

Attachment: Bug 1904562 - Move PersistenceScopeRef, OriginScopeRef and NullableClientType methods to DirectoryLock class; r=#dom-storage

All directory locks use these types under the hood, so it makes more sense to
have them in DirectoryLock class.

Comment 4

[Jan Varga [:janv]]

Attachment: Bug 1904562 - Change DirectoryLockImpl methods which are used only internally or by quota manager only to be private; r=#dom-storage

This patch also cleans up the declaration and definition order. There are no
other functional changes.

Comment 5

[Jan Varga [:janv]]

Attachment: Bug 1904562 - Move UniversalDirectoryLock to separate files and make it inherit from DirectoryLockImpl; r=#dom-storage

Comment 6

[Jan Varga [:janv]]

Attachment: Bug 1904562 - Move OriginDirectoryLock to separate files and make it inherit from DirectoryLockImpl; r=#dom-storage

Comment 7

[Jan Varga [:janv]]

Attachment: Bug 1904562 - Move ClientDirectoryLock to separate files and make it inherit from DirectoryLockImpl; r=#dom-storage

Comment 8

[Jan Varga [:janv]]

Attachment: Bug 1904562 - Change ClientDirectoryLock to inherit from OriginDirectoryLock; r=#dom-storage

Comment 9

[Jan Varga [:janv]]

Attachment: Bug 1904562 - Convert BucketFS to use concrete directory lock type; r=#dom-storage

Comment 10

[Jan Varga [:janv]]

Attachment: Bug 1904562 - Convert LSNG to use concrete directory lock type; r=#dom-storage

Comment 11

[Jan Varga [:janv]]

Attachment: Bug 1904562 - Convert SimpleDB to use concrete directory lock type; r=#dom-storage

Comment 12

[Jan Varga [:janv]]

Attachment: Bug 1904562 - Convert CacheAPI to use concrete directory lock type; r=#dom-storage

Comment 13

[Jan Varga [:janv]]

Attachment: Bug 1904562 - Convert IndexedDB to use concrete directory lock type; r=#dom-storage

Comment 14

[Jan Varga [:janv]]

Attachment: Bug 1904562 - Convert QuotaManager to use concrete directory lock type; r=#dom-storage

Comment 15

[Jan Varga [:janv]]

Attachment: Bug 1904562 - Change DirectoryLockImpl to be topmost class; r=#dom-storage

Comment 16

[Jan Varga [:janv]]

Attachment: Bug 1904562 - Remove unused DirectoryLock class; r=#dom-storage

Comment 17

[Jan Varga [:janv]]

Attachment: Bug 1904562 - Update TestDirectoryLock.cpp to create directory locks through quota manager; r=#dom-storage

Only quota manager will be able to create directory locks directly.

Comment 18

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/369f6badda31
Clean up include directives in directory lock related source files; r=dom-storage-reviewers,asuth
https://hg.mozilla.org/integration/autoland/rev/221c3087333b
ClientImpl.h shouldn't include DirectoryLock.h; r=dom-storage-reviewers,asuth
https://hg.mozilla.org/integration/autoland/rev/e94f4986d788
Move PersistenceScopeRef, OriginScopeRef and NullableClientType methods to DirectoryLock class; r=dom-storage-reviewers,asuth
https://hg.mozilla.org/integration/autoland/rev/479fe5252960
Update TestDirectoryLock.cpp to create directory locks through quota manager; r=dom-storage-reviewers,asuth
https://hg.mozilla.org/integration/autoland/rev/a0f76b09a7d3
Change DirectoryLockImpl methods which are used only internally or by quota manager only to be private; r=dom-storage-reviewers,asuth
https://hg.mozilla.org/integration/autoland/rev/c7409587c4de
Move UniversalDirectoryLock to separate files and make it inherit from DirectoryLockImpl; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/165107cddd62
Move OriginDirectoryLock to separate files and make it inherit from DirectoryLockImpl; r=dom-storage-reviewers,asuth
https://hg.mozilla.org/integration/autoland/rev/a50de6413cd9
Move ClientDirectoryLock to separate files and make it inherit from DirectoryLockImpl; r=dom-storage-reviewers,aiunusov
https://hg.mozilla.org/integration/autoland/rev/f671382d3c98
Change ClientDirectoryLock to inherit from OriginDirectoryLock; r=dom-storage-reviewers,asuth
https://hg.mozilla.org/integration/autoland/rev/f73eaba1fa96
Convert BucketFS to use concrete directory lock type; r=dom-storage-reviewers,asuth
https://hg.mozilla.org/integration/autoland/rev/e20ecdb1fc57
Convert LSNG to use concrete directory lock type; r=dom-storage-reviewers,asuth
https://hg.mozilla.org/integration/autoland/rev/e7c62a4ffac4
Convert SimpleDB to use concrete directory lock type; r=dom-storage-reviewers,asuth
https://hg.mozilla.org/integration/autoland/rev/297dd4fd6349
Convert CacheAPI to use concrete directory lock type; r=dom-storage-reviewers,asuth
https://hg.mozilla.org/integration/autoland/rev/3929ef7e5f11
Convert IndexedDB to use concrete directory lock type; r=dom-storage-reviewers,jari
https://hg.mozilla.org/integration/autoland/rev/3c8fed991027
Convert QuotaManager to use concrete directory lock type; r=dom-storage-reviewers,asuth
https://hg.mozilla.org/integration/autoland/rev/0ab96fb7ea5b
Change DirectoryLockImpl to be topmost class; r=dom-storage-reviewers,asuth
https://hg.mozilla.org/integration/autoland/rev/3b61ed2478fb
Remove unused DirectoryLock class; r=dom-storage-reviewers,asuth

Comment 19

[Norisz Fay [:noriszfay]]

https://hg.mozilla.org/mozilla-central/rev/369f6badda31
https://hg.mozilla.org/mozilla-central/rev/221c3087333b
https://hg.mozilla.org/mozilla-central/rev/e94f4986d788
https://hg.mozilla.org/mozilla-central/rev/479fe5252960
https://hg.mozilla.org/mozilla-central/rev/a0f76b09a7d3
https://hg.mozilla.org/mozilla-central/rev/c7409587c4de
https://hg.mozilla.org/mozilla-central/rev/165107cddd62
https://hg.mozilla.org/mozilla-central/rev/a50de6413cd9
https://hg.mozilla.org/mozilla-central/rev/f671382d3c98
https://hg.mozilla.org/mozilla-central/rev/f73eaba1fa96
https://hg.mozilla.org/mozilla-central/rev/e20ecdb1fc57
https://hg.mozilla.org/mozilla-central/rev/e7c62a4ffac4
https://hg.mozilla.org/mozilla-central/rev/297dd4fd6349
https://hg.mozilla.org/mozilla-central/rev/3929ef7e5f11
https://hg.mozilla.org/mozilla-central/rev/3c8fed991027
https://hg.mozilla.org/mozilla-central/rev/0ab96fb7ea5b
https://hg.mozilla.org/mozilla-central/rev/3b61ed2478fb