Skip to content

feat(spanner): support x-goog-user-project #8316

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

Merged
coryan merged 2 commits into from
Feb 9, 2022
Merged

feat(spanner): support x-goog-user-project #8316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87b4570
feat(spanner): support x-goog-user-project
coryan Feb 9, 2022
76dd3ae
Address review comments
coryan Feb 9, 2022
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
32 changes: 7 additions & 25 deletions google/cloud/spanner/internal/defaults.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,9 @@
#include "google/cloud/spanner/internal/defaults.h"
#include "google/cloud/spanner/internal/session_pool.h"
#include "google/cloud/spanner/options.h"
#include "google/cloud/spanner/session_pool_options.h"
#include "google/cloud/common_options.h"
#include "google/cloud/connection_options.h"
#include "google/cloud/grpc_options.h"
#include "google/cloud/internal/getenv.h"
#include "google/cloud/internal/user_agent_prefix.h"
#include "google/cloud/internal/populate_common_options.h"
#include "google/cloud/internal/populate_grpc_options.h"
#include "google/cloud/options.h"
#include <chrono>
#include <string>
Expand All @@ -34,29 +31,14 @@ namespace {

// Sets basic defaults that apply to normal and admin connections.
void SetBasicDefaults(Options& opts) {
if (!opts.has<EndpointOption>()) {
auto e = internal::GetEnv("GOOGLE_CLOUD_CPP_SPANNER_DEFAULT_ENDPOINT");
opts.set<EndpointOption>(e && !e->empty() ? *e : "spanner.googleapis.com");
}
if (auto emulator = internal::GetEnv("SPANNER_EMULATOR_HOST")) {
opts.set<EndpointOption>(*emulator).set<GrpcCredentialOption>(
grpc::InsecureChannelCredentials());
}
if (!opts.has<GrpcCredentialOption>()) {
opts.set<GrpcCredentialOption>(grpc::GoogleDefaultCredentials());
}
opts = internal::PopulateCommonOptions(
std::move(opts), "GOOGLE_CLOUD_CPP_SPANNER_DEFAULT_ENDPOINT",
"SPANNER_EMULATOR_HOST", "spanner.googleapis.com");
opts =
internal::PopulateGrpcOptions(std::move(opts), "SPANNER_EMULATOR_HOST");
if (!opts.has<GrpcNumChannelsOption>()) {
opts.set<GrpcNumChannelsOption>(4);
}
if (!opts.has<TracingComponentsOption>()) {
opts.set<TracingComponentsOption>(internal::DefaultTracingComponents());
}
if (!opts.has<GrpcTracingOptionsOption>()) {
opts.set<GrpcTracingOptionsOption>(internal::DefaultTracingOptions());
}
// Inserts our user-agent string at the front.
auto& products = opts.lookup<UserAgentProductsOption>();
products.insert(products.begin(), internal::UserAgentPrefix());
}

} // namespace
Expand Down
20 changes: 20 additions & 0 deletions google/cloud/spanner/internal/defaults_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ TEST(Options, Defaults) {
"GOOGLE_CLOUD_CPP_TRACING_OPTIONS", absl::nullopt);
testing_util::ScopedEnvironment emulator_env("SPANNER_EMULATOR_HOST",
absl::nullopt);
testing_util::ScopedEnvironment user_project_env(
"GOOGLE_CLOUD_CPP_USER_PROJECT", absl::nullopt);
auto opts = spanner_internal::DefaultOptions();

EXPECT_EQ(opts.get<EndpointOption>(), "spanner.googleapis.com");
Expand All @@ -64,6 +66,7 @@ TEST(Options, Defaults) {
EXPECT_EQ(opts.get<GrpcTracingOptionsOption>(), TracingOptions{});
EXPECT_THAT(opts.get<UserAgentProductsOption>(),
ElementsAre(gcloud_user_agent_matcher()));
EXPECT_FALSE(opts.has<UserProjectOption>());

EXPECT_EQ(0, opts.get<SessionPoolMinSessionsOption>());
EXPECT_EQ(100, opts.get<SessionPoolMaxSessionsPerChannelOption>());
Expand All @@ -87,6 +90,8 @@ TEST(Options, AdminDefaults) {
"GOOGLE_CLOUD_CPP_TRACING_OPTIONS", absl::nullopt);
testing_util::ScopedEnvironment emulator_env("SPANNER_EMULATOR_HOST",
absl::nullopt);
testing_util::ScopedEnvironment user_project_env(
"GOOGLE_CLOUD_CPP_USER_PROJECT", absl::nullopt);
auto opts = spanner_internal::DefaultAdminOptions();

EXPECT_EQ(opts.get<EndpointOption>(), "spanner.googleapis.com");
Expand All @@ -99,6 +104,7 @@ TEST(Options, AdminDefaults) {
EXPECT_EQ(opts.get<GrpcTracingOptionsOption>(), TracingOptions{});
EXPECT_THAT(opts.get<UserAgentProductsOption>(),
ElementsAre(gcloud_user_agent_matcher()));
EXPECT_FALSE(opts.has<UserProjectOption>());

EXPECT_TRUE(opts.has<SpannerRetryPolicyOption>());
EXPECT_TRUE(opts.has<SpannerBackoffPolicyOption>());
Expand Down Expand Up @@ -154,6 +160,20 @@ TEST(Options, TracingOptionsFromEnv) {
EXPECT_EQ(256, options.truncate_string_field_longer_than());
}

TEST(Options, UserProject) {
auto env = testing_util::ScopedEnvironment("GOOGLE_CLOUD_CPP_USER_PROJECT",
absl::nullopt);
auto opts = spanner_internal::DefaultOptions(
Options{}.set<UserProjectOption>("opt-user-project"));
EXPECT_THAT(opts.get<UserProjectOption>(), "opt-user-project");

env = testing_util::ScopedEnvironment("GOOGLE_CLOUD_CPP_USER_PROJECT",
"env-user-project");
opts = spanner_internal::DefaultOptions(
Options{}.set<UserProjectOption>("opt-user-project"));
EXPECT_THAT(opts.get<UserProjectOption>(), "env-user-project");
}

TEST(Options, PassThroughUnknown) {
struct UnknownOption {
using Type = int;
Expand Down