Update docker-based proto gen

Author: cretz

.github/workflows/ci.yml

@@ -16,7 +16,9 @@ jobs:
         os: [ubuntu-latest, ubuntu-arm, macos-intel, macos-arm, windows-latest]
         include:
           - os: ubuntu-latest
-            python: "3.12"
+            # TODO(cretz): Remove trailing patch version when
+            # https://github.com/pydantic/pydantic/pull/9612 tagged
+            python: "3.12.3"
             docsTarget: true
           - os: ubuntu-latest
             python: "3.8"
@@ -52,6 +54,11 @@ jobs:
         uses: deadsnakes/[email protected]
         with:
           python-version: ${{ matrix.python }}
+      - uses: arduino/setup-protoc@v3
+        with:
+          # TODO(cretz): Can upgrade proto when https://github.com/arduino/setup-protoc/issues/99 fixed
+          version: "23.x"
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
       # Using fixed Poetry version until
       # https://github.com/python-poetry/poetry/issues/7611 and
       # https://github.com/python-poetry/poetry/pull/7694 are fixed
@@ -74,8 +81,8 @@ jobs:
         env:
           TEMPORAL_TEST_PROTO3: 1
         run: |
-          poetry add "protobuf<4"
-          poe gen-protos
+          docker build -f scripts/_proto/Dockerfile -t python-gen-proto .
+          docker run --rm -v "${PWD}/temporalio/api:/api_new" -v "${PWD}/temporalio/bridge/proto:/bridge_new" python-gen-proto
           poe format
           [[ -z $(git status --porcelain temporalio) ]] || (git diff temporalio; echo "Protos changed"; exit 1)
           poe test -s -o log_cli_level=DEBUG

README.md

@@ -1469,7 +1469,10 @@ poe test -s --log-cli-level=DEBUG -k test_sync_activity_thread_cancel_caught
 
 #### Proto Generation and Testing
 
-To allow for backwards compatibility, protobuf code is generated on the 3.x series of the protobuf library. To generate
+To allow for backwards compatibility, protobuf code is generated on the 3.x series of the protobuf library. This means
+we must generate proto code on older Python and older protobuf (pre 4.x).
+
+To generate
 protobuf code, you must be on Python <= 3.10, and then run `poetry add "protobuf<4"`. Then the protobuf files can be
 generated via `poe gen-protos`. Tests can be run for protobuf version 3 by setting the `TEMPORAL_TEST_PROTO3` env var
 to `1` prior to running tests.
