@cratis/arc 18.4.3 → 18.5.0

package/queries/for_QueryFor/when_performing/with_fetch_error.ts

@@ -5,15 +5,18 @@ import { a_query_for } from '../given/a_query_for';
 import { given } from '../../../given';
 
 import * as sinon from 'sinon';
+import { createFetchHelper } from '../../../helpers/fetchHelper';
 import { QueryResult } from '../../QueryResult';
 
 describe('with fetch error', given(a_query_for, context => {
     let result: QueryResult<string>;
     let fetchStub: sinon.SinonStub;
+    let fetchHelper: { stubFetch: () => sinon.SinonStub; restore: () => void };
 
     beforeEach(async () => {
         // Setup fetch mock to reject
-        fetchStub = sinon.stub(global, 'fetch');
+        fetchHelper = createFetchHelper();
+        fetchStub = fetchHelper.stubFetch();
         fetchStub.rejects(new Error('Network error'));
 
         context.query.setOrigin('https://api.example.com');
@@ -29,7 +32,7 @@ describe('with fetch error', given(a_query_for, context => {
     });
 
     afterEach(() => {
-        fetchStub.restore();
+        fetchHelper.restore();
     });
 
     it('should return no success result', () => {

package/queries/for_QueryFor/when_performing/with_json_parse_error.ts

@@ -5,15 +5,18 @@ import { a_query_for } from '../given/a_query_for';
 import { given } from '../../../given';
 
 import * as sinon from 'sinon';
+import { createFetchHelper } from '../../../helpers/fetchHelper';
 import { QueryResult } from '../../QueryResult';
 
 describe('with json parse error', given(a_query_for, context => {
     let result: QueryResult<string>;
     let fetchStub: sinon.SinonStub;
+    let fetchHelper: { stubFetch: () => sinon.SinonStub; restore: () => void };
 
     beforeEach(async () => {
-        // Setup fetch mock with json parse error
-        fetchStub = sinon.stub(global, 'fetch');
+        // Setup fetch mock with json parse error using helper
+        fetchHelper = createFetchHelper();
+        fetchStub = fetchHelper.stubFetch();
         fetchStub.resolves({
             json: sinon.stub().rejects(new Error('Invalid JSON')),
             ok: true,
@@ -27,7 +30,7 @@ describe('with json parse error', given(a_query_for, context => {
     });
 
     afterEach(() => {
-        fetchStub.restore();
+        fetchHelper.restore();
     });
 
     it('should return no success result', () => {

package/queries/for_QueryFor/when_performing/with_paging.ts

@@ -5,12 +5,14 @@ import { a_query_for } from '../given/a_query_for';
 import { given } from '../../../given';
 
 import * as sinon from 'sinon';
+import { createFetchHelper } from '../../../helpers/fetchHelper';
 import { QueryResult } from '../../QueryResult';
 import { Paging } from '../../Paging';
 
 describe('with paging', given(a_query_for, context => {
     let result: QueryResult<string>;
     let fetchStub: sinon.SinonStub;
+    let fetchHelper: { stubFetch: () => sinon.SinonStub; restore: () => void };
     const mockResponse = {
         data: 'test-result',
         isSuccess: true,
@@ -30,7 +32,8 @@ describe('with paging', given(a_query_for, context => {
 
     beforeEach(async () => {
         // Setup fetch mock
-        fetchStub = sinon.stub(global, 'fetch');
+        fetchHelper = createFetchHelper();
+        fetchStub = fetchHelper.stubFetch();
         fetchStub.resolves({
             json: sinon.stub().resolves(mockResponse),
             ok: true,
@@ -45,7 +48,7 @@ describe('with paging', given(a_query_for, context => {
     });
 
     afterEach(() => {
-        fetchStub.restore();
+        fetchHelper.restore();
     });
 
     it('should call fetch with URL including paging parameters', () => {

package/queries/for_QueryFor/when_performing/with_parameter_descriptor_values.ts

@@ -4,11 +4,13 @@
 import { a_query_for } from '../given/a_query_for';
 import { given } from '../../../given';
 import * as sinon from 'sinon';
+import { createFetchHelper } from '../../../helpers/fetchHelper';
 import { QueryResult } from '../../QueryResult';
 
 describe('with parameter descriptor values', given(a_query_for, context => {
     let result: QueryResult<string>;
     let fetchStub: sinon.SinonStub;
+    let fetchHelper: { stubFetch: () => sinon.SinonStub; restore: () => void };
     const mockResponse = {
         data: 'test-result',
         isSuccess: true,
@@ -27,7 +29,8 @@ describe('with parameter descriptor values', given(a_query_for, context => {
     };
 
     beforeEach(async () => {
-        fetchStub = sinon.stub(global, 'fetch');
+        fetchHelper = createFetchHelper();
+        fetchStub = fetchHelper.stubFetch();
         fetchStub.resolves({
             json: sinon.stub().resolves(mockResponse),
             ok: true,
@@ -45,7 +48,7 @@ describe('with parameter descriptor values', given(a_query_for, context => {
     });
 
     afterEach(() => {
-        fetchStub.restore();
+        fetchHelper.restore();
     });
 
     it('should return successful result', () => {

package/queries/for_QueryFor/when_performing/with_partial_parameter_descriptor_values.ts

@@ -4,11 +4,13 @@
 import { a_query_for } from '../given/a_query_for';
 import { given } from '../../../given';
 import * as sinon from 'sinon';
+import { createFetchHelper } from '../../../helpers/fetchHelper';
 import { QueryResult } from '../../QueryResult';
 
 describe('with partial parameter descriptor values', given(a_query_for, context => {
     let result: QueryResult<string>;
     let fetchStub: sinon.SinonStub;
+    let fetchHelper: { stubFetch: () => sinon.SinonStub; restore: () => void };
     const mockResponse = {
         data: 'test-result',
         isSuccess: true,
@@ -27,7 +29,8 @@ describe('with partial parameter descriptor values', given(a_query_for, context
     };
 
     beforeEach(async () => {
-        fetchStub = sinon.stub(global, 'fetch');
+        fetchHelper = createFetchHelper();
+        fetchStub = fetchHelper.stubFetch();
         fetchStub.resolves({
             json: sinon.stub().resolves(mockResponse),
             ok: true,
@@ -45,7 +48,7 @@ describe('with partial parameter descriptor values', given(a_query_for, context
     });
 
     afterEach(() => {
-        fetchStub.restore();
+        fetchHelper.restore();
     });
 
     it('should return successful result', () => {

package/queries/for_QueryFor/when_performing/with_query_without_required_parameters.ts

@@ -5,11 +5,13 @@ import { a_query_for } from '../given/a_query_for';
 import { given } from '../../../given';
 
 import * as sinon from 'sinon';
+import { createFetchHelper } from '../../../helpers/fetchHelper';
 import { QueryResult } from '../../QueryResult';
 
 describe('with query without required parameters', given(a_query_for, context => {
     let result: QueryResult<string>;
     let fetchStub: sinon.SinonStub;
+    let fetchHelper: { stubFetch: () => sinon.SinonStub; restore: () => void };
     const mockResponse = {
         data: 'test-result',
         isSuccess: true,
@@ -32,7 +34,8 @@ describe('with query without required parameters', given(a_query_for, context =>
         if ((global.fetch as sinon.SinonStub)?.restore) {
             (global.fetch as sinon.SinonStub).restore();
         }
-        fetchStub = sinon.stub(global, 'fetch');
+        fetchHelper = createFetchHelper();
+        fetchStub = fetchHelper.stubFetch();
         fetchStub.resolves({
             json: sinon.stub().resolves(mockResponse),
             ok: true,
@@ -46,7 +49,7 @@ describe('with query without required parameters', given(a_query_for, context =>
     });
 
     afterEach(() => {
-        fetchStub?.restore();
+        fetchHelper.restore();
     });
 
     it('should return successful result', () => {

package/queries/for_QueryFor/when_performing/with_route_parameters_and_unused_parameters.ts

@@ -4,12 +4,14 @@
 import { a_query_for } from '../given/a_query_for';
 import { given } from '../../../given';
 import * as sinon from 'sinon';
+import { createFetchHelper } from '../../../helpers/fetchHelper';
 import { QueryResult } from '../../QueryResult';
 import { expect } from 'chai';
 
 describe('with route parameters and unused parameters', given(a_query_for, context => {
     let result: QueryResult<string>;
     let fetchStub: sinon.SinonStub;
+    let fetchHelper: { stubFetch: () => sinon.SinonStub; restore: () => void };
     const mockResponse = {
         data: 'test-result',
         isSuccess: true,
@@ -28,7 +30,8 @@ describe('with route parameters and unused parameters', given(a_query_for, conte
     };
 
     beforeEach(async () => {
-        fetchStub = sinon.stub(global, 'fetch');
+        fetchHelper = createFetchHelper();
+        fetchStub = fetchHelper.stubFetch();
         fetchStub.resolves({
             json: sinon.stub().resolves(mockResponse),
             ok: true,
@@ -43,7 +46,7 @@ describe('with route parameters and unused parameters', given(a_query_for, conte
     });
 
     afterEach(() => {
-        fetchStub.restore();
+        fetchHelper.restore();
     });
 
     it('should return successful result', () => {

package/queries/for_QueryFor/when_performing/with_sorting.ts

@@ -5,6 +5,7 @@ import { a_query_for } from '../given/a_query_for';
 import { given } from '../../../given';
 
 import * as sinon from 'sinon';
+import { createFetchHelper } from '../../../helpers/fetchHelper';
 import { QueryResult } from '../../QueryResult';
 import { Sorting } from '../../Sorting';
 import { SortDirection } from '../../SortDirection';
@@ -12,6 +13,7 @@ import { SortDirection } from '../../SortDirection';
 describe('with sorting', given(a_query_for, context => {
     let result: QueryResult<string>;
     let fetchStub: sinon.SinonStub;
+    let fetchHelper: { stubFetch: () => sinon.SinonStub; restore: () => void };
                 const mockResponse = {
                 data: 'test-result',
                 isSuccess: true,
@@ -32,7 +34,8 @@ describe('with sorting', given(a_query_for, context => {
     describe('and ascending direction', () => {
         beforeEach(async () => {
             // Setup fetch mock
-            fetchStub = sinon.stub(global, 'fetch');
+            fetchHelper = createFetchHelper();
+            fetchStub = fetchHelper.stubFetch();
             fetchStub.resolves({
                 json: sinon.stub().resolves(mockResponse),
                 ok: true,
@@ -66,7 +69,8 @@ describe('with sorting', given(a_query_for, context => {
     describe('and descending direction', () => {
         beforeEach(async () => {
             // Setup fetch mock
-            fetchStub = sinon.stub(global, 'fetch');
+            fetchHelper = createFetchHelper();
+            fetchStub = fetchHelper.stubFetch();
             fetchStub.resolves({
                 json: sinon.stub().resolves(mockResponse),
                 ok: true,
@@ -81,7 +85,7 @@ describe('with sorting', given(a_query_for, context => {
         });
 
         afterEach(() => {
-            fetchStub.restore();
+            fetchHelper.restore();
         });
 
         it('should call fetch with URL including sorting parameters', () => {

package/queries/for_QueryFor/when_performing/with_valid_arguments.ts

@@ -4,11 +4,13 @@
 import { a_query_for } from '../given/a_query_for';
 import { given } from '../../../given';
 import * as sinon from 'sinon';
+import { createFetchHelper } from '../../../helpers/fetchHelper';
 import { QueryResult } from '../../QueryResult';
 
 describe('with valid arguments', given(a_query_for, context => {
     let result: QueryResult<string>;
     let fetchStub: sinon.SinonStub;
+    let fetchHelper: { stubFetch: () => sinon.SinonStub; restore: () => void };
     const mockResponse = {
         data: 'test-result',
         isSuccess: true,
@@ -27,8 +29,9 @@ describe('with valid arguments', given(a_query_for, context => {
     };
 
     beforeEach(async () => {
-        // Setup fetch mock
-        fetchStub = sinon.stub(global, 'fetch');
+        // Setup fetch mock using helper
+        fetchHelper = createFetchHelper();
+        fetchStub = fetchHelper.stubFetch();
         fetchStub.resolves({
             json: sinon.stub().resolves(mockResponse),
             ok: true,
@@ -44,7 +47,7 @@ describe('with valid arguments', given(a_query_for, context => {
     });
 
     afterEach(() => {
-        fetchStub.restore();
+        fetchHelper.restore();
     });
 
     it('should return successful result', () => {

package/queries/for_WebSocketMessage/when_creating_messages.ts

@@ -0,0 +1,67 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { WebSocketMessage, WebSocketMessageType } from '../WebSocketMessage';
+
+describe('when creating a ping message', () => {
+    let timestamp: number;
+    let message: WebSocketMessage;
+
+    beforeEach(() => {
+        timestamp = Date.now();
+        message = {
+            type: WebSocketMessageType.Ping,
+            timestamp: timestamp
+        };
+    });
+
+    it('should have ping type', () => {
+        message.type.should.equal(WebSocketMessageType.Ping);
+    });
+
+    it('should have timestamp', () => {
+        message.timestamp!.should.equal(timestamp);
+    });
+});
+
+describe('when creating a pong message', () => {
+    let timestamp: number;
+    let message: WebSocketMessage;
+
+    beforeEach(() => {
+        timestamp = Date.now();
+        message = {
+            type: WebSocketMessageType.Pong,
+            timestamp: timestamp
+        };
+    });
+
+    it('should have pong type', () => {
+        message.type.should.equal(WebSocketMessageType.Pong);
+    });
+
+    it('should have timestamp', () => {
+        message.timestamp!.should.equal(timestamp);
+    });
+});
+
+describe('when creating a data message', () => {
+    let data: object;
+    let message: WebSocketMessage;
+
+    beforeEach(() => {
+        data = { test: 'value' };
+        message = {
+            type: WebSocketMessageType.Data,
+            data: data
+        };
+    });
+
+    it('should have data type', () => {
+        message.type.should.equal(WebSocketMessageType.Data);
+    });
+
+    it('should have data', () => {
+        message.data.should.equal(data);
+    });
+});

package/queries/index.ts

@@ -17,5 +17,6 @@ export * from './ObservableQueryFor';
 export * from './IObservableQueryConnection';
 export * from './ObservableQueryConnection';
 export * from './ObservableQuerySubscription';
+export * from './WebSocketMessage';
 export * from './IQueryProvider';
-export * from './QueryProvider';
+export * from './QueryProvider';