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
100 changes: 81 additions & 19 deletions app/build.gradle
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,101 @@
buildscript {
ext.gradleVersion = '7.5.1'
ext.protobufPlugInVersion = '0.8.12'
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.gradleVersion = '7.5.1'
ext.protobufPlugInVersion = '0.8.12'
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.postgresVersion = '42.5.1'
ext.jooqVersion = '3.17.7'
ext.guiceVersion = '5.1.0'
}

plugins {
id 'java'
id 'com.google.protobuf' version "${protobufPlugInVersion}"
id 'war'
id 'idea'
id 'java'
id 'com.google.protobuf' version "${protobufPlugInVersion}"
id 'war'
id 'idea'
id 'nu.studer.jooq' version '8.0'
}

repositories {
mavenCentral()
mavenCentral()
}

idea {
module {
generatedSourceDirs.add(file("build/generated/proto/main"))
}
module {
generatedSourceDirs.add(file("build/generated/proto/main"))
}
}

group 'org.vss'
version '1.0'


dependencies {
implementation "com.google.protobuf:protobuf-java:$protobufVersion"
implementation "com.google.protobuf:protobuf-java:$protobufVersion"

//jOOQ & Postgres impl deps
implementation "org.jooq:jooq:$jooqVersion"
implementation "org.jooq:jooq-meta:$jooqVersion"
implementation "org.jooq:jooq-codegen:$jooqVersion"
runtimeOnly "org.postgresql:postgresql:$postgresVersion"
jooqGenerator "org.postgresql:postgresql:$postgresVersion"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
implementation "com.google.inject:guice:$guiceVersion"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:2.2"
testImplementation "org.testcontainers:junit-jupiter:1.17.6"
testImplementation "org.testcontainers:postgresql:1.17.6"
}

test {
useJUnitPlatform()
}
useJUnitPlatform()
}

protobuf {
protoc {
artifact = "com.google.protobuf:protoc:$protobufVersion"
}
}

jooq {
configurations {
main {
generateSchemaSourceOnCompilation = true

generationTool {
jdbc {
driver = 'org.postgresql.Driver'
url = 'jdbc:postgresql://localhost:5432/postgres'
user = 'postgres'
password = ''
properties {
property {
key = 'ssl'
value = 'false'
}
}
}
generator {
name = 'org.jooq.codegen.DefaultGenerator'
database {
name = 'org.jooq.meta.postgres.PostgresDatabase'
inputSchema = 'public'
}
generate {
deprecated = false
records = true
immutablePojos = true
fluentSetters = true
}
target {
packageName = 'org.vss.postgres'
directory = 'build/generated-src/jooq/main'
}
strategy.name = 'org.jooq.codegen.DefaultGeneratorStrategy'
}
}
}
}
}
12 changes: 12 additions & 0 deletions app/src/main/java/org/vss/KVStore.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
package org.vss;

public interface KVStore {

String GLOBAL_VERSION_KEY = "vss_global_version";

GetObjectResponse get(GetObjectRequest request);

PutObjectResponse put(PutObjectRequest request);

ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request);
}
7 changes: 7 additions & 0 deletions app/src/main/java/org/vss/exception/ConflictException.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
package org.vss.exception;

public class ConflictException extends RuntimeException {
public ConflictException(String message) {
super(message);
}
}
132 changes: 132 additions & 0 deletions app/src/main/java/org/vss/impl/postgres/PostgresBackendImpl.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
package org.vss.impl.postgres;

import com.google.inject.Inject;
import com.google.protobuf.ByteString;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.inject.Singleton;
import org.jooq.DSLContext;
import org.jooq.Insert;
import org.jooq.Query;
import org.jooq.Update;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;
import org.vss.PutObjectRequest;
import org.vss.PutObjectResponse;
import org.vss.exception.ConflictException;
import org.vss.postgres.tables.records.VssDbRecord;

import static org.jooq.impl.DSL.val;
import static org.vss.postgres.tables.VssDb.VSS_DB;

@Singleton
public class PostgresBackendImpl implements KVStore {

private final DSLContext context;

@Inject
public PostgresBackendImpl(DSLContext context) {
this.context = context;
}

@Override
public GetObjectResponse get(GetObjectRequest request) {

VssDbRecord vssDbRecord = context.selectFrom(VSS_DB)
.where(VSS_DB.STORE_ID.eq(request.getStoreId())
.and(VSS_DB.KEY.eq(request.getKey())))
.fetchOne();

final KeyValue keyValue;

if (vssDbRecord != null) {
keyValue = KeyValue.newBuilder()
.setKey(vssDbRecord.getKey())
.setValue(ByteString.copyFrom(vssDbRecord.getValue()))
.setVersion(vssDbRecord.getVersion())
.build();
} else {
keyValue = KeyValue.newBuilder()
.setKey(request.getKey()).build();
}
Comment on lines +53 to +56

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we return an error if there is no record for the key?

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 think an empty response is preferable in this case.
ResourceNotFound or 404 might represent a myriad of issues and things going wrong. (url wrong etc.)
In this case, we consider it a perfectly valid request to get a key which does not exist or to check existence of a key.
I see no harm in mixing keys that exist with no data and keys which don't exist, to make clients life easier instead of throwing an exception in one case.

Note: This is only applicable if client has permission to storeId, if not then we would want to throw ResourceNotFound.

However, this is a controversial topic and there are reasons to go either way.


return GetObjectResponse.newBuilder()
.setValue(keyValue)
.build();
}

@Override
public PutObjectResponse put(PutObjectRequest request) {

String storeId = request.getStoreId();

List<VssDbRecord> vssRecords = new ArrayList<>(request.getTransactionItemsList().stream()
.map(kv -> buildVssRecord(storeId, kv)).toList());

if (request.hasGlobalVersion()) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this doesn't increment the global version when it's not specified in the request. we always want to increment it, right?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I guess we could have the specifications say that it doesn't get incremented if not present in the request, but we should be explicit about it, since the developer might not expect that

@G8XSUG8XSUJan 25, 2023

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.

Based on how optimistic locking works, version needs to be provided by client in order to enact it.
So expectation is that we don't increment it and dont perform the check if developer doesn't supply it.

If global_version is not supplied, it means it is a non-global-version-check-required write.
We shouldn't be incrementing global_version in this case as client-side will not increment and has no way of knowing this without performing a sync.

Based on different application needs, some might not need a global_version check on every write, and this feature is meant to support those applications.

VssDbRecord globalVersionRecord = buildVssRecord(storeId,
KeyValue.newBuilder()
.setKey(GLOBAL_VERSION_KEY)
.setVersion(request.getGlobalVersion())
.build());

vssRecords.add(globalVersionRecord);
}

context.transaction((ctx) -> {
DSLContext dsl = ctx.dsl();
List<Query> batchQueries = vssRecords.stream()
.map(vssRecord -> buildPutObjectQuery(dsl, vssRecord)).toList();

int[] batchResult = dsl.batch(batchQueries).execute();

for (int numOfRowsUpdated : batchResult) {
if (numOfRowsUpdated == 0) {
throw new ConflictException(
"Transaction could not be completed due to a possible conflict");
}
}
});
Comment on lines +86 to +94

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could you test the case where one key failing causes the entire transaction to fail? (i.e., the successful key is not updated)


return PutObjectResponse.newBuilder().build();
}

private Query buildPutObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
return vssRecord.getVersion() == 0 ? buildInsertRecordQuery(dsl, vssRecord)
: buildUpdateRecordQuery(dsl, vssRecord);
}

private Insert<VssDbRecord> buildInsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.insertInto(VSS_DB)
.values(vssRecord.getStoreId(), vssRecord.getKey(),
vssRecord.getValue(), 1)
.onDuplicateKeyIgnore();
}

private Update<VssDbRecord> buildUpdateRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.update(VSS_DB)
.set(Map.of(VSS_DB.VALUE, vssRecord.getValue(),
VSS_DB.VERSION, vssRecord.getVersion() + 1))
.where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey()))
.and(VSS_DB.VERSION.eq(vssRecord.getVersion())));
}

private VssDbRecord buildVssRecord(String storeId, KeyValue kv) {
return new VssDbRecord()
.setStoreId(storeId)
.setKey(kv.getKey())
.setValue(kv.getValue().toByteArray())
.setVersion(kv.getVersion());
}

@Override
public ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request) {
throw new UnsupportedOperationException("Operation not implemented");
}
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
CREATE TABLE vss_db (
store_id character varying(120) NOT NULL CHECK (store_id <> ''),
key character varying(120) NOT NULL,
value bytea NULL,
version bigint NOT NULL,
PRIMARY KEY (store_id, key)
);
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
100 changes: 81 additions & 19 deletions app/build.gradle
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,101 @@
buildscript {
ext.gradleVersion = '7.5.1'
ext.protobufPlugInVersion = '0.8.12'
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.gradleVersion = '7.5.1'
ext.protobufPlugInVersion = '0.8.12'
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.postgresVersion = '42.5.1'
ext.jooqVersion = '3.17.7'
ext.guiceVersion = '5.1.0'
}

