Skip to content

[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors #8053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ngaya-ll wants to merge 6 commits into
base:master
Choose a base branch
from
Open

[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors #8053

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6419a36
Update java-okhttp-gson tests
ngaya-ll Apr 21, 2018
dd091d6
Minor test refactoring
ngaya-ll Apr 21, 2018
a35d4e0
Add test case for async calls and upload/download progress
ngaya-ll Apr 21, 2018
5b64f04
[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors
ngaya-ll Apr 21, 2018
a83fa95
Remove unnecessary ProgressListener interface
ngaya-ll Apr 22, 2018
bba39db
Merge branch 'master' into issue-7876
ngaya-ll Nov 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 34 additions & 7 deletions modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,7 @@ public class ApiClient {
*/
public ApiClient() {
httpClient = new OkHttpClient();
addProgressInterceptor();

{{#useGzipFeature}}
// Enable gzip request compression
Expand DownExpand Up@@ -138,6 +139,7 @@ public class ApiClient {
*/
public ApiClient setHttpClient(OkHttpClient httpClient) {
this.httpClient = httpClient;
addProgressInterceptor();

@ngaya-llngaya-llApr 22, 2018

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that if multiple ApiClients are created with the same underlying OkHttpClient this will create duplicate progress updates for each request. However, from reading the rest of the class (e.g. the setDebugging() method) I concluded that this is not a supported use case.

return this;
}

Expand DownExpand Up@@ -959,12 +961,12 @@ public class ApiClient {
* @param headerParams The header parameters
* @param formParams The form parameters
* @param authNames The authentications to apply
* @param progressRequestListener Progress request listener
* @param callback Callback for upload/download progress
* @return The HTTP call
* @throws ApiException If fail to serialize the request body object
*/
public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, progressRequestListener);
public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, callback);

return httpClient.newCall(request);
}
Expand All@@ -980,11 +982,11 @@ public class ApiClient {
* @param headerParams The header parameters
* @param formParams The form parameters
* @param authNames The authentications to apply
* @param progressRequestListener Progress request listener
* @param callback Callback for upload/download progress
* @return The HTTP request
* @throws ApiException If fail to serialize the request body object
*/
public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
updateParamsForAuth(authNames, queryParams, headerParams);

final String url = buildUrl(path, queryParams, collectionQueryParams);
Expand DownExpand Up@@ -1016,10 +1018,14 @@ public class ApiClient {
reqBody = serialize(body, contentType);
}

// Associate callback with request (if not null) so interceptor can
// access it when creating ProgressResponseBody
reqBuilder.tag(callback);

Request request = null;

if(progressRequestListener != null && reqBody != null) {
ProgressRequestBody progressRequestBody = new ProgressRequestBody(reqBody, progressRequestListener);
if(callback != null && reqBody != null) {
ProgressRequestBody progressRequestBody = new ProgressRequestBody(reqBody, callback);
request = reqBuilder.method(method, progressRequestBody).build();
} else {
request = reqBuilder.method(method, reqBody).build();
Expand DownExpand Up@@ -1161,6 +1167,27 @@ public class ApiClient {
}
}

/**
* Add network interceptor to httpClient to track download progress for
* async requests.
*/
private void addProgressInterceptor() {
httpClient.networkInterceptors().add(new Interceptor() {
@Override
public Response intercept(Interceptor.Chain chain) throws IOException {
final Request request = chain.request();
final Response originalResponse = chain.proceed(request);
if (request.tag() instanceof ApiCallback) {
final ApiCallback callback = (ApiCallback) request.tag();
return originalResponse.newBuilder()
.body(new ProgressResponseBody(originalResponse.body(), callback))
.build();
}
return originalResponse;
}
});
}

/**
* Apply SSL related settings to httpClient according to the current values of
* verifyingSsl and sslCaCert.
Expand Down
12 changes: 4 additions & 8 deletions ...wagger-codegen/src/main/resources/Java/libraries/okhttp-gson/ProgressRequestBody.mustache
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,13 @@ import okio.Sink;

public class ProgressRequestBody extends RequestBody {

public interface ProgressRequestListener {
void onRequestProgress(long bytesWritten, long contentLength, boolean done);
}

private final RequestBody requestBody;

private final ProgressRequestListener progressListener;
private final ApiCallback callback;

public ProgressRequestBody(RequestBody requestBody, ProgressRequestListener progressListener) {
public ProgressRequestBody(RequestBody requestBody, ApiCallback callback) {
this.requestBody = requestBody;
this.progressListener = progressListener;
this.callback = callback;
}

@Override
Expand DownExpand Up@@ -59,7 +55,7 @@ public class ProgressRequestBody extends RequestBody {
}

bytesWritten += byteCount;
progressListener.onRequestProgress(bytesWritten, contentLength, bytesWritten == contentLength);
callback.onUploadProgress(bytesWritten, contentLength, bytesWritten == contentLength);
}
};
}
Expand Down
12 changes: 4 additions & 8 deletions ...agger-codegen/src/main/resources/Java/libraries/okhttp-gson/ProgressResponseBody.mustache
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,13 @@ import okio.Source;

public class ProgressResponseBody extends ResponseBody {

public interface ProgressListener {
void update(long bytesRead, long contentLength, boolean done);
}

private final ResponseBody responseBody;
private final ProgressListener progressListener;
private final ApiCallback callback;
private BufferedSource bufferedSource;

public ProgressResponseBody(ResponseBody responseBody, ProgressListener progressListener) {
public ProgressResponseBody(ResponseBody responseBody, ApiCallback callback) {
this.responseBody = responseBody;
this.progressListener = progressListener;
this.callback = callback;
}

@Override
Expand DownExpand Up@@ -55,7 +51,7 @@ public class ProgressResponseBody extends ResponseBody {
long bytesRead = super.read(sink, byteCount);
// read() returns the number of bytes read, or -1 if this source is exhausted.
totalBytesRead += bytesRead != -1 ? bytesRead : 0;
progressListener.update(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
callback.onDownloadProgress(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
return bytesRead;
}
};
Expand Down
50 changes: 9 additions & 41 deletions modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/api.mustache
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,8 +66,7 @@ public class {{classname}} {
/**
* Build call for {{operationId}}{{#allParams}}
* @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{/allParams}}
* @param progressListener Progress listener
* @param progressRequestListener Progress request listener
* @param callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
{{#isDeprecated}}
Expand All@@ -81,7 +80,7 @@ public class {{classname}} {
{{#isDeprecated}}
@Deprecated
{{/isDeprecated}}
public com.squareup.okhttp.Call {{operationId}}Call({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
public com.squareup.okhttp.Call {{operationId}}Call({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback callback) throws ApiException {
Object {{localVariablePrefix}}localVarPostBody = {{#bodyParam}}{{paramName}}{{/bodyParam}}{{^bodyParam}}null{{/bodyParam}};

// create path and map variables
Expand DownExpand Up@@ -113,27 +112,15 @@ public class {{classname}} {
final String {{localVariablePrefix}}localVarContentType = {{localVariablePrefix}}apiClient.selectHeaderContentType({{localVariablePrefix}}localVarContentTypes);
{{localVariablePrefix}}localVarHeaderParams.put("Content-Type", {{localVariablePrefix}}localVarContentType);

if(progressListener != null) {
apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() {
@Override
public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException {
com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request());
return originalResponse.newBuilder()
.body(new ProgressResponseBody(originalResponse.body(), progressListener))
.build();
}
});
}

String[] {{localVariablePrefix}}localVarAuthNames = new String[] { {{#authMethods}}"{{name}}"{{#hasMore}}, {{/hasMore}}{{/authMethods}} };
return {{localVariablePrefix}}apiClient.buildCall({{localVariablePrefix}}localVarPath, "{{httpMethod}}", {{localVariablePrefix}}localVarQueryParams, {{localVariablePrefix}}localVarCollectionQueryParams, {{localVariablePrefix}}localVarPostBody, {{localVariablePrefix}}localVarHeaderParams, {{localVariablePrefix}}localVarFormParams, {{localVariablePrefix}}localVarAuthNames, progressRequestListener);
return {{localVariablePrefix}}apiClient.buildCall({{localVariablePrefix}}localVarPath, "{{httpMethod}}", {{localVariablePrefix}}localVarQueryParams, {{localVariablePrefix}}localVarCollectionQueryParams, {{localVariablePrefix}}localVarPostBody, {{localVariablePrefix}}localVarHeaderParams, {{localVariablePrefix}}localVarFormParams, {{localVariablePrefix}}localVarAuthNames, callback);
}

{{#isDeprecated}}
@Deprecated
{{/isDeprecated}}
@SuppressWarnings("rawtypes")
private com.squareup.okhttp.Call {{operationId}}ValidateBeforeCall({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
private com.squareup.okhttp.Call {{operationId}}ValidateBeforeCall({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback callback) throws ApiException {
{{^performBeanValidation}}
{{#allParams}}{{#required}}
// verify the required parameter '{{paramName}}' is set
Expand All@@ -142,7 +129,7 @@ public class {{classname}} {
}
{{/required}}{{/allParams}}

com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}callback);
return {{localVariablePrefix}}call;

{{/performBeanValidation}}
Expand All@@ -157,7 +144,7 @@ public class {{classname}} {
parameterValues);

if (violations.size() == 0) {
com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}callback);
return {{localVariablePrefix}}call;

} else {
Expand DownExpand Up@@ -214,7 +201,7 @@ public class {{classname}} {
@Deprecated
{{/isDeprecated}}
public ApiResponse<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{operationId}}WithHttpInfo({{#allParams}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) throws ApiException {
com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null, null);
com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null);
{{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType);{{/returnType}}{{^returnType}}return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call);{{/returnType}}
}
Expand All@@ -239,30 +226,11 @@ public class {{classname}} {
{{/isDeprecated}}
public com.squareup.okhttp.Call {{operationId}}Async({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{localVariablePrefix}}callback) throws ApiException {

ProgressResponseBody.ProgressListener progressListener = null;
ProgressRequestBody.ProgressRequestListener progressRequestListener = null;

if (callback != null) {
progressListener = new ProgressResponseBody.ProgressListener() {
@Override
public void update(long bytesRead, long contentLength, boolean done) {
callback.onDownloadProgress(bytesRead, contentLength, done);
}
};

progressRequestListener = new ProgressRequestBody.ProgressRequestListener() {
@Override
public void onRequestProgress(long bytesWritten, long contentLength, boolean done) {
callback.onUploadProgress(bytesWritten, contentLength, done);
}
};
}

com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}callback);
{{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
{{localVariablePrefix}}apiClient.executeAsync({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType, {{localVariablePrefix}}callback);{{/returnType}}{{^returnType}}{{localVariablePrefix}}apiClient.executeAsync({{localVariablePrefix}}call, {{localVariablePrefix}}callback);{{/returnType}}
return {{localVariablePrefix}}call;
}
{{/operation}}
}
{{/operations}}
{{/operations}}
2 changes: 1 addition & 1 deletion samples/client/petstore-security-test/java/okhttp-gson/.swagger-codegen/VERSION
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
2.3.0-SNAPSHOT
2.4.0-SNAPSHOT
3 changes: 2 additions & 1 deletion samples/client/petstore-security-test/java/okhttp-gson/build.gradle
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,10 +94,11 @@ if(hasProperty('target') && target == 'android') {
}

dependencies {
compile 'io.swagger:swagger-annotations:1.5.15'
compile 'io.swagger:swagger-annotations:1.5.17'
compile 'com.squareup.okhttp:okhttp:2.7.5'
compile 'com.squareup.okhttp:logging-interceptor:2.7.5'
compile 'com.google.code.gson:gson:2.8.1'
compile 'io.gsonfire:gson-fire:1.8.0'
compile 'org.threeten:threetenbp:1.3.5'
testCompile 'junit:junit:4.12'
}
3 changes: 2 additions & 1 deletion samples/client/petstore-security-test/java/okhttp-gson/build.sbt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,12 @@ lazy val root = (project in file(".")).
publishArtifact in (Compile, packageDoc) := false,
resolvers += Resolver.mavenLocal,
libraryDependencies ++= Seq(
"io.swagger" % "swagger-annotations" % "1.5.15",
"io.swagger" % "swagger-annotations" % "1.5.17",
"com.squareup.okhttp" % "okhttp" % "2.7.5",
"com.squareup.okhttp" % "logging-interceptor" % "2.7.5",
"com.google.code.gson" % "gson" % "2.8.1",
"org.threeten" % "threetenbp" % "1.3.5" % "compile",
"io.gsonfire" % "gson-fire" % "1.8.0" % "compile",
"junit" % "junit" % "4.12" % "test",
"com.novocode" % "junit-interface" % "0.10" % "test"
)
Expand Down
2 changes: 1 addition & 1 deletion samples/client/petstore-security-test/java/okhttp-gson/git_push.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ git_remote=`git remote`
if [ "$git_remote" = "" ]; then # git remote not defined

if [ "$GIT_TOKEN" = "" ]; then
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
else
git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors by ngaya-ll · Pull Request #8053 · swagger-api/swagger-codegen · GitHub
Skip to content
[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors #8053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

ngaya-ll
wants to merge
6
commits into

base:master
Choose a base branch

from

 Open


[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors #8053
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
6419a36

Update java-okhttp-gson tests


ngaya-ll Apr 21, 2018
dd091d6

Minor test refactoring


ngaya-ll Apr 21, 2018
a35d4e0

Add test case for async calls and upload/download progress


ngaya-ll Apr 21, 2018
5b64f04

[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors


ngaya-ll Apr 21, 2018
a83fa95

Remove unnecessary ProgressListener interface


ngaya-ll Apr 22, 2018
bba39db

Merge branch 'master' into issue-7876


ngaya-ll Nov 21, 2018

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


41 changes: 34 additions & 7 deletions
modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,7 @@ public class ApiClient {
 */
 public ApiClient() {
 httpClient = new OkHttpClient();
 addProgressInterceptor();

 {{#useGzipFeature}}
 // Enable gzip request compression
Expand DownExpand Up@@ -138,6 +139,7 @@ public class ApiClient {
 */
 public ApiClient setHttpClient(OkHttpClient httpClient) {
 this.httpClient = httpClient;
 addProgressInterceptor();
@ngaya-llngaya-llApr 22, 2018

Copy link


Copy Markdown

Author
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that if multiple ApiClients are created with the same underlying OkHttpClient this will create duplicate progress updates for each request. However, from reading the rest of the class (e.g. the setDebugging() method) I concluded that this is not a supported use case.
 return this;
 }

Expand DownExpand Up@@ -959,12 +961,12 @@ public class ApiClient {
 * @param headerParams The header parameters
 * @param formParams The form parameters
 * @param authNames The authentications to apply
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return The HTTP call
 * @throws ApiException If fail to serialize the request body object
 */
 public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, progressRequestListener);
 public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
 Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, callback);

 return httpClient.newCall(request);
 }
Expand All@@ -980,11 +982,11 @@ public class ApiClient {
 * @param headerParams The header parameters
 * @param formParams The form parameters
 * @param authNames The authentications to apply
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return The HTTP request 
 * @throws ApiException If fail to serialize the request body object
 */
 public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
 updateParamsForAuth(authNames, queryParams, headerParams);

 final String url = buildUrl(path, queryParams, collectionQueryParams);
Expand DownExpand Up@@ -1016,10 +1018,14 @@ public class ApiClient {
 reqBody = serialize(body, contentType);
 }

 // Associate callback with request (if not null) so interceptor can
 // access it when creating ProgressResponseBody
 reqBuilder.tag(callback);

 Request request = null;

 if(progressRequestListener != null && reqBody != null) {
 ProgressRequestBody progressRequestBody = new ProgressRequestBody(reqBody, progressRequestListener);
 if(callback != null && reqBody != null) {
 ProgressRequestBody progressRequestBody = new ProgressRequestBody(reqBody, callback);
 request = reqBuilder.method(method, progressRequestBody).build();
 } else {
 request = reqBuilder.method(method, reqBody).build();
Expand DownExpand Up@@ -1161,6 +1167,27 @@ public class ApiClient {
 }
 }

 /**
 * Add network interceptor to httpClient to track download progress for
 * async requests.
 */
 private void addProgressInterceptor() {
 httpClient.networkInterceptors().add(new Interceptor() {
 @Override
 public Response intercept(Interceptor.Chain chain) throws IOException {
 final Request request = chain.request();
 final Response originalResponse = chain.proceed(request);
 if (request.tag() instanceof ApiCallback) {
 final ApiCallback callback = (ApiCallback) request.tag();
 return originalResponse.newBuilder()
 .body(new ProgressResponseBody(originalResponse.body(), callback))
 .build();
 }
 return originalResponse;
 }
 });
 }

 /**
 * Apply SSL related settings to httpClient according to the current values of
 * verifyingSsl and sslCaCert.
Expand Down

12 changes: 4 additions & 8 deletions
...wagger-codegen/src/main/resources/Java/libraries/okhttp-gson/ProgressRequestBody.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,13 @@ import okio.Sink;

public class ProgressRequestBody extends RequestBody {

 public interface ProgressRequestListener {
 void onRequestProgress(long bytesWritten, long contentLength, boolean done);
 }

 private final RequestBody requestBody;

 private final ProgressRequestListener progressListener;
 private final ApiCallback callback;

 public ProgressRequestBody(RequestBody requestBody, ProgressRequestListener progressListener) {
 public ProgressRequestBody(RequestBody requestBody, ApiCallback callback) {
 this.requestBody = requestBody;
 this.progressListener = progressListener;
 this.callback = callback;
 }

 @Override
Expand DownExpand Up@@ -59,7 +55,7 @@ public class ProgressRequestBody extends RequestBody {
 }

 bytesWritten += byteCount;
progressListener.onRequestProgress(bytesWritten, contentLength, bytesWritten == contentLength);
callback.onUploadProgress(bytesWritten, contentLength, bytesWritten == contentLength);
 }
 };
 }
Expand Down

12 changes: 4 additions & 8 deletions
...agger-codegen/src/main/resources/Java/libraries/okhttp-gson/ProgressResponseBody.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,13 @@ import okio.Source;

public class ProgressResponseBody extends ResponseBody {

 public interface ProgressListener {
 void update(long bytesRead, long contentLength, boolean done);
 }

 private final ResponseBody responseBody;
 private final ProgressListener progressListener;
 private final ApiCallback callback;
 private BufferedSource bufferedSource;

 public ProgressResponseBody(ResponseBody responseBody, ProgressListener progressListener) {
 public ProgressResponseBody(ResponseBody responseBody, ApiCallback callback) {
 this.responseBody = responseBody;
 this.progressListener = progressListener;
 this.callback = callback;
 }

 @Override
Expand DownExpand Up@@ -55,7 +51,7 @@ public class ProgressResponseBody extends ResponseBody {
 long bytesRead = super.read(sink, byteCount);
 // read() returns the number of bytes read, or -1 if this source is exhausted.
 totalBytesRead += bytesRead != -1 ? bytesRead : 0;
progressListener.update(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
callback.onDownloadProgress(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
 return bytesRead;
 }
 };
Expand Down

50 changes: 9 additions & 41 deletions
modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,8 +66,7 @@ public class {{classname}} {
 /**
 * Build call for {{operationId}}{{#allParams}}
 * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{/allParams}}
 * @param progressListener Progress listener
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return Call to execute
 * @throws ApiException If fail to serialize the request body object
 {{#isDeprecated}}
Expand All@@ -81,7 +80,7 @@ public class {{classname}} {
 {{#isDeprecated}}
 @Deprecated
 {{/isDeprecated}}
 public com.squareup.okhttp.Call {{operationId}}Call({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 public com.squareup.okhttp.Call {{operationId}}Call({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback callback) throws ApiException {
 Object {{localVariablePrefix}}localVarPostBody = {{#bodyParam}}{{paramName}}{{/bodyParam}}{{^bodyParam}}null{{/bodyParam}};

 // create path and map variables
Expand DownExpand Up@@ -113,27 +112,15 @@ public class {{classname}} {
 final String {{localVariablePrefix}}localVarContentType = {{localVariablePrefix}}apiClient.selectHeaderContentType({{localVariablePrefix}}localVarContentTypes);
 {{localVariablePrefix}}localVarHeaderParams.put("Content-Type", {{localVariablePrefix}}localVarContentType);

 if(progressListener != null) {
 apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() {
 @Override
 public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException {
 com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request());
 return originalResponse.newBuilder()
 .body(new ProgressResponseBody(originalResponse.body(), progressListener))
 .build();
 }
 });
 }

 String[] {{localVariablePrefix}}localVarAuthNames = new String[] { {{#authMethods}}"{{name}}"{{#hasMore}}, {{/hasMore}}{{/authMethods}} };
 return {{localVariablePrefix}}apiClient.buildCall({{localVariablePrefix}}localVarPath, "{{httpMethod}}", {{localVariablePrefix}}localVarQueryParams, {{localVariablePrefix}}localVarCollectionQueryParams, {{localVariablePrefix}}localVarPostBody, {{localVariablePrefix}}localVarHeaderParams, {{localVariablePrefix}}localVarFormParams, {{localVariablePrefix}}localVarAuthNames, progressRequestListener);
 return {{localVariablePrefix}}apiClient.buildCall({{localVariablePrefix}}localVarPath, "{{httpMethod}}", {{localVariablePrefix}}localVarQueryParams, {{localVariablePrefix}}localVarCollectionQueryParams, {{localVariablePrefix}}localVarPostBody, {{localVariablePrefix}}localVarHeaderParams, {{localVariablePrefix}}localVarFormParams, {{localVariablePrefix}}localVarAuthNames, callback);
 }

 {{#isDeprecated}}
 @Deprecated
 {{/isDeprecated}}
 @SuppressWarnings("rawtypes")
 private com.squareup.okhttp.Call {{operationId}}ValidateBeforeCall({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 private com.squareup.okhttp.Call {{operationId}}ValidateBeforeCall({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback callback) throws ApiException {
 {{^performBeanValidation}}
 {{#allParams}}{{#required}}
 // verify the required parameter '{{paramName}}' is set
Expand All@@ -142,7 +129,7 @@ public class {{classname}} {
 }
 {{/required}}{{/allParams}}

 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}callback);
 return {{localVariablePrefix}}call;

 {{/performBeanValidation}}
Expand All@@ -157,7 +144,7 @@ public class {{classname}} {
 parameterValues);

 if (violations.size() == 0) {
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}callback);
 return {{localVariablePrefix}}call;

 } else {
Expand DownExpand Up@@ -214,7 +201,7 @@ public class {{classname}} {
 @Deprecated
 {{/isDeprecated}}
 public ApiResponse<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{operationId}}WithHttpInfo({{#allParams}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) throws ApiException {
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null, null);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null);
 {{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
 return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType);{{/returnType}}{{^returnType}}return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call);{{/returnType}}
 }
Expand All@@ -239,30 +226,11 @@ public class {{classname}} {
 {{/isDeprecated}}
 public com.squareup.okhttp.Call {{operationId}}Async({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{localVariablePrefix}}callback) throws ApiException {

 ProgressResponseBody.ProgressListener progressListener = null;
 ProgressRequestBody.ProgressRequestListener progressRequestListener = null;

 if (callback != null) {
 progressListener = new ProgressResponseBody.ProgressListener() {
 @Override
 public void update(long bytesRead, long contentLength, boolean done) {
 callback.onDownloadProgress(bytesRead, contentLength, done);
 }
 };

 progressRequestListener = new ProgressRequestBody.ProgressRequestListener() {
 @Override
 public void onRequestProgress(long bytesWritten, long contentLength, boolean done) {
 callback.onUploadProgress(bytesWritten, contentLength, done);
 }
 };
 }

 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}callback);
 {{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
 {{localVariablePrefix}}apiClient.executeAsync({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType, {{localVariablePrefix}}callback);{{/returnType}}{{^returnType}}{{localVariablePrefix}}apiClient.executeAsync({{localVariablePrefix}}call, {{localVariablePrefix}}callback);{{/returnType}}
 return {{localVariablePrefix}}call;
 }
 {{/operation}}
}
{{/operations}}
{{/operations}}

2 changes: 1 addition & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/.swagger-codegen/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
2.3.0-SNAPSHOT
2.4.0-SNAPSHOT

3 changes: 2 additions & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/build.gradle

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,10 +94,11 @@ if(hasProperty('target') && target == 'android') {
}

dependencies {
 compile 'io.swagger:swagger-annotations:1.5.15'
 compile 'io.swagger:swagger-annotations:1.5.17'
 compile 'com.squareup.okhttp:okhttp:2.7.5'
 compile 'com.squareup.okhttp:logging-interceptor:2.7.5'
 compile 'com.google.code.gson:gson:2.8.1'
 compile 'io.gsonfire:gson-fire:1.8.0'
 compile 'org.threeten:threetenbp:1.3.5'
 testCompile 'junit:junit:4.12'
}

3 changes: 2 additions & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/build.sbt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,12 @@ lazy val root = (project in file(".")).
 publishArtifact in (Compile, packageDoc) := false,
 resolvers += Resolver.mavenLocal,
 libraryDependencies ++= Seq(
 "io.swagger" % "swagger-annotations" % "1.5.15",
 "io.swagger" % "swagger-annotations" % "1.5.17",
 "com.squareup.okhttp" % "okhttp" % "2.7.5",
 "com.squareup.okhttp" % "logging-interceptor" % "2.7.5",
 "com.google.code.gson" % "gson" % "2.8.1",
 "org.threeten" % "threetenbp" % "1.3.5" % "compile",
 "io.gsonfire" % "gson-fire" % "1.8.0" % "compile",
 "junit" % "junit" % "4.12" % "test",
 "com.novocode" % "junit-interface" % "0.10" % "test"
 )
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/git_push.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ git_remote=`git remote`
if [ "$git_remote" = "" ]; then # git remote not defined

 if [ "$GIT_TOKEN" = "" ]; then
 echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
 echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
 git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
 else
 git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors by ngaya-ll · Pull Request #8053 · swagger-api/swagger-codegen · GitHub
Skip to content
[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors #8053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

ngaya-ll
wants to merge
6
commits into

base:master
Choose a base branch

from

 Open


[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors #8053
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
6419a36

Update java-okhttp-gson tests


ngaya-ll Apr 21, 2018
dd091d6

Minor test refactoring


ngaya-ll Apr 21, 2018
a35d4e0

Add test case for async calls and upload/download progress


ngaya-ll Apr 21, 2018
5b64f04

[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors


ngaya-ll Apr 21, 2018
a83fa95

Remove unnecessary ProgressListener interface


ngaya-ll Apr 22, 2018
bba39db

Merge branch 'master' into issue-7876


ngaya-ll Nov 21, 2018

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


41 changes: 34 additions & 7 deletions
modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,7 @@ public class ApiClient {
 */
 public ApiClient() {
 httpClient = new OkHttpClient();
 addProgressInterceptor();

 {{#useGzipFeature}}
 // Enable gzip request compression
Expand DownExpand Up@@ -138,6 +139,7 @@ public class ApiClient {
 */
 public ApiClient setHttpClient(OkHttpClient httpClient) {
 this.httpClient = httpClient;
 addProgressInterceptor();
@ngaya-llngaya-llApr 22, 2018

Copy link


Copy Markdown

Author
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that if multiple ApiClients are created with the same underlying OkHttpClient this will create duplicate progress updates for each request. However, from reading the rest of the class (e.g. the setDebugging() method) I concluded that this is not a supported use case.
 return this;
 }

Expand DownExpand Up@@ -959,12 +961,12 @@ public class ApiClient {
 * @param headerParams The header parameters
 * @param formParams The form parameters
 * @param authNames The authentications to apply
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return The HTTP call
 * @throws ApiException If fail to serialize the request body object
 */
 public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, progressRequestListener);
 public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
 Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, callback);

 return httpClient.newCall(request);
 }
Expand All@@ -980,11 +982,11 @@ public class ApiClient {
 * @param headerParams The header parameters
 * @param formParams The form parameters
 * @param authNames The authentications to apply
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return The HTTP request 
 * @throws ApiException If fail to serialize the request body object
 */
 public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
 updateParamsForAuth(authNames, queryParams, headerParams);

 final String url = buildUrl(path, queryParams, collectionQueryParams);
Expand DownExpand Up@@ -1016,10 +1018,14 @@ public class ApiClient {
 reqBody = serialize(body, contentType);
 }

 // Associate callback with request (if not null) so interceptor can
 // access it when creating ProgressResponseBody
 reqBuilder.tag(callback);

 Request request = null;

 if(progressRequestListener != null && reqBody != null) {
 ProgressRequestBody progressRequestBody = new ProgressRequestBody(reqBody, progressRequestListener);
 if(callback != null && reqBody != null) {
 ProgressRequestBody progressRequestBody = new ProgressRequestBody(reqBody, callback);
 request = reqBuilder.method(method, progressRequestBody).build();
 } else {
 request = reqBuilder.method(method, reqBody).build();
Expand DownExpand Up@@ -1161,6 +1167,27 @@ public class ApiClient {
 }
 }

 /**
 * Add network interceptor to httpClient to track download progress for
 * async requests.
 */
 private void addProgressInterceptor() {
 httpClient.networkInterceptors().add(new Interceptor() {
 @Override
 public Response intercept(Interceptor.Chain chain) throws IOException {
 final Request request = chain.request();
 final Response originalResponse = chain.proceed(request);
 if (request.tag() instanceof ApiCallback) {
 final ApiCallback callback = (ApiCallback) request.tag();
 return originalResponse.newBuilder()
 .body(new ProgressResponseBody(originalResponse.body(), callback))
 .build();
 }
 return originalResponse;
 }
 });
 }

 /**
 * Apply SSL related settings to httpClient according to the current values of
 * verifyingSsl and sslCaCert.
Expand Down

12 changes: 4 additions & 8 deletions
...wagger-codegen/src/main/resources/Java/libraries/okhttp-gson/ProgressRequestBody.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,13 @@ import okio.Sink;

public class ProgressRequestBody extends RequestBody {

 public interface ProgressRequestListener {
 void onRequestProgress(long bytesWritten, long contentLength, boolean done);
 }

 private final RequestBody requestBody;

 private final ProgressRequestListener progressListener;
 private final ApiCallback callback;

 public ProgressRequestBody(RequestBody requestBody, ProgressRequestListener progressListener) {
 public ProgressRequestBody(RequestBody requestBody, ApiCallback callback) {
 this.requestBody = requestBody;
 this.progressListener = progressListener;
 this.callback = callback;
 }

 @Override
Expand DownExpand Up@@ -59,7 +55,7 @@ public class ProgressRequestBody extends RequestBody {
 }

 bytesWritten += byteCount;
progressListener.onRequestProgress(bytesWritten, contentLength, bytesWritten == contentLength);
callback.onUploadProgress(bytesWritten, contentLength, bytesWritten == contentLength);
 }
 };
 }
Expand Down

12 changes: 4 additions & 8 deletions
...agger-codegen/src/main/resources/Java/libraries/okhttp-gson/ProgressResponseBody.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,13 @@ import okio.Source;

public class ProgressResponseBody extends ResponseBody {

 public interface ProgressListener {
 void update(long bytesRead, long contentLength, boolean done);
 }

 private final ResponseBody responseBody;
 private final ProgressListener progressListener;
 private final ApiCallback callback;
 private BufferedSource bufferedSource;

 public ProgressResponseBody(ResponseBody responseBody, ProgressListener progressListener) {
 public ProgressResponseBody(ResponseBody responseBody, ApiCallback callback) {
 this.responseBody = responseBody;
 this.progressListener = progressListener;
 this.callback = callback;
 }

 @Override
Expand DownExpand Up@@ -55,7 +51,7 @@ public class ProgressResponseBody extends ResponseBody {
 long bytesRead = super.read(sink, byteCount);
 // read() returns the number of bytes read, or -1 if this source is exhausted.
 totalBytesRead += bytesRead != -1 ? bytesRead : 0;
progressListener.update(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
callback.onDownloadProgress(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
 return bytesRead;
 }
 };
Expand Down

50 changes: 9 additions & 41 deletions
modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,8 +66,7 @@ public class {{classname}} {
 /**
 * Build call for {{operationId}}{{#allParams}}
 * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{/allParams}}
 * @param progressListener Progress listener
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return Call to execute
 * @throws ApiException If fail to serialize the request body object
 {{#isDeprecated}}
Expand All@@ -81,7 +80,7 @@ public class {{classname}} {
 {{#isDeprecated}}
 @Deprecated
 {{/isDeprecated}}
 public com.squareup.okhttp.Call {{operationId}}Call({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 public com.squareup.okhttp.Call {{operationId}}Call({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback callback) throws ApiException {
 Object {{localVariablePrefix}}localVarPostBody = {{#bodyParam}}{{paramName}}{{/bodyParam}}{{^bodyParam}}null{{/bodyParam}};

 // create path and map variables
Expand DownExpand Up@@ -113,27 +112,15 @@ public class {{classname}} {
 final String {{localVariablePrefix}}localVarContentType = {{localVariablePrefix}}apiClient.selectHeaderContentType({{localVariablePrefix}}localVarContentTypes);
 {{localVariablePrefix}}localVarHeaderParams.put("Content-Type", {{localVariablePrefix}}localVarContentType);

 if(progressListener != null) {
 apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() {
 @Override
 public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException {
 com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request());
 return originalResponse.newBuilder()
 .body(new ProgressResponseBody(originalResponse.body(), progressListener))
 .build();
 }
 });
 }

 String[] {{localVariablePrefix}}localVarAuthNames = new String[] { {{#authMethods}}"{{name}}"{{#hasMore}}, {{/hasMore}}{{/authMethods}} };
 return {{localVariablePrefix}}apiClient.buildCall({{localVariablePrefix}}localVarPath, "{{httpMethod}}", {{localVariablePrefix}}localVarQueryParams, {{localVariablePrefix}}localVarCollectionQueryParams, {{localVariablePrefix}}localVarPostBody, {{localVariablePrefix}}localVarHeaderParams, {{localVariablePrefix}}localVarFormParams, {{localVariablePrefix}}localVarAuthNames, progressRequestListener);
 return {{localVariablePrefix}}apiClient.buildCall({{localVariablePrefix}}localVarPath, "{{httpMethod}}", {{localVariablePrefix}}localVarQueryParams, {{localVariablePrefix}}localVarCollectionQueryParams, {{localVariablePrefix}}localVarPostBody, {{localVariablePrefix}}localVarHeaderParams, {{localVariablePrefix}}localVarFormParams, {{localVariablePrefix}}localVarAuthNames, callback);
 }

 {{#isDeprecated}}
 @Deprecated
 {{/isDeprecated}}
 @SuppressWarnings("rawtypes")
 private com.squareup.okhttp.Call {{operationId}}ValidateBeforeCall({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 private com.squareup.okhttp.Call {{operationId}}ValidateBeforeCall({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback callback) throws ApiException {
 {{^performBeanValidation}}
 {{#allParams}}{{#required}}
 // verify the required parameter '{{paramName}}' is set
Expand All@@ -142,7 +129,7 @@ public class {{classname}} {
 }
 {{/required}}{{/allParams}}

 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}callback);
 return {{localVariablePrefix}}call;

 {{/performBeanValidation}}
Expand All@@ -157,7 +144,7 @@ public class {{classname}} {
 parameterValues);

 if (violations.size() == 0) {
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}callback);
 return {{localVariablePrefix}}call;

 } else {
Expand DownExpand Up@@ -214,7 +201,7 @@ public class {{classname}} {
 @Deprecated
 {{/isDeprecated}}
 public ApiResponse<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{operationId}}WithHttpInfo({{#allParams}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) throws ApiException {
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null, null);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null);
 {{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
 return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType);{{/returnType}}{{^returnType}}return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call);{{/returnType}}
 }
Expand All@@ -239,30 +226,11 @@ public class {{classname}} {
 {{/isDeprecated}}
 public com.squareup.okhttp.Call {{operationId}}Async({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{localVariablePrefix}}callback) throws ApiException {

 ProgressResponseBody.ProgressListener progressListener = null;
 ProgressRequestBody.ProgressRequestListener progressRequestListener = null;

 if (callback != null) {
 progressListener = new ProgressResponseBody.ProgressListener() {
 @Override
 public void update(long bytesRead, long contentLength, boolean done) {
 callback.onDownloadProgress(bytesRead, contentLength, done);
 }
 };

 progressRequestListener = new ProgressRequestBody.ProgressRequestListener() {
 @Override
 public void onRequestProgress(long bytesWritten, long contentLength, boolean done) {
 callback.onUploadProgress(bytesWritten, contentLength, done);
 }
 };
 }

 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}callback);
 {{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
 {{localVariablePrefix}}apiClient.executeAsync({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType, {{localVariablePrefix}}callback);{{/returnType}}{{^returnType}}{{localVariablePrefix}}apiClient.executeAsync({{localVariablePrefix}}call, {{localVariablePrefix}}callback);{{/returnType}}
 return {{localVariablePrefix}}call;
 }
 {{/operation}}
}
{{/operations}}
{{/operations}}

2 changes: 1 addition & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/.swagger-codegen/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
2.3.0-SNAPSHOT
2.4.0-SNAPSHOT

3 changes: 2 additions & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/build.gradle

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,10 +94,11 @@ if(hasProperty('target') && target == 'android') {
}

dependencies {
 compile 'io.swagger:swagger-annotations:1.5.15'
 compile 'io.swagger:swagger-annotations:1.5.17'
 compile 'com.squareup.okhttp:okhttp:2.7.5'
 compile 'com.squareup.okhttp:logging-interceptor:2.7.5'
 compile 'com.google.code.gson:gson:2.8.1'
 compile 'io.gsonfire:gson-fire:1.8.0'
 compile 'org.threeten:threetenbp:1.3.5'
 testCompile 'junit:junit:4.12'
}

3 changes: 2 additions & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/build.sbt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,12 @@ lazy val root = (project in file(".")).
 publishArtifact in (Compile, packageDoc) := false,
 resolvers += Resolver.mavenLocal,
 libraryDependencies ++= Seq(
 "io.swagger" % "swagger-annotations" % "1.5.15",
 "io.swagger" % "swagger-annotations" % "1.5.17",
 "com.squareup.okhttp" % "okhttp" % "2.7.5",
 "com.squareup.okhttp" % "logging-interceptor" % "2.7.5",
 "com.google.code.gson" % "gson" % "2.8.1",
 "org.threeten" % "threetenbp" % "1.3.5" % "compile",
 "io.gsonfire" % "gson-fire" % "1.8.0" % "compile",
 "junit" % "junit" % "4.12" % "test",
 "com.novocode" % "junit-interface" % "0.10" % "test"
 )
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/git_push.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ git_remote=`git remote`
if [ "$git_remote" = "" ]; then # git remote not defined

 if [ "$GIT_TOKEN" = "" ]; then
 echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
 echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
 git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
 else
 git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors by ngaya-ll · Pull Request #8053 · swagger-api/swagger-codegen · GitHub
Skip to content
[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors #8053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

ngaya-ll
wants to merge
6
commits into

base:master
Choose a base branch

from

 Open


[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors #8053
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
6419a36

Update java-okhttp-gson tests


ngaya-ll Apr 21, 2018
dd091d6

Minor test refactoring


ngaya-ll Apr 21, 2018
a35d4e0

Add test case for async calls and upload/download progress


ngaya-ll Apr 21, 2018
5b64f04

[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors


ngaya-ll Apr 21, 2018
a83fa95

Remove unnecessary ProgressListener interface


ngaya-ll Apr 22, 2018
bba39db

Merge branch 'master' into issue-7876


ngaya-ll Nov 21, 2018

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


41 changes: 34 additions & 7 deletions
modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,7 @@ public class ApiClient {
 */
 public ApiClient() {
 httpClient = new OkHttpClient();
 addProgressInterceptor();

 {{#useGzipFeature}}
 // Enable gzip request compression
Expand DownExpand Up@@ -138,6 +139,7 @@ public class ApiClient {
 */
 public ApiClient setHttpClient(OkHttpClient httpClient) {
 this.httpClient = httpClient;
 addProgressInterceptor();
@ngaya-llngaya-llApr 22, 2018

Copy link


Copy Markdown

Author
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that if multiple ApiClients are created with the same underlying OkHttpClient this will create duplicate progress updates for each request. However, from reading the rest of the class (e.g. the setDebugging() method) I concluded that this is not a supported use case.
 return this;
 }

Expand DownExpand Up@@ -959,12 +961,12 @@ public class ApiClient {
 * @param headerParams The header parameters
 * @param formParams The form parameters
 * @param authNames The authentications to apply
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return The HTTP call
 * @throws ApiException If fail to serialize the request body object
 */
 public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, progressRequestListener);
 public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
 Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, callback);

 return httpClient.newCall(request);
 }
Expand All@@ -980,11 +982,11 @@ public class ApiClient {
 * @param headerParams The header parameters
 * @param formParams The form parameters
 * @param authNames The authentications to apply
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return The HTTP request 
 * @throws ApiException If fail to serialize the request body object
 */
 public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
 updateParamsForAuth(authNames, queryParams, headerParams);

 final String url = buildUrl(path, queryParams, collectionQueryParams);
Expand DownExpand Up@@ -1016,10 +1018,14 @@ public class ApiClient {
 reqBody = serialize(body, contentType);
 }

 // Associate callback with request (if not null) so interceptor can
 // access it when creating ProgressResponseBody
 reqBuilder.tag(callback);

 Request request = null;

 if(progressRequestListener != null && reqBody != null) {
 ProgressRequestBody progressRequestBody = new ProgressRequestBody(reqBody, progressRequestListener);
 if(callback != null && reqBody != null) {
 ProgressRequestBody progressRequestBody = new ProgressRequestBody(reqBody, callback);
 request = reqBuilder.method(method, progressRequestBody).build();
 } else {
 request = reqBuilder.method(method, reqBody).build();
Expand DownExpand Up@@ -1161,6 +1167,27 @@ public class ApiClient {
 }
 }

 /**
 * Add network interceptor to httpClient to track download progress for
 * async requests.
 */
 private void addProgressInterceptor() {
 httpClient.networkInterceptors().add(new Interceptor() {
 @Override
 public Response intercept(Interceptor.Chain chain) throws IOException {
 final Request request = chain.request();
 final Response originalResponse = chain.proceed(request);
 if (request.tag() instanceof ApiCallback) {
 final ApiCallback callback = (ApiCallback) request.tag();
 return originalResponse.newBuilder()
 .body(new ProgressResponseBody(originalResponse.body(), callback))
 .build();
 }
 return originalResponse;
 }
 });
 }

 /**
 * Apply SSL related settings to httpClient according to the current values of
 * verifyingSsl and sslCaCert.
Expand Down

12 changes: 4 additions & 8 deletions
...wagger-codegen/src/main/resources/Java/libraries/okhttp-gson/ProgressRequestBody.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,13 @@ import okio.Sink;

public class ProgressRequestBody extends RequestBody {

 public interface ProgressRequestListener {
 void onRequestProgress(long bytesWritten, long contentLength, boolean done);
 }

 private final RequestBody requestBody;

 private final ProgressRequestListener progressListener;
 private final ApiCallback callback;

 public ProgressRequestBody(RequestBody requestBody, ProgressRequestListener progressListener) {
 public ProgressRequestBody(RequestBody requestBody, ApiCallback callback) {
 this.requestBody = requestBody;
 this.progressListener = progressListener;
 this.callback = callback;
 }

 @Override
Expand DownExpand Up@@ -59,7 +55,7 @@ public class ProgressRequestBody extends RequestBody {
 }

 bytesWritten += byteCount;
progressListener.onRequestProgress(bytesWritten, contentLength, bytesWritten == contentLength);
callback.onUploadProgress(bytesWritten, contentLength, bytesWritten == contentLength);
 }
 };
 }
Expand Down

12 changes: 4 additions & 8 deletions
...agger-codegen/src/main/resources/Java/libraries/okhttp-gson/ProgressResponseBody.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,13 @@ import okio.Source;

public class ProgressResponseBody extends ResponseBody {

 public interface ProgressListener {
 void update(long bytesRead, long contentLength, boolean done);
 }

 private final ResponseBody responseBody;
 private final ProgressListener progressListener;
 private final ApiCallback callback;
 private BufferedSource bufferedSource;

 public ProgressResponseBody(ResponseBody responseBody, ProgressListener progressListener) {
 public ProgressResponseBody(ResponseBody responseBody, ApiCallback callback) {
 this.responseBody = responseBody;
 this.progressListener = progressListener;
 this.callback = callback;
 }

 @Override
Expand DownExpand Up@@ -55,7 +51,7 @@ public class ProgressResponseBody extends ResponseBody {
 long bytesRead = super.read(sink, byteCount);
 // read() returns the number of bytes read, or -1 if this source is exhausted.
 totalBytesRead += bytesRead != -1 ? bytesRead : 0;
progressListener.update(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
callback.onDownloadProgress(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
 return bytesRead;
 }
 };
Expand Down

50 changes: 9 additions & 41 deletions
modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,8 +66,7 @@ public class {{classname}} {
 /**
 * Build call for {{operationId}}{{#allParams}}
 * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{/allParams}}
 * @param progressListener Progress listener
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return Call to execute
 * @throws ApiException If fail to serialize the request body object
 {{#isDeprecated}}
Expand All@@ -81,7 +80,7 @@ public class {{classname}} {
 {{#isDeprecated}}
 @Deprecated
 {{/isDeprecated}}
 public com.squareup.okhttp.Call {{operationId}}Call({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 public com.squareup.okhttp.Call {{operationId}}Call({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback callback) throws ApiException {
 Object {{localVariablePrefix}}localVarPostBody = {{#bodyParam}}{{paramName}}{{/bodyParam}}{{^bodyParam}}null{{/bodyParam}};

 // create path and map variables
Expand DownExpand Up@@ -113,27 +112,15 @@ public class {{classname}} {
 final String {{localVariablePrefix}}localVarContentType = {{localVariablePrefix}}apiClient.selectHeaderContentType({{localVariablePrefix}}localVarContentTypes);
 {{localVariablePrefix}}localVarHeaderParams.put("Content-Type", {{localVariablePrefix}}localVarContentType);

 if(progressListener != null) {
 apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() {
 @Override
 public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException {
 com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request());
 return originalResponse.newBuilder()
 .body(new ProgressResponseBody(originalResponse.body(), progressListener))
 .build();
 }
 });
 }

 String[] {{localVariablePrefix}}localVarAuthNames = new String[] { {{#authMethods}}"{{name}}"{{#hasMore}}, {{/hasMore}}{{/authMethods}} };
 return {{localVariablePrefix}}apiClient.buildCall({{localVariablePrefix}}localVarPath, "{{httpMethod}}", {{localVariablePrefix}}localVarQueryParams, {{localVariablePrefix}}localVarCollectionQueryParams, {{localVariablePrefix}}localVarPostBody, {{localVariablePrefix}}localVarHeaderParams, {{localVariablePrefix}}localVarFormParams, {{localVariablePrefix}}localVarAuthNames, progressRequestListener);
 return {{localVariablePrefix}}apiClient.buildCall({{localVariablePrefix}}localVarPath, "{{httpMethod}}", {{localVariablePrefix}}localVarQueryParams, {{localVariablePrefix}}localVarCollectionQueryParams, {{localVariablePrefix}}localVarPostBody, {{localVariablePrefix}}localVarHeaderParams, {{localVariablePrefix}}localVarFormParams, {{localVariablePrefix}}localVarAuthNames, callback);
 }

 {{#isDeprecated}}
 @Deprecated
 {{/isDeprecated}}
 @SuppressWarnings("rawtypes")
 private com.squareup.okhttp.Call {{operationId}}ValidateBeforeCall({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 private com.squareup.okhttp.Call {{operationId}}ValidateBeforeCall({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback callback) throws ApiException {
 {{^performBeanValidation}}
 {{#allParams}}{{#required}}
 // verify the required parameter '{{paramName}}' is set
Expand All@@ -142,7 +129,7 @@ public class {{classname}} {
 }
 {{/required}}{{/allParams}}

 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}callback);
 return {{localVariablePrefix}}call;

 {{/performBeanValidation}}
Expand All@@ -157,7 +144,7 @@ public class {{classname}} {
 parameterValues);

 if (violations.size() == 0) {
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}callback);
 return {{localVariablePrefix}}call;

 } else {
Expand DownExpand Up@@ -214,7 +201,7 @@ public class {{classname}} {
 @Deprecated
 {{/isDeprecated}}
 public ApiResponse<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{operationId}}WithHttpInfo({{#allParams}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) throws ApiException {
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null, null);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null);
 {{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
 return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType);{{/returnType}}{{^returnType}}return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call);{{/returnType}}
 }
Expand All@@ -239,30 +226,11 @@ public class {{classname}} {
 {{/isDeprecated}}
 public com.squareup.okhttp.Call {{operationId}}Async({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{localVariablePrefix}}callback) throws ApiException {

 ProgressResponseBody.ProgressListener progressListener = null;
 ProgressRequestBody.ProgressRequestListener progressRequestListener = null;

 if (callback != null) {
 progressListener = new ProgressResponseBody.ProgressListener() {
 @Override
 public void update(long bytesRead, long contentLength, boolean done) {
 callback.onDownloadProgress(bytesRead, contentLength, done);
 }
 };

 progressRequestListener = new ProgressRequestBody.ProgressRequestListener() {
 @Override
 public void onRequestProgress(long bytesWritten, long contentLength, boolean done) {
 callback.onUploadProgress(bytesWritten, contentLength, done);
 }
 };
 }

 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}callback);
 {{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
 {{localVariablePrefix}}apiClient.executeAsync({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType, {{localVariablePrefix}}callback);{{/returnType}}{{^returnType}}{{localVariablePrefix}}apiClient.executeAsync({{localVariablePrefix}}call, {{localVariablePrefix}}callback);{{/returnType}}
 return {{localVariablePrefix}}call;
 }
 {{/operation}}
}
{{/operations}}
{{/operations}}

2 changes: 1 addition & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/.swagger-codegen/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
2.3.0-SNAPSHOT
2.4.0-SNAPSHOT

3 changes: 2 additions & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/build.gradle

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,10 +94,11 @@ if(hasProperty('target') && target == 'android') {
}

dependencies {
 compile 'io.swagger:swagger-annotations:1.5.15'
 compile 'io.swagger:swagger-annotations:1.5.17'
 compile 'com.squareup.okhttp:okhttp:2.7.5'
 compile 'com.squareup.okhttp:logging-interceptor:2.7.5'
 compile 'com.google.code.gson:gson:2.8.1'
 compile 'io.gsonfire:gson-fire:1.8.0'
 compile 'org.threeten:threetenbp:1.3.5'
 testCompile 'junit:junit:4.12'
}

3 changes: 2 additions & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/build.sbt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,12 @@ lazy val root = (project in file(".")).
 publishArtifact in (Compile, packageDoc) := false,
 resolvers += Resolver.mavenLocal,
 libraryDependencies ++= Seq(
 "io.swagger" % "swagger-annotations" % "1.5.15",
 "io.swagger" % "swagger-annotations" % "1.5.17",
 "com.squareup.okhttp" % "okhttp" % "2.7.5",
 "com.squareup.okhttp" % "logging-interceptor" % "2.7.5",
 "com.google.code.gson" % "gson" % "2.8.1",
 "org.threeten" % "threetenbp" % "1.3.5" % "compile",
 "io.gsonfire" % "gson-fire" % "1.8.0" % "compile",
 "junit" % "junit" % "4.12" % "test",
 "com.novocode" % "junit-interface" % "0.10" % "test"
 )
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/git_push.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ git_remote=`git remote`
if [ "$git_remote" = "" ]; then # git remote not defined

 if [ "$GIT_TOKEN" = "" ]; then
 echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
 echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
 git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
 else
 git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors by ngaya-ll · Pull Request #8053 · swagger-api/swagger-codegen · GitHub
Skip to content
[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors #8053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

ngaya-ll
wants to merge
6
commits into

base:master
Choose a base branch

from

 Open


[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors #8053
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
6419a36

Update java-okhttp-gson tests


ngaya-ll Apr 21, 2018
dd091d6

Minor test refactoring


ngaya-ll Apr 21, 2018
a35d4e0

Add test case for async calls and upload/download progress


ngaya-ll Apr 21, 2018
5b64f04

[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors


ngaya-ll Apr 21, 2018
a83fa95

Remove unnecessary ProgressListener interface


ngaya-ll Apr 22, 2018
bba39db

Merge branch 'master' into issue-7876


ngaya-ll Nov 21, 2018

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


41 changes: 34 additions & 7 deletions
modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,7 @@ public class ApiClient {
 */
 public ApiClient() {
 httpClient = new OkHttpClient();
 addProgressInterceptor();

 {{#useGzipFeature}}
 // Enable gzip request compression
Expand DownExpand Up@@ -138,6 +139,7 @@ public class ApiClient {
 */
 public ApiClient setHttpClient(OkHttpClient httpClient) {
 this.httpClient = httpClient;
 addProgressInterceptor();
@ngaya-llngaya-llApr 22, 2018

Copy link


Copy Markdown

Author
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that if multiple ApiClients are created with the same underlying OkHttpClient this will create duplicate progress updates for each request. However, from reading the rest of the class (e.g. the setDebugging() method) I concluded that this is not a supported use case.
 return this;
 }

Expand DownExpand Up@@ -959,12 +961,12 @@ public class ApiClient {
 * @param headerParams The header parameters
 * @param formParams The form parameters
 * @param authNames The authentications to apply
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return The HTTP call
 * @throws ApiException If fail to serialize the request body object
 */
 public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, progressRequestListener);
 public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
 Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, callback);

 return httpClient.newCall(request);
 }
Expand All@@ -980,11 +982,11 @@ public class ApiClient {
 * @param headerParams The header parameters
 * @param formParams The form parameters
 * @param authNames The authentications to apply
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return The HTTP request 
 * @throws ApiException If fail to serialize the request body object
 */
 public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
 updateParamsForAuth(authNames, queryParams, headerParams);

 final String url = buildUrl(path, queryParams, collectionQueryParams);
Expand DownExpand Up@@ -1016,10 +1018,14 @@ public class ApiClient {
 reqBody = serialize(body, contentType);
 }

 // Associate callback with request (if not null) so interceptor can
 // access it when creating ProgressResponseBody
 reqBuilder.tag(callback);

 Request request = null;

 if(progressRequestListener != null && reqBody != null) {
 ProgressRequestBody progressRequestBody = new ProgressRequestBody(reqBody, progressRequestListener);
 if(callback != null && reqBody != null) {
 ProgressRequestBody progressRequestBody = new ProgressRequestBody(reqBody, callback);
 request = reqBuilder.method(method, progressRequestBody).build();
 } else {
 request = reqBuilder.method(method, reqBody).build();
Expand DownExpand Up@@ -1161,6 +1167,27 @@ public class ApiClient {
 }
 }

 /**
 * Add network interceptor to httpClient to track download progress for
 * async requests.
 */
 private void addProgressInterceptor() {
 httpClient.networkInterceptors().add(new Interceptor() {
 @Override
 public Response intercept(Interceptor.Chain chain) throws IOException {
 final Request request = chain.request();
 final Response originalResponse = chain.proceed(request);
 if (request.tag() instanceof ApiCallback) {
 final ApiCallback callback = (ApiCallback) request.tag();
 return originalResponse.newBuilder()
 .body(new ProgressResponseBody(originalResponse.body(), callback))
 .build();
 }
 return originalResponse;
 }
 });
 }

 /**
 * Apply SSL related settings to httpClient according to the current values of
 * verifyingSsl and sslCaCert.
Expand Down

12 changes: 4 additions & 8 deletions
...wagger-codegen/src/main/resources/Java/libraries/okhttp-gson/ProgressRequestBody.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,13 @@ import okio.Sink;

public class ProgressRequestBody extends RequestBody {

 public interface ProgressRequestListener {
 void onRequestProgress(long bytesWritten, long contentLength, boolean done);
 }

 private final RequestBody requestBody;

 private final ProgressRequestListener progressListener;
 private final ApiCallback callback;

 public ProgressRequestBody(RequestBody requestBody, ProgressRequestListener progressListener) {
 public ProgressRequestBody(RequestBody requestBody, ApiCallback callback) {
 this.requestBody = requestBody;
 this.progressListener = progressListener;
 this.callback = callback;
 }

 @Override
Expand DownExpand Up@@ -59,7 +55,7 @@ public class ProgressRequestBody extends RequestBody {
 }

 bytesWritten += byteCount;
progressListener.onRequestProgress(bytesWritten, contentLength, bytesWritten == contentLength);
callback.onUploadProgress(bytesWritten, contentLength, bytesWritten == contentLength);
 }
 };
 }
Expand Down

12 changes: 4 additions & 8 deletions
...agger-codegen/src/main/resources/Java/libraries/okhttp-gson/ProgressResponseBody.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,13 @@ import okio.Source;

public class ProgressResponseBody extends ResponseBody {

 public interface ProgressListener {
 void update(long bytesRead, long contentLength, boolean done);
 }

 private final ResponseBody responseBody;
 private final ProgressListener progressListener;
 private final ApiCallback callback;
 private BufferedSource bufferedSource;

 public ProgressResponseBody(ResponseBody responseBody, ProgressListener progressListener) {
 public ProgressResponseBody(ResponseBody responseBody, ApiCallback callback) {
 this.responseBody = responseBody;
 this.progressListener = progressListener;
 this.callback = callback;
 }

 @Override
Expand DownExpand Up@@ -55,7 +51,7 @@ public class ProgressResponseBody extends ResponseBody {
 long bytesRead = super.read(sink, byteCount);
 // read() returns the number of bytes read, or -1 if this source is exhausted.
 totalBytesRead += bytesRead != -1 ? bytesRead : 0;
progressListener.update(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
callback.onDownloadProgress(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
 return bytesRead;
 }
 };
Expand Down

50 changes: 9 additions & 41 deletions
modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,8 +66,7 @@ public class {{classname}} {
 /**
 * Build call for {{operationId}}{{#allParams}}
 * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{/allParams}}
 * @param progressListener Progress listener
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return Call to execute
 * @throws ApiException If fail to serialize the request body object
 {{#isDeprecated}}
Expand All@@ -81,7 +80,7 @@ public class {{classname}} {
 {{#isDeprecated}}
 @Deprecated
 {{/isDeprecated}}
 public com.squareup.okhttp.Call {{operationId}}Call({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 public com.squareup.okhttp.Call {{operationId}}Call({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback callback) throws ApiException {
 Object {{localVariablePrefix}}localVarPostBody = {{#bodyParam}}{{paramName}}{{/bodyParam}}{{^bodyParam}}null{{/bodyParam}};

 // create path and map variables
Expand DownExpand Up@@ -113,27 +112,15 @@ public class {{classname}} {
 final String {{localVariablePrefix}}localVarContentType = {{localVariablePrefix}}apiClient.selectHeaderContentType({{localVariablePrefix}}localVarContentTypes);
 {{localVariablePrefix}}localVarHeaderParams.put("Content-Type", {{localVariablePrefix}}localVarContentType);

 if(progressListener != null) {
 apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() {
 @Override
 public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException {
 com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request());
 return originalResponse.newBuilder()
 .body(new ProgressResponseBody(originalResponse.body(), progressListener))
 .build();
 }
 });
 }

 String[] {{localVariablePrefix}}localVarAuthNames = new String[] { {{#authMethods}}"{{name}}"{{#hasMore}}, {{/hasMore}}{{/authMethods}} };
 return {{localVariablePrefix}}apiClient.buildCall({{localVariablePrefix}}localVarPath, "{{httpMethod}}", {{localVariablePrefix}}localVarQueryParams, {{localVariablePrefix}}localVarCollectionQueryParams, {{localVariablePrefix}}localVarPostBody, {{localVariablePrefix}}localVarHeaderParams, {{localVariablePrefix}}localVarFormParams, {{localVariablePrefix}}localVarAuthNames, progressRequestListener);
 return {{localVariablePrefix}}apiClient.buildCall({{localVariablePrefix}}localVarPath, "{{httpMethod}}", {{localVariablePrefix}}localVarQueryParams, {{localVariablePrefix}}localVarCollectionQueryParams, {{localVariablePrefix}}localVarPostBody, {{localVariablePrefix}}localVarHeaderParams, {{localVariablePrefix}}localVarFormParams, {{localVariablePrefix}}localVarAuthNames, callback);
 }

 {{#isDeprecated}}
 @Deprecated
 {{/isDeprecated}}
 @SuppressWarnings("rawtypes")
 private com.squareup.okhttp.Call {{operationId}}ValidateBeforeCall({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 private com.squareup.okhttp.Call {{operationId}}ValidateBeforeCall({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback callback) throws ApiException {
 {{^performBeanValidation}}
 {{#allParams}}{{#required}}
 // verify the required parameter '{{paramName}}' is set
Expand All@@ -142,7 +129,7 @@ public class {{classname}} {
 }
 {{/required}}{{/allParams}}

 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}callback);
 return {{localVariablePrefix}}call;

 {{/performBeanValidation}}
Expand All@@ -157,7 +144,7 @@ public class {{classname}} {
 parameterValues);

 if (violations.size() == 0) {
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}callback);
 return {{localVariablePrefix}}call;

 } else {
Expand DownExpand Up@@ -214,7 +201,7 @@ public class {{classname}} {
 @Deprecated
 {{/isDeprecated}}
 public ApiResponse<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{operationId}}WithHttpInfo({{#allParams}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) throws ApiException {
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null, null);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null);
 {{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
 return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType);{{/returnType}}{{^returnType}}return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call);{{/returnType}}
 }
Expand All@@ -239,30 +226,11 @@ public class {{classname}} {
 {{/isDeprecated}}
 public com.squareup.okhttp.Call {{operationId}}Async({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{localVariablePrefix}}callback) throws ApiException {

 ProgressResponseBody.ProgressListener progressListener = null;
 ProgressRequestBody.ProgressRequestListener progressRequestListener = null;

 if (callback != null) {
 progressListener = new ProgressResponseBody.ProgressListener() {
 @Override
 public void update(long bytesRead, long contentLength, boolean done) {
 callback.onDownloadProgress(bytesRead, contentLength, done);
 }
 };

 progressRequestListener = new ProgressRequestBody.ProgressRequestListener() {
 @Override
 public void onRequestProgress(long bytesWritten, long contentLength, boolean done) {
 callback.onUploadProgress(bytesWritten, contentLength, done);
 }
 };
 }

 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}callback);
 {{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
 {{localVariablePrefix}}apiClient.executeAsync({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType, {{localVariablePrefix}}callback);{{/returnType}}{{^returnType}}{{localVariablePrefix}}apiClient.executeAsync({{localVariablePrefix}}call, {{localVariablePrefix}}callback);{{/returnType}}
 return {{localVariablePrefix}}call;
 }
 {{/operation}}
}
{{/operations}}
{{/operations}}

2 changes: 1 addition & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/.swagger-codegen/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
2.3.0-SNAPSHOT
2.4.0-SNAPSHOT

3 changes: 2 additions & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/build.gradle

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,10 +94,11 @@ if(hasProperty('target') && target == 'android') {
}

dependencies {
 compile 'io.swagger:swagger-annotations:1.5.15'
 compile 'io.swagger:swagger-annotations:1.5.17'
 compile 'com.squareup.okhttp:okhttp:2.7.5'
 compile 'com.squareup.okhttp:logging-interceptor:2.7.5'
 compile 'com.google.code.gson:gson:2.8.1'
 compile 'io.gsonfire:gson-fire:1.8.0'
 compile 'org.threeten:threetenbp:1.3.5'
 testCompile 'junit:junit:4.12'
}

3 changes: 2 additions & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/build.sbt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,12 @@ lazy val root = (project in file(".")).
 publishArtifact in (Compile, packageDoc) := false,
 resolvers += Resolver.mavenLocal,
 libraryDependencies ++= Seq(
 "io.swagger" % "swagger-annotations" % "1.5.15",
 "io.swagger" % "swagger-annotations" % "1.5.17",
 "com.squareup.okhttp" % "okhttp" % "2.7.5",
 "com.squareup.okhttp" % "logging-interceptor" % "2.7.5",
 "com.google.code.gson" % "gson" % "2.8.1",
 "org.threeten" % "threetenbp" % "1.3.5" % "compile",
 "io.gsonfire" % "gson-fire" % "1.8.0" % "compile",
 "junit" % "junit" % "4.12" % "test",
 "com.novocode" % "junit-interface" % "0.10" % "test"
 )
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/git_push.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ git_remote=`git remote`
if [ "$git_remote" = "" ]; then # git remote not defined

 if [ "$GIT_TOKEN" = "" ]; then
 echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
 echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
 git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
 else
 git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors by ngaya-ll · Pull Request #8053 · swagger-api/swagger-codegen · GitHub
Skip to content
[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors #8053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

ngaya-ll
wants to merge
6
commits into

base:master
Choose a base branch

from

 Open


[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors #8053
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
6419a36

Update java-okhttp-gson tests


ngaya-ll Apr 21, 2018
dd091d6

Minor test refactoring


ngaya-ll Apr 21, 2018
a35d4e0

Add test case for async calls and upload/download progress


ngaya-ll Apr 21, 2018
5b64f04

[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors


ngaya-ll Apr 21, 2018
a83fa95

Remove unnecessary ProgressListener interface


ngaya-ll Apr 22, 2018
bba39db

Merge branch 'master' into issue-7876


ngaya-ll Nov 21, 2018

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


41 changes: 34 additions & 7 deletions
modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,7 @@ public class ApiClient {
 */
 public ApiClient() {
 httpClient = new OkHttpClient();
 addProgressInterceptor();

 {{#useGzipFeature}}
 // Enable gzip request compression
Expand DownExpand Up@@ -138,6 +139,7 @@ public class ApiClient {
 */
 public ApiClient setHttpClient(OkHttpClient httpClient) {
 this.httpClient = httpClient;
 addProgressInterceptor();
@ngaya-llngaya-llApr 22, 2018

Copy link


Copy Markdown

Author
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that if multiple ApiClients are created with the same underlying OkHttpClient this will create duplicate progress updates for each request. However, from reading the rest of the class (e.g. the setDebugging() method) I concluded that this is not a supported use case.
 return this;
 }

Expand DownExpand Up@@ -959,12 +961,12 @@ public class ApiClient {
 * @param headerParams The header parameters
 * @param formParams The form parameters
 * @param authNames The authentications to apply
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return The HTTP call
 * @throws ApiException If fail to serialize the request body object
 */
 public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, progressRequestListener);
 public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
 Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, callback);

 return httpClient.newCall(request);
 }
Expand All@@ -980,11 +982,11 @@ public class ApiClient {
 * @param headerParams The header parameters
 * @param formParams The form parameters
 * @param authNames The authentications to apply
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return The HTTP request 
 * @throws ApiException If fail to serialize the request body object
 */
 public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
 updateParamsForAuth(authNames, queryParams, headerParams);

 final String url = buildUrl(path, queryParams, collectionQueryParams);
Expand DownExpand Up@@ -1016,10 +1018,14 @@ public class ApiClient {
 reqBody = serialize(body, contentType);
 }

 // Associate callback with request (if not null) so interceptor can
 // access it when creating ProgressResponseBody
 reqBuilder.tag(callback);

 Request request = null;

 if(progressRequestListener != null && reqBody != null) {
 ProgressRequestBody progressRequestBody = new ProgressRequestBody(reqBody, progressRequestListener);
 if(callback != null && reqBody != null) {
 ProgressRequestBody progressRequestBody = new ProgressRequestBody(reqBody, callback);
 request = reqBuilder.method(method, progressRequestBody).build();
 } else {
 request = reqBuilder.method(method, reqBody).build();
Expand DownExpand Up@@ -1161,6 +1167,27 @@ public class ApiClient {
 }
 }

 /**
 * Add network interceptor to httpClient to track download progress for
 * async requests.
 */
 private void addProgressInterceptor() {
 httpClient.networkInterceptors().add(new Interceptor() {
 @Override
 public Response intercept(Interceptor.Chain chain) throws IOException {
 final Request request = chain.request();
 final Response originalResponse = chain.proceed(request);
 if (request.tag() instanceof ApiCallback) {
 final ApiCallback callback = (ApiCallback) request.tag();
 return originalResponse.newBuilder()
 .body(new ProgressResponseBody(originalResponse.body(), callback))
 .build();
 }
 return originalResponse;
 }
 });
 }

 /**
 * Apply SSL related settings to httpClient according to the current values of
 * verifyingSsl and sslCaCert.
Expand Down

12 changes: 4 additions & 8 deletions
...wagger-codegen/src/main/resources/Java/libraries/okhttp-gson/ProgressRequestBody.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,13 @@ import okio.Sink;

public class ProgressRequestBody extends RequestBody {

 public interface ProgressRequestListener {
 void onRequestProgress(long bytesWritten, long contentLength, boolean done);
 }

 private final RequestBody requestBody;

 private final ProgressRequestListener progressListener;
 private final ApiCallback callback;

 public ProgressRequestBody(RequestBody requestBody, ProgressRequestListener progressListener) {
 public ProgressRequestBody(RequestBody requestBody, ApiCallback callback) {
 this.requestBody = requestBody;
 this.progressListener = progressListener;
 this.callback = callback;
 }

 @Override
Expand DownExpand Up@@ -59,7 +55,7 @@ public class ProgressRequestBody extends RequestBody {
 }

 bytesWritten += byteCount;
progressListener.onRequestProgress(bytesWritten, contentLength, bytesWritten == contentLength);
callback.onUploadProgress(bytesWritten, contentLength, bytesWritten == contentLength);
 }
 };
 }
Expand Down

12 changes: 4 additions & 8 deletions
...agger-codegen/src/main/resources/Java/libraries/okhttp-gson/ProgressResponseBody.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,13 @@ import okio.Source;

public class ProgressResponseBody extends ResponseBody {

 public interface ProgressListener {
 void update(long bytesRead, long contentLength, boolean done);
 }

 private final ResponseBody responseBody;
 private final ProgressListener progressListener;
 private final ApiCallback callback;
 private BufferedSource bufferedSource;

 public ProgressResponseBody(ResponseBody responseBody, ProgressListener progressListener) {
 public ProgressResponseBody(ResponseBody responseBody, ApiCallback callback) {
 this.responseBody = responseBody;
 this.progressListener = progressListener;
 this.callback = callback;
 }

 @Override
Expand DownExpand Up@@ -55,7 +51,7 @@ public class ProgressResponseBody extends ResponseBody {
 long bytesRead = super.read(sink, byteCount);
 // read() returns the number of bytes read, or -1 if this source is exhausted.
 totalBytesRead += bytesRead != -1 ? bytesRead : 0;
progressListener.update(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
callback.onDownloadProgress(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
 return bytesRead;
 }
 };
Expand Down

50 changes: 9 additions & 41 deletions
modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,8 +66,7 @@ public class {{classname}} {
 /**
 * Build call for {{operationId}}{{#allParams}}
 * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{/allParams}}
 * @param progressListener Progress listener
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return Call to execute
 * @throws ApiException If fail to serialize the request body object
 {{#isDeprecated}}
Expand All@@ -81,7 +80,7 @@ public class {{classname}} {
 {{#isDeprecated}}
 @Deprecated
 {{/isDeprecated}}
 public com.squareup.okhttp.Call {{operationId}}Call({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 public com.squareup.okhttp.Call {{operationId}}Call({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback callback) throws ApiException {
 Object {{localVariablePrefix}}localVarPostBody = {{#bodyParam}}{{paramName}}{{/bodyParam}}{{^bodyParam}}null{{/bodyParam}};

 // create path and map variables
Expand DownExpand Up@@ -113,27 +112,15 @@ public class {{classname}} {
 final String {{localVariablePrefix}}localVarContentType = {{localVariablePrefix}}apiClient.selectHeaderContentType({{localVariablePrefix}}localVarContentTypes);
 {{localVariablePrefix}}localVarHeaderParams.put("Content-Type", {{localVariablePrefix}}localVarContentType);

 if(progressListener != null) {
 apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() {
 @Override
 public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException {
 com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request());
 return originalResponse.newBuilder()
 .body(new ProgressResponseBody(originalResponse.body(), progressListener))
 .build();
 }
 });
 }

 String[] {{localVariablePrefix}}localVarAuthNames = new String[] { {{#authMethods}}"{{name}}"{{#hasMore}}, {{/hasMore}}{{/authMethods}} };
 return {{localVariablePrefix}}apiClient.buildCall({{localVariablePrefix}}localVarPath, "{{httpMethod}}", {{localVariablePrefix}}localVarQueryParams, {{localVariablePrefix}}localVarCollectionQueryParams, {{localVariablePrefix}}localVarPostBody, {{localVariablePrefix}}localVarHeaderParams, {{localVariablePrefix}}localVarFormParams, {{localVariablePrefix}}localVarAuthNames, progressRequestListener);
 return {{localVariablePrefix}}apiClient.buildCall({{localVariablePrefix}}localVarPath, "{{httpMethod}}", {{localVariablePrefix}}localVarQueryParams, {{localVariablePrefix}}localVarCollectionQueryParams, {{localVariablePrefix}}localVarPostBody, {{localVariablePrefix}}localVarHeaderParams, {{localVariablePrefix}}localVarFormParams, {{localVariablePrefix}}localVarAuthNames, callback);
 }

 {{#isDeprecated}}
 @Deprecated
 {{/isDeprecated}}
 @SuppressWarnings("rawtypes")
 private com.squareup.okhttp.Call {{operationId}}ValidateBeforeCall({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 private com.squareup.okhttp.Call {{operationId}}ValidateBeforeCall({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback callback) throws ApiException {
 {{^performBeanValidation}}
 {{#allParams}}{{#required}}
 // verify the required parameter '{{paramName}}' is set
Expand All@@ -142,7 +129,7 @@ public class {{classname}} {
 }
 {{/required}}{{/allParams}}

 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}callback);
 return {{localVariablePrefix}}call;

 {{/performBeanValidation}}
Expand All@@ -157,7 +144,7 @@ public class {{classname}} {
 parameterValues);

 if (violations.size() == 0) {
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}callback);
 return {{localVariablePrefix}}call;

 } else {
Expand DownExpand Up@@ -214,7 +201,7 @@ public class {{classname}} {
 @Deprecated
 {{/isDeprecated}}
 public ApiResponse<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{operationId}}WithHttpInfo({{#allParams}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) throws ApiException {
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null, null);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null);
 {{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
 return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType);{{/returnType}}{{^returnType}}return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call);{{/returnType}}
 }
Expand All@@ -239,30 +226,11 @@ public class {{classname}} {
 {{/isDeprecated}}
 public com.squareup.okhttp.Call {{operationId}}Async({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{localVariablePrefix}}callback) throws ApiException {

 ProgressResponseBody.ProgressListener progressListener = null;
 ProgressRequestBody.ProgressRequestListener progressRequestListener = null;

 if (callback != null) {
 progressListener = new ProgressResponseBody.ProgressListener() {
 @Override
 public void update(long bytesRead, long contentLength, boolean done) {
 callback.onDownloadProgress(bytesRead, contentLength, done);
 }
 };

 progressRequestListener = new ProgressRequestBody.ProgressRequestListener() {
 @Override
 public void onRequestProgress(long bytesWritten, long contentLength, boolean done) {
 callback.onUploadProgress(bytesWritten, contentLength, done);
 }
 };
 }

 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}callback);
 {{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
 {{localVariablePrefix}}apiClient.executeAsync({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType, {{localVariablePrefix}}callback);{{/returnType}}{{^returnType}}{{localVariablePrefix}}apiClient.executeAsync({{localVariablePrefix}}call, {{localVariablePrefix}}callback);{{/returnType}}
 return {{localVariablePrefix}}call;
 }
 {{/operation}}
}
{{/operations}}
{{/operations}}

2 changes: 1 addition & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/.swagger-codegen/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
2.3.0-SNAPSHOT
2.4.0-SNAPSHOT

3 changes: 2 additions & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/build.gradle

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,10 +94,11 @@ if(hasProperty('target') && target == 'android') {
}

dependencies {
 compile 'io.swagger:swagger-annotations:1.5.15'
 compile 'io.swagger:swagger-annotations:1.5.17'
 compile 'com.squareup.okhttp:okhttp:2.7.5'
 compile 'com.squareup.okhttp:logging-interceptor:2.7.5'
 compile 'com.google.code.gson:gson:2.8.1'
 compile 'io.gsonfire:gson-fire:1.8.0'
 compile 'org.threeten:threetenbp:1.3.5'
 testCompile 'junit:junit:4.12'
}

3 changes: 2 additions & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/build.sbt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,12 @@ lazy val root = (project in file(".")).
 publishArtifact in (Compile, packageDoc) := false,
 resolvers += Resolver.mavenLocal,
 libraryDependencies ++= Seq(
 "io.swagger" % "swagger-annotations" % "1.5.15",
 "io.swagger" % "swagger-annotations" % "1.5.17",
 "com.squareup.okhttp" % "okhttp" % "2.7.5",
 "com.squareup.okhttp" % "logging-interceptor" % "2.7.5",
 "com.google.code.gson" % "gson" % "2.8.1",
 "org.threeten" % "threetenbp" % "1.3.5" % "compile",
 "io.gsonfire" % "gson-fire" % "1.8.0" % "compile",
 "junit" % "junit" % "4.12" % "test",
 "com.novocode" % "junit-interface" % "0.10" % "test"
 )
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/git_push.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ git_remote=`git remote`
if [ "$git_remote" = "" ]; then # git remote not defined

 if [ "$GIT_TOKEN" = "" ]; then
 echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
 echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
 git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
 else
 git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors by ngaya-ll · Pull Request #8053 · swagger-api/swagger-codegen · GitHub
Skip to content
[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors #8053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

ngaya-ll
wants to merge
6
commits into

base:master
Choose a base branch

from

 Open


[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors #8053
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
6419a36

Update java-okhttp-gson tests


ngaya-ll Apr 21, 2018
dd091d6

Minor test refactoring


ngaya-ll Apr 21, 2018
a35d4e0

Add test case for async calls and upload/download progress


ngaya-ll Apr 21, 2018
5b64f04

[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors


ngaya-ll Apr 21, 2018
a83fa95

Remove unnecessary ProgressListener interface


ngaya-ll Apr 22, 2018
bba39db

Merge branch 'master' into issue-7876


ngaya-ll Nov 21, 2018

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


41 changes: 34 additions & 7 deletions
modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,7 @@ public class ApiClient {
 */
 public ApiClient() {
 httpClient = new OkHttpClient();
 addProgressInterceptor();

 {{#useGzipFeature}}
 // Enable gzip request compression
Expand DownExpand Up@@ -138,6 +139,7 @@ public class ApiClient {
 */
 public ApiClient setHttpClient(OkHttpClient httpClient) {
 this.httpClient = httpClient;
 addProgressInterceptor();
@ngaya-llngaya-llApr 22, 2018

Copy link


Copy Markdown

Author
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that if multiple ApiClients are created with the same underlying OkHttpClient this will create duplicate progress updates for each request. However, from reading the rest of the class (e.g. the setDebugging() method) I concluded that this is not a supported use case.
 return this;
 }

Expand DownExpand Up@@ -959,12 +961,12 @@ public class ApiClient {
 * @param headerParams The header parameters
 * @param formParams The form parameters
 * @param authNames The authentications to apply
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return The HTTP call
 * @throws ApiException If fail to serialize the request body object
 */
 public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, progressRequestListener);
 public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
 Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, callback);

 return httpClient.newCall(request);
 }
Expand All@@ -980,11 +982,11 @@ public class ApiClient {
 * @param headerParams The header parameters
 * @param formParams The form parameters
 * @param authNames The authentications to apply
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return The HTTP request 
 * @throws ApiException If fail to serialize the request body object
 */
 public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
 updateParamsForAuth(authNames, queryParams, headerParams);

 final String url = buildUrl(path, queryParams, collectionQueryParams);
Expand DownExpand Up@@ -1016,10 +1018,14 @@ public class ApiClient {
 reqBody = serialize(body, contentType);
 }

 // Associate callback with request (if not null) so interceptor can
 // access it when creating ProgressResponseBody
 reqBuilder.tag(callback);

 Request request = null;

 if(progressRequestListener != null && reqBody != null) {
 ProgressRequestBody progressRequestBody = new ProgressRequestBody(reqBody, progressRequestListener);
 if(callback != null && reqBody != null) {
 ProgressRequestBody progressRequestBody = new ProgressRequestBody(reqBody, callback);
 request = reqBuilder.method(method, progressRequestBody).build();
 } else {
 request = reqBuilder.method(method, reqBody).build();
Expand DownExpand Up@@ -1161,6 +1167,27 @@ public class ApiClient {
 }
 }

 /**
 * Add network interceptor to httpClient to track download progress for
 * async requests.
 */
 private void addProgressInterceptor() {
 httpClient.networkInterceptors().add(new Interceptor() {
 @Override
 public Response intercept(Interceptor.Chain chain) throws IOException {
 final Request request = chain.request();
 final Response originalResponse = chain.proceed(request);
 if (request.tag() instanceof ApiCallback) {
 final ApiCallback callback = (ApiCallback) request.tag();
 return originalResponse.newBuilder()
 .body(new ProgressResponseBody(originalResponse.body(), callback))
 .build();
 }
 return originalResponse;
 }
 });
 }

 /**
 * Apply SSL related settings to httpClient according to the current values of
 * verifyingSsl and sslCaCert.
Expand Down

12 changes: 4 additions & 8 deletions
...wagger-codegen/src/main/resources/Java/libraries/okhttp-gson/ProgressRequestBody.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,13 @@ import okio.Sink;

public class ProgressRequestBody extends RequestBody {

 public interface ProgressRequestListener {
 void onRequestProgress(long bytesWritten, long contentLength, boolean done);
 }

 private final RequestBody requestBody;

 private final ProgressRequestListener progressListener;
 private final ApiCallback callback;

 public ProgressRequestBody(RequestBody requestBody, ProgressRequestListener progressListener) {
 public ProgressRequestBody(RequestBody requestBody, ApiCallback callback) {
 this.requestBody = requestBody;
 this.progressListener = progressListener;
 this.callback = callback;
 }

 @Override
Expand DownExpand Up@@ -59,7 +55,7 @@ public class ProgressRequestBody extends RequestBody {
 }

 bytesWritten += byteCount;
progressListener.onRequestProgress(bytesWritten, contentLength, bytesWritten == contentLength);
callback.onUploadProgress(bytesWritten, contentLength, bytesWritten == contentLength);
 }
 };
 }
Expand Down

12 changes: 4 additions & 8 deletions
...agger-codegen/src/main/resources/Java/libraries/okhttp-gson/ProgressResponseBody.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,13 @@ import okio.Source;

public class ProgressResponseBody extends ResponseBody {

 public interface ProgressListener {
 void update(long bytesRead, long contentLength, boolean done);
 }

 private final ResponseBody responseBody;
 private final ProgressListener progressListener;
 private final ApiCallback callback;
 private BufferedSource bufferedSource;

 public ProgressResponseBody(ResponseBody responseBody, ProgressListener progressListener) {
 public ProgressResponseBody(ResponseBody responseBody, ApiCallback callback) {
 this.responseBody = responseBody;
 this.progressListener = progressListener;
 this.callback = callback;
 }

 @Override
Expand DownExpand Up@@ -55,7 +51,7 @@ public class ProgressResponseBody extends ResponseBody {
 long bytesRead = super.read(sink, byteCount);
 // read() returns the number of bytes read, or -1 if this source is exhausted.
 totalBytesRead += bytesRead != -1 ? bytesRead : 0;
progressListener.update(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
callback.onDownloadProgress(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
 return bytesRead;
 }
 };
Expand Down

50 changes: 9 additions & 41 deletions
modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,8 +66,7 @@ public class {{classname}} {
 /**
 * Build call for {{operationId}}{{#allParams}}
 * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{/allParams}}
 * @param progressListener Progress listener
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return Call to execute
 * @throws ApiException If fail to serialize the request body object
 {{#isDeprecated}}
Expand All@@ -81,7 +80,7 @@ public class {{classname}} {
 {{#isDeprecated}}
 @Deprecated
 {{/isDeprecated}}
 public com.squareup.okhttp.Call {{operationId}}Call({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 public com.squareup.okhttp.Call {{operationId}}Call({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback callback) throws ApiException {
 Object {{localVariablePrefix}}localVarPostBody = {{#bodyParam}}{{paramName}}{{/bodyParam}}{{^bodyParam}}null{{/bodyParam}};

 // create path and map variables
Expand DownExpand Up@@ -113,27 +112,15 @@ public class {{classname}} {
 final String {{localVariablePrefix}}localVarContentType = {{localVariablePrefix}}apiClient.selectHeaderContentType({{localVariablePrefix}}localVarContentTypes);
 {{localVariablePrefix}}localVarHeaderParams.put("Content-Type", {{localVariablePrefix}}localVarContentType);

 if(progressListener != null) {
 apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() {
 @Override
 public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException {
 com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request());
 return originalResponse.newBuilder()
 .body(new ProgressResponseBody(originalResponse.body(), progressListener))
 .build();
 }
 });
 }

 String[] {{localVariablePrefix}}localVarAuthNames = new String[] { {{#authMethods}}"{{name}}"{{#hasMore}}, {{/hasMore}}{{/authMethods}} };
 return {{localVariablePrefix}}apiClient.buildCall({{localVariablePrefix}}localVarPath, "{{httpMethod}}", {{localVariablePrefix}}localVarQueryParams, {{localVariablePrefix}}localVarCollectionQueryParams, {{localVariablePrefix}}localVarPostBody, {{localVariablePrefix}}localVarHeaderParams, {{localVariablePrefix}}localVarFormParams, {{localVariablePrefix}}localVarAuthNames, progressRequestListener);
 return {{localVariablePrefix}}apiClient.buildCall({{localVariablePrefix}}localVarPath, "{{httpMethod}}", {{localVariablePrefix}}localVarQueryParams, {{localVariablePrefix}}localVarCollectionQueryParams, {{localVariablePrefix}}localVarPostBody, {{localVariablePrefix}}localVarHeaderParams, {{localVariablePrefix}}localVarFormParams, {{localVariablePrefix}}localVarAuthNames, callback);
 }

 {{#isDeprecated}}
 @Deprecated
 {{/isDeprecated}}
 @SuppressWarnings("rawtypes")
 private com.squareup.okhttp.Call {{operationId}}ValidateBeforeCall({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 private com.squareup.okhttp.Call {{operationId}}ValidateBeforeCall({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback callback) throws ApiException {
 {{^performBeanValidation}}
 {{#allParams}}{{#required}}
 // verify the required parameter '{{paramName}}' is set
Expand All@@ -142,7 +129,7 @@ public class {{classname}} {
 }
 {{/required}}{{/allParams}}

 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}callback);
 return {{localVariablePrefix}}call;

 {{/performBeanValidation}}
Expand All@@ -157,7 +144,7 @@ public class {{classname}} {
 parameterValues);

 if (violations.size() == 0) {
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}callback);
 return {{localVariablePrefix}}call;

 } else {
Expand DownExpand Up@@ -214,7 +201,7 @@ public class {{classname}} {
 @Deprecated
 {{/isDeprecated}}
 public ApiResponse<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{operationId}}WithHttpInfo({{#allParams}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) throws ApiException {
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null, null);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null);
 {{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
 return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType);{{/returnType}}{{^returnType}}return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call);{{/returnType}}
 }
Expand All@@ -239,30 +226,11 @@ public class {{classname}} {
 {{/isDeprecated}}
 public com.squareup.okhttp.Call {{operationId}}Async({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{localVariablePrefix}}callback) throws ApiException {

 ProgressResponseBody.ProgressListener progressListener = null;
 ProgressRequestBody.ProgressRequestListener progressRequestListener = null;

 if (callback != null) {
 progressListener = new ProgressResponseBody.ProgressListener() {
 @Override
 public void update(long bytesRead, long contentLength, boolean done) {
 callback.onDownloadProgress(bytesRead, contentLength, done);
 }
 };

 progressRequestListener = new ProgressRequestBody.ProgressRequestListener() {
 @Override
 public void onRequestProgress(long bytesWritten, long contentLength, boolean done) {
 callback.onUploadProgress(bytesWritten, contentLength, done);
 }
 };
 }

 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}callback);
 {{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
 {{localVariablePrefix}}apiClient.executeAsync({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType, {{localVariablePrefix}}callback);{{/returnType}}{{^returnType}}{{localVariablePrefix}}apiClient.executeAsync({{localVariablePrefix}}call, {{localVariablePrefix}}callback);{{/returnType}}
 return {{localVariablePrefix}}call;
 }
 {{/operation}}
}
{{/operations}}
{{/operations}}

2 changes: 1 addition & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/.swagger-codegen/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
2.3.0-SNAPSHOT
2.4.0-SNAPSHOT

3 changes: 2 additions & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/build.gradle

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,10 +94,11 @@ if(hasProperty('target') && target == 'android') {
}

dependencies {
 compile 'io.swagger:swagger-annotations:1.5.15'
 compile 'io.swagger:swagger-annotations:1.5.17'
 compile 'com.squareup.okhttp:okhttp:2.7.5'
 compile 'com.squareup.okhttp:logging-interceptor:2.7.5'
 compile 'com.google.code.gson:gson:2.8.1'
 compile 'io.gsonfire:gson-fire:1.8.0'
 compile 'org.threeten:threetenbp:1.3.5'
 testCompile 'junit:junit:4.12'
}

3 changes: 2 additions & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/build.sbt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,12 @@ lazy val root = (project in file(".")).
 publishArtifact in (Compile, packageDoc) := false,
 resolvers += Resolver.mavenLocal,
 libraryDependencies ++= Seq(
 "io.swagger" % "swagger-annotations" % "1.5.15",
 "io.swagger" % "swagger-annotations" % "1.5.17",
 "com.squareup.okhttp" % "okhttp" % "2.7.5",
 "com.squareup.okhttp" % "logging-interceptor" % "2.7.5",
 "com.google.code.gson" % "gson" % "2.8.1",
 "org.threeten" % "threetenbp" % "1.3.5" % "compile",
 "io.gsonfire" % "gson-fire" % "1.8.0" % "compile",
 "junit" % "junit" % "4.12" % "test",
 "com.novocode" % "junit-interface" % "0.10" % "test"
 )
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/git_push.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ git_remote=`git remote`
if [ "$git_remote" = "" ]; then # git remote not defined

 if [ "$GIT_TOKEN" = "" ]; then
 echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
 echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
 git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
 else
 git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors by ngaya-ll · Pull Request #8053 · swagger-api/swagger-codegen · GitHub
Skip to content
[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors #8053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

ngaya-ll
wants to merge
6
commits into

base:master
Choose a base branch

from

 Open


[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors #8053
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
6419a36

Update java-okhttp-gson tests


ngaya-ll Apr 21, 2018
dd091d6

Minor test refactoring


ngaya-ll Apr 21, 2018
a35d4e0

Add test case for async calls and upload/download progress


ngaya-ll Apr 21, 2018
5b64f04

[Java][okhttp-gson] Fix incorrect use of OkHttp interceptors


ngaya-ll Apr 21, 2018
a83fa95

Remove unnecessary ProgressListener interface


ngaya-ll Apr 22, 2018
bba39db

Merge branch 'master' into issue-7876


ngaya-ll Nov 21, 2018

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


41 changes: 34 additions & 7 deletions
modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,6 +79,7 @@ public class ApiClient {
 */
 public ApiClient() {
 httpClient = new OkHttpClient();
 addProgressInterceptor();

 {{#useGzipFeature}}
 // Enable gzip request compression
Expand DownExpand Up@@ -138,6 +139,7 @@ public class ApiClient {
 */
 public ApiClient setHttpClient(OkHttpClient httpClient) {
 this.httpClient = httpClient;
 addProgressInterceptor();
@ngaya-llngaya-llApr 22, 2018

Copy link


Copy Markdown

Author
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that if multiple ApiClients are created with the same underlying OkHttpClient this will create duplicate progress updates for each request. However, from reading the rest of the class (e.g. the setDebugging() method) I concluded that this is not a supported use case.
 return this;
 }

Expand DownExpand Up@@ -959,12 +961,12 @@ public class ApiClient {
 * @param headerParams The header parameters
 * @param formParams The form parameters
 * @param authNames The authentications to apply
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return The HTTP call
 * @throws ApiException If fail to serialize the request body object
 */
 public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, progressRequestListener);
 public Call buildCall(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
 Request request = buildRequest(path, method, queryParams, collectionQueryParams, body, headerParams, formParams, authNames, callback);

 return httpClient.newCall(request);
 }
Expand All@@ -980,11 +982,11 @@ public class ApiClient {
 * @param headerParams The header parameters
 * @param formParams The form parameters
 * @param authNames The authentications to apply
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return The HTTP request 
 * @throws ApiException If fail to serialize the request body object
 */
 public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 public Request buildRequest(String path, String method, List<Pair> queryParams, List<Pair> collectionQueryParams, Object body, Map<String, String> headerParams, Map<String, Object> formParams, String[] authNames, ApiCallback callback) throws ApiException {
 updateParamsForAuth(authNames, queryParams, headerParams);

 final String url = buildUrl(path, queryParams, collectionQueryParams);
Expand DownExpand Up@@ -1016,10 +1018,14 @@ public class ApiClient {
 reqBody = serialize(body, contentType);
 }

 // Associate callback with request (if not null) so interceptor can
 // access it when creating ProgressResponseBody
 reqBuilder.tag(callback);

 Request request = null;

 if(progressRequestListener != null && reqBody != null) {
 ProgressRequestBody progressRequestBody = new ProgressRequestBody(reqBody, progressRequestListener);
 if(callback != null && reqBody != null) {
 ProgressRequestBody progressRequestBody = new ProgressRequestBody(reqBody, callback);
 request = reqBuilder.method(method, progressRequestBody).build();
 } else {
 request = reqBuilder.method(method, reqBody).build();
Expand DownExpand Up@@ -1161,6 +1167,27 @@ public class ApiClient {
 }
 }

 /**
 * Add network interceptor to httpClient to track download progress for
 * async requests.
 */
 private void addProgressInterceptor() {
 httpClient.networkInterceptors().add(new Interceptor() {
 @Override
 public Response intercept(Interceptor.Chain chain) throws IOException {
 final Request request = chain.request();
 final Response originalResponse = chain.proceed(request);
 if (request.tag() instanceof ApiCallback) {
 final ApiCallback callback = (ApiCallback) request.tag();
 return originalResponse.newBuilder()
 .body(new ProgressResponseBody(originalResponse.body(), callback))
 .build();
 }
 return originalResponse;
 }
 });
 }

 /**
 * Apply SSL related settings to httpClient according to the current values of
 * verifyingSsl and sslCaCert.
Expand Down

12 changes: 4 additions & 8 deletions
...wagger-codegen/src/main/resources/Java/libraries/okhttp-gson/ProgressRequestBody.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,13 @@ import okio.Sink;

public class ProgressRequestBody extends RequestBody {

 public interface ProgressRequestListener {
 void onRequestProgress(long bytesWritten, long contentLength, boolean done);
 }

 private final RequestBody requestBody;

 private final ProgressRequestListener progressListener;
 private final ApiCallback callback;

 public ProgressRequestBody(RequestBody requestBody, ProgressRequestListener progressListener) {
 public ProgressRequestBody(RequestBody requestBody, ApiCallback callback) {
 this.requestBody = requestBody;
 this.progressListener = progressListener;
 this.callback = callback;
 }

 @Override
Expand DownExpand Up@@ -59,7 +55,7 @@ public class ProgressRequestBody extends RequestBody {
 }

 bytesWritten += byteCount;
progressListener.onRequestProgress(bytesWritten, contentLength, bytesWritten == contentLength);
callback.onUploadProgress(bytesWritten, contentLength, bytesWritten == contentLength);
 }
 };
 }
Expand Down

12 changes: 4 additions & 8 deletions
...agger-codegen/src/main/resources/Java/libraries/okhttp-gson/ProgressResponseBody.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,17 +15,13 @@ import okio.Source;

public class ProgressResponseBody extends ResponseBody {

 public interface ProgressListener {
 void update(long bytesRead, long contentLength, boolean done);
 }

 private final ResponseBody responseBody;
 private final ProgressListener progressListener;
 private final ApiCallback callback;
 private BufferedSource bufferedSource;

 public ProgressResponseBody(ResponseBody responseBody, ProgressListener progressListener) {
 public ProgressResponseBody(ResponseBody responseBody, ApiCallback callback) {
 this.responseBody = responseBody;
 this.progressListener = progressListener;
 this.callback = callback;
 }

 @Override
Expand DownExpand Up@@ -55,7 +51,7 @@ public class ProgressResponseBody extends ResponseBody {
 long bytesRead = super.read(sink, byteCount);
 // read() returns the number of bytes read, or -1 if this source is exhausted.
 totalBytesRead += bytesRead != -1 ? bytesRead : 0;
progressListener.update(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
callback.onDownloadProgress(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
 return bytesRead;
 }
 };
Expand Down

50 changes: 9 additions & 41 deletions
modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -66,8 +66,7 @@ public class {{classname}} {
 /**
 * Build call for {{operationId}}{{#allParams}}
 * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{/allParams}}
 * @param progressListener Progress listener
 * @param progressRequestListener Progress request listener
 * @param callback Callback for upload/download progress
 * @return Call to execute
 * @throws ApiException If fail to serialize the request body object
 {{#isDeprecated}}
Expand All@@ -81,7 +80,7 @@ public class {{classname}} {
 {{#isDeprecated}}
 @Deprecated
 {{/isDeprecated}}
 public com.squareup.okhttp.Call {{operationId}}Call({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 public com.squareup.okhttp.Call {{operationId}}Call({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback callback) throws ApiException {
 Object {{localVariablePrefix}}localVarPostBody = {{#bodyParam}}{{paramName}}{{/bodyParam}}{{^bodyParam}}null{{/bodyParam}};

 // create path and map variables
Expand DownExpand Up@@ -113,27 +112,15 @@ public class {{classname}} {
 final String {{localVariablePrefix}}localVarContentType = {{localVariablePrefix}}apiClient.selectHeaderContentType({{localVariablePrefix}}localVarContentTypes);
 {{localVariablePrefix}}localVarHeaderParams.put("Content-Type", {{localVariablePrefix}}localVarContentType);

 if(progressListener != null) {
 apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() {
 @Override
 public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException {
 com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request());
 return originalResponse.newBuilder()
 .body(new ProgressResponseBody(originalResponse.body(), progressListener))
 .build();
 }
 });
 }

 String[] {{localVariablePrefix}}localVarAuthNames = new String[] { {{#authMethods}}"{{name}}"{{#hasMore}}, {{/hasMore}}{{/authMethods}} };
 return {{localVariablePrefix}}apiClient.buildCall({{localVariablePrefix}}localVarPath, "{{httpMethod}}", {{localVariablePrefix}}localVarQueryParams, {{localVariablePrefix}}localVarCollectionQueryParams, {{localVariablePrefix}}localVarPostBody, {{localVariablePrefix}}localVarHeaderParams, {{localVariablePrefix}}localVarFormParams, {{localVariablePrefix}}localVarAuthNames, progressRequestListener);
 return {{localVariablePrefix}}apiClient.buildCall({{localVariablePrefix}}localVarPath, "{{httpMethod}}", {{localVariablePrefix}}localVarQueryParams, {{localVariablePrefix}}localVarCollectionQueryParams, {{localVariablePrefix}}localVarPostBody, {{localVariablePrefix}}localVarHeaderParams, {{localVariablePrefix}}localVarFormParams, {{localVariablePrefix}}localVarAuthNames, callback);
 }

 {{#isDeprecated}}
 @Deprecated
 {{/isDeprecated}}
 @SuppressWarnings("rawtypes")
 private com.squareup.okhttp.Call {{operationId}}ValidateBeforeCall({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
 private com.squareup.okhttp.Call {{operationId}}ValidateBeforeCall({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback callback) throws ApiException {
 {{^performBeanValidation}}
 {{#allParams}}{{#required}}
 // verify the required parameter '{{paramName}}' is set
Expand All@@ -142,7 +129,7 @@ public class {{classname}} {
 }
 {{/required}}{{/allParams}}

 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}callback);
 return {{localVariablePrefix}}call;

 {{/performBeanValidation}}
Expand All@@ -157,7 +144,7 @@ public class {{classname}} {
 parameterValues);

 if (violations.size() == 0) {
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}Call({{#allParams}}{{paramName}}, {{/allParams}}callback);
 return {{localVariablePrefix}}call;

 } else {
Expand DownExpand Up@@ -214,7 +201,7 @@ public class {{classname}} {
 @Deprecated
 {{/isDeprecated}}
 public ApiResponse<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{operationId}}WithHttpInfo({{#allParams}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) throws ApiException {
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null, null);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null);
 {{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
 return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType);{{/returnType}}{{^returnType}}return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call);{{/returnType}}
 }
Expand All@@ -239,30 +226,11 @@ public class {{classname}} {
 {{/isDeprecated}}
 public com.squareup.okhttp.Call {{operationId}}Async({{#allParams}}{{{dataType}}} {{paramName}}, {{/allParams}}final ApiCallback<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{localVariablePrefix}}callback) throws ApiException {

 ProgressResponseBody.ProgressListener progressListener = null;
 ProgressRequestBody.ProgressRequestListener progressRequestListener = null;

 if (callback != null) {
 progressListener = new ProgressResponseBody.ProgressListener() {
 @Override
 public void update(long bytesRead, long contentLength, boolean done) {
 callback.onDownloadProgress(bytesRead, contentLength, done);
 }
 };

 progressRequestListener = new ProgressRequestBody.ProgressRequestListener() {
 @Override
 public void onRequestProgress(long bytesWritten, long contentLength, boolean done) {
 callback.onUploadProgress(bytesWritten, contentLength, done);
 }
 };
 }

 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}progressListener, progressRequestListener);
 com.squareup.okhttp.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}callback);
 {{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
 {{localVariablePrefix}}apiClient.executeAsync({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType, {{localVariablePrefix}}callback);{{/returnType}}{{^returnType}}{{localVariablePrefix}}apiClient.executeAsync({{localVariablePrefix}}call, {{localVariablePrefix}}callback);{{/returnType}}
 return {{localVariablePrefix}}call;
 }
 {{/operation}}
}
{{/operations}}
{{/operations}}

2 changes: 1 addition & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/.swagger-codegen/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
2.3.0-SNAPSHOT
2.4.0-SNAPSHOT

3 changes: 2 additions & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/build.gradle

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,10 +94,11 @@ if(hasProperty('target') && target == 'android') {
}

dependencies {
 compile 'io.swagger:swagger-annotations:1.5.15'
 compile 'io.swagger:swagger-annotations:1.5.17'
 compile 'com.squareup.okhttp:okhttp:2.7.5'
 compile 'com.squareup.okhttp:logging-interceptor:2.7.5'
 compile 'com.google.code.gson:gson:2.8.1'
 compile 'io.gsonfire:gson-fire:1.8.0'
 compile 'org.threeten:threetenbp:1.3.5'
 testCompile 'junit:junit:4.12'
}

3 changes: 2 additions & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/build.sbt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,12 @@ lazy val root = (project in file(".")).
 publishArtifact in (Compile, packageDoc) := false,
 resolvers += Resolver.mavenLocal,
 libraryDependencies ++= Seq(
 "io.swagger" % "swagger-annotations" % "1.5.15",
 "io.swagger" % "swagger-annotations" % "1.5.17",
 "com.squareup.okhttp" % "okhttp" % "2.7.5",
 "com.squareup.okhttp" % "logging-interceptor" % "2.7.5",
 "com.google.code.gson" % "gson" % "2.8.1",
 "org.threeten" % "threetenbp" % "1.3.5" % "compile",
 "io.gsonfire" % "gson-fire" % "1.8.0" % "compile",
 "junit" % "junit" % "4.12" % "test",
 "com.novocode" % "junit-interface" % "0.10" % "test"
 )
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore-security-test/java/okhttp-gson/git_push.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ git_remote=`git remote`
if [ "$git_remote" = "" ]; then # git remote not defined

 if [ "$GIT_TOKEN" = "" ]; then
 echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
 echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
 git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
 else
 git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
Expand Down
Loading