Bug 1348660 - Part 2: Rename usage related methods and structures to express the relation to a concrete origin; r=btseng

This commit is contained in:
Jan Varga 2017-03-22 12:13:48 +01:00
parent 2232d1fd5c
commit 4221505b78
18 changed files with 71 additions and 69 deletions

View File

@ -223,7 +223,7 @@ function grabFileUsageAndContinueHandler(request)
testGenerator.next(request.result.fileUsage);
}
function getUsage(usageHandler)
function getCurrentUsage(usageHandler)
{
let qms = SpecialPowers.Services.qms;
let principal = SpecialPowers.wrap(document).nodePrincipal;

View File

@ -18,7 +18,7 @@
const objectStoreName = "Blobs";
getUsage(grabFileUsageAndContinueHandler);
getCurrentUsage(grabFileUsageAndContinueHandler);
let startUsage = yield undefined;
const fileData1 = {
@ -61,7 +61,7 @@
is(event.type, "success", "Got correct event type");
getUsage(grabFileUsageAndContinueHandler);
getCurrentUsage(grabFileUsageAndContinueHandler);
let usage = yield undefined;
is(usage, startUsage + fileData1.obj.file.size + fileData2.obj.file.size,
@ -74,7 +74,7 @@
is(event.type, "complete", "Got correct event type");
getUsage(grabFileUsageAndContinueHandler);
getCurrentUsage(grabFileUsageAndContinueHandler);
usage = yield undefined;
is(usage, startUsage + fileData1.obj.file.size + fileData2.obj.file.size,
@ -90,7 +90,7 @@
// Flush pending file deletions before checking usage.
flushPendingFileDeletions();
getUsage(grabFileUsageAndContinueHandler);
getCurrentUsage(grabFileUsageAndContinueHandler);
let endUsage = yield undefined;
is(endUsage, startUsage, "OS files deleted");

View File

@ -80,7 +80,7 @@ function* testSteps()
verifyView(request.result, viewData.view);
yield undefined;
getUsage(grabFileUsageAndContinueHandler);
getCurrentUsage(grabFileUsageAndContinueHandler);
let fileUsage = yield undefined;
if (external) {

View File

@ -519,7 +519,7 @@ function grabFileUsageAndContinueHandler(request)
testGenerator.next(request.result.fileUsage);
}
function getUsage(usageHandler)
function getCurrentUsage(usageHandler)
{
let qms = Cc["@mozilla.org/dom/quota-manager-service;1"]
.getService(Ci.nsIQuotaManagerService);

View File

@ -142,17 +142,18 @@ QuotaUsageRequestChild::HandleResponse(nsresult aResponse)
}
void
QuotaUsageRequestChild::HandleResponse(const UsageResponse& aResponse)
QuotaUsageRequestChild::HandleResponse(const OriginUsageResponse& aResponse)
{
AssertIsOnOwningThread();
MOZ_ASSERT(mRequest);
RefPtr<UsageResult> result = new UsageResult(aResponse.usage(),
aResponse.fileUsage(),
aResponse.limit());
RefPtr<OriginUsageResult> result =
new OriginUsageResult(aResponse.usage(),
aResponse.fileUsage(),
aResponse.limit());
RefPtr<nsVariant> variant = new nsVariant();
variant->SetAsInterface(NS_GET_IID(nsIQuotaUsageResult), result);
variant->SetAsInterface(NS_GET_IID(nsIQuotaOriginUsageResult), result);
mRequest->SetResult(variant);
}
@ -181,8 +182,8 @@ QuotaUsageRequestChild::Recv__delete__(const UsageRequestResponse& aResponse)
HandleResponse(aResponse.get_nsresult());
break;
case UsageRequestResponse::TUsageResponse:
HandleResponse(aResponse.get_UsageResponse());
case UsageRequestResponse::TOriginUsageResponse:
HandleResponse(aResponse.get_OriginUsageResponse());
break;
default:

View File

@ -98,7 +98,7 @@ private:
HandleResponse(nsresult aResponse);
void
HandleResponse(const UsageResponse& aResponse);
HandleResponse(const OriginUsageResponse& aResponse);
// IPDL methods are only called by IPDL.
virtual void

View File

@ -1042,7 +1042,7 @@ private:
RecvStopIdleMaintenance() override;
};
class GetUsageOp final
class GetOriginUsageOp final
: public NormalOriginOperationBase
, public PQuotaUsageRequestParent
{
@ -1051,19 +1051,19 @@ class GetUsageOp final
// limit.
UsageInfo mUsageInfo;
const UsageParams mParams;
const OriginUsageParams mParams;
nsCString mSuffix;
nsCString mGroup;
bool mGetGroupUsage;
public:
explicit GetUsageOp(const UsageRequestParams& aParams);
explicit GetOriginUsageOp(const UsageRequestParams& aParams);
MOZ_IS_CLASS_INIT bool
Init(Quota* aQuota);
private:
~GetUsageOp()
~GetOriginUsageOp()
{ }
MOZ_IS_CLASS_INIT virtual nsresult
@ -6230,7 +6230,7 @@ Quota::ActorDestroy(ActorDestroyReason aWhy)
PQuotaUsageRequestParent*
Quota::AllocPQuotaUsageRequestParent(const UsageRequestParams& aParams)
{
RefPtr<GetUsageOp> actor = new GetUsageOp(aParams);
RefPtr<GetOriginUsageOp> actor = new GetOriginUsageOp(aParams);
// Transfer ownership to IPDL.
return actor.forget().take();
@ -6244,7 +6244,7 @@ Quota::RecvPQuotaUsageRequestConstructor(PQuotaUsageRequestParent* aActor,
MOZ_ASSERT(aActor);
MOZ_ASSERT(aParams.type() != UsageRequestParams::T__None);
auto* op = static_cast<GetUsageOp*>(aActor);
auto* op = static_cast<GetOriginUsageOp*>(aActor);
if (NS_WARN_IF(!op->Init(this))) {
return IPC_FAIL_NO_REASON(this);
@ -6261,8 +6261,8 @@ Quota::DeallocPQuotaUsageRequestParent(PQuotaUsageRequestParent* aActor)
MOZ_ASSERT(aActor);
// Transfer ownership back from IPDL.
RefPtr<GetUsageOp> actor =
dont_AddRef(static_cast<GetUsageOp*>(aActor));
RefPtr<GetOriginUsageOp> actor =
dont_AddRef(static_cast<GetOriginUsageOp*>(aActor));
return true;
}
@ -6414,19 +6414,19 @@ Quota::RecvStopIdleMaintenance()
return IPC_OK();
}
GetUsageOp::GetUsageOp(const UsageRequestParams& aParams)
GetOriginUsageOp::GetOriginUsageOp(const UsageRequestParams& aParams)
: NormalOriginOperationBase(Nullable<PersistenceType>(),
OriginScope::FromNull(),
/* aExclusive */ false)
, mParams(aParams.get_UsageParams())
, mGetGroupUsage(aParams.get_UsageParams().getGroupUsage())
, mParams(aParams.get_OriginUsageParams())
, mGetGroupUsage(aParams.get_OriginUsageParams().getGroupUsage())
{
AssertIsOnOwningThread();
MOZ_ASSERT(aParams.type() == UsageRequestParams::TUsageParams);
MOZ_ASSERT(aParams.type() == UsageRequestParams::TOriginUsageParams);
}
bool
GetUsageOp::Init(Quota* aQuota)
GetOriginUsageOp::Init(Quota* aQuota)
{
AssertIsOnOwningThread();
MOZ_ASSERT(aQuota);
@ -6438,7 +6438,7 @@ GetUsageOp::Init(Quota* aQuota)
}
nsresult
GetUsageOp::DoInitOnMainThread()
GetOriginUsageOp::DoInitOnMainThread()
{
MOZ_ASSERT(NS_IsMainThread());
MOZ_ASSERT(GetState() == State_Initializing);
@ -6467,8 +6467,8 @@ GetUsageOp::DoInitOnMainThread()
}
nsresult
GetUsageOp::AddToUsage(QuotaManager* aQuotaManager,
PersistenceType aPersistenceType)
GetOriginUsageOp::AddToUsage(QuotaManager* aQuotaManager,
PersistenceType aPersistenceType)
{
AssertIsOnIOThread();
@ -6580,12 +6580,12 @@ GetUsageOp::AddToUsage(QuotaManager* aQuotaManager,
}
nsresult
GetUsageOp::DoDirectoryWork(QuotaManager* aQuotaManager)
GetOriginUsageOp::DoDirectoryWork(QuotaManager* aQuotaManager)
{
AssertIsOnIOThread();
MOZ_ASSERT(mUsageInfo.TotalUsage() == 0);
PROFILER_LABEL("Quota", "GetUsageOp::DoDirectoryWork",
PROFILER_LABEL("Quota", "GetOriginUsageOp::DoDirectoryWork",
js::ProfileEntry::Category::OTHER);
nsresult rv;
@ -6621,7 +6621,7 @@ GetUsageOp::DoDirectoryWork(QuotaManager* aQuotaManager)
}
void
GetUsageOp::SendResults()
GetOriginUsageOp::SendResults()
{
AssertIsOnOwningThread();
@ -6637,7 +6637,7 @@ GetUsageOp::SendResults()
UsageRequestResponse response;
if (NS_SUCCEEDED(mResultCode)) {
UsageResponse usageResponse;
OriginUsageResponse usageResponse;
// We'll get the group usage when mGetGroupUsage is true and get the
// origin usage when mGetGroupUsage is false.
@ -6659,7 +6659,7 @@ GetUsageOp::SendResults()
}
void
GetUsageOp::ActorDestroy(ActorDestroyReason aWhy)
GetOriginUsageOp::ActorDestroy(ActorDestroyReason aWhy)
{
AssertIsOnOwningThread();
@ -6667,7 +6667,7 @@ GetUsageOp::ActorDestroy(ActorDestroyReason aWhy)
}
mozilla::ipc::IPCResult
GetUsageOp::RecvCancel()
GetOriginUsageOp::RecvCancel()
{
AssertIsOnOwningThread();

View File

@ -27,7 +27,7 @@ struct InitOriginParams
PersistenceType persistenceType;
};
struct UsageParams
struct OriginUsageParams
{
PrincipalInfo principalInfo;
bool getGroupUsage;
@ -35,7 +35,7 @@ struct UsageParams
union UsageRequestParams
{
UsageParams;
OriginUsageParams;
};
struct ClearOriginParams

View File

@ -8,7 +8,7 @@ namespace mozilla {
namespace dom {
namespace quota {
struct UsageResponse
struct OriginUsageResponse
{
uint64_t usage;
uint64_t fileUsage;
@ -18,7 +18,7 @@ struct UsageResponse
union UsageRequestResponse
{
nsresult;
UsageResponse;
OriginUsageResponse;
};
protocol PQuotaUsageRequest

View File

@ -596,7 +596,7 @@ QuotaManagerService::GetUsageForPrincipal(nsIPrincipal* aPrincipal,
RefPtr<UsageRequest> request = new UsageRequest(aPrincipal, aCallback);
UsageParams params;
OriginUsageParams params;
nsresult rv = CheckedPrincipalToPrincipalInfo(aPrincipal,
params.principalInfo());

View File

@ -10,20 +10,20 @@ namespace mozilla {
namespace dom {
namespace quota {
UsageResult::UsageResult(uint64_t aUsage,
uint64_t aFileUsage,
uint64_t aLimit)
OriginUsageResult::OriginUsageResult(uint64_t aUsage,
uint64_t aFileUsage,
uint64_t aLimit)
: mUsage(aUsage)
, mFileUsage(aFileUsage)
, mLimit(aLimit)
{
}
NS_IMPL_ISUPPORTS(UsageResult,
nsIQuotaUsageResult)
NS_IMPL_ISUPPORTS(OriginUsageResult,
nsIQuotaOriginUsageResult)
NS_IMETHODIMP
UsageResult::GetUsage(uint64_t* aUsage)
OriginUsageResult::GetUsage(uint64_t* aUsage)
{
MOZ_ASSERT(aUsage);
@ -32,7 +32,7 @@ UsageResult::GetUsage(uint64_t* aUsage)
}
NS_IMETHODIMP
UsageResult::GetFileUsage(uint64_t* aFileUsage)
OriginUsageResult::GetFileUsage(uint64_t* aFileUsage)
{
MOZ_ASSERT(aFileUsage);
@ -41,7 +41,7 @@ UsageResult::GetFileUsage(uint64_t* aFileUsage)
}
NS_IMETHODIMP
UsageResult::GetLimit(uint64_t* aLimit)
OriginUsageResult::GetLimit(uint64_t* aLimit)
{
MOZ_ASSERT(aLimit);

View File

@ -13,24 +13,24 @@ namespace mozilla {
namespace dom {
namespace quota {
class UsageResult
: public nsIQuotaUsageResult
class OriginUsageResult
: public nsIQuotaOriginUsageResult
{
uint64_t mUsage;
uint64_t mFileUsage;
uint64_t mLimit;
public:
UsageResult(uint64_t aUsage,
uint64_t aFileUsage,
uint64_t aLimit);
OriginUsageResult(uint64_t aUsage,
uint64_t aFileUsage,
uint64_t aLimit);
private:
virtual ~UsageResult()
virtual ~OriginUsageResult()
{ }
NS_DECL_ISUPPORTS
NS_DECL_NSIQUOTAUSAGERESULT
NS_DECL_NSIQUOTAORIGINUSAGERESULT
};
} // namespace quota

View File

@ -148,14 +148,15 @@ GetStorageEstimate(nsIQuotaUsageRequest* aRequest,
free(iid);
nsCOMPtr<nsIQuotaUsageResult> usageResult = do_QueryInterface(supports);
MOZ_ASSERT(usageResult);
nsCOMPtr<nsIQuotaOriginUsageResult> originUsageResult =
do_QueryInterface(supports);
MOZ_ASSERT(originUsageResult);
MOZ_ALWAYS_SUCCEEDS(
usageResult->GetUsage(&aStorageEstimate.mUsage.Construct()));
originUsageResult->GetUsage(&aStorageEstimate.mUsage.Construct()));
MOZ_ALWAYS_SUCCEEDS(
usageResult->GetLimit(&aStorageEstimate.mQuota.Construct()));
originUsageResult->GetLimit(&aStorageEstimate.mQuota.Construct()));
return NS_OK;
}

View File

@ -23,7 +23,7 @@ interface nsIQuotaRequestBase : nsISupports
interface nsIQuotaUsageRequest : nsIQuotaRequestBase
{
// The result can contain one of these types:
// nsIQuotaUsageResult
// nsIQuotaOriginUsageResult
[must_use] readonly attribute nsIVariant result;
attribute nsIQuotaUsageCallback callback;

View File

@ -7,7 +7,7 @@
#include "nsISupports.idl"
[scriptable, function, uuid(96df03d2-116a-493f-bb0b-118c212a6b32)]
interface nsIQuotaUsageResult : nsISupports
interface nsIQuotaOriginUsageResult : nsISupports
{
readonly attribute unsigned long long usage;

View File

@ -266,7 +266,7 @@ function grabUsageAndContinueHandler(request)
testGenerator.next(request.result.usage);
}
function getUsage(usageHandler)
function getCurrentUsage(usageHandler)
{
let principal = Cc["@mozilla.org/systemprincipal;1"]
.createInstance(Ci.nsIPrincipal);

View File

@ -38,7 +38,7 @@ function* testSteps()
info("Getting usage");
getUsage(grabUsageAndContinueHandler);
getCurrentUsage(grabUsageAndContinueHandler);
let usage = yield undefined;
ok(usage == 0, "Usage is zero");
@ -53,7 +53,7 @@ function* testSteps()
info("Getting usage");
getUsage(grabUsageAndContinueHandler);
getCurrentUsage(grabUsageAndContinueHandler);
usage = yield undefined;
ok(usage > 0, "Usage is not zero");

View File

@ -131,7 +131,7 @@ function* testSteps()
info("Getting usage");
request = getUsage(continueToNextStepSync);
request = getCurrentUsage(continueToNextStepSync);
yield undefined;
ok(request.resultCode == NS_ERROR_UNEXPECTED, "Get usage failed");
@ -140,7 +140,7 @@ function* testSteps()
info("Getting usage");
request = getUsage(continueToNextStepSync);
request = getCurrentUsage(continueToNextStepSync);
yield undefined;
ok(request.resultCode == NS_OK, "Get usage succeeded");
@ -156,7 +156,7 @@ function* testSteps()
info("Getting usage");
request = getUsage(continueToNextStepSync);
request = getCurrentUsage(continueToNextStepSync);
yield undefined;
ok(request.resultCode == NS_OK, "Get usage succeeded");