plugins {
id 'java'
id 'com.google.protobuf' version "${protobufPlugInVersion}"
id 'war'
id 'idea'
id 'java'
id 'com.google.protobuf' version "${protobufPlugInVersion}"
id 'war'
id 'idea'
id 'nu.studer.jooq' version '8.0'
}

repositories {
mavenCentral()
mavenCentral()
}

idea {
module {
generatedSourceDirs.add(file("build/generated/proto/main"))
}
module {
generatedSourceDirs.add(file("build/generated/proto/main"))
}
}

group 'org.vss'
version '1.0'


dependencies {
implementation "com.google.protobuf:protobuf-java:$protobufVersion"
implementation "com.google.protobuf:protobuf-java:$protobufVersion"

//jOOQ & Postgres impl deps
implementation "org.jooq:jooq:$jooqVersion"
implementation "org.jooq:jooq-meta:$jooqVersion"
implementation "org.jooq:jooq-codegen:$jooqVersion"
runtimeOnly "org.postgresql:postgresql:$postgresVersion"
jooqGenerator "org.postgresql:postgresql:$postgresVersion"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
implementation "com.google.inject:guice:$guiceVersion"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:2.2"
testImplementation "org.testcontainers:junit-jupiter:1.17.6"
testImplementation "org.testcontainers:postgresql:1.17.6"
}

test {
useJUnitPlatform()
}
useJUnitPlatform()
}

protobuf {
protoc {
artifact = "com.google.protobuf:protoc:$protobufVersion"
}
}

jooq {
configurations {
main {
generateSchemaSourceOnCompilation = true

generationTool {
jdbc {
driver = 'org.postgresql.Driver'
url = 'jdbc:postgresql://localhost:5432/postgres'
user = 'postgres'
password = ''
properties {
property {
key = 'ssl'
value = 'false'
}
}
}
generator {
name = 'org.jooq.codegen.DefaultGenerator'
database {
name = 'org.jooq.meta.postgres.PostgresDatabase'
inputSchema = 'public'
}
generate {
deprecated = false
records = true
immutablePojos = true
fluentSetters = true
}
target {
packageName = 'org.vss.postgres'
directory = 'build/generated-src/jooq/main'
}
strategy.name = 'org.jooq.codegen.DefaultGeneratorStrategy'
}
}
}
}
}
12 changes: 12 additions & 0 deletions app/src/main/java/org/vss/KVStore.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
package org.vss;

public interface KVStore {

String GLOBAL_VERSION_KEY = "vss_global_version";

GetObjectResponse get(GetObjectRequest request);

PutObjectResponse put(PutObjectRequest request);

ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request);
}
7 changes: 7 additions & 0 deletions app/src/main/java/org/vss/exception/ConflictException.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
package org.vss.exception;

public class ConflictException extends RuntimeException {
public ConflictException(String message) {
super(message);
}
}
132 changes: 132 additions & 0 deletions app/src/main/java/org/vss/impl/postgres/PostgresBackendImpl.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
package org.vss.impl.postgres;

import com.google.inject.Inject;
import com.google.protobuf.ByteString;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.inject.Singleton;
import org.jooq.DSLContext;
import org.jooq.Insert;
import org.jooq.Query;
import org.jooq.Update;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;
import org.vss.PutObjectRequest;
import org.vss.PutObjectResponse;
import org.vss.exception.ConflictException;
import org.vss.postgres.tables.records.VssDbRecord;

import static org.jooq.impl.DSL.val;
import static org.vss.postgres.tables.VssDb.VSS_DB;

@Singleton
public class PostgresBackendImpl implements KVStore {

private final DSLContext context;

@Inject
public PostgresBackendImpl(DSLContext context) {
this.context = context;
}

@Override
public GetObjectResponse get(GetObjectRequest request) {

VssDbRecord vssDbRecord = context.selectFrom(VSS_DB)
.where(VSS_DB.STORE_ID.eq(request.getStoreId())
.and(VSS_DB.KEY.eq(request.getKey())))
.fetchOne();

final KeyValue keyValue;

if (vssDbRecord != null) {
keyValue = KeyValue.newBuilder()
.setKey(vssDbRecord.getKey())
.setValue(ByteString.copyFrom(vssDbRecord.getValue()))
.setVersion(vssDbRecord.getVersion())
.build();
} else {
keyValue = KeyValue.newBuilder()
.setKey(request.getKey()).build();
}
Comment on lines +53 to +56

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we return an error if there is no record for the key?

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 think an empty response is preferable in this case.
ResourceNotFound or 404 might represent a myriad of issues and things going wrong. (url wrong etc.)
In this case, we consider it a perfectly valid request to get a key which does not exist or to check existence of a key.
I see no harm in mixing keys that exist with no data and keys which don't exist, to make clients life easier instead of throwing an exception in one case.

Note: This is only applicable if client has permission to storeId, if not then we would want to throw ResourceNotFound.

However, this is a controversial topic and there are reasons to go either way.


return GetObjectResponse.newBuilder()
.setValue(keyValue)
.build();
}

@Override
public PutObjectResponse put(PutObjectRequest request) {

String storeId = request.getStoreId();

List<VssDbRecord> vssRecords = new ArrayList<>(request.getTransactionItemsList().stream()
.map(kv -> buildVssRecord(storeId, kv)).toList());

if (request.hasGlobalVersion()) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this doesn't increment the global version when it's not specified in the request. we always want to increment it, right?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I guess we could have the specifications say that it doesn't get incremented if not present in the request, but we should be explicit about it, since the developer might not expect that

@G8XSUG8XSUJan 25, 2023

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.

Based on how optimistic locking works, version needs to be provided by client in order to enact it.
So expectation is that we don't increment it and dont perform the check if developer doesn't supply it.

If global_version is not supplied, it means it is a non-global-version-check-required write.
We shouldn't be incrementing global_version in this case as client-side will not increment and has no way of knowing this without performing a sync.

Based on different application needs, some might not need a global_version check on every write, and this feature is meant to support those applications.

VssDbRecord globalVersionRecord = buildVssRecord(storeId,
KeyValue.newBuilder()
.setKey(GLOBAL_VERSION_KEY)
.setVersion(request.getGlobalVersion())
.build());

vssRecords.add(globalVersionRecord);
}

context.transaction((ctx) -> {
DSLContext dsl = ctx.dsl();
List<Query> batchQueries = vssRecords.stream()
.map(vssRecord -> buildPutObjectQuery(dsl, vssRecord)).toList();

int[] batchResult = dsl.batch(batchQueries).execute();

for (int numOfRowsUpdated : batchResult) {
if (numOfRowsUpdated == 0) {
throw new ConflictException(
"Transaction could not be completed due to a possible conflict");
}
}
});
Comment on lines +86 to +94

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could you test the case where one key failing causes the entire transaction to fail? (i.e., the successful key is not updated)


return PutObjectResponse.newBuilder().build();
}

private Query buildPutObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
return vssRecord.getVersion() == 0 ? buildInsertRecordQuery(dsl, vssRecord)
: buildUpdateRecordQuery(dsl, vssRecord);
}

private Insert<VssDbRecord> buildInsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.insertInto(VSS_DB)
.values(vssRecord.getStoreId(), vssRecord.getKey(),
vssRecord.getValue(), 1)
.onDuplicateKeyIgnore();
}

private Update<VssDbRecord> buildUpdateRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.update(VSS_DB)
.set(Map.of(VSS_DB.VALUE, vssRecord.getValue(),
VSS_DB.VERSION, vssRecord.getVersion() + 1))
.where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey()))
.and(VSS_DB.VERSION.eq(vssRecord.getVersion())));
}

private VssDbRecord buildVssRecord(String storeId, KeyValue kv) {
return new VssDbRecord()
.setStoreId(storeId)
.setKey(kv.getKey())
.setValue(kv.getValue().toByteArray())
.setVersion(kv.getVersion());
}

@Override
public ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request) {
throw new UnsupportedOperationException("Operation not implemented");
}
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
CREATE TABLE vss_db (
store_id character varying(120) NOT NULL CHECK (store_id <> ''),
key character varying(120) NOT NULL,
value bytea NULL,
version bigint NOT NULL,
PRIMARY KEY (store_id, key)
);
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
100 changes: 81 additions & 19 deletions app/build.gradle
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,101 @@
buildscript {
ext.gradleVersion = '7.5.1'
ext.protobufPlugInVersion = '0.8.12'
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.gradleVersion = '7.5.1'
ext.protobufPlugInVersion = '0.8.12'
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.postgresVersion = '42.5.1'
ext.jooqVersion = '3.17.7'
ext.guiceVersion = '5.1.0'
}

plugins {
id 'java'
id 'com.google.protobuf' version "${protobufPlugInVersion}"
id 'war'
id 'idea'
id 'java'
id 'com.google.protobuf' version "${protobufPlugInVersion}"
id 'war'
id 'idea'
id 'nu.studer.jooq' version '8.0'
}

repositories {
mavenCentral()
mavenCentral()
}

idea {
module {
generatedSourceDirs.add(file("build/generated/proto/main"))
}
module {
generatedSourceDirs.add(file("build/generated/proto/main"))
}
}

group 'org.vss'
version '1.0'


dependencies {
implementation "com.google.protobuf:protobuf-java:$protobufVersion"
implementation "com.google.protobuf:protobuf-java:$protobufVersion"

//jOOQ & Postgres impl deps
implementation "org.jooq:jooq:$jooqVersion"
implementation "org.jooq:jooq-meta:$jooqVersion"
implementation "org.jooq:jooq-codegen:$jooqVersion"
runtimeOnly "org.postgresql:postgresql:$postgresVersion"
jooqGenerator "org.postgresql:postgresql:$postgresVersion"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
implementation "com.google.inject:guice:$guiceVersion"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:2.2"
testImplementation "org.testcontainers:junit-jupiter:1.17.6"
testImplementation "org.testcontainers:postgresql:1.17.6"
}

test {
useJUnitPlatform()
}
useJUnitPlatform()
}

protobuf {
protoc {
artifact = "com.google.protobuf:protoc:$protobufVersion"
}
}

jooq {
configurations {
main {
generateSchemaSourceOnCompilation = true

generationTool {
jdbc {
driver = 'org.postgresql.Driver'
url = 'jdbc:postgresql://localhost:5432/postgres'
user = 'postgres'
password = ''
properties {
property {
key = 'ssl'
value = 'false'
}
}
}
generator {
name = 'org.jooq.codegen.DefaultGenerator'
database {
name = 'org.jooq.meta.postgres.PostgresDatabase'
inputSchema = 'public'
}
generate {
deprecated = false
records = true
immutablePojos = true
fluentSetters = true
}
target {
packageName = 'org.vss.postgres'
directory = 'build/generated-src/jooq/main'
}
strategy.name = 'org.jooq.codegen.DefaultGeneratorStrategy'
}
}
}
}
}
12 changes: 12 additions & 0 deletions app/src/main/java/org/vss/KVStore.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
package org.vss;

public interface KVStore {

String GLOBAL_VERSION_KEY = "vss_global_version";

GetObjectResponse get(GetObjectRequest request);

PutObjectResponse put(PutObjectRequest request);

ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request);
}
7 changes: 7 additions & 0 deletions app/src/main/java/org/vss/exception/ConflictException.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
package org.vss.exception;

public class ConflictException extends RuntimeException {
public ConflictException(String message) {
super(message);
}
}
132 changes: 132 additions & 0 deletions app/src/main/java/org/vss/impl/postgres/PostgresBackendImpl.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
package org.vss.impl.postgres;

import com.google.inject.Inject;
import com.google.protobuf.ByteString;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.inject.Singleton;
import org.jooq.DSLContext;
import org.jooq.Insert;
import org.jooq.Query;
import org.jooq.Update;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;
import org.vss.PutObjectRequest;
import org.vss.PutObjectResponse;
import org.vss.exception.ConflictException;
import org.vss.postgres.tables.records.VssDbRecord;

import static org.jooq.impl.DSL.val;
import static org.vss.postgres.tables.VssDb.VSS_DB;

@Singleton
public class PostgresBackendImpl implements KVStore {

private final DSLContext context;

@Inject
public PostgresBackendImpl(DSLContext context) {
this.context = context;
}

@Override
public GetObjectResponse get(GetObjectRequest request) {

VssDbRecord vssDbRecord = context.selectFrom(VSS_DB)
.where(VSS_DB.STORE_ID.eq(request.getStoreId())
.and(VSS_DB.KEY.eq(request.getKey())))
.fetchOne();

final KeyValue keyValue;

if (vssDbRecord != null) {
keyValue = KeyValue.newBuilder()
.setKey(vssDbRecord.getKey())
.setValue(ByteString.copyFrom(vssDbRecord.getValue()))
.setVersion(vssDbRecord.getVersion())
.build();
} else {
keyValue = KeyValue.newBuilder()
.setKey(request.getKey()).build();
}
Comment on lines +53 to +56

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we return an error if there is no record for the key?

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 think an empty response is preferable in this case.
ResourceNotFound or 404 might represent a myriad of issues and things going wrong. (url wrong etc.)
In this case, we consider it a perfectly valid request to get a key which does not exist or to check existence of a key.
I see no harm in mixing keys that exist with no data and keys which don't exist, to make clients life easier instead of throwing an exception in one case.

Note: This is only applicable if client has permission to storeId, if not then we would want to throw ResourceNotFound.

However, this is a controversial topic and there are reasons to go either way.


return GetObjectResponse.newBuilder()
.setValue(keyValue)
.build();
}

@Override
public PutObjectResponse put(PutObjectRequest request) {

String storeId = request.getStoreId();

List<VssDbRecord> vssRecords = new ArrayList<>(request.getTransactionItemsList().stream()
.map(kv -> buildVssRecord(storeId, kv)).toList());

if (request.hasGlobalVersion()) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this doesn't increment the global version when it's not specified in the request. we always want to increment it, right?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I guess we could have the specifications say that it doesn't get incremented if not present in the request, but we should be explicit about it, since the developer might not expect that

@G8XSUG8XSUJan 25, 2023

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.

Based on how optimistic locking works, version needs to be provided by client in order to enact it.
So expectation is that we don't increment it and dont perform the check if developer doesn't supply it.

If global_version is not supplied, it means it is a non-global-version-check-required write.
We shouldn't be incrementing global_version in this case as client-side will not increment and has no way of knowing this without performing a sync.

Based on different application needs, some might not need a global_version check on every write, and this feature is meant to support those applications.

VssDbRecord globalVersionRecord = buildVssRecord(storeId,
KeyValue.newBuilder()
.setKey(GLOBAL_VERSION_KEY)
.setVersion(request.getGlobalVersion())
.build());

vssRecords.add(globalVersionRecord);
}

context.transaction((ctx) -> {
DSLContext dsl = ctx.dsl();
List<Query> batchQueries = vssRecords.stream()
.map(vssRecord -> buildPutObjectQuery(dsl, vssRecord)).toList();

int[] batchResult = dsl.batch(batchQueries).execute();

for (int numOfRowsUpdated : batchResult) {
if (numOfRowsUpdated == 0) {
throw new ConflictException(
"Transaction could not be completed due to a possible conflict");
}
}
});
Comment on lines +86 to +94

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could you test the case where one key failing causes the entire transaction to fail? (i.e., the successful key is not updated)


return PutObjectResponse.newBuilder().build();
}

private Query buildPutObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
return vssRecord.getVersion() == 0 ? buildInsertRecordQuery(dsl, vssRecord)
: buildUpdateRecordQuery(dsl, vssRecord);
}

private Insert<VssDbRecord> buildInsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.insertInto(VSS_DB)
.values(vssRecord.getStoreId(), vssRecord.getKey(),
vssRecord.getValue(), 1)
.onDuplicateKeyIgnore();
}

private Update<VssDbRecord> buildUpdateRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.update(VSS_DB)
.set(Map.of(VSS_DB.VALUE, vssRecord.getValue(),
VSS_DB.VERSION, vssRecord.getVersion() + 1))
.where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey()))
.and(VSS_DB.VERSION.eq(vssRecord.getVersion())));
}

private VssDbRecord buildVssRecord(String storeId, KeyValue kv) {
return new VssDbRecord()
.setStoreId(storeId)
.setKey(kv.getKey())
.setValue(kv.getValue().toByteArray())
.setVersion(kv.getVersion());
}

@Override
public ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request) {
throw new UnsupportedOperationException("Operation not implemented");
}
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
CREATE TABLE vss_db (
store_id character varying(120) NOT NULL CHECK (store_id <> ''),
key character varying(120) NOT NULL,
value bytea NULL,
version bigint NOT NULL,
PRIMARY KEY (store_id, key)
);
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
100 changes: 81 additions & 19 deletions app/build.gradle
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,101 @@
buildscript {
ext.gradleVersion = '7.5.1'
ext.protobufPlugInVersion = '0.8.12'
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.gradleVersion = '7.5.1'
ext.protobufPlugInVersion = '0.8.12'
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.postgresVersion = '42.5.1'
ext.jooqVersion = '3.17.7'
ext.guiceVersion = '5.1.0'
}

