Consider eventual consisteny in TODO example about worktop HOT 4 CLOSED

Yup. PR in the works for all metadata-stuff. Was a busy week so havent had time to finish it up yet.

from worktop.

In the TODO example, we will lose data when multiple users create TODO's in the time range

There will be synchronization issues if UserA and UserB are writing into the same key, but that doesn't happen in this example. The example is setup in a way so that UserA only deals with UserA's todos (eg, user::UserA::todos) and UserB only cares about their own todos (eg, user::UserB::todos).

That said, if UserA adds multiple todos in close succession, then that may cause replication issues within the user::UserA::todos document. This is because the save() helper is called at the end of the insert model method, which is hard-coded to write into the same key.

This save method could be skipped entirely in favor of a new list() model method that would use a prefix match for keys. Across regions, there will still be replication delay, but there won't ever be actual data loss or (true) data inconsistency because there's no write/update into the same document. In practice, this means that users in other regions may see items missing during their KV.list result, but it's guaranteed to show up within the minute.

This updated, hypothetical list method would look like this:

export async function list(username: string): Promise<Todo['uid'][]> {
  const prefix = key_owner(username) + '::';
  const keys = await TODOS.list({ prefix, limit: 10 });

  // The current example returns Array<Todo['uid']>
  // So stopping here, but could do Promise.all(/* key lookup */)
  
  // strip prefix; eg `key_item - (key_owner + '::') = uid`
  return keys.map(key => key.substring(prefix.length));
}

Durable Objects will solve it but I'm surprised that they can only hold 32KiB

DOs are still in beta & worktop (purposefully) doesn't integrate with or support them yet. This is to avoid early/unnecessary breaking API changes while DO-things continue to finalize.

from worktop.

Hi @lukeed thanks for the write-up. Indeed, the list is scoped to the user. Great tip with the prefix-match. In combination with the metadata, it allows storing a kind of search index next to the item to avoid loading all key values.

Do you plan to support the metadata option in the WriteOptions ?

from worktop.

metadata is also missing on the ListOptions type.

from worktop.