Skip to content
This repository was archived by the owner on Sep 26, 2023. It is now read-only.

Commit 12b18ee

Browse files
vam-googlevam-google
authored
feat: REST Gapic (REGAPIC) Support (#1177)
1 parent b856351 commit 12b18ee

16 files changed

Lines changed: 899 additions & 10 deletions

‎build.gradle‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,8 @@ subprojects {
132132
'maven.io_grpc_grpc_protobuf': "io.grpc:grpc-protobuf:${libraries['version.io_grpc']}",
133133
'maven.io_grpc_grpc_netty_shaded': "io.grpc:grpc-netty-shaded:${libraries['version.io_grpc']}",
134134
'maven.io_grpc_grpc_alts': "io.grpc:grpc-alts:${libraries['version.io_grpc']}",
135+
'maven.com_google_protobuf': "com.google.protobuf:protobuf-java:${libraries['version.com_google_protobuf']}",
136+
'maven.com_google_protobuf_java_util': "com.google.protobuf:protobuf-java-util:${libraries['version.com_google_protobuf']}"
135137
])
136138
}
137139

‎gax-httpjson/BUILD.bazel‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ _COMPILE_DEPS = [
2020
"@com_google_auto_value_auto_value_annotations//jar",
2121
"@com_google_http_client_google_http_client_jackson2//jar",
2222
"@javax_annotation_javax_annotation_api//jar",
23+
"@com_google_protobuf//:protobuf_java",
24+
"@com_google_protobuf_java_util//jar",
2325
"//gax:gax",
2426
]
2527

‎gax-httpjson/build.gradle‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ project.version = "0.76.1" // {x-version-update:gax-httpjson:current}
55

66
dependencies {
77
compile project(':gax'),
8+
libraries['maven.com_google_protobuf'],
9+
libraries['maven.com_google_protobuf_java_util'],
810
libraries['maven.com_google_code_gson_gson'],
911
libraries['maven.com_google_guava_guava'],
1012
libraries['maven.com_google_code_findbugs_jsr305'],

‎gax-httpjson/src/main/java/com/google/api/gax/httpjson/ApiMessageHttpResponseParser.java‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,15 @@
3232
import com.google.auto.value.AutoValue;
3333
import com.google.gson.Gson;
3434
import com.google.gson.GsonBuilder;
35+
import com.google.gson.JsonIOException;
36+
import com.google.gson.JsonSyntaxException;
3537
import com.google.gson.TypeAdapter;
3638
import com.google.gson.stream.JsonReader;
3739
import com.google.gson.stream.JsonWriter;
3840
import java.io.InputStream;
3941
import java.io.InputStreamReader;
4042
import java.lang.reflect.Type;
43+
import java.nio.charset.StandardCharsets;
4144

4245
/** Utility class to parse {@link ApiMessage}s from HTTP responses. */
4346
@AutoValue
@@ -91,8 +94,13 @@ public ResponseT parse(InputStream httpResponseBody) {
9194
return null;
9295
} else {
9396
Type responseType = getResponseInstance().getClass();
94-
return getResponseMarshaller()
95-
.fromJson(new InputStreamReader(httpResponseBody), responseType);
97+
try {
98+
return getResponseMarshaller()
99+
.fromJson(
100+
new InputStreamReader(httpResponseBody, StandardCharsets.UTF_8), responseType);
101+
} catch (JsonIOException | JsonSyntaxException e) {
102+
throw new RestSerializationException(e);
103+
}
96104
}
97105
}
98106

