@temporalio/core-bridge 1.8.6 → 1.9.0

package/sdk-core/sdk-core-protos/Cargo.toml

@@ -3,7 +3,7 @@ name = "temporal-sdk-core-protos"
 version = "0.1.0"
 edition = "2021"
 authors = ["Spencer Judge <spencer@temporal.io>"]
-license-file = "LICENSE.txt"
+license-file = { workspace = true }
 description = "Protobuf definitions for Temporal SDKs Core/Lang interface"
 homepage = "https://temporal.io/"
 repository = "https://github.com/temporalio/sdk-core"
@@ -25,9 +25,9 @@ rand = { version = "0.8", optional = true }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 thiserror = "1.0"
-tonic = "0.8"
+tonic = { workspace = true }
 uuid = { version = "1.1", features = ["v4"], optional = true }
 
 [build-dependencies]
-tonic-build = "0.8"
+tonic-build = { workspace = true }
 prost-wkt-build = "0.4"

package/sdk-core/sdk-core-protos/build.rs

@@ -1,7 +1,10 @@
 use std::{env, path::PathBuf};
 
+static ALWAYS_SERDE: &str = "#[cfg_attr(not(feature = \"serde_serialize\"), \
+                               derive(::serde::Serialize, ::serde::Deserialize))]";
+
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    println!("cargo:rerun-if-changed=../protos");
+    println!("cargo:rerun-if-changed=./protos");
     let out = PathBuf::from(env::var("OUT_DIR").unwrap());
     let descriptor_file = out.join("descriptors.bin");
     tonic_build::configure()
@@ -76,10 +79,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
         )
         .type_attribute("coresdk.Task.variant", "#[derive(::derive_more::From)]")
         // All external data is useful to be able to JSON serialize, so it can render in web UI
-        .type_attribute(
-            ".coresdk.external_data",
-            "#[cfg_attr(not(feature = \"serde_serialize\"), derive(::serde::Serialize, ::serde::Deserialize))]",
-        )
+        .type_attribute(".coresdk.external_data", ALWAYS_SERDE)
         .type_attribute(
             ".",
             "#[cfg_attr(feature = \"serde_serialize\", derive(::serde::Serialize, ::serde::Deserialize))]",
@@ -115,17 +115,17 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
         .file_descriptor_set_path(#[allow(clippy::needless_borrow)] &descriptor_file)
         .compile(
             &[
-                "../protos/local/temporal/sdk/core/core_interface.proto",
-                "../protos/api_upstream/temporal/api/workflowservice/v1/service.proto",
-                "../protos/api_upstream/temporal/api/operatorservice/v1/service.proto",
-                "../protos/testsrv_upstream/temporal/api/testservice/v1/service.proto",
-                "../protos/grpc/health/v1/health.proto",
+                "./protos/local/temporal/sdk/core/core_interface.proto",
+                "./protos/api_upstream/temporal/api/workflowservice/v1/service.proto",
+                "./protos/api_upstream/temporal/api/operatorservice/v1/service.proto",
+                "./protos/testsrv_upstream/temporal/api/testservice/v1/service.proto",
+                "./protos/grpc/health/v1/health.proto",
             ],
             &[
-                "../protos/api_upstream",
-                "../protos/local",
-                "../protos/testsrv_upstream",
-                "../protos/grpc",
+                "./protos/api_upstream",
+                "./protos/local",
+                "./protos/testsrv_upstream",
+                "./protos/grpc",
             ],
         )?;
 

package/sdk-core/sdk-core-protos/protos/api_upstream/.buildkite/Dockerfile

@@ -0,0 +1,2 @@
+FROM temporalio/base-ci-builder:1.10.3
+WORKDIR /temporal

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

@@ -0,0 +1,99 @@
+$(VERBOSE).SILENT:
+############################# Main targets #############################
+ci-build: install proto
+
+# Install dependencies.
+install: grpc-install api-linter-install buf-install
+
+# Run all linters and compile proto files.
+proto: grpc
+########################################################################
+
+##### Variables ######
+ifndef GOPATH
+GOPATH := $(shell go env GOPATH)
+endif
+
+GOBIN := $(if $(shell go env GOBIN),$(shell go env GOBIN),$(GOPATH)/bin)
+PATH := $(GOBIN):$(PATH)
+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)))
+PROTO_OUT := .gen
+PROTO_IMPORTS = \
+	-I=$(PROTO_ROOT)
+PROTO_PATHS = paths=source_relative:$(PROTO_OUT)
+
+$(PROTO_OUT):
+	mkdir $(PROTO_OUT)
+
+##### Compile proto files for go #####
+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;)
+
+fix-path:
+	mv -f $(PROTO_OUT)/temporal/api/* $(PROTO_OUT) && rm -rf $(PROTO_OUT)/temporal
+
+##### Plugins & tools #####
+grpc-install:
+	@printf $(COLOR) "Install/update protoc and plugins..."
+	@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
+
+api-linter-install:
+	printf $(COLOR) "Install/update api-linter..."
+	go install github.com/googleapis/api-linter/cmd/api-linter@v1.32.3
+
+buf-install:
+	printf $(COLOR) "Install/update buf..."
+	go install github.com/bufbuild/buf/cmd/buf@v1.27.0
+
+##### 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))
+
+$(STAMPDIR):
+	mkdir $@
+
+$(STAMPDIR)/buf-mod-prune: $(STAMPDIR) buf.yaml
+	printf $(COLOR) "Pruning buf module"
+	buf mod prune
+	touch $@
+
+buf-lint: $(STAMPDIR)/buf-mod-prune
+	printf $(COLOR) "Run buf linter..."
+	(cd $(PROTO_ROOT) && buf lint)
+
+buf-breaking:
+	@printf $(COLOR) "Run buf breaking changes check against master branch..."	
+	@(cd $(PROTO_ROOT) && buf breaking --against '.git#branch=master')
+
+##### Clean #####
+clean:
+	printf $(COLOR) "Delete generated go files..."
+	rm -rf $(PROTO_OUT) $(BUF_DEPS)

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

@@ -0,0 +1,56 @@
+- included_paths:
+    - "**/*.proto"
+  disabled_rules:
+    - "core::0192::has-comments"
+
+- included_paths:
+    - "**/message.proto"
+  disabled_rules:
+    - "core::0122::name-suffix"
+    - "core::0123::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"
+
+- 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"
+
+    # 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"
+
+    # We don't require HTTP calls to be suffixed with the same name as the gRPC
+    # name
+    - "core::0136::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"
+
+- included_paths:
+    - "google/**/*.proto"
+  disabled_rules:
+    - "all"

