Skip to content

feat(rest): add faraday_config option to client configuration #1284

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.

Sign up for GitHub

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

Open
aandreassa wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(rest): add faraday_config option to client configuration #1284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions gapic-generator-cloud/Gemfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ gem "grpc-tools", ">= 1.60.0", "< 1.75.1"
gem "minitest", "~> 5.16"
gem "minitest-autotest", "~> 1.0"
gem "minitest-focus", "~> 1.0"
gem "ostruct", "~> 0.6.3"
gem "pry", ">= 0.14"
gem "redcarpet", "~> 3.0"
gem "yard", "~> 0.9"
2 changes: 2 additions & 0 deletions gapic-generator-cloud/Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ GEM
minitest (~> 5.16)
nokogiri (1.19.2-x86_64-linux-gnu)
racc (~> 1.4)
ostruct (0.6.3)
parallel (2.0.1)
parser (3.3.11.1)
ast (~> 2.4.1)
Expand Down Expand Up @@ -155,6 +156,7 @@ DEPENDENCIES
minitest (~> 5.16)
minitest-autotest (~> 1.0)
minitest-focus (~> 1.0)
ostruct (~> 0.6.3)
pry (>= 0.14)
redcarpet (~> 3.0)
yard (~> 0.9)
Expand Down
1 change: 1 addition & 0 deletions gapic-generator/Gemfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ gem "grpc-tools", ">= 1.60.0", "< 1.75.1"
gem "minitest", "~> 5.16"
gem "minitest-autotest", "~> 1.0"
gem "minitest-focus", "~> 1.0"
gem "ostruct", "~> 0.6.3"
gem "pry", ">= 0.14"
gem "redcarpet", "~> 3.0"
gem "yard", "~> 0.9"
2 changes: 2 additions & 0 deletions gapic-generator/Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ GEM
minitest (~> 5.16)
nokogiri (1.19.2-x86_64-linux-gnu)
racc (~> 1.4)
ostruct (0.6.3)
parallel (2.0.1)
parser (3.3.11.1)
ast (~> 2.4.1)
Expand Down Expand Up @@ -148,6 +149,7 @@ DEPENDENCIES
minitest (~> 5.16)
minitest-autotest (~> 1.0)
minitest-focus (~> 1.0)
ostruct (~> 0.6.3)
pry (>= 0.14)
redcarpet (~> 3.0)
yard (~> 0.9)
Expand Down
5 changes: 4 additions & 1 deletion gapic-generator/templates/default/service/rest/client/_client.text.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ class <%= service.rest.client_name %>
<%- if subclient.respond_to?(:bindings_override) && !subclient.bindings_override.empty? -%>
config.bindings_override = @config.bindings_override
<%- end -%>
config.faraday_config = @config.faraday_config if config.respond_to? :faraday_config=
end

<%- end -%>
Expand All @@ -145,7 +146,8 @@ class <%= service.rest.client_name %>
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
universe_domain: @config.universe_domain,
credentials: credentials,
logger: @config.logger
logger: @config.logger,
faraday_config: @config.faraday_config
)

@<%= service.stub_name %>.logger(stub: true)&.info do |entry|
Expand All @@ -168,6 +170,7 @@ class <%= service.rest.client_name %>
config.bindings_override = @config.bindings_override
<%- end -%>
config.logger = @<%= service.stub_name %>.logger if config.respond_to? :logger=
config.faraday_config = @config.faraday_config if config.respond_to? :faraday_config=
end
<%- end -%>
end
Expand Down
4 changes: 4 additions & 0 deletions gapic-generator/templates/default/service/rest/client/_config.text.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,9 @@
# `:default` (the default) to construct a default logger, or `nil` to
# explicitly disable logging.
# @return [::Logger,:default,nil]
# @!attribute [rw] faraday_config
# A Proc to configure the underlying Faraday connection object.
# @return [::Proc,nil]
#
class Configuration
extend ::Gapic::Config
Expand Down Expand Up @@ -120,6 +123,7 @@ class Configuration
config_attr :bindings_override, {}, ::Hash, nil
<%- end -%>
config_attr :logger, :default, ::Logger, nil, :default
config_attr :faraday_config, nil, ::Proc, nil

# @private
def initialize parent_config = nil
Expand Down
16 changes: 10 additions & 6 deletions gapic-generator/templates/default/service/rest/client/_operations.text.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ class <%= service.operations_name %>
endpoint: @config.endpoint,
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
universe_domain: @config.universe_domain,
credentials: credentials
credentials: credentials,
faraday_config: @config.faraday_config
)

