@fintekkers/ledger-models 0.4.13 → 0.4.15

package/node/wrappers/services/apikey.credentials.test.js

@@ -0,0 +1,101 @@
+"use strict";
+/**
+ * Unit tests for Issue #114: each wrapper service hands the generated gRPC
+ * client the authenticated credentials when given an apiKey, and
+ * EnvConfig.apiCredentials otherwise.
+ *
+ * The generated *_grpc_pb clients are mocked, so no channel is opened.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+jest.mock('../../fintekkers/services/portfolio-service/portfolio_service_grpc_pb', () => ({
+    PortfolioClient: jest.fn(),
+}));
+jest.mock('../../fintekkers/services/position-service/position_service_grpc_pb', () => ({
+    PositionClient: jest.fn(),
+}));
+jest.mock('../../fintekkers/services/price-service/price_service_grpc_pb', () => ({
+    PriceClient: jest.fn(),
+}));
+jest.mock('../../fintekkers/services/security-service/security_service_grpc_pb', () => ({
+    SecurityClient: jest.fn(),
+}));
+jest.mock('../../fintekkers/services/transaction-service/transaction_service_grpc_pb', () => ({
+    TransactionClient: jest.fn(),
+}));
+const grpc = __importStar(require("@grpc/grpc-js"));
+const requestcontext_1 = __importDefault(require("../models/utils/requestcontext"));
+const portfolio_service_grpc_pb_1 = require("../../fintekkers/services/portfolio-service/portfolio_service_grpc_pb");
+const position_service_grpc_pb_1 = require("../../fintekkers/services/position-service/position_service_grpc_pb");
+const price_service_grpc_pb_1 = require("../../fintekkers/services/price-service/price_service_grpc_pb");
+const security_service_grpc_pb_1 = require("../../fintekkers/services/security-service/security_service_grpc_pb");
+const transaction_service_grpc_pb_1 = require("../../fintekkers/services/transaction-service/transaction_service_grpc_pb");
+const PortfolioService_1 = require("./portfolio-service/PortfolioService");
+const PositionService_1 = require("./position-service/PositionService");
+const PriceService_1 = require("./price-service/PriceService");
+const SecurityService_1 = require("./security-service/SecurityService");
+const TransactionService_1 = require("./transaction-service/TransactionService");
+const cases = [
+    ['PortfolioService', PortfolioService_1.PortfolioService, portfolio_service_grpc_pb_1.PortfolioClient],
+    ['PositionService', PositionService_1.PositionService, position_service_grpc_pb_1.PositionClient],
+    ['PriceService', PriceService_1.PriceService, price_service_grpc_pb_1.PriceClient],
+    ['SecurityService', SecurityService_1.SecurityService, security_service_grpc_pb_1.SecurityClient],
+    ['TransactionService', TransactionService_1.TransactionService, transaction_service_grpc_pb_1.TransactionClient],
+];
+beforeEach(() => {
+    jest.clearAllMocks();
+});
+afterEach(() => {
+    jest.restoreAllMocks();
+});
+describe.each(cases)('%s', (_name, Service, Client) => {
+    const ClientMock = Client;
+    test('with apiKey, client gets the authenticated credentials', () => {
+        const sentinel = {
+            credentials: grpc.credentials.createInsecure(),
+            interceptors: [],
+        };
+        const authSpy = jest
+            .spyOn(requestcontext_1.default, 'getAuthenticatedClientOptions')
+            .mockReturnValue(sentinel);
+        new Service('k');
+        expect(authSpy).toHaveBeenCalledWith('k');
+        expect(ClientMock).toHaveBeenCalledTimes(1);
+        expect(ClientMock).toHaveBeenCalledWith(requestcontext_1.default.apiURL, sentinel.credentials, { interceptors: sentinel.interceptors });
+    });
+    test('zero-arg constructor constructs with EnvConfig.apiCredentials', () => {
+        const plain = grpc.credentials.createInsecure();
+        jest.spyOn(requestcontext_1.default, 'apiCredentials', 'get').mockReturnValue(plain);
+        const authSpy = jest.spyOn(requestcontext_1.default, 'getAuthenticatedClientOptions');
+        expect(new Service()).toBeDefined();
+        expect(authSpy).not.toHaveBeenCalled();
+        expect(ClientMock).toHaveBeenCalledTimes(1);
+        expect(ClientMock).toHaveBeenCalledWith(requestcontext_1.default.apiURL, plain);
+    });
+});
+//# sourceMappingURL=apikey.credentials.test.js.map

package/node/wrappers/services/apikey.credentials.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apikey.credentials.test.js","sourceRoot":"","sources":["apikey.credentials.test.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,IAAI,CAAC,IAAI,CAAC,uEAAuE,EAAE,GAAG,EAAE,CAAC,CAAC;IACxF,eAAe,EAAE,IAAI,CAAC,EAAE,EAAE;CAC3B,CAAC,CAAC,CAAC;AACJ,IAAI,CAAC,IAAI,CAAC,qEAAqE,EAAE,GAAG,EAAE,CAAC,CAAC;IACtF,cAAc,EAAE,IAAI,CAAC,EAAE,EAAE;CAC1B,CAAC,CAAC,CAAC;AACJ,IAAI,CAAC,IAAI,CAAC,+DAA+D,EAAE,GAAG,EAAE,CAAC,CAAC;IAChF,WAAW,EAAE,IAAI,CAAC,EAAE,EAAE;CACvB,CAAC,CAAC,CAAC;AACJ,IAAI,CAAC,IAAI,CAAC,qEAAqE,EAAE,GAAG,EAAE,CAAC,CAAC;IACtF,cAAc,EAAE,IAAI,CAAC,EAAE,EAAE;CAC1B,CAAC,CAAC,CAAC;AACJ,IAAI,CAAC,IAAI,CAAC,2EAA2E,EAAE,GAAG,EAAE,CAAC,CAAC;IAC5F,iBAAiB,EAAE,IAAI,CAAC,EAAE,EAAE;CAC7B,CAAC,CAAC,CAAC;AAEJ,oDAAsC;AACtC,oFAAuD;AACvD,qHAAwG;AACxG,kHAAqG;AACrG,yGAA4F;AAC5F,kHAAqG;AACrG,2HAA8G;AAC9G,2EAAwE;AACxE,wEAAqE;AACrE,+DAA4D;AAC5D,wEAAqE;AACrE,iFAA8E;AAE9E,MAAM,KAAK,GAA+D;IACxE,CAAC,kBAAkB,EAAE,mCAAgB,EAAE,2CAAe,CAAC;IACvD,CAAC,iBAAiB,EAAE,iCAAe,EAAE,yCAAc,CAAC;IACpD,CAAC,cAAc,EAAE,2BAAY,EAAE,mCAAW,CAAC;IAC3C,CAAC,iBAAiB,EAAE,iCAAe,EAAE,yCAAc,CAAC;IACpD,CAAC,oBAAoB,EAAE,uCAAkB,EAAE,+CAAiB,CAAC;CAC9D,CAAC;AAEF,UAAU,CAAC,GAAG,EAAE;IACd,IAAI,CAAC,aAAa,EAAE,CAAC;AACvB,CAAC,CAAC,CAAC;AAEH,SAAS,CAAC,GAAG,EAAE;IACb,IAAI,CAAC,eAAe,EAAE,CAAC;AACzB,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;IACpD,MAAM,UAAU,GAAG,MAAmB,CAAC;IAEvC,IAAI,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAClE,MAAM,QAAQ,GAAG;YACf,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE;YAC9C,YAAY,EAAE,EAAwB;SACvC,CAAC;QACF,MAAM,OAAO,GAAG,IAAI;aACjB,KAAK,CAAC,wBAAS,EAAE,+BAA+B,CAAC;aACjD,eAAe,CAAC,QAAQ,CAAC,CAAC;QAE7B,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;QAEjB,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC1C,MAAM,CAAC,UAAU,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC5C,MAAM,CAAC,UAAU,CAAC,CAAC,oBAAoB,CACrC,wBAAS,CAAC,MAAM,EAChB,QAAQ,CAAC,WAAW,EACpB,EAAE,YAAY,EAAE,QAAQ,CAAC,YAAY,EAAE,CACxC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACzE,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,CAAC;QAChD,IAAI,CAAC,KAAK,CAAC,wBAAS,EAAE,gBAAgB,EAAE,KAAK,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACtE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,wBAAS,EAAE,+BAA+B,CAAC,CAAC;QAEvE,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAEpC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACvC,MAAM,CAAC,UAAU,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC5C,MAAM,CAAC,UAAU,CAAC,CAAC,oBAAoB,CAAC,wBAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/node/wrappers/services/apikey.credentials.test.ts

@@ -0,0 +1,88 @@
+/**
+ * Unit tests for Issue #114: each wrapper service hands the generated gRPC
+ * client the authenticated credentials when given an apiKey, and
+ * EnvConfig.apiCredentials otherwise.
+ *
+ * The generated *_grpc_pb clients are mocked, so no channel is opened.
+ */
+
+jest.mock('../../fintekkers/services/portfolio-service/portfolio_service_grpc_pb', () => ({
+  PortfolioClient: jest.fn(),
+}));
+jest.mock('../../fintekkers/services/position-service/position_service_grpc_pb', () => ({
+  PositionClient: jest.fn(),
+}));
+jest.mock('../../fintekkers/services/price-service/price_service_grpc_pb', () => ({
+  PriceClient: jest.fn(),
+}));
+jest.mock('../../fintekkers/services/security-service/security_service_grpc_pb', () => ({
+  SecurityClient: jest.fn(),
+}));
+jest.mock('../../fintekkers/services/transaction-service/transaction_service_grpc_pb', () => ({
+  TransactionClient: jest.fn(),
+}));
+
+import * as grpc from '@grpc/grpc-js';
+import EnvConfig from '../models/utils/requestcontext';
+import { PortfolioClient } from '../../fintekkers/services/portfolio-service/portfolio_service_grpc_pb';
+import { PositionClient } from '../../fintekkers/services/position-service/position_service_grpc_pb';
+import { PriceClient } from '../../fintekkers/services/price-service/price_service_grpc_pb';
+import { SecurityClient } from '../../fintekkers/services/security-service/security_service_grpc_pb';
+import { TransactionClient } from '../../fintekkers/services/transaction-service/transaction_service_grpc_pb';
+import { PortfolioService } from './portfolio-service/PortfolioService';
+import { PositionService } from './position-service/PositionService';
+import { PriceService } from './price-service/PriceService';
+import { SecurityService } from './security-service/SecurityService';
+import { TransactionService } from './transaction-service/TransactionService';
+
+const cases: Array<[string, new (apiKey?: string) => unknown, unknown]> = [
+  ['PortfolioService', PortfolioService, PortfolioClient],
+  ['PositionService', PositionService, PositionClient],
+  ['PriceService', PriceService, PriceClient],
+  ['SecurityService', SecurityService, SecurityClient],
+  ['TransactionService', TransactionService, TransactionClient],
+];
+
+beforeEach(() => {
+  jest.clearAllMocks();
+});
+
+afterEach(() => {
+  jest.restoreAllMocks();
+});
+
+describe.each(cases)('%s', (_name, Service, Client) => {
+  const ClientMock = Client as jest.Mock;
+
+  test('with apiKey, client gets the authenticated credentials', () => {
+    const sentinel = {
+      credentials: grpc.credentials.createInsecure(),
+      interceptors: [] as grpc.Interceptor[],
+    };
+    const authSpy = jest
+      .spyOn(EnvConfig, 'getAuthenticatedClientOptions')
+      .mockReturnValue(sentinel);
+
+    new Service('k');
+
+    expect(authSpy).toHaveBeenCalledWith('k');
+    expect(ClientMock).toHaveBeenCalledTimes(1);
+    expect(ClientMock).toHaveBeenCalledWith(
+      EnvConfig.apiURL,
+      sentinel.credentials,
+      { interceptors: sentinel.interceptors }
+    );
+  });
+
+  test('zero-arg constructor constructs with EnvConfig.apiCredentials', () => {
+    const plain = grpc.credentials.createInsecure();
+    jest.spyOn(EnvConfig, 'apiCredentials', 'get').mockReturnValue(plain);
+    const authSpy = jest.spyOn(EnvConfig, 'getAuthenticatedClientOptions');
+
+    expect(new Service()).toBeDefined();
+
+    expect(authSpy).not.toHaveBeenCalled();
+    expect(ClientMock).toHaveBeenCalledTimes(1);
+    expect(ClientMock).toHaveBeenCalledWith(EnvConfig.apiURL, plain);
+  });
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fintekkers/ledger-models",
   "todo": "Replace the version with build script version number",
-  "version": "0.4.13",
+  "version": "0.4.15",
   "description": "ledger model protos ",
   "authors": [
     "David Doherty",