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

Status: ASSIGNED

(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 - 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.