fune/dom/storage/PBackgroundSessionStorageCache.ipdl
Tom Tung 45a97b5b83 Bug 1654080 - Use PBackground for syncing SessionStorageCache and use LSWriteOptimizer to send data changes; r=dom-workers-and-storage-reviewers,janv,nika
This patch does:
- Use LSWriteOptimizer
- Remove SessionStorageService since it's unused.
- Move IPC from PContent to PBackground
(by SessionStorageManager{Child, Parent} and SessionStorageCache{Child, Parent}).
- Extract SessionStorageManagerBase and add PBackgroundSessionStorageManager.
- Expose a getter function to get a BackgroundParentManager for top context id
on the parent.

IPC
- Before this patch:
  - Copy from parent while loading a document.
    - Mark cache entry on the parent process as loaded by the child id.
  - Update change on checkpoint.
  - Unmark cache entry on the parent process as unloaded for the child id while
  the parent actor is destorying.
- After this patch:
  - Sync IPC load in the first SessionStorage operation.
  - Update change on checkpoint

`BackgroundSessionStorageManager`'s lifecycle on the parent process.
- Create by `SessionStorageManagerParent` and register to the `sManagers`.
- Hold by `SessionStorageManagerParent` and `sManagers`.
- Remove from the `sManagers` while the corresponding `BrowsingContext` is
destructed (on the parent process).

Depends on D89341

Differential Revision: https://phabricator.services.mozilla.com/D89342
2020-10-14 00:19:33 +00:00

68 lines
1.7 KiB
Text

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
include protocol PBackground;
include protocol PBackgroundSessionStorageManager;
namespace mozilla {
namespace dom {
struct SSSetItemInfo
{
nsString key;
nsString value;
};
struct SSRemoveItemInfo
{
nsString key;
};
struct SSClearInfo
{
};
/**
* Union of SessionStorage mutation types.
*/
union SSWriteInfo
{
SSSetItemInfo;
SSRemoveItemInfo;
SSClearInfo;
};
sync refcounted protocol PBackgroundSessionStorageCache
{
manager PBackgroundSessionStorageManager;
parent:
async DeleteMe();
/**
* Copy SessionStorageCache from the parent process to the content process.
* See SessionStorageManager documentation for more details.
*
* This needs to be synchronous because SessionStorage's semantics are
* synchronous. Note that the BackgroundSessionStorageManager in the
* PBackground parent already has the answers to this request immediately
* available without needing to consult any other threads or perform any I/O.
*/
sync Load()
returns (SSSetItemInfo[] aDefaultData, SSSetItemInfo[] aSessionData);
/**
* Send changes for SessionStorageCache from a content process to the parent
* process so that the data in the parent can be updated to be in sync with
* the content. See SessionStorageManager documentation for more details.
*/
async Checkpoint(SSWriteInfo[] aDefaultWriteInfos,
SSWriteInfo[] aSessionWriteInfos);
child:
async __delete__();
};
} // namespace dom
} // namespace mozilla