box / box-java-sdk-gen / #55

Committed 08 Apr 2025 10:56AM UTC coverage: 35.205% (+0.01%) from 35.192%

Build # #55

Build Type

Pull #267

github

Committed by

web-flow

Commit Message

Merge 97cf143a4 into c93ae3b21

Pull Request Pull Request #267: feat: Support sensitive data sanitization in errors (box/box-codegen#695)

Run Details

40 of 80 new or added lines in 8 files covered. (50.0%)

7 existing lines in 6 files now uncovered.

15268 of 43369 relevant lines covered (35.2%)

0.35 hits per line

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

64.29

/src/main/java/com/box/sdkgen/box/errors/BoxAPIError.java

package com.box.sdkgen.box.errors;

import com.box.sdkgen.internal.logging.DataSanitizer;
import com.box.sdkgen.networking.fetchresponse.FetchResponse;
import com.fasterxml.jackson.databind.JsonNode;
import java.time.LocalDateTime;
import java.util.Optional;
import okhttp3.Request;

public class BoxAPIError extends BoxSDKError {

  public final RequestInfo requestInfo;

  public final ResponseInfo responseInfo;

  private final DataSanitizer dataSanitizer;

  public BoxAPIError(String message, RequestInfo requestInfo, ResponseInfo responseInfo) {
    super(message);
    this.requestInfo = requestInfo;
    this.responseInfo = responseInfo;
    this.dataSanitizer = new DataSanitizer();
  }

  public static BoxAPIError fromAPICall(
      Request request,
      FetchResponse fetchResponse,
      String rawResponseBody,
      DataSanitizer dataSanitizer) {
    RequestInfo requestInfo = RequestInfo.fromRequest(request);
    ResponseInfo responseInfo = ResponseInfo.fromResponse(fetchResponse, rawResponseBody);

    String requestId =
        Optional.ofNullable(responseInfo.getBody())
            .map(body -> body.get("request_id"))
            .map(JsonNode::asText)
            .orElse("");

    return new BoxAPIErrorBuilder(
            String.format("Status %d; Request ID: %s", responseInfo.getStatusCode(), requestId),
            requestInfo,
            responseInfo)
        .timestamp(LocalDateTime.now().toString())
        .dataSanitizer(dataSanitizer)
        .build();
  }

  protected BoxAPIError(BoxAPIErrorBuilder builder) {
    super(builder);
    this.requestInfo = builder.requestInfo;
    this.responseInfo = builder.responseInfo;
    this.dataSanitizer = builder.dataSanitizer;
  }

  public RequestInfo getRequestInfo() {
    return requestInfo;
  }

  public ResponseInfo getResponseInfo() {
    return responseInfo;
  }

  public static class BoxAPIErrorBuilder extends BoxSDKErrorBuilder {

    protected final RequestInfo requestInfo;

    protected final ResponseInfo responseInfo;

    protected DataSanitizer dataSanitizer;

    public BoxAPIErrorBuilder(String message, RequestInfo requestInfo, ResponseInfo responseInfo) {
      super(message);
      this.requestInfo = requestInfo;
      this.responseInfo = responseInfo;
      this.dataSanitizer = new DataSanitizer();
    }

    @Override
    public BoxAPIErrorBuilder timestamp(String timestamp) {
      this.timestamp = timestamp;
      return this;
    }

    @Override
    public BoxAPIErrorBuilder error(Exception error) {
      this.error = error;
      return this;
    }

    @Override
    public BoxAPIErrorBuilder name(String name) {
      this.name = name;
      return this;
    }

    public BoxAPIErrorBuilder dataSanitizer(DataSanitizer dataSanitizer) {
      this.dataSanitizer = dataSanitizer;
      return this;
    }

    public BoxAPIError build() {
      return new BoxAPIError(this);
    }
  }

  @Override
  public String toString() {
    return String.join(
        "",
        super.toString(),
        String.format("\nRequest: %s", requestInfo.print(dataSanitizer)),
        String.format("\nResponse: %s", responseInfo.print(dataSanitizer)));
  }
}

1	package com.box.sdkgen.box.errors;
2
3	import com.box.sdkgen.internal.logging.DataSanitizer;
4	import com.box.sdkgen.networking.fetchresponse.FetchResponse;
5	import com.fasterxml.jackson.databind.JsonNode;
6	import java.time.LocalDateTime;
7	import java.util.Optional;
8	import okhttp3.Request;
9
10	public class BoxAPIError extends BoxSDKError {
11
12	public final RequestInfo requestInfo;
13
14	public final ResponseInfo responseInfo;
15
16	private final DataSanitizer dataSanitizer;
17
18	public BoxAPIError(String message, RequestInfo requestInfo, ResponseInfo responseInfo) {
19	super(message);	×
20	this.requestInfo = requestInfo;	×
21	this.responseInfo = responseInfo;	×
NEW 22	this.dataSanitizer = new DataSanitizer();	×
UNCOV 23	}	×
24
25	public static BoxAPIError fromAPICall(
26	Request request,
27	FetchResponse fetchResponse,
28	String rawResponseBody,
29	DataSanitizer dataSanitizer) {
30	RequestInfo requestInfo = RequestInfo.fromRequest(request);	1✔
31	ResponseInfo responseInfo = ResponseInfo.fromResponse(fetchResponse, rawResponseBody);	1✔
32
33	String requestId =	1✔
34	Optional.ofNullable(responseInfo.getBody())	1✔
35	.map(body -> body.get("request_id"))	1✔
36	.map(JsonNode::asText)	1✔
37	.orElse("");	1✔
38
39	return new BoxAPIErrorBuilder(	1✔
40	String.format("Status %d; Request ID: %s", responseInfo.getStatusCode(), requestId),	1✔
41	requestInfo,
42	responseInfo)
43	.timestamp(LocalDateTime.now().toString())	1✔
44	.dataSanitizer(dataSanitizer)	1✔
45	.build();	1✔
46	}
47
48	protected BoxAPIError(BoxAPIErrorBuilder builder) {
49	super(builder);	1✔
50	this.requestInfo = builder.requestInfo;	1✔
51	this.responseInfo = builder.responseInfo;	1✔
52	this.dataSanitizer = builder.dataSanitizer;	1✔
53	}	1✔
54
55	public RequestInfo getRequestInfo() {
56	return requestInfo;	×
57	}
58
59	public ResponseInfo getResponseInfo() {
60	return responseInfo;	×
61	}
62
63	public static class BoxAPIErrorBuilder extends BoxSDKErrorBuilder {
64
65	protected final RequestInfo requestInfo;
66
67	protected final ResponseInfo responseInfo;
68
69	protected DataSanitizer dataSanitizer;
70
71	public BoxAPIErrorBuilder(String message, RequestInfo requestInfo, ResponseInfo responseInfo) {
72	super(message);	1✔
73	this.requestInfo = requestInfo;	1✔
74	this.responseInfo = responseInfo;	1✔
75	this.dataSanitizer = new DataSanitizer();	1✔
76	}	1✔
77
78	@Override
79	public BoxAPIErrorBuilder timestamp(String timestamp) {
80	this.timestamp = timestamp;	1✔
81	return this;	1✔
82	}
83
84	@Override
85	public BoxAPIErrorBuilder error(Exception error) {
86	this.error = error;	×
87	return this;	×
88	}
89
90	@Override
91	public BoxAPIErrorBuilder name(String name) {
92	this.name = name;	×
93	return this;	×
94	}
95
96	public BoxAPIErrorBuilder dataSanitizer(DataSanitizer dataSanitizer) {
97	this.dataSanitizer = dataSanitizer;	1✔
98	return this;	1✔
99	}
100
101	public BoxAPIError build() {
102	return new BoxAPIError(this);	1✔
103	}
104	}
105
106	@Override
107	public String toString() {
NEW 108	return String.join(	×
109	"",
NEW 110	super.toString(),	×
NEW 111	String.format("\nRequest: %s", requestInfo.print(dataSanitizer)),	×
NEW 112	String.format("\nResponse: %s", responseInfo.print(dataSanitizer)));	×
113	}
114	}

box / box-java-sdk-gen / #55

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

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