Add and handle live-updates to saved snippets data

[PIG208]

This prepares the data model and API bindings for #1391 towards #863.

[chrisbobbe]

Thanks!! Small comments below.

[chrisbobbe]

api: Add save_snippets events and handle live-updates

Commit-message nit: saved_snippets

[chrisbobbe]

Also this is labeled as an "api:" commit, but it also adds to model code; how about separate api: and model: commits?

(Or perhaps just one model: commit with the API-binding additions lumped into that same commit—but if doing that, it would be logical to lump all the new API-binding code into that commit, including the initial-snapshot code.)

[chrisbobbe]

Normally a substore would extend PerAccountStoreBase…it seems we don't depend on that here though 🙂 but maybe it's helpful to do it anyway, in case it's needed in the future, and also as an example for future substore implementations?

diff --git lib/model/saved_snippet.dart lib/model/saved_snippet.dart
index 66b50781d..92cb253ef 100644
--- lib/model/saved_snippet.dart
+++ lib/model/saved_snippet.dart
@@ -2,14 +2,18 @@ import 'package:collection/collection.dart';
 
 import '../api/model/events.dart';
 import '../api/model/model.dart';
+import 'store.dart';
 
 mixin SavedSnippetStore {
   Map<int, SavedSnippet> get savedSnippets;
 }
 
-class SavedSnippetStoreImpl with SavedSnippetStore {
-  SavedSnippetStoreImpl({required Iterable<SavedSnippet> savedSnippets})
-    : _savedSnippets = {
+class SavedSnippetStoreImpl extends PerAccountStoreBase with SavedSnippetStore {
+  SavedSnippetStoreImpl({
+    required super.core,
+    required Iterable<SavedSnippet> savedSnippets,
+  }) :
+      _savedSnippets = {
         for (final savedSnippet in savedSnippets)
           savedSnippet.id: savedSnippet,
       };

[chrisbobbe]

nit: space after comma; actually maybe put savedSnippet: on the next line, with eg.savedSnippet(?

[PIG208]

Thanks! Updated the PR.

[chrisbobbe]

Thanks! Small comments below.

[chrisbobbe]

api: Add createSavedSnippet route

This needs a simple smoke test in test/api/route/.

[chrisbobbe]

Ah I guess this case needs to be handled (as a no-op) in the earlier commit—

api: Add saved_snippets events

—to satisfy the analyzer there.

[chrisbobbe]

model: Handle live-updates to savedSnippets

Commit-message nit: this commit does more than just handle live-updates to savedSnippets—it's what adds savedSnippets into the codebase in the first place :)

Could be:

model: Add PerAccountStore.savedSnippets, updating with events

or similar.

[PIG208]

Thanks! Pushed an update.

[chrisbobbe]

Thanks! One nit below, and I'll mark for Greg's review.

[chrisbobbe]

Suggested change

	check(connection.takeRequests()).single.isA<http.Request>()
	.bodyFields.deepEquals({
	'title': 'test saved snippet',
	'content': 'content',
	});
	check(connection.takeRequests()).single.isA<http.Request>()
	.bodyFields.deepEquals({
	'title': 'test saved snippet',
	'content': 'content',
	});

(I think)

[PIG208]

Oh right. Oops 😬

[gnprice]

Thanks to you both! I've done a quick skim, and this structure looks good. I like the organization with the separate API and model/store commits (as per #1511 (comment)), with this to decouple the API event commit from the store changes:

      case SavedSnippetsEvent():
        // TODO handle
        break;

I'll aim to do a full review tomorrow.

[gnprice]

nit: It looks like these docs are actually next to each other, so this class can usefully link to the one that comes first. (The subclasses can still link to the individual sections.)

This wording was originally for realm_user, which is actually scattered across two widely-separated places in https://zulip.com/api/get-events . (And I see I wrote it at the same time for stream but it's not true of stream now; not sure if that was an oversight or that one got fixed since then.)