Add support for custom static headers by vam-google · Pull Request #2690 · googleapis/google-cloud-java

vam-google · 2017-12-08T00:53:30Z

Dependent on googleapis/gax-java#432 (will fail build until that is released)

Note, PubSub is supported only partially. Full support is dependent on migration of PubSub from Grpc stubs to Gapic stubs.

The spanner's SpannerOptions.Builder.setUserAgentPrefix() method is replaced with ServiceOptions.Builder.setHeaderProvider() and providing "user-agent" value there (it will be prefixing the header provider as explained in ServiceOptions.Builder.setHeaderProvider() documentation, see example below).

Usage:

// For manual/semi-manual clients:
//     Resource Manager
//     Translate
//     Compute
//     Storage
//     Datastore
//     Dns
//     BigQuery
//
//     Logging
//     Firestore
//     Spanner
HeaderProvider headerProvider =
    FixedHeaderProvider.create("user-agent", "my-client-name", "custom-header", "custom stuff");
DatastoreOptions options =
    DatastoreOptions.newBuilder().setHeaderProvider(headerProvider).build();
Datastore datastore = options.getService();

// For generated clients:
//    All others, except Pub/Sub
HeaderProvider headerProvider =
    FixedHeaderProvider.create("user-agent", "my-client-name", "custom-header", "custom stuff");
LanguageServiceSettings settings =
    LanguageServiceSettings.newBuilder().setHeaderProvider(headerProvider).build();
LanguageServiceClient client = LanguageServiceClient.create(settings);

// Note, PubSub is supported only partially. Full support is dependent on migration of PubSub from Grpc stubs to Gapic stubs

Dependent on googleapis/gax-java#432 Usage: // For manual/semi-manual clients: // Resource Manager // Translate // Compute // Storage // Datastore // Dns // BigQuery // // Logging // Firestore // Spanner HeaderProvider headerProvider = FixedHeaderProvider.create("user-agent", "my-client-name", "custom-header", "custom stuff"); LanguageServiceSettings settings = LanguageServiceSettings.newBuilder().setHeaderProvider(headerProvider).build(); LanguageServiceClient client = LanguageServiceClient.create(settings); // For generated clients: // All others, except Pub/Sub HeaderProvider headerProvider = FixedHeaderProvider.create("user-agent", "my-client-name", "custom-header", "custom stuff"); DatastoreOptions options = DatastoreOptions.newBuilder().setHeaderProvider(headerProvider).build(); Datastore datastore = options.getService(); // Note, PubSub is supported only partially. Full support is dependent on migration of PubSub from Grpc stubs to Gapic stubs

garrettjonesgoogle

One initial comment

...-cloud-examples/src/main/java/com/google/cloud/examples/datastore/snippets/CreateEntity.java

  public static void main(String... args) {
-    Datastore datastore = DatastoreOptions.getDefaultInstance().getService();
+    HeaderProvider headerProvider =
+        FixedHeaderProvider.create("user-agent", "my-client-name", "custom-header", "custom stuff");


google-cloud-spanner/pom.xml

-            </goals>
-          </execution>
-        </executions>
-      </plugin>


google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java

  private SpannerOptions(Builder builder) {
    super(SpannerFactory.class, SpannerRpcFactory.class, builder, new SpannerDefaults());
    numChannels = builder.numChannels;
-    userAgent = builder.userAgentPrefix;


google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/GrpcSpannerRpc.java

+      Pattern.compile("^(?<headerValue>projects/[^/]*/instances/[^/]*/databases/[^/]*)(.*)?");
  private static final Pattern INSTANCE_PATTERN =
-      Pattern.compile("^(?<instance>projects/[^/]*/instances/[^/]*)(.*)?");
+      Pattern.compile("^(?<headerValue>projects/[^/]*/instances/[^/]*)(.*)?");


...cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/SpannerClientHeaderProvider.java

+    return headersAsMetadata;
+  }
+
+  Map<Key<String>, String> getResourceHeadersAsMetadata(


...cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/SpannerClientHeaderProvider.java

+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+class SpannerClientHeaderProvider implements HeaderProvider {


vam-google · 2017-12-09T00:07:38Z

@vkedia PTAL

google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/GrpcSpannerRpc.java

+
+    HeaderProvider mergedHeaderProvider = options.getMergedHeaderProvider(internalHeaderProvider);
+    this.headerProvider = SpannerHeaderProvider.create(mergedHeaderProvider.getHeaders(),
+        internalHeaderProviderBuilder.getResourceHeaderKey());


google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/SpannerHeaderProvider.java

+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+class SpannerHeaderProvider implements HeaderProvider {


google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/SpannerHeaderProvider.java

+    }
+
+    return ImmutableMap.of(
+        Key.of(resourceHeaderKey, Metadata.ASCII_STRING_MARSHALLER), resourceToken);


google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/GrpcSpannerRpc.java

-    Matcher m = DATABASE_PATTERN.matcher(resource);
-    if (m.matches()) {
-      return m.group("database");
+    Map<Metadata.Key<String>, String> headers = headerProvider.getHeadersAsMetadata();


vam-google · 2017-12-13T01:48:09Z

@garrettjonesgoogle PTAL

Note that the header testing changes are additive, and thus are reflected here only in LanguageServiceClientTest as an example (the others will be added automatically once everything is regenerated using corresponding toolkit changes)

google-cloud-bom/pom.xml

-    <gax-grpc.version>1.15.0</gax-grpc.version>
+    <gax.version>1.15.1-SNAPSHOT</gax.version>
+    <gax-grpc.version>1.15.1-SNAPSHOT</gax-grpc.version>
+    <gax-httpjson.version>0.32.1-SNAPSHOT</gax-httpjson.version>


...cloud-spanner/src/test/java/com/google/cloud/spanner/spi/v1/SpannerMetadataProviderTest.java

+  @Test
+  public void testGetHeadersAsMetadata() {
+    Map<String, String> headers = ImmutableMap.of("header1", "value1", "header2", "value2");
+    SpannerMetadataProvider headerProvider = SpannerMetadataProvider.create(headers, "header3");


google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/SpannerMetadataProvider.java

+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+class SpannerMetadataProvider {


...-examples/src/main/java/com/google/cloud/examples/logging/snippets/CreateAndListMetrics.java

+        FixedHeaderProvider.create("user-agent", "my-client-name", "custom-header", "custom stuff");
+
+    LoggingOptions options =
+        LoggingOptions.newBuilder().setHeaderProvider(headerProvider).build();


...mples/src/main/java/com/google/cloud/examples/bigquery/snippets/InsertDataAndQueryTable.java


    // Create a dataset
-    String datasetId = "my_dataset_id";
+    String datasetId = "my_dataset_id_1";


google-cloud-core/src/main/java/com/google/cloud/ServiceOptions.java

-    return libraryVersion == null ? LIBRARY_NAME : LIBRARY_NAME + "/" + libraryVersion;
-  }

+    // We have to do it, since underlying layers often do not appreciate User-Agent provided as a


vam-google · 2017-12-13T23:04:09Z

@garrettjonesgoogle PTAL

gax: 1.16.0 gax-grpc: 1.16.0 gax-httpjson: 0.33.0

vam-google · 2017-12-14T21:27:26Z

@garrettjonesgoogle PTAL

…#2690) * chore: Update generation configuration at Tue Oct 8 02:26:28 UTC 2024 * chore: generate libraries at Tue Oct 8 02:26:50 UTC 2024

vam-google requested a review from garrettjonesgoogle as a code owner December 8, 2017 00:53

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Dec 8, 2017

vam-google requested review from pongad and vkedia December 8, 2017 00:53

vam-google mentioned this pull request Dec 8, 2017

Add support for custom static headers googleapis/gax-java#432

Merged

garrettjonesgoogle reviewed Dec 8, 2017

View reviewed changes

vam-google added 3 commits December 8, 2017 15:04

Address codacy-bot feedback and initial feedback comment

cf6610e

remove extractHeader method from GrpcSpannerRpc

5129a68

Minor spanner fixes

b6b1413

vkedia suggested changes Dec 8, 2017

View reviewed changes

Address Spanner PR feedback

54759a2

vam-google mentioned this pull request Dec 11, 2017

Add support for custom static headers googleapis/gapic-generator#1741

Merged

vkedia reviewed Dec 11, 2017

View reviewed changes

vam-google added 3 commits December 12, 2017 14:23

Merge remote-tracking branch 'upstream/master'

4fa1a78

Add support internal headers validation in generated tests only.

7d99714

Address spanner PR feedback

28c9c1b

vam-google added 2 commits December 13, 2017 13:27

Merge remote-tracking branch 'upstream/master'

ab0601f

Fix for firestore

59af7b9

vkedia approved these changes Dec 13, 2017

View reviewed changes

garrettjonesgoogle reviewed Dec 13, 2017

View reviewed changes

vam-google added 3 commits December 13, 2017 15:01

Address PR feedback, fix logging headers

1c43bc6

Fix comment

9f86cf5

Fix comment

21c0fb8

vam-google added 2 commits December 14, 2017 12:42

Integrate with latest gax-java PR feedback changes

88008d6

Bump dependencies versions:

0a98718

gax: 1.16.0 gax-grpc: 1.16.0 gax-httpjson: 0.33.0

vam-google merged commit db0fdb1 into googleapis:master Dec 14, 2017

salrashid123 mentioned this pull request Dec 18, 2017

Allow setting ApplicationName/user-agent #2443

Closed

meltsufin mentioned this pull request Jan 17, 2018

Adds usage tracking to the Google Cloud Client libraries spring-attic/spring-cloud-gcp#308

Merged

garrettjonesgoogle mentioned this pull request Jul 16, 2018

[BEAM-3098] Upgrades gRPC and protobuf dependencies apache/beam#5767

Closed

2 tasks

Conversation

vam-google commented Dec 8, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

garrettjonesgoogle left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

vam-google commented Dec 9, 2017

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

vam-google commented Dec 13, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

vam-google commented Dec 8, 2017 •

edited

Loading

vam-google commented Dec 13, 2017 •

edited

Loading