@cratis/arc 20.10.0 → 20.10.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cratis/arc",
-    "version": "20.10.0",
+    "version": "20.10.1",
     "description": "",
     "author": "Cratis",
     "license": "MIT",

package/queries/ObservableQueryFor.ts

@@ -103,11 +103,13 @@ export abstract class ObservableQueryFor<TDataType, TParameters = object> implem
             });
         }
 
-        // Build query arguments including unused args parameters, parameter descriptor values, and paging/sorting
+        // For multiplexed mode, include route arguments as plain arguments in the subscribe payload.
+        // In direct mode, route arguments are already part of the URL path and should not be duplicated.
         const parameterValues = ParametersHelper.collectParameterValues(this);
         const { unusedParameters } = UrlHelpers.replaceRouteParameters(this.route, args as object);
+        const routeAndQueryArguments = (args as object) || {};
         const connectionQueryArguments: any = {
-            ...unusedParameters,
+            ...(Globals.queryDirectMode ? unusedParameters : routeAndQueryArguments),
             ...parameterValues,
             ...this.buildQueryArguments()
         };

package/queries/ObservableQueryMultiplexer.ts

@@ -126,7 +126,8 @@ export class ObservableQueryMultiplexer {
 
         for (const [key, value] of Object.entries(a)) {
             if (pagingAndSortingKeys.has(key)) continue;
-            remaining[key] = value !== undefined && value !== null ? String(value) : null;
+            if (value === undefined || value === null) continue;
+            remaining[key] = String(value);
             hasRemaining = true;
         }
 

package/queries/for_ObservableQueryFor/when_subscribing/with_hub_mode_and_sse_transport_and_null_or_undefined_args.ts

@@ -0,0 +1,88 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { an_observable_query_for } from '../given/an_observable_query_for';
+import { given } from '../../../given';
+import { Globals } from '../../../Globals';
+import { QueryTransportMethod } from '../../QueryTransportMethod';
+import { ObservableQuerySubscription } from '../../ObservableQuerySubscription';
+import { HubMessageType } from '../../WebSocketHubConnection';
+import { resetSharedMultiplexer } from '../../ObservableQueryMultiplexer';
+
+import * as sinon from 'sinon';
+
+describe('when subscribing with hub mode and SSE transport and null or undefined args', given(an_observable_query_for, context => {
+    let callback: sinon.SinonStub;
+    let subscription: ObservableQuerySubscription<string>;
+    let fetchStub: sinon.SinonStub;
+    let originalQueryDirectMode: boolean;
+    let originalTransportMethod: QueryTransportMethod;
+    let eventSourceInstance: EventSource & {
+        onopen: (() => void) | null;
+        onmessage: ((event: { data: string }) => void) | null;
+    };
+
+    beforeEach(() => {
+        originalQueryDirectMode = Globals.queryDirectMode;
+        originalTransportMethod = Globals.queryTransportMethod;
+        resetSharedMultiplexer();
+
+        Globals.queryDirectMode = false;
+        Globals.queryTransportMethod = QueryTransportMethod.ServerSentEvents;
+
+        context.queryWithParameterDescriptorValues.setOrigin('https://example.com');
+        callback = sinon.stub();
+
+        const FakeEventSourceConstructor = function (this: EventSource, url: string) {
+            void url;
+            eventSourceInstance = this as EventSource & {
+                onopen: (() => void) | null;
+                onmessage: ((event: { data: string }) => void) | null;
+            };
+            Object.assign(this, {
+                onopen: null,
+                onerror: null,
+                onmessage: null,
+                close: sinon.stub(),
+                addEventListener: sinon.stub(),
+                removeEventListener: sinon.stub(),
+                readyState: 0,
+            });
+        };
+        (globalThis as Record<string, unknown>)['EventSource'] = FakeEventSourceConstructor;
+
+        fetchStub = sinon.stub().resolves({ ok: true } as Response);
+        (globalThis as Record<string, unknown>)['fetch'] = fetchStub;
+
+        subscription = context.queryWithParameterDescriptorValues.subscribe(callback, {
+            filter: undefined,
+            limit: null
+        });
+
+        eventSourceInstance.onopen?.();
+        eventSourceInstance.onmessage?.({
+            data: JSON.stringify({
+                type: HubMessageType.Connected,
+                payload: 'conn-1'
+            })
+        });
+    });
+
+    afterEach(() => {
+        Globals.queryDirectMode = originalQueryDirectMode;
+        Globals.queryTransportMethod = originalTransportMethod;
+        if (subscription) {
+            subscription.unsubscribe();
+        }
+        delete (globalThis as Record<string, unknown>)['EventSource'];
+        delete (globalThis as Record<string, unknown>)['fetch'];
+        resetSharedMultiplexer();
+        sinon.restore();
+    });
+
+    it('should not include null or undefined arguments in the subscribe request', () => {
+        fetchStub.called.should.be.true;
+        const subscribeBody = JSON.parse(fetchStub.firstCall.args[1].body as string);
+        (subscribeBody.request.arguments === undefined).should.be.true;
+    });
+}));

package/queries/for_ObservableQueryFor/when_subscribing/with_hub_mode_and_sse_transport_and_route_and_query_args.ts

@@ -0,0 +1,91 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { an_observable_query_for } from '../given/an_observable_query_for';
+import { given } from '../../../given';
+import { Globals } from '../../../Globals';
+import { QueryTransportMethod } from '../../QueryTransportMethod';
+import { ObservableQuerySubscription } from '../../ObservableQuerySubscription';
+import { HubMessageType } from '../../WebSocketHubConnection';
+import { resetSharedMultiplexer } from '../../ObservableQueryMultiplexer';
+
+import * as sinon from 'sinon';
+
+describe('when subscribing with hub mode and SSE transport and route and query args', given(an_observable_query_for, context => {
+    let callback: sinon.SinonStub;
+    let subscription: ObservableQuerySubscription<string>;
+    let fetchStub: sinon.SinonStub;
+    let originalQueryDirectMode: boolean;
+    let originalTransportMethod: QueryTransportMethod;
+    let eventSourceInstance: EventSource & {
+        onopen: (() => void) | null;
+        onmessage: ((event: { data: string }) => void) | null;
+    };
+
+    beforeEach(() => {
+        originalQueryDirectMode = Globals.queryDirectMode;
+        originalTransportMethod = Globals.queryTransportMethod;
+        resetSharedMultiplexer();
+
+        Globals.queryDirectMode = false;
+        Globals.queryTransportMethod = QueryTransportMethod.ServerSentEvents;
+
+        context.queryWithRouteAndQueryArgs.setOrigin('https://example.com');
+        callback = sinon.stub();
+
+        const FakeEventSourceConstructor = function (this: EventSource, url: string) {
+            void url;
+            eventSourceInstance = this as EventSource & {
+                onopen: (() => void) | null;
+                onmessage: ((event: { data: string }) => void) | null;
+            };
+            Object.assign(this, {
+                onopen: null,
+                onerror: null,
+                onmessage: null,
+                close: sinon.stub(),
+                addEventListener: sinon.stub(),
+                removeEventListener: sinon.stub(),
+                readyState: 0,
+            });
+        };
+        (globalThis as Record<string, unknown>)['EventSource'] = FakeEventSourceConstructor;
+
+        fetchStub = sinon.stub().resolves({ ok: true } as Response);
+        (globalThis as Record<string, unknown>)['fetch'] = fetchStub;
+
+        subscription = context.queryWithRouteAndQueryArgs.subscribe(callback, {
+            id: 'my-item-id',
+            filter: 'active',
+            limit: 50
+        });
+
+        eventSourceInstance.onopen?.();
+        eventSourceInstance.onmessage?.({
+            data: JSON.stringify({
+                type: HubMessageType.Connected,
+                payload: 'conn-1'
+            })
+        });
+    });
+
+    afterEach(() => {
+        Globals.queryDirectMode = originalQueryDirectMode;
+        Globals.queryTransportMethod = originalTransportMethod;
+        if (subscription) {
+            subscription.unsubscribe();
+        }
+        delete (globalThis as Record<string, unknown>)['EventSource'];
+        delete (globalThis as Record<string, unknown>)['fetch'];
+        resetSharedMultiplexer();
+        sinon.restore();
+    });
+
+    it('should include route and query arguments in the subscribe request', () => {
+        fetchStub.called.should.be.true;
+        const subscribeBody = JSON.parse(fetchStub.firstCall.args[1].body as string);
+        subscribeBody.request.arguments.id.should.equal('my-item-id');
+        subscribeBody.request.arguments.filter.should.equal('active');
+        subscribeBody.request.arguments.limit.should.equal('50');
+    });
+}));