# Used by an LRO wrapper for some methods of this service
Expand All @@ -102,15 +103,18 @@ end
# Service stub contains baseline method implementations
# including transcoding, making the REST call, and deserialing the response.
class <%= service.operations_stub_name %>
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, faraday_config: nil
# These require statements are intentionally placed here to initialize
# the REST modules only when it's required.
require "gapic/rest"

@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
endpoint_template: endpoint_template,
universe_domain: universe_domain,
credentials: credentials
@client_stub = ::Gapic::Rest::ClientStub.new(
endpoint: endpoint,
endpoint_template: endpoint_template,
universe_domain: universe_domain,
credentials: credentials,
&faraday_config
)
end

<%- service.lro_service.rest.methods.each do |method| -%>
Expand Down
21 changes: 12 additions & 9 deletions gapic-generator/templates/default/service/rest/service_stub/_service_stub.text.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,22 @@ require "<%= service.proto_service_require %>"
<%= render partial: "proto_docs/deprecated", locals: { presenter: service } -%>
class <%= service.rest.service_stub_name %>
# @private
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:, faraday_config: nil
# These require statements are intentionally placed here to initialize
# the REST modules only when it's required.
require "gapic/rest"

@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
endpoint_template: endpoint_template,
universe_domain: universe_domain,
credentials: credentials,
numeric_enums: <%= service.rest.numeric_enums? %>,
service_name: self.class,
raise_faraday_errors: false,
logger: logger
@client_stub = ::Gapic::Rest::ClientStub.new(
endpoint: endpoint,
endpoint_template: endpoint_template,
universe_domain: universe_domain,
credentials: credentials,
numeric_enums: <%= service.rest.numeric_enums? %>,
service_name: self.class,
raise_faraday_errors: false,
logger: logger,
&faraday_config
)
end

##
Expand Down
25 changes: 25 additions & 0 deletions gapic-generator/templates/default/service/rest/test/method/_configure.text.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,28 @@ def test_configure
assert_same block_config, config
assert_kind_of <%= full_client_name %>::Configuration, config
end

def test_faraday_config
# Create test objects.
credentials_token = :dummy_value
captured_blocks = []

faraday_config_proc = ->(conn) { conn.ssl.client_cert = "cert" }

stub_proc = ->(**kwargs, &block) do
captured_blocks << block
ClientStub.new nil
end

# Create client with faraday_config option.
Gapic::Rest::ClientStub.stub :new, stub_proc do
<%= full_client_name %>.new do |config|
config.credentials = credentials_token
config.faraday_config = faraday_config_proc
end
end

# Verify faraday_config block passthrough.
assert_includes captured_blocks, faraday_config_proc
end

8 changes: 7 additions & 1 deletion shared/output/cloud/compute_small/lib/google/cloud/compute/v1/addresses/rest/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,14 +150,16 @@ def initialize
config.quota_project = @quota_project_id
config.endpoint = @config.endpoint
config.universe_domain = @config.universe_domain
config.faraday_config = @config.faraday_config if config.respond_to? :faraday_config=
end

@addresses_stub = ::Google::Cloud::Compute::V1::Addresses::Rest::ServiceStub.new(
endpoint: @config.endpoint,
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
universe_domain: @config.universe_domain,
credentials: credentials,
logger: @config.logger
logger: @config.logger,
faraday_config: @config.faraday_config
)

@addresses_stub.logger(stub: true)&.info do |entry|
Expand Down Expand Up @@ -758,6 +760,9 @@ def list request, options = nil
# `:default` (the default) to construct a default logger, or `nil` to
# explicitly disable logging.
# @return [::Logger,:default,nil]
# @!attribute [rw] faraday_config
# A Proc to configure the underlying Faraday connection object.
# @return [::Proc,nil]
#
class Configuration
extend ::Gapic::Config
Expand All @@ -780,6 +785,7 @@ class Configuration
config_attr :quota_project, nil, ::String, nil
config_attr :universe_domain, nil, ::String, nil
config_attr :logger, :default, ::Logger, nil, :default
config_attr :faraday_config, nil, ::Proc, nil

# @private
def initialize parent_config = nil
Expand Down
21 changes: 12 additions & 9 deletions shared/output/cloud/compute_small/lib/google/cloud/compute/v1/addresses/rest/service_stub.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,22 @@ module Rest
#
class ServiceStub
# @private
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:, faraday_config: nil
# These require statements are intentionally placed here to initialize
# the REST modules only when it's required.
require "gapic/rest"

