You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by "shunping-google (via GitHub)" <gi...@apache.org> on 2023/05/18 19:17:32 UTC

[GitHub] [beam] shunping-google opened a new pull request, #26770: Include "(GPN:Beam)" in the user agent of GCS HTTP request header.

shunping-google opened a new pull request, #26770:
URL: https://github.com/apache/beam/pull/26770

   * Prepend "(GPN:Beam)" to the application name, which is then used in constructing the user agent string by GCS client APIs.
   * Add a unit test.
   
   **Please** add a meaningful description for your change here
   
   ------------------------
   
   Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
   
    - [ ] Mention the appropriate issue in your description (for example: `addresses #123`), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment `fixes #<ISSUE NUMBER>` instead.
    - [ ] Update `CHANGES.md` with noteworthy changes.
    - [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
   
   See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://beam.apache.org/contribute/get-started-contributing/#make-the-reviewers-job-easier).
   
   To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
   
   GitHub Actions Tests Status (on master branch)
   ------------------------------------------------------------------------------------------------
   [![Build python source distribution and wheels](https://github.com/apache/beam/workflows/Build%20python%20source%20distribution%20and%20wheels/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
   [![Python tests](https://github.com/apache/beam/workflows/Python%20tests/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
   [![Java tests](https://github.com/apache/beam/workflows/Java%20Tests/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
   [![Go tests](https://github.com/apache/beam/workflows/Go%20tests/badge.svg?branch=master&event=schedule)](https://github.com/apache/beam/actions?query=workflow%3A%22Go+tests%22+branch%3Amaster+event%3Aschedule)
   
   See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] kennknowles commented on a diff in pull request #26770: Include "(GPN:Beam)" in user-agent of GCS HTTP request header for Java.

Posted by "kennknowles (via GitHub)" <gi...@apache.org>.
kennknowles commented on code in PR #26770:
URL: https://github.com/apache/beam/pull/26770#discussion_r1199333276


##########
sdks/java/extensions/google-cloud-platform-core/src/test/java/org/apache/beam/sdk/extensions/gcp/util/TransportTest.java:
##########
@@ -0,0 +1,43 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.
+ */
+package org.apache.beam.sdk.extensions.gcp.util;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.containsString;
+
+import com.google.api.services.storage.Storage;
+import java.io.IOException;
+import org.apache.beam.sdk.extensions.gcp.options.GcsOptions;
+import org.apache.beam.sdk.options.PipelineOptionsFactory;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+@RunWith(JUnit4.class)
+public class TransportTest {
+
+  @Test
+  public void testUserAgentInGcsRequestHeaders() throws IOException {
+    GcsOptions gcsOptions = PipelineOptionsFactory.as(GcsOptions.class);
+    Storage storageClient = Transport.newStorageClient(gcsOptions).build();
+    Storage.Objects.Get getObject = storageClient.objects().get("testbucket", "testobject");
+    // An example of user agent string will be like
+    // "TransportTest (GPN:Beam) Google-API-Java-Client/2.0.0"
+    assertThat(getObject.getRequestHeaders().getUserAgent(), containsString("(GPN:Beam)"));

Review Comment:
   Since we discovered the possible problem in code review, how about also checking that the userAgent string is valid. Or at least that if you split it on space that the GPN:Beam is not the first.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] kennknowles commented on a diff in pull request #26770: Include "(GPN:Beam)" in user-agent of GCS HTTP request header for Java.

Posted by "kennknowles (via GitHub)" <gi...@apache.org>.
kennknowles commented on code in PR #26770:
URL: https://github.com/apache/beam/pull/26770#discussion_r1198356087


##########
sdks/java/extensions/google-cloud-platform-core/src/main/java/org/apache/beam/sdk/extensions/gcp/util/Transport.java:
##########
@@ -101,7 +102,7 @@ public static Storage.Builder newStorageClient(GcsOptions options) {
                     // logging it by default clutters the output during file staging.
                     new RetryHttpRequestInitializer(
                         ImmutableList.of(404), new UploadIdResponseInterceptor())))
-            .setApplicationName(options.getAppName())
+            .setApplicationName(applicationNamePrefix + options.getAppName())

Review Comment:
   This would actually make an invalid user agent if it came first. Is there a spec for where the application name goes in the user-agent field?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] shunping-google commented on pull request #26770: Include "(GPN:Beam)" in user-agent of GCS HTTP request header for Java.

Posted by "shunping-google (via GitHub)" <gi...@apache.org>.
shunping-google commented on PR #26770:
URL: https://github.com/apache/beam/pull/26770#issuecomment-1553919201

   Run Java_Examples_Dataflow PreCommit


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] bvolpato commented on pull request #26770: Include "(GPN:Beam)" in user-agent of GCS HTTP request header for Java.

Posted by "bvolpato (via GitHub)" <gi...@apache.org>.
bvolpato commented on PR #26770:
URL: https://github.com/apache/beam/pull/26770#issuecomment-1553993469

   Run Java PreCommit


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] johnjcasey merged pull request #26770: Include "(GPN:Beam)" in user-agent of GCS HTTP request header for Java.

Posted by "johnjcasey (via GitHub)" <gi...@apache.org>.
johnjcasey merged PR #26770:
URL: https://github.com/apache/beam/pull/26770


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] github-actions[bot] commented on pull request #26770: Include "(GPN:Beam)" in user-agent of GCS HTTP request header for Java.

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #26770:
URL: https://github.com/apache/beam/pull/26770#issuecomment-1553584112

   Assigning reviewers. If you would like to opt out of this review, comment `assign to next reviewer`:
   
   R: @Abacn for label java.
   
   Available commands:
   - `stop reviewer notifications` - opt out of the automated review tooling
   - `remind me after tests pass` - tag the comment author after tests pass
   - `waiting on author` - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)
   
   The PR bot will only process comments in the main thread (not review comments).


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] bvolpato commented on pull request #26770: Include "(GPN:Beam)" in user-agent of GCS HTTP request header for Java.

Posted by "bvolpato (via GitHub)" <gi...@apache.org>.
bvolpato commented on PR #26770:
URL: https://github.com/apache/beam/pull/26770#issuecomment-1553993563

   Run Java_GCP_IO_Direct PreCommit


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] shunping-google commented on a diff in pull request #26770: Include "(GPN:Beam)" in user-agent of GCS HTTP request header for Java.

Posted by "shunping-google (via GitHub)" <gi...@apache.org>.
shunping-google commented on code in PR #26770:
URL: https://github.com/apache/beam/pull/26770#discussion_r1198485188


##########
sdks/java/extensions/google-cloud-platform-core/src/main/java/org/apache/beam/sdk/extensions/gcp/util/Transport.java:
##########
@@ -101,7 +102,7 @@ public static Storage.Builder newStorageClient(GcsOptions options) {
                     // logging it by default clutters the output during file staging.
                     new RetryHttpRequestInitializer(
                         ImmutableList.of(404), new UploadIdResponseInterceptor())))
-            .setApplicationName(options.getAppName())
+            .setApplicationName(applicationNamePrefix + options.getAppName())

Review Comment:
   Fixed.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [beam] shunping-google commented on a diff in pull request #26770: Include "(GPN:Beam)" in user-agent of GCS HTTP request header for Java.

Posted by "shunping-google (via GitHub)" <gi...@apache.org>.
shunping-google commented on code in PR #26770:
URL: https://github.com/apache/beam/pull/26770#discussion_r1199683296


##########
sdks/java/extensions/google-cloud-platform-core/src/test/java/org/apache/beam/sdk/extensions/gcp/util/TransportTest.java:
##########
@@ -0,0 +1,43 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.
+ */
+package org.apache.beam.sdk.extensions.gcp.util;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.containsString;
+
+import com.google.api.services.storage.Storage;
+import java.io.IOException;
+import org.apache.beam.sdk.extensions.gcp.options.GcsOptions;
+import org.apache.beam.sdk.options.PipelineOptionsFactory;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+@RunWith(JUnit4.class)
+public class TransportTest {
+
+  @Test
+  public void testUserAgentInGcsRequestHeaders() throws IOException {
+    GcsOptions gcsOptions = PipelineOptionsFactory.as(GcsOptions.class);
+    Storage storageClient = Transport.newStorageClient(gcsOptions).build();
+    Storage.Objects.Get getObject = storageClient.objects().get("testbucket", "testobject");
+    // An example of user agent string will be like
+    // "TransportTest (GPN:Beam) Google-API-Java-Client/2.0.0"
+    assertThat(getObject.getRequestHeaders().getUserAgent(), containsString("(GPN:Beam)"));

Review Comment:
   Done.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org