@temporalio/proto 1.11.1 → 1.11.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temporalio/proto",
-  "version": "1.11.1",
+  "version": "1.11.2",
   "description": "Temporal.io SDK compiled protobuf definitions",
   "main": "protos/index.js",
   "types": "protos/index.d.ts",
@@ -39,5 +39,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c4163f8a2ae87fe84dd435d56f69e23c5eefeffb"
+  "gitHead": "e78b4f71236ccd3227e674bad68439e961fec639"
 }

package/protos/json-module.js

@@ -399,7 +399,7 @@ var $root = ($protobuf.roots.__temporal || ($protobuf.roots.__temporal = new $pr
             oneofs: {
               variant: {
                 oneof: [
-                  "startWorkflow",
+                  "initializeWorkflow",
                   "fireTimer",
                   "updateRandomSeed",
                   "queryWorkflow",
@@ -417,8 +417,8 @@ var $root = ($protobuf.roots.__temporal || ($protobuf.roots.__temporal = new $pr
               }
             },
             fields: {
-              startWorkflow: {
-                type: "StartWorkflow",
+              initializeWorkflow: {
+                type: "InitializeWorkflow",
                 id: 1
               },
               fireTimer: {
@@ -475,7 +475,7 @@ var $root = ($protobuf.roots.__temporal || ($protobuf.roots.__temporal = new $pr
               }
             }
           },
-          StartWorkflow: {
+          InitializeWorkflow: {
             fields: {
               workflowType: {
                 type: "string",
@@ -590,6 +590,10 @@ var $root = ($protobuf.roots.__temporal || ($protobuf.roots.__temporal = new $pr
               result: {
                 type: "activity_result.ActivityResolution",
                 id: 2
+              },
+              isLocal: {
+                type: "bool",
+                id: 3
               }
             }
           },

package/protos/root.d.ts

@@ -1740,22 +1740,38 @@ export namespace coresdk {
          * ## Job ordering guarantees and semantics
          *
          * Core will, by default, order jobs within the activation as follows:
-         * `patches -> signals/updates -> other -> queries -> evictions`
+         * 1. init workflow
+         * 2. patches
+         * 3. random-seed-updates
+         * 4. signals/updates
+         * 5. all others
+         * 6. local activity resolutions
+         * 7. queries
+         * 8. evictions
          *
          * This is because:
          * * Patches are expected to apply to the entire activation
          * * Signal and update handlers should be invoked before workflow routines are iterated. That is to
          * say before the users' main workflow function and anything spawned by it is allowed to continue.
+         * * Local activities resolutions go after other normal jobs because while *not* replaying, they
+         * will always take longer than anything else that produces an immediate job (which is
+         * effectively instant). When *replaying* we need to scan ahead for LA markers so that we can
+         * resolve them in the same activation that they completed in when not replaying. However, doing
+         * so would, by default, put those resolutions *before* any other immediate jobs that happened
+         * in that same activation (prime example: cancelling not-wait-for-cancel activities). So, we do
+         * this to ensure the LA resolution happens after that cancel (or whatever else it may be) as it
+         * normally would have when executing.
          * * Queries always go last (and, in fact, always come in their own activation)
          * * Evictions also always come in their own activation
          *
-         * The downside of this reordering is that a signal or update handler may not observe that some
-         * other event had already happened (ex: an activity completed) when it is first invoked, though it
-         * will subsequently when workflow routines are driven. Core only does this reordering to make life
-         * easier for languages that cannot explicitly control when workflow routines are iterated.
-         * Languages that can explicitly control such iteration should prefer to apply all the jobs to state
-         * (by resolving promises/futures, invoking handlers, etc as they iterate over the jobs) and then
-         * only *after* that is done, drive the workflow routines.
+         * Core does this reordering to ensure that langs observe jobs in the same order during replay as
+         * they would have during execution. However, in principle, this ordering is not necessary
+         * (excepting queries/evictions, which definitely must come last) if lang layers apply all jobs to
+         * state *first* (by resolving promises/futures, marking handlers to be invoked, etc as they iterate
+         * over the jobs) and then only *after* that is done, drive coroutines/threads/whatever. If
+         * execution works this way, then determinism is only impacted by the order routines are driven in
+         * (which must be stable based on lang implementation or convention), rather than the order jobs are
+         * processed.
          *
          * ## Evictions
          *
@@ -1886,8 +1902,8 @@ export namespace coresdk {
         /** Properties of a WorkflowActivationJob. */
         interface IWorkflowActivationJob {
 
-            /** Begin a workflow for the first time */
-            startWorkflow?: (coresdk.workflow_activation.IStartWorkflow|null);
+            /** A workflow is starting, record all of the information from its start event */
+            initializeWorkflow?: (coresdk.workflow_activation.IInitializeWorkflow|null);
 
             /** A timer has fired, allowing whatever was waiting on it (if anything) to proceed */
             fireTimer?: (coresdk.workflow_activation.IFireTimer|null);
@@ -1949,8 +1965,8 @@ export namespace coresdk {
              */
             constructor(properties?: coresdk.workflow_activation.IWorkflowActivationJob);
 
-            /** Begin a workflow for the first time */
-            public startWorkflow?: (coresdk.workflow_activation.IStartWorkflow|null);
+            /** A workflow is starting, record all of the information from its start event */
+            public initializeWorkflow?: (coresdk.workflow_activation.IInitializeWorkflow|null);
 
             /** A timer has fired, allowing whatever was waiting on it (if anything) to proceed */
             public fireTimer?: (coresdk.workflow_activation.IFireTimer|null);
@@ -2003,7 +2019,7 @@ export namespace coresdk {
             public removeFromCache?: (coresdk.workflow_activation.IRemoveFromCache|null);
 
             /** WorkflowActivationJob variant. */
-            public variant?: ("startWorkflow"|"fireTimer"|"updateRandomSeed"|"queryWorkflow"|"cancelWorkflow"|"signalWorkflow"|"resolveActivity"|"notifyHasPatch"|"resolveChildWorkflowExecutionStart"|"resolveChildWorkflowExecution"|"resolveSignalExternalWorkflow"|"resolveRequestCancelExternalWorkflow"|"doUpdate"|"removeFromCache");
+            public variant?: ("initializeWorkflow"|"fireTimer"|"updateRandomSeed"|"queryWorkflow"|"cancelWorkflow"|"signalWorkflow"|"resolveActivity"|"notifyHasPatch"|"resolveChildWorkflowExecutionStart"|"resolveChildWorkflowExecution"|"resolveSignalExternalWorkflow"|"resolveRequestCancelExternalWorkflow"|"doUpdate"|"removeFromCache");
 
             /**
              * Creates a new WorkflowActivationJob instance using the specified properties.
@@ -2076,8 +2092,8 @@ export namespace coresdk {
             public static getTypeUrl(typeUrlPrefix?: string): string;
         }
 
-        /** Properties of a StartWorkflow. */
-        interface IStartWorkflow {
+        /** Properties of an InitializeWorkflow. */
+        interface IInitializeWorkflow {
 
             /** The identifier the lang-specific sdk uses to execute workflow code */
             workflowType?: (string|null);
@@ -2161,14 +2177,14 @@ export namespace coresdk {
             startTime?: (google.protobuf.ITimestamp|null);
         }
 
-        /** Start a new workflow */
-        class StartWorkflow implements IStartWorkflow {
+        /** Initialize a new workflow */
+        class InitializeWorkflow implements IInitializeWorkflow {
 
             /**
-             * Constructs a new StartWorkflow.
+             * Constructs a new InitializeWorkflow.
              * @param [properties] Properties to set
              */
-            constructor(properties?: coresdk.workflow_activation.IStartWorkflow);
+            constructor(properties?: coresdk.workflow_activation.IInitializeWorkflow);
 
             /** The identifier the lang-specific sdk uses to execute workflow code */
             public workflowType: string;
@@ -2252,70 +2268,70 @@ export namespace coresdk {
             public startTime?: (google.protobuf.ITimestamp|null);
 
             /**
-             * Creates a new StartWorkflow instance using the specified properties.
+             * Creates a new InitializeWorkflow instance using the specified properties.
              * @param [properties] Properties to set
-             * @returns StartWorkflow instance
+             * @returns InitializeWorkflow instance
              */
-            public static create(properties?: coresdk.workflow_activation.IStartWorkflow): coresdk.workflow_activation.StartWorkflow;
+            public static create(properties?: coresdk.workflow_activation.IInitializeWorkflow): coresdk.workflow_activation.InitializeWorkflow;
 
             /**
-             * Encodes the specified StartWorkflow message. Does not implicitly {@link coresdk.workflow_activation.StartWorkflow.verify|verify} messages.
-             * @param message StartWorkflow message or plain object to encode
+             * Encodes the specified InitializeWorkflow message. Does not implicitly {@link coresdk.workflow_activation.InitializeWorkflow.verify|verify} messages.
+             * @param message InitializeWorkflow message or plain object to encode
              * @param [writer] Writer to encode to
              * @returns Writer
              */
-            public static encode(message: coresdk.workflow_activation.IStartWorkflow, writer?: $protobuf.Writer): $protobuf.Writer;
+            public static encode(message: coresdk.workflow_activation.IInitializeWorkflow, writer?: $protobuf.Writer): $protobuf.Writer;
 
             /**
-             * Encodes the specified StartWorkflow message, length delimited. Does not implicitly {@link coresdk.workflow_activation.StartWorkflow.verify|verify} messages.
-             * @param message StartWorkflow message or plain object to encode
+             * Encodes the specified InitializeWorkflow message, length delimited. Does not implicitly {@link coresdk.workflow_activation.InitializeWorkflow.verify|verify} messages.
+             * @param message InitializeWorkflow message or plain object to encode
              * @param [writer] Writer to encode to
              * @returns Writer
              */
-            public static encodeDelimited(message: coresdk.workflow_activation.IStartWorkflow, writer?: $protobuf.Writer): $protobuf.Writer;
+            public static encodeDelimited(message: coresdk.workflow_activation.IInitializeWorkflow, writer?: $protobuf.Writer): $protobuf.Writer;
 
             /**
-             * Decodes a StartWorkflow message from the specified reader or buffer.
+             * Decodes an InitializeWorkflow message from the specified reader or buffer.
              * @param reader Reader or buffer to decode from
              * @param [length] Message length if known beforehand
-             * @returns StartWorkflow
+             * @returns InitializeWorkflow
              * @throws {Error} If the payload is not a reader or valid buffer
              * @throws {$protobuf.util.ProtocolError} If required fields are missing
              */
-            public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): coresdk.workflow_activation.StartWorkflow;
+            public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): coresdk.workflow_activation.InitializeWorkflow;
 
             /**
-             * Decodes a StartWorkflow message from the specified reader or buffer, length delimited.
+             * Decodes an InitializeWorkflow message from the specified reader or buffer, length delimited.
              * @param reader Reader or buffer to decode from
-             * @returns StartWorkflow
+             * @returns InitializeWorkflow
              * @throws {Error} If the payload is not a reader or valid buffer
              * @throws {$protobuf.util.ProtocolError} If required fields are missing
              */
-            public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): coresdk.workflow_activation.StartWorkflow;
+            public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): coresdk.workflow_activation.InitializeWorkflow;
 
             /**
-             * Creates a StartWorkflow message from a plain object. Also converts values to their respective internal types.
+             * Creates an InitializeWorkflow message from a plain object. Also converts values to their respective internal types.
              * @param object Plain object
-             * @returns StartWorkflow
+             * @returns InitializeWorkflow
              */
-            public static fromObject(object: { [k: string]: any }): coresdk.workflow_activation.StartWorkflow;
+            public static fromObject(object: { [k: string]: any }): coresdk.workflow_activation.InitializeWorkflow;
 
             /**
-             * Creates a plain object from a StartWorkflow message. Also converts values to other types if specified.
-             * @param message StartWorkflow
+             * Creates a plain object from an InitializeWorkflow message. Also converts values to other types if specified.
+             * @param message InitializeWorkflow
              * @param [options] Conversion options
              * @returns Plain object
              */
-            public static toObject(message: coresdk.workflow_activation.StartWorkflow, options?: $protobuf.IConversionOptions): { [k: string]: any };
+            public static toObject(message: coresdk.workflow_activation.InitializeWorkflow, options?: $protobuf.IConversionOptions): { [k: string]: any };
 
             /**
-             * Converts this StartWorkflow to JSON.
+             * Converts this InitializeWorkflow to JSON.
              * @returns JSON object
              */
             public toJSON(): { [k: string]: any };
 
             /**
-             * Gets the default type url for StartWorkflow
+             * Gets the default type url for InitializeWorkflow
              * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
              * @returns The default type url
              */
@@ -2420,6 +2436,12 @@ export namespace coresdk {
 
             /** ResolveActivity result */
             result?: (coresdk.activity_result.IActivityResolution|null);
+
+            /**
+             * Set to true if the resolution is for a local activity. This is used internally by Core and
+             * lang does not need to care about it.
+             */
+            isLocal?: (boolean|null);
         }
 
         /** Notify a workflow that an activity has been resolved */
@@ -2437,6 +2459,12 @@ export namespace coresdk {
             /** ResolveActivity result. */
             public result?: (coresdk.activity_result.IActivityResolution|null);
 
+            /**
+             * Set to true if the resolution is for a local activity. This is used internally by Core and
+             * lang does not need to care about it.
+             */
+            public isLocal: boolean;
+
             /**
              * Creates a new ResolveActivity instance using the specified properties.
              * @param [properties] Properties to set