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
40 changes: 36 additions & 4 deletions app/src/main/java/org/vss/impl/postgres/PostgresBackendImpl.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
import java.util.Objects;
import javax.inject.Singleton;
import org.jooq.DSLContext;
import org.jooq.DeleteConditionStep;
import org.jooq.Insert;
import org.jooq.Query;
import org.jooq.Update;
Expand DownExpand Up@@ -108,24 +109,55 @@ public PutObjectResponse put(PutObjectRequest request) {
}

private Query buildDeleteObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
if (vssRecord.getVersion() == -1) {
return buildNonConditionalDeleteQuery(dsl, vssRecord);
} else {
return buildConditionalDeleteQuery(dsl, vssRecord);
}
}

private static DeleteConditionStep<VssDbRecord> buildNonConditionalDeleteQuery(DSLContext dsl,
VssDbRecord vssRecord) {
return dsl.deleteFrom(VSS_DB).where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey())));
}

private static DeleteConditionStep<VssDbRecord> buildConditionalDeleteQuery(DSLContext dsl,
VssDbRecord vssRecord) {
return dsl.deleteFrom(VSS_DB).where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey()))
.and(VSS_DB.VERSION.eq(vssRecord.getVersion())));
}

private Query buildPutObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
return vssRecord.getVersion() == 0 ? buildInsertRecordQuery(dsl, vssRecord)
: buildUpdateRecordQuery(dsl, vssRecord);
if (vssRecord.getVersion() == -1) {
return buildNonConditionalUpsertRecordQuery(dsl, vssRecord);
} else if (vssRecord.getVersion() == 0) {
return buildConditionalInsertRecordQuery(dsl, vssRecord);
} else {
return buildConditionalUpdateRecordQuery(dsl, vssRecord);
}
}

private Query buildNonConditionalUpsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.insertInto(VSS_DB)
.values(vssRecord.getStoreId(), vssRecord.getKey(),
vssRecord.getValue(), 1)
.onConflict(VSS_DB.STORE_ID, VSS_DB.KEY)
.doUpdate()
.set(VSS_DB.VALUE, vssRecord.getValue())
.set(VSS_DB.VERSION, 1L);
}

private Insert<VssDbRecord> buildInsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
private Insert<VssDbRecord> buildConditionalInsertRecordQuery(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) {
private Update<VssDbRecord> buildConditionalUpdateRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.update(VSS_DB)
.set(Map.of(VSS_DB.VALUE, vssRecord.getValue(),
VSS_DB.VERSION, vssRecord.getVersion() + 1))
Expand Down
56 changes: 39 additions & 17 deletions app/src/main/proto/vss.proto
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,18 +73,26 @@ message PutObjectRequest {
// a database-transaction in an all-or-nothing fashion.
// All Items in a single `PutObjectRequest` must have distinct keys.
//
// Clients are expected to store a `version` against every `key`.
// The write will succeed if the current DB version against the `key` is the same as in the request.
// When initiating a `PutObjectRequest`, the request should contain their client-side version for
// that key-value.
//
// For the first write of any key, the `version` should be '0'. If the write succeeds, the client
// must increment their corresponding key versions (client-side) by 1.
// The server increments key versions (server-side) for every successful write, hence this
// client-side increment is required to ensure matching versions. These updated key versions should
// be used in subsequent `PutObjectRequest`s for the keys.
// Key-level versioning (Conditional Write):
// Clients are expected to store a `version` against every `key`.
// The write will succeed if the current DB version against the `key` is the same as in the request.
// When initiating a `PutObjectRequest`, the request should contain their client-side `version`
// for that key-value.
//
// Requests with a conflicting version will fail with `CONFLICT_EXCEPTION` as ErrorCode.
// For the first write of any `key`, the `version` should be '0'. If the write succeeds, the client
// must increment their corresponding key versions (client-side) by 1.
// The server increments key versions (server-side) for every successful write, hence this
// client-side increment is required to ensure matching versions. These updated key versions should
// be used in subsequent `PutObjectRequest`s for the keys.
//
// Requests with a conflicting/mismatched version will fail with `CONFLICT_EXCEPTION` as ErrorCode
// for conditional writes.
//
// Skipping key-level versioning (Non-conditional Write):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional write query, after which the `version` against the `key`
// is reset to '1'. Hence, the next `PutObjectRequest` for the `key` can be either
// a non-conditional write or a conditional write with `version` set to `1`.
//
// Considerations for transactions:
// Transaction writes of multiple items have a performance overhead, hence it is recommended to use
Expand All@@ -101,13 +109,20 @@ message PutObjectRequest {
// Items to be deleted as a result of this `PutObjectRequest`.
//
// Each item in the `delete_items` field consists of a `key` and its corresponding `version`.
// The `version` is used to perform a version check before deleting the item.
// The delete will only succeed if the current database version against the `key` is the same as the `version`
// specified in the request.
//
// Key-Level Versioning (Conditional Delete):
// The `version` is used to perform a version check before deleting the item.
// The delete will only succeed if the current database version against the `key` is the same as
// the `version` specified in the request.
//
// Skipping key-level versioning (Non-conditional Delete):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional delete query.
//
// Fails with `CONFLICT_EXCEPTION` as the ErrorCode if:
// * The requested item does not exist.
// * The requested item does exist but there is a version-number mismatch with the one in the database.
// * The requested item does exist but there is a version-number mismatch (in conditional delete)
// with the one in the database.
//
// Multiple items in the `delete_items` field, along with the `transaction_items`, are written in a
// database transaction in an all-or-nothing fashion.
Expand All@@ -133,8 +148,15 @@ message DeleteObjectRequest {
// Item to be deleted as a result of this `DeleteObjectRequest`.
//
// An item consists of a `key` and its corresponding `version`.
// The item is only deleted if the current database version against the `key` is the same as the `version`
// specified in the request.
//
// Key-level Versioning (Conditional Delete):
// The item is only deleted if the current database version against the `key` is the same as
// the `version` specified in the request.
//
// Skipping key-level versioning (Non-conditional Delete):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional delete query.
//
// This operation is idempotent, that is, multiple delete calls for the same item will not fail.
//
// If the requested item does not exist, this operation will not fail.
Expand Down
23 changes: 22 additions & 1 deletion app/src/test/java/org/vss/AbstractKVStoreIntegrationTest.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,15 +29,26 @@ public abstract class AbstractKVStoreIntegrationTest {

@Test
void putShouldSucceedWhenSingleObjectPutOperation() {
// Conditional Put
assertDoesNotThrow(() -> putObjects(0L, List.of(kv("k1", "k1v1", 0))));
assertDoesNotThrow(() -> putObjects(1L, List.of(kv("k1", "k1v2", 1))));

// NonConditional Put
assertDoesNotThrow(() -> putObjects(2L, List.of(kv("k2", "k2v1", -1))));
assertDoesNotThrow(() -> putObjects(3L, List.of(kv("k2", "k2v2", -1))));
assertDoesNotThrow(() -> putObjects(4L, List.of(kv("k2", "k2v3", -1))));

KeyValue response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertThat(response.getVersion(), is(2L));
assertThat(response.getValue().toStringUtf8(), is("k1v2"));

assertThat(getObject(KVStore.GLOBAL_VERSION_KEY).getVersion(), is(2L));
response = getObject("k2");
assertThat(response.getKey(), is("k2"));
assertThat(response.getVersion(), is(1L));
assertThat(response.getValue().toStringUtf8(), is("k1v3"));

assertThat(getObject(KVStore.GLOBAL_VERSION_KEY).getVersion(), is(5L));
}

@Test
Expand DownExpand Up@@ -168,11 +179,21 @@ void putAndDeleteShouldSucceedAsAtomicTransaction() {
@Test
void deleteShouldSucceedWhenItemExists() {
assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v1", 0))));
// Conditional Delete
assertDoesNotThrow(() -> deleteObject(kv("k1", "", 1)));

KeyValue response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertTrue(response.getValue().isEmpty());

assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v1", 0))));
assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v2", 1))));
// NonConditional Delete
assertDoesNotThrow(() -> deleteObject(kv("k1", "", -1)));

response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertTrue(response.getValue().isEmpty());
}

@Test
Expand Down
, '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
40 changes: 36 additions & 4 deletions app/src/main/java/org/vss/impl/postgres/PostgresBackendImpl.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
import java.util.Objects;
import javax.inject.Singleton;
import org.jooq.DSLContext;
import org.jooq.DeleteConditionStep;
import org.jooq.Insert;
import org.jooq.Query;
import org.jooq.Update;
Expand DownExpand Up@@ -108,24 +109,55 @@ public PutObjectResponse put(PutObjectRequest request) {
}

private Query buildDeleteObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
if (vssRecord.getVersion() == -1) {
return buildNonConditionalDeleteQuery(dsl, vssRecord);
} else {
return buildConditionalDeleteQuery(dsl, vssRecord);
}
}

private static DeleteConditionStep<VssDbRecord> buildNonConditionalDeleteQuery(DSLContext dsl,
VssDbRecord vssRecord) {
return dsl.deleteFrom(VSS_DB).where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey())));
}

private static DeleteConditionStep<VssDbRecord> buildConditionalDeleteQuery(DSLContext dsl,
VssDbRecord vssRecord) {
return dsl.deleteFrom(VSS_DB).where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey()))
.and(VSS_DB.VERSION.eq(vssRecord.getVersion())));
}

private Query buildPutObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
return vssRecord.getVersion() == 0 ? buildInsertRecordQuery(dsl, vssRecord)
: buildUpdateRecordQuery(dsl, vssRecord);
if (vssRecord.getVersion() == -1) {
return buildNonConditionalUpsertRecordQuery(dsl, vssRecord);
} else if (vssRecord.getVersion() == 0) {
return buildConditionalInsertRecordQuery(dsl, vssRecord);
} else {
return buildConditionalUpdateRecordQuery(dsl, vssRecord);
}
}

private Query buildNonConditionalUpsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.insertInto(VSS_DB)
.values(vssRecord.getStoreId(), vssRecord.getKey(),
vssRecord.getValue(), 1)
.onConflict(VSS_DB.STORE_ID, VSS_DB.KEY)
.doUpdate()
.set(VSS_DB.VALUE, vssRecord.getValue())
.set(VSS_DB.VERSION, 1L);
}

private Insert<VssDbRecord> buildInsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
private Insert<VssDbRecord> buildConditionalInsertRecordQuery(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) {
private Update<VssDbRecord> buildConditionalUpdateRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.update(VSS_DB)
.set(Map.of(VSS_DB.VALUE, vssRecord.getValue(),
VSS_DB.VERSION, vssRecord.getVersion() + 1))
Expand Down
56 changes: 39 additions & 17 deletions app/src/main/proto/vss.proto
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,18 +73,26 @@ message PutObjectRequest {
// a database-transaction in an all-or-nothing fashion.
// All Items in a single `PutObjectRequest` must have distinct keys.
//
// Clients are expected to store a `version` against every `key`.
// The write will succeed if the current DB version against the `key` is the same as in the request.
// When initiating a `PutObjectRequest`, the request should contain their client-side version for
// that key-value.
//
// For the first write of any key, the `version` should be '0'. If the write succeeds, the client
// must increment their corresponding key versions (client-side) by 1.
// The server increments key versions (server-side) for every successful write, hence this
// client-side increment is required to ensure matching versions. These updated key versions should
// be used in subsequent `PutObjectRequest`s for the keys.
// Key-level versioning (Conditional Write):
// Clients are expected to store a `version` against every `key`.
// The write will succeed if the current DB version against the `key` is the same as in the request.
// When initiating a `PutObjectRequest`, the request should contain their client-side `version`
// for that key-value.
//
// Requests with a conflicting version will fail with `CONFLICT_EXCEPTION` as ErrorCode.
// For the first write of any `key`, the `version` should be '0'. If the write succeeds, the client
// must increment their corresponding key versions (client-side) by 1.
// The server increments key versions (server-side) for every successful write, hence this
// client-side increment is required to ensure matching versions. These updated key versions should
// be used in subsequent `PutObjectRequest`s for the keys.
//
// Requests with a conflicting/mismatched version will fail with `CONFLICT_EXCEPTION` as ErrorCode
// for conditional writes.
//
// Skipping key-level versioning (Non-conditional Write):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional write query, after which the `version` against the `key`
// is reset to '1'. Hence, the next `PutObjectRequest` for the `key` can be either
// a non-conditional write or a conditional write with `version` set to `1`.
//
// Considerations for transactions:
// Transaction writes of multiple items have a performance overhead, hence it is recommended to use
Expand All@@ -101,13 +109,20 @@ message PutObjectRequest {
// Items to be deleted as a result of this `PutObjectRequest`.
//
// Each item in the `delete_items` field consists of a `key` and its corresponding `version`.
// The `version` is used to perform a version check before deleting the item.
// The delete will only succeed if the current database version against the `key` is the same as the `version`
// specified in the request.
//
// Key-Level Versioning (Conditional Delete):
// The `version` is used to perform a version check before deleting the item.
// The delete will only succeed if the current database version against the `key` is the same as
// the `version` specified in the request.
//
// Skipping key-level versioning (Non-conditional Delete):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional delete query.
//
// Fails with `CONFLICT_EXCEPTION` as the ErrorCode if:
// * The requested item does not exist.
// * The requested item does exist but there is a version-number mismatch with the one in the database.
// * The requested item does exist but there is a version-number mismatch (in conditional delete)
// with the one in the database.
//
// Multiple items in the `delete_items` field, along with the `transaction_items`, are written in a
// database transaction in an all-or-nothing fashion.
Expand All@@ -133,8 +148,15 @@ message DeleteObjectRequest {
// Item to be deleted as a result of this `DeleteObjectRequest`.
//
// An item consists of a `key` and its corresponding `version`.
// The item is only deleted if the current database version against the `key` is the same as the `version`
// specified in the request.
//
// Key-level Versioning (Conditional Delete):
// The item is only deleted if the current database version against the `key` is the same as
// the `version` specified in the request.
//
// Skipping key-level versioning (Non-conditional Delete):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional delete query.
//
// This operation is idempotent, that is, multiple delete calls for the same item will not fail.
//
// If the requested item does not exist, this operation will not fail.
Expand Down
23 changes: 22 additions & 1 deletion app/src/test/java/org/vss/AbstractKVStoreIntegrationTest.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,15 +29,26 @@ public abstract class AbstractKVStoreIntegrationTest {

@Test
void putShouldSucceedWhenSingleObjectPutOperation() {
// Conditional Put
assertDoesNotThrow(() -> putObjects(0L, List.of(kv("k1", "k1v1", 0))));
assertDoesNotThrow(() -> putObjects(1L, List.of(kv("k1", "k1v2", 1))));

// NonConditional Put
assertDoesNotThrow(() -> putObjects(2L, List.of(kv("k2", "k2v1", -1))));
assertDoesNotThrow(() -> putObjects(3L, List.of(kv("k2", "k2v2", -1))));
assertDoesNotThrow(() -> putObjects(4L, List.of(kv("k2", "k2v3", -1))));

KeyValue response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertThat(response.getVersion(), is(2L));
assertThat(response.getValue().toStringUtf8(), is("k1v2"));

assertThat(getObject(KVStore.GLOBAL_VERSION_KEY).getVersion(), is(2L));
response = getObject("k2");
assertThat(response.getKey(), is("k2"));
assertThat(response.getVersion(), is(1L));
assertThat(response.getValue().toStringUtf8(), is("k1v3"));

assertThat(getObject(KVStore.GLOBAL_VERSION_KEY).getVersion(), is(5L));
}

@Test
Expand DownExpand Up@@ -168,11 +179,21 @@ void putAndDeleteShouldSucceedAsAtomicTransaction() {
@Test
void deleteShouldSucceedWhenItemExists() {
assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v1", 0))));
// Conditional Delete
assertDoesNotThrow(() -> deleteObject(kv("k1", "", 1)));

KeyValue response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertTrue(response.getValue().isEmpty());

assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v1", 0))));
assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v2", 1))));
// NonConditional Delete
assertDoesNotThrow(() -> deleteObject(kv("k1", "", -1)));

response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertTrue(response.getValue().isEmpty());
}

@Test
Expand Down
, '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
40 changes: 36 additions & 4 deletions app/src/main/java/org/vss/impl/postgres/PostgresBackendImpl.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
import java.util.Objects;
import javax.inject.Singleton;
import org.jooq.DSLContext;
import org.jooq.DeleteConditionStep;
import org.jooq.Insert;
import org.jooq.Query;
import org.jooq.Update;
Expand DownExpand Up@@ -108,24 +109,55 @@ public PutObjectResponse put(PutObjectRequest request) {
}

private Query buildDeleteObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
if (vssRecord.getVersion() == -1) {
return buildNonConditionalDeleteQuery(dsl, vssRecord);
} else {
return buildConditionalDeleteQuery(dsl, vssRecord);
}
}

private static DeleteConditionStep<VssDbRecord> buildNonConditionalDeleteQuery(DSLContext dsl,
VssDbRecord vssRecord) {
return dsl.deleteFrom(VSS_DB).where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey())));
}

private static DeleteConditionStep<VssDbRecord> buildConditionalDeleteQuery(DSLContext dsl,
VssDbRecord vssRecord) {
return dsl.deleteFrom(VSS_DB).where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey()))
.and(VSS_DB.VERSION.eq(vssRecord.getVersion())));
}

private Query buildPutObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
return vssRecord.getVersion() == 0 ? buildInsertRecordQuery(dsl, vssRecord)
: buildUpdateRecordQuery(dsl, vssRecord);
if (vssRecord.getVersion() == -1) {
return buildNonConditionalUpsertRecordQuery(dsl, vssRecord);
} else if (vssRecord.getVersion() == 0) {
return buildConditionalInsertRecordQuery(dsl, vssRecord);
} else {
return buildConditionalUpdateRecordQuery(dsl, vssRecord);
}
}

private Query buildNonConditionalUpsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.insertInto(VSS_DB)
.values(vssRecord.getStoreId(), vssRecord.getKey(),
vssRecord.getValue(), 1)
.onConflict(VSS_DB.STORE_ID, VSS_DB.KEY)
.doUpdate()
.set(VSS_DB.VALUE, vssRecord.getValue())
.set(VSS_DB.VERSION, 1L);
}

private Insert<VssDbRecord> buildInsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
private Insert<VssDbRecord> buildConditionalInsertRecordQuery(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) {
private Update<VssDbRecord> buildConditionalUpdateRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.update(VSS_DB)
.set(Map.of(VSS_DB.VALUE, vssRecord.getValue(),
VSS_DB.VERSION, vssRecord.getVersion() + 1))
Expand Down
56 changes: 39 additions & 17 deletions app/src/main/proto/vss.proto
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,18 +73,26 @@ message PutObjectRequest {
// a database-transaction in an all-or-nothing fashion.
// All Items in a single `PutObjectRequest` must have distinct keys.
//
// Clients are expected to store a `version` against every `key`.
// The write will succeed if the current DB version against the `key` is the same as in the request.
// When initiating a `PutObjectRequest`, the request should contain their client-side version for
// that key-value.
//
// For the first write of any key, the `version` should be '0'. If the write succeeds, the client
// must increment their corresponding key versions (client-side) by 1.
// The server increments key versions (server-side) for every successful write, hence this
// client-side increment is required to ensure matching versions. These updated key versions should
// be used in subsequent `PutObjectRequest`s for the keys.
// Key-level versioning (Conditional Write):
// Clients are expected to store a `version` against every `key`.
// The write will succeed if the current DB version against the `key` is the same as in the request.
// When initiating a `PutObjectRequest`, the request should contain their client-side `version`
// for that key-value.
//
// Requests with a conflicting version will fail with `CONFLICT_EXCEPTION` as ErrorCode.
// For the first write of any `key`, the `version` should be '0'. If the write succeeds, the client
// must increment their corresponding key versions (client-side) by 1.
// The server increments key versions (server-side) for every successful write, hence this
// client-side increment is required to ensure matching versions. These updated key versions should
// be used in subsequent `PutObjectRequest`s for the keys.
//
// Requests with a conflicting/mismatched version will fail with `CONFLICT_EXCEPTION` as ErrorCode
// for conditional writes.
//
// Skipping key-level versioning (Non-conditional Write):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional write query, after which the `version` against the `key`
// is reset to '1'. Hence, the next `PutObjectRequest` for the `key` can be either
// a non-conditional write or a conditional write with `version` set to `1`.
//
// Considerations for transactions:
// Transaction writes of multiple items have a performance overhead, hence it is recommended to use
Expand All@@ -101,13 +109,20 @@ message PutObjectRequest {
// Items to be deleted as a result of this `PutObjectRequest`.
//
// Each item in the `delete_items` field consists of a `key` and its corresponding `version`.
// The `version` is used to perform a version check before deleting the item.
// The delete will only succeed if the current database version against the `key` is the same as the `version`
// specified in the request.
//
// Key-Level Versioning (Conditional Delete):
// The `version` is used to perform a version check before deleting the item.
// The delete will only succeed if the current database version against the `key` is the same as
// the `version` specified in the request.
//
// Skipping key-level versioning (Non-conditional Delete):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional delete query.
//
// Fails with `CONFLICT_EXCEPTION` as the ErrorCode if:
// * The requested item does not exist.
// * The requested item does exist but there is a version-number mismatch with the one in the database.
// * The requested item does exist but there is a version-number mismatch (in conditional delete)
// with the one in the database.
//
// Multiple items in the `delete_items` field, along with the `transaction_items`, are written in a
// database transaction in an all-or-nothing fashion.
Expand All@@ -133,8 +148,15 @@ message DeleteObjectRequest {
// Item to be deleted as a result of this `DeleteObjectRequest`.
//
// An item consists of a `key` and its corresponding `version`.
// The item is only deleted if the current database version against the `key` is the same as the `version`
// specified in the request.
//
// Key-level Versioning (Conditional Delete):
// The item is only deleted if the current database version against the `key` is the same as
// the `version` specified in the request.
//
// Skipping key-level versioning (Non-conditional Delete):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional delete query.
//
// This operation is idempotent, that is, multiple delete calls for the same item will not fail.
//
// If the requested item does not exist, this operation will not fail.
Expand Down
23 changes: 22 additions & 1 deletion app/src/test/java/org/vss/AbstractKVStoreIntegrationTest.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,15 +29,26 @@ public abstract class AbstractKVStoreIntegrationTest {

@Test
void putShouldSucceedWhenSingleObjectPutOperation() {
// Conditional Put
assertDoesNotThrow(() -> putObjects(0L, List.of(kv("k1", "k1v1", 0))));
assertDoesNotThrow(() -> putObjects(1L, List.of(kv("k1", "k1v2", 1))));

// NonConditional Put
assertDoesNotThrow(() -> putObjects(2L, List.of(kv("k2", "k2v1", -1))));
assertDoesNotThrow(() -> putObjects(3L, List.of(kv("k2", "k2v2", -1))));
assertDoesNotThrow(() -> putObjects(4L, List.of(kv("k2", "k2v3", -1))));

KeyValue response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertThat(response.getVersion(), is(2L));
assertThat(response.getValue().toStringUtf8(), is("k1v2"));

assertThat(getObject(KVStore.GLOBAL_VERSION_KEY).getVersion(), is(2L));
response = getObject("k2");
assertThat(response.getKey(), is("k2"));
assertThat(response.getVersion(), is(1L));
assertThat(response.getValue().toStringUtf8(), is("k1v3"));

assertThat(getObject(KVStore.GLOBAL_VERSION_KEY).getVersion(), is(5L));
}

@Test
Expand DownExpand Up@@ -168,11 +179,21 @@ void putAndDeleteShouldSucceedAsAtomicTransaction() {
@Test
void deleteShouldSucceedWhenItemExists() {
assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v1", 0))));
// Conditional Delete
assertDoesNotThrow(() -> deleteObject(kv("k1", "", 1)));

KeyValue response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertTrue(response.getValue().isEmpty());

assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v1", 0))));
assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v2", 1))));
// NonConditional Delete
assertDoesNotThrow(() -> deleteObject(kv("k1", "", -1)));

response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertTrue(response.getValue().isEmpty());
}

@Test
Expand Down
, '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
40 changes: 36 additions & 4 deletions app/src/main/java/org/vss/impl/postgres/PostgresBackendImpl.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
import java.util.Objects;
import javax.inject.Singleton;
import org.jooq.DSLContext;
import org.jooq.DeleteConditionStep;
import org.jooq.Insert;
import org.jooq.Query;
import org.jooq.Update;
Expand DownExpand Up@@ -108,24 +109,55 @@ public PutObjectResponse put(PutObjectRequest request) {
}

private Query buildDeleteObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
if (vssRecord.getVersion() == -1) {
return buildNonConditionalDeleteQuery(dsl, vssRecord);
} else {
return buildConditionalDeleteQuery(dsl, vssRecord);
}
}

private static DeleteConditionStep<VssDbRecord> buildNonConditionalDeleteQuery(DSLContext dsl,
VssDbRecord vssRecord) {
return dsl.deleteFrom(VSS_DB).where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey())));
}

private static DeleteConditionStep<VssDbRecord> buildConditionalDeleteQuery(DSLContext dsl,
VssDbRecord vssRecord) {
return dsl.deleteFrom(VSS_DB).where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey()))
.and(VSS_DB.VERSION.eq(vssRecord.getVersion())));
}

private Query buildPutObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
return vssRecord.getVersion() == 0 ? buildInsertRecordQuery(dsl, vssRecord)
: buildUpdateRecordQuery(dsl, vssRecord);
if (vssRecord.getVersion() == -1) {
return buildNonConditionalUpsertRecordQuery(dsl, vssRecord);
} else if (vssRecord.getVersion() == 0) {
return buildConditionalInsertRecordQuery(dsl, vssRecord);
} else {
return buildConditionalUpdateRecordQuery(dsl, vssRecord);
}
}

private Query buildNonConditionalUpsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.insertInto(VSS_DB)
.values(vssRecord.getStoreId(), vssRecord.getKey(),
vssRecord.getValue(), 1)
.onConflict(VSS_DB.STORE_ID, VSS_DB.KEY)
.doUpdate()
.set(VSS_DB.VALUE, vssRecord.getValue())
.set(VSS_DB.VERSION, 1L);
}

private Insert<VssDbRecord> buildInsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
private Insert<VssDbRecord> buildConditionalInsertRecordQuery(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) {
private Update<VssDbRecord> buildConditionalUpdateRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.update(VSS_DB)
.set(Map.of(VSS_DB.VALUE, vssRecord.getValue(),
VSS_DB.VERSION, vssRecord.getVersion() + 1))
Expand Down
56 changes: 39 additions & 17 deletions app/src/main/proto/vss.proto
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,18 +73,26 @@ message PutObjectRequest {
// a database-transaction in an all-or-nothing fashion.
// All Items in a single `PutObjectRequest` must have distinct keys.
//
// Clients are expected to store a `version` against every `key`.
// The write will succeed if the current DB version against the `key` is the same as in the request.
// When initiating a `PutObjectRequest`, the request should contain their client-side version for
// that key-value.
//
// For the first write of any key, the `version` should be '0'. If the write succeeds, the client
// must increment their corresponding key versions (client-side) by 1.
// The server increments key versions (server-side) for every successful write, hence this
// client-side increment is required to ensure matching versions. These updated key versions should
// be used in subsequent `PutObjectRequest`s for the keys.
// Key-level versioning (Conditional Write):
// Clients are expected to store a `version` against every `key`.
// The write will succeed if the current DB version against the `key` is the same as in the request.
// When initiating a `PutObjectRequest`, the request should contain their client-side `version`
// for that key-value.
//
// Requests with a conflicting version will fail with `CONFLICT_EXCEPTION` as ErrorCode.
// For the first write of any `key`, the `version` should be '0'. If the write succeeds, the client
// must increment their corresponding key versions (client-side) by 1.
// The server increments key versions (server-side) for every successful write, hence this
// client-side increment is required to ensure matching versions. These updated key versions should
// be used in subsequent `PutObjectRequest`s for the keys.
//
// Requests with a conflicting/mismatched version will fail with `CONFLICT_EXCEPTION` as ErrorCode
// for conditional writes.
//
// Skipping key-level versioning (Non-conditional Write):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional write query, after which the `version` against the `key`
// is reset to '1'. Hence, the next `PutObjectRequest` for the `key` can be either
// a non-conditional write or a conditional write with `version` set to `1`.
//
// Considerations for transactions:
// Transaction writes of multiple items have a performance overhead, hence it is recommended to use
Expand All@@ -101,13 +109,20 @@ message PutObjectRequest {
// Items to be deleted as a result of this `PutObjectRequest`.
//
// Each item in the `delete_items` field consists of a `key` and its corresponding `version`.
// The `version` is used to perform a version check before deleting the item.
// The delete will only succeed if the current database version against the `key` is the same as the `version`
// specified in the request.
//
// Key-Level Versioning (Conditional Delete):
// The `version` is used to perform a version check before deleting the item.
// The delete will only succeed if the current database version against the `key` is the same as
// the `version` specified in the request.
//
// Skipping key-level versioning (Non-conditional Delete):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional delete query.
//
// Fails with `CONFLICT_EXCEPTION` as the ErrorCode if:
// * The requested item does not exist.
// * The requested item does exist but there is a version-number mismatch with the one in the database.
// * The requested item does exist but there is a version-number mismatch (in conditional delete)
// with the one in the database.
//
// Multiple items in the `delete_items` field, along with the `transaction_items`, are written in a
// database transaction in an all-or-nothing fashion.
Expand All@@ -133,8 +148,15 @@ message DeleteObjectRequest {
// Item to be deleted as a result of this `DeleteObjectRequest`.
//
// An item consists of a `key` and its corresponding `version`.
// The item is only deleted if the current database version against the `key` is the same as the `version`
// specified in the request.
//
// Key-level Versioning (Conditional Delete):
// The item is only deleted if the current database version against the `key` is the same as
// the `version` specified in the request.
//
// Skipping key-level versioning (Non-conditional Delete):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional delete query.
//
// This operation is idempotent, that is, multiple delete calls for the same item will not fail.
//
// If the requested item does not exist, this operation will not fail.
Expand Down
23 changes: 22 additions & 1 deletion app/src/test/java/org/vss/AbstractKVStoreIntegrationTest.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,15 +29,26 @@ public abstract class AbstractKVStoreIntegrationTest {

@Test
void putShouldSucceedWhenSingleObjectPutOperation() {
// Conditional Put
assertDoesNotThrow(() -> putObjects(0L, List.of(kv("k1", "k1v1", 0))));
assertDoesNotThrow(() -> putObjects(1L, List.of(kv("k1", "k1v2", 1))));

// NonConditional Put
assertDoesNotThrow(() -> putObjects(2L, List.of(kv("k2", "k2v1", -1))));
assertDoesNotThrow(() -> putObjects(3L, List.of(kv("k2", "k2v2", -1))));
assertDoesNotThrow(() -> putObjects(4L, List.of(kv("k2", "k2v3", -1))));

KeyValue response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertThat(response.getVersion(), is(2L));
assertThat(response.getValue().toStringUtf8(), is("k1v2"));

assertThat(getObject(KVStore.GLOBAL_VERSION_KEY).getVersion(), is(2L));
response = getObject("k2");
assertThat(response.getKey(), is("k2"));
assertThat(response.getVersion(), is(1L));
assertThat(response.getValue().toStringUtf8(), is("k1v3"));

assertThat(getObject(KVStore.GLOBAL_VERSION_KEY).getVersion(), is(5L));
}

@Test
Expand DownExpand Up@@ -168,11 +179,21 @@ void putAndDeleteShouldSucceedAsAtomicTransaction() {
@Test
void deleteShouldSucceedWhenItemExists() {
assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v1", 0))));
// Conditional Delete
assertDoesNotThrow(() -> deleteObject(kv("k1", "", 1)));

KeyValue response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertTrue(response.getValue().isEmpty());

assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v1", 0))));
assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v2", 1))));
// NonConditional Delete
assertDoesNotThrow(() -> deleteObject(kv("k1", "", -1)));

response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertTrue(response.getValue().isEmpty());
}

@Test
Expand Down
, '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
40 changes: 36 additions & 4 deletions app/src/main/java/org/vss/impl/postgres/PostgresBackendImpl.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
import java.util.Objects;
import javax.inject.Singleton;
import org.jooq.DSLContext;
import org.jooq.DeleteConditionStep;
import org.jooq.Insert;
import org.jooq.Query;
import org.jooq.Update;
Expand DownExpand Up@@ -108,24 +109,55 @@ public PutObjectResponse put(PutObjectRequest request) {
}

private Query buildDeleteObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
if (vssRecord.getVersion() == -1) {
return buildNonConditionalDeleteQuery(dsl, vssRecord);
} else {
return buildConditionalDeleteQuery(dsl, vssRecord);
}
}

private static DeleteConditionStep<VssDbRecord> buildNonConditionalDeleteQuery(DSLContext dsl,
VssDbRecord vssRecord) {
return dsl.deleteFrom(VSS_DB).where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey())));
}

private static DeleteConditionStep<VssDbRecord> buildConditionalDeleteQuery(DSLContext dsl,
VssDbRecord vssRecord) {
return dsl.deleteFrom(VSS_DB).where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey()))
.and(VSS_DB.VERSION.eq(vssRecord.getVersion())));
}

private Query buildPutObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
return vssRecord.getVersion() == 0 ? buildInsertRecordQuery(dsl, vssRecord)
: buildUpdateRecordQuery(dsl, vssRecord);
if (vssRecord.getVersion() == -1) {
return buildNonConditionalUpsertRecordQuery(dsl, vssRecord);
} else if (vssRecord.getVersion() == 0) {
return buildConditionalInsertRecordQuery(dsl, vssRecord);
} else {
return buildConditionalUpdateRecordQuery(dsl, vssRecord);
}
}

private Query buildNonConditionalUpsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.insertInto(VSS_DB)
.values(vssRecord.getStoreId(), vssRecord.getKey(),
vssRecord.getValue(), 1)
.onConflict(VSS_DB.STORE_ID, VSS_DB.KEY)
.doUpdate()
.set(VSS_DB.VALUE, vssRecord.getValue())
.set(VSS_DB.VERSION, 1L);
}

private Insert<VssDbRecord> buildInsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
private Insert<VssDbRecord> buildConditionalInsertRecordQuery(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) {
private Update<VssDbRecord> buildConditionalUpdateRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.update(VSS_DB)
.set(Map.of(VSS_DB.VALUE, vssRecord.getValue(),
VSS_DB.VERSION, vssRecord.getVersion() + 1))
Expand Down
56 changes: 39 additions & 17 deletions app/src/main/proto/vss.proto
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,18 +73,26 @@ message PutObjectRequest {
// a database-transaction in an all-or-nothing fashion.
// All Items in a single `PutObjectRequest` must have distinct keys.
//
// Clients are expected to store a `version` against every `key`.
// The write will succeed if the current DB version against the `key` is the same as in the request.
// When initiating a `PutObjectRequest`, the request should contain their client-side version for
// that key-value.
//
// For the first write of any key, the `version` should be '0'. If the write succeeds, the client
// must increment their corresponding key versions (client-side) by 1.
// The server increments key versions (server-side) for every successful write, hence this
// client-side increment is required to ensure matching versions. These updated key versions should
// be used in subsequent `PutObjectRequest`s for the keys.
// Key-level versioning (Conditional Write):
// Clients are expected to store a `version` against every `key`.
// The write will succeed if the current DB version against the `key` is the same as in the request.
// When initiating a `PutObjectRequest`, the request should contain their client-side `version`
// for that key-value.
//
// Requests with a conflicting version will fail with `CONFLICT_EXCEPTION` as ErrorCode.
// For the first write of any `key`, the `version` should be '0'. If the write succeeds, the client
// must increment their corresponding key versions (client-side) by 1.
// The server increments key versions (server-side) for every successful write, hence this
// client-side increment is required to ensure matching versions. These updated key versions should
// be used in subsequent `PutObjectRequest`s for the keys.
//
// Requests with a conflicting/mismatched version will fail with `CONFLICT_EXCEPTION` as ErrorCode
// for conditional writes.
//
// Skipping key-level versioning (Non-conditional Write):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional write query, after which the `version` against the `key`
// is reset to '1'. Hence, the next `PutObjectRequest` for the `key` can be either
// a non-conditional write or a conditional write with `version` set to `1`.
//
// Considerations for transactions:
// Transaction writes of multiple items have a performance overhead, hence it is recommended to use
Expand All@@ -101,13 +109,20 @@ message PutObjectRequest {
// Items to be deleted as a result of this `PutObjectRequest`.
//
// Each item in the `delete_items` field consists of a `key` and its corresponding `version`.
// The `version` is used to perform a version check before deleting the item.
// The delete will only succeed if the current database version against the `key` is the same as the `version`
// specified in the request.
//
// Key-Level Versioning (Conditional Delete):
// The `version` is used to perform a version check before deleting the item.
// The delete will only succeed if the current database version against the `key` is the same as
// the `version` specified in the request.
//
// Skipping key-level versioning (Non-conditional Delete):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional delete query.
//
// Fails with `CONFLICT_EXCEPTION` as the ErrorCode if:
// * The requested item does not exist.
// * The requested item does exist but there is a version-number mismatch with the one in the database.
// * The requested item does exist but there is a version-number mismatch (in conditional delete)
// with the one in the database.
//
// Multiple items in the `delete_items` field, along with the `transaction_items`, are written in a
// database transaction in an all-or-nothing fashion.
Expand All@@ -133,8 +148,15 @@ message DeleteObjectRequest {
// Item to be deleted as a result of this `DeleteObjectRequest`.
//
// An item consists of a `key` and its corresponding `version`.
// The item is only deleted if the current database version against the `key` is the same as the `version`
// specified in the request.
//
// Key-level Versioning (Conditional Delete):
// The item is only deleted if the current database version against the `key` is the same as
// the `version` specified in the request.
//
// Skipping key-level versioning (Non-conditional Delete):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional delete query.
//
// This operation is idempotent, that is, multiple delete calls for the same item will not fail.
//
// If the requested item does not exist, this operation will not fail.
Expand Down
23 changes: 22 additions & 1 deletion app/src/test/java/org/vss/AbstractKVStoreIntegrationTest.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,15 +29,26 @@ public abstract class AbstractKVStoreIntegrationTest {

@Test
void putShouldSucceedWhenSingleObjectPutOperation() {
// Conditional Put
assertDoesNotThrow(() -> putObjects(0L, List.of(kv("k1", "k1v1", 0))));
assertDoesNotThrow(() -> putObjects(1L, List.of(kv("k1", "k1v2", 1))));

// NonConditional Put
assertDoesNotThrow(() -> putObjects(2L, List.of(kv("k2", "k2v1", -1))));
assertDoesNotThrow(() -> putObjects(3L, List.of(kv("k2", "k2v2", -1))));
assertDoesNotThrow(() -> putObjects(4L, List.of(kv("k2", "k2v3", -1))));

KeyValue response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertThat(response.getVersion(), is(2L));
assertThat(response.getValue().toStringUtf8(), is("k1v2"));

assertThat(getObject(KVStore.GLOBAL_VERSION_KEY).getVersion(), is(2L));
response = getObject("k2");
assertThat(response.getKey(), is("k2"));
assertThat(response.getVersion(), is(1L));
assertThat(response.getValue().toStringUtf8(), is("k1v3"));

assertThat(getObject(KVStore.GLOBAL_VERSION_KEY).getVersion(), is(5L));
}

@Test
Expand DownExpand Up@@ -168,11 +179,21 @@ void putAndDeleteShouldSucceedAsAtomicTransaction() {
@Test
void deleteShouldSucceedWhenItemExists() {
assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v1", 0))));
// Conditional Delete
assertDoesNotThrow(() -> deleteObject(kv("k1", "", 1)));

KeyValue response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertTrue(response.getValue().isEmpty());

assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v1", 0))));
assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v2", 1))));
// NonConditional Delete
assertDoesNotThrow(() -> deleteObject(kv("k1", "", -1)));

response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertTrue(response.getValue().isEmpty());
}

@Test
Expand Down
, '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
40 changes: 36 additions & 4 deletions app/src/main/java/org/vss/impl/postgres/PostgresBackendImpl.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
import java.util.Objects;
import javax.inject.Singleton;
import org.jooq.DSLContext;
import org.jooq.DeleteConditionStep;
import org.jooq.Insert;
import org.jooq.Query;
import org.jooq.Update;
Expand DownExpand Up@@ -108,24 +109,55 @@ public PutObjectResponse put(PutObjectRequest request) {
}

private Query buildDeleteObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
if (vssRecord.getVersion() == -1) {
return buildNonConditionalDeleteQuery(dsl, vssRecord);
} else {
return buildConditionalDeleteQuery(dsl, vssRecord);
}
}

private static DeleteConditionStep<VssDbRecord> buildNonConditionalDeleteQuery(DSLContext dsl,
VssDbRecord vssRecord) {
return dsl.deleteFrom(VSS_DB).where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey())));
}

private static DeleteConditionStep<VssDbRecord> buildConditionalDeleteQuery(DSLContext dsl,
VssDbRecord vssRecord) {
return dsl.deleteFrom(VSS_DB).where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey()))
.and(VSS_DB.VERSION.eq(vssRecord.getVersion())));
}

private Query buildPutObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
return vssRecord.getVersion() == 0 ? buildInsertRecordQuery(dsl, vssRecord)
: buildUpdateRecordQuery(dsl, vssRecord);
if (vssRecord.getVersion() == -1) {
return buildNonConditionalUpsertRecordQuery(dsl, vssRecord);
} else if (vssRecord.getVersion() == 0) {
return buildConditionalInsertRecordQuery(dsl, vssRecord);
} else {
return buildConditionalUpdateRecordQuery(dsl, vssRecord);
}
}

private Query buildNonConditionalUpsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.insertInto(VSS_DB)
.values(vssRecord.getStoreId(), vssRecord.getKey(),
vssRecord.getValue(), 1)
.onConflict(VSS_DB.STORE_ID, VSS_DB.KEY)
.doUpdate()
.set(VSS_DB.VALUE, vssRecord.getValue())
.set(VSS_DB.VERSION, 1L);
}

private Insert<VssDbRecord> buildInsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
private Insert<VssDbRecord> buildConditionalInsertRecordQuery(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) {
private Update<VssDbRecord> buildConditionalUpdateRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.update(VSS_DB)
.set(Map.of(VSS_DB.VALUE, vssRecord.getValue(),
VSS_DB.VERSION, vssRecord.getVersion() + 1))
Expand Down
56 changes: 39 additions & 17 deletions app/src/main/proto/vss.proto
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,18 +73,26 @@ message PutObjectRequest {
// a database-transaction in an all-or-nothing fashion.
// All Items in a single `PutObjectRequest` must have distinct keys.
//
// Clients are expected to store a `version` against every `key`.
// The write will succeed if the current DB version against the `key` is the same as in the request.
// When initiating a `PutObjectRequest`, the request should contain their client-side version for
// that key-value.
//
// For the first write of any key, the `version` should be '0'. If the write succeeds, the client
// must increment their corresponding key versions (client-side) by 1.
// The server increments key versions (server-side) for every successful write, hence this
// client-side increment is required to ensure matching versions. These updated key versions should
// be used in subsequent `PutObjectRequest`s for the keys.
// Key-level versioning (Conditional Write):
// Clients are expected to store a `version` against every `key`.
// The write will succeed if the current DB version against the `key` is the same as in the request.
// When initiating a `PutObjectRequest`, the request should contain their client-side `version`
// for that key-value.
//
// Requests with a conflicting version will fail with `CONFLICT_EXCEPTION` as ErrorCode.
// For the first write of any `key`, the `version` should be '0'. If the write succeeds, the client
// must increment their corresponding key versions (client-side) by 1.
// The server increments key versions (server-side) for every successful write, hence this
// client-side increment is required to ensure matching versions. These updated key versions should
// be used in subsequent `PutObjectRequest`s for the keys.
//
// Requests with a conflicting/mismatched version will fail with `CONFLICT_EXCEPTION` as ErrorCode
// for conditional writes.
//
// Skipping key-level versioning (Non-conditional Write):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional write query, after which the `version` against the `key`
// is reset to '1'. Hence, the next `PutObjectRequest` for the `key` can be either
// a non-conditional write or a conditional write with `version` set to `1`.
//
// Considerations for transactions:
// Transaction writes of multiple items have a performance overhead, hence it is recommended to use
Expand All@@ -101,13 +109,20 @@ message PutObjectRequest {
// Items to be deleted as a result of this `PutObjectRequest`.
//
// Each item in the `delete_items` field consists of a `key` and its corresponding `version`.
// The `version` is used to perform a version check before deleting the item.
// The delete will only succeed if the current database version against the `key` is the same as the `version`
// specified in the request.
//
// Key-Level Versioning (Conditional Delete):
// The `version` is used to perform a version check before deleting the item.
// The delete will only succeed if the current database version against the `key` is the same as
// the `version` specified in the request.
//
// Skipping key-level versioning (Non-conditional Delete):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional delete query.
//
// Fails with `CONFLICT_EXCEPTION` as the ErrorCode if:
// * The requested item does not exist.
// * The requested item does exist but there is a version-number mismatch with the one in the database.
// * The requested item does exist but there is a version-number mismatch (in conditional delete)
// with the one in the database.
//
// Multiple items in the `delete_items` field, along with the `transaction_items`, are written in a
// database transaction in an all-or-nothing fashion.
Expand All@@ -133,8 +148,15 @@ message DeleteObjectRequest {
// Item to be deleted as a result of this `DeleteObjectRequest`.
//
// An item consists of a `key` and its corresponding `version`.
// The item is only deleted if the current database version against the `key` is the same as the `version`
// specified in the request.
//
// Key-level Versioning (Conditional Delete):
// The item is only deleted if the current database version against the `key` is the same as
// the `version` specified in the request.
//
// Skipping key-level versioning (Non-conditional Delete):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional delete query.
//
// This operation is idempotent, that is, multiple delete calls for the same item will not fail.
//
// If the requested item does not exist, this operation will not fail.
Expand Down
23 changes: 22 additions & 1 deletion app/src/test/java/org/vss/AbstractKVStoreIntegrationTest.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,15 +29,26 @@ public abstract class AbstractKVStoreIntegrationTest {

@Test
void putShouldSucceedWhenSingleObjectPutOperation() {
// Conditional Put
assertDoesNotThrow(() -> putObjects(0L, List.of(kv("k1", "k1v1", 0))));
assertDoesNotThrow(() -> putObjects(1L, List.of(kv("k1", "k1v2", 1))));

// NonConditional Put
assertDoesNotThrow(() -> putObjects(2L, List.of(kv("k2", "k2v1", -1))));
assertDoesNotThrow(() -> putObjects(3L, List.of(kv("k2", "k2v2", -1))));
assertDoesNotThrow(() -> putObjects(4L, List.of(kv("k2", "k2v3", -1))));

KeyValue response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertThat(response.getVersion(), is(2L));
assertThat(response.getValue().toStringUtf8(), is("k1v2"));

assertThat(getObject(KVStore.GLOBAL_VERSION_KEY).getVersion(), is(2L));
response = getObject("k2");
assertThat(response.getKey(), is("k2"));
assertThat(response.getVersion(), is(1L));
assertThat(response.getValue().toStringUtf8(), is("k1v3"));

assertThat(getObject(KVStore.GLOBAL_VERSION_KEY).getVersion(), is(5L));
}

@Test
Expand DownExpand Up@@ -168,11 +179,21 @@ void putAndDeleteShouldSucceedAsAtomicTransaction() {
@Test
void deleteShouldSucceedWhenItemExists() {
assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v1", 0))));
// Conditional Delete
assertDoesNotThrow(() -> deleteObject(kv("k1", "", 1)));

KeyValue response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertTrue(response.getValue().isEmpty());

assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v1", 0))));
assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v2", 1))));
// NonConditional Delete
assertDoesNotThrow(() -> deleteObject(kv("k1", "", -1)));

response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertTrue(response.getValue().isEmpty());
}

@Test
Expand Down
, '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
40 changes: 36 additions & 4 deletions app/src/main/java/org/vss/impl/postgres/PostgresBackendImpl.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
import java.util.Objects;
import javax.inject.Singleton;
import org.jooq.DSLContext;
import org.jooq.DeleteConditionStep;
import org.jooq.Insert;
import org.jooq.Query;
import org.jooq.Update;
Expand DownExpand Up@@ -108,24 +109,55 @@ public PutObjectResponse put(PutObjectRequest request) {
}

private Query buildDeleteObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
if (vssRecord.getVersion() == -1) {
return buildNonConditionalDeleteQuery(dsl, vssRecord);
} else {
return buildConditionalDeleteQuery(dsl, vssRecord);
}
}

private static DeleteConditionStep<VssDbRecord> buildNonConditionalDeleteQuery(DSLContext dsl,
VssDbRecord vssRecord) {
return dsl.deleteFrom(VSS_DB).where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey())));
}

private static DeleteConditionStep<VssDbRecord> buildConditionalDeleteQuery(DSLContext dsl,
VssDbRecord vssRecord) {
return dsl.deleteFrom(VSS_DB).where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey()))
.and(VSS_DB.VERSION.eq(vssRecord.getVersion())));
}

private Query buildPutObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
return vssRecord.getVersion() == 0 ? buildInsertRecordQuery(dsl, vssRecord)
: buildUpdateRecordQuery(dsl, vssRecord);
if (vssRecord.getVersion() == -1) {
return buildNonConditionalUpsertRecordQuery(dsl, vssRecord);
} else if (vssRecord.getVersion() == 0) {
return buildConditionalInsertRecordQuery(dsl, vssRecord);
} else {
return buildConditionalUpdateRecordQuery(dsl, vssRecord);
}
}

private Query buildNonConditionalUpsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.insertInto(VSS_DB)
.values(vssRecord.getStoreId(), vssRecord.getKey(),
vssRecord.getValue(), 1)
.onConflict(VSS_DB.STORE_ID, VSS_DB.KEY)
.doUpdate()
.set(VSS_DB.VALUE, vssRecord.getValue())
.set(VSS_DB.VERSION, 1L);
}

private Insert<VssDbRecord> buildInsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
private Insert<VssDbRecord> buildConditionalInsertRecordQuery(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) {
private Update<VssDbRecord> buildConditionalUpdateRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.update(VSS_DB)
.set(Map.of(VSS_DB.VALUE, vssRecord.getValue(),
VSS_DB.VERSION, vssRecord.getVersion() + 1))
Expand Down
56 changes: 39 additions & 17 deletions app/src/main/proto/vss.proto
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,18 +73,26 @@ message PutObjectRequest {
// a database-transaction in an all-or-nothing fashion.
// All Items in a single `PutObjectRequest` must have distinct keys.
//
// Clients are expected to store a `version` against every `key`.
// The write will succeed if the current DB version against the `key` is the same as in the request.
// When initiating a `PutObjectRequest`, the request should contain their client-side version for
// that key-value.
//
// For the first write of any key, the `version` should be '0'. If the write succeeds, the client
// must increment their corresponding key versions (client-side) by 1.
// The server increments key versions (server-side) for every successful write, hence this
// client-side increment is required to ensure matching versions. These updated key versions should
// be used in subsequent `PutObjectRequest`s for the keys.
// Key-level versioning (Conditional Write):
// Clients are expected to store a `version` against every `key`.
// The write will succeed if the current DB version against the `key` is the same as in the request.
// When initiating a `PutObjectRequest`, the request should contain their client-side `version`
// for that key-value.
//
// Requests with a conflicting version will fail with `CONFLICT_EXCEPTION` as ErrorCode.
// For the first write of any `key`, the `version` should be '0'. If the write succeeds, the client
// must increment their corresponding key versions (client-side) by 1.
// The server increments key versions (server-side) for every successful write, hence this
// client-side increment is required to ensure matching versions. These updated key versions should
// be used in subsequent `PutObjectRequest`s for the keys.
//
// Requests with a conflicting/mismatched version will fail with `CONFLICT_EXCEPTION` as ErrorCode
// for conditional writes.
//
// Skipping key-level versioning (Non-conditional Write):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional write query, after which the `version` against the `key`
// is reset to '1'. Hence, the next `PutObjectRequest` for the `key` can be either
// a non-conditional write or a conditional write with `version` set to `1`.
//
// Considerations for transactions:
// Transaction writes of multiple items have a performance overhead, hence it is recommended to use
Expand All@@ -101,13 +109,20 @@ message PutObjectRequest {
// Items to be deleted as a result of this `PutObjectRequest`.
//
// Each item in the `delete_items` field consists of a `key` and its corresponding `version`.
// The `version` is used to perform a version check before deleting the item.
// The delete will only succeed if the current database version against the `key` is the same as the `version`
// specified in the request.
//
// Key-Level Versioning (Conditional Delete):
// The `version` is used to perform a version check before deleting the item.
// The delete will only succeed if the current database version against the `key` is the same as
// the `version` specified in the request.
//
// Skipping key-level versioning (Non-conditional Delete):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional delete query.
//
// Fails with `CONFLICT_EXCEPTION` as the ErrorCode if:
// * The requested item does not exist.
// * The requested item does exist but there is a version-number mismatch with the one in the database.
// * The requested item does exist but there is a version-number mismatch (in conditional delete)
// with the one in the database.
//
// Multiple items in the `delete_items` field, along with the `transaction_items`, are written in a
// database transaction in an all-or-nothing fashion.
Expand All@@ -133,8 +148,15 @@ message DeleteObjectRequest {
// Item to be deleted as a result of this `DeleteObjectRequest`.
//
// An item consists of a `key` and its corresponding `version`.
// The item is only deleted if the current database version against the `key` is the same as the `version`
// specified in the request.
//
// Key-level Versioning (Conditional Delete):
// The item is only deleted if the current database version against the `key` is the same as
// the `version` specified in the request.
//
// Skipping key-level versioning (Non-conditional Delete):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional delete query.
//
// This operation is idempotent, that is, multiple delete calls for the same item will not fail.
//
// If the requested item does not exist, this operation will not fail.
Expand Down
23 changes: 22 additions & 1 deletion app/src/test/java/org/vss/AbstractKVStoreIntegrationTest.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,15 +29,26 @@ public abstract class AbstractKVStoreIntegrationTest {

@Test
void putShouldSucceedWhenSingleObjectPutOperation() {
// Conditional Put
assertDoesNotThrow(() -> putObjects(0L, List.of(kv("k1", "k1v1", 0))));
assertDoesNotThrow(() -> putObjects(1L, List.of(kv("k1", "k1v2", 1))));

// NonConditional Put
assertDoesNotThrow(() -> putObjects(2L, List.of(kv("k2", "k2v1", -1))));
assertDoesNotThrow(() -> putObjects(3L, List.of(kv("k2", "k2v2", -1))));
assertDoesNotThrow(() -> putObjects(4L, List.of(kv("k2", "k2v3", -1))));

KeyValue response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertThat(response.getVersion(), is(2L));
assertThat(response.getValue().toStringUtf8(), is("k1v2"));

assertThat(getObject(KVStore.GLOBAL_VERSION_KEY).getVersion(), is(2L));
response = getObject("k2");
assertThat(response.getKey(), is("k2"));
assertThat(response.getVersion(), is(1L));
assertThat(response.getValue().toStringUtf8(), is("k1v3"));

assertThat(getObject(KVStore.GLOBAL_VERSION_KEY).getVersion(), is(5L));
}

@Test
Expand DownExpand Up@@ -168,11 +179,21 @@ void putAndDeleteShouldSucceedAsAtomicTransaction() {
@Test
void deleteShouldSucceedWhenItemExists() {
assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v1", 0))));
// Conditional Delete
assertDoesNotThrow(() -> deleteObject(kv("k1", "", 1)));

KeyValue response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertTrue(response.getValue().isEmpty());

assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v1", 0))));
assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v2", 1))));
// NonConditional Delete
assertDoesNotThrow(() -> deleteObject(kv("k1", "", -1)));

response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertTrue(response.getValue().isEmpty());
}

@Test
Expand Down
, '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
40 changes: 36 additions & 4 deletions app/src/main/java/org/vss/impl/postgres/PostgresBackendImpl.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
import java.util.Objects;
import javax.inject.Singleton;
import org.jooq.DSLContext;
import org.jooq.DeleteConditionStep;
import org.jooq.Insert;
import org.jooq.Query;
import org.jooq.Update;
Expand DownExpand Up@@ -108,24 +109,55 @@ public PutObjectResponse put(PutObjectRequest request) {
}

private Query buildDeleteObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
if (vssRecord.getVersion() == -1) {
return buildNonConditionalDeleteQuery(dsl, vssRecord);
} else {
return buildConditionalDeleteQuery(dsl, vssRecord);
}
}

private static DeleteConditionStep<VssDbRecord> buildNonConditionalDeleteQuery(DSLContext dsl,
VssDbRecord vssRecord) {
return dsl.deleteFrom(VSS_DB).where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey())));
}

private static DeleteConditionStep<VssDbRecord> buildConditionalDeleteQuery(DSLContext dsl,
VssDbRecord vssRecord) {
return dsl.deleteFrom(VSS_DB).where(VSS_DB.STORE_ID.eq(vssRecord.getStoreId())
.and(VSS_DB.KEY.eq(vssRecord.getKey()))
.and(VSS_DB.VERSION.eq(vssRecord.getVersion())));
}

private Query buildPutObjectQuery(DSLContext dsl, VssDbRecord vssRecord) {
return vssRecord.getVersion() == 0 ? buildInsertRecordQuery(dsl, vssRecord)
: buildUpdateRecordQuery(dsl, vssRecord);
if (vssRecord.getVersion() == -1) {
return buildNonConditionalUpsertRecordQuery(dsl, vssRecord);
} else if (vssRecord.getVersion() == 0) {
return buildConditionalInsertRecordQuery(dsl, vssRecord);
} else {
return buildConditionalUpdateRecordQuery(dsl, vssRecord);
}
}

private Query buildNonConditionalUpsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.insertInto(VSS_DB)
.values(vssRecord.getStoreId(), vssRecord.getKey(),
vssRecord.getValue(), 1)
.onConflict(VSS_DB.STORE_ID, VSS_DB.KEY)
.doUpdate()
.set(VSS_DB.VALUE, vssRecord.getValue())
.set(VSS_DB.VERSION, 1L);
}

private Insert<VssDbRecord> buildInsertRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
private Insert<VssDbRecord> buildConditionalInsertRecordQuery(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) {
private Update<VssDbRecord> buildConditionalUpdateRecordQuery(DSLContext dsl, VssDbRecord vssRecord) {
return dsl.update(VSS_DB)
.set(Map.of(VSS_DB.VALUE, vssRecord.getValue(),
VSS_DB.VERSION, vssRecord.getVersion() + 1))
Expand Down
56 changes: 39 additions & 17 deletions app/src/main/proto/vss.proto
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,18 +73,26 @@ message PutObjectRequest {
// a database-transaction in an all-or-nothing fashion.
// All Items in a single `PutObjectRequest` must have distinct keys.
//
// Clients are expected to store a `version` against every `key`.
// The write will succeed if the current DB version against the `key` is the same as in the request.
// When initiating a `PutObjectRequest`, the request should contain their client-side version for
// that key-value.
//
// For the first write of any key, the `version` should be '0'. If the write succeeds, the client
// must increment their corresponding key versions (client-side) by 1.
// The server increments key versions (server-side) for every successful write, hence this
// client-side increment is required to ensure matching versions. These updated key versions should
// be used in subsequent `PutObjectRequest`s for the keys.
// Key-level versioning (Conditional Write):
// Clients are expected to store a `version` against every `key`.
// The write will succeed if the current DB version against the `key` is the same as in the request.
// When initiating a `PutObjectRequest`, the request should contain their client-side `version`
// for that key-value.
//
// Requests with a conflicting version will fail with `CONFLICT_EXCEPTION` as ErrorCode.
// For the first write of any `key`, the `version` should be '0'. If the write succeeds, the client
// must increment their corresponding key versions (client-side) by 1.
// The server increments key versions (server-side) for every successful write, hence this
// client-side increment is required to ensure matching versions. These updated key versions should
// be used in subsequent `PutObjectRequest`s for the keys.
//
// Requests with a conflicting/mismatched version will fail with `CONFLICT_EXCEPTION` as ErrorCode
// for conditional writes.
//
// Skipping key-level versioning (Non-conditional Write):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional write query, after which the `version` against the `key`
// is reset to '1'. Hence, the next `PutObjectRequest` for the `key` can be either
// a non-conditional write or a conditional write with `version` set to `1`.
//
// Considerations for transactions:
// Transaction writes of multiple items have a performance overhead, hence it is recommended to use
Expand All@@ -101,13 +109,20 @@ message PutObjectRequest {
// Items to be deleted as a result of this `PutObjectRequest`.
//
// Each item in the `delete_items` field consists of a `key` and its corresponding `version`.
// The `version` is used to perform a version check before deleting the item.
// The delete will only succeed if the current database version against the `key` is the same as the `version`
// specified in the request.
//
// Key-Level Versioning (Conditional Delete):
// The `version` is used to perform a version check before deleting the item.
// The delete will only succeed if the current database version against the `key` is the same as
// the `version` specified in the request.
//
// Skipping key-level versioning (Non-conditional Delete):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional delete query.
//
// Fails with `CONFLICT_EXCEPTION` as the ErrorCode if:
// * The requested item does not exist.
// * The requested item does exist but there is a version-number mismatch with the one in the database.
// * The requested item does exist but there is a version-number mismatch (in conditional delete)
// with the one in the database.
//
// Multiple items in the `delete_items` field, along with the `transaction_items`, are written in a
// database transaction in an all-or-nothing fashion.
Expand All@@ -133,8 +148,15 @@ message DeleteObjectRequest {
// Item to be deleted as a result of this `DeleteObjectRequest`.
//
// An item consists of a `key` and its corresponding `version`.
// The item is only deleted if the current database version against the `key` is the same as the `version`
// specified in the request.
//
// Key-level Versioning (Conditional Delete):
// The item is only deleted if the current database version against the `key` is the same as
// the `version` specified in the request.
//
// Skipping key-level versioning (Non-conditional Delete):
// If you wish to skip key-level version checks, set the `version` against the `key` to '-1'.
// This will perform a non-conditional delete query.
//
// This operation is idempotent, that is, multiple delete calls for the same item will not fail.
//
// If the requested item does not exist, this operation will not fail.
Expand Down
23 changes: 22 additions & 1 deletion app/src/test/java/org/vss/AbstractKVStoreIntegrationTest.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,15 +29,26 @@ public abstract class AbstractKVStoreIntegrationTest {

@Test
void putShouldSucceedWhenSingleObjectPutOperation() {
// Conditional Put
assertDoesNotThrow(() -> putObjects(0L, List.of(kv("k1", "k1v1", 0))));
assertDoesNotThrow(() -> putObjects(1L, List.of(kv("k1", "k1v2", 1))));

// NonConditional Put
assertDoesNotThrow(() -> putObjects(2L, List.of(kv("k2", "k2v1", -1))));
assertDoesNotThrow(() -> putObjects(3L, List.of(kv("k2", "k2v2", -1))));
assertDoesNotThrow(() -> putObjects(4L, List.of(kv("k2", "k2v3", -1))));

KeyValue response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertThat(response.getVersion(), is(2L));
assertThat(response.getValue().toStringUtf8(), is("k1v2"));

assertThat(getObject(KVStore.GLOBAL_VERSION_KEY).getVersion(), is(2L));
response = getObject("k2");
assertThat(response.getKey(), is("k2"));
assertThat(response.getVersion(), is(1L));
assertThat(response.getValue().toStringUtf8(), is("k1v3"));

assertThat(getObject(KVStore.GLOBAL_VERSION_KEY).getVersion(), is(5L));
}

@Test
Expand DownExpand Up@@ -168,11 +179,21 @@ void putAndDeleteShouldSucceedAsAtomicTransaction() {
@Test
void deleteShouldSucceedWhenItemExists() {
assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v1", 0))));
// Conditional Delete
assertDoesNotThrow(() -> deleteObject(kv("k1", "", 1)));

KeyValue response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertTrue(response.getValue().isEmpty());

assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v1", 0))));
assertDoesNotThrow(() -> putObjects(null, List.of(kv("k1", "k1v2", 1))));
// NonConditional Delete
assertDoesNotThrow(() -> deleteObject(kv("k1", "", -1)));

response = getObject("k1");
assertThat(response.getKey(), is("k1"));
assertTrue(response.getValue().isEmpty());
}

@Test
Expand Down