dom/serviceworkers/ServiceWorkerOpArgs.ipdlh

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 include ClientIPCTypes;
   6 include DOMTypes;
   7 include FetchTypes;
   8
   9 include "mozilla/dom/ServiceWorkerIPCUtils.h";
  10
  11 using mozilla::dom::ServiceWorkerState from "mozilla/dom/ServiceWorkerBinding.h";
  12 using mozilla::TimeStamp from "mozilla/TimeStamp.h";
  13
  14 namespace mozilla {
  15 namespace dom {
  16
  17 /**
  18  * ServiceWorkerOpArgs
  19  */
  20 struct ServiceWorkerCheckScriptEvaluationOpArgs {};
  21
  22 struct ServiceWorkerUpdateStateOpArgs {
  23   ServiceWorkerState state;
  24 };
  25
  26 struct ServiceWorkerTerminateWorkerOpArgs {
  27   uint32_t shutdownStateId;
  28 };
  29
  30 struct ServiceWorkerLifeCycleEventOpArgs {
  31   nsString eventName;
  32 };
  33
  34 // Possibly need to differentiate an empty array from the absence of an array.
  35 union OptionalPushData {
  36   void_t;
  37   uint8_t[];
  38 };
  39
  40 struct ServiceWorkerPushEventOpArgs {
  41   nsString messageId;
  42   OptionalPushData data;
  43 };
  44
  45 struct ServiceWorkerPushSubscriptionChangeEventOpArgs {};
  46
  47 struct ServiceWorkerNotificationEventOpArgs {
  48   nsString eventName;
  49   nsString id;
  50   nsString title;
  51   nsString dir;
  52   nsString lang;
  53   nsString body;
  54   nsString tag;
  55   nsString icon;
  56   nsString data;
  57   nsString scope;
  58   uint32_t disableOpenClickDelay;
  59 };
  60
  61 struct ServiceWorkerExtensionAPIEventOpArgs {
  62   // WebExtensions API namespace and event names, for a list of the API namespaces
  63   // and related API event names refer to the API JSONSchema files in-tree:
  64   //
  65   // https://searchfox.org/mozilla-central/search?q=&path=extensions%2Fschemas%2F*.json
  66   nsString apiNamespace;
  67   nsString apiEventName;
  68 };
  69
  70 struct ServiceWorkerMessageEventOpArgs {
  71   PostMessageSource source;
  72   ClonedOrErrorMessageData clonedData;
  73 };
  74
  75 struct ServiceWorkerFetchEventOpArgsCommon {
  76   nsCString workerScriptSpec;
  77   IPCInternalRequest internalRequest;
  78   nsString clientId;
  79   nsString resultingClientId;
  80   bool isNonSubresourceRequest;
  81   // Is navigation preload enabled for this fetch? If true, if some
  82   // preloadResponse was not already provided in this structure, then it's
  83   // expected that a PreloadResponse message will eventually be sent.
  84   bool preloadNavigation;
  85   // Failure injection helper; non-NS_OK values indicate that the event, instead
  86   // of dispatching should instead return a `CancelInterceptionArgs` response
  87   // with this nsresult.  This value originates from
  88   // `nsIServiceWorkerInfo::testingInjectCancellation`.
  89   nsresult testingInjectCancellation;
  90 };
  91
  92 struct ParentToParentServiceWorkerFetchEventOpArgs {
  93   ServiceWorkerFetchEventOpArgsCommon common;
  94   ParentToParentInternalResponse? preloadResponse;
  95   ResponseTiming? preloadResponseTiming;
  96   ResponseEndArgs? preloadResponseEndArgs;
  97 };
  98
  99 struct ParentToChildServiceWorkerFetchEventOpArgs {
 100   ServiceWorkerFetchEventOpArgsCommon common;
 101   ParentToChildInternalResponse? preloadResponse;
 102   ResponseTiming? preloadResponseTiming;
 103   ResponseEndArgs? preloadResponseEndArgs;
 104 };
 105
 106 struct ServiceWorkerUpdateIsOnContentBlockingAllowListOpArgs {
 107   bool onContentBlockingAllowList;
 108 };
 109
 110 union ServiceWorkerOpArgs {
 111   ServiceWorkerCheckScriptEvaluationOpArgs;
 112   ServiceWorkerUpdateStateOpArgs;
 113   ServiceWorkerTerminateWorkerOpArgs;
 114   ServiceWorkerLifeCycleEventOpArgs;
 115   ServiceWorkerPushEventOpArgs;
 116   ServiceWorkerPushSubscriptionChangeEventOpArgs;
 117   ServiceWorkerNotificationEventOpArgs;
 118   ServiceWorkerMessageEventOpArgs;
 119   ServiceWorkerExtensionAPIEventOpArgs;
 120   ParentToChildServiceWorkerFetchEventOpArgs;
 121   ServiceWorkerUpdateIsOnContentBlockingAllowListOpArgs;
 122 };
 123
 124 /**
 125  * IPCFetchEventRespondWithResult
 126  */
 127 struct FetchEventRespondWithClosure {
 128   nsCString respondWithScriptSpec;
 129   uint32_t respondWithLineNumber;
 130   uint32_t respondWithColumnNumber;
 131 };
 132
 133 struct FetchEventTimeStamps {
 134   TimeStamp fetchHandlerStart;
 135   TimeStamp fetchHandlerFinish;
 136 };
 137
 138 struct ChildToParentSynthesizeResponseArgs {
 139   ChildToParentInternalResponse internalResponse;
 140   FetchEventRespondWithClosure closure;
 141   FetchEventTimeStamps timeStamps;
 142 };
 143
 144 struct ParentToParentSynthesizeResponseArgs {
 145   ParentToParentInternalResponse internalResponse;
 146   FetchEventRespondWithClosure closure;
 147   FetchEventTimeStamps timeStamps;
 148 };
 149
 150 struct ResetInterceptionArgs {
 151   FetchEventTimeStamps timeStamps;
 152 };
 153
 154 struct CancelInterceptionArgs {
 155   nsresult status;
 156   FetchEventTimeStamps timeStamps;
 157 };
 158
 159 union ChildToParentFetchEventRespondWithResult {
 160   ChildToParentSynthesizeResponseArgs;
 161   ResetInterceptionArgs;
 162   CancelInterceptionArgs;
 163 };
 164
 165 union ParentToParentFetchEventRespondWithResult {
 166   ParentToParentSynthesizeResponseArgs;
 167   ResetInterceptionArgs;
 168   CancelInterceptionArgs;
 169 };
 170
 171 /**
 172  * ServiceWorkerOpResult
 173  */
 174 struct ServiceWorkerCheckScriptEvaluationOpResult {
 175   bool workerScriptExecutedSuccessfully;
 176   bool fetchHandlerWasAdded;
 177 };
 178
 179 struct ServiceWorkerFetchEventOpResult {
 180   nsresult rv;
 181 };
 182
 183 struct ServiceWorkerExtensionAPIEventOpResult {
 184   bool extensionAPIEventListenerWasAdded;
 185 };
 186
 187 union ServiceWorkerOpResult {
 188   nsresult;
 189   ServiceWorkerCheckScriptEvaluationOpResult;
 190   ServiceWorkerFetchEventOpResult;
 191   ServiceWorkerExtensionAPIEventOpResult;
 192 };
 193
 194 }  // namespace dom
 195 }  // namespace mozilla