Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support disabling proto load via environment variable #335

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -6,4 +6,10 @@ PROTO_OUT := lib/gen
proto:
$(foreach PROTO_DIR,$(PROTO_DIRS),bundle exec grpc_tools_ruby_protoc -Iproto --ruby_out=$(PROTO_OUT) --grpc_out=$(PROTO_OUT) $(PROTO_DIR)*.proto;)

# Need to only load imports if not disabled
sed -i "/require 'temporal/ s|\(.*\)|\1 unless ENV['COINBASE_TEMPORAL_RUBY_DISABLE_PROTO_LOAD'] == '1'|" \
lib/gen/temporal/api/operatorservice/v1/service_services_pb.rb
sed -i "/require 'temporal/ s|\(.*\)|\1 unless ENV['COINBASE_TEMPORAL_RUBY_DISABLE_PROTO_LOAD'] == '1'|" \
lib/gen/temporal/api/workflowservice/v1/service_services_pb.rb

.PHONY: proto

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions lib/temporal.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Protoc wants all of its generated files on the LOAD_PATH
$LOAD_PATH << File.expand_path('./gen', __dir__)
# Protoc wants all of its generated files on the LOAD_PATH. Only require protos if not disabled.
unless ENV['COINBASE_TEMPORAL_RUBY_DISABLE_PROTO_LOAD'] == '1'
$LOAD_PATH << File.expand_path('./gen', __dir__)
end

require 'securerandom'
require 'forwardable'
16 changes: 11 additions & 5 deletions lib/temporal/connection/grpc.rb
Original file line number Diff line number Diff line change
@@ -3,11 +3,6 @@
require 'google/protobuf/well_known_types'
require 'securerandom'
require 'json'
require 'gen/temporal/api/filter/v1/message_pb'
require 'gen/temporal/api/workflowservice/v1/service_services_pb'
require 'gen/temporal/api/operatorservice/v1/service_services_pb'
require 'gen/temporal/api/enums/v1/workflow_pb'
require 'gen/temporal/api/enums/v1/common_pb'
require 'temporal/connection/errors'
require 'temporal/connection/interceptors/client_name_version_interceptor'
require 'temporal/connection/serializer'
@@ -16,6 +11,17 @@
require 'temporal/connection/serializer/schedule'
require 'temporal/connection/serializer/workflow_id_reuse_policy'

# Only require protos if not disabled. This env var is commonly set to work alongside the temporalio/sdk-ruby project.
unless ENV['COINBASE_TEMPORAL_RUBY_DISABLE_PROTO_LOAD'] == '1'
require 'gen/temporal/api/filter/v1/message_pb'
require 'gen/temporal/api/enums/v1/workflow_pb'
require 'gen/temporal/api/enums/v1/common_pb'
end

# These are gRPC stubs, not protos, and therefore are not disabled when protos are
require 'gen/temporal/api/workflowservice/v1/service_services_pb'
require 'gen/temporal/api/operatorservice/v1/service_services_pb'

module Temporal
module Connection
class GRPC
8 changes: 6 additions & 2 deletions lib/temporal/connection/serializer/base.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
require 'oj'
require 'gen/temporal/api/common/v1/message_pb'
require 'gen/temporal/api/command/v1/message_pb'

# Only require protos if not disabled
unless ENV['COINBASE_TEMPORAL_RUBY_DISABLE_PROTO_LOAD'] == '1'
require 'gen/temporal/api/common/v1/message_pb'
require 'gen/temporal/api/command/v1/message_pb'
end

module Temporal
module Connection
6 changes: 5 additions & 1 deletion lib/temporal/testing/replay_tester.rb
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
require "gen/temporal/api/history/v1/message_pb"
require "json"
require "temporal/errors"
require "temporal/metadata/workflow_task"
require "temporal/middleware/chain"
require "temporal/workflow/executor"
require "temporal/workflow/stack_trace_tracker"

# Only require protos if not disabled
unless ENV['COINBASE_TEMPORAL_RUBY_DISABLE_PROTO_LOAD'] == '1'
require "gen/temporal/api/history/v1/message_pb"
end

module Temporal
module Testing
class ReplayError < StandardError