@temporalio/core-bridge 1.9.2 → 1.10.0

package/sdk-core/sdk-core-protos/protos/api_upstream/Makefile

@@ -1,12 +1,14 @@
+SHELL=/bin/bash -o pipefail
+
 $(VERBOSE).SILENT:
 ############################# Main targets #############################
-ci-build: install proto
+ci-build: install proto http-api-docs
 
 # Install dependencies.
 install: grpc-install api-linter-install buf-install
 
 # Run all linters and compile proto files.
-proto: grpc
+proto: grpc http-api-docs
 ########################################################################
 
 ##### Variables ######
@@ -20,16 +22,6 @@ STAMPDIR := .stamp
 
 COLOR := "\e[1;36m%s\e[0m\n"
 
-# Only prints output if the exit code is non-zero
-define silent_exec
-    @output=$$($(1) 2>&1); \
-    status=$$?; \
-    if [ $$status -ne 0 ]; then \
-        echo "$$output"; \
-    fi; \
-    exit $$status
-endef
-
 PROTO_ROOT := .
 PROTO_FILES = $(shell find temporal -name "*.proto")
 PROTO_DIRS = $(sort $(dir $(PROTO_FILES)))
@@ -38,6 +30,9 @@ PROTO_IMPORTS = \
 	-I=$(PROTO_ROOT)
 PROTO_PATHS = paths=source_relative:$(PROTO_OUT)
 
+OAPI_OUT := openapi
+OAPI3_PATH := .components.schemas.Payload
+
 $(PROTO_OUT):
 	mkdir $(PROTO_OUT)
 
@@ -46,27 +41,54 @@ grpc: buf-lint api-linter buf-breaking clean go-grpc fix-path
 
 go-grpc: clean $(PROTO_OUT)
 	printf $(COLOR) "Compile for go-gRPC..."
-	$(foreach PROTO_DIR,$(PROTO_DIRS),\
-		protoc --fatal_warnings $(PROTO_IMPORTS) \
-		 	--go_out=$(PROTO_PATHS) \
-            --grpc-gateway_out=allow_patch_feature=false,$(PROTO_PATHS)\
-			--doc_out=html,index.html,source_relative:$(PROTO_OUT) \
-		$(PROTO_DIR)*.proto;)
+	protogen \
+		--root=$(PROTO_ROOT) \
+		--output=$(PROTO_OUT) \
+		--exclude=internal \
+		--exclude=proto/api/google \
+		-I $(PROTO_ROOT) \
+		-p go-grpc_out=$(PROTO_PATHS) \
+		-p grpc-gateway_out=allow_patch_feature=false,$(PROTO_PATHS) \
+		-p doc_out=html,index.html,source_relative:$(PROTO_OUT)
 
 fix-path:
 	mv -f $(PROTO_OUT)/temporal/api/* $(PROTO_OUT) && rm -rf $(PROTO_OUT)/temporal
 
+# We need to rewrite bits of this to support our shorthand payload format
+# We use both yq and jq here as they preserve comments and the ordering of the original
+# document
+http-api-docs:
+	protoc -I $(PROTO_ROOT) \
+		--openapi_out=$(OAPI_OUT) \
+		--openapi_opt=enum_type=string \
+		--openapiv2_out=openapi \
+        --openapiv2_opt=allow_merge=true,merge_file_name=openapiv2,simple_operation_ids=true \
+		temporal/api/workflowservice/v1/* \
+		temporal/api/operatorservice/v1/*
+
+	jq --rawfile desc $(OAPI_OUT)/payload_description.txt < $(OAPI_OUT)/openapiv2.swagger.json '.definitions.v1Payload={description: $$desc}' > $(OAPI_OUT)/v2.tmp
+	mv -f $(OAPI_OUT)/v2.tmp $(OAPI_OUT)/openapiv2.json
+	rm -f $(OAPI_OUT)/openapiv2.swagger.json
+	DESC=$$(cat $(OAPI_OUT)/payload_description.txt) yq e -i '$(OAPIV3_PATH).description = strenv(DESC) | del($(OAPI3_PATH).type) | del($(OAPI3_PATH).properties)' $(OAPI_OUT)/openapi.yaml
+	yq e -i '(.paths[] | .[] | .operationId) |= sub("\w+_(.*)", "$$1")' $(OAPI_OUT)/openapi.yaml
+	mv -f $(OAPI_OUT)/openapi.yaml $(OAPI_OUT)/openapiv3.yaml
+
 ##### Plugins & tools #####
 grpc-install:
 	@printf $(COLOR) "Install/update protoc and plugins..."
+	@go install go.temporal.io/api/cmd/protogen@latest
 	@go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
 	@go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
 	@go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest
 	@go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest
+	@go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest
+	@go install github.com/google/gnostic/cmd/protoc-gen-openapi@latest
+	@go install github.com/mikefarah/yq/v4@latest
 
 api-linter-install:
 	printf $(COLOR) "Install/update api-linter..."
 	go install github.com/googleapis/api-linter/cmd/api-linter@v1.32.3
+	go install github.com/itchyny/gojq/cmd/gojq@v0.12.14
 
 buf-install:
 	printf $(COLOR) "Install/update buf..."
@@ -75,7 +97,7 @@ buf-install:
 ##### Linters #####
 api-linter:
 	printf $(COLOR) "Run api-linter..."
-	$(call silent_exec, api-linter --set-exit-status $(PROTO_IMPORTS) --config $(PROTO_ROOT)/api-linter.yaml $(PROTO_FILES))
+	@api-linter --set-exit-status $(PROTO_IMPORTS) --config $(PROTO_ROOT)/api-linter.yaml --output-format json $(PROTO_FILES) | gojq -r 'map(select(.problems != []) | . as $$file | .problems[] | {rule: .rule_doc_uri, location: "\($$file.file_path):\(.location.start_position.line_number)"}) | group_by(.rule) | .[] | .[0].rule + ":\n" + (map("\t" + .location) | join("\n"))'
 
 $(STAMPDIR):
 	mkdir $@
@@ -91,7 +113,7 @@ buf-lint: $(STAMPDIR)/buf-mod-prune
 
 buf-breaking:
 	@printf $(COLOR) "Run buf breaking changes check against master branch..."	
-	@(cd $(PROTO_ROOT) && buf breaking --against '.git#branch=master')
+	@(cd $(PROTO_ROOT) && buf breaking --against 'https://github.com/temporalio/api.git#branch=master')
 
 ##### Clean #####
 clean:

package/sdk-core/sdk-core-protos/protos/api_upstream/README.md

@@ -1,5 +1,7 @@
 # Temporal proto files  
 
+This repository contains both the protobuf descriptors and OpenAPI documentation for the Temporal platform.
+
 ## How to use
 
 Install as git submodule to the project.

package/sdk-core/sdk-core-protos/protos/api_upstream/api-linter.yaml

@@ -1,54 +1,64 @@
 - included_paths:
     - "**/*.proto"
   disabled_rules:
-    - "core::0192::has-comments"
+    - "core::0122::name-suffix" # Allow fields to have a "_name" suffix -- https://linter.aip.dev/122/name-suffix
+    - "core::0140::uri" # We use "URL" instead of "URI" in many places. -- https://linter.aip.dev/140/uri
+    - "core::0192::has-comments" # Don't require comments on every field. -- https://linter.aip.dev/192/has-comments
+    - "core::0203::required" # We don't use resource annotations -- https://linter.aip.dev/203/required
+    - "core::0203::optional" # Same rationale as `core::0203::required` -- https://linter.aip.dev/203/optional
 
 - included_paths:
     - "**/message.proto"
   disabled_rules:
-    - "core::0122::name-suffix"
-    - "core::0123::resource-annotation"
+    - "core::0123::resource-annotation" # We don't require resource annotations on all messages -- https://linter.aip.dev/123/resource-annotation
 
 - included_paths:
     - "**/workflowservice/v1/request_response.proto"
     - "**/operatorservice/v1/request_response.proto"
   disabled_rules:
