Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions app/build.gradle
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ buildscript {
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.mockitoVersion = '5.2.0'
ext.postgresVersion = '42.5.1'
ext.jooqVersion = '3.17.7'
ext.guiceVersion = '5.1.0'
Expand DownExpand Up@@ -33,6 +34,8 @@ version '1.0'
dependencies {
implementation "com.google.protobuf:protobuf-java:$protobufVersion"

implementation('org.glassfish.jersey.containers:jersey-container-servlet:3.1.0')

//jOOQ & Postgres impl deps
implementation "org.jooq:jooq:$jooqVersion"
implementation "org.jooq:jooq-meta:$jooqVersion"
Expand All@@ -42,7 +45,12 @@ dependencies {

implementation "com.google.inject:guice:$guiceVersion"

compileOnly 'org.projectlombok:lombok:1.18.24'
annotationProcessor 'org.projectlombok:lombok:1.18.24'

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testImplementation "org.junit.jupiter:junit-jupiter-params:$junitVersion"
testImplementation "org.mockito:mockito-core:$mockitoVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:2.2"
testImplementation "org.testcontainers:junit-jupiter:1.17.6"
Expand Down
10 changes: 10 additions & 0 deletions app/src/main/java/org/vss/VSSApplication.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
package org.vss;

import jakarta.ws.rs.ApplicationPath;
import org.glassfish.jersey.server.ResourceConfig;

@ApplicationPath("/")
public class VSSApplication extends ResourceConfig {
public VSSApplication() {
}
}
48 changes: 48 additions & 0 deletions app/src/main/java/org/vss/api/AbstractVssApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
package org.vss.api;

import com.google.protobuf.GeneratedMessageV3;
import com.google.protobuf.InvalidProtocolBufferException;
import jakarta.inject.Inject;
import jakarta.ws.rs.core.Response;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.KVStore;
import org.vss.exception.ConflictException;

public abstract class AbstractVssApi {
final KVStore kvStore;

@Inject
public AbstractVssApi(KVStore kvStore) {
this.kvStore = kvStore;
}

Response toResponse(GeneratedMessageV3 protoResponse) {

return Response
.status(Response.Status.OK)
.entity(protoResponse.toByteArray())
.build();
}

Response toErrorResponse(Exception e) {
ErrorCode errorCode;
if (e instanceof ConflictException) {
errorCode = ErrorCode.CONFLICT_EXCEPTION;
} else if (e instanceof IllegalArgumentException
|| e instanceof InvalidProtocolBufferException) {
errorCode = ErrorCode.INVALID_REQUEST_EXCEPTION;
} else {
errorCode = ErrorCode.INTERNAL_SERVER_EXCEPTION;
}

ErrorResponse errorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage(e.getMessage())
.build();

return Response.status(errorCode.getNumber())
.entity(errorResponse.toByteArray())
.build();
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/GetObjectApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;

@Path(VssApiEndpoint.GET_OBJECT)
@Slf4j
public class GetObjectApi extends AbstractVssApi {

@Inject
public GetObjectApi(KVStore kvstore) {
super(kvstore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
GetObjectRequest request = GetObjectRequest.parseFrom(payload);
GetObjectResponse response = kvStore.get(request);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in GetObjectApi: ", e);
return toErrorResponse(e);
}
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/ListKeyVersionsApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.KVStore;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;

@Path(VssApiEndpoint.LIST_KEY_VERSIONS)
@Slf4j
public class ListKeyVersionsApi extends AbstractVssApi {

@Inject
public ListKeyVersionsApi(KVStore kvStore) {
super(kvStore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
ListKeyVersionsRequest request = ListKeyVersionsRequest.parseFrom(payload);
ListKeyVersionsResponse response = kvStore.listKeyVersions(request);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in ListKeyVersionsApi: ", e);
return toErrorResponse(e);
}
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/PutObjectsApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.KVStore;
import org.vss.PutObjectRequest;
import org.vss.PutObjectResponse;

@Path(VssApiEndpoint.PUT_OBJECTS)
@Slf4j
public class PutObjectsApi extends AbstractVssApi {

@Inject
public PutObjectsApi(KVStore kvStore) {
super(kvStore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
PutObjectRequest putObjectRequest = PutObjectRequest.parseFrom(payload);
PutObjectResponse response = kvStore.put(putObjectRequest);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in PutObjectsApi: ", e);
return toErrorResponse(e);
}
}
}
7 changes: 7 additions & 0 deletions app/src/main/java/org/vss/api/VssApiEndpoint.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
package org.vss.api;

public class VssApiEndpoint {
public static final String GET_OBJECT = "/getObject";
public static final String PUT_OBJECTS = "/putObjects";
public static final String LIST_KEY_VERSIONS = "/listKeyVersions";
}
86 changes: 86 additions & 0 deletions app/src/test/java/org/vss/api/GetObjectApiTest.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
package org.vss.api;

import com.google.protobuf.ByteString;
import jakarta.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.exception.ConflictException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

class GetObjectApiTest {
private GetObjectApi getObjectApi;
private KVStore mockKVStore;

private static String TEST_STORE_ID = "storeId";
private static String TEST_KEY = "key";
private static KeyValue TEST_KV = KeyValue.newBuilder().setKey(TEST_KEY).setValue(
ByteString.copyFrom("test_value", StandardCharsets.UTF_8)).build();

@BeforeEach
void setUp() {
mockKVStore = mock(KVStore.class);
getObjectApi = new GetObjectApi(mockKVStore);
}

@Test
void execute_ValidPayload_ReturnsResponse() {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

i tried creating a common base testcase but it was more complex and less readable since many api specific calls are interleaved.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

these are the abstract methods a sub-test would have had to implement in that case, and it seemed difficult to understand test-case.

 abstract void beforeEachSetup();
abstract void verifyAfterTest();
abstract GeneratedMessageV3 createExpectedRequest();
abstract GeneratedMessageV3 createExpectedResponse();
abstract Response executeValidRequest();
abstract Response executeErroringRequest(Class<? extends Exception> exceptionClass)
throws Exception;

GetObjectRequest expectedRequest =
GetObjectRequest.newBuilder().setStoreId(TEST_STORE_ID).setKey(TEST_KEY).build();
byte[] payload = expectedRequest.toByteArray();
GetObjectResponse mockResponse = GetObjectResponse.newBuilder().setValue(TEST_KV).build();
when(mockKVStore.get(expectedRequest)).thenReturn(mockResponse);

Response actualResponse = getObjectApi.execute(payload);

assertThat(actualResponse.getStatus(), is(Response.Status.OK.getStatusCode()));
assertThat(actualResponse.getEntity(), is(mockResponse.toByteArray()));
verify(mockKVStore).get(expectedRequest);
}

@ParameterizedTest
@MethodSource("provideErrorTestCases")
void execute_InvalidPayload_ReturnsErrorResponse(Exception exception,
ErrorCode errorCode) {
GetObjectRequest expectedRequest = GetObjectRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKey(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
when(mockKVStore.get(any())).thenThrow(exception);

Response response = getObjectApi.execute(payload);

ErrorResponse expectedErrorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage("")
.build();
assertThat(response.getEntity(), is(expectedErrorResponse.toByteArray()));
assertThat(response.getStatus(), is(expectedErrorResponse.getErrorCode().getNumber()));
verify(mockKVStore).get(expectedRequest);
}

private static Stream<Arguments> provideErrorTestCases() {
return Stream.of(
Arguments.of(new ConflictException(""), ErrorCode.CONFLICT_EXCEPTION),
Arguments.of(new IllegalArgumentException(""), ErrorCode.INVALID_REQUEST_EXCEPTION),
Arguments.of(new RuntimeException(""), ErrorCode.INTERNAL_SERVER_EXCEPTION)
);
}
}
92 changes: 92 additions & 0 deletions app/src/test/java/org/vss/api/ListKeyVersionsApiTest.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
package org.vss.api;

import com.google.protobuf.ByteString;
import jakarta.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;
import org.vss.exception.ConflictException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

public class ListKeyVersionsApiTest {
private ListKeyVersionsApi listKeyVersionsApi;
private KVStore mockKVStore;

private static String TEST_STORE_ID = "storeId";
private static String TEST_KEY = "key";
private static KeyValue TEST_KV = KeyValue.newBuilder().setKey(TEST_KEY).setValue(
ByteString.copyFrom("test_value", StandardCharsets.UTF_8)).build();

@BeforeEach
void setUp() {
mockKVStore = mock(KVStore.class);
listKeyVersionsApi = new ListKeyVersionsApi(mockKVStore);
}

@Test
void execute_ValidPayload_ReturnsResponse() {
ListKeyVersionsRequest expectedRequest =
ListKeyVersionsRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKeyPrefix(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
ListKeyVersionsResponse mockResponse = ListKeyVersionsResponse.newBuilder().addAllKeyVersions(
List.of(TEST_KV)).build();
when(mockKVStore.listKeyVersions(expectedRequest)).thenReturn(mockResponse);

Response actualResponse = listKeyVersionsApi.execute(payload);

assertThat(actualResponse.getStatus(), is(Response.Status.OK.getStatusCode()));
assertThat(actualResponse.getEntity(), is(mockResponse.toByteArray()));
verify(mockKVStore).listKeyVersions(expectedRequest);
}

@ParameterizedTest
@MethodSource("provideErrorTestCases")
void execute_InvalidPayload_ReturnsErrorResponse(Exception exception,
ErrorCode errorCode) {
ListKeyVersionsRequest expectedRequest =
ListKeyVersionsRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKeyPrefix(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
when(mockKVStore.listKeyVersions(any())).thenThrow(exception);

Response response = listKeyVersionsApi.execute(payload);

ErrorResponse expectedErrorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage("")
.build();
assertThat(response.getEntity(), is(expectedErrorResponse.toByteArray()));
assertThat(response.getStatus(), is(expectedErrorResponse.getErrorCode().getNumber()));
verify(mockKVStore).listKeyVersions(expectedRequest);
}

private static Stream<Arguments> provideErrorTestCases() {
return Stream.of(
Arguments.of(new ConflictException(""), ErrorCode.CONFLICT_EXCEPTION),
Arguments.of(new IllegalArgumentException(""), ErrorCode.INVALID_REQUEST_EXCEPTION),
Arguments.of(new RuntimeException(""), ErrorCode.INTERNAL_SERVER_EXCEPTION)
);
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions app/build.gradle
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ buildscript {
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.mockitoVersion = '5.2.0'
ext.postgresVersion = '42.5.1'
ext.jooqVersion = '3.17.7'
ext.guiceVersion = '5.1.0'
Expand DownExpand Up@@ -33,6 +34,8 @@ version '1.0'
dependencies {
implementation "com.google.protobuf:protobuf-java:$protobufVersion"

implementation('org.glassfish.jersey.containers:jersey-container-servlet:3.1.0')

//jOOQ & Postgres impl deps
implementation "org.jooq:jooq:$jooqVersion"
implementation "org.jooq:jooq-meta:$jooqVersion"
Expand All@@ -42,7 +45,12 @@ dependencies {

implementation "com.google.inject:guice:$guiceVersion"

compileOnly 'org.projectlombok:lombok:1.18.24'
annotationProcessor 'org.projectlombok:lombok:1.18.24'

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testImplementation "org.junit.jupiter:junit-jupiter-params:$junitVersion"
testImplementation "org.mockito:mockito-core:$mockitoVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:2.2"
testImplementation "org.testcontainers:junit-jupiter:1.17.6"
Expand Down
10 changes: 10 additions & 0 deletions app/src/main/java/org/vss/VSSApplication.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
package org.vss;

import jakarta.ws.rs.ApplicationPath;
import org.glassfish.jersey.server.ResourceConfig;

@ApplicationPath("/")
public class VSSApplication extends ResourceConfig {
public VSSApplication() {
}
}
48 changes: 48 additions & 0 deletions app/src/main/java/org/vss/api/AbstractVssApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
package org.vss.api;

import com.google.protobuf.GeneratedMessageV3;
import com.google.protobuf.InvalidProtocolBufferException;
import jakarta.inject.Inject;
import jakarta.ws.rs.core.Response;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.KVStore;
import org.vss.exception.ConflictException;

public abstract class AbstractVssApi {
final KVStore kvStore;

@Inject
public AbstractVssApi(KVStore kvStore) {
this.kvStore = kvStore;
}

Response toResponse(GeneratedMessageV3 protoResponse) {

return Response
.status(Response.Status.OK)
.entity(protoResponse.toByteArray())
.build();
}

Response toErrorResponse(Exception e) {
ErrorCode errorCode;
if (e instanceof ConflictException) {
errorCode = ErrorCode.CONFLICT_EXCEPTION;
} else if (e instanceof IllegalArgumentException
|| e instanceof InvalidProtocolBufferException) {
errorCode = ErrorCode.INVALID_REQUEST_EXCEPTION;
} else {
errorCode = ErrorCode.INTERNAL_SERVER_EXCEPTION;
}

ErrorResponse errorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage(e.getMessage())
.build();

return Response.status(errorCode.getNumber())
.entity(errorResponse.toByteArray())
.build();
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/GetObjectApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;

@Path(VssApiEndpoint.GET_OBJECT)
@Slf4j
public class GetObjectApi extends AbstractVssApi {

@Inject
public GetObjectApi(KVStore kvstore) {
super(kvstore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
GetObjectRequest request = GetObjectRequest.parseFrom(payload);
GetObjectResponse response = kvStore.get(request);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in GetObjectApi: ", e);
return toErrorResponse(e);
}
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/ListKeyVersionsApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.KVStore;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;

@Path(VssApiEndpoint.LIST_KEY_VERSIONS)
@Slf4j
public class ListKeyVersionsApi extends AbstractVssApi {

@Inject
public ListKeyVersionsApi(KVStore kvStore) {
super(kvStore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
ListKeyVersionsRequest request = ListKeyVersionsRequest.parseFrom(payload);
ListKeyVersionsResponse response = kvStore.listKeyVersions(request);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in ListKeyVersionsApi: ", e);
return toErrorResponse(e);
}
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/PutObjectsApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.KVStore;
import org.vss.PutObjectRequest;
import org.vss.PutObjectResponse;

@Path(VssApiEndpoint.PUT_OBJECTS)
@Slf4j
public class PutObjectsApi extends AbstractVssApi {

@Inject
public PutObjectsApi(KVStore kvStore) {
super(kvStore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
PutObjectRequest putObjectRequest = PutObjectRequest.parseFrom(payload);
PutObjectResponse response = kvStore.put(putObjectRequest);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in PutObjectsApi: ", e);
return toErrorResponse(e);
}
}
}
7 changes: 7 additions & 0 deletions app/src/main/java/org/vss/api/VssApiEndpoint.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
package org.vss.api;

public class VssApiEndpoint {
public static final String GET_OBJECT = "/getObject";
public static final String PUT_OBJECTS = "/putObjects";
public static final String LIST_KEY_VERSIONS = "/listKeyVersions";
}
86 changes: 86 additions & 0 deletions app/src/test/java/org/vss/api/GetObjectApiTest.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
package org.vss.api;

import com.google.protobuf.ByteString;
import jakarta.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.exception.ConflictException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

class GetObjectApiTest {
private GetObjectApi getObjectApi;
private KVStore mockKVStore;

private static String TEST_STORE_ID = "storeId";
private static String TEST_KEY = "key";
private static KeyValue TEST_KV = KeyValue.newBuilder().setKey(TEST_KEY).setValue(
ByteString.copyFrom("test_value", StandardCharsets.UTF_8)).build();

@BeforeEach
void setUp() {
mockKVStore = mock(KVStore.class);
getObjectApi = new GetObjectApi(mockKVStore);
}

@Test
void execute_ValidPayload_ReturnsResponse() {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

i tried creating a common base testcase but it was more complex and less readable since many api specific calls are interleaved.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

these are the abstract methods a sub-test would have had to implement in that case, and it seemed difficult to understand test-case.

 abstract void beforeEachSetup();
abstract void verifyAfterTest();
abstract GeneratedMessageV3 createExpectedRequest();
abstract GeneratedMessageV3 createExpectedResponse();
abstract Response executeValidRequest();
abstract Response executeErroringRequest(Class<? extends Exception> exceptionClass)
throws Exception;

GetObjectRequest expectedRequest =
GetObjectRequest.newBuilder().setStoreId(TEST_STORE_ID).setKey(TEST_KEY).build();
byte[] payload = expectedRequest.toByteArray();
GetObjectResponse mockResponse = GetObjectResponse.newBuilder().setValue(TEST_KV).build();
when(mockKVStore.get(expectedRequest)).thenReturn(mockResponse);

Response actualResponse = getObjectApi.execute(payload);

assertThat(actualResponse.getStatus(), is(Response.Status.OK.getStatusCode()));
assertThat(actualResponse.getEntity(), is(mockResponse.toByteArray()));
verify(mockKVStore).get(expectedRequest);
}

@ParameterizedTest
@MethodSource("provideErrorTestCases")
void execute_InvalidPayload_ReturnsErrorResponse(Exception exception,
ErrorCode errorCode) {
GetObjectRequest expectedRequest = GetObjectRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKey(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
when(mockKVStore.get(any())).thenThrow(exception);

Response response = getObjectApi.execute(payload);

ErrorResponse expectedErrorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage("")
.build();
assertThat(response.getEntity(), is(expectedErrorResponse.toByteArray()));
assertThat(response.getStatus(), is(expectedErrorResponse.getErrorCode().getNumber()));
verify(mockKVStore).get(expectedRequest);
}

private static Stream<Arguments> provideErrorTestCases() {
return Stream.of(
Arguments.of(new ConflictException(""), ErrorCode.CONFLICT_EXCEPTION),
Arguments.of(new IllegalArgumentException(""), ErrorCode.INVALID_REQUEST_EXCEPTION),
Arguments.of(new RuntimeException(""), ErrorCode.INTERNAL_SERVER_EXCEPTION)
);
}
}
92 changes: 92 additions & 0 deletions app/src/test/java/org/vss/api/ListKeyVersionsApiTest.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
package org.vss.api;

import com.google.protobuf.ByteString;
import jakarta.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;
import org.vss.exception.ConflictException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

public class ListKeyVersionsApiTest {
private ListKeyVersionsApi listKeyVersionsApi;
private KVStore mockKVStore;

private static String TEST_STORE_ID = "storeId";
private static String TEST_KEY = "key";
private static KeyValue TEST_KV = KeyValue.newBuilder().setKey(TEST_KEY).setValue(
ByteString.copyFrom("test_value", StandardCharsets.UTF_8)).build();

@BeforeEach
void setUp() {
mockKVStore = mock(KVStore.class);
listKeyVersionsApi = new ListKeyVersionsApi(mockKVStore);
}

@Test
void execute_ValidPayload_ReturnsResponse() {
ListKeyVersionsRequest expectedRequest =
ListKeyVersionsRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKeyPrefix(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
ListKeyVersionsResponse mockResponse = ListKeyVersionsResponse.newBuilder().addAllKeyVersions(
List.of(TEST_KV)).build();
when(mockKVStore.listKeyVersions(expectedRequest)).thenReturn(mockResponse);

Response actualResponse = listKeyVersionsApi.execute(payload);

assertThat(actualResponse.getStatus(), is(Response.Status.OK.getStatusCode()));
assertThat(actualResponse.getEntity(), is(mockResponse.toByteArray()));
verify(mockKVStore).listKeyVersions(expectedRequest);
}

@ParameterizedTest
@MethodSource("provideErrorTestCases")
void execute_InvalidPayload_ReturnsErrorResponse(Exception exception,
ErrorCode errorCode) {
ListKeyVersionsRequest expectedRequest =
ListKeyVersionsRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKeyPrefix(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
when(mockKVStore.listKeyVersions(any())).thenThrow(exception);

Response response = listKeyVersionsApi.execute(payload);

ErrorResponse expectedErrorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage("")
.build();
assertThat(response.getEntity(), is(expectedErrorResponse.toByteArray()));
assertThat(response.getStatus(), is(expectedErrorResponse.getErrorCode().getNumber()));
verify(mockKVStore).listKeyVersions(expectedRequest);
}

private static Stream<Arguments> provideErrorTestCases() {
return Stream.of(
Arguments.of(new ConflictException(""), ErrorCode.CONFLICT_EXCEPTION),
Arguments.of(new IllegalArgumentException(""), ErrorCode.INVALID_REQUEST_EXCEPTION),
Arguments.of(new RuntimeException(""), ErrorCode.INTERNAL_SERVER_EXCEPTION)
);
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions app/build.gradle
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ buildscript {
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.mockitoVersion = '5.2.0'
ext.postgresVersion = '42.5.1'
ext.jooqVersion = '3.17.7'
ext.guiceVersion = '5.1.0'
Expand DownExpand Up@@ -33,6 +34,8 @@ version '1.0'
dependencies {
implementation "com.google.protobuf:protobuf-java:$protobufVersion"

implementation('org.glassfish.jersey.containers:jersey-container-servlet:3.1.0')

//jOOQ & Postgres impl deps
implementation "org.jooq:jooq:$jooqVersion"
implementation "org.jooq:jooq-meta:$jooqVersion"
Expand All@@ -42,7 +45,12 @@ dependencies {

implementation "com.google.inject:guice:$guiceVersion"

compileOnly 'org.projectlombok:lombok:1.18.24'
annotationProcessor 'org.projectlombok:lombok:1.18.24'

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testImplementation "org.junit.jupiter:junit-jupiter-params:$junitVersion"
testImplementation "org.mockito:mockito-core:$mockitoVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:2.2"
testImplementation "org.testcontainers:junit-jupiter:1.17.6"
Expand Down
10 changes: 10 additions & 0 deletions app/src/main/java/org/vss/VSSApplication.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
package org.vss;

import jakarta.ws.rs.ApplicationPath;
import org.glassfish.jersey.server.ResourceConfig;

@ApplicationPath("/")
public class VSSApplication extends ResourceConfig {
public VSSApplication() {
}
}
48 changes: 48 additions & 0 deletions app/src/main/java/org/vss/api/AbstractVssApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
package org.vss.api;

import com.google.protobuf.GeneratedMessageV3;
import com.google.protobuf.InvalidProtocolBufferException;
import jakarta.inject.Inject;
import jakarta.ws.rs.core.Response;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.KVStore;
import org.vss.exception.ConflictException;

public abstract class AbstractVssApi {
final KVStore kvStore;

@Inject
public AbstractVssApi(KVStore kvStore) {
this.kvStore = kvStore;
}

Response toResponse(GeneratedMessageV3 protoResponse) {

return Response
.status(Response.Status.OK)
.entity(protoResponse.toByteArray())
.build();
}

Response toErrorResponse(Exception e) {
ErrorCode errorCode;
if (e instanceof ConflictException) {
errorCode = ErrorCode.CONFLICT_EXCEPTION;
} else if (e instanceof IllegalArgumentException
|| e instanceof InvalidProtocolBufferException) {
errorCode = ErrorCode.INVALID_REQUEST_EXCEPTION;
} else {
errorCode = ErrorCode.INTERNAL_SERVER_EXCEPTION;
}

ErrorResponse errorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage(e.getMessage())
.build();

return Response.status(errorCode.getNumber())
.entity(errorResponse.toByteArray())
.build();
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/GetObjectApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;

@Path(VssApiEndpoint.GET_OBJECT)
@Slf4j
public class GetObjectApi extends AbstractVssApi {

@Inject
public GetObjectApi(KVStore kvstore) {
super(kvstore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
GetObjectRequest request = GetObjectRequest.parseFrom(payload);
GetObjectResponse response = kvStore.get(request);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in GetObjectApi: ", e);
return toErrorResponse(e);
}
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/ListKeyVersionsApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.KVStore;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;

@Path(VssApiEndpoint.LIST_KEY_VERSIONS)
@Slf4j
public class ListKeyVersionsApi extends AbstractVssApi {

@Inject
public ListKeyVersionsApi(KVStore kvStore) {
super(kvStore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
ListKeyVersionsRequest request = ListKeyVersionsRequest.parseFrom(payload);
ListKeyVersionsResponse response = kvStore.listKeyVersions(request);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in ListKeyVersionsApi: ", e);
return toErrorResponse(e);
}
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/PutObjectsApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.KVStore;
import org.vss.PutObjectRequest;
import org.vss.PutObjectResponse;

@Path(VssApiEndpoint.PUT_OBJECTS)
@Slf4j
public class PutObjectsApi extends AbstractVssApi {

@Inject
public PutObjectsApi(KVStore kvStore) {
super(kvStore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
PutObjectRequest putObjectRequest = PutObjectRequest.parseFrom(payload);
PutObjectResponse response = kvStore.put(putObjectRequest);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in PutObjectsApi: ", e);
return toErrorResponse(e);
}
}
}
7 changes: 7 additions & 0 deletions app/src/main/java/org/vss/api/VssApiEndpoint.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
package org.vss.api;

public class VssApiEndpoint {
public static final String GET_OBJECT = "/getObject";
public static final String PUT_OBJECTS = "/putObjects";
public static final String LIST_KEY_VERSIONS = "/listKeyVersions";
}
86 changes: 86 additions & 0 deletions app/src/test/java/org/vss/api/GetObjectApiTest.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
package org.vss.api;

import com.google.protobuf.ByteString;
import jakarta.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.exception.ConflictException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

class GetObjectApiTest {
private GetObjectApi getObjectApi;
private KVStore mockKVStore;

private static String TEST_STORE_ID = "storeId";
private static String TEST_KEY = "key";
private static KeyValue TEST_KV = KeyValue.newBuilder().setKey(TEST_KEY).setValue(
ByteString.copyFrom("test_value", StandardCharsets.UTF_8)).build();

@BeforeEach
void setUp() {
mockKVStore = mock(KVStore.class);
getObjectApi = new GetObjectApi(mockKVStore);
}

@Test
void execute_ValidPayload_ReturnsResponse() {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

i tried creating a common base testcase but it was more complex and less readable since many api specific calls are interleaved.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

these are the abstract methods a sub-test would have had to implement in that case, and it seemed difficult to understand test-case.

 abstract void beforeEachSetup();
abstract void verifyAfterTest();
abstract GeneratedMessageV3 createExpectedRequest();
abstract GeneratedMessageV3 createExpectedResponse();
abstract Response executeValidRequest();
abstract Response executeErroringRequest(Class<? extends Exception> exceptionClass)
throws Exception;

GetObjectRequest expectedRequest =
GetObjectRequest.newBuilder().setStoreId(TEST_STORE_ID).setKey(TEST_KEY).build();
byte[] payload = expectedRequest.toByteArray();
GetObjectResponse mockResponse = GetObjectResponse.newBuilder().setValue(TEST_KV).build();
when(mockKVStore.get(expectedRequest)).thenReturn(mockResponse);

Response actualResponse = getObjectApi.execute(payload);

assertThat(actualResponse.getStatus(), is(Response.Status.OK.getStatusCode()));
assertThat(actualResponse.getEntity(), is(mockResponse.toByteArray()));
verify(mockKVStore).get(expectedRequest);
}

@ParameterizedTest
@MethodSource("provideErrorTestCases")
void execute_InvalidPayload_ReturnsErrorResponse(Exception exception,
ErrorCode errorCode) {
GetObjectRequest expectedRequest = GetObjectRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKey(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
when(mockKVStore.get(any())).thenThrow(exception);

Response response = getObjectApi.execute(payload);

ErrorResponse expectedErrorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage("")
.build();
assertThat(response.getEntity(), is(expectedErrorResponse.toByteArray()));
assertThat(response.getStatus(), is(expectedErrorResponse.getErrorCode().getNumber()));
verify(mockKVStore).get(expectedRequest);
}

private static Stream<Arguments> provideErrorTestCases() {
return Stream.of(
Arguments.of(new ConflictException(""), ErrorCode.CONFLICT_EXCEPTION),
Arguments.of(new IllegalArgumentException(""), ErrorCode.INVALID_REQUEST_EXCEPTION),
Arguments.of(new RuntimeException(""), ErrorCode.INTERNAL_SERVER_EXCEPTION)
);
}
}
92 changes: 92 additions & 0 deletions app/src/test/java/org/vss/api/ListKeyVersionsApiTest.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
package org.vss.api;

import com.google.protobuf.ByteString;
import jakarta.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;
import org.vss.exception.ConflictException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

public class ListKeyVersionsApiTest {
private ListKeyVersionsApi listKeyVersionsApi;
private KVStore mockKVStore;

private static String TEST_STORE_ID = "storeId";
private static String TEST_KEY = "key";
private static KeyValue TEST_KV = KeyValue.newBuilder().setKey(TEST_KEY).setValue(
ByteString.copyFrom("test_value", StandardCharsets.UTF_8)).build();

@BeforeEach
void setUp() {
mockKVStore = mock(KVStore.class);
listKeyVersionsApi = new ListKeyVersionsApi(mockKVStore);
}

@Test
void execute_ValidPayload_ReturnsResponse() {
ListKeyVersionsRequest expectedRequest =
ListKeyVersionsRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKeyPrefix(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
ListKeyVersionsResponse mockResponse = ListKeyVersionsResponse.newBuilder().addAllKeyVersions(
List.of(TEST_KV)).build();
when(mockKVStore.listKeyVersions(expectedRequest)).thenReturn(mockResponse);

Response actualResponse = listKeyVersionsApi.execute(payload);

assertThat(actualResponse.getStatus(), is(Response.Status.OK.getStatusCode()));
assertThat(actualResponse.getEntity(), is(mockResponse.toByteArray()));
verify(mockKVStore).listKeyVersions(expectedRequest);
}

@ParameterizedTest
@MethodSource("provideErrorTestCases")
void execute_InvalidPayload_ReturnsErrorResponse(Exception exception,
ErrorCode errorCode) {
ListKeyVersionsRequest expectedRequest =
ListKeyVersionsRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKeyPrefix(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
when(mockKVStore.listKeyVersions(any())).thenThrow(exception);

Response response = listKeyVersionsApi.execute(payload);

ErrorResponse expectedErrorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage("")
.build();
assertThat(response.getEntity(), is(expectedErrorResponse.toByteArray()));
assertThat(response.getStatus(), is(expectedErrorResponse.getErrorCode().getNumber()));
verify(mockKVStore).listKeyVersions(expectedRequest);
}

private static Stream<Arguments> provideErrorTestCases() {
return Stream.of(
Arguments.of(new ConflictException(""), ErrorCode.CONFLICT_EXCEPTION),
Arguments.of(new IllegalArgumentException(""), ErrorCode.INVALID_REQUEST_EXCEPTION),
Arguments.of(new RuntimeException(""), ErrorCode.INTERNAL_SERVER_EXCEPTION)
);
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions app/build.gradle
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ buildscript {
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.mockitoVersion = '5.2.0'
ext.postgresVersion = '42.5.1'
ext.jooqVersion = '3.17.7'
ext.guiceVersion = '5.1.0'
Expand DownExpand Up@@ -33,6 +34,8 @@ version '1.0'
dependencies {
implementation "com.google.protobuf:protobuf-java:$protobufVersion"

implementation('org.glassfish.jersey.containers:jersey-container-servlet:3.1.0')

//jOOQ & Postgres impl deps
implementation "org.jooq:jooq:$jooqVersion"
implementation "org.jooq:jooq-meta:$jooqVersion"
Expand All@@ -42,7 +45,12 @@ dependencies {

implementation "com.google.inject:guice:$guiceVersion"

compileOnly 'org.projectlombok:lombok:1.18.24'
annotationProcessor 'org.projectlombok:lombok:1.18.24'

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testImplementation "org.junit.jupiter:junit-jupiter-params:$junitVersion"
testImplementation "org.mockito:mockito-core:$mockitoVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:2.2"
testImplementation "org.testcontainers:junit-jupiter:1.17.6"
Expand Down
10 changes: 10 additions & 0 deletions app/src/main/java/org/vss/VSSApplication.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
package org.vss;

import jakarta.ws.rs.ApplicationPath;
import org.glassfish.jersey.server.ResourceConfig;

@ApplicationPath("/")
public class VSSApplication extends ResourceConfig {
public VSSApplication() {
}
}
48 changes: 48 additions & 0 deletions app/src/main/java/org/vss/api/AbstractVssApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
package org.vss.api;

import com.google.protobuf.GeneratedMessageV3;
import com.google.protobuf.InvalidProtocolBufferException;
import jakarta.inject.Inject;
import jakarta.ws.rs.core.Response;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.KVStore;
import org.vss.exception.ConflictException;

public abstract class AbstractVssApi {
final KVStore kvStore;

@Inject
public AbstractVssApi(KVStore kvStore) {
this.kvStore = kvStore;
}

Response toResponse(GeneratedMessageV3 protoResponse) {

return Response
.status(Response.Status.OK)
.entity(protoResponse.toByteArray())
.build();
}

Response toErrorResponse(Exception e) {
ErrorCode errorCode;
if (e instanceof ConflictException) {
errorCode = ErrorCode.CONFLICT_EXCEPTION;
} else if (e instanceof IllegalArgumentException
|| e instanceof InvalidProtocolBufferException) {
errorCode = ErrorCode.INVALID_REQUEST_EXCEPTION;
} else {
errorCode = ErrorCode.INTERNAL_SERVER_EXCEPTION;
}

ErrorResponse errorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage(e.getMessage())
.build();

return Response.status(errorCode.getNumber())
.entity(errorResponse.toByteArray())
.build();
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/GetObjectApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;

@Path(VssApiEndpoint.GET_OBJECT)
@Slf4j
public class GetObjectApi extends AbstractVssApi {

@Inject
public GetObjectApi(KVStore kvstore) {
super(kvstore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
GetObjectRequest request = GetObjectRequest.parseFrom(payload);
GetObjectResponse response = kvStore.get(request);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in GetObjectApi: ", e);
return toErrorResponse(e);
}
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/ListKeyVersionsApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.KVStore;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;

@Path(VssApiEndpoint.LIST_KEY_VERSIONS)
@Slf4j
public class ListKeyVersionsApi extends AbstractVssApi {

@Inject
public ListKeyVersionsApi(KVStore kvStore) {
super(kvStore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
ListKeyVersionsRequest request = ListKeyVersionsRequest.parseFrom(payload);
ListKeyVersionsResponse response = kvStore.listKeyVersions(request);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in ListKeyVersionsApi: ", e);
return toErrorResponse(e);
}
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/PutObjectsApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.KVStore;
import org.vss.PutObjectRequest;
import org.vss.PutObjectResponse;

@Path(VssApiEndpoint.PUT_OBJECTS)
@Slf4j
public class PutObjectsApi extends AbstractVssApi {

@Inject
public PutObjectsApi(KVStore kvStore) {
super(kvStore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
PutObjectRequest putObjectRequest = PutObjectRequest.parseFrom(payload);
PutObjectResponse response = kvStore.put(putObjectRequest);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in PutObjectsApi: ", e);
return toErrorResponse(e);
}
}
}
7 changes: 7 additions & 0 deletions app/src/main/java/org/vss/api/VssApiEndpoint.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
package org.vss.api;

public class VssApiEndpoint {
public static final String GET_OBJECT = "/getObject";
public static final String PUT_OBJECTS = "/putObjects";
public static final String LIST_KEY_VERSIONS = "/listKeyVersions";
}
86 changes: 86 additions & 0 deletions app/src/test/java/org/vss/api/GetObjectApiTest.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
package org.vss.api;

import com.google.protobuf.ByteString;
import jakarta.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.exception.ConflictException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

class GetObjectApiTest {
private GetObjectApi getObjectApi;
private KVStore mockKVStore;

private static String TEST_STORE_ID = "storeId";
private static String TEST_KEY = "key";
private static KeyValue TEST_KV = KeyValue.newBuilder().setKey(TEST_KEY).setValue(
ByteString.copyFrom("test_value", StandardCharsets.UTF_8)).build();

@BeforeEach
void setUp() {
mockKVStore = mock(KVStore.class);
getObjectApi = new GetObjectApi(mockKVStore);
}

@Test
void execute_ValidPayload_ReturnsResponse() {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

i tried creating a common base testcase but it was more complex and less readable since many api specific calls are interleaved.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

these are the abstract methods a sub-test would have had to implement in that case, and it seemed difficult to understand test-case.

 abstract void beforeEachSetup();
abstract void verifyAfterTest();
abstract GeneratedMessageV3 createExpectedRequest();
abstract GeneratedMessageV3 createExpectedResponse();
abstract Response executeValidRequest();
abstract Response executeErroringRequest(Class<? extends Exception> exceptionClass)
throws Exception;

GetObjectRequest expectedRequest =
GetObjectRequest.newBuilder().setStoreId(TEST_STORE_ID).setKey(TEST_KEY).build();
byte[] payload = expectedRequest.toByteArray();
GetObjectResponse mockResponse = GetObjectResponse.newBuilder().setValue(TEST_KV).build();
when(mockKVStore.get(expectedRequest)).thenReturn(mockResponse);

Response actualResponse = getObjectApi.execute(payload);

assertThat(actualResponse.getStatus(), is(Response.Status.OK.getStatusCode()));
assertThat(actualResponse.getEntity(), is(mockResponse.toByteArray()));
verify(mockKVStore).get(expectedRequest);
}

@ParameterizedTest
@MethodSource("provideErrorTestCases")
void execute_InvalidPayload_ReturnsErrorResponse(Exception exception,
ErrorCode errorCode) {
GetObjectRequest expectedRequest = GetObjectRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKey(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
when(mockKVStore.get(any())).thenThrow(exception);

Response response = getObjectApi.execute(payload);

ErrorResponse expectedErrorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage("")
.build();
assertThat(response.getEntity(), is(expectedErrorResponse.toByteArray()));
assertThat(response.getStatus(), is(expectedErrorResponse.getErrorCode().getNumber()));
verify(mockKVStore).get(expectedRequest);
}

private static Stream<Arguments> provideErrorTestCases() {
return Stream.of(
Arguments.of(new ConflictException(""), ErrorCode.CONFLICT_EXCEPTION),
Arguments.of(new IllegalArgumentException(""), ErrorCode.INVALID_REQUEST_EXCEPTION),
Arguments.of(new RuntimeException(""), ErrorCode.INTERNAL_SERVER_EXCEPTION)
);
}
}
92 changes: 92 additions & 0 deletions app/src/test/java/org/vss/api/ListKeyVersionsApiTest.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
package org.vss.api;

import com.google.protobuf.ByteString;
import jakarta.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;
import org.vss.exception.ConflictException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

public class ListKeyVersionsApiTest {
private ListKeyVersionsApi listKeyVersionsApi;
private KVStore mockKVStore;

private static String TEST_STORE_ID = "storeId";
private static String TEST_KEY = "key";
private static KeyValue TEST_KV = KeyValue.newBuilder().setKey(TEST_KEY).setValue(
ByteString.copyFrom("test_value", StandardCharsets.UTF_8)).build();

@BeforeEach
void setUp() {
mockKVStore = mock(KVStore.class);
listKeyVersionsApi = new ListKeyVersionsApi(mockKVStore);
}

@Test
void execute_ValidPayload_ReturnsResponse() {
ListKeyVersionsRequest expectedRequest =
ListKeyVersionsRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKeyPrefix(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
ListKeyVersionsResponse mockResponse = ListKeyVersionsResponse.newBuilder().addAllKeyVersions(
List.of(TEST_KV)).build();
when(mockKVStore.listKeyVersions(expectedRequest)).thenReturn(mockResponse);

Response actualResponse = listKeyVersionsApi.execute(payload);

assertThat(actualResponse.getStatus(), is(Response.Status.OK.getStatusCode()));
assertThat(actualResponse.getEntity(), is(mockResponse.toByteArray()));
verify(mockKVStore).listKeyVersions(expectedRequest);
}

@ParameterizedTest
@MethodSource("provideErrorTestCases")
void execute_InvalidPayload_ReturnsErrorResponse(Exception exception,
ErrorCode errorCode) {
ListKeyVersionsRequest expectedRequest =
ListKeyVersionsRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKeyPrefix(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
when(mockKVStore.listKeyVersions(any())).thenThrow(exception);

Response response = listKeyVersionsApi.execute(payload);

ErrorResponse expectedErrorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage("")
.build();
assertThat(response.getEntity(), is(expectedErrorResponse.toByteArray()));
assertThat(response.getStatus(), is(expectedErrorResponse.getErrorCode().getNumber()));
verify(mockKVStore).listKeyVersions(expectedRequest);
}

private static Stream<Arguments> provideErrorTestCases() {
return Stream.of(
Arguments.of(new ConflictException(""), ErrorCode.CONFLICT_EXCEPTION),
Arguments.of(new IllegalArgumentException(""), ErrorCode.INVALID_REQUEST_EXCEPTION),
Arguments.of(new RuntimeException(""), ErrorCode.INTERNAL_SERVER_EXCEPTION)
);
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions app/build.gradle
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ buildscript {
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.mockitoVersion = '5.2.0'
ext.postgresVersion = '42.5.1'
ext.jooqVersion = '3.17.7'
ext.guiceVersion = '5.1.0'
Expand DownExpand Up@@ -33,6 +34,8 @@ version '1.0'
dependencies {
implementation "com.google.protobuf:protobuf-java:$protobufVersion"

implementation('org.glassfish.jersey.containers:jersey-container-servlet:3.1.0')

//jOOQ & Postgres impl deps
implementation "org.jooq:jooq:$jooqVersion"
implementation "org.jooq:jooq-meta:$jooqVersion"
Expand All@@ -42,7 +45,12 @@ dependencies {

implementation "com.google.inject:guice:$guiceVersion"

compileOnly 'org.projectlombok:lombok:1.18.24'
annotationProcessor 'org.projectlombok:lombok:1.18.24'

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testImplementation "org.junit.jupiter:junit-jupiter-params:$junitVersion"
testImplementation "org.mockito:mockito-core:$mockitoVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:2.2"
testImplementation "org.testcontainers:junit-jupiter:1.17.6"
Expand Down
10 changes: 10 additions & 0 deletions app/src/main/java/org/vss/VSSApplication.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
package org.vss;

import jakarta.ws.rs.ApplicationPath;
import org.glassfish.jersey.server.ResourceConfig;

@ApplicationPath("/")
public class VSSApplication extends ResourceConfig {
public VSSApplication() {
}
}
48 changes: 48 additions & 0 deletions app/src/main/java/org/vss/api/AbstractVssApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
package org.vss.api;

import com.google.protobuf.GeneratedMessageV3;
import com.google.protobuf.InvalidProtocolBufferException;
import jakarta.inject.Inject;
import jakarta.ws.rs.core.Response;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.KVStore;
import org.vss.exception.ConflictException;

public abstract class AbstractVssApi {
final KVStore kvStore;

@Inject
public AbstractVssApi(KVStore kvStore) {
this.kvStore = kvStore;
}

Response toResponse(GeneratedMessageV3 protoResponse) {

return Response
.status(Response.Status.OK)
.entity(protoResponse.toByteArray())
.build();
}

Response toErrorResponse(Exception e) {
ErrorCode errorCode;
if (e instanceof ConflictException) {
errorCode = ErrorCode.CONFLICT_EXCEPTION;
} else if (e instanceof IllegalArgumentException
|| e instanceof InvalidProtocolBufferException) {
errorCode = ErrorCode.INVALID_REQUEST_EXCEPTION;
} else {
errorCode = ErrorCode.INTERNAL_SERVER_EXCEPTION;
}

ErrorResponse errorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage(e.getMessage())
.build();

return Response.status(errorCode.getNumber())
.entity(errorResponse.toByteArray())
.build();
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/GetObjectApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;

@Path(VssApiEndpoint.GET_OBJECT)
@Slf4j
public class GetObjectApi extends AbstractVssApi {

@Inject
public GetObjectApi(KVStore kvstore) {
super(kvstore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
GetObjectRequest request = GetObjectRequest.parseFrom(payload);
GetObjectResponse response = kvStore.get(request);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in GetObjectApi: ", e);
return toErrorResponse(e);
}
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/ListKeyVersionsApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.KVStore;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;

@Path(VssApiEndpoint.LIST_KEY_VERSIONS)
@Slf4j
public class ListKeyVersionsApi extends AbstractVssApi {

@Inject
public ListKeyVersionsApi(KVStore kvStore) {
super(kvStore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
ListKeyVersionsRequest request = ListKeyVersionsRequest.parseFrom(payload);
ListKeyVersionsResponse response = kvStore.listKeyVersions(request);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in ListKeyVersionsApi: ", e);
return toErrorResponse(e);
}
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/PutObjectsApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.KVStore;
import org.vss.PutObjectRequest;
import org.vss.PutObjectResponse;

@Path(VssApiEndpoint.PUT_OBJECTS)
@Slf4j
public class PutObjectsApi extends AbstractVssApi {

@Inject
public PutObjectsApi(KVStore kvStore) {
super(kvStore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
PutObjectRequest putObjectRequest = PutObjectRequest.parseFrom(payload);
PutObjectResponse response = kvStore.put(putObjectRequest);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in PutObjectsApi: ", e);
return toErrorResponse(e);
}
}
}
7 changes: 7 additions & 0 deletions app/src/main/java/org/vss/api/VssApiEndpoint.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
package org.vss.api;

public class VssApiEndpoint {
public static final String GET_OBJECT = "/getObject";
public static final String PUT_OBJECTS = "/putObjects";
public static final String LIST_KEY_VERSIONS = "/listKeyVersions";
}
86 changes: 86 additions & 0 deletions app/src/test/java/org/vss/api/GetObjectApiTest.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
package org.vss.api;

import com.google.protobuf.ByteString;
import jakarta.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.exception.ConflictException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

class GetObjectApiTest {
private GetObjectApi getObjectApi;
private KVStore mockKVStore;

private static String TEST_STORE_ID = "storeId";
private static String TEST_KEY = "key";
private static KeyValue TEST_KV = KeyValue.newBuilder().setKey(TEST_KEY).setValue(
ByteString.copyFrom("test_value", StandardCharsets.UTF_8)).build();

@BeforeEach
void setUp() {
mockKVStore = mock(KVStore.class);
getObjectApi = new GetObjectApi(mockKVStore);
}

@Test
void execute_ValidPayload_ReturnsResponse() {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

i tried creating a common base testcase but it was more complex and less readable since many api specific calls are interleaved.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

these are the abstract methods a sub-test would have had to implement in that case, and it seemed difficult to understand test-case.

 abstract void beforeEachSetup();
abstract void verifyAfterTest();
abstract GeneratedMessageV3 createExpectedRequest();
abstract GeneratedMessageV3 createExpectedResponse();
abstract Response executeValidRequest();
abstract Response executeErroringRequest(Class<? extends Exception> exceptionClass)
throws Exception;

GetObjectRequest expectedRequest =
GetObjectRequest.newBuilder().setStoreId(TEST_STORE_ID).setKey(TEST_KEY).build();
byte[] payload = expectedRequest.toByteArray();
GetObjectResponse mockResponse = GetObjectResponse.newBuilder().setValue(TEST_KV).build();
when(mockKVStore.get(expectedRequest)).thenReturn(mockResponse);

Response actualResponse = getObjectApi.execute(payload);

assertThat(actualResponse.getStatus(), is(Response.Status.OK.getStatusCode()));
assertThat(actualResponse.getEntity(), is(mockResponse.toByteArray()));
verify(mockKVStore).get(expectedRequest);
}

@ParameterizedTest
@MethodSource("provideErrorTestCases")
void execute_InvalidPayload_ReturnsErrorResponse(Exception exception,
ErrorCode errorCode) {
GetObjectRequest expectedRequest = GetObjectRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKey(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
when(mockKVStore.get(any())).thenThrow(exception);

Response response = getObjectApi.execute(payload);

ErrorResponse expectedErrorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage("")
.build();
assertThat(response.getEntity(), is(expectedErrorResponse.toByteArray()));
assertThat(response.getStatus(), is(expectedErrorResponse.getErrorCode().getNumber()));
verify(mockKVStore).get(expectedRequest);
}

private static Stream<Arguments> provideErrorTestCases() {
return Stream.of(
Arguments.of(new ConflictException(""), ErrorCode.CONFLICT_EXCEPTION),
Arguments.of(new IllegalArgumentException(""), ErrorCode.INVALID_REQUEST_EXCEPTION),
Arguments.of(new RuntimeException(""), ErrorCode.INTERNAL_SERVER_EXCEPTION)
);
}
}
92 changes: 92 additions & 0 deletions app/src/test/java/org/vss/api/ListKeyVersionsApiTest.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
package org.vss.api;

import com.google.protobuf.ByteString;
import jakarta.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;
import org.vss.exception.ConflictException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

public class ListKeyVersionsApiTest {
private ListKeyVersionsApi listKeyVersionsApi;
private KVStore mockKVStore;

private static String TEST_STORE_ID = "storeId";
private static String TEST_KEY = "key";
private static KeyValue TEST_KV = KeyValue.newBuilder().setKey(TEST_KEY).setValue(
ByteString.copyFrom("test_value", StandardCharsets.UTF_8)).build();

@BeforeEach
void setUp() {
mockKVStore = mock(KVStore.class);
listKeyVersionsApi = new ListKeyVersionsApi(mockKVStore);
}

@Test
void execute_ValidPayload_ReturnsResponse() {
ListKeyVersionsRequest expectedRequest =
ListKeyVersionsRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKeyPrefix(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
ListKeyVersionsResponse mockResponse = ListKeyVersionsResponse.newBuilder().addAllKeyVersions(
List.of(TEST_KV)).build();
when(mockKVStore.listKeyVersions(expectedRequest)).thenReturn(mockResponse);

Response actualResponse = listKeyVersionsApi.execute(payload);

assertThat(actualResponse.getStatus(), is(Response.Status.OK.getStatusCode()));
assertThat(actualResponse.getEntity(), is(mockResponse.toByteArray()));
verify(mockKVStore).listKeyVersions(expectedRequest);
}

@ParameterizedTest
@MethodSource("provideErrorTestCases")
void execute_InvalidPayload_ReturnsErrorResponse(Exception exception,
ErrorCode errorCode) {
ListKeyVersionsRequest expectedRequest =
ListKeyVersionsRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKeyPrefix(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
when(mockKVStore.listKeyVersions(any())).thenThrow(exception);

Response response = listKeyVersionsApi.execute(payload);

ErrorResponse expectedErrorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage("")
.build();
assertThat(response.getEntity(), is(expectedErrorResponse.toByteArray()));
assertThat(response.getStatus(), is(expectedErrorResponse.getErrorCode().getNumber()));
verify(mockKVStore).listKeyVersions(expectedRequest);
}

private static Stream<Arguments> provideErrorTestCases() {
return Stream.of(
Arguments.of(new ConflictException(""), ErrorCode.CONFLICT_EXCEPTION),
Arguments.of(new IllegalArgumentException(""), ErrorCode.INVALID_REQUEST_EXCEPTION),
Arguments.of(new RuntimeException(""), ErrorCode.INTERNAL_SERVER_EXCEPTION)
);
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions app/build.gradle
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ buildscript {
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.mockitoVersion = '5.2.0'
ext.postgresVersion = '42.5.1'
ext.jooqVersion = '3.17.7'
ext.guiceVersion = '5.1.0'
Expand DownExpand Up@@ -33,6 +34,8 @@ version '1.0'
dependencies {
implementation "com.google.protobuf:protobuf-java:$protobufVersion"

implementation('org.glassfish.jersey.containers:jersey-container-servlet:3.1.0')

//jOOQ & Postgres impl deps
implementation "org.jooq:jooq:$jooqVersion"
implementation "org.jooq:jooq-meta:$jooqVersion"
Expand All@@ -42,7 +45,12 @@ dependencies {

implementation "com.google.inject:guice:$guiceVersion"

compileOnly 'org.projectlombok:lombok:1.18.24'
annotationProcessor 'org.projectlombok:lombok:1.18.24'

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testImplementation "org.junit.jupiter:junit-jupiter-params:$junitVersion"
testImplementation "org.mockito:mockito-core:$mockitoVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:2.2"
testImplementation "org.testcontainers:junit-jupiter:1.17.6"
Expand Down
10 changes: 10 additions & 0 deletions app/src/main/java/org/vss/VSSApplication.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
package org.vss;

import jakarta.ws.rs.ApplicationPath;
import org.glassfish.jersey.server.ResourceConfig;

@ApplicationPath("/")
public class VSSApplication extends ResourceConfig {
public VSSApplication() {
}
}
48 changes: 48 additions & 0 deletions app/src/main/java/org/vss/api/AbstractVssApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
package org.vss.api;

import com.google.protobuf.GeneratedMessageV3;
import com.google.protobuf.InvalidProtocolBufferException;
import jakarta.inject.Inject;
import jakarta.ws.rs.core.Response;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.KVStore;
import org.vss.exception.ConflictException;

public abstract class AbstractVssApi {
final KVStore kvStore;

@Inject
public AbstractVssApi(KVStore kvStore) {
this.kvStore = kvStore;
}

Response toResponse(GeneratedMessageV3 protoResponse) {

return Response
.status(Response.Status.OK)
.entity(protoResponse.toByteArray())
.build();
}

Response toErrorResponse(Exception e) {
ErrorCode errorCode;
if (e instanceof ConflictException) {
errorCode = ErrorCode.CONFLICT_EXCEPTION;
} else if (e instanceof IllegalArgumentException
|| e instanceof InvalidProtocolBufferException) {
errorCode = ErrorCode.INVALID_REQUEST_EXCEPTION;
} else {
errorCode = ErrorCode.INTERNAL_SERVER_EXCEPTION;
}

ErrorResponse errorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage(e.getMessage())
.build();

return Response.status(errorCode.getNumber())
.entity(errorResponse.toByteArray())
.build();
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/GetObjectApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;

@Path(VssApiEndpoint.GET_OBJECT)
@Slf4j
public class GetObjectApi extends AbstractVssApi {

@Inject
public GetObjectApi(KVStore kvstore) {
super(kvstore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
GetObjectRequest request = GetObjectRequest.parseFrom(payload);
GetObjectResponse response = kvStore.get(request);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in GetObjectApi: ", e);
return toErrorResponse(e);
}
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/ListKeyVersionsApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.KVStore;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;

@Path(VssApiEndpoint.LIST_KEY_VERSIONS)
@Slf4j
public class ListKeyVersionsApi extends AbstractVssApi {

@Inject
public ListKeyVersionsApi(KVStore kvStore) {
super(kvStore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
ListKeyVersionsRequest request = ListKeyVersionsRequest.parseFrom(payload);
ListKeyVersionsResponse response = kvStore.listKeyVersions(request);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in ListKeyVersionsApi: ", e);
return toErrorResponse(e);
}
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/PutObjectsApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.KVStore;
import org.vss.PutObjectRequest;
import org.vss.PutObjectResponse;

@Path(VssApiEndpoint.PUT_OBJECTS)
@Slf4j
public class PutObjectsApi extends AbstractVssApi {

@Inject
public PutObjectsApi(KVStore kvStore) {
super(kvStore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
PutObjectRequest putObjectRequest = PutObjectRequest.parseFrom(payload);
PutObjectResponse response = kvStore.put(putObjectRequest);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in PutObjectsApi: ", e);
return toErrorResponse(e);
}
}
}
7 changes: 7 additions & 0 deletions app/src/main/java/org/vss/api/VssApiEndpoint.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
package org.vss.api;

public class VssApiEndpoint {
public static final String GET_OBJECT = "/getObject";
public static final String PUT_OBJECTS = "/putObjects";
public static final String LIST_KEY_VERSIONS = "/listKeyVersions";
}
86 changes: 86 additions & 0 deletions app/src/test/java/org/vss/api/GetObjectApiTest.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
package org.vss.api;

import com.google.protobuf.ByteString;
import jakarta.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.exception.ConflictException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

class GetObjectApiTest {
private GetObjectApi getObjectApi;
private KVStore mockKVStore;

private static String TEST_STORE_ID = "storeId";
private static String TEST_KEY = "key";
private static KeyValue TEST_KV = KeyValue.newBuilder().setKey(TEST_KEY).setValue(
ByteString.copyFrom("test_value", StandardCharsets.UTF_8)).build();

@BeforeEach
void setUp() {
mockKVStore = mock(KVStore.class);
getObjectApi = new GetObjectApi(mockKVStore);
}

@Test
void execute_ValidPayload_ReturnsResponse() {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

i tried creating a common base testcase but it was more complex and less readable since many api specific calls are interleaved.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

these are the abstract methods a sub-test would have had to implement in that case, and it seemed difficult to understand test-case.

 abstract void beforeEachSetup();
abstract void verifyAfterTest();
abstract GeneratedMessageV3 createExpectedRequest();
abstract GeneratedMessageV3 createExpectedResponse();
abstract Response executeValidRequest();
abstract Response executeErroringRequest(Class<? extends Exception> exceptionClass)
throws Exception;

GetObjectRequest expectedRequest =
GetObjectRequest.newBuilder().setStoreId(TEST_STORE_ID).setKey(TEST_KEY).build();
byte[] payload = expectedRequest.toByteArray();
GetObjectResponse mockResponse = GetObjectResponse.newBuilder().setValue(TEST_KV).build();
when(mockKVStore.get(expectedRequest)).thenReturn(mockResponse);

Response actualResponse = getObjectApi.execute(payload);

assertThat(actualResponse.getStatus(), is(Response.Status.OK.getStatusCode()));
assertThat(actualResponse.getEntity(), is(mockResponse.toByteArray()));
verify(mockKVStore).get(expectedRequest);
}

@ParameterizedTest
@MethodSource("provideErrorTestCases")
void execute_InvalidPayload_ReturnsErrorResponse(Exception exception,
ErrorCode errorCode) {
GetObjectRequest expectedRequest = GetObjectRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKey(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
when(mockKVStore.get(any())).thenThrow(exception);

Response response = getObjectApi.execute(payload);

ErrorResponse expectedErrorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage("")
.build();
assertThat(response.getEntity(), is(expectedErrorResponse.toByteArray()));
assertThat(response.getStatus(), is(expectedErrorResponse.getErrorCode().getNumber()));
verify(mockKVStore).get(expectedRequest);
}

private static Stream<Arguments> provideErrorTestCases() {
return Stream.of(
Arguments.of(new ConflictException(""), ErrorCode.CONFLICT_EXCEPTION),
Arguments.of(new IllegalArgumentException(""), ErrorCode.INVALID_REQUEST_EXCEPTION),
Arguments.of(new RuntimeException(""), ErrorCode.INTERNAL_SERVER_EXCEPTION)
);
}
}
92 changes: 92 additions & 0 deletions app/src/test/java/org/vss/api/ListKeyVersionsApiTest.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
package org.vss.api;

import com.google.protobuf.ByteString;
import jakarta.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;
import org.vss.exception.ConflictException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

public class ListKeyVersionsApiTest {
private ListKeyVersionsApi listKeyVersionsApi;
private KVStore mockKVStore;

private static String TEST_STORE_ID = "storeId";
private static String TEST_KEY = "key";
private static KeyValue TEST_KV = KeyValue.newBuilder().setKey(TEST_KEY).setValue(
ByteString.copyFrom("test_value", StandardCharsets.UTF_8)).build();

@BeforeEach
void setUp() {
mockKVStore = mock(KVStore.class);
listKeyVersionsApi = new ListKeyVersionsApi(mockKVStore);
}

@Test
void execute_ValidPayload_ReturnsResponse() {
ListKeyVersionsRequest expectedRequest =
ListKeyVersionsRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKeyPrefix(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
ListKeyVersionsResponse mockResponse = ListKeyVersionsResponse.newBuilder().addAllKeyVersions(
List.of(TEST_KV)).build();
when(mockKVStore.listKeyVersions(expectedRequest)).thenReturn(mockResponse);

Response actualResponse = listKeyVersionsApi.execute(payload);

assertThat(actualResponse.getStatus(), is(Response.Status.OK.getStatusCode()));
assertThat(actualResponse.getEntity(), is(mockResponse.toByteArray()));
verify(mockKVStore).listKeyVersions(expectedRequest);
}

@ParameterizedTest
@MethodSource("provideErrorTestCases")
void execute_InvalidPayload_ReturnsErrorResponse(Exception exception,
ErrorCode errorCode) {
ListKeyVersionsRequest expectedRequest =
ListKeyVersionsRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKeyPrefix(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
when(mockKVStore.listKeyVersions(any())).thenThrow(exception);

Response response = listKeyVersionsApi.execute(payload);

ErrorResponse expectedErrorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage("")
.build();
assertThat(response.getEntity(), is(expectedErrorResponse.toByteArray()));
assertThat(response.getStatus(), is(expectedErrorResponse.getErrorCode().getNumber()));
verify(mockKVStore).listKeyVersions(expectedRequest);
}

private static Stream<Arguments> provideErrorTestCases() {
return Stream.of(
Arguments.of(new ConflictException(""), ErrorCode.CONFLICT_EXCEPTION),
Arguments.of(new IllegalArgumentException(""), ErrorCode.INVALID_REQUEST_EXCEPTION),
Arguments.of(new RuntimeException(""), ErrorCode.INTERNAL_SERVER_EXCEPTION)
);
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions app/build.gradle
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ buildscript {
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.mockitoVersion = '5.2.0'
ext.postgresVersion = '42.5.1'
ext.jooqVersion = '3.17.7'
ext.guiceVersion = '5.1.0'
Expand DownExpand Up@@ -33,6 +34,8 @@ version '1.0'
dependencies {
implementation "com.google.protobuf:protobuf-java:$protobufVersion"

implementation('org.glassfish.jersey.containers:jersey-container-servlet:3.1.0')

//jOOQ & Postgres impl deps
implementation "org.jooq:jooq:$jooqVersion"
implementation "org.jooq:jooq-meta:$jooqVersion"
Expand All@@ -42,7 +45,12 @@ dependencies {

implementation "com.google.inject:guice:$guiceVersion"

compileOnly 'org.projectlombok:lombok:1.18.24'
annotationProcessor 'org.projectlombok:lombok:1.18.24'

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testImplementation "org.junit.jupiter:junit-jupiter-params:$junitVersion"
testImplementation "org.mockito:mockito-core:$mockitoVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:2.2"
testImplementation "org.testcontainers:junit-jupiter:1.17.6"
Expand Down
10 changes: 10 additions & 0 deletions app/src/main/java/org/vss/VSSApplication.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
package org.vss;

import jakarta.ws.rs.ApplicationPath;
import org.glassfish.jersey.server.ResourceConfig;

@ApplicationPath("/")
public class VSSApplication extends ResourceConfig {
public VSSApplication() {
}
}
48 changes: 48 additions & 0 deletions app/src/main/java/org/vss/api/AbstractVssApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
package org.vss.api;

import com.google.protobuf.GeneratedMessageV3;
import com.google.protobuf.InvalidProtocolBufferException;
import jakarta.inject.Inject;
import jakarta.ws.rs.core.Response;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.KVStore;
import org.vss.exception.ConflictException;

public abstract class AbstractVssApi {
final KVStore kvStore;

@Inject
public AbstractVssApi(KVStore kvStore) {
this.kvStore = kvStore;
}

Response toResponse(GeneratedMessageV3 protoResponse) {

return Response
.status(Response.Status.OK)
.entity(protoResponse.toByteArray())
.build();
}

Response toErrorResponse(Exception e) {
ErrorCode errorCode;
if (e instanceof ConflictException) {
errorCode = ErrorCode.CONFLICT_EXCEPTION;
} else if (e instanceof IllegalArgumentException
|| e instanceof InvalidProtocolBufferException) {
errorCode = ErrorCode.INVALID_REQUEST_EXCEPTION;
} else {
errorCode = ErrorCode.INTERNAL_SERVER_EXCEPTION;
}

ErrorResponse errorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage(e.getMessage())
.build();

return Response.status(errorCode.getNumber())
.entity(errorResponse.toByteArray())
.build();
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/GetObjectApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;

@Path(VssApiEndpoint.GET_OBJECT)
@Slf4j
public class GetObjectApi extends AbstractVssApi {

@Inject
public GetObjectApi(KVStore kvstore) {
super(kvstore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
GetObjectRequest request = GetObjectRequest.parseFrom(payload);
GetObjectResponse response = kvStore.get(request);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in GetObjectApi: ", e);
return toErrorResponse(e);
}
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/ListKeyVersionsApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.KVStore;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;

@Path(VssApiEndpoint.LIST_KEY_VERSIONS)
@Slf4j
public class ListKeyVersionsApi extends AbstractVssApi {

@Inject
public ListKeyVersionsApi(KVStore kvStore) {
super(kvStore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
ListKeyVersionsRequest request = ListKeyVersionsRequest.parseFrom(payload);
ListKeyVersionsResponse response = kvStore.listKeyVersions(request);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in ListKeyVersionsApi: ", e);
return toErrorResponse(e);
}
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/PutObjectsApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.KVStore;
import org.vss.PutObjectRequest;
import org.vss.PutObjectResponse;

@Path(VssApiEndpoint.PUT_OBJECTS)
@Slf4j
public class PutObjectsApi extends AbstractVssApi {

@Inject
public PutObjectsApi(KVStore kvStore) {
super(kvStore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
PutObjectRequest putObjectRequest = PutObjectRequest.parseFrom(payload);
PutObjectResponse response = kvStore.put(putObjectRequest);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in PutObjectsApi: ", e);
return toErrorResponse(e);
}
}
}
7 changes: 7 additions & 0 deletions app/src/main/java/org/vss/api/VssApiEndpoint.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
package org.vss.api;

public class VssApiEndpoint {
public static final String GET_OBJECT = "/getObject";
public static final String PUT_OBJECTS = "/putObjects";
public static final String LIST_KEY_VERSIONS = "/listKeyVersions";
}
86 changes: 86 additions & 0 deletions app/src/test/java/org/vss/api/GetObjectApiTest.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
package org.vss.api;

import com.google.protobuf.ByteString;
import jakarta.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.exception.ConflictException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

class GetObjectApiTest {
private GetObjectApi getObjectApi;
private KVStore mockKVStore;

private static String TEST_STORE_ID = "storeId";
private static String TEST_KEY = "key";
private static KeyValue TEST_KV = KeyValue.newBuilder().setKey(TEST_KEY).setValue(
ByteString.copyFrom("test_value", StandardCharsets.UTF_8)).build();

@BeforeEach
void setUp() {
mockKVStore = mock(KVStore.class);
getObjectApi = new GetObjectApi(mockKVStore);
}

@Test
void execute_ValidPayload_ReturnsResponse() {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

i tried creating a common base testcase but it was more complex and less readable since many api specific calls are interleaved.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

these are the abstract methods a sub-test would have had to implement in that case, and it seemed difficult to understand test-case.

 abstract void beforeEachSetup();
abstract void verifyAfterTest();
abstract GeneratedMessageV3 createExpectedRequest();
abstract GeneratedMessageV3 createExpectedResponse();
abstract Response executeValidRequest();
abstract Response executeErroringRequest(Class<? extends Exception> exceptionClass)
throws Exception;

GetObjectRequest expectedRequest =
GetObjectRequest.newBuilder().setStoreId(TEST_STORE_ID).setKey(TEST_KEY).build();
byte[] payload = expectedRequest.toByteArray();
GetObjectResponse mockResponse = GetObjectResponse.newBuilder().setValue(TEST_KV).build();
when(mockKVStore.get(expectedRequest)).thenReturn(mockResponse);

Response actualResponse = getObjectApi.execute(payload);

assertThat(actualResponse.getStatus(), is(Response.Status.OK.getStatusCode()));
assertThat(actualResponse.getEntity(), is(mockResponse.toByteArray()));
verify(mockKVStore).get(expectedRequest);
}

@ParameterizedTest
@MethodSource("provideErrorTestCases")
void execute_InvalidPayload_ReturnsErrorResponse(Exception exception,
ErrorCode errorCode) {
GetObjectRequest expectedRequest = GetObjectRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKey(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
when(mockKVStore.get(any())).thenThrow(exception);

Response response = getObjectApi.execute(payload);

ErrorResponse expectedErrorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage("")
.build();
assertThat(response.getEntity(), is(expectedErrorResponse.toByteArray()));
assertThat(response.getStatus(), is(expectedErrorResponse.getErrorCode().getNumber()));
verify(mockKVStore).get(expectedRequest);
}

private static Stream<Arguments> provideErrorTestCases() {
return Stream.of(
Arguments.of(new ConflictException(""), ErrorCode.CONFLICT_EXCEPTION),
Arguments.of(new IllegalArgumentException(""), ErrorCode.INVALID_REQUEST_EXCEPTION),
Arguments.of(new RuntimeException(""), ErrorCode.INTERNAL_SERVER_EXCEPTION)
);
}
}
92 changes: 92 additions & 0 deletions app/src/test/java/org/vss/api/ListKeyVersionsApiTest.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
package org.vss.api;

import com.google.protobuf.ByteString;
import jakarta.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;
import org.vss.exception.ConflictException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

public class ListKeyVersionsApiTest {
private ListKeyVersionsApi listKeyVersionsApi;
private KVStore mockKVStore;

private static String TEST_STORE_ID = "storeId";
private static String TEST_KEY = "key";
private static KeyValue TEST_KV = KeyValue.newBuilder().setKey(TEST_KEY).setValue(
ByteString.copyFrom("test_value", StandardCharsets.UTF_8)).build();

@BeforeEach
void setUp() {
mockKVStore = mock(KVStore.class);
listKeyVersionsApi = new ListKeyVersionsApi(mockKVStore);
}

@Test
void execute_ValidPayload_ReturnsResponse() {
ListKeyVersionsRequest expectedRequest =
ListKeyVersionsRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKeyPrefix(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
ListKeyVersionsResponse mockResponse = ListKeyVersionsResponse.newBuilder().addAllKeyVersions(
List.of(TEST_KV)).build();
when(mockKVStore.listKeyVersions(expectedRequest)).thenReturn(mockResponse);

Response actualResponse = listKeyVersionsApi.execute(payload);

assertThat(actualResponse.getStatus(), is(Response.Status.OK.getStatusCode()));
assertThat(actualResponse.getEntity(), is(mockResponse.toByteArray()));
verify(mockKVStore).listKeyVersions(expectedRequest);
}

@ParameterizedTest
@MethodSource("provideErrorTestCases")
void execute_InvalidPayload_ReturnsErrorResponse(Exception exception,
ErrorCode errorCode) {
ListKeyVersionsRequest expectedRequest =
ListKeyVersionsRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKeyPrefix(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
when(mockKVStore.listKeyVersions(any())).thenThrow(exception);

Response response = listKeyVersionsApi.execute(payload);

ErrorResponse expectedErrorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage("")
.build();
assertThat(response.getEntity(), is(expectedErrorResponse.toByteArray()));
assertThat(response.getStatus(), is(expectedErrorResponse.getErrorCode().getNumber()));
verify(mockKVStore).listKeyVersions(expectedRequest);
}

private static Stream<Arguments> provideErrorTestCases() {
return Stream.of(
Arguments.of(new ConflictException(""), ErrorCode.CONFLICT_EXCEPTION),
Arguments.of(new IllegalArgumentException(""), ErrorCode.INVALID_REQUEST_EXCEPTION),
Arguments.of(new RuntimeException(""), ErrorCode.INTERNAL_SERVER_EXCEPTION)
);
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions app/build.gradle
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ buildscript {
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.mockitoVersion = '5.2.0'
ext.postgresVersion = '42.5.1'
ext.jooqVersion = '3.17.7'
ext.guiceVersion = '5.1.0'
Expand DownExpand Up@@ -33,6 +34,8 @@ version '1.0'
dependencies {
implementation "com.google.protobuf:protobuf-java:$protobufVersion"

implementation('org.glassfish.jersey.containers:jersey-container-servlet:3.1.0')

//jOOQ & Postgres impl deps
implementation "org.jooq:jooq:$jooqVersion"
implementation "org.jooq:jooq-meta:$jooqVersion"
Expand All@@ -42,7 +45,12 @@ dependencies {

implementation "com.google.inject:guice:$guiceVersion"

compileOnly 'org.projectlombok:lombok:1.18.24'
annotationProcessor 'org.projectlombok:lombok:1.18.24'

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testImplementation "org.junit.jupiter:junit-jupiter-params:$junitVersion"
testImplementation "org.mockito:mockito-core:$mockitoVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:2.2"
testImplementation "org.testcontainers:junit-jupiter:1.17.6"
Expand Down
10 changes: 10 additions & 0 deletions app/src/main/java/org/vss/VSSApplication.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
package org.vss;

import jakarta.ws.rs.ApplicationPath;
import org.glassfish.jersey.server.ResourceConfig;

@ApplicationPath("/")
public class VSSApplication extends ResourceConfig {
public VSSApplication() {
}
}
48 changes: 48 additions & 0 deletions app/src/main/java/org/vss/api/AbstractVssApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
package org.vss.api;

import com.google.protobuf.GeneratedMessageV3;
import com.google.protobuf.InvalidProtocolBufferException;
import jakarta.inject.Inject;
import jakarta.ws.rs.core.Response;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.KVStore;
import org.vss.exception.ConflictException;

public abstract class AbstractVssApi {
final KVStore kvStore;

@Inject
public AbstractVssApi(KVStore kvStore) {
this.kvStore = kvStore;
}

Response toResponse(GeneratedMessageV3 protoResponse) {

return Response
.status(Response.Status.OK)
.entity(protoResponse.toByteArray())
.build();
}

Response toErrorResponse(Exception e) {
ErrorCode errorCode;
if (e instanceof ConflictException) {
errorCode = ErrorCode.CONFLICT_EXCEPTION;
} else if (e instanceof IllegalArgumentException
|| e instanceof InvalidProtocolBufferException) {
errorCode = ErrorCode.INVALID_REQUEST_EXCEPTION;
} else {
errorCode = ErrorCode.INTERNAL_SERVER_EXCEPTION;
}

ErrorResponse errorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage(e.getMessage())
.build();

return Response.status(errorCode.getNumber())
.entity(errorResponse.toByteArray())
.build();
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/GetObjectApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;

@Path(VssApiEndpoint.GET_OBJECT)
@Slf4j
public class GetObjectApi extends AbstractVssApi {

@Inject
public GetObjectApi(KVStore kvstore) {
super(kvstore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
GetObjectRequest request = GetObjectRequest.parseFrom(payload);
GetObjectResponse response = kvStore.get(request);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in GetObjectApi: ", e);
return toErrorResponse(e);
}
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/ListKeyVersionsApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.KVStore;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;

@Path(VssApiEndpoint.LIST_KEY_VERSIONS)
@Slf4j
public class ListKeyVersionsApi extends AbstractVssApi {

@Inject
public ListKeyVersionsApi(KVStore kvStore) {
super(kvStore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
ListKeyVersionsRequest request = ListKeyVersionsRequest.parseFrom(payload);
ListKeyVersionsResponse response = kvStore.listKeyVersions(request);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in ListKeyVersionsApi: ", e);
return toErrorResponse(e);
}
}
}
35 changes: 35 additions & 0 deletions app/src/main/java/org/vss/api/PutObjectsApi.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
package org.vss.api;

import jakarta.inject.Inject;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.extern.slf4j.Slf4j;
import org.vss.KVStore;
import org.vss.PutObjectRequest;
import org.vss.PutObjectResponse;

@Path(VssApiEndpoint.PUT_OBJECTS)
@Slf4j
public class PutObjectsApi extends AbstractVssApi {

@Inject
public PutObjectsApi(KVStore kvStore) {
super(kvStore);
}

@POST
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response execute(byte[] payload) {
try {
PutObjectRequest putObjectRequest = PutObjectRequest.parseFrom(payload);
PutObjectResponse response = kvStore.put(putObjectRequest);
return toResponse(response);
} catch (Exception e) {
log.error("Exception in PutObjectsApi: ", e);
return toErrorResponse(e);
}
}
}
7 changes: 7 additions & 0 deletions app/src/main/java/org/vss/api/VssApiEndpoint.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
package org.vss.api;

public class VssApiEndpoint {
public static final String GET_OBJECT = "/getObject";
public static final String PUT_OBJECTS = "/putObjects";
public static final String LIST_KEY_VERSIONS = "/listKeyVersions";
}
86 changes: 86 additions & 0 deletions app/src/test/java/org/vss/api/GetObjectApiTest.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
package org.vss.api;

import com.google.protobuf.ByteString;
import jakarta.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.exception.ConflictException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

class GetObjectApiTest {
private GetObjectApi getObjectApi;
private KVStore mockKVStore;

private static String TEST_STORE_ID = "storeId";
private static String TEST_KEY = "key";
private static KeyValue TEST_KV = KeyValue.newBuilder().setKey(TEST_KEY).setValue(
ByteString.copyFrom("test_value", StandardCharsets.UTF_8)).build();

@BeforeEach
void setUp() {
mockKVStore = mock(KVStore.class);
getObjectApi = new GetObjectApi(mockKVStore);
}

@Test
void execute_ValidPayload_ReturnsResponse() {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

i tried creating a common base testcase but it was more complex and less readable since many api specific calls are interleaved.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

these are the abstract methods a sub-test would have had to implement in that case, and it seemed difficult to understand test-case.

 abstract void beforeEachSetup();
abstract void verifyAfterTest();
abstract GeneratedMessageV3 createExpectedRequest();
abstract GeneratedMessageV3 createExpectedResponse();
abstract Response executeValidRequest();
abstract Response executeErroringRequest(Class<? extends Exception> exceptionClass)
throws Exception;

GetObjectRequest expectedRequest =
GetObjectRequest.newBuilder().setStoreId(TEST_STORE_ID).setKey(TEST_KEY).build();
byte[] payload = expectedRequest.toByteArray();
GetObjectResponse mockResponse = GetObjectResponse.newBuilder().setValue(TEST_KV).build();
when(mockKVStore.get(expectedRequest)).thenReturn(mockResponse);

Response actualResponse = getObjectApi.execute(payload);

assertThat(actualResponse.getStatus(), is(Response.Status.OK.getStatusCode()));
assertThat(actualResponse.getEntity(), is(mockResponse.toByteArray()));
verify(mockKVStore).get(expectedRequest);
}

@ParameterizedTest
@MethodSource("provideErrorTestCases")
void execute_InvalidPayload_ReturnsErrorResponse(Exception exception,
ErrorCode errorCode) {
GetObjectRequest expectedRequest = GetObjectRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKey(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
when(mockKVStore.get(any())).thenThrow(exception);

Response response = getObjectApi.execute(payload);

ErrorResponse expectedErrorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage("")
.build();
assertThat(response.getEntity(), is(expectedErrorResponse.toByteArray()));
assertThat(response.getStatus(), is(expectedErrorResponse.getErrorCode().getNumber()));
verify(mockKVStore).get(expectedRequest);
}

private static Stream<Arguments> provideErrorTestCases() {
return Stream.of(
Arguments.of(new ConflictException(""), ErrorCode.CONFLICT_EXCEPTION),
Arguments.of(new IllegalArgumentException(""), ErrorCode.INVALID_REQUEST_EXCEPTION),
Arguments.of(new RuntimeException(""), ErrorCode.INTERNAL_SERVER_EXCEPTION)
);
}
}
92 changes: 92 additions & 0 deletions app/src/test/java/org/vss/api/ListKeyVersionsApiTest.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
package org.vss.api;

import com.google.protobuf.ByteString;
import jakarta.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.stream.Stream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.vss.ErrorCode;
import org.vss.ErrorResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;
import org.vss.exception.ConflictException;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

public class ListKeyVersionsApiTest {
private ListKeyVersionsApi listKeyVersionsApi;
private KVStore mockKVStore;

private static String TEST_STORE_ID = "storeId";
private static String TEST_KEY = "key";
private static KeyValue TEST_KV = KeyValue.newBuilder().setKey(TEST_KEY).setValue(
ByteString.copyFrom("test_value", StandardCharsets.UTF_8)).build();

@BeforeEach
void setUp() {
mockKVStore = mock(KVStore.class);
listKeyVersionsApi = new ListKeyVersionsApi(mockKVStore);
}

@Test
void execute_ValidPayload_ReturnsResponse() {
ListKeyVersionsRequest expectedRequest =
ListKeyVersionsRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKeyPrefix(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
ListKeyVersionsResponse mockResponse = ListKeyVersionsResponse.newBuilder().addAllKeyVersions(
List.of(TEST_KV)).build();
when(mockKVStore.listKeyVersions(expectedRequest)).thenReturn(mockResponse);

Response actualResponse = listKeyVersionsApi.execute(payload);

assertThat(actualResponse.getStatus(), is(Response.Status.OK.getStatusCode()));
assertThat(actualResponse.getEntity(), is(mockResponse.toByteArray()));
verify(mockKVStore).listKeyVersions(expectedRequest);
}

@ParameterizedTest
@MethodSource("provideErrorTestCases")
void execute_InvalidPayload_ReturnsErrorResponse(Exception exception,
ErrorCode errorCode) {
ListKeyVersionsRequest expectedRequest =
ListKeyVersionsRequest.newBuilder()
.setStoreId(TEST_STORE_ID)
.setKeyPrefix(TEST_KEY)
.build();
byte[] payload = expectedRequest.toByteArray();
when(mockKVStore.listKeyVersions(any())).thenThrow(exception);

Response response = listKeyVersionsApi.execute(payload);

ErrorResponse expectedErrorResponse = ErrorResponse.newBuilder()
.setErrorCode(errorCode)
.setMessage("")
.build();
assertThat(response.getEntity(), is(expectedErrorResponse.toByteArray()));
assertThat(response.getStatus(), is(expectedErrorResponse.getErrorCode().getNumber()));
verify(mockKVStore).listKeyVersions(expectedRequest);
}

private static Stream<Arguments> provideErrorTestCases() {
return Stream.of(
Arguments.of(new ConflictException(""), ErrorCode.CONFLICT_EXCEPTION),
Arguments.of(new IllegalArgumentException(""), ErrorCode.INVALID_REQUEST_EXCEPTION),
Arguments.of(new RuntimeException(""), ErrorCode.INTERNAL_SERVER_EXCEPTION)
);
}
}
Loading