@fintekkers/ledger-models 0.4.43 → 0.4.45

package/node/wrappers/util/object-type-coverage.test.js

@@ -0,0 +1,159 @@
+"use strict";
+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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Every message with object_type has an own-type stamp (LM-320). Walks the
+// descriptor set for messages whose field 1 is
+// fintekkers.models.util.ObjectTypeProto, and fails when `stampOwn` has no
+// entry for one. Stamps each and checks its own type and version (0, 0, 1).
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const descriptor_pb_1 = require("google-protobuf/google/protobuf/descriptor_pb");
+const object_type_pb_1 = require("../../fintekkers/models/util/object_type_pb");
+const uuid_pb_1 = require("../../fintekkers/models/util/uuid_pb");
+const objectTypes = __importStar(require("./object-types"));
+// The descriptor set compile.sh writes for every language.
+const DESCRIPTOR_SET = path.resolve(__dirname, '../../../../ledger-models-rust/ledger_models_file_descriptor_set_v_todo.bin');
+const GENERATED = path.resolve(__dirname, '../..');
+const OBJECT_TYPE_ENUM = '.fintekkers.models.util.ObjectTypeProto';
+// The 13 types LM-320 names: every *ResponseProto and the index-composition
+// requests and responses.
+const NAMED = [
+    'fintekkers.requests.price.CreatePriceResponseProto',
+    'fintekkers.requests.price.QueryPriceResponseProto',
+    'fintekkers.requests.security.CreateSecurityResponseProto',
+    'fintekkers.requests.security.QuerySecurityResponseProto',
+    'fintekkers.requests.portfolio.CreatePortfolioResponseProto',
+    'fintekkers.requests.portfolio.QueryPortfolioResponseProto',
+    'fintekkers.requests.transaction.CreateTransactionResponseProto',
+    'fintekkers.requests.transaction.QueryTransactionResponseProto',
+    'fintekkers.requests.position.QueryPositionResponseProto',
+    'fintekkers.requests.index_composition.CreateIndexCompositionRequestProto',
+    'fintekkers.requests.index_composition.CreateIndexCompositionResponseProto',
+    'fintekkers.requests.index_composition.GetIndexCompositionRequestProto',
+    'fintekkers.requests.index_composition.GetIndexCompositionResponseProto',
+];
+/** Full name -> generated class of every message whose field 1 is ObjectTypeProto. */
+function walk() {
+    if (!fs.existsSync(DESCRIPTOR_SET))
+        throw new Error(`descriptor set not found at ${DESCRIPTOR_SET}`);
+    const found = new Map();
+    const set = descriptor_pb_1.FileDescriptorSet.deserializeBinary(new Uint8Array(fs.readFileSync(DESCRIPTOR_SET)));
+    const isTyped = (message) => message.getFieldList().some((f) => f.getNumber() === 1 && f.getTypeName() === OBJECT_TYPE_ENUM);
+    for (const file of set.getFileList()) {
+        const fileName = file.getName();
+        // Loaded only for a typed message: google/protobuf/* has no module here.
+        const generated = () => require(path.join(GENERATED, fileName.replace(/\.proto$/, '_pb')));
+        const visit = (fullName, scope, message) => {
+            const messageClass = () => scope()[message.getName()];
+            if (isTyped(message)) {
+                if (typeof messageClass() !== 'function')
+                    throw new Error(`${fullName}: no generated class in ${fileName}`);
+                found.set(fullName, messageClass());
+            }
+            for (const nested of message.getNestedTypeList()) {
+                visit(`${fullName}.${nested.getName()}`, messageClass, nested);
+            }
+        };
+        for (const message of file.getMessageTypeList()) {
+            visit(`${file.getPackage()}.${message.getName()}`, generated, message);
+        }
+    }
+    return found;
+}
+const WALKED = walk();
+/** The walked names that `lookup` has no own type for. */
+function missingTypes(walked, lookup) {
+    return Array.from(walked).filter((name) => lookup(name) === undefined);
+}
+function lookup(fullName) {
+    const messageClass = WALKED.get(fullName);
+    return objectTypes.ownType(new messageClass());
+}
+/** The value the naming rule gives: message name without Proto, in SCREAMING_SNAKE, prefixed OBJECT_TYPE_. */
+function expectedType(fullName) {
+    const name = fullName.split('.').pop().replace(/Proto$/, '');
+    const enumName = 'OBJECT_TYPE_' + name.replace(/([a-z])([A-Z])/g, '$1_$2').toUpperCase();
+    const value = object_type_pb_1.ObjectTypeProto[enumName];
+    if (value === undefined)
+        throw new Error(`${fullName}: no ${enumName} in ObjectTypeProto`);
+    return value;
+}
+test('the walk finds every typed message, including the named ones', () => {
+    expect(WALKED.size).toBeGreaterThanOrEqual(49);
+    for (const name of NAMED)
+        expect(WALKED.has(name)).toBe(true);
+});
+test('every typed message has an own type', () => {
+    expect(missingTypes(WALKED.keys(), lookup)).toEqual([]);
+});
+test('a missing entry is reported', () => {
+    const dropped = 'fintekkers.requests.price.QueryPriceResponseProto';
+    const without = (name) => (name === dropped ? undefined : lookup(name));
+    expect(missingTypes(WALKED.keys(), without)).toEqual([dropped]);
+});
+test.each(Array.from(WALKED.keys()).sort())('stamping %s sets its own type and version', (fullName) => {
+    const messageClass = WALKED.get(fullName);
+    const stamped = objectTypes.stampOwn(new messageClass());
+    const expected = expectedType(fullName);
+    expect(objectTypes.readType(stamped)).toBe(expected);
+    expect(objectTypes.readVersion(stamped)).toEqual([0, 0, 1]);
+    // The name table agrees with the class table.
+    expect(objectTypes.OWN_TYPE_NAMES.get(fullName)).toBe(expected);
+});
+test('own types are distinct and known', () => {
+    const types = Array.from(WALKED.keys()).map(lookup);
+    expect(types).not.toContain(object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_UNKNOWN);
+    expect(new Set(types).size).toBe(types.length);
+});
+test('the LM-318 entries keep their values', () => {
+    const lm318 = [
+        ['fintekkers.models.portfolio.PortfolioProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_PORTFOLIO],
+        ['fintekkers.models.position.PositionProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_POSITION],
+        ['fintekkers.models.position.PositionFilterProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_POSITION_FILTER],
+        ['fintekkers.models.price.PriceProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_PRICE],
+        ['fintekkers.models.security.IdentifierProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_IDENTIFIER],
+        ['fintekkers.models.security.SecurityProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_SECURITY],
+        ['fintekkers.models.security.TenorProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_TENOR],
+        ['fintekkers.models.strategy.StrategyProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_STRATEGY],
+        ['fintekkers.models.strategy.StrategyAllocationProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_STRATEGY_ALLOCATION],
+        ['fintekkers.models.transaction.TransactionProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_TRANSACTION],
+        ['fintekkers.requests.portfolio.CreatePortfolioRequestProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_CREATE_PORTFOLIO_REQUEST],
+        ['fintekkers.requests.portfolio.QueryPortfolioRequestProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_QUERY_PORTFOLIO_REQUEST],
+        ['fintekkers.requests.price.CreatePriceRequestProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_CREATE_PRICE_REQUEST],
+        ['fintekkers.requests.price.QueryPriceRequestProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_QUERY_PRICE_REQUEST],
+        ['fintekkers.requests.security.CreateSecurityRequestProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_CREATE_SECURITY_REQUEST],
+        ['fintekkers.requests.security.QuerySecurityRequestProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_QUERY_SECURITY_REQUEST],
+        ['fintekkers.requests.transaction.CreateTransactionRequestProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_CREATE_TRANSACTION_REQUEST],
+        ['fintekkers.requests.transaction.QueryTransactionRequestProto', object_type_pb_1.ObjectTypeProto.OBJECT_TYPE_QUERY_TRANSACTION_REQUEST],
+    ];
+    for (const [name, objectType] of lm318)
+        expect([name, lookup(name)]).toEqual([name, objectType]);
+});
+test('stampOwn on a message without object_type throws', () => {
+    expect(objectTypes.ownType(new uuid_pb_1.UUIDProto())).toBeUndefined();
+    expect(objectTypes.ownType({})).toBeUndefined();
+    expect(() => objectTypes.stampOwn(new uuid_pb_1.UUIDProto())).toThrow('this message type has no own ObjectTypeProto');
+});
+//# sourceMappingURL=object-type-coverage.test.js.map

package/node/wrappers/util/object-type-coverage.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-type-coverage.test.js","sourceRoot":"","sources":["object-type-coverage.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2EAA2E;AAC3E,+CAA+C;AAC/C,2EAA2E;AAC3E,4EAA4E;AAC5E,uCAAyB;AACzB,2CAA6B;AAC7B,iFAAmG;AAEnG,gFAA8E;AAC9E,kEAAiE;AAEjE,4DAA8C;AAG9C,2DAA2D;AAC3D,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,6EAA6E,CAAC,CAAC;AAC9H,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;AAEnD,MAAM,gBAAgB,GAAG,yCAAyC,CAAC;AAEnE,4EAA4E;AAC5E,0BAA0B;AAC1B,MAAM,KAAK,GAAG;IACZ,oDAAoD;IACpD,mDAAmD;IACnD,0DAA0D;IAC1D,yDAAyD;IACzD,4DAA4D;IAC5D,2DAA2D;IAC3D,gEAAgE;IAChE,+DAA+D;IAC/D,yDAAyD;IACzD,0EAA0E;IAC1E,2EAA2E;IAC3E,uEAAuE;IACvE,wEAAwE;CACzE,CAAC;AAIF,sFAAsF;AACtF,SAAS,IAAI;IACX,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,cAAc,EAAE,CAAC,CAAC;IACrG,MAAM,KAAK,GAAG,IAAI,GAAG,EAAwB,CAAC;IAC9C,MAAM,GAAG,GAAG,iCAAiB,CAAC,iBAAiB,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IACjG,MAAM,OAAO,GAAG,CAAC,OAAwB,EAAE,EAAE,CAC3C,OAAO,CAAC,YAAY,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,KAAK,gBAAgB,CAAC,CAAC;IAClG,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,WAAW,EAAE,EAAE;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,EAAY,CAAC;QAC1C,yEAAyE;QACzE,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QAC3F,MAAM,KAAK,GAAG,CAAC,QAAgB,EAAE,KAAoC,EAAE,OAAwB,EAAE,EAAE;YACjG,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,OAAO,EAAY,CAA2C,CAAC;YAC1G,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;gBACpB,IAAI,OAAO,YAAY,EAAE,KAAK,UAAU;oBAAE,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,2BAA2B,QAAQ,EAAE,CAAC,CAAC;gBAC5G,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC;aACrC;YACD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,iBAAiB,EAAE,EAAE;gBAChD,KAAK,CAAC,GAAG,QAAQ,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;aAChE;QACH,CAAC,CAAC;QACF,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,kBAAkB,EAAE,EAAE;YAC/C,KAAK,CAAC,GAAG,IAAI,CAAC,UAAU,EAAE,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;SACxE;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC;AAEtB,0DAA0D;AAC1D,SAAS,YAAY,CAAC,MAAwB,EAAE,MAAyD;IACvG,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC;AACzE,CAAC;AAED,SAAS,MAAM,CAAC,QAAgB;IAC9B,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAiB,CAAC;IAC1D,OAAO,WAAW,CAAC,OAAO,CAAC,IAAI,YAAY,EAAE,CAAC,CAAC;AACjD,CAAC;AAED,8GAA8G;AAC9G,SAAS,YAAY,CAAC,QAAgB;IACpC,MAAM,IAAI,GAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAa,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACzE,MAAM,QAAQ,GAAG,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;IACzF,MAAM,KAAK,GAAI,gCAA8D,CAAC,QAAQ,CAAC,CAAC;IACxF,IAAI,KAAK,KAAK,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,QAAQ,QAAQ,qBAAqB,CAAC,CAAC;IAC3F,OAAO,KAAK,CAAC;AACf,CAAC;AAED,IAAI,CAAC,8DAA8D,EAAE,GAAG,EAAE;IACxE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAAC;IAC/C,KAAK,MAAM,IAAI,IAAI,KAAK;QAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAChE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,qCAAqC,EAAE,GAAG,EAAE;IAC/C,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;AAC1D,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6BAA6B,EAAE,GAAG,EAAE;IACvC,MAAM,OAAO,GAAG,mDAAmD,CAAC;IACpE,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAChF,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;AAClE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,2CAA2C,EAAE,CAAC,QAAQ,EAAE,EAAE;IACpG,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAiB,CAAC;IAC1D,MAAM,OAAO,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,YAAY,EAAE,CAAC,CAAC;IACzD,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IACxC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrD,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC5D,8CAA8C;IAC9C,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAClE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,kCAAkC,EAAE,GAAG,EAAE;IAC5C,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACpD,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,gCAAe,CAAC,mBAAmB,CAAC,CAAC;IACjE,MAAM,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AACjD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,sCAAsC,EAAE,GAAG,EAAE;IAChD,MAAM,KAAK,GAAgC;QACzC,CAAC,4CAA4C,EAAE,gCAAe,CAAC,qBAAqB,CAAC;QACrF,CAAC,0CAA0C,EAAE,gCAAe,CAAC,oBAAoB,CAAC;QAClF,CAAC,gDAAgD,EAAE,gCAAe,CAAC,2BAA2B,CAAC;QAC/F,CAAC,oCAAoC,EAAE,gCAAe,CAAC,iBAAiB,CAAC;QACzE,CAAC,4CAA4C,EAAE,gCAAe,CAAC,sBAAsB,CAAC;QACtF,CAAC,0CAA0C,EAAE,gCAAe,CAAC,oBAAoB,CAAC;QAClF,CAAC,uCAAuC,EAAE,gCAAe,CAAC,iBAAiB,CAAC;QAC5E,CAAC,0CAA0C,EAAE,gCAAe,CAAC,oBAAoB,CAAC;QAClF,CAAC,oDAAoD,EAAE,gCAAe,CAAC,+BAA+B,CAAC;QACvG,CAAC,gDAAgD,EAAE,gCAAe,CAAC,uBAAuB,CAAC;QAC3F,CAAC,2DAA2D,EAAE,gCAAe,CAAC,oCAAoC,CAAC;QACnH,CAAC,0DAA0D,EAAE,gCAAe,CAAC,mCAAmC,CAAC;QACjH,CAAC,mDAAmD,EAAE,gCAAe,CAAC,gCAAgC,CAAC;QACvG,CAAC,kDAAkD,EAAE,gCAAe,CAAC,+BAA+B,CAAC;QACrG,CAAC,yDAAyD,EAAE,gCAAe,CAAC,mCAAmC,CAAC;QAChH,CAAC,wDAAwD,EAAE,gCAAe,CAAC,kCAAkC,CAAC;QAC9G,CAAC,+DAA+D,EAAE,gCAAe,CAAC,sCAAsC,CAAC;QACzH,CAAC,8DAA8D,EAAE,gCAAe,CAAC,qCAAqC,CAAC;KACxH,CAAC;IACF,KAAK,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,KAAK;QAAE,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;AACnG,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,kDAAkD,EAAE,GAAG,EAAE;IAC5D,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,mBAAS,EAAE,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IAC7D,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IAChD,MAAM,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,mBAAS,EAA4B,CAAC,CAAC,CAAC,OAAO,CAAC,8CAA8C,CAAC,CAAC;AACxI,CAAC,CAAC,CAAC"}

package/node/wrappers/util/object-type-coverage.test.ts

@@ -0,0 +1,149 @@
+// Every message with object_type has an own-type stamp (LM-320). Walks the
+// descriptor set for messages whose field 1 is
+// fintekkers.models.util.ObjectTypeProto, and fails when `stampOwn` has no
+// entry for one. Stamps each and checks its own type and version (0, 0, 1).
+import * as fs from 'fs';
+import * as path from 'path';
+import { DescriptorProto, FileDescriptorSet } from 'google-protobuf/google/protobuf/descriptor_pb';
+
+import { ObjectTypeProto } from '../../fintekkers/models/util/object_type_pb';
+import { UUIDProto } from '../../fintekkers/models/util/uuid_pb';
+
+import * as objectTypes from './object-types';
+import { ObjectTyped } from './object-types';
+
+// The descriptor set compile.sh writes for every language.
+const DESCRIPTOR_SET = path.resolve(__dirname, '../../../../ledger-models-rust/ledger_models_file_descriptor_set_v_todo.bin');
+const GENERATED = path.resolve(__dirname, '../..');
+
+const OBJECT_TYPE_ENUM = '.fintekkers.models.util.ObjectTypeProto';
+
+// The 13 types LM-320 names: every *ResponseProto and the index-composition
+// requests and responses.
+const NAMED = [
+  'fintekkers.requests.price.CreatePriceResponseProto',
+  'fintekkers.requests.price.QueryPriceResponseProto',
+  'fintekkers.requests.security.CreateSecurityResponseProto',
+  'fintekkers.requests.security.QuerySecurityResponseProto',
+  'fintekkers.requests.portfolio.CreatePortfolioResponseProto',
+  'fintekkers.requests.portfolio.QueryPortfolioResponseProto',
+  'fintekkers.requests.transaction.CreateTransactionResponseProto',
+  'fintekkers.requests.transaction.QueryTransactionResponseProto',
+  'fintekkers.requests.position.QueryPositionResponseProto',
+  'fintekkers.requests.index_composition.CreateIndexCompositionRequestProto',
+  'fintekkers.requests.index_composition.CreateIndexCompositionResponseProto',
+  'fintekkers.requests.index_composition.GetIndexCompositionRequestProto',
+  'fintekkers.requests.index_composition.GetIndexCompositionResponseProto',
+];
+
+type MessageClass = new () => ObjectTyped;
+
+/** Full name -> generated class of every message whose field 1 is ObjectTypeProto. */
+function walk(): Map<string, MessageClass> {
+  if (!fs.existsSync(DESCRIPTOR_SET)) throw new Error(`descriptor set not found at ${DESCRIPTOR_SET}`);
+  const found = new Map<string, MessageClass>();
+  const set = FileDescriptorSet.deserializeBinary(new Uint8Array(fs.readFileSync(DESCRIPTOR_SET)));
+  const isTyped = (message: DescriptorProto) =>
+    message.getFieldList().some((f) => f.getNumber() === 1 && f.getTypeName() === OBJECT_TYPE_ENUM);
+  for (const file of set.getFileList()) {
+    const fileName = file.getName() as string;
+    // Loaded only for a typed message: google/protobuf/* has no module here.
+    const generated = () => require(path.join(GENERATED, fileName.replace(/\.proto$/, '_pb')));
+    const visit = (fullName: string, scope: () => Record<string, unknown>, message: DescriptorProto) => {
+      const messageClass = () => scope()[message.getName() as string] as MessageClass & Record<string, unknown>;
+      if (isTyped(message)) {
+        if (typeof messageClass() !== 'function') throw new Error(`${fullName}: no generated class in ${fileName}`);
+        found.set(fullName, messageClass());
+      }
+      for (const nested of message.getNestedTypeList()) {
+        visit(`${fullName}.${nested.getName()}`, messageClass, nested);
+      }
+    };
+    for (const message of file.getMessageTypeList()) {
+      visit(`${file.getPackage()}.${message.getName()}`, generated, message);
+    }
+  }
+  return found;
+}
+
+const WALKED = walk();
+
+/** The walked names that `lookup` has no own type for. */
+function missingTypes(walked: Iterable<string>, lookup: (fullName: string) => ObjectTypeProto | undefined): string[] {
+  return Array.from(walked).filter((name) => lookup(name) === undefined);
+}
+
+function lookup(fullName: string): ObjectTypeProto | undefined {
+  const messageClass = WALKED.get(fullName) as MessageClass;
+  return objectTypes.ownType(new messageClass());
+}
+
+/** The value the naming rule gives: message name without Proto, in SCREAMING_SNAKE, prefixed OBJECT_TYPE_. */
+function expectedType(fullName: string): ObjectTypeProto {
+  const name = (fullName.split('.').pop() as string).replace(/Proto$/, '');
+  const enumName = 'OBJECT_TYPE_' + name.replace(/([a-z])([A-Z])/g, '$1_$2').toUpperCase();
+  const value = (ObjectTypeProto as unknown as Record<string, ObjectTypeProto>)[enumName];
+  if (value === undefined) throw new Error(`${fullName}: no ${enumName} in ObjectTypeProto`);
+  return value;
+}
+
+test('the walk finds every typed message, including the named ones', () => {
+  expect(WALKED.size).toBeGreaterThanOrEqual(49);
+  for (const name of NAMED) expect(WALKED.has(name)).toBe(true);
+});
+
+test('every typed message has an own type', () => {
+  expect(missingTypes(WALKED.keys(), lookup)).toEqual([]);
+});
+
+test('a missing entry is reported', () => {
+  const dropped = 'fintekkers.requests.price.QueryPriceResponseProto';
+  const without = (name: string) => (name === dropped ? undefined : lookup(name));
+  expect(missingTypes(WALKED.keys(), without)).toEqual([dropped]);
+});
+
+test.each(Array.from(WALKED.keys()).sort())('stamping %s sets its own type and version', (fullName) => {
+  const messageClass = WALKED.get(fullName) as MessageClass;
+  const stamped = objectTypes.stampOwn(new messageClass());
+  const expected = expectedType(fullName);
+  expect(objectTypes.readType(stamped)).toBe(expected);
+  expect(objectTypes.readVersion(stamped)).toEqual([0, 0, 1]);
+  // The name table agrees with the class table.
+  expect(objectTypes.OWN_TYPE_NAMES.get(fullName)).toBe(expected);
+});
+
+test('own types are distinct and known', () => {
+  const types = Array.from(WALKED.keys()).map(lookup);
+  expect(types).not.toContain(ObjectTypeProto.OBJECT_TYPE_UNKNOWN);
+  expect(new Set(types).size).toBe(types.length);
+});
+
+test('the LM-318 entries keep their values', () => {
+  const lm318: [string, ObjectTypeProto][] = [
+    ['fintekkers.models.portfolio.PortfolioProto', ObjectTypeProto.OBJECT_TYPE_PORTFOLIO],
+    ['fintekkers.models.position.PositionProto', ObjectTypeProto.OBJECT_TYPE_POSITION],
+    ['fintekkers.models.position.PositionFilterProto', ObjectTypeProto.OBJECT_TYPE_POSITION_FILTER],
+    ['fintekkers.models.price.PriceProto', ObjectTypeProto.OBJECT_TYPE_PRICE],
+    ['fintekkers.models.security.IdentifierProto', ObjectTypeProto.OBJECT_TYPE_IDENTIFIER],
+    ['fintekkers.models.security.SecurityProto', ObjectTypeProto.OBJECT_TYPE_SECURITY],
+    ['fintekkers.models.security.TenorProto', ObjectTypeProto.OBJECT_TYPE_TENOR],
+    ['fintekkers.models.strategy.StrategyProto', ObjectTypeProto.OBJECT_TYPE_STRATEGY],
+    ['fintekkers.models.strategy.StrategyAllocationProto', ObjectTypeProto.OBJECT_TYPE_STRATEGY_ALLOCATION],
+    ['fintekkers.models.transaction.TransactionProto', ObjectTypeProto.OBJECT_TYPE_TRANSACTION],
+    ['fintekkers.requests.portfolio.CreatePortfolioRequestProto', ObjectTypeProto.OBJECT_TYPE_CREATE_PORTFOLIO_REQUEST],
+    ['fintekkers.requests.portfolio.QueryPortfolioRequestProto', ObjectTypeProto.OBJECT_TYPE_QUERY_PORTFOLIO_REQUEST],
+    ['fintekkers.requests.price.CreatePriceRequestProto', ObjectTypeProto.OBJECT_TYPE_CREATE_PRICE_REQUEST],
+    ['fintekkers.requests.price.QueryPriceRequestProto', ObjectTypeProto.OBJECT_TYPE_QUERY_PRICE_REQUEST],
+    ['fintekkers.requests.security.CreateSecurityRequestProto', ObjectTypeProto.OBJECT_TYPE_CREATE_SECURITY_REQUEST],
+    ['fintekkers.requests.security.QuerySecurityRequestProto', ObjectTypeProto.OBJECT_TYPE_QUERY_SECURITY_REQUEST],
+    ['fintekkers.requests.transaction.CreateTransactionRequestProto', ObjectTypeProto.OBJECT_TYPE_CREATE_TRANSACTION_REQUEST],
+    ['fintekkers.requests.transaction.QueryTransactionRequestProto', ObjectTypeProto.OBJECT_TYPE_QUERY_TRANSACTION_REQUEST],
+  ];
+  for (const [name, objectType] of lm318) expect([name, lookup(name)]).toEqual([name, objectType]);
+});
+
+test('stampOwn on a message without object_type throws', () => {
+  expect(objectTypes.ownType(new UUIDProto())).toBeUndefined();
+  expect(objectTypes.ownType({})).toBeUndefined();
+  expect(() => objectTypes.stampOwn(new UUIDProto() as unknown as ObjectTyped)).toThrow('this message type has no own ObjectTypeProto');
+});

package/node/wrappers/util/object-types.d.ts

@@ -1,62 +1,46 @@
 /**
- * Compact object type and version (LM-297), stage 1: write both forms, read the new one.
+ * Object type and version (LM-297, LM-318).
  *
- * Every message with `string object_class = 1` and `string version = 2` also
- * carries `ObjectTypeProto object_type = 1001` and `uint32 version_major /
- * version_minor / version_patch = 1002-1004`. Writers call `stamp`, which sets
- * the strings and the new fields. Readers call `readType` / `readVersion` (or
- * `upgrade`), which use the new fields and fall back to the deprecated strings,
- * logging one `console.warn` per distinct pair of strings. A fallback never
- * throws: an unknown object_class gives OBJECT_TYPE_UNKNOWN and a malformed
- * version gives 0.0.0. Empty strings are the proto3 default and fall back
- * silently.
- *
- * google-protobuf cannot read the `(legacy_object_class)` options at runtime,
- * so the string map comes from object-type-legacy.json, generated by
- * scripts/gen-object-type-legacy-map.py. See docs/adr/compact_object_type_and_version.md.
+ * Every message that names its type carries `ObjectTypeProto object_type = 1`
+ * and `VersionProto version = 2`. Writers call `stamp`, which sets the type and
+ * `SCHEMA_VERSION`; `stampOwn` passes the message's own type (LM-320). Readers
+ * call `readType` / `readVersion`. The old `object_class` / `version` strings
+ * were replaced in place by LM-318: bytes written before it are not readable.
+ * See docs/adr/compact_object_type_and_version.md.
  */
 import { ObjectTypeProto } from '../../fintekkers/models/util/object_type_pb';
-/** Any generated message that carries object_class / version and their compact form. */
+import { VersionProto } from '../../fintekkers/models/util/version_pb';
+/** Any generated message that carries object_type and version. */
 export interface ObjectTyped {
-    getObjectClass(): string;
-    setObjectClass(value: string): unknown;
-    getVersion(): string;
-    setVersion(value: string): unknown;
     getObjectType(): ObjectTypeProto;
     setObjectType(value: ObjectTypeProto): unknown;
-    getVersionMajor(): number;
-    setVersionMajor(value: number): unknown;
-    getVersionMinor(): number;
-    setVersionMinor(value: number): unknown;
-    getVersionPatch(): number;
-    setVersionPatch(value: number): unknown;
+    hasVersion(): boolean;
+    getVersion(): VersionProto | undefined;
+    setVersion(value?: VersionProto): unknown;
 }
 /** [major, minor, patch], each a uint32. */
 export type Version = [number, number, number];
-/** The ObjectTypeProto value an object_class string stands for, or OBJECT_TYPE_UNKNOWN. */
-export declare function fromLegacy(objectClass: string): ObjectTypeProto;
+/** The schema version `stamp` writes. Not the library release. */
+export declare const SCHEMA_VERSION: Version;
 /**
- * The ObjectTypeProto value named for a message type, or OBJECT_TYPE_UNKNOWN.
- * Uses the enum's naming rule: `QuerySecurityRequestProto` ->
- * OBJECT_TYPE_QUERY_SECURITY_REQUEST.
+ * Sets object_type and version (`SCHEMA_VERSION`) on `message`; returns it.
+ * `objectType` is the message's own ObjectTypeProto value.
  */
-export declare function ownType(messageName: string): ObjectTypeProto;
-/** '1.2.3' -> [1, 2, 3]; null unless exactly three decimal uint32 parts. */
-export declare function parseVersion(version: string): Version | null;
+export declare function stamp<T extends ObjectTyped>(message: T, objectType: ObjectTypeProto): T;
+/** Each message with object_type, by proto full name, to its own ObjectTypeProto value. */
+export declare const OWN_TYPE_NAMES: ReadonlyMap<string, ObjectTypeProto>;
+/** The message's own ObjectTypeProto value, or undefined when its class has none. */
+export declare function ownType(message: object): ObjectTypeProto | undefined;
 /**
- * Sets object_class / version and their compact form on `message`; returns it.
- * `objectType` is the message's own ObjectTypeProto value. `version` must be
- * empty or three uint32 parts.
+ * `stamp` with the message's own ObjectTypeProto value (LM-320); returns it.
+ * Throws an Error when its class has no own value. Generated classes are
+ * anonymous at runtime, so the error names the class only when it has a name.
  */
-export declare function stamp<T extends ObjectTyped>(message: T, objectType: ObjectTypeProto, objectClass: string, version: string): T;
-/** The message's ObjectTypeProto value: object_type, else the object_class string. */
-export declare function readType(message: ObjectTyped): ObjectTypeProto;
-/** The message's [major, minor, patch]: the compact fields, else the version string. */
-export declare function readVersion(message: ObjectTyped): Version;
+export declare function stampOwn<T extends ObjectTyped>(message: T): T;
 /**
- * Fills the compact fields from the strings where they are unset; returns `message`.
- * The strings are kept, so re-serialising writes both forms.
+ * The message's ObjectTypeProto value; OBJECT_TYPE_UNKNOWN when unset. A value
+ * added after this build is returned as its number.
  */
-export declare function upgrade<T extends ObjectTyped>(message: T): T;
-/** Forgets which strings have warned. Tests only. */
-export declare function resetWarningsForTests(): void;
+export declare function readType(message: ObjectTyped): ObjectTypeProto;
+/** The message's [major, minor, patch], or undefined when version is absent. */
+export declare function readVersion(message: ObjectTyped): Version | undefined;