adjust for alarm storage (#298)

* adjust for alarm storage

* test case more clear

* better comments

* adjust options not overwritten

* Update plugin.spec.ts

Co-authored-by: MrBBot <[email protected]>

Author: CraigglesO

packages/durable-objects/src/storage.ts

@@ -183,28 +183,31 @@ async function list<Value = unknown>(
       "list() cannot be called with both start and startAfter values."
     );
   }
+  options = { ...options };
   const originalLimit = options.limit;
+  // Since alarms now exist in storage, add 1 to the limit to account for
+  // the alarm key.
+  if (options.limit !== undefined) options.limit++;
   if (options.startAfter !== undefined) {
     // If *exclusive* `startAfter` is set, set it as the *inclusive* `start`.
     // Then if `startAfter` does exist as a key, we can remove it later.
     // To ensure we still return `limit` keys in this case, add 1 to the limit
     // if one is set.
-    options = { ...options, start: options.startAfter };
+    options.start = options.startAfter;
     if (options.limit !== undefined) options.limit++;
   }
 
   const { keys } = await storage.list(options);
-  let keyNames = keys.map(({ name }) => name);
+  let keyNames = keys
+    .map(({ name }) => name)
+    .filter((name) => name !== ALARM_KEY);
 
-  if (options.startAfter !== undefined) {
-    if (keyNames[0] === options.startAfter) {
-      // If the first key matched `startAfter`, remove it as this is exclusive.
-      keyNames.splice(0, 1);
-    } else if (originalLimit !== undefined) {
-      // Otherwise, make sure the original `limit` still holds.
-      keyNames = keyNames.slice(0, originalLimit);
-    }
+  if (options.startAfter !== undefined && keyNames[0] === options.startAfter) {
+    // If the first key matched `startAfter`, remove it as this is exclusive.
+    keyNames.splice(0, 1);
   }
+  // Make sure the original `limit` still holds.
+  if (originalLimit !== undefined) keyNames = keyNames.slice(0, originalLimit);
 
   return get(
     storage,

packages/durable-objects/test/plugin.spec.ts

@@ -337,3 +337,29 @@ test("DurableObjectsPlugin: setup alarms and dispose alarms", async (t) => {
   plugin.dispose();
   t.false(plugin.durableObjectsAlarms);
 });
+
+test("DurableObjectsPlugin: set alarm and run list filters out alarm", async (t) => {
+  class Object1 implements DurableObject {
+    constructor(private readonly state: DurableObjectState) {}
+
+    fetch = async () => {
+      await this.state.storage.setAlarm(Date.now() + 60 * 1000);
+      const list = await this.state.storage.list();
+      return new Response(JSON.stringify(list));
+    };
+    alarm = () => {};
+  }
+
+  const factory = new MemoryStorageFactory();
+  const plugin = new DurableObjectsPlugin(ctx, {
+    durableObjects: { OBJECT1: "Object1" },
+  });
+
+  const result = await plugin.setup(factory);
+  plugin.beforeReload();
+  plugin.reload({}, { Object1 }, new Map());
+
+  const ns1: DurableObjectNamespace = result.bindings?.OBJECT1;
+  const res1 = await ns1.get(ns1.newUniqueId()).fetch("/");
+  t.is(await res1.text(), "{}");
+});