@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
endpoint_template: endpoint_template,
universe_domain: universe_domain,
credentials: credentials,
numeric_enums: false,
service_name: self.class,
raise_faraday_errors: false,
logger: logger
@client_stub = ::Gapic::Rest::ClientStub.new(
endpoint: endpoint,
endpoint_template: endpoint_template,
universe_domain: universe_domain,
credentials: credentials,
numeric_enums: false,
service_name: self.class,
raise_faraday_errors: false,
logger: logger,
&faraday_config
)
end

##
Expand Down
7 changes: 6 additions & 1 deletion ...d/output/cloud/compute_small/lib/google/cloud/compute/v1/global_operations/rest/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,8 @@ def initialize
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
universe_domain: @config.universe_domain,
credentials: credentials,
logger: @config.logger
logger: @config.logger,
faraday_config: @config.faraday_config
)

@global_operations_stub.logger(stub: true)&.info do |entry|
Expand Down Expand Up @@ -421,6 +422,9 @@ def get request, options = nil
# `:default` (the default) to construct a default logger, or `nil` to
# explicitly disable logging.
# @return [::Logger,:default,nil]
# @!attribute [rw] faraday_config
# A Proc to configure the underlying Faraday connection object.
# @return [::Proc,nil]
#
class Configuration
extend ::Gapic::Config
Expand All @@ -443,6 +447,7 @@ class Configuration
config_attr :quota_project, nil, ::String, nil
config_attr :universe_domain, nil, ::String, nil
config_attr :logger, :default, ::Logger, nil, :default
config_attr :faraday_config, nil, ::Proc, nil

# @private
def initialize parent_config = nil
Expand Down
21 changes: 12 additions & 9 deletions ...ut/cloud/compute_small/lib/google/cloud/compute/v1/global_operations/rest/service_stub.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,22 @@ module Rest
#
class ServiceStub
# @private
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:, faraday_config: nil
# These require statements are intentionally placed here to initialize
# the REST modules only when it's required.
require "gapic/rest"

@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
endpoint_template: endpoint_template,
universe_domain: universe_domain,
credentials: credentials,
numeric_enums: false,
service_name: self.class,
raise_faraday_errors: false,
logger: logger
@client_stub = ::Gapic::Rest::ClientStub.new(
endpoint: endpoint,
endpoint_template: endpoint_template,
universe_domain: universe_domain,
credentials: credentials,
numeric_enums: false,
service_name: self.class,
raise_faraday_errors: false,
logger: logger,
&faraday_config
)
end

##
Expand Down
8 changes: 7 additions & 1 deletion shared/output/cloud/compute_small/lib/google/cloud/compute/v1/networks/rest/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,14 +150,16 @@ def initialize
config.quota_project = @quota_project_id
config.endpoint = @config.endpoint
config.universe_domain = @config.universe_domain
config.faraday_config = @config.faraday_config if config.respond_to? :faraday_config=
end

@networks_stub = ::Google::Cloud::Compute::V1::Networks::Rest::ServiceStub.new(
endpoint: @config.endpoint,
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
universe_domain: @config.universe_domain,
credentials: credentials,
logger: @config.logger
logger: @config.logger,
faraday_config: @config.faraday_config
)

@networks_stub.logger(stub: true)&.info do |entry|
Expand Down Expand Up @@ -481,6 +483,9 @@ def remove_peering request, options = nil
# `:default` (the default) to construct a default logger, or `nil` to
# explicitly disable logging.
# @return [::Logger,:default,nil]
# @!attribute [rw] faraday_config
# A Proc to configure the underlying Faraday connection object.
# @return [::Proc,nil]
#
class Configuration
extend ::Gapic::Config
Expand All @@ -503,6 +508,7 @@ class Configuration
config_attr :quota_project, nil, ::String, nil
config_attr :universe_domain, nil, ::String, nil
config_attr :logger, :default, ::Logger, nil, :default
config_attr :faraday_config, nil, ::Proc, nil

# @private
def initialize parent_config = nil
Expand Down
21 changes: 12 additions & 9 deletions shared/output/cloud/compute_small/lib/google/cloud/compute/v1/networks/rest/service_stub.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,22 @@ module Rest
#
class ServiceStub
# @private
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:, faraday_config: nil
# These require statements are intentionally placed here to initialize
# the REST modules only when it's required.
require "gapic/rest"

@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
endpoint_template: endpoint_template,
universe_domain: universe_domain,
credentials: credentials,
numeric_enums: false,
service_name: self.class,
raise_faraday_errors: false,
logger: logger
@client_stub = ::Gapic::Rest::ClientStub.new(
endpoint: endpoint,
endpoint_template: endpoint_template,
universe_domain: universe_domain,
credentials: credentials,
numeric_enums: false,
service_name: self.class,
raise_faraday_errors: false,
logger: logger,
&faraday_config
)
end

##
Expand Down
Loading
Loading