Merge pull request #134 from makeflow/7382

7382

Author: vilicvane

.vscode/settings.json

@@ -9,5 +9,5 @@
   "files.insertFinalNewline": true,
   "files.trimTrailingWhitespace": true,
   "typescript.tsdk": "node_modules/typescript/lib",
-  "cSpell.words": ["jsondiffpatch", "mobx", "syncable", "syncables"]
+  "cSpell.words": ["jsondiffpatch", "mobx", "syncable", "syncables", "tslang"]
 }

client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncable/client",
-  "version": "3.0.0-wip.54",
+  "version": "3.0.0-wip.60",
   "publishConfig": {
     "access": "public"
   },
@@ -37,7 +37,7 @@
   "dependencies": {
     "jsondiffpatch": "^0.3.11",
     "lodash": "^4.17.14",
-    "tslang": "^0.1.22",
+    "tslang": "^0.1.23",
     "villa": "^0.3.1"
   },
   "devDependencies": {

client/src/library/client.ts

@@ -203,15 +203,19 @@ export class Client<TGenericParams extends IClientGenericParams>
 
   async query(
     update: ViewQueryUpdateObject<TGenericParams['viewQueryDict']>,
+    forceUpdate?: boolean,
   ): Promise<void>;
-  async query(update: ViewQueryUpdateObject): Promise<void> {
+  async query(
+    update: ViewQueryUpdateObject,
+    forceUpdate?: boolean,
+  ): Promise<void> {
     runInAction(() => {
       this.pendingQueryingNumber++;
     });
 
     try {
       await this.ready;
-      await this._query(update);
+      await this._query(update, forceUpdate);
     } finally {
       runInAction(() => {
         this.pendingQueryingNumber--;
@@ -260,6 +264,7 @@ export class Client<TGenericParams extends IClientGenericParams>
           syncables: [],
           removals: [],
           updates: [],
+          queryMetadata: {},
         },
         {
           id,
@@ -338,9 +343,13 @@ export class Client<TGenericParams extends IClientGenericParams>
   @RPCMethod()
   @action
   sync(
-    {syncables, removals, updates}: SyncData,
+    {syncables, removals, updates, queryMetadata}: SyncData,
     source?: SyncUpdateSource,
   ): void {
+    for (let [viewQueryName, metadata] of Object.entries(queryMetadata)) {
+      this.context.setQueryMetadata(viewQueryName, metadata);
+    }
+
     let container = this.container;
 
     let pendingChangeInfos = this.pendingChangeInfos;
@@ -444,7 +453,10 @@ export class Client<TGenericParams extends IClientGenericParams>
     this.container.addSyncable(snapshot, clock);
   }
 
-  private async _query(update: ViewQueryUpdateObject): Promise<void> {
+  private async _query(
+    update: ViewQueryUpdateObject,
+    forceUpdate = false,
+  ): Promise<void> {
     update = _.cloneDeep(update);
 
     let viewQueryInfoMap = this.nameToViewQueryInfoMap;
@@ -454,7 +466,7 @@ export class Client<TGenericParams extends IClientGenericParams>
     ).filter(([name, query]) => {
       let info = viewQueryInfoMap.get(name);
 
-      if (info && _.isEqual(toJS(info.query), query)) {
+      if (info && _.isEqual(toJS(info.query), query) && !forceUpdate) {
         delete (update as any)[name];
         return false;
       } else {

core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncable/core",
-  "version": "3.0.0-wip.58",
+  "version": "3.0.0-wip.61",
   "publishConfig": {
     "access": "public"
   },
@@ -38,7 +38,7 @@
     "jsondiffpatch": "^0.3.11",
     "lodash": "^4.17.14",
     "replace-object": "^0.2.1",
-    "tslang": "^0.1.22",
+    "tslang": "^0.1.23",
     "uuid": "^3.3.2",
     "villa": "^0.3.1"
   },

core/src/library/connection-client/sync.ts

@@ -8,10 +8,11 @@ export interface SyncDataUpdateEntry {
   delta: Delta;
 }
 
-export interface SyncData {
+export interface SyncData<TQueryMetadata = object> {
   syncables: ISyncable[];
   removals: SyncableRef[];
   updates: SyncDataUpdateEntry[];
+  queryMetadata: TQueryMetadata;
 }
 
 export interface SyncUpdateSource {

core/src/library/context.ts

@@ -1,4 +1,5 @@
 import {observable} from 'mobx';
+import {Dict} from 'tslang';
 
 import {ISyncableObject, SyncableRef} from './syncable';
 
@@ -14,13 +15,19 @@ export type ContextType = 'server' | 'user';
 
 export type ContextEnvironment = 'server' | 'client';
 
-abstract class Context<TSyncableObject extends ISyncableObject> {
+abstract class Context<
+  TSyncableObject extends ISyncableObject,
+  TViewQueryMetadataDict extends object
+> {
   @observable
   ref!: SyncableRef<TSyncableObject>;
 
   @observable
   object!: TSyncableObject;
 
+  @observable
+  queryMetadataDict: Partial<TViewQueryMetadataDict> = {};
+
   constructor(
     readonly type: ContextType,
     readonly environment: ContextEnvironment,
@@ -41,10 +48,15 @@ abstract class Context<TSyncableObject extends ISyncableObject> {
     this.ref = object.ref;
     this.object = object;
   }
+
+  setQueryMetadata(name: string, metadata: unknown): void {
+    (this.queryMetadataDict as Dict<unknown>)[name] = metadata;
+  }
 }
 
 export interface IContext<
-  TSyncableObject extends ISyncableObject = ISyncableObject
-> extends Context<TSyncableObject> {}
+  TSyncableObject extends ISyncableObject = ISyncableObject,
+  TViewQueryMetadataDict extends object = Dict<unknown>
+> extends Context<TSyncableObject, TViewQueryMetadataDict> {}
 
 export const AbstractContext = Context;

lerna.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.0.0-wip.59",
+  "version": "3.0.0-wip.62",
   "npmClient": "yarn",
   "command": {
     "publish": {

server/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncable/server",
-  "version": "3.0.0-wip.59",
+  "version": "3.0.0-wip.62",
   "publishConfig": {
     "access": "public"
   },
@@ -36,7 +36,7 @@
     "extendable-error": "^0.1.5",
     "lodash": "^4.17.14",
     "rxjs": "^6.5.2",
-    "tslang": "^0.1.22",
+    "tslang": "^0.1.23",
     "villa": "^0.3.1"
   },
   "devDependencies": {

server/src/library/connection/connection.ts

@@ -82,6 +82,8 @@ export class Connection<
 
   private nameToViewQueryInfoMap = new Map<string, ViewQueryInfo>();
 
+  private nameToContextDependencyRefsMap = new Map<string, SyncableRef[]>();
+
   private loadedKeySet = new Set<string>();
   private sanitizedFieldNamesMap = new Map<string, string[]>();
 
@@ -275,7 +277,27 @@ export class Connection<
     let nameToViewQueryInfoMap = this.nameToViewQueryInfoMap;
 
     if (contextObjectChanged) {
-      relevantViewQueryNames = Array.from(nameToViewQueryInfoMap.keys());
+      let contextDependencyRefsEntries = Object.entries(
+        await this.server.resolveQueryToContextDependencyRefsDict(context),
+      );
+
+      relevantViewQueryNames = _.union(
+        Array.from(nameToViewQueryInfoMap.keys()),
+        _.compact(
+          contextDependencyRefsEntries.map(([viewQueryName, refs]) =>
+            _.isEqual(
+              this.nameToContextDependencyRefsMap.get(viewQueryName),
+              refs,
+            )
+              ? undefined
+              : viewQueryName,
+          ),
+        ),
+      );
+
+      this.nameToContextDependencyRefsMap = new Map(
+        contextDependencyRefsEntries,
+      );
     } else {
       let keyToViewQueryNameSet = new Map<string, Set<string>>();
 
@@ -285,7 +307,10 @@ export class Connection<
           query: {refs: refDict},
         },
       ] of nameToViewQueryInfoMap) {
-        for (let ref of Object.values(refDict)) {
+        for (let ref of _.union(
+          Object.values(refDict).flat(),
+          this.nameToContextDependencyRefsMap.get(name) || [],
+        )) {
           let key = getSyncableKey(ref);
 
           let nameSet = keyToViewQueryNameSet.get(key);
@@ -467,10 +492,13 @@ export class Connection<
 
     syncables.push(...sanitizedDependentSyncables);
 
+    let queryMetadata = context.queryMetadataDict;
+
     let data: SyncData = {
       syncables,
       removals,
       updates,
+      queryMetadata,
     };
 
     if (
@@ -542,8 +570,18 @@ export class Connection<
       if (context.disabled) {
         throw new RPCError('CONTEXT_DISABLED');
       }
+
+      let contextDependencyRefsDict = await this.server.resolveQueryToContextDependencyRefsDict(
+        context,
+      );
+
+      this.nameToContextDependencyRefsMap = new Map(
+        Object.entries(contextDependencyRefsDict),
+      );
     }
 
+    let previousQueryMetadataDict = _.cloneDeep(context.queryMetadataDict);
+
     let {
       syncables,
       nameToViewQueryMapToAdd,
@@ -575,10 +613,13 @@ export class Connection<
       loadedKeySet.add(getSyncableKey(syncable));
     }
 
+    let queryMetadataDict = context.queryMetadataDict;
+
     let data: SyncData = {
       syncables,
       removals: [],
       updates: [],
+      queryMetadata: queryMetadataDict,
     };
 
     if (toInitialize) {
@@ -588,26 +629,31 @@ export class Connection<
         contextRef,
         this.connectionAdapter.viewQueryDict as ViewQueryUpdateObject,
       );
-    } else if (syncables.length || source) {
+    } else if (
+      syncables.length ||
+      source ||
+      !_.isEqual(previousQueryMetadataDict, queryMetadataDict)
+    ) {
       await (this as RPCPeer<ClientRPCDefinition>).call('sync', data, source);
     }
   }
 
   private async request(refs: SyncableRef[]): Promise<void> {
     let loadedKeySet = this.loadedKeySet;
     let sanitizedFieldNamesMap = this.sanitizedFieldNamesMap;
+    let context = this.context;
 
     let syncables = await this.server.loadSyncablesByRefs(
       this.group,
-      this.context,
+      context,
       refs,
       {
         loadedKeySet,
       },
     );
 
     syncables = filterReadableSyncables(
-      this.context,
+      context,
       this.syncableAdapter,
       syncables,
       true,
@@ -627,6 +673,7 @@ export class Connection<
       syncables,
       removals: [],
       updates: [],
+      queryMetadata: context.queryMetadataDict,
     });
   }
 }

server/src/library/server/server-adapter.ts

@@ -6,6 +6,7 @@ import {
   ViewQueryDictToResolvedViewQueryDict,
 } from '@syncable/core';
 import {Observable} from 'rxjs';
+import {Dict} from 'tslang';
 
 import {Connection} from '../connection';
 
@@ -40,6 +41,18 @@ export interface IServerAdapter<
     processor: QueuedChangeProcessor,
   ): Promise<void>;
 
+  resolveQueryToContextDependencyRefsDict(
+    context: TGenericParams['context'],
+  ): Promise<Dict<SyncableRef[]>>;
+
+  preloadQueryMetadata<
+    TViewQueryName extends keyof TGenericParams['context']['queryMetadataDict']
+  >(
+    group: string,
+    context: TGenericParams['context'],
+    viewQueryName: TViewQueryName,
+  ): Promise<TGenericParams['context']['queryMetadataDict'][TViewQueryName]>;
+
   loadSyncablesByQuery(
     group: string,
     context: TGenericParams['context'],