-    - "core::0122::name-suffix"
-    - "core::0131::request-name-required"
-    - "core::0131::request-unknown-fields"
-    - "core::0132::request-parent-required"
-    - "core::0132::request-unknown-fields"
-    - "core::0132::response-unknown-fields"
-    - "core::0134::request-unknown-fields"
-    - "core::0158::request-page-size-field"
-    - "core::0158::request-page-token-field"
-    - "core::0158::response-next-page-token-field"
-    - "core::0158::response-plural-first-field"
-    - "core::0158::response-repeated-first-field"
+    - "core::0131::request-name-behavior" # We don't add non-HTTP annotations -- https://linter.aip.dev/131/request-name-behavior
+    - "core::0131::request-name-reference" # We don't add non-HTTP annotations -- https://linter.aip.dev/131/request-name-reference
+    - "core::0131::request-name-required" # Don't require the `name` field in RPCs -- https://linter.aip.dev/131/request-name-required
+    - "core::0131::request-unknown-fields" # Allow things other than `name`, like `namespace`, in RPCs. This could've been `parent`, but that ship has sailed. -- https://linter.aip.dev/131/request-unknown-fields
+    - "core::0132::request-parent-required" # Don't require the `parent` field in List RPCs -- https://linter.aip.dev/132/request-parent-required
+    - "core::0132::request-unknown-fields" # Same rationale as `core::0131::request-unknown-fields`, but for List RPCs -- https://linter.aip.dev/132/request-unknown-fields
+    - "core::0132::response-unknown-fields" # We have a lot of List APIs which have more than just X's in the response. -- https://linter.aip.dev/132/response-unknown-fields
+    - "core::0133::request-parent-required" # Same rationale as `core::0132::request-parent-required`, but for Create RPCs -- https://linter.aip.dev/133/request-parent-required
+    - "core::0133::request-resource-behavior" # We don't add non-HTTP annotations -- https://linter.aip.dev/133/request-resource-behavior
+    - "core::0133::request-resource-field" # We don't add non-HTTP annotations -- https://linter.aip.dev/133/request-resource-field
+    - "core::0133::request-unknown-fields" # Same rationale as `core::0131::request-unknown-fields`, but for Create RPCs -- https://linter.aip.dev/133/request-unknown-fields
+    - "core::0134::request-mask-required" # We don't support an update mask in any of our APIs -- https://linter.aip.dev/134/request-mask-required
+    - "core::0134::request-resource-required" # We don't add non-HTTP annotations -- https://linter.aip.dev/134/request-resource-required
+    - "core::0134::request-unknown-fields" # Same rationale as `core::0131::request-unknown-fields`, but for Update RPCs -- https://linter.aip.dev/134/request-unknown-fields
+    - "core::0135::request-name-behavior" # We don't add non-HTTP annotations -- https://linter.aip.dev/135/request-name-behavior
+    - "core::0135::request-name-reference" # We don't add non-HTTP annotations -- https://linter.aip.dev/135/request-name-reference
+    - "core::0135::request-name-required" # Allow objects to be identified with something other than `name` -- https://linter.aip.dev/135/request-name-required
+    - "core::0135::request-unknown-fields" # Same rationale as `core::0131::request-unknown-fields`, but for Delete RPCs -- https://linter.aip.dev/135/request-unknown-fields
+    - "core::0158::request-page-size-field" # Allow "maximum_page_size" instead of "page_size" in requests, and allow non-paginated List RPCs -- https://linter.aip.dev/158/response-next-page-token-field
+    - "core::0158::request-page-token-field" # Allow "next_page_token" instead of "page_token" in requests, and allow non-paginated List RPCs -- https://linter.aip.dev/158/response-next-page-token-field
+    - "core::0158::response-next-page-token-field" # Allow for page tokens to be byte arrays instead of strings, and allow non-paginated List RPCs -- https://linter.aip.dev/158/response-next-page-token-field
+    - "core::0158::response-plural-first-field" # We have many APIs where we use "next_page_token" instead of "page_token" in the request. For some reason, that causes AIP to enforce some response-specific linter rules like this one. -- https://linter.aip.dev/158/response-plural-first-field
+    - "core::0158::response-repeated-first-field" # Same rationale as `core::0158::response-plural-first-field` -- https://linter.aip.dev/158/response-repeated-first-field
 
 - included_paths:
     - "**/workflowservice/v1/service.proto"
     - "**/operatorservice/v1/service.proto"
   disabled_rules:
-    # We extract specific fields in URL since the gRPC API predates the HTTP API
-    - "core::0127::resource-name-extraction"
+    - "core::0127::resource-name-extraction" # We extract specific fields in URL since the gRPC API predates the HTTP API -- https://linter.aip.dev/127/resource-name-extraction
 
     # We do not require specific "Get", "Create", "Update", or "Delete" RPC
     # rules just because we happen to use a known RPC name prefix
-    - "core::0131"
-    - "core::0133"
-    - "core::0134"
-    - "core::0135"
+    - "core::0131" # https://linter.aip.dev/0131
+    - "core::0133" # https://linter.aip.dev/0133
+    - "core::0134" # https://linter.aip.dev/0134
+    - "core::0135" # https://linter.aip.dev/0135
 
-    # We don't require HTTP calls to be suffixed with the same name as the gRPC
-    # name
-    - "core::0136::http-uri-suffix"
+    - "core::0136::http-uri-suffix" # We don't require HTTP calls to be suffixed with the same name as the gRPC name -- https://linter.aip.dev/136/http-uri-suffix
 
 - included_paths:
     - "**/operatorservice/v1/service.proto"
   disabled_rules:
-    # Do not require HTTP annotations on OperatorService calls at this time
-    - "core::0127::http-annotation"
+    - "core::0127::http-annotation" # Do not require HTTP annotations on OperatorService calls at this time -- https://linter.aip.dev/127/http-annotation
 
 - included_paths:
     - "google/**/*.proto"

package/sdk-core/sdk-core-protos/protos/api_upstream/buf.lock

@@ -5,7 +5,9 @@ deps:
     owner: googleapis
     repository: googleapis
     commit: 28151c0d0a1641bf938a7672c500e01d
+    digest: shake256:49215edf8ef57f7863004539deff8834cfb2195113f0b890dd1f67815d9353e28e668019165b9d872395871eeafcbab3ccfdb2b5f11734d3cca95be9e8d139de
   - remote: buf.build
     owner: grpc-ecosystem
     repository: grpc-gateway
     commit: 048ae6ff94ca4476b3225904b1078fad
+    digest: shake256:e5250bf2d999516c02206d757502b902e406f35c099d0e869dc3e4f923f6870fe0805a9974c27df0695462937eae90cd4d9db90bb9a03489412560baa74a87b6

package/sdk-core/sdk-core-protos/protos/api_upstream/google/protobuf/struct.proto

@@ -0,0 +1,95 @@
+// Protocol Buffers - Google's data interchange format
+// Copyright 2008 Google Inc.  All rights reserved.
+// https://developers.google.com/protocol-buffers/
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//     * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//     * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//     * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+syntax = "proto3";
+
+package google.protobuf;
+
+option cc_enable_arenas = true;
+option go_package = "google.golang.org/protobuf/types/known/structpb";
+option java_package = "com.google.protobuf";
+option java_outer_classname = "StructProto";
+option java_multiple_files = true;
+option objc_class_prefix = "GPB";
+option csharp_namespace = "Google.Protobuf.WellKnownTypes";
+
+// `Struct` represents a structured data value, consisting of fields
+// which map to dynamically typed values. In some languages, `Struct`
+// might be supported by a native representation. For example, in
+// scripting languages like JS a struct is represented as an
+// object. The details of that representation are described together
+// with the proto support for the language.
+//
+// The JSON representation for `Struct` is JSON object.
+message Struct {
+  // Unordered map of dynamically typed values.
+  map<string, Value> fields = 1;
+}
+
+// `Value` represents a dynamically typed value which can be either
+// null, a number, a string, a boolean, a recursive struct value, or a
+// list of values. A producer of value is expected to set one of these
+// variants. Absence of any variant indicates an error.
+//
+// The JSON representation for `Value` is JSON value.
+message Value {
+  // The kind of value.
+  oneof kind {
+    // Represents a null value.
+    NullValue null_value = 1;
+    // Represents a double value.
+    double number_value = 2;
+    // Represents a string value.
+    string string_value = 3;
+    // Represents a boolean value.
+    bool bool_value = 4;
+    // Represents a structured value.
+    Struct struct_value = 5;
+    // Represents a repeated `Value`.
+    ListValue list_value = 6;
+  }
+}
+
+// `NullValue` is a singleton enumeration to represent the null value for the
+// `Value` type union.
+//
+// The JSON representation for `NullValue` is JSON `null`.
+enum NullValue {
+  // Null value.
+  NULL_VALUE = 0;
+}
+
+// `ListValue` is a wrapper around a repeated field of values.
+//
+// The JSON representation for `ListValue` is JSON array.
+message ListValue {
+  // Repeated field of dynamically typed values.
+  repeated Value values = 1;
+}