@@ -1484,6 +1487,8 @@ docker run --rm -v "${PWD}/temporalio/api:/api_new" -v "${PWD}/temporalio/bridge
 poe format
 ```
 
+Can use `%CD%` instead of `${PWD}` on Windows.
+
 ### Style
 
 * Mostly [Google Style Guide](https://google.github.io/styleguide/pyguide.html). Notable exceptions:

pyproject.toml

@@ -123,6 +123,7 @@ environment = { PATH = "$PATH:$HOME/.cargo/bin", CARGO_NET_GIT_FETCH_WITH_CLI =
 [tool.isort]
 profile = "black"
 skip_gitignore = true
+extend_skip = ["./temporalio/bridge/sdk-core", "./temporalio/bridge/target"]
 
 [tool.mypy]
 ignore_missing_imports = true

temporalio/api/common/v1/message_pb2.pyi

@@ -421,7 +421,7 @@ class MeteringMetadata(google.protobuf.message.Message):
     """Count of local activities which have begun an execution attempt during this workflow task,
     and whose first attempt occurred in some previous task. This is used for metering
     purposes, and does not affect workflow state.
-
+    
     (-- api-linter: core::0141::forbidden-types=disabled
         aip.dev/not-precedent: Negative values make no sense to represent. --)
     """

temporalio/api/enums/v1/failed_cause_pb2.pyi

@@ -88,7 +88,7 @@ class _WorkflowTaskFailedCauseEnumTypeWrapper(
     of their workflow. We do this to ensure that the state of their workflow does not become too
     large because that can cause severe performance degradation. You can modify the thresholds for
     each of these errors within your dynamic config.
-
+    
     Spawning a new child workflow would cause this workflow to exceed its limit of pending child
     workflows.
     """

temporalio/api/enums/v1/task_queue_pb2.pyi

@@ -50,19 +50,19 @@ class _TaskQueueKindEnumTypeWrapper(
     TASK_QUEUE_KIND_UNSPECIFIED: _TaskQueueKind.ValueType  # 0
     TASK_QUEUE_KIND_NORMAL: _TaskQueueKind.ValueType  # 1
     """Tasks from a normal workflow task queue always include complete workflow history
-
+    
     The task queue specified by the user is always a normal task queue. There can be as many
     workers as desired for a single normal task queue. All those workers may pick up tasks from
     that queue.
     """
     TASK_QUEUE_KIND_STICKY: _TaskQueueKind.ValueType  # 2
     """A sticky queue only includes new history since the last workflow task, and they are
     per-worker.
-
+    
     Sticky queues are created dynamically by each worker during their start up. They only exist
     for the lifetime of the worker process. Tasks in a sticky task queue are only available to
     the worker that created the sticky queue.
-
+    
     Sticky queues are only for workflow tasks. There are no sticky task queues for activities.
     """
 

temporalio/api/operatorservice/v1/service_pb2_grpc.pyi

@@ -41,7 +41,7 @@ class OperatorServiceStub:
         temporalio.api.operatorservice.v1.request_response_pb2.AddSearchAttributesResponse,
     ]
     """AddSearchAttributes add custom search attributes.
-
+    
     Returns ALREADY_EXISTS status code if a Search Attribute with any of the specified names already exists
     Returns INTERNAL status code with temporalio.api.errordetails.v1.SystemWorkflowFailure in Error Details if registration process fails,
     """
@@ -50,7 +50,7 @@ class OperatorServiceStub:
         temporalio.api.operatorservice.v1.request_response_pb2.RemoveSearchAttributesResponse,
     ]
     """RemoveSearchAttributes removes custom search attributes.
-
+    
     Returns NOT_FOUND status code if a Search Attribute with any of the specified names is not registered
     """
     ListSearchAttributes: grpc.UnaryUnaryMultiCallable[

temporalio/api/schedule/v1/message_pb2.pyi

@@ -410,26 +410,26 @@ class ScheduleSpec(google.protobuf.message.Message):
         """
     timezone_name: builtins.str
     """Time zone to interpret all calendar-based specs in.
-
+    
     If unset, defaults to UTC. We recommend using UTC for your application if
     at all possible, to avoid various surprising properties of time zones.
-
+    
     Time zones may be provided by name, corresponding to names in the IANA
     time zone database (see https://www.iana.org/time-zones). The definition
     will be loaded by the Temporal server from the environment it runs in.
-
+    
     If your application requires more control over the time zone definition
     used, it may pass in a complete definition in the form of a TZif file
     from the time zone database. If present, this will be used instead of
     loading anything from the environment. You are then responsible for
     updating timezone_data when the definition changes.
-
+    
     Calendar spec matching is based on literal matching of the clock time
     with no special handling of DST: if you write a calendar spec that fires
     at 2:30am and specify a time zone that follows DST, that action will not
     be triggered on the day that has no 2:30am. Similarly, an action that
     fires at 1:30am will be triggered twice on the day that has two 1:30s.
-
+    
     Also note that no actions are taken on leap-seconds (e.g. 23:59:60 UTC).
     """
     timezone_data: builtins.bytes

temporalio/api/sdk/v1/task_complete_metadata_pb2.pyi

@@ -83,7 +83,7 @@ class WorkflowTaskCompletedMetadata(google.protobuf.message.Message):
     """Name of the SDK that processed the task. This is usually something like "temporal-go" and is
     usually the same as client-name gRPC header. This should only be set if its value changed
     since the last time recorded on the workflow (or be set on the first task).
-
+    
     (-- api-linter: core::0122::name-suffix=disabled
         aip.dev/not-precedent: We're ok with a name suffix here. --)
     """

temporalio/api/testservice/v1/service_pb2_grpc.pyi

@@ -41,23 +41,23 @@ class TestServiceStub:
         temporalio.api.testservice.v1.request_response_pb2.LockTimeSkippingResponse,
     ]
     """LockTimeSkipping increments Time Locking Counter by one.
-
+    
     If Time Locking Counter is positive, time skipping is locked (disabled).
     When time skipping is disabled, the time in test server is moving normally, with a real time pace.
     Test Server is typically started with locked time skipping and Time Locking Counter = 1.
-
+    
     LockTimeSkipping and UnlockTimeSkipping calls are counted.
     """
     UnlockTimeSkipping: grpc.UnaryUnaryMultiCallable[
         temporalio.api.testservice.v1.request_response_pb2.UnlockTimeSkippingRequest,
         temporalio.api.testservice.v1.request_response_pb2.UnlockTimeSkippingResponse,
     ]
     """UnlockTimeSkipping decrements Time Locking Counter by one.
-
+    
     If the counter reaches 0, it unlocks time skipping and fast forwards time.
     LockTimeSkipping and UnlockTimeSkipping calls are counted. Calling UnlockTimeSkipping does not
     guarantee that time is going to be fast forwarded as another lock can be holding it.
-
+    
     Time Locking Counter can't be negative, unbalanced calls to UnlockTimeSkipping will lead to rpc call failure
     """
     Sleep: grpc.UnaryUnaryMultiCallable[
@@ -81,9 +81,9 @@ class TestServiceStub:
     ]
     """UnlockTimeSkippingWhileSleep decreases time locking counter by one and increases it back
     once the Test Server Time advances by the duration specified in the request.
-
+    
     This call returns only when the Test Server Time advances by the specified duration.
-
+    
     If it is called when Time Locking Counter is
       - more than 1 and no other unlocks are coming in, rpc call will block for the specified duration, time will not be fast forwarded.
       - 1, it will lead to fast forwarding of the time by the duration specified in the request and quick return of this rpc call.
@@ -94,7 +94,7 @@ class TestServiceStub:
         temporalio.api.testservice.v1.request_response_pb2.GetCurrentTimeResponse,
     ]
     """GetCurrentTime returns the current Temporal Test Server time
-
+    
     This time might not be equal to {@link System#currentTimeMillis()} due to time skipping.
     """
 

temporalio/api/workflowservice/v1/request_response_pb2.pyi

@@ -575,13 +575,13 @@ class StartWorkflowExecutionRequest(google.protobuf.message.Message):
     workflow_id_reuse_policy: temporalio.api.enums.v1.workflow_pb2.WorkflowIdReusePolicy.ValueType
     """Defines whether to allow re-using the workflow id from a previously *closed* workflow.
     The default policy is WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
-
+    
     See `workflow_id_conflict_policy` for handling a workflow id duplication with a *running* workflow.
     """
     workflow_id_conflict_policy: temporalio.api.enums.v1.workflow_pb2.WorkflowIdConflictPolicy.ValueType
     """Defines how to resolve a workflow id conflict with a *running* workflow.
     The default policy is WORKFLOW_ID_CONFLICT_POLICY_FAIL.
-
+    
     See `workflow_id_reuse_policy` for handling a workflow id duplication with a *closed* workflow.
     """
     @property
@@ -2601,14 +2601,14 @@ class SignalWithStartWorkflowExecutionRequest(google.protobuf.message.Message):
     workflow_id_reuse_policy: temporalio.api.enums.v1.workflow_pb2.WorkflowIdReusePolicy.ValueType
     """Defines whether to allow re-using the workflow id from a previously *closed* workflow.
     The default policy is WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
-
+    
     See `workflow_id_reuse_policy` for handling a workflow id duplication with a *running* workflow.
     """
     workflow_id_conflict_policy: temporalio.api.enums.v1.workflow_pb2.WorkflowIdConflictPolicy.ValueType
     """Defines how to resolve a workflow id conflict with a *running* workflow.
     The default policy is WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING.
     Note that WORKFLOW_ID_CONFLICT_POLICY_FAIL is an invalid option.
-
+    
     See `workflow_id_reuse_policy` for handling a workflow id duplication with a *closed* workflow.
     """
     signal_name: builtins.str
@@ -4149,7 +4149,7 @@ class GetSystemInfoResponse(google.protobuf.message.Message):
         internal_error_differentiation: builtins.bool
         """True if internal errors are differentiated from other types of errors for purposes of
         retrying non-internal errors.
-
+        
         When unset/false, clients retry all failures. When true, clients should only retry
         non-internal errors.
         """
@@ -4915,7 +4915,7 @@ class UpdateWorkerBuildIdCompatibilityRequest(google.protobuf.message.Message):
     """A new build id. This operation will create a new set which will be the new overall
     default version for the queue, with this id as its only member. This new set is
     incompatible with all previous sets/versions.
-
+    
     (-- api-linter: core::0140::prepositions=disabled
         aip.dev/not-precedent: In makes perfect sense here. --)
     """
@@ -4927,13 +4927,13 @@ class UpdateWorkerBuildIdCompatibilityRequest(google.protobuf.message.Message):
     promote_set_by_build_id: builtins.str
     """Promote an existing set to be the current default (if it isn't already) by targeting
     an existing build id within it. This field's value is the extant build id.
-
+    
     (-- api-linter: core::0140::prepositions=disabled
         aip.dev/not-precedent: Names are hard. --)
     """
     promote_build_id_within_set: builtins.str
     """Promote an existing build id within some set to be the current default for that set.
-
+    
     (-- api-linter: core::0140::prepositions=disabled
         aip.dev/not-precedent: Within makes perfect sense here. --)
     """