• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

box / box-java-sdk-gen / #46

03 Apr 2025 02:42PM UTC coverage: 35.189%. First build
#46

Pull #264

github

web-flow
Merge ecd2f972a into 27c23da94
Pull Request #264: SDK-4659: Fix handling responses with invalid json in Java (box/box-codegen#693)

39 of 44 new or added lines in 4 files covered. (88.64%)

15238 of 43303 relevant lines covered (35.19%)

0.35 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

82.35
/src/main/java/com/box/sdkgen/networking/boxnetworkclient/BoxNetworkClient.java
1
package com.box.sdkgen.networking.boxnetworkclient;
2

3
import static com.box.sdkgen.box.BoxConstants.USER_AGENT_HEADER;
4
import static com.box.sdkgen.box.BoxConstants.X_BOX_UA_HEADER;
5
import static com.box.sdkgen.internal.utils.UtilsManager.readByteStream;
6
import static com.box.sdkgen.serialization.json.JsonManager.jsonToSerializedData;
7
import static com.box.sdkgen.serialization.json.JsonManager.sdToJson;
8
import static com.box.sdkgen.serialization.json.JsonManager.sdToUrlParams;
9
import static java.util.Collections.singletonList;
10
import static okhttp3.ConnectionSpec.MODERN_TLS;
11

12
import com.box.sdkgen.box.errors.BoxAPIError;
13
import com.box.sdkgen.box.errors.BoxSDKError;
14
import com.box.sdkgen.networking.fetchoptions.FetchOptions;
15
import com.box.sdkgen.networking.fetchoptions.MultipartItem;
16
import com.box.sdkgen.networking.fetchoptions.ResponseFormat;
17
import com.box.sdkgen.networking.fetchresponse.FetchResponse;
18
import com.box.sdkgen.networking.network.NetworkSession;
19
import com.box.sdkgen.networking.networkclient.NetworkClient;
20
import com.fasterxml.jackson.databind.JsonNode;
21
import java.io.IOException;
22
import java.net.URI;
23
import java.util.Map;
24
import java.util.Objects;
25
import java.util.TreeMap;
26
import java.util.concurrent.TimeUnit;
27
import java.util.stream.Collectors;
28
import okhttp3.Call;
29
import okhttp3.Headers;
30
import okhttp3.HttpUrl;
31
import okhttp3.MediaType;
32
import okhttp3.MultipartBody;
33
import okhttp3.OkHttpClient;
34
import okhttp3.Request;
35
import okhttp3.RequestBody;
36
import okhttp3.Response;
37
import okio.BufferedSink;
38
import okio.Okio;
39
import okio.Source;
40

41
public class BoxNetworkClient implements NetworkClient {
42

43
  private static final int BASE_TIMEOUT = 1;
44
  private static final double RANDOM_FACTOR = 0.5;
45

46
  protected OkHttpClient httpClient;
47

48
  public BoxNetworkClient(OkHttpClient httpClient) {
×
49
    this.httpClient = httpClient;
×
50
  }
×
51

52
  public BoxNetworkClient() {
1✔
53
    OkHttpClient.Builder builder =
1✔
54
        new OkHttpClient.Builder()
55
            .followSslRedirects(true)
1✔
56
            .followRedirects(false)
1✔
57
            .connectionSpecs(singletonList(MODERN_TLS));
1✔
58
    httpClient = builder.build();
1✔
59
  }
1✔
60

61
  public OkHttpClient getHttpClient() {
62
    return httpClient;
×
63
  }
64

65
  public FetchResponse fetch(FetchOptions options) {
66
    NetworkSession networkSession =
67
        options.getNetworkSession() == null ? new NetworkSession() : options.getNetworkSession();
1✔
68

69
    FetchOptions fetchOptions =
1✔
70
        networkSession.getInterceptors().stream()
1✔
71
            .reduce(
1✔
72
                options,
73
                (modifiedOptions, interceptor) -> interceptor.beforeRequest(modifiedOptions),
1✔
74
                (o1, o2) -> o2);
×
75

76
    boolean authenticationNeeded = false;
1✔
77
    Request request;
78
    FetchResponse fetchResponse = null;
1✔
79
    Exception exceptionThrown = null;
1✔
80

81
    int attemptNumber = 0;
1✔
82

83
    while (true) {
84
      request = prepareRequest(fetchOptions, authenticationNeeded, networkSession);
1✔
85

86
      Response response = null;
1✔
87
      String rawResponseBody = null;
1✔
88

89
      try {
90
        response = executeOnClient(request);
1✔
91

92
        Map<String, String> headersMap =
1✔
93
            response.headers().toMultimap().entrySet().stream()
1✔
94
                .collect(
1✔
95
                    Collectors.toMap(
1✔
96
                        Map.Entry::getKey,
97
                        e -> e.getValue().get(0),
1✔
98
                        (existing, replacement) -> existing,
×
99
                        () -> new TreeMap<>(String.CASE_INSENSITIVE_ORDER)));
1✔
100

101
        String responseUrl =
102
            response.networkResponse() != null
1✔
103
                ? response.networkResponse().request().url().toString()
1✔
104
                : response.request().url().toString();
1✔
105

106
        if (Objects.equals(
1✔
107
            fetchOptions.getResponseFormat().getEnumValue(), ResponseFormat.BINARY)) {
1✔
108
          fetchResponse =
1✔
109
              new FetchResponse.FetchResponseBuilder(response.code(), headersMap)
1✔
110
                  .content(response.body().byteStream())
1✔
111
                  .url(responseUrl)
1✔
112
                  .build();
1✔
113
        } else {
114
          rawResponseBody = response.body() != null ? response.body().string() : null;
1✔
115
          fetchResponse =
1✔
116
              new FetchResponse.FetchResponseBuilder(response.code(), headersMap)
1✔
117
                  .data(readJsonFromRawBody(rawResponseBody))
1✔
118
                  .url(responseUrl)
1✔
119
                  .build();
1✔
120
        }
121

122
        fetchResponse =
1✔
123
            networkSession.getInterceptors().stream()
1✔
124
                .reduce(
1✔
125
                    fetchResponse,
126
                    (modifiedResponse, interceptor) -> interceptor.afterRequest(modifiedResponse),
1✔
127
                    (o1, o2) -> o2);
×
128

129
        boolean shouldRetry =
1✔
130
            networkSession
131
                .getRetryStrategy()
1✔
132
                .shouldRetry(fetchOptions, fetchResponse, attemptNumber);
1✔
133

134
        if (shouldRetry) {
1✔
135
          TimeUnit.SECONDS.sleep(
×
136
              (long)
137
                  networkSession
138
                      .getRetryStrategy()
×
139
                      .retryAfter(fetchOptions, fetchResponse, attemptNumber));
×
140
          attemptNumber++;
×
141
          continue;
×
142
        }
143

144
        if (fetchResponse.getStatus() >= 300
1✔
145
            && fetchResponse.getStatus() < 400
1✔
146
            && fetchOptions.followRedirects) {
1✔
147
          if (!fetchResponse.getHeaders().containsKey("Location")) {
1✔
148
            throw new BoxSDKError(
1✔
149
                "Redirect response missing Location header for " + fetchOptions.getUrl());
1✔
150
          }
151
          URI originalUri = URI.create(fetchOptions.getUrl());
1✔
152
          URI redirectUri = URI.create(fetchResponse.getHeaders().get("Location"));
1✔
153
          boolean sameOrigin =
1✔
154
              originalUri.getHost().equals(redirectUri.getHost())
1✔
155
                  && originalUri.getPort() == redirectUri.getPort()
1✔
156
                  && originalUri.getScheme().equals(redirectUri.getScheme());
1✔
157
          return fetch(
1✔
158
              new FetchOptions.FetchOptionsBuilder(
159
                      fetchResponse.getHeaders().get("Location"), "GET")
1✔
160
                  .responseFormat(fetchOptions.getResponseFormat())
1✔
161
                  .auth(sameOrigin ? fetchOptions.getAuth() : null)
1✔
162
                  .networkSession(networkSession)
1✔
163
                  .build());
1✔
164
        }
165

166
      } catch (Exception e) {
1✔
167
        exceptionThrown = e;
1✔
168
        // Retry network exception only once
169
        if (attemptNumber > 1) {
1✔
170
          if (response != null) {
×
171
            response.close();
×
172
          }
173
          throw new BoxSDKError(e.getMessage(), e);
×
174
        }
175
      }
1✔
176

177
      if (fetchResponse != null
1✔
178
          && fetchResponse.getStatus() >= 200
1✔
179
          && fetchResponse.getStatus() < 400) {
1✔
180
        return fetchResponse;
1✔
181
      }
182

NEW
183
      throwOnUnsuccessfulResponse(request, fetchResponse, rawResponseBody, exceptionThrown);
×
184
    }
×
185
  }
186

187
  private static Request prepareRequest(
188
      FetchOptions options, boolean reauthenticate, NetworkSession networkSession) {
189
    Request.Builder requestBuilder = new Request.Builder().url(options.getUrl());
1✔
190
    Headers headers = prepareHeaders(options, reauthenticate, networkSession);
1✔
191
    HttpUrl url = prepareUrl(options);
1✔
192
    RequestBody body = prepareRequestBody(options);
1✔
193

194
    requestBuilder.headers(headers);
1✔
195
    requestBuilder.url(url);
1✔
196
    requestBuilder.method(options.getMethod().toUpperCase(), body);
1✔
197
    return requestBuilder.build();
1✔
198
  }
199

200
  private static Headers prepareHeaders(
201
      FetchOptions options, boolean reauthenticate, NetworkSession networkSession) {
202
    Headers.Builder headersBuilder = new Headers.Builder();
1✔
203

204
    networkSession.getAdditionalHeaders().forEach(headersBuilder::add);
1✔
205

206
    if (options.getHeaders() != null) {
1✔
207
      options.getHeaders().forEach(headersBuilder::add);
1✔
208
    }
209
    if (options.getAuth() != null) {
1✔
210
      if (reauthenticate) {
1✔
211
        options.getAuth().refreshToken(networkSession);
×
212
      }
213
      headersBuilder.add(
1✔
214
          "Authorization", options.getAuth().retrieveAuthorizationHeader(networkSession));
1✔
215
    }
216
    headersBuilder.add("User-Agent", USER_AGENT_HEADER);
1✔
217
    headersBuilder.add("X-Box-UA", X_BOX_UA_HEADER);
1✔
218
    return headersBuilder.build();
1✔
219
  }
220

221
  private static HttpUrl prepareUrl(FetchOptions options) {
222

223
    HttpUrl baseUrl = HttpUrl.parse(options.getUrl());
1✔
224
    if (baseUrl == null) {
1✔
225
      throw new IllegalArgumentException("Invalid URL " + options.getUrl());
×
226
    }
227
    HttpUrl.Builder urlBuilder = baseUrl.newBuilder();
1✔
228
    if (options.getParams() != null) {
1✔
229
      options.getParams().forEach(urlBuilder::addQueryParameter);
1✔
230
    }
231
    return urlBuilder.build();
1✔
232
  }
233

234
  private static RequestBody prepareRequestBody(FetchOptions options) {
235
    if (options.getMethod().equalsIgnoreCase("GET")) {
1✔
236
      return null;
1✔
237
    }
238
    String contentType = options.getContentType();
1✔
239
    MediaType mediaType = MediaType.parse(contentType);
1✔
240
    switch (contentType) {
1✔
241
      case "application/json":
242
      case "application/json-patch+json":
243
        return options.getData() != null
1✔
244
            ? RequestBody.create(sdToJson(options.getData()), mediaType)
1✔
245
            : RequestBody.create("", mediaType);
1✔
246
      case "application/x-www-form-urlencoded":
247
        return options.getData() != null
1✔
248
            ? RequestBody.create(sdToUrlParams(options.getData()), mediaType)
1✔
249
            : RequestBody.create("", mediaType);
×
250
      case "multipart/form-data":
251
        MultipartBody.Builder bodyBuilder = new MultipartBody.Builder().setType(MultipartBody.FORM);
1✔
252
        for (MultipartItem part : options.multipartData) {
1✔
253
          if (part.getData() != null) {
1✔
254
            bodyBuilder.addFormDataPart(part.getPartName(), sdToJson(part.getData()));
1✔
255
          } else {
256
            bodyBuilder.addFormDataPart(
1✔
257
                part.getPartName(),
1✔
258
                part.getFileName() != null ? part.getFileName() : "file",
1✔
259
                createMultipartRequestBody(part));
1✔
260
          }
261
        }
1✔
262
        return bodyBuilder.build();
1✔
263
      case "application/octet-stream":
264
        return RequestBody.create(readByteStream(options.getFileStream()), mediaType);
1✔
265
      default:
266
        throw new IllegalArgumentException("Unsupported content type " + contentType);
×
267
    }
268
  }
269

270
  protected Call createNewCall(Request request) {
271
    return this.httpClient.newCall(request);
1✔
272
  }
273

274
  private Response executeOnClient(Request request) throws IOException {
275
    return createNewCall(request).execute();
1✔
276
  }
277

278
  private static JsonNode readJsonFromRawBody(String rawResponseBody) {
279
    if (rawResponseBody == null) {
1✔
NEW
280
      return null;
×
281
    }
282

283
    try {
284
      return jsonToSerializedData(rawResponseBody);
1✔
285
    } catch (Exception e) {
1✔
286
      return null;
1✔
287
    }
288
  }
289

290
  private static void throwOnUnsuccessfulResponse(
291
      Request request,
292
      FetchResponse fetchResponse,
293
      String rawResponseBody,
294
      Exception exceptionThrown) {
295
    if (fetchResponse == null) {
1✔
296
      throw new BoxSDKError(exceptionThrown.getMessage(), exceptionThrown);
×
297
    }
298
    try {
299
      throw BoxAPIError.fromAPICall(request, fetchResponse, rawResponseBody);
1✔
300
    } finally {
301
      try {
302
        if (fetchResponse.getContent() != null) {
1✔
303
          fetchResponse.getContent().close();
1✔
304
        }
305
      } catch (IOException ignored) {
×
306
      }
1✔
307
    }
308
  }
309

310
  private static int getRetryAfterTimeInSeconds(int attemptNumber, String retryAfterHeader) {
311

312
    if (retryAfterHeader != null) {
×
313
      return Integer.parseInt(retryAfterHeader);
×
314
    }
315

316
    double minWindow = 1 - RANDOM_FACTOR;
×
317
    double maxWindow = 1 + RANDOM_FACTOR;
×
318
    double jitter = (Math.random() * (maxWindow - minWindow)) + minWindow;
×
319
    return (int) (Math.pow(2, attemptNumber) * BASE_TIMEOUT * jitter);
×
320
  }
321

322
  public static RequestBody createMultipartRequestBody(MultipartItem part) {
323
    return new RequestBody() {
1✔
324
      @Override
325
      public MediaType contentType() {
326
        if (part.contentType != null) {
1✔
327
          return MediaType.parse(part.contentType);
1✔
328
        }
329
        return MediaType.parse("application/octet-stream");
1✔
330
      }
331

332
      @Override
333
      public void writeTo(BufferedSink sink) throws IOException {
334
        try (Source source = Okio.source(part.getFileStream())) {
1✔
335
          sink.writeAll(source);
1✔
336
        }
337
      }
1✔
338
    };
339
  }
340
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc