Skip to content
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

perf: optimizing request plugin bundle resources #4639

Merged
merged 7 commits into from
Sep 27, 2023
Merged

perf: optimizing request plugin bundle resources #4639

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b00a0f2
perf: optimizing query for plugin bundle resources
guqing Sep 21, 2023
e4a50e4
Merge branch 'main' into refactor/plugin-bundle
JohnNiang Sep 27, 2023
221fb47
refactor: using databuffer instead of string for plugin bundle resource
guqing Sep 27, 2023
d172a43
Merge branch 'main' into refactor/plugin-bundle
guqing Sep 27, 2023
cb028fe
fix: unit test case
guqing Sep 27, 2023
bd1f1cc
fix: lock outside of try statement
guqing Sep 27, 2023
f58366b
fix: remove synchronized for create temp file
guqing Sep 27, 2023
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
168 changes: 147 additions & 21 deletions application/src/main/java/run/halo/app/core/extension/endpoint/PluginEndpoint.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import static io.swagger.v3.oas.annotations.media.Schema.RequiredMode.NOT_REQUIRED;
import static io.swagger.v3.oas.annotations.media.Schema.RequiredMode.REQUIRED;
import static java.util.Comparator.comparing;
import static org.apache.commons.lang3.StringUtils.defaultString;
import static org.springdoc.core.fn.builders.apiresponse.Builder.responseBuilder;
import static org.springdoc.core.fn.builders.content.Builder.contentBuilder;
import static org.springdoc.core.fn.builders.parameter.Builder.parameterBuilder;
Expand All @@ -19,11 +20,14 @@
import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Schema;
import java.io.IOException;
import java.net.URI;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.time.Duration;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
Expand All @@ -33,10 +37,14 @@
import java.util.concurrent.TimeUnit;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.Supplier;
import lombok.AllArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.reactivestreams.Publisher;
import org.springdoc.webflux.core.fn.SpringdocRouteBuilder;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.core.io.FileSystemResource;
import org.springframework.core.io.Resource;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.dao.OptimisticLockingFailureException;
import org.springframework.data.domain.Sort;
Expand All @@ -45,9 +53,13 @@
import org.springframework.http.codec.multipart.FilePart;
import org.springframework.http.codec.multipart.FormFieldPart;
import org.springframework.http.codec.multipart.Part;
import org.springframework.lang.Nullable;
import org.springframework.stereotype.Component;
import org.springframework.util.Assert;
import org.springframework.util.FileSystemUtils;
import org.springframework.util.MultiValueMap;
import org.springframework.util.StringUtils;
import org.springframework.web.reactive.function.BodyInserters;
import org.springframework.web.reactive.function.server.RouterFunction;
import org.springframework.web.reactive.function.server.ServerRequest;
import org.springframework.web.reactive.function.server.ServerResponse;
Expand Down Expand Up @@ -82,6 +94,8 @@ public class PluginEndpoint implements CustomEndpoint {

private final Scheduler scheduler = Schedulers.boundedElastic();

private final BufferedPluginBundleResource bufferedPluginBundleResource;

@Override
public RouterFunction<ServerResponse> endpoint() {
final var tag = "api.console.halo.run/v1alpha1/Plugin";
Expand Down Expand Up @@ -240,36 +254,59 @@ public RouterFunction<ServerResponse> endpoint() {

private Mono<ServerResponse> fetchJsBundle(ServerRequest request) {
Optional<String> versionOption = request.queryParam("v");
if (versionOption.isEmpty()) {
return pluginService.generateJsBundleVersion()
return versionOption.map(s ->
Mono.fromCallable(() -> bufferedPluginBundleResource
.jsBundleResource(s, () -> pluginService.uglifyJsBundle().block())
).flatMap(fsRes -> {
var bodyBuilder = ServerResponse.ok()
.cacheControl(MAX_CACHE_CONTROL)
.contentType(MediaType.valueOf("text/javascript"));
try {
Instant lastModified = Instant.ofEpochMilli(fsRes.lastModified());
return request.checkNotModified(lastModified)
.switchIfEmpty(Mono.defer(() ->
bodyBuilder.lastModified(lastModified)
.body(BodyInserters.fromResource(fsRes)))
);
} catch (IOException e) {
return Mono.error(e);
}
})
)
.orElseGet(() -> pluginService.generateJsBundleVersion()
.flatMap(v -> ServerResponse
.temporaryRedirect(buildJsBundleUri("js", v))
.build()
);
}
return pluginService.uglifyJsBundle()
.defaultIfEmpty("")
.flatMap(bundle -> ServerResponse.ok()
.cacheControl(MAX_CACHE_CONTROL)
.contentType(MediaType.valueOf("text/javascript"))
.bodyValue(bundle)
)
);
}

private Mono<ServerResponse> fetchCssBundle(ServerRequest request) {
Optional<String> versionOption = request.queryParam("v");
if (versionOption.isEmpty()) {
return pluginService.generateJsBundleVersion()
return versionOption.map(s ->
Mono.fromCallable(() -> bufferedPluginBundleResource.cssBundleResource(s,
() -> pluginService.uglifyCssBundle().block())
guqing marked this conversation as resolved.
Show resolved Hide resolved
).flatMap(fsRes -> {
var bodyBuilder = ServerResponse.ok()
.cacheControl(MAX_CACHE_CONTROL)
.contentType(MediaType.valueOf("text/css"));
try {
Instant lastModified = Instant.ofEpochMilli(fsRes.lastModified());
return request.checkNotModified(lastModified)
.switchIfEmpty(Mono.defer(() ->
bodyBuilder.lastModified(lastModified)
.body(BodyInserters.fromResource(fsRes)))
);
} catch (IOException e) {
return Mono.error(e);
}
})
)
.orElseGet(() -> pluginService.generateJsBundleVersion()
.flatMap(v -> ServerResponse
.temporaryRedirect(buildJsBundleUri("css", v))
.build()
);
}
return pluginService.uglifyCssBundle()
.flatMap(bundle -> ServerResponse.ok()
.cacheControl(MAX_CACHE_CONTROL)
.contentType(MediaType.valueOf("text/css"))
.bodyValue(bundle)
)
);
}

Expand Down Expand Up @@ -353,7 +390,7 @@ private Mono<ServerResponse> updatePluginConfig(ServerRequest request) {
if (!configMapName.equals(configMapNameToUpdate)) {
throw new ServerWebInputException(
"The name from the request body does not match the plugin "
+ "configMapName name.");
+ "configMapName name.");
}
})
.flatMap(configMapToUpdate -> client.fetch(ConfigMap.class, configMapName)
Expand Down Expand Up @@ -482,7 +519,7 @@ public Boolean getEnabled() {
@ArraySchema(uniqueItems = true,
arraySchema = @Schema(name = "sort",
description = "Sort property and direction of the list result. Supported fields: "
+ "creationTimestamp"),
+ "creationTimestamp"),
schema = @Schema(description = "like field,asc or field,desc",
implementation = String.class,
example = "creationTimestamp,desc"))
Expand Down Expand Up @@ -633,4 +670,93 @@ private Mono<Path> writeToTempFile(Publisher<DataBuffer> content) {
.subscribeOn(this.scheduler);
}

@Component
static class BufferedPluginBundleResource implements DisposableBean {
private final Object jsBundleLock = new Object();
private final Object cssBundleLock = new Object();

private FileSystemResource jsBundleResource;
private FileSystemResource cssBundleResource;
private Path tempDir;

public FileSystemResource jsBundleResource(String v, Supplier<String> bundleSupplier) {
synchronized (jsBundleLock) {
var jsResource = writeAndGetBundleResource(jsBundleResource,
tempFileName(v, ".js"), bundleSupplier);
this.jsBundleResource = jsResource;
return jsResource;
}
}

public FileSystemResource cssBundleResource(String v, Supplier<String> bundleSupplier) {
synchronized (cssBundleLock) {
var cssResource = writeAndGetBundleResource(cssBundleResource,
tempFileName(v, ".css"), bundleSupplier);
this.cssBundleResource = cssResource;
return cssResource;
}
}

FileSystemResource writeAndGetBundleResource(FileSystemResource resource, String fileName,
Supplier<String> bundleSupplier) {
if (resourceDoesNotExist(resource)) {
return createAndWriteContent(fileName, bundleSupplier, null);
}
if (fileName.equals(resource.getFilename())) {
return resource;
}
return createAndWriteContent(fileName, bundleSupplier, resource);
}

FileSystemResource createAndWriteContent(String fileName, Supplier<String> bundleSupplier,
@Nullable FileSystemResource fileResource) {
try {
if (fileResource != null) {
Files.deleteIfExists(fileResource.getFile().toPath());
}
var filePath = generateStorePath(fileName);
var newResource = new FileSystemResource(filePath);

String content = defaultString(bundleSupplier.get());
Files.writeString(filePath, content, StandardCharsets.UTF_8);
return newResource;
} catch (IOException e) {
throw new ServerWebInputException("Failed to write bundle file.", null, e);
}
}

Path generateStorePath(String fileName) {
try {
if (tempDirDoesNotExist()) {
this.tempDir = Files.createTempDirectory("halo-plugin-bundle");
}
return Files.createFile(tempDir.resolve(fileName));
} catch (IOException e) {
throw new ServerWebInputException("Failed to create temp file.", null, e);
}
}

boolean tempDirDoesNotExist() {
return tempDir == null || !Files.exists(tempDir);
}

String tempFileName(String v, String suffix) {
Assert.notNull(v, "Version must not be null");
Assert.notNull(suffix, "Suffix must not be null");
return v + suffix;
}

boolean resourceDoesNotExist(Resource resource) {
return resource == null || !resource.exists();
}

@Override
public void destroy() throws Exception {
if (!tempDirDoesNotExist()) {
FileSystemUtils.deleteRecursively(tempDir);
}
this.jsBundleResource = null;
this.cssBundleResource = null;
}
}
}
36 changes: 32 additions & 4 deletions application/src/test/java/run/halo/app/core/extension/endpoint/PluginEndpointTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package run.halo.app.core.extension.endpoint;

import static java.util.Objects.requireNonNull;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyInt;
import static org.mockito.ArgumentMatchers.argThat;
Expand All @@ -16,6 +17,7 @@
import com.github.zafarkhaja.semver.Version;
import java.io.IOException;
import java.net.URISyntaxException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
Expand Down Expand Up @@ -130,8 +132,8 @@ void shouldFilterPluginsWhenKeywordProvided() {

verify(client).list(same(Plugin.class), argThat(
predicate -> predicate.test(expectPlugin)
&& !predicate.test(unexpectedPlugin1)
&& !predicate.test(unexpectedPlugin2)),
&& !predicate.test(unexpectedPlugin1)
&& !predicate.test(unexpectedPlugin2)),
any(), anyInt(), anyInt());
}

Expand All @@ -158,8 +160,8 @@ void shouldFilterPluginsWhenEnabledProvided() {

verify(client).list(same(Plugin.class), argThat(
predicate -> predicate.test(expectPlugin)
&& !predicate.test(unexpectedPlugin1)
&& !predicate.test(unexpectedPlugin2)),
&& !predicate.test(unexpectedPlugin1)
&& !predicate.test(unexpectedPlugin2)),
any(), anyInt(), anyInt());
}

Expand Down Expand Up @@ -382,4 +384,30 @@ Plugin createPlugin(String name, Instant creationTimestamp) {
plugin.setSpec(spec);
return plugin;
}

@Nested
class BufferedPluginBundleResourceTest {
private final PluginEndpoint.BufferedPluginBundleResource bufferedPluginBundleResource =
new PluginEndpoint.BufferedPluginBundleResource();

@Test
void writeAndGetResourceTest() throws IOException {
var resource =
bufferedPluginBundleResource.jsBundleResource("1", () -> "first line\nnext line");
var content = resource.getContentAsString(StandardCharsets.UTF_8);
assertThat(content).isEqualTo("first line\nnext line");

// version is matched, should return cached content
resource =
bufferedPluginBundleResource.jsBundleResource("1", () -> "first line\nnext line-1");
content = resource.getContentAsString(StandardCharsets.UTF_8);
assertThat(content).isEqualTo("first line\nnext line");

// new version should return new content
resource =
bufferedPluginBundleResource.jsBundleResource("2", () -> "first line\nnext line-2");
content = resource.getContentAsString(StandardCharsets.UTF_8);
assertThat(content).isEqualTo("first line\nnext line-2");
}
}
}