plugins {
id 'java'
id 'com.google.protobuf' version "${protobufPlugInVersion}"
id 'war'
id 'idea'
id 'java'
id 'com.google.protobuf' version "${protobufPlugInVersion}"
id 'war'
id 'idea'
id 'nu.studer.jooq' version '8.0'
}

repositories {
mavenCentral()
mavenCentral()
}

idea {
module {
generatedSourceDirs.add(file("build/generated/proto/main"))
}
module {
generatedSourceDirs.add(file("build/generated/proto/main"))
}
}

group 'org.vss'
version '1.0'


dependencies {
implementation "com.google.protobuf:protobuf-java:$protobufVersion"
implementation "com.google.protobuf:protobuf-java:$protobufVersion"

//jOOQ & Postgres impl deps
implementation "org.jooq:jooq:$jooqVersion"
implementation "org.jooq:jooq-meta:$jooqVersion"
implementation "org.jooq:jooq-codegen:$jooqVersion"
runtimeOnly "org.postgresql:postgresql:$postgresVersion"
jooqGenerator "org.postgresql:postgresql:$postgresVersion"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
implementation "com.google.inject:guice:$guiceVersion"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:2.2"
testImplementation "org.testcontainers:junit-jupiter:1.17.6"
testImplementation "org.testcontainers:postgresql:1.17.6"
}

test {
useJUnitPlatform()
}
useJUnitPlatform()
}

protobuf {
protoc {
artifact = "com.google.protobuf:protoc:$protobufVersion"
}
}

jooq {
configurations {
main {
generateSchemaSourceOnCompilation = true

generationTool {
jdbc {
driver = 'org.postgresql.Driver'
url = 'jdbc:postgresql://localhost:5432/postgres'
user = 'postgres'
password = ''
properties {
property {
key = 'ssl'
value = 'false'
}
}
}
generator {
name = 'org.jooq.codegen.DefaultGenerator'
database {
name = 'org.jooq.meta.postgres.PostgresDatabase'
inputSchema = 'public'
}
generate {
deprecated = false
records = true
immutablePojos = true
fluentSetters = true
}
target {
packageName = 'org.vss.postgres'
directory = 'build/generated-src/jooq/main'
}
strategy.name = 'org.jooq.codegen.DefaultGeneratorStrategy'
}
}
}
}
}
12 changes: 12 additions & 0 deletions app/src/main/java/org/vss/KVStore.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
package org.vss;

public interface KVStore {

String GLOBAL_VERSION_KEY = "vss_global_version";

GetObjectResponse get(GetObjectRequest request);

PutObjectResponse put(PutObjectRequest request);

ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request);
}
7 changes: 7 additions & 0 deletions app/src/main/java/org/vss/exception/ConflictException.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
package org.vss.exception;

public class ConflictException extends RuntimeException {
public ConflictException(String message) {
super(message);
}
}
132 changes: 132 additions & 0 deletions app/src/main/java/org/vss/impl/postgres/PostgresBackendImpl.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
package org.vss.impl.postgres;

import com.google.inject.Inject;
import com.google.protobuf.ByteString;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.inject.Singleton;
import org.jooq.DSLContext;
import org.jooq.Insert;
import org.jooq.Query;
import org.jooq.Update;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;
import org.vss.PutObjectRequest;
import org.vss.PutObjectResponse;
import org.vss.exception.ConflictException;
import org.vss.postgres.tables.records.VssDbRecord;

import static org.jooq.impl.DSL.val;
import static org.vss.postgres.tables.VssDb.VSS_DB;

@Singleton
public class PostgresBackendImpl implements KVStore {

private final DSLContext context;

@Inject
public PostgresBackendImpl(DSLContext context) {
this.context = context;
}

@Override
public GetObjectResponse get(GetObjectRequest request) {

VssDbRecord vssDbRecord = context.selectFrom(VSS_DB)
.where(VSS_DB.STORE_ID.eq(request.getStoreId())
.and(VSS_DB.KEY.eq(request.getKey())))
.fetchOne();

final KeyValue keyValue;

if (vssDbRecord != null) {
keyValue = KeyValue.newBuilder()
.setKey(vssDbRecord.getKey())
.setValue(ByteString.copyFrom(vssDbRecord.getValue()))
.setVersion(vssDbRecord.getVersion())
.build();
} else {
keyValue = KeyValue.newBuilder()
.setKey(request.getKey()).build();
}
Comment on lines +53 to +56

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we return an error if there is no record for the key?

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 think an empty response is preferable in this case.
ResourceNotFound or 404 might represent a myriad of issues and things going wrong. (url wrong etc.)
In this case, we consider it a perfectly valid request to get a key which does not exist or to check existence of a key.
I see no harm in mixing keys that exist with no data and keys which don't exist, to make clients life easier instead of throwing an exception in one case.

Note: This is only applicable if client has permission to storeId, if not then we would want to throw ResourceNotFound.

However, this is a controversial topic and there are reasons to go either way.


return GetObjectResponse.newBuilder()
.setValue(keyValue)
.build();
}

@Override
public PutObjectResponse put(PutObjectRequest request) {

String storeId = request.getStoreId();

List<VssDbRecord> vssRecords = new ArrayList<>(request.getTransactionItemsList().stream()
.map(kv -> buildVssRecord(storeId, kv)).toList());

if (request.hasGlobalVersion()) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this doesn't increment the global version when it's not specified in the request. we always want to increment it, right?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I guess we could have the specifications say that it doesn't get incremented if not present in the request, but we should be explicit about it, since the developer might not expect that

@G8XSUG8XSUJan 25, 2023

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.

Based on how optimistic locking works, version needs to be provided by client in order to enact it.
So expectation is that we don't increment it and dont perform the check if developer doesn't supply it.

If global_version is not supplied, it means it is a non-global-version-check-required write.
We shouldn't be incrementing global_version in this case as client-side will not increment and has no way of knowing this without performing a sync.

Based on different application needs, some might not need a global_version check on every write, and this feature is meant to support those applications.

VssDbRecord globalVersionRecord = buildVssRecord(storeId,
KeyValue.newBuilder()
.setKey(GLOBAL_VERSION_KEY)
.setVersion(request.getGlobalVersion())
.build());

vssRecords.add(globalVersionRecord);
}

context.transaction((ctx) -> {
DSLContext dsl = ctx.dsl();
List<Query> batchQueries = vssRecords.stream()
.map(vssRecord -> buildPutObjectQuery(dsl, vssRecord)).toList();

int[] batchResult = dsl.batch(batchQueries).execute();

for (int numOfRowsUpdated : batchResult) {
if (numOfRowsUpdated == 0) {
throw new ConflictException(
"Transaction could not be completed due to a possible conflict");
}
}
});
Comment on lines +86 to +94

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could you test the case where one key failing causes the entire transaction to fail? (i.e., the successful key is not updated)


return PutObjectResponse.newBuilder().build();
}

private Query buildPutObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
return vssRecord.getVersion() == 0 ? buildInsertRecordQuery(dsl, vssRecord)
: buildUpdateRecordQuery(dsl, vssRecord);
}

private Insert<VssDbRecord> buildInsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.insertInto(VSS_DB)
.values(vssRecord.getStoreId(), vssRecord.getKey(),
vssRecord.getValue(), 1)
.onDuplicateKeyIgnore();
}

private Update<VssDbRecord> buildUpdateRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.update(VSS_DB)
.set(Map.of(VSS_DB.VALUE, vssRecord.getValue(),
VSS_DB.VERSION, vssRecord.getVersion() + 1))
.where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey()))
.and(VSS_DB.VERSION.eq(vssRecord.getVersion())));
}

private VssDbRecord buildVssRecord(String storeId, KeyValue kv) {
return new VssDbRecord()
.setStoreId(storeId)
.setKey(kv.getKey())
.setValue(kv.getValue().toByteArray())
.setVersion(kv.getVersion());
}

@Override
public ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request) {
throw new UnsupportedOperationException("Operation not implemented");
}
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
CREATE TABLE vss_db (
store_id character varying(120) NOT NULL CHECK (store_id <> ''),
key character varying(120) NOT NULL,
value bytea NULL,
version bigint NOT NULL,
PRIMARY KEY (store_id, key)
);
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
100 changes: 81 additions & 19 deletions app/build.gradle
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,101 @@
buildscript {
ext.gradleVersion = '7.5.1'
ext.protobufPlugInVersion = '0.8.12'
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.gradleVersion = '7.5.1'
ext.protobufPlugInVersion = '0.8.12'
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.postgresVersion = '42.5.1'
ext.jooqVersion = '3.17.7'
ext.guiceVersion = '5.1.0'
}

plugins {
id 'java'
id 'com.google.protobuf' version "${protobufPlugInVersion}"
id 'war'
id 'idea'
id 'java'
id 'com.google.protobuf' version "${protobufPlugInVersion}"
id 'war'
id 'idea'
id 'nu.studer.jooq' version '8.0'
}

repositories {
mavenCentral()
mavenCentral()
}

idea {
module {
generatedSourceDirs.add(file("build/generated/proto/main"))
}
module {
generatedSourceDirs.add(file("build/generated/proto/main"))
}
}

group 'org.vss'
version '1.0'


dependencies {
implementation "com.google.protobuf:protobuf-java:$protobufVersion"
implementation "com.google.protobuf:protobuf-java:$protobufVersion"

//jOOQ & Postgres impl deps
implementation "org.jooq:jooq:$jooqVersion"
implementation "org.jooq:jooq-meta:$jooqVersion"
implementation "org.jooq:jooq-codegen:$jooqVersion"
runtimeOnly "org.postgresql:postgresql:$postgresVersion"
jooqGenerator "org.postgresql:postgresql:$postgresVersion"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
implementation "com.google.inject:guice:$guiceVersion"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:2.2"
testImplementation "org.testcontainers:junit-jupiter:1.17.6"
testImplementation "org.testcontainers:postgresql:1.17.6"
}

test {
useJUnitPlatform()
}
useJUnitPlatform()
}

protobuf {
protoc {
artifact = "com.google.protobuf:protoc:$protobufVersion"
}
}

jooq {
configurations {
main {
generateSchemaSourceOnCompilation = true

generationTool {
jdbc {
driver = 'org.postgresql.Driver'
url = 'jdbc:postgresql://localhost:5432/postgres'
user = 'postgres'
password = ''
properties {
property {
key = 'ssl'
value = 'false'
}
}
}
generator {
name = 'org.jooq.codegen.DefaultGenerator'
database {
name = 'org.jooq.meta.postgres.PostgresDatabase'
inputSchema = 'public'
}
generate {
deprecated = false
records = true
immutablePojos = true
fluentSetters = true
}
target {
packageName = 'org.vss.postgres'
directory = 'build/generated-src/jooq/main'
}
strategy.name = 'org.jooq.codegen.DefaultGeneratorStrategy'
}
}
}
}
}
12 changes: 12 additions & 0 deletions app/src/main/java/org/vss/KVStore.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
package org.vss;

public interface KVStore {

String GLOBAL_VERSION_KEY = "vss_global_version";

GetObjectResponse get(GetObjectRequest request);

PutObjectResponse put(PutObjectRequest request);

ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request);
}
7 changes: 7 additions & 0 deletions app/src/main/java/org/vss/exception/ConflictException.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
package org.vss.exception;

public class ConflictException extends RuntimeException {
public ConflictException(String message) {
super(message);
}
}
132 changes: 132 additions & 0 deletions app/src/main/java/org/vss/impl/postgres/PostgresBackendImpl.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
package org.vss.impl.postgres;

import com.google.inject.Inject;
import com.google.protobuf.ByteString;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.inject.Singleton;
import org.jooq.DSLContext;
import org.jooq.Insert;
import org.jooq.Query;
import org.jooq.Update;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;
import org.vss.PutObjectRequest;
import org.vss.PutObjectResponse;
import org.vss.exception.ConflictException;
import org.vss.postgres.tables.records.VssDbRecord;

import static org.jooq.impl.DSL.val;
import static org.vss.postgres.tables.VssDb.VSS_DB;

@Singleton
public class PostgresBackendImpl implements KVStore {

private final DSLContext context;

@Inject
public PostgresBackendImpl(DSLContext context) {
this.context = context;
}

@Override
public GetObjectResponse get(GetObjectRequest request) {

VssDbRecord vssDbRecord = context.selectFrom(VSS_DB)
.where(VSS_DB.STORE_ID.eq(request.getStoreId())
.and(VSS_DB.KEY.eq(request.getKey())))
.fetchOne();

final KeyValue keyValue;

if (vssDbRecord != null) {
keyValue = KeyValue.newBuilder()
.setKey(vssDbRecord.getKey())
.setValue(ByteString.copyFrom(vssDbRecord.getValue()))
.setVersion(vssDbRecord.getVersion())
.build();
} else {
keyValue = KeyValue.newBuilder()
.setKey(request.getKey()).build();
}
Comment on lines +53 to +56

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we return an error if there is no record for the key?

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 think an empty response is preferable in this case.
ResourceNotFound or 404 might represent a myriad of issues and things going wrong. (url wrong etc.)
In this case, we consider it a perfectly valid request to get a key which does not exist or to check existence of a key.
I see no harm in mixing keys that exist with no data and keys which don't exist, to make clients life easier instead of throwing an exception in one case.

Note: This is only applicable if client has permission to storeId, if not then we would want to throw ResourceNotFound.

However, this is a controversial topic and there are reasons to go either way.


return GetObjectResponse.newBuilder()
.setValue(keyValue)
.build();
}

@Override
public PutObjectResponse put(PutObjectRequest request) {

String storeId = request.getStoreId();

List<VssDbRecord> vssRecords = new ArrayList<>(request.getTransactionItemsList().stream()
.map(kv -> buildVssRecord(storeId, kv)).toList());

if (request.hasGlobalVersion()) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this doesn't increment the global version when it's not specified in the request. we always want to increment it, right?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I guess we could have the specifications say that it doesn't get incremented if not present in the request, but we should be explicit about it, since the developer might not expect that

@G8XSUG8XSUJan 25, 2023

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.

Based on how optimistic locking works, version needs to be provided by client in order to enact it.
So expectation is that we don't increment it and dont perform the check if developer doesn't supply it.

If global_version is not supplied, it means it is a non-global-version-check-required write.
We shouldn't be incrementing global_version in this case as client-side will not increment and has no way of knowing this without performing a sync.

Based on different application needs, some might not need a global_version check on every write, and this feature is meant to support those applications.

VssDbRecord globalVersionRecord = buildVssRecord(storeId,
KeyValue.newBuilder()
.setKey(GLOBAL_VERSION_KEY)
.setVersion(request.getGlobalVersion())
.build());

vssRecords.add(globalVersionRecord);
}

context.transaction((ctx) -> {
DSLContext dsl = ctx.dsl();
List<Query> batchQueries = vssRecords.stream()
.map(vssRecord -> buildPutObjectQuery(dsl, vssRecord)).toList();

int[] batchResult = dsl.batch(batchQueries).execute();

for (int numOfRowsUpdated : batchResult) {
if (numOfRowsUpdated == 0) {
throw new ConflictException(
"Transaction could not be completed due to a possible conflict");
}
}
});
Comment on lines +86 to +94

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could you test the case where one key failing causes the entire transaction to fail? (i.e., the successful key is not updated)


return PutObjectResponse.newBuilder().build();
}

private Query buildPutObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
return vssRecord.getVersion() == 0 ? buildInsertRecordQuery(dsl, vssRecord)
: buildUpdateRecordQuery(dsl, vssRecord);
}

private Insert<VssDbRecord> buildInsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.insertInto(VSS_DB)
.values(vssRecord.getStoreId(), vssRecord.getKey(),
vssRecord.getValue(), 1)
.onDuplicateKeyIgnore();
}

private Update<VssDbRecord> buildUpdateRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.update(VSS_DB)
.set(Map.of(VSS_DB.VALUE, vssRecord.getValue(),
VSS_DB.VERSION, vssRecord.getVersion() + 1))
.where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey()))
.and(VSS_DB.VERSION.eq(vssRecord.getVersion())));
}

private VssDbRecord buildVssRecord(String storeId, KeyValue kv) {
return new VssDbRecord()
.setStoreId(storeId)
.setKey(kv.getKey())
.setValue(kv.getValue().toByteArray())
.setVersion(kv.getVersion());
}

@Override
public ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request) {
throw new UnsupportedOperationException("Operation not implemented");
}
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
CREATE TABLE vss_db (
store_id character varying(120) NOT NULL CHECK (store_id <> ''),
key character varying(120) NOT NULL,
value bytea NULL,
version bigint NOT NULL,
PRIMARY KEY (store_id, key)
);
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
100 changes: 81 additions & 19 deletions app/build.gradle
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,101 @@
buildscript {
ext.gradleVersion = '7.5.1'
ext.protobufPlugInVersion = '0.8.12'
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.gradleVersion = '7.5.1'
ext.protobufPlugInVersion = '0.8.12'
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.postgresVersion = '42.5.1'
ext.jooqVersion = '3.17.7'
ext.guiceVersion = '5.1.0'
}

plugins {
id 'java'
id 'com.google.protobuf' version "${protobufPlugInVersion}"
id 'war'
id 'idea'
id 'java'
id 'com.google.protobuf' version "${protobufPlugInVersion}"
id 'war'
id 'idea'
id 'nu.studer.jooq' version '8.0'
}

repositories {
mavenCentral()
mavenCentral()
}

idea {
module {
generatedSourceDirs.add(file("build/generated/proto/main"))
}
module {
generatedSourceDirs.add(file("build/generated/proto/main"))
}
}

group 'org.vss'
version '1.0'


dependencies {
implementation "com.google.protobuf:protobuf-java:$protobufVersion"
implementation "com.google.protobuf:protobuf-java:$protobufVersion"

//jOOQ & Postgres impl deps
implementation "org.jooq:jooq:$jooqVersion"
implementation "org.jooq:jooq-meta:$jooqVersion"
implementation "org.jooq:jooq-codegen:$jooqVersion"
runtimeOnly "org.postgresql:postgresql:$postgresVersion"
jooqGenerator "org.postgresql:postgresql:$postgresVersion"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
implementation "com.google.inject:guice:$guiceVersion"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:2.2"
testImplementation "org.testcontainers:junit-jupiter:1.17.6"
testImplementation "org.testcontainers:postgresql:1.17.6"
}

test {
useJUnitPlatform()
}
useJUnitPlatform()
}

protobuf {
protoc {
artifact = "com.google.protobuf:protoc:$protobufVersion"
}
}

jooq {
configurations {
main {
generateSchemaSourceOnCompilation = true

generationTool {
jdbc {
driver = 'org.postgresql.Driver'
url = 'jdbc:postgresql://localhost:5432/postgres'
user = 'postgres'
password = ''
properties {
property {
key = 'ssl'
value = 'false'
}
}
}
generator {
name = 'org.jooq.codegen.DefaultGenerator'
database {
name = 'org.jooq.meta.postgres.PostgresDatabase'
inputSchema = 'public'
}
generate {
deprecated = false
records = true
immutablePojos = true
fluentSetters = true
}
target {
packageName = 'org.vss.postgres'
directory = 'build/generated-src/jooq/main'
}
strategy.name = 'org.jooq.codegen.DefaultGeneratorStrategy'
}
}
}
}
}
12 changes: 12 additions & 0 deletions app/src/main/java/org/vss/KVStore.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
package org.vss;

public interface KVStore {

String GLOBAL_VERSION_KEY = "vss_global_version";

GetObjectResponse get(GetObjectRequest request);

PutObjectResponse put(PutObjectRequest request);

ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request);
}
7 changes: 7 additions & 0 deletions app/src/main/java/org/vss/exception/ConflictException.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
package org.vss.exception;

public class ConflictException extends RuntimeException {
public ConflictException(String message) {
super(message);
}
}
132 changes: 132 additions & 0 deletions app/src/main/java/org/vss/impl/postgres/PostgresBackendImpl.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
package org.vss.impl.postgres;

import com.google.inject.Inject;
import com.google.protobuf.ByteString;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.inject.Singleton;
import org.jooq.DSLContext;
import org.jooq.Insert;
import org.jooq.Query;
import org.jooq.Update;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;
import org.vss.PutObjectRequest;
import org.vss.PutObjectResponse;
import org.vss.exception.ConflictException;
import org.vss.postgres.tables.records.VssDbRecord;

import static org.jooq.impl.DSL.val;
import static org.vss.postgres.tables.VssDb.VSS_DB;

@Singleton
public class PostgresBackendImpl implements KVStore {

private final DSLContext context;

@Inject
public PostgresBackendImpl(DSLContext context) {
this.context = context;
}

@Override
public GetObjectResponse get(GetObjectRequest request) {

VssDbRecord vssDbRecord = context.selectFrom(VSS_DB)
.where(VSS_DB.STORE_ID.eq(request.getStoreId())
.and(VSS_DB.KEY.eq(request.getKey())))
.fetchOne();

final KeyValue keyValue;

if (vssDbRecord != null) {
keyValue = KeyValue.newBuilder()
.setKey(vssDbRecord.getKey())
.setValue(ByteString.copyFrom(vssDbRecord.getValue()))
.setVersion(vssDbRecord.getVersion())
.build();
} else {
keyValue = KeyValue.newBuilder()
.setKey(request.getKey()).build();
}
Comment on lines +53 to +56

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we return an error if there is no record for the key?

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 think an empty response is preferable in this case.
ResourceNotFound or 404 might represent a myriad of issues and things going wrong. (url wrong etc.)
In this case, we consider it a perfectly valid request to get a key which does not exist or to check existence of a key.
I see no harm in mixing keys that exist with no data and keys which don't exist, to make clients life easier instead of throwing an exception in one case.

Note: This is only applicable if client has permission to storeId, if not then we would want to throw ResourceNotFound.

However, this is a controversial topic and there are reasons to go either way.


return GetObjectResponse.newBuilder()
.setValue(keyValue)
.build();
}

@Override
public PutObjectResponse put(PutObjectRequest request) {

String storeId = request.getStoreId();

List<VssDbRecord> vssRecords = new ArrayList<>(request.getTransactionItemsList().stream()
.map(kv -> buildVssRecord(storeId, kv)).toList());

if (request.hasGlobalVersion()) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this doesn't increment the global version when it's not specified in the request. we always want to increment it, right?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I guess we could have the specifications say that it doesn't get incremented if not present in the request, but we should be explicit about it, since the developer might not expect that

@G8XSUG8XSUJan 25, 2023

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.

Based on how optimistic locking works, version needs to be provided by client in order to enact it.
So expectation is that we don't increment it and dont perform the check if developer doesn't supply it.

If global_version is not supplied, it means it is a non-global-version-check-required write.
We shouldn't be incrementing global_version in this case as client-side will not increment and has no way of knowing this without performing a sync.

Based on different application needs, some might not need a global_version check on every write, and this feature is meant to support those applications.

VssDbRecord globalVersionRecord = buildVssRecord(storeId,
KeyValue.newBuilder()
.setKey(GLOBAL_VERSION_KEY)
.setVersion(request.getGlobalVersion())
.build());

vssRecords.add(globalVersionRecord);
}

context.transaction((ctx) -> {
DSLContext dsl = ctx.dsl();
List<Query> batchQueries = vssRecords.stream()
.map(vssRecord -> buildPutObjectQuery(dsl, vssRecord)).toList();

int[] batchResult = dsl.batch(batchQueries).execute();

for (int numOfRowsUpdated : batchResult) {
if (numOfRowsUpdated == 0) {
throw new ConflictException(
"Transaction could not be completed due to a possible conflict");
}
}
});
Comment on lines +86 to +94

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could you test the case where one key failing causes the entire transaction to fail? (i.e., the successful key is not updated)


return PutObjectResponse.newBuilder().build();
}

private Query buildPutObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
return vssRecord.getVersion() == 0 ? buildInsertRecordQuery(dsl, vssRecord)
: buildUpdateRecordQuery(dsl, vssRecord);
}

private Insert<VssDbRecord> buildInsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.insertInto(VSS_DB)
.values(vssRecord.getStoreId(), vssRecord.getKey(),
vssRecord.getValue(), 1)
.onDuplicateKeyIgnore();
}

private Update<VssDbRecord> buildUpdateRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.update(VSS_DB)
.set(Map.of(VSS_DB.VALUE, vssRecord.getValue(),
VSS_DB.VERSION, vssRecord.getVersion() + 1))
.where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey()))
.and(VSS_DB.VERSION.eq(vssRecord.getVersion())));
}

private VssDbRecord buildVssRecord(String storeId, KeyValue kv) {
return new VssDbRecord()
.setStoreId(storeId)
.setKey(kv.getKey())
.setValue(kv.getValue().toByteArray())
.setVersion(kv.getVersion());
}

@Override
public ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request) {
throw new UnsupportedOperationException("Operation not implemented");
}
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
CREATE TABLE vss_db (
store_id character varying(120) NOT NULL CHECK (store_id <> ''),
key character varying(120) NOT NULL,
value bytea NULL,
version bigint NOT NULL,
PRIMARY KEY (store_id, key)
);
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
100 changes: 81 additions & 19 deletions app/build.gradle
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,101 @@
buildscript {
ext.gradleVersion = '7.5.1'
ext.protobufPlugInVersion = '0.8.12'
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.gradleVersion = '7.5.1'
ext.protobufPlugInVersion = '0.8.12'
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.postgresVersion = '42.5.1'
ext.jooqVersion = '3.17.7'
ext.guiceVersion = '5.1.0'
}

plugins {
id 'java'
id 'com.google.protobuf' version "${protobufPlugInVersion}"
id 'war'
id 'idea'
id 'java'
id 'com.google.protobuf' version "${protobufPlugInVersion}"
id 'war'
id 'idea'
id 'nu.studer.jooq' version '8.0'
}

repositories {
mavenCentral()
mavenCentral()
}

idea {
module {
generatedSourceDirs.add(file("build/generated/proto/main"))
}
module {
generatedSourceDirs.add(file("build/generated/proto/main"))
}
}

group 'org.vss'
version '1.0'


dependencies {
implementation "com.google.protobuf:protobuf-java:$protobufVersion"
implementation "com.google.protobuf:protobuf-java:$protobufVersion"

//jOOQ & Postgres impl deps
implementation "org.jooq:jooq:$jooqVersion"
implementation "org.jooq:jooq-meta:$jooqVersion"
implementation "org.jooq:jooq-codegen:$jooqVersion"
runtimeOnly "org.postgresql:postgresql:$postgresVersion"
jooqGenerator "org.postgresql:postgresql:$postgresVersion"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
implementation "com.google.inject:guice:$guiceVersion"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:2.2"
testImplementation "org.testcontainers:junit-jupiter:1.17.6"
testImplementation "org.testcontainers:postgresql:1.17.6"
}

test {
useJUnitPlatform()
}
useJUnitPlatform()
}

protobuf {
protoc {
artifact = "com.google.protobuf:protoc:$protobufVersion"
}
}

jooq {
configurations {
main {
generateSchemaSourceOnCompilation = true

generationTool {
jdbc {
driver = 'org.postgresql.Driver'
url = 'jdbc:postgresql://localhost:5432/postgres'
user = 'postgres'
password = ''
properties {
property {
key = 'ssl'
value = 'false'
}
}
}
generator {
name = 'org.jooq.codegen.DefaultGenerator'
database {
name = 'org.jooq.meta.postgres.PostgresDatabase'
inputSchema = 'public'
}
generate {
deprecated = false
records = true
immutablePojos = true
fluentSetters = true
}
target {
packageName = 'org.vss.postgres'
directory = 'build/generated-src/jooq/main'
}
strategy.name = 'org.jooq.codegen.DefaultGeneratorStrategy'
}
}
}
}
}
12 changes: 12 additions & 0 deletions app/src/main/java/org/vss/KVStore.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
package org.vss;

public interface KVStore {

String GLOBAL_VERSION_KEY = "vss_global_version";

GetObjectResponse get(GetObjectRequest request);

PutObjectResponse put(PutObjectRequest request);

ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request);
}
7 changes: 7 additions & 0 deletions app/src/main/java/org/vss/exception/ConflictException.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
package org.vss.exception;

public class ConflictException extends RuntimeException {
public ConflictException(String message) {
super(message);
}
}
132 changes: 132 additions & 0 deletions app/src/main/java/org/vss/impl/postgres/PostgresBackendImpl.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
package org.vss.impl.postgres;

import com.google.inject.Inject;
import com.google.protobuf.ByteString;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.inject.Singleton;
import org.jooq.DSLContext;
import org.jooq.Insert;
import org.jooq.Query;
import org.jooq.Update;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;
import org.vss.PutObjectRequest;
import org.vss.PutObjectResponse;
import org.vss.exception.ConflictException;
import org.vss.postgres.tables.records.VssDbRecord;

import static org.jooq.impl.DSL.val;
import static org.vss.postgres.tables.VssDb.VSS_DB;

@Singleton
public class PostgresBackendImpl implements KVStore {

private final DSLContext context;

@Inject
public PostgresBackendImpl(DSLContext context) {
this.context = context;
}

@Override
public GetObjectResponse get(GetObjectRequest request) {

VssDbRecord vssDbRecord = context.selectFrom(VSS_DB)
.where(VSS_DB.STORE_ID.eq(request.getStoreId())
.and(VSS_DB.KEY.eq(request.getKey())))
.fetchOne();

final KeyValue keyValue;

if (vssDbRecord != null) {
keyValue = KeyValue.newBuilder()
.setKey(vssDbRecord.getKey())
.setValue(ByteString.copyFrom(vssDbRecord.getValue()))
.setVersion(vssDbRecord.getVersion())
.build();
} else {
keyValue = KeyValue.newBuilder()
.setKey(request.getKey()).build();
}
Comment on lines +53 to +56

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we return an error if there is no record for the key?

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 think an empty response is preferable in this case.
ResourceNotFound or 404 might represent a myriad of issues and things going wrong. (url wrong etc.)
In this case, we consider it a perfectly valid request to get a key which does not exist or to check existence of a key.
I see no harm in mixing keys that exist with no data and keys which don't exist, to make clients life easier instead of throwing an exception in one case.

Note: This is only applicable if client has permission to storeId, if not then we would want to throw ResourceNotFound.

However, this is a controversial topic and there are reasons to go either way.


return GetObjectResponse.newBuilder()
.setValue(keyValue)
.build();
}

@Override
public PutObjectResponse put(PutObjectRequest request) {

String storeId = request.getStoreId();

List<VssDbRecord> vssRecords = new ArrayList<>(request.getTransactionItemsList().stream()
.map(kv -> buildVssRecord(storeId, kv)).toList());

if (request.hasGlobalVersion()) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this doesn't increment the global version when it's not specified in the request. we always want to increment it, right?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I guess we could have the specifications say that it doesn't get incremented if not present in the request, but we should be explicit about it, since the developer might not expect that

@G8XSUG8XSUJan 25, 2023

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.

Based on how optimistic locking works, version needs to be provided by client in order to enact it.
So expectation is that we don't increment it and dont perform the check if developer doesn't supply it.

If global_version is not supplied, it means it is a non-global-version-check-required write.
We shouldn't be incrementing global_version in this case as client-side will not increment and has no way of knowing this without performing a sync.

Based on different application needs, some might not need a global_version check on every write, and this feature is meant to support those applications.

VssDbRecord globalVersionRecord = buildVssRecord(storeId,
KeyValue.newBuilder()
.setKey(GLOBAL_VERSION_KEY)
.setVersion(request.getGlobalVersion())
.build());

vssRecords.add(globalVersionRecord);
}

context.transaction((ctx) -> {
DSLContext dsl = ctx.dsl();
List<Query> batchQueries = vssRecords.stream()
.map(vssRecord -> buildPutObjectQuery(dsl, vssRecord)).toList();

int[] batchResult = dsl.batch(batchQueries).execute();

for (int numOfRowsUpdated : batchResult) {
if (numOfRowsUpdated == 0) {
throw new ConflictException(
"Transaction could not be completed due to a possible conflict");
}
}
});
Comment on lines +86 to +94

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could you test the case where one key failing causes the entire transaction to fail? (i.e., the successful key is not updated)


return PutObjectResponse.newBuilder().build();
}

private Query buildPutObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
return vssRecord.getVersion() == 0 ? buildInsertRecordQuery(dsl, vssRecord)
: buildUpdateRecordQuery(dsl, vssRecord);
}

private Insert<VssDbRecord> buildInsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.insertInto(VSS_DB)
.values(vssRecord.getStoreId(), vssRecord.getKey(),
vssRecord.getValue(), 1)
.onDuplicateKeyIgnore();
}

private Update<VssDbRecord> buildUpdateRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.update(VSS_DB)
.set(Map.of(VSS_DB.VALUE, vssRecord.getValue(),
VSS_DB.VERSION, vssRecord.getVersion() + 1))
.where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey()))
.and(VSS_DB.VERSION.eq(vssRecord.getVersion())));
}

private VssDbRecord buildVssRecord(String storeId, KeyValue kv) {
return new VssDbRecord()
.setStoreId(storeId)
.setKey(kv.getKey())
.setValue(kv.getValue().toByteArray())
.setVersion(kv.getVersion());
}

@Override
public ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request) {
throw new UnsupportedOperationException("Operation not implemented");
}
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
CREATE TABLE vss_db (
store_id character varying(120) NOT NULL CHECK (store_id <> ''),
key character varying(120) NOT NULL,
value bytea NULL,
version bigint NOT NULL,
PRIMARY KEY (store_id, key)
);
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
100 changes: 81 additions & 19 deletions app/build.gradle
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,101 @@
buildscript {
ext.gradleVersion = '7.5.1'
ext.protobufPlugInVersion = '0.8.12'
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.gradleVersion = '7.5.1'
ext.protobufPlugInVersion = '0.8.12'
ext.protobufVersion = '3.21.7'
ext.jerseyVersion = '3.1.0'
ext.junitVersion = '5.9.0'
ext.postgresVersion = '42.5.1'
ext.jooqVersion = '3.17.7'
ext.guiceVersion = '5.1.0'
}

plugins {
id 'java'
id 'com.google.protobuf' version "${protobufPlugInVersion}"
id 'war'
id 'idea'
id 'java'
id 'com.google.protobuf' version "${protobufPlugInVersion}"
id 'war'
id 'idea'
id 'nu.studer.jooq' version '8.0'
}

repositories {
mavenCentral()
mavenCentral()
}

idea {
module {
generatedSourceDirs.add(file("build/generated/proto/main"))
}
module {
generatedSourceDirs.add(file("build/generated/proto/main"))
}
}

group 'org.vss'
version '1.0'


dependencies {
implementation "com.google.protobuf:protobuf-java:$protobufVersion"
implementation "com.google.protobuf:protobuf-java:$protobufVersion"

//jOOQ & Postgres impl deps
implementation "org.jooq:jooq:$jooqVersion"
implementation "org.jooq:jooq-meta:$jooqVersion"
implementation "org.jooq:jooq-codegen:$jooqVersion"
runtimeOnly "org.postgresql:postgresql:$postgresVersion"
jooqGenerator "org.postgresql:postgresql:$postgresVersion"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
implementation "com.google.inject:guice:$guiceVersion"

testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:2.2"
testImplementation "org.testcontainers:junit-jupiter:1.17.6"
testImplementation "org.testcontainers:postgresql:1.17.6"
}

test {
useJUnitPlatform()
}
useJUnitPlatform()
}

protobuf {
protoc {
artifact = "com.google.protobuf:protoc:$protobufVersion"
}
}

jooq {
configurations {
main {
generateSchemaSourceOnCompilation = true

generationTool {
jdbc {
driver = 'org.postgresql.Driver'
url = 'jdbc:postgresql://localhost:5432/postgres'
user = 'postgres'
password = ''
properties {
property {
key = 'ssl'
value = 'false'
}
}
}
generator {
name = 'org.jooq.codegen.DefaultGenerator'
database {
name = 'org.jooq.meta.postgres.PostgresDatabase'
inputSchema = 'public'
}
generate {
deprecated = false
records = true
immutablePojos = true
fluentSetters = true
}
target {
packageName = 'org.vss.postgres'
directory = 'build/generated-src/jooq/main'
}
strategy.name = 'org.jooq.codegen.DefaultGeneratorStrategy'
}
}
}
}
}
12 changes: 12 additions & 0 deletions app/src/main/java/org/vss/KVStore.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
package org.vss;

public interface KVStore {

String GLOBAL_VERSION_KEY = "vss_global_version";

GetObjectResponse get(GetObjectRequest request);

PutObjectResponse put(PutObjectRequest request);

ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request);
}
7 changes: 7 additions & 0 deletions app/src/main/java/org/vss/exception/ConflictException.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
package org.vss.exception;

public class ConflictException extends RuntimeException {
public ConflictException(String message) {
super(message);
}
}
132 changes: 132 additions & 0 deletions app/src/main/java/org/vss/impl/postgres/PostgresBackendImpl.java
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
package org.vss.impl.postgres;

import com.google.inject.Inject;
import com.google.protobuf.ByteString;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.inject.Singleton;
import org.jooq.DSLContext;
import org.jooq.Insert;
import org.jooq.Query;
import org.jooq.Update;
import org.vss.GetObjectRequest;
import org.vss.GetObjectResponse;
import org.vss.KVStore;
import org.vss.KeyValue;
import org.vss.ListKeyVersionsRequest;
import org.vss.ListKeyVersionsResponse;
import org.vss.PutObjectRequest;
import org.vss.PutObjectResponse;
import org.vss.exception.ConflictException;
import org.vss.postgres.tables.records.VssDbRecord;

import static org.jooq.impl.DSL.val;
import static org.vss.postgres.tables.VssDb.VSS_DB;

@Singleton
public class PostgresBackendImpl implements KVStore {

private final DSLContext context;

@Inject
public PostgresBackendImpl(DSLContext context) {
this.context = context;
}

@Override
public GetObjectResponse get(GetObjectRequest request) {

VssDbRecord vssDbRecord = context.selectFrom(VSS_DB)
.where(VSS_DB.STORE_ID.eq(request.getStoreId())
.and(VSS_DB.KEY.eq(request.getKey())))
.fetchOne();

final KeyValue keyValue;

if (vssDbRecord != null) {
keyValue = KeyValue.newBuilder()
.setKey(vssDbRecord.getKey())
.setValue(ByteString.copyFrom(vssDbRecord.getValue()))
.setVersion(vssDbRecord.getVersion())
.build();
} else {
keyValue = KeyValue.newBuilder()
.setKey(request.getKey()).build();
}
Comment on lines +53 to +56

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we return an error if there is no record for the key?

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 think an empty response is preferable in this case.
ResourceNotFound or 404 might represent a myriad of issues and things going wrong. (url wrong etc.)
In this case, we consider it a perfectly valid request to get a key which does not exist or to check existence of a key.
I see no harm in mixing keys that exist with no data and keys which don't exist, to make clients life easier instead of throwing an exception in one case.

Note: This is only applicable if client has permission to storeId, if not then we would want to throw ResourceNotFound.

However, this is a controversial topic and there are reasons to go either way.


return GetObjectResponse.newBuilder()
.setValue(keyValue)
.build();
}

@Override
public PutObjectResponse put(PutObjectRequest request) {

String storeId = request.getStoreId();

List<VssDbRecord> vssRecords = new ArrayList<>(request.getTransactionItemsList().stream()
.map(kv -> buildVssRecord(storeId, kv)).toList());

if (request.hasGlobalVersion()) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this doesn't increment the global version when it's not specified in the request. we always want to increment it, right?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I guess we could have the specifications say that it doesn't get incremented if not present in the request, but we should be explicit about it, since the developer might not expect that

@G8XSUG8XSUJan 25, 2023

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.

Based on how optimistic locking works, version needs to be provided by client in order to enact it.
So expectation is that we don't increment it and dont perform the check if developer doesn't supply it.

If global_version is not supplied, it means it is a non-global-version-check-required write.
We shouldn't be incrementing global_version in this case as client-side will not increment and has no way of knowing this without performing a sync.

Based on different application needs, some might not need a global_version check on every write, and this feature is meant to support those applications.

VssDbRecord globalVersionRecord = buildVssRecord(storeId,
KeyValue.newBuilder()
.setKey(GLOBAL_VERSION_KEY)
.setVersion(request.getGlobalVersion())
.build());

vssRecords.add(globalVersionRecord);
}

context.transaction((ctx) -> {
DSLContext dsl = ctx.dsl();
List<Query> batchQueries = vssRecords.stream()
.map(vssRecord -> buildPutObjectQuery(dsl, vssRecord)).toList();

int[] batchResult = dsl.batch(batchQueries).execute();

for (int numOfRowsUpdated : batchResult) {
if (numOfRowsUpdated == 0) {
throw new ConflictException(
"Transaction could not be completed due to a possible conflict");
}
}
});
Comment on lines +86 to +94

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could you test the case where one key failing causes the entire transaction to fail? (i.e., the successful key is not updated)


return PutObjectResponse.newBuilder().build();
}

private Query buildPutObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
return vssRecord.getVersion() == 0 ? buildInsertRecordQuery(dsl, vssRecord)
: buildUpdateRecordQuery(dsl, vssRecord);
}

private Insert<VssDbRecord> buildInsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.insertInto(VSS_DB)
.values(vssRecord.getStoreId(), vssRecord.getKey(),
vssRecord.getValue(), 1)
.onDuplicateKeyIgnore();
}

private Update<VssDbRecord> buildUpdateRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.update(VSS_DB)
.set(Map.of(VSS_DB.VALUE, vssRecord.getValue(),
VSS_DB.VERSION, vssRecord.getVersion() + 1))
.where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey()))
.and(VSS_DB.VERSION.eq(vssRecord.getVersion())));
}

private VssDbRecord buildVssRecord(String storeId, KeyValue kv) {
return new VssDbRecord()
.setStoreId(storeId)
.setKey(kv.getKey())
.setValue(kv.getValue().toByteArray())
.setVersion(kv.getVersion());
}

@Override
public ListKeyVersionsResponse listKeyVersions(ListKeyVersionsRequest request) {
throw new UnsupportedOperationException("Operation not implemented");
}
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
CREATE TABLE vss_db (
store_id character varying(120) NOT NULL CHECK (store_id <> ''),
key character varying(120) NOT NULL,
value bytea NULL,
version bigint NOT NULL,
PRIMARY KEY (store_id, key)
);
Loading