[shared storage] Implement the batch with_lock option for response …

…header Parse "options;with_lock=xxx" into the `with_lock` parameter. If multiple "options" Items appear in the List, the last one will be used. The parsed value is passed to the browser process's `BatchUpdate()` API in the lock manager. This allows developers to perform multiple Shared Storage operations atomically within a single lock, as part of the Web Lock integration proposal: - WICG/shared-storage#199 - WICG/shared-storage#205 Bug: 373899210 Change-Id: Id041e92075b22988656a3db4f1a74792312ee422 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/6072742 Reviewed-by: Gary Kacmarcik <garykac@chromium.org> Reviewed-by: Avi Drissman <avi@chromium.org> Commit-Queue: Yao Xiao <yaoxia@chromium.org> Reviewed-by: Joe Mason <joenotcharles@google.com> Reviewed-by: Cammie Smith Barnes <cammie@chromium.org> Reviewed-by: Adam Rice <ricea@chromium.org> Cr-Commit-Position: refs/heads/main@{#1397664}
web-platform-tests · Dec 18, 2024 · 3f1b4be · 3f1b4be
1 parent 72af8ee
commit 3f1b4be
Showing 1 changed file with 83 additions and 0 deletions.
diff --git a/shared-storage/web-locks-header-batch-update.tentative.https.sub.html b/shared-storage/web-locks-header-batch-update.tentative.https.sub.html
@@ -0,0 +1,83 @@
+<!doctype html>
+<script src="/resources/testharness.js"></script>
+<script src="/resources/testharnessreport.js"></script>
+<script src="/common/utils.js"></script>
+<script src="/shared-storage/resources/util.js"></script>
+<script src="/fenced-frame/resources/utils.js"></script>
+
+<body>
+<script>
+'use strict';
+
+promise_test(async t => {
+  const worklet = await sharedStorage.createWorklet('resources/simple-module.js');
+
+  const ancestor_key = token();
+  const url0 = generateURL("/shared-storage/resources/frame0.html",
+                           [ancestor_key]);
+  const url1 = generateURL("/shared-storage/resources/frame1.html",
+                           [ancestor_key]);
+
+  // Invoke `selectURL()` to perform the following steps:
+  // 1. Acquires the lock.
+  // 2. Reads the current value at the given key.
+  // 3. Waits for 500ms.
+  // 4. Sets the shared storage value to the read value appended with the given letter.
+  // 5. Releases the lock.
+  //
+  // After 100ms, send a fetch() request. The response sends the
+  // `Shared-Storage-Write` header that:
+  // - Acquires the same named lock via the batch `options`
+  // - Executes two `append` methods, each appending the same letter.
+  //
+  // Expected behavior: After both of them finish, the value at the given key
+  // should contain the letter repeated three times.
+  //
+  // This demonstrates that:
+  // 1. The `withLock` option is effective, preventing the header batch update
+  //    interfering with the "get and set" operation. If the lock were not used,
+  //    the final value would likely be a single letter.
+  // 2. The header batch update correctly executes all `append` methods within
+  //    the batch.
+  //
+  // Note: This test remains valid even if the header batch update happens
+  // outside the critical section protected by the lock within the worklet. The
+  // test effectively demonstrates mutual exclusion as long as there's a
+  // reasonable chance for the header batch update to occur while the worklet is
+  // still running.
+  const select_url_result = await worklet.selectURL(
+      "get-wait-set-within-lock",
+      [{url: url0}, {url: url1}],
+      {data: {'key': 'key',
+              'lock_name': 'lock1',
+              'append_letter': 'a'},
+      resolveToConfig: true});
+
+  // Busy wait for 100ms.
+  const startWaitTime = Date.now();
+  while (Date.now() - startWaitTime < 100) {}
+
+  // After 100ms, send a fetch() request. The response sends the
+  // `Shared-Storage-Write` header that:
+  // - Acquires the same named lock via the batch `options`
+  // - Executes two `append` methods, each appending the same letter.
+  const rawUpdatesHeader = 'append;key=key;value=a, append;key=key;value=a, options;with_lock=lock1';
+  const updatesHeader = encodeURIComponent(rawUpdatesHeader);
+  const updatesUrl =
+    `/shared-storage/resources/shared-storage-write.py?write=${updatesHeader}`;
+
+  const response = await fetch(updatesUrl, {sharedStorageWritable: true});
+  const sharedStorageWritableHeader = await response.text();
+  assert_equals(sharedStorageWritableHeader, "?1");
+
+  attachFencedFrame(select_url_result, 'opaque-ads');
+  const result = await nextValueFromServer(ancestor_key);
+  assert_equals(result, "frame1_loaded");
+
+  await verifyKeyValueForOrigin('key', 'aaa', location.origin);
+
+  await deleteKeyForOrigin('key', location.origin);
+}, 'Test for batch withLock option in the Shared-Storage-Write response header');
+
+</script>
+</body>