package/sdk-core/sdk-core-protos/protos/api_upstream/buf.gen.yaml

@@ -0,0 +1,20 @@
+version: v1
+plugins:
+  - plugin: buf.build/protocolbuffers/go:v1.31.0
+    out: ./
+    opt:
+      - paths=source_relative
+  - plugin: buf.build/grpc/go:v1.3.0
+    out: ./
+    opt:
+      - paths=source_relative
+  - plugin: buf.build/grpc-ecosystem/gateway:v2.18.0
+    out: ./
+    opt:
+      - paths=source_relative
+      - allow_patch_feature=false
+  - name: go-helpers
+    out: ./
+    path: ["go", "run", "./protoc-gen-go-helpers"]
+    opt:
+      - paths=source_relative

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

@@ -0,0 +1,11 @@
+# Generated by buf. DO NOT EDIT.
+version: v1
+deps:
+  - remote: buf.build
+    owner: googleapis
+    repository: googleapis
+    commit: 28151c0d0a1641bf938a7672c500e01d
+  - remote: buf.build
+    owner: grpc-ecosystem
+    repository: grpc-gateway
+    commit: 048ae6ff94ca4476b3225904b1078fad

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

@@ -0,0 +1,18 @@
+version: v1
+deps:
+  - buf.build/grpc-ecosystem/grpc-gateway
+build:
+  excludes:
+    # Buf won't accept a local dependency on the google protos but we need them
+    # to run api-linter, so just tell buf it ignore it
+    - google
+breaking:
+  use:
+    - WIRE_JSON
+  ignore:
+    - google
+lint:
+  use:
+    - DEFAULT
+  ignore:
+    - google

package/sdk-core/sdk-core-protos/protos/api_upstream/google/api/annotations.proto

@@ -0,0 +1,31 @@
+// Copyright 2015 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.api;
+
+import "google/api/http.proto";
+import "google/protobuf/descriptor.proto";
+
+option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
+option java_multiple_files = true;
+option java_outer_classname = "AnnotationsProto";
+option java_package = "com.google.api";
+option objc_class_prefix = "GAPI";
+
+extend google.protobuf.MethodOptions {
+  // See `HttpRule`.
+  HttpRule http = 72295728;
+}