fune/dom/storage/SessionStorage.h
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

88 lines
2.6 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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/. */
#ifndef mozilla_dom_SessionStorage_h
#define mozilla_dom_SessionStorage_h
#include "Storage.h"
class nsIPrincipal;
namespace mozilla {
namespace dom {
class SessionStorageCache;
class SessionStorageManager;
class SessionStorage final : public Storage {
public:
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(SessionStorage, Storage)
SessionStorage(nsPIDOMWindowInner* aWindow, nsIPrincipal* aPrincipal,
nsIPrincipal* aStoragePrincipal, SessionStorageCache* aCache,
SessionStorageManager* aManager, const nsAString& aDocumentURI,
bool aIsPrivate);
void AssertIsOnOwningThread() const {
NS_ASSERT_OWNINGTHREAD(SessionStorage);
}
StorageType Type() const override { return eSessionStorage; }
SessionStorageManager* Manager() const { return mManager; }
SessionStorageCache* Cache() const { return mCache; }
int64_t GetOriginQuotaUsage() const override;
bool IsForkOf(const Storage* aStorage) const override;
// WebIDL
uint32_t GetLength(nsIPrincipal& aSubjectPrincipal,
ErrorResult& aRv) override;
void Key(uint32_t aIndex, nsAString& aResult, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aRv) override;
void GetItem(const nsAString& aKey, nsAString& aResult,
nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv) override;
void GetSupportedNames(nsTArray<nsString>& aKeys) override;
void SetItem(const nsAString& aKey, const nsAString& aValue,
nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv) override;
void RemoveItem(const nsAString& aKey, nsIPrincipal& aSubjectPrincipal,
ErrorResult& aRv) override;
void Clear(nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv) override;
private:
~SessionStorage();
void BroadcastChangeNotification(const nsAString& aKey,
const nsAString& aOldValue,
const nsAString& aNewValue);
void MaybeScheduleStableStateCallback();
void StableStateCallback();
nsresult EnsureCacheLoadedOrCloned() const;
RefPtr<SessionStorageCache> mCache;
RefPtr<SessionStorageManager> mManager;
nsString mDocumentURI;
bool mIsPrivate;
bool mHasPendingStableStateCallback;
};
} // namespace dom
} // namespace mozilla
#endif // mozilla_dom_SessionStorage_h