Skip to content

Add request temp file buffer (#3479) #3659

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.

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
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Milkdove
Copy link
Contributor

@Milkdove Milkdove commented Jan 7, 2025

Add the feature of using temp file as intermediaries when forwarding large requests, which can effectively solve the OOM, and added two configs to control it:

spring.cloud.gateway.mvc.file-buffer-enabled 
spring.cloud.gateway.mvc.file-buffer-size-threshold

I'm not sure if this solution is appropriate. It may cause some large requests to be slowed down.But I don’t have any other ideas at the moment. This is the solution our team uses. In addition, should the default value of file-buffer-enabled be true?

@ryanjbaxter
Copy link
Contributor

Shouldn't the gateway stream the file? Or are you using filters that may be reading the body?

@Milkdove
Copy link
Contributor Author

Strictly speaking, the current MVC version of the Gateway doesn't truly support streaming transmission. Its process involves reading the request, caching it, and then sending it out. This approach can lead to Out Of Memory (OOM) issues, as seen in some cases.
To achieve streaming forwarding, you'd need to modify the underlying network framework to use asynchronous I/O, like with a WebFlux Gateway. However, this means moving away from the traditional MVC architecture.

@spencergibb
Copy link
Member

This version was built specifically for Spring WebMVC and blocking IO is part of that. When Zuul was supported, there was an option to install it as a servlet outside the spring dispatcher servlet, and that's how large uploads were handled. We don't really have either of those options. This seems like a good middle ground.

/**
* Temp file buffer for request.
*/
private boolean fileBufferEnabled = true;
Copy link
Member

Choose a reason for hiding this comment

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

This should be disabled by default.

/**
* The size threshold which a request will be written to disk.
*/
private DataSize fileBufferSizeThreshold = DataSize.ofMegabytes(1L);
Copy link
Member

Choose a reason for hiding this comment

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

Let's create a nest class FileBuffer and move these two properties to it.

@@ -75,4 +75,9 @@ private int copyResponseBodyWithFlushing(InputStream inputStream, OutputStream o
return totalReadBytes;
}


protected boolean isWriteClientBodyToFile(Request request) {
return properties.isFileBufferEnabled() && request.getServerRequest().servletRequest().getContentLength() >= properties.getFileBufferSizeThreshold().toBytes();
Copy link
Member

Choose a reason for hiding this comment

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

I wonder if this should include a content type check as well?

}
return requestSpec.exchange((clientRequest, clientResponse) -> {
ServerResponse serverResponse = doExchange(request, clientResponse);
clearTempFileIfExist(request);
Copy link
Member

Choose a reason for hiding this comment

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

This should be guarded by the isWriteClientBodyToFile() check as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants