Merge pull request #284 from Jujulego/fix/qref-reads-undefined-if-que…

…ry-fails

Fix QRef reads undefined if query fails

packages/aegis/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jujulego/aegis",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.3",
   "license": "MIT",
   "author": "Julien Capellari <julien.capellari@google.com>",
   "repository": {
@@ -33,7 +33,7 @@
     "publish": "yarn npm publish --access public --tolerate-republish"
   },
   "dependencies": {
-    "@jujulego/event-tree": "^2.6.1",
+    "@jujulego/event-tree": "^2.6.2",
     "@jujulego/utils": "^1.3.2"
   },
   "devDependencies": {

packages/aegis/src/query/q-ref.ts

@@ -11,6 +11,13 @@ export type QRefEventMap<D> = {
   failed: QueryStateFailed;
 };
 
+export interface QRefReadOpts {
+  /**
+   * Should throw if current query fails ?
+   */
+  throws?: boolean;
+}
+
 // Class
 export class QRef<D> implements IObservable<QueryState<D>>, IListenable<QRefEventMap<D>> {
   // Attributes
@@ -82,11 +89,19 @@ export class QRef<D> implements IObservable<QueryState<D>>, IListenable<QRefEven
   /**
    * Resolves to loaded data. Will return immediately if the current Query is done.
    */
-  async read(): Promise<D> {
+  async read(opts: QRefReadOpts = {}): Promise<D> {
     let state = this._query?.state;
 
     if (state?.status !== 'done') {
-      state = await waitFor(this._events, 'done');
+      state = await new Promise<QueryStateDone<D>>((resolve, reject) => {
+        const off = offGroup();
+
+        once(this._events, 'done', resolve, { off });
+
+        if (opts.throws) {
+          once(this._events, 'failed', ({ error }) => reject(error), { off });
+        }
+      });
     }
 
     return state.data;

packages/aegis/tests/queries/q-ref.test.ts

@@ -164,4 +164,13 @@ describe('QRef.read', () => {
 
     await expect(qref.read()).resolves.toBe(42);
   });
-});
+
+  it('should reject when current query fails', async () => {
+    const query = new Query<number>();
+    qref.refresh(() => query, 'keep');
+
+    setTimeout(() => query.fail(new Error('Failed !')), 0);
+
+    await expect(qref.read({ throws: true })).rejects.toEqual(new Error('Failed !'));
+  });
+});

yarn.lock

@@ -1316,7 +1316,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@jujulego/aegis@workspace:packages/aegis"
   dependencies:
-    "@jujulego/event-tree": ^2.6.1
+    "@jujulego/event-tree": ^2.6.2
     "@jujulego/flow": 1.1.0
     "@jujulego/utils": ^1.3.2
     "@swc/cli": 0.1.62
@@ -1363,10 +1363,10 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@jujulego/event-tree@npm:^2.6.1":
-  version: 2.6.1
-  resolution: "@jujulego/event-tree@npm:2.6.1"
-  checksum: 04a59f0ad2c7402e98a110918a0ebd00ea13c1a330ea4f0c7a811635dc7631d5ad1c9b76003263984f986555fd9124b48f8a1584e8b88acc0a601d21fc3409d5
+"@jujulego/event-tree@npm:^2.6.2":
+  version: 2.6.2
+  resolution: "@jujulego/event-tree@npm:2.6.2"
+  checksum: 71ff291a6d5580f649fe37136fbb409322705734f7df0b37265a78c14f52de50d910727aae530ae93cef9cf9a5e99f4b607c8a0fd85dcc41321876f8f8610a86
   languageName: node
   linkType: hard