‎gax-httpjson/src/main/java/com/google/api/gax/httpjson/FieldsExtractor.java‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
/*
2+
* Copyright 2020 Google LLC
3+
*
4+
* Redistribution and use in source and binary forms, with or without
5+
* modification, are permitted provided that the following conditions are
6+
* met:
7+
*
8+
* * Redistributions of source code must retain the above copyright
9+
* notice, this list of conditions and the following disclaimer.
10+
* * Redistributions in binary form must reproduce the above
11+
* copyright notice, this list of conditions and the following disclaimer
12+
* in the documentation and/or other materials provided with the
13+
* distribution.
14+
* * Neither the name of Google LLC nor the names of its
15+
* contributors may be used to endorse or promote products derived from
16+
* this software without specific prior written permission.
17+
*
18+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19+
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20+
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21+
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22+
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23+
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24+
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25+
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26+
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27+
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28+
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29+
*/
30+
package com.google.api.gax.httpjson;
31+
32+
import com.google.api.core.BetaApi;
33+
34+
/**
35+
* A functional interface to be implemented for each request message to extract specific fields from
36+
* it. For advanced usage only.
37+
*/
38+
@BetaApi
39+
public interface FieldsExtractor<RequestT, ParamsT> {
40+
ParamsT extract(RequestT request);
41+
}

‎gax-httpjson/src/main/java/com/google/api/gax/httpjson/HttpRequestRunnable.java‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,8 @@ HttpRequest createHttpRequest() throws IOException {
103103
}
104104

105105
// Populate URL path and query parameters.
106-
GenericUrl url = new GenericUrl(getEndpoint() + requestFormatter.getPath(getRequest()));
106+
String endpoint = normalizeEndpoint(getEndpoint());
107+
GenericUrl url = new GenericUrl(endpoint + requestFormatter.getPath(getRequest()));
107108
Map<String, List<String>> queryParams = requestFormatter.getQueryParamNames(getRequest());
108109
for (Entry<String, List<String>> queryParam : queryParams.entrySet()) {
109110
if (queryParam.getValue() != null) {
@@ -120,12 +121,26 @@ HttpRequest createHttpRequest() throws IOException {
120121
return httpRequest;
121122
}
122123

124+
// This will be frequently executed, so avoiding using regexps if not necessary.
125+
private String normalizeEndpoint(String endpoint) {
126+
String normalized = endpoint;
127+
// Set protocol as https by default if not set explicitly
128+
if (!normalized.contains("://")) {
129+
normalized = "https://" + normalized;
130+
}
131+
132+
if (normalized.charAt(normalized.length() - 1) != '/') {
133+
normalized += '/';
134+
}
135+
136+
return normalized;
137+
}
138+
123139
@Override
124140
public void run() {
125141
try {
126142
HttpRequest httpRequest = createHttpRequest();
127143
HttpResponse httpResponse = httpRequest.execute();
128-
129144
if (!httpResponse.isSuccessStatusCode()) {
130145
ApiExceptionFactory.createException(
131146
null,

‎gax-httpjson/src/main/java/com/google/api/gax/httpjson/HttpResponseParser.java‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,26 @@
3333
import com.google.api.core.InternalExtensionOnly;
3434
import java.io.InputStream;
3535

36-
/** Interface for classes that parse parts of Http responses into the parameterized message type. */
36+
/** Interface for classes that parse parts of HTTP responses into the parameterized message type. */
3737
@InternalExtensionOnly
3838
public interface HttpResponseParser<MessageFormatT> {
3939

40-
/* Parse the http body content JSON stream into the MessageFormatT.
40+
/**
41+
* Parse the http body content JSON stream into the MessageFormatT.
4142
*
42-
* @param httpContent the body of an http response. */
43+
* @param httpContent the body of an HTTP response
44+
* @throws RestSerializationException if failed to parse the {@code httpContent} to a valid {@code
45+
* MessageFormatT}
46+
*/
4347
MessageFormatT parse(InputStream httpContent);
4448

45-
/* Serialize an object into an HTTP body, which is written out to output.
49+
/**
50+
* Serialize an object into an HTTP body, which is written out to output.
4651
*
47-
* @param response the object to serialize.
48-
* @param output the output stream to append the serialization to. */
52+
* @param response the object to serialize
53+
* @throws RestSerializationException if failed to serialize {@code response} to a valid {@code
54+
* String} representation
55+
*/
4956
@InternalApi
5057
String serialize(MessageFormatT response);
5158
}

‎gax-httpjson/src/main/java/com/google/api/gax/httpjson/ProtoMessageRequestFormatter.java‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
/*
2+
* Copyright 2020 Google LLC
3+
*
4+
* Redistribution and use in source and binary forms, with or without
5+
* modification, are permitted provided that the following conditions are
6+
* met:
7+
*
8+
* * Redistributions of source code must retain the above copyright
9+
* notice, this list of conditions and the following disclaimer.
10+
* * Redistributions in binary form must reproduce the above
11+
* copyright notice, this list of conditions and the following disclaimer
12+
* in the documentation and/or other materials provided with the
13+
* distribution.
14+
* * Neither the name of Google LLC nor the names of its
15+
* contributors may be used to endorse or promote products derived from
16+
* this software without specific prior written permission.
17+
*
18+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19+
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20+
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21+
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22+
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23+
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24+
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25+
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26+
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27+
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28+
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29+
*/
30+
package com.google.api.gax.httpjson;
31+
32+
import com.google.api.core.BetaApi;
33+
import com.google.api.pathtemplate.PathTemplate;
34+
import com.google.protobuf.Message;
35+
import java.util.List;
36+
import java.util.Map;
37+
38+
/** Creates parts of a HTTP request from a protobuf message. */
39+
@BetaApi
40+
public class ProtoMessageRequestFormatter<RequestT extends Message>
41+
implements HttpRequestFormatter<RequestT> {
42+
43+
private final FieldsExtractor<RequestT, String> requestBodyExtractor;
44+
// Using of triple nested generics (which is not pretty) is predetermined by the
45+
// Map<String, List<String>> returned value type of the getQueryParamNames interface method
46+
// implemented by this class.
47+
private final FieldsExtractor<RequestT, Map<String, List<String>>> queryParamsExtractor;
48+
private final PathTemplate pathTemplate;
49+
private final FieldsExtractor<RequestT, Map<String, String>> pathVarsExtractor;
50+
51+
private ProtoMessageRequestFormatter(
52+
FieldsExtractor<RequestT, String> requestBodyExtractor,
53+
FieldsExtractor<RequestT, Map<String, List<String>>> queryParamsExtractor,
54+
PathTemplate pathTemplate,
55+
FieldsExtractor<RequestT, Map<String, String>> pathVarsExtractor) {
56+
this.requestBodyExtractor = requestBodyExtractor;
57+
this.queryParamsExtractor = queryParamsExtractor;
58+
this.pathTemplate = pathTemplate;
59+
this.pathVarsExtractor = pathVarsExtractor;
60+
}
61+
62+
public static <RequestT extends Message>
63+
ProtoMessageRequestFormatter.Builder<RequestT> newBuilder() {
64+
return new Builder<>();
65+
}
66+
67+
/* {@inheritDoc} */
68+
@Override
69+
public Map<String, List<String>> getQueryParamNames(RequestT apiMessage) {
70+
return queryParamsExtractor.extract(apiMessage);
71+
}
72+
73+
/* {@inheritDoc} */
74+
@Override
75+
public String getRequestBody(RequestT apiMessage) {
76+
return requestBodyExtractor.extract(apiMessage);
77+
}
78+
79+
/* {@inheritDoc} */
80+
@Override
81+
public String getPath(RequestT apiMessage) {
82+
return pathTemplate.instantiate(pathVarsExtractor.extract(apiMessage));
83+
}
84+
85+
/* {@inheritDoc} */
86+
@Override
87+
public PathTemplate getPathTemplate() {
88+
return pathTemplate;
89+
}
90+
91+
// This has class has compound setter methods (multiple arguments in setters), that is why not
92+
// using @AutoValue.
93+
public static class Builder<RequestT extends Message> {
94+
private FieldsExtractor<RequestT, String> requestBodyExtractor;
95+
private FieldsExtractor<RequestT, Map<String, List<String>>> queryParamsExtractor;
96+
private String path;
97+
private FieldsExtractor<RequestT, Map<String, String>> pathVarsExtractor;
98+
99+
public Builder<RequestT> setRequestBodyExtractor(
100+
FieldsExtractor<RequestT, String> requestBodyExtractor) {
101+
this.requestBodyExtractor = requestBodyExtractor;
102+
return this;
103+
}
104+
105+
public Builder<RequestT> setQueryParamsExtractor(
106+
FieldsExtractor<RequestT, Map<String, List<String>>> queryParamsExtractor) {
107+
this.queryParamsExtractor = queryParamsExtractor;
108+
return this;
109+
}
110+
111+
public Builder<RequestT> setPath(
112+
String path, FieldsExtractor<RequestT, Map<String, String>> pathVarsExtractor) {
113+
this.path = path;
114+
this.pathVarsExtractor = pathVarsExtractor;
115+
return this;
116+
}
117+
118+
public ProtoMessageRequestFormatter<RequestT> build() {
119+
return new ProtoMessageRequestFormatter<>(
120+
requestBodyExtractor, queryParamsExtractor, PathTemplate.create(path), pathVarsExtractor);
121+
}
122+
}
123+
}

‎gax-httpjson/src/main/java/com/google/api/gax/httpjson/ProtoMessageResponseParser.java‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
/*
2+
* Copyright 2020 Google LLC
3+
*
4+
* Redistribution and use in source and binary forms, with or without
5+
* modification, are permitted provided that the following conditions are
6+
* met:
7+
*
8+
* * Redistributions of source code must retain the above copyright
9+
* notice, this list of conditions and the following disclaimer.
10+
* * Redistributions in binary form must reproduce the above
11+
* copyright notice, this list of conditions and the following disclaimer
12+
* in the documentation and/or other materials provided with the
13+
* distribution.
14+
* * Neither the name of Google LLC nor the names of its
15+
* contributors may be used to endorse or promote products derived from
16+
* this software without specific prior written permission.
17+
*
18+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19+
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20+
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21+
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22+
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23+
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24+
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25+
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26+
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27+
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28+
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29+
*/
30+
package com.google.api.gax.httpjson;
31+
32+
import com.google.api.core.BetaApi;
33+
import com.google.protobuf.Message;
34+
import java.io.InputStream;
35+
import java.nio.charset.StandardCharsets;
36+
37+
/** The implementation of {@link HttpResponseParser} which works with protobuf messages. */
38+
@BetaApi
39+
public class ProtoMessageResponseParser<ResponseT extends Message>
40+
implements HttpResponseParser<ResponseT> {
41+
42+
private final ResponseT defaultInstance;
43+
44+
private ProtoMessageResponseParser(ResponseT defaultInstance) {
45+
this.defaultInstance = defaultInstance;
46+
}
47+
48+
public static <RequestT extends Message>
49+
ProtoMessageResponseParser.Builder<RequestT> newBuilder() {
50+
return new ProtoMessageResponseParser.Builder<>();
51+
}
52+
53+
/* {@inheritDoc} */
54+
@Override
55+
public ResponseT parse(InputStream httpContent) {
56+
return ProtoRestSerializer.<ResponseT>create()
57+
.fromJson(httpContent, StandardCharsets.UTF_8, defaultInstance.newBuilderForType());
58+
}
59+
60+
/* {@inheritDoc} */
61+
@Override
62+
public String serialize(ResponseT response) {
63+
return ProtoRestSerializer.create().toJson(response);
64+
}
65+
66+
// Convert to @AutoValue if this class gets more complicated
67+
public static class Builder<ResponseT extends Message> {
68+
private ResponseT defaultInstance;
69+
70+
public Builder<ResponseT> setDefaultInstance(ResponseT defaultInstance) {
71+
this.defaultInstance = defaultInstance;
72+
return this;
73+
}
74+
75+
public ProtoMessageResponseParser<ResponseT> build() {
76+
return new ProtoMessageResponseParser<>(defaultInstance);
77+
}
78+
}
79+
}

0 commit comments

Comments
 (0)