@natlibfi/melinda-record-matching 2.2.1-alpha.1 → 2.2.1-alpha.2

package/dist/candidate-search/candidate-search-utils.js

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.toQueries = toQueries;
+
+var _debug = _interopRequireDefault(require("debug"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+*
+* @licstart  The following is the entire license notice for the JavaScript code in this file.
+*
+* Melinda record matching modules for Javascript
+*
+* Copyright (C) 2020 University Of Helsinki (The National Library Of Finland)
+*
+* This file is part of melinda-record-matching-js
+*
+* melinda-record-matching-js program is free software: you can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as
+* published by the Free Software Foundation, either version 3 of the
+* License, or (at your option) any later version.
+*
+* melinda-record-matching-js is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Affero General Public License
+* along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*
+* @licend  The above is the entire license notice
+* for the JavaScript code in this file.
+*
+*/
+function toQueries(identifiers, queryString) {
+  const debug = (0, _debug.default)('@natlibfi/melinda-record-matching:toQueries');
+  const debugData = debug.extend('data');
+  const quotedIdentifiers = identifiers.map(identifier => identifier.match(/\//u) ? `"${identifier}"` : `${identifier}`); // Aleph supports only two queries with or -operator (This is not actually true)
+
+  const pairs = toPairs(quotedIdentifiers);
+  const queries = pairs.map(([a, b]) => b ? `${queryString}=${a} or ${queryString}=${b}` : `${queryString}=${a}`);
+  debugData(`Pairs (${pairs.length}): ${JSON.stringify(pairs)}`);
+  debugData(`Queries (${queries.length}): ${JSON.stringify(queries)}`);
+  return queries;
+}
+
+function toPairs(array) {
+  if (array.length === 0) {
+    return [];
+  }
+
+  return [array.slice(0, 2)].concat(toPairs(array.slice(2), 2));
+}
+//# sourceMappingURL=candidate-search-utils.js.map

package/dist/candidate-search/candidate-search-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"candidate-search-utils.js","names":["toQueries","identifiers","queryString","debug","createDebugLogger","debugData","extend","quotedIdentifiers","map","identifier","match","pairs","toPairs","queries","a","b","length","JSON","stringify","array","slice","concat"],"sources":["../../src/candidate-search/candidate-search-utils.js"],"sourcesContent":["/**\n*\n* @licstart  The following is the entire license notice for the JavaScript code in this file.\n*\n* Melinda record matching modules for Javascript\n*\n* Copyright (C) 2020 University Of Helsinki (The National Library Of Finland)\n*\n* This file is part of melinda-record-matching-js\n*\n* melinda-record-matching-js program is free software: you can redistribute it and/or modify\n* it under the terms of the GNU Lesser General Public License as\n* published by the Free Software Foundation, either version 3 of the\n* License, or (at your option) any later version.\n*\n* melinda-record-matching-js is distributed in the hope that it will be useful,\n* but WITHOUT ANY WARRANTY; without even the implied warranty of\n* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n* GNU Lesser General Public License for more details.\n*\n* You should have received a copy of the GNU Affero General Public License\n* along with this program.  If not, see <http://www.gnu.org/licenses/>.\n*\n* @licend  The above is the entire license notice\n* for the JavaScript code in this file.\n*\n*/\n\nimport createDebugLogger from 'debug';\n\nexport function toQueries(identifiers, queryString) {\n\n  const debug = createDebugLogger('@natlibfi/melinda-record-matching:toQueries');\n  const debugData = debug.extend('data');\n\n  const quotedIdentifiers = identifiers.map(identifier => identifier.match(/\\//u) ? `\"${identifier}\"` : `${identifier}`);\n\n  // Aleph supports only two queries with or -operator (This is not actually true)\n  const pairs = toPairs(quotedIdentifiers);\n  const queries = pairs.map(([a, b]) => b ? `${queryString}=${a} or ${queryString}=${b}` : `${queryString}=${a}`);\n\n  debugData(`Pairs (${pairs.length}): ${JSON.stringify(pairs)}`);\n  debugData(`Queries (${queries.length}): ${JSON.stringify(queries)}`);\n\n  return queries;\n}\n\nfunction toPairs(array) {\n  if (array.length === 0) {\n    return [];\n  }\n  return [array.slice(0, 2)].concat(toPairs(array.slice(2), 2));\n}\n"],"mappings":";;;;;;;AA4BA;;;;AA5BA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAIO,SAASA,SAAT,CAAmBC,WAAnB,EAAgCC,WAAhC,EAA6C;EAElD,MAAMC,KAAK,GAAG,IAAAC,cAAA,EAAkB,6CAAlB,CAAd;EACA,MAAMC,SAAS,GAAGF,KAAK,CAACG,MAAN,CAAa,MAAb,CAAlB;EAEA,MAAMC,iBAAiB,GAAGN,WAAW,CAACO,GAAZ,CAAgBC,UAAU,IAAIA,UAAU,CAACC,KAAX,CAAiB,KAAjB,IAA2B,IAAGD,UAAW,GAAzC,GAA+C,GAAEA,UAAW,EAA1F,CAA1B,CALkD,CAOlD;;EACA,MAAME,KAAK,GAAGC,OAAO,CAACL,iBAAD,CAArB;EACA,MAAMM,OAAO,GAAGF,KAAK,CAACH,GAAN,CAAU,CAAC,CAACM,CAAD,EAAIC,CAAJ,CAAD,KAAYA,CAAC,GAAI,GAAEb,WAAY,IAAGY,CAAE,OAAMZ,WAAY,IAAGa,CAAE,EAA9C,GAAmD,GAAEb,WAAY,IAAGY,CAAE,EAA7F,CAAhB;EAEAT,SAAS,CAAE,UAASM,KAAK,CAACK,MAAO,MAAKC,IAAI,CAACC,SAAL,CAAeP,KAAf,CAAsB,EAAnD,CAAT;EACAN,SAAS,CAAE,YAAWQ,OAAO,CAACG,MAAO,MAAKC,IAAI,CAACC,SAAL,CAAeL,OAAf,CAAwB,EAAzD,CAAT;EAEA,OAAOA,OAAP;AACD;;AAED,SAASD,OAAT,CAAiBO,KAAjB,EAAwB;EACtB,IAAIA,KAAK,CAACH,MAAN,KAAiB,CAArB,EAAwB;IACtB,OAAO,EAAP;EACD;;EACD,OAAO,CAACG,KAAK,CAACC,KAAN,CAAY,CAAZ,EAAe,CAAf,CAAD,EAAoBC,MAApB,CAA2BT,OAAO,CAACO,KAAK,CAACC,KAAN,CAAY,CAAZ,CAAD,EAAiB,CAAjB,CAAlC,CAAP;AACD"}

package/dist/candidate-search/index.js

@@ -0,0 +1,273 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.CandidateSearchError = void 0;
+Object.defineProperty(exports, "searchTypes", {
+  enumerable: true,
+  get: function () {
+    return _queryList.searchTypes;
+  }
+});
+
+var _debug = _interopRequireDefault(require("debug"));
+
+var _sruClient = _interopRequireWildcard(require("@natlibfi/sru-client"));
+
+var _marcRecord = require("@natlibfi/marc-record");
+
+var _marcRecordSerializers = require("@natlibfi/marc-record-serializers");
+
+var _queryList = _interopRequireWildcard(require("./query-list"));
+
+var _melindaCommons = require("@natlibfi/melinda-commons");
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+*
+* @licstart  The following is the entire license notice for the JavaScript code in this file.
+*
+* Melinda record matching modules for Javascript
+*
+* Copyright (C) 2020-2022 University Of Helsinki (The National Library Of Finland)
+*
+* This file is part of melinda-record-matching-js
+*
+* melinda-record-matching-js program is free software: you can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as
+* published by the Free Software Foundation, either version 3 of the
+* License, or (at your option) any later version.
+*
+* melinda-record-matching-js is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Affero General Public License
+* along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*
+* @licend  The above is the entire license notice
+* for the JavaScript code in this file.
+*
+*/
+class CandidateSearchError extends Error {} // serverMaxResults : maximum size of total search result available from the server, defaults to Aleph's 20000
+// eslint-disable-next-line max-statements
+
+
+exports.CandidateSearchError = CandidateSearchError;
+
+var _default = ({
+  record,
+  searchSpec,
+  url,
+  maxCandidates,
+  maxRecordsPerRequest = 50,
+  serverMaxResult = 20000
+}) => {
+  _marcRecord.MarcRecord.setValidationOptions({
+    subfieldValues: false
+  });
+
+  const debug = (0, _debug.default)('@natlibfi/melinda-record-matching:candidate-search');
+  const debugData = debug.extend('data');
+  debugData(`SearchSpec: ${JSON.stringify(searchSpec)}`);
+  debugData(`Url: ${url}`);
+  debugData(`MaxRecordsPerRequest ${maxRecordsPerRequest}`);
+  debugData(`ServerMaxResult: ${serverMaxResult}`);
+  debugData(`MaxCandidates: ${maxCandidates}`); // Do not retrieve more candidates than defined in maxCandidates
+
+  const adjustedMaxRecordsPerRequest = maxRecordsPerRequest >= maxCandidates ? maxCandidates : maxRecordsPerRequest;
+  const inputRecordId = getRecordId(record);
+  const queryList = (0, _queryList.default)(record, searchSpec);
+  const client = (0, _sruClient.default)({
+    url,
+    maxRecordsPerRequest: adjustedMaxRecordsPerRequest,
+    version: '2.0',
+    retrieveAll: false
+  });
+  debug(`Searching matches for ${inputRecordId}`);
+  debug(`Generated queryList ${JSON.stringify(queryList)}`); // if generateQueryList errored we should throw 422
+
+  if (queryList.length === 0) {
+    // eslint-disable-line functional/no-conditional-statement
+    throw new CandidateSearchError(`Generated query list contains no queries`);
+  } // state.totalRecords : amount of candidate records available to the current query (undefined, if there was no queries left)
+  // state.query : current query (undefined if there was no queries left)
+  // state.searchCounter : sequence for current search for current query (undefined, if there we no queries left)
+  // state.queryCandidateCounter: amount of candidates (records+failures) retrieved from SRU for matching for current query, including the current record+failure set (undefined if there were no queries left)
+  // state.queriesLeft : amount of queries left
+  // state.queryCounter : sequence for current query
+  // state.maxedQueries : queries that resulted in more than serverMaxResults hits
+
+
+  return async ({
+    queryOffset = 0,
+    resultSetOffset = 1,
+    totalRecords = 0,
+    searchCounter = 0,
+    queryCandidateCounter = 0,
+    queryCounter = 0,
+    maxedQueries = []
+  }) => {
+    const query = queryList[queryOffset];
+
+    if (query) {
+      const {
+        records,
+        failures,
+        nextOffset,
+        total
+      } = await retrieveRecords(); // If resultSetOffset === 1 this is the first search for the current query
+
+      debugData(`ResultSetOffset: ${resultSetOffset}`);
+      const newTotalRecords = resultSetOffset === 1 ? total : totalRecords;
+      const newQueryCounter = resultSetOffset === 1 ? queryCounter + 1 : queryCounter;
+      const newSearchCounter = resultSetOffset === 1 ? 1 : searchCounter + 1;
+      const newQueryCandidateCounter = resultSetOffset === 1 ? records.length + failures.length : queryCandidateCounter + records.length + failures.length;
+      const maxedQuery = resultSetOffset === 1 ? checkMaxedQuery(query, total, serverMaxResult) : undefined;
+      const newMaxedQueries = maxedQuery ? maxedQueries.concat(maxedQuery) : maxedQueries;
+
+      if (typeof nextOffset === 'number') {
+        debug(`Next search will be for query ${queryOffset} ${query}, starting from record ${nextOffset}`);
+        return {
+          records,
+          failures,
+          queryOffset,
+          resultSetOffset: nextOffset,
+          queriesLeft: queryList.length - (queryOffset + 1),
+          totalRecords: newTotalRecords,
+          query,
+          searchCounter: newSearchCounter,
+          queryCandidateCounter: newQueryCandidateCounter,
+          queryCounter: newQueryCounter,
+          maxedQueries: newMaxedQueries
+        };
+      }
+
+      debug(`Query ${queryOffset} ${query} done.`);
+      debug(`There are (${queryList.length - (queryOffset + 1)} queries left)`);
+      return {
+        records,
+        failures,
+        queryOffset: queryOffset + 1,
+        queriesLeft: queryList.length - (queryOffset + 1),
+        totalRecords: newTotalRecords,
+        query,
+        searchCounter: newSearchCounter,
+        queryCandidateCounter: newQueryCandidateCounter,
+        queryCounter: newQueryCounter,
+        maxedQueries: newMaxedQueries
+      };
+    }
+
+    debug(`All ${queryList.length} queries done, there's no query for ${queryOffset}`);
+    return {
+      records: [],
+      failures: [],
+      queriesLeft: 0,
+      queryCounter,
+      maxedQueries
+    };
+
+    function retrieveRecords() {
+      return new Promise((resolve, reject) => {
+        const promises = []; // eslint-disable-next-line functional/no-let
+
+        let totalRecords = 0;
+        debug(`Searching for candidates with query: ${query} (Offset ${resultSetOffset})`);
+        client.searchRetrieve(query, {
+          startRecord: resultSetOffset
+        }).on('error', err => {
+          // eslint-disable-next-line functional/no-conditional-statement
+          if (err instanceof _sruClient.SruSearchError) {
+            debug(`SRU SruSearchError for query: ${query}: ${err}`);
+            reject(new CandidateSearchError(`SRU SruSearchError for query: ${query}: ${err}`));
+          }
+
+          debug(`SRU error for query: ${query}: ${err}`);
+          reject(new CandidateSearchError(`SRU error for query: ${query}: ${err}`));
+        }).on('total', total => {
+          debug(`Got total: ${total}`);
+          totalRecords += total;
+        }).on('end', async nextOffset => {
+          try {
+            const recordPromises = await Promise.allSettled(promises);
+            debug(`All recordPromises: ${JSON.stringify(recordPromises)}`);
+            const filtered = recordPromises.filter(r => r.status === 'fulfilled').map(r => r.value);
+            const failures = recordPromises.filter(r => r.status === 'rejected').map(r => ({
+              status: r.reason.status,
+              payload: r.reason.payload
+            }));
+            debug(`Found ${JSON.stringify(recordPromises)} records`);
+            debug(`Found ${filtered.length} convertable candidates`);
+            debug(`Found ${failures.length} NON-convertable candidates`);
+            debug(`Converted: ${JSON.stringify(filtered)}.`);
+            debug(`Not converted: ${JSON.stringify(failures)}.`);
+            resolve({
+              nextOffset,
+              records: filtered,
+              failures,
+              total: totalRecords
+            });
+          } catch (err) {
+            debug(`Error caught on END`);
+            reject(err);
+          }
+        }).on('record', recordXML => {
+          promises.push(handleRecord()); // eslint-disable-line functional/immutable-data
+
+          async function handleRecord() {
+            try {
+              const recordMarc = await _marcRecordSerializers.MARCXML.from(recordXML, {
+                subfieldValues: false
+              });
+              const recordId = getRecordId(recordMarc);
+              return {
+                record: recordMarc,
+                id: recordId
+              };
+            } catch (err) {
+              // What should this do?
+              const idFromXML = getRecordIdFromXML(recordXML);
+              debugData(`Failed converting record: ${err.message}, id: ${idFromXML}, data: ${recordXML}`); //return {message: `Failed converting record: ${err.message}`, id: idFromXML, data: recordXML};
+
+              throw new _melindaCommons.Error(422, {
+                message: `Failed converting record: ${err.message}`,
+                id: idFromXML || '000000000',
+                data: recordXML
+              });
+            }
+          }
+        });
+      });
+    }
+  };
+
+  function checkMaxedQuery(query, total, serverMaxResult) {
+    // eslint-disable-next-line functional/no-conditional-statement
+    if (total >= serverMaxResult) {
+      debug(`WARNING: Query ${query} resulted in ${total} hits which meets the serverMaxResult (${serverMaxResult}) `);
+      return query;
+    }
+  }
+
+  function getRecordId(record) {
+    const [field] = record.get(/^001$/u);
+    return field ? field.value : '';
+  }
+
+  function getRecordIdFromXML(recordXML) {
+    //<controlfield tag=\"001\">015376846</controlfield
+    debug(`Cannot yet find possible database record id from recordXML (length ${recordXML.length})`);
+    return undefined;
+  }
+};
+
+exports.default = _default;
+//# sourceMappingURL=index.js.map

package/dist/candidate-search/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["CandidateSearchError","Error","record","searchSpec","url","maxCandidates","maxRecordsPerRequest","serverMaxResult","MarcRecord","setValidationOptions","subfieldValues","debug","createDebugLogger","debugData","extend","JSON","stringify","adjustedMaxRecordsPerRequest","inputRecordId","getRecordId","queryList","generateQueryList","client","createClient","version","retrieveAll","length","queryOffset","resultSetOffset","totalRecords","searchCounter","queryCandidateCounter","queryCounter","maxedQueries","query","records","failures","nextOffset","total","retrieveRecords","newTotalRecords","newQueryCounter","newSearchCounter","newQueryCandidateCounter","maxedQuery","checkMaxedQuery","undefined","newMaxedQueries","concat","queriesLeft","Promise","resolve","reject","promises","searchRetrieve","startRecord","on","err","SruSearchError","recordPromises","allSettled","filtered","filter","r","status","map","value","reason","payload","recordXML","push","handleRecord","recordMarc","MARCXML","from","recordId","id","idFromXML","getRecordIdFromXML","message","MatchingError","data","field","get"],"sources":["../../src/candidate-search/index.js"],"sourcesContent":["/**\n*\n* @licstart  The following is the entire license notice for the JavaScript code in this file.\n*\n* Melinda record matching modules for Javascript\n*\n* Copyright (C) 2020-2022 University Of Helsinki (The National Library Of Finland)\n*\n* This file is part of melinda-record-matching-js\n*\n* melinda-record-matching-js program is free software: you can redistribute it and/or modify\n* it under the terms of the GNU Lesser General Public License as\n* published by the Free Software Foundation, either version 3 of the\n* License, or (at your option) any later version.\n*\n* melinda-record-matching-js is distributed in the hope that it will be useful,\n* but WITHOUT ANY WARRANTY; without even the implied warranty of\n* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n* GNU Lesser General Public License for more details.\n*\n* You should have received a copy of the GNU Affero General Public License\n* along with this program.  If not, see <http://www.gnu.org/licenses/>.\n*\n* @licend  The above is the entire license notice\n* for the JavaScript code in this file.\n*\n*/\n\nimport createDebugLogger from 'debug';\nimport createClient, {SruSearchError} from '@natlibfi/sru-client';\nimport {MarcRecord} from '@natlibfi/marc-record';\nimport {MARCXML} from '@natlibfi/marc-record-serializers';\nimport generateQueryList from './query-list';\nimport {Error as MatchingError} from '@natlibfi/melinda-commons';\n\nexport {searchTypes} from './query-list';\n\nexport class CandidateSearchError extends Error {}\n\n// serverMaxResults : maximum size of total search result available from the server, defaults to Aleph's 20000\n\n// eslint-disable-next-line max-statements\nexport default ({record, searchSpec, url, maxCandidates, maxRecordsPerRequest = 50, serverMaxResult = 20000}) => {\n  MarcRecord.setValidationOptions({subfieldValues: false});\n\n  const debug = createDebugLogger('@natlibfi/melinda-record-matching:candidate-search');\n  const debugData = debug.extend('data');\n\n  debugData(`SearchSpec: ${JSON.stringify(searchSpec)}`);\n  debugData(`Url: ${url}`);\n  debugData(`MaxRecordsPerRequest ${maxRecordsPerRequest}`);\n  debugData(`ServerMaxResult: ${serverMaxResult}`);\n  debugData(`MaxCandidates: ${maxCandidates}`);\n\n  // Do not retrieve more candidates than defined in maxCandidates\n  const adjustedMaxRecordsPerRequest = maxRecordsPerRequest >= maxCandidates ? maxCandidates : maxRecordsPerRequest;\n\n  const inputRecordId = getRecordId(record);\n  const queryList = generateQueryList(record, searchSpec);\n  const client = createClient({\n    url,\n    maxRecordsPerRequest: adjustedMaxRecordsPerRequest,\n    version: '2.0',\n    retrieveAll: false\n  });\n\n  debug(`Searching matches for ${inputRecordId}`);\n  debug(`Generated queryList ${JSON.stringify(queryList)}`);\n\n  // if generateQueryList errored we should throw 422\n\n  if (queryList.length === 0) { // eslint-disable-line functional/no-conditional-statement\n    throw new CandidateSearchError(`Generated query list contains no queries`);\n  }\n\n  // state.totalRecords : amount of candidate records available to the current query (undefined, if there was no queries left)\n  // state.query : current query (undefined if there was no queries left)\n  // state.searchCounter : sequence for current search for current query (undefined, if there we no queries left)\n  // state.queryCandidateCounter: amount of candidates (records+failures) retrieved from SRU for matching for current query, including the current record+failure set (undefined if there were no queries left)\n  // state.queriesLeft : amount of queries left\n  // state.queryCounter : sequence for current query\n  // state.maxedQueries : queries that resulted in more than serverMaxResults hits\n\n\n  return async ({queryOffset = 0, resultSetOffset = 1, totalRecords = 0, searchCounter = 0, queryCandidateCounter = 0, queryCounter = 0, maxedQueries = []}) => {\n    const query = queryList[queryOffset];\n\n    if (query) {\n      const {records, failures, nextOffset, total} = await retrieveRecords();\n\n      // If resultSetOffset === 1 this is the first search for the current query\n      debugData(`ResultSetOffset: ${resultSetOffset}`);\n      const newTotalRecords = resultSetOffset === 1 ? total : totalRecords;\n      const newQueryCounter = resultSetOffset === 1 ? queryCounter + 1 : queryCounter;\n      const newSearchCounter = resultSetOffset === 1 ? 1 : searchCounter + 1;\n      const newQueryCandidateCounter = resultSetOffset === 1 ? records.length + failures.length : queryCandidateCounter + records.length + failures.length;\n\n      const maxedQuery = resultSetOffset === 1 ? checkMaxedQuery(query, total, serverMaxResult) : undefined;\n      const newMaxedQueries = maxedQuery ? maxedQueries.concat(maxedQuery) : maxedQueries;\n\n      if (typeof nextOffset === 'number') {\n        debug(`Next search will be for query ${queryOffset} ${query}, starting from record ${nextOffset}`);\n        return {records, failures, queryOffset, resultSetOffset: nextOffset, queriesLeft: queryList.length - (queryOffset + 1), totalRecords: newTotalRecords, query, searchCounter: newSearchCounter, queryCandidateCounter: newQueryCandidateCounter, queryCounter: newQueryCounter, maxedQueries: newMaxedQueries};\n      }\n      debug(`Query ${queryOffset} ${query} done.`);\n      debug(`There are (${queryList.length - (queryOffset + 1)} queries left)`);\n      return {records, failures, queryOffset: queryOffset + 1, queriesLeft: queryList.length - (queryOffset + 1), totalRecords: newTotalRecords, query, searchCounter: newSearchCounter, queryCandidateCounter: newQueryCandidateCounter, queryCounter: newQueryCounter, maxedQueries: newMaxedQueries};\n    }\n\n    debug(`All ${queryList.length} queries done, there's no query for ${queryOffset}`);\n    return {records: [], failures: [], queriesLeft: 0, queryCounter, maxedQueries};\n\n    function retrieveRecords() {\n      return new Promise((resolve, reject) => {\n        const promises = [];\n        // eslint-disable-next-line functional/no-let\n        let totalRecords = 0;\n\n        debug(`Searching for candidates with query: ${query} (Offset ${resultSetOffset})`);\n\n        client.searchRetrieve(query, {startRecord: resultSetOffset})\n          .on('error', err => {\n            // eslint-disable-next-line functional/no-conditional-statement\n            if (err instanceof SruSearchError) {\n              debug(`SRU SruSearchError for query: ${query}: ${err}`);\n              reject(new CandidateSearchError(`SRU SruSearchError for query: ${query}: ${err}`));\n            }\n            debug(`SRU error for query: ${query}: ${err}`);\n            reject(new CandidateSearchError(`SRU error for query: ${query}: ${err}`));\n          })\n          .on('total', total => {\n            debug(`Got total: ${total}`);\n            totalRecords += total;\n          })\n          .on('end', async nextOffset => {\n            try {\n              const recordPromises = await Promise.allSettled(promises);\n              debug(`All recordPromises: ${JSON.stringify(recordPromises)}`);\n              const filtered = recordPromises.filter(r => r.status === 'fulfilled').map(r => r.value);\n              const failures = recordPromises.filter(r => r.status === 'rejected').map(r => ({status: r.reason.status, payload: r.reason.payload}));\n\n              debug(`Found ${JSON.stringify(recordPromises)} records`);\n              debug(`Found ${filtered.length} convertable candidates`);\n              debug(`Found ${failures.length} NON-convertable candidates`);\n              debug(`Converted: ${JSON.stringify(filtered)}.`);\n              debug(`Not converted: ${JSON.stringify(failures)}.`);\n\n\n              resolve({nextOffset, records: filtered, failures, total: totalRecords});\n            } catch (err) {\n              debug(`Error caught on END`);\n              reject(err);\n            }\n          })\n          .on('record', recordXML => {\n            promises.push(handleRecord()); // eslint-disable-line functional/immutable-data\n\n            async function handleRecord() {\n              try {\n                const recordMarc = await MARCXML.from(recordXML, {subfieldValues: false});\n                const recordId = getRecordId(recordMarc);\n\n                return {record: recordMarc, id: recordId};\n              } catch (err) {\n                // What should this do?\n                const idFromXML = getRecordIdFromXML(recordXML);\n                debugData(`Failed converting record: ${err.message}, id: ${idFromXML}, data: ${recordXML}`);\n                //return {message: `Failed converting record: ${err.message}`, id: idFromXML, data: recordXML};\n                throw new MatchingError(422, {message: `Failed converting record: ${err.message}`, id: idFromXML || '000000000', data: recordXML});\n              }\n            }\n          });\n      });\n    }\n  };\n\n  function checkMaxedQuery(query, total, serverMaxResult) {\n    // eslint-disable-next-line functional/no-conditional-statement\n    if (total >= serverMaxResult) {\n      debug(`WARNING: Query ${query} resulted in ${total} hits which meets the serverMaxResult (${serverMaxResult}) `);\n      return query;\n    }\n  }\n\n\n  function getRecordId(record) {\n    const [field] = record.get(/^001$/u);\n    return field ? field.value : '';\n  }\n\n  function getRecordIdFromXML(recordXML) {\n    //<controlfield tag=\\\"001\\\">015376846</controlfield\n    debug(`Cannot yet find possible database record id from recordXML (length ${recordXML.length})`);\n    return undefined;\n  }\n\n};\n"],"mappings":";;;;;;;;;;;;;AA4BA;;AACA;;AACA;;AACA;;AACA;;AACA;;;;;;;;AAjCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAWO,MAAMA,oBAAN,SAAmCC,KAAnC,CAAyC,E,CAEhD;AAEA;;;;;eACe,CAAC;EAACC,MAAD;EAASC,UAAT;EAAqBC,GAArB;EAA0BC,aAA1B;EAAyCC,oBAAoB,GAAG,EAAhE;EAAoEC,eAAe,GAAG;AAAtF,CAAD,KAAkG;EAC/GC,sBAAA,CAAWC,oBAAX,CAAgC;IAACC,cAAc,EAAE;EAAjB,CAAhC;;EAEA,MAAMC,KAAK,GAAG,IAAAC,cAAA,EAAkB,oDAAlB,CAAd;EACA,MAAMC,SAAS,GAAGF,KAAK,CAACG,MAAN,CAAa,MAAb,CAAlB;EAEAD,SAAS,CAAE,eAAcE,IAAI,CAACC,SAAL,CAAeb,UAAf,CAA2B,EAA3C,CAAT;EACAU,SAAS,CAAE,QAAOT,GAAI,EAAb,CAAT;EACAS,SAAS,CAAE,wBAAuBP,oBAAqB,EAA9C,CAAT;EACAO,SAAS,CAAE,oBAAmBN,eAAgB,EAArC,CAAT;EACAM,SAAS,CAAE,kBAAiBR,aAAc,EAAjC,CAAT,CAV+G,CAY/G;;EACA,MAAMY,4BAA4B,GAAGX,oBAAoB,IAAID,aAAxB,GAAwCA,aAAxC,GAAwDC,oBAA7F;EAEA,MAAMY,aAAa,GAAGC,WAAW,CAACjB,MAAD,CAAjC;EACA,MAAMkB,SAAS,GAAG,IAAAC,kBAAA,EAAkBnB,MAAlB,EAA0BC,UAA1B,CAAlB;EACA,MAAMmB,MAAM,GAAG,IAAAC,kBAAA,EAAa;IAC1BnB,GAD0B;IAE1BE,oBAAoB,EAAEW,4BAFI;IAG1BO,OAAO,EAAE,KAHiB;IAI1BC,WAAW,EAAE;EAJa,CAAb,CAAf;EAOAd,KAAK,CAAE,yBAAwBO,aAAc,EAAxC,CAAL;EACAP,KAAK,CAAE,uBAAsBI,IAAI,CAACC,SAAL,CAAeI,SAAf,CAA0B,EAAlD,CAAL,CAzB+G,CA2B/G;;EAEA,IAAIA,SAAS,CAACM,MAAV,KAAqB,CAAzB,EAA4B;IAAE;IAC5B,MAAM,IAAI1B,oBAAJ,CAA0B,0CAA1B,CAAN;EACD,CA/B8G,CAiC/G;EACA;EACA;EACA;EACA;EACA;EACA;;;EAGA,OAAO,OAAO;IAAC2B,WAAW,GAAG,CAAf;IAAkBC,eAAe,GAAG,CAApC;IAAuCC,YAAY,GAAG,CAAtD;IAAyDC,aAAa,GAAG,CAAzE;IAA4EC,qBAAqB,GAAG,CAApG;IAAuGC,YAAY,GAAG,CAAtH;IAAyHC,YAAY,GAAG;EAAxI,CAAP,KAAuJ;IAC5J,MAAMC,KAAK,GAAGd,SAAS,CAACO,WAAD,CAAvB;;IAEA,IAAIO,KAAJ,EAAW;MACT,MAAM;QAACC,OAAD;QAAUC,QAAV;QAAoBC,UAApB;QAAgCC;MAAhC,IAAyC,MAAMC,eAAe,EAApE,CADS,CAGT;;MACA1B,SAAS,CAAE,oBAAmBe,eAAgB,EAArC,CAAT;MACA,MAAMY,eAAe,GAAGZ,eAAe,KAAK,CAApB,GAAwBU,KAAxB,GAAgCT,YAAxD;MACA,MAAMY,eAAe,GAAGb,eAAe,KAAK,CAApB,GAAwBI,YAAY,GAAG,CAAvC,GAA2CA,YAAnE;MACA,MAAMU,gBAAgB,GAAGd,eAAe,KAAK,CAApB,GAAwB,CAAxB,GAA4BE,aAAa,GAAG,CAArE;MACA,MAAMa,wBAAwB,GAAGf,eAAe,KAAK,CAApB,GAAwBO,OAAO,CAACT,MAAR,GAAiBU,QAAQ,CAACV,MAAlD,GAA2DK,qBAAqB,GAAGI,OAAO,CAACT,MAAhC,GAAyCU,QAAQ,CAACV,MAA9I;MAEA,MAAMkB,UAAU,GAAGhB,eAAe,KAAK,CAApB,GAAwBiB,eAAe,CAACX,KAAD,EAAQI,KAAR,EAAe/B,eAAf,CAAvC,GAAyEuC,SAA5F;MACA,MAAMC,eAAe,GAAGH,UAAU,GAAGX,YAAY,CAACe,MAAb,CAAoBJ,UAApB,CAAH,GAAqCX,YAAvE;;MAEA,IAAI,OAAOI,UAAP,KAAsB,QAA1B,EAAoC;QAClC1B,KAAK,CAAE,iCAAgCgB,WAAY,IAAGO,KAAM,0BAAyBG,UAAW,EAA3F,CAAL;QACA,OAAO;UAACF,OAAD;UAAUC,QAAV;UAAoBT,WAApB;UAAiCC,eAAe,EAAES,UAAlD;UAA8DY,WAAW,EAAE7B,SAAS,CAACM,MAAV,IAAoBC,WAAW,GAAG,CAAlC,CAA3E;UAAiHE,YAAY,EAAEW,eAA/H;UAAgJN,KAAhJ;UAAuJJ,aAAa,EAAEY,gBAAtK;UAAwLX,qBAAqB,EAAEY,wBAA/M;UAAyOX,YAAY,EAAES,eAAvP;UAAwQR,YAAY,EAAEc;QAAtR,CAAP;MACD;;MACDpC,KAAK,CAAE,SAAQgB,WAAY,IAAGO,KAAM,QAA/B,CAAL;MACAvB,KAAK,CAAE,cAAaS,SAAS,CAACM,MAAV,IAAoBC,WAAW,GAAG,CAAlC,CAAqC,gBAApD,CAAL;MACA,OAAO;QAACQ,OAAD;QAAUC,QAAV;QAAoBT,WAAW,EAAEA,WAAW,GAAG,CAA/C;QAAkDsB,WAAW,EAAE7B,SAAS,CAACM,MAAV,IAAoBC,WAAW,GAAG,CAAlC,CAA/D;QAAqGE,YAAY,EAAEW,eAAnH;QAAoIN,KAApI;QAA2IJ,aAAa,EAAEY,gBAA1J;QAA4KX,qBAAqB,EAAEY,wBAAnM;QAA6NX,YAAY,EAAES,eAA3O;QAA4PR,YAAY,EAAEc;MAA1Q,CAAP;IACD;;IAEDpC,KAAK,CAAE,OAAMS,SAAS,CAACM,MAAO,uCAAsCC,WAAY,EAA3E,CAAL;IACA,OAAO;MAACQ,OAAO,EAAE,EAAV;MAAcC,QAAQ,EAAE,EAAxB;MAA4Ba,WAAW,EAAE,CAAzC;MAA4CjB,YAA5C;MAA0DC;IAA1D,CAAP;;IAEA,SAASM,eAAT,GAA2B;MACzB,OAAO,IAAIW,OAAJ,CAAY,CAACC,OAAD,EAAUC,MAAV,KAAqB;QACtC,MAAMC,QAAQ,GAAG,EAAjB,CADsC,CAEtC;;QACA,IAAIxB,YAAY,GAAG,CAAnB;QAEAlB,KAAK,CAAE,wCAAuCuB,KAAM,YAAWN,eAAgB,GAA1E,CAAL;QAEAN,MAAM,CAACgC,cAAP,CAAsBpB,KAAtB,EAA6B;UAACqB,WAAW,EAAE3B;QAAd,CAA7B,EACG4B,EADH,CACM,OADN,EACeC,GAAG,IAAI;UAClB;UACA,IAAIA,GAAG,YAAYC,yBAAnB,EAAmC;YACjC/C,KAAK,CAAE,iCAAgCuB,KAAM,KAAIuB,GAAI,EAAhD,CAAL;YACAL,MAAM,CAAC,IAAIpD,oBAAJ,CAA0B,iCAAgCkC,KAAM,KAAIuB,GAAI,EAAxE,CAAD,CAAN;UACD;;UACD9C,KAAK,CAAE,wBAAuBuB,KAAM,KAAIuB,GAAI,EAAvC,CAAL;UACAL,MAAM,CAAC,IAAIpD,oBAAJ,CAA0B,wBAAuBkC,KAAM,KAAIuB,GAAI,EAA/D,CAAD,CAAN;QACD,CATH,EAUGD,EAVH,CAUM,OAVN,EAUelB,KAAK,IAAI;UACpB3B,KAAK,CAAE,cAAa2B,KAAM,EAArB,CAAL;UACAT,YAAY,IAAIS,KAAhB;QACD,CAbH,EAcGkB,EAdH,CAcM,KAdN,EAca,MAAMnB,UAAN,IAAoB;UAC7B,IAAI;YACF,MAAMsB,cAAc,GAAG,MAAMT,OAAO,CAACU,UAAR,CAAmBP,QAAnB,CAA7B;YACA1C,KAAK,CAAE,uBAAsBI,IAAI,CAACC,SAAL,CAAe2C,cAAf,CAA+B,EAAvD,CAAL;YACA,MAAME,QAAQ,GAAGF,cAAc,CAACG,MAAf,CAAsBC,CAAC,IAAIA,CAAC,CAACC,MAAF,KAAa,WAAxC,EAAqDC,GAArD,CAAyDF,CAAC,IAAIA,CAAC,CAACG,KAAhE,CAAjB;YACA,MAAM9B,QAAQ,GAAGuB,cAAc,CAACG,MAAf,CAAsBC,CAAC,IAAIA,CAAC,CAACC,MAAF,KAAa,UAAxC,EAAoDC,GAApD,CAAwDF,CAAC,KAAK;cAACC,MAAM,EAAED,CAAC,CAACI,MAAF,CAASH,MAAlB;cAA0BI,OAAO,EAAEL,CAAC,CAACI,MAAF,CAASC;YAA5C,CAAL,CAAzD,CAAjB;YAEAzD,KAAK,CAAE,SAAQI,IAAI,CAACC,SAAL,CAAe2C,cAAf,CAA+B,UAAzC,CAAL;YACAhD,KAAK,CAAE,SAAQkD,QAAQ,CAACnC,MAAO,yBAA1B,CAAL;YACAf,KAAK,CAAE,SAAQyB,QAAQ,CAACV,MAAO,6BAA1B,CAAL;YACAf,KAAK,CAAE,cAAaI,IAAI,CAACC,SAAL,CAAe6C,QAAf,CAAyB,GAAxC,CAAL;YACAlD,KAAK,CAAE,kBAAiBI,IAAI,CAACC,SAAL,CAAeoB,QAAf,CAAyB,GAA5C,CAAL;YAGAe,OAAO,CAAC;cAACd,UAAD;cAAaF,OAAO,EAAE0B,QAAtB;cAAgCzB,QAAhC;cAA0CE,KAAK,EAAET;YAAjD,CAAD,CAAP;UACD,CAdD,CAcE,OAAO4B,GAAP,EAAY;YACZ9C,KAAK,CAAE,qBAAF,CAAL;YACAyC,MAAM,CAACK,GAAD,CAAN;UACD;QACF,CAjCH,EAkCGD,EAlCH,CAkCM,QAlCN,EAkCgBa,SAAS,IAAI;UACzBhB,QAAQ,CAACiB,IAAT,CAAcC,YAAY,EAA1B,EADyB,CACM;;UAE/B,eAAeA,YAAf,GAA8B;YAC5B,IAAI;cACF,MAAMC,UAAU,GAAG,MAAMC,8BAAA,CAAQC,IAAR,CAAaL,SAAb,EAAwB;gBAAC3D,cAAc,EAAE;cAAjB,CAAxB,CAAzB;cACA,MAAMiE,QAAQ,GAAGxD,WAAW,CAACqD,UAAD,CAA5B;cAEA,OAAO;gBAACtE,MAAM,EAAEsE,UAAT;gBAAqBI,EAAE,EAAED;cAAzB,CAAP;YACD,CALD,CAKE,OAAOlB,GAAP,EAAY;cACZ;cACA,MAAMoB,SAAS,GAAGC,kBAAkB,CAACT,SAAD,CAApC;cACAxD,SAAS,CAAE,6BAA4B4C,GAAG,CAACsB,OAAQ,SAAQF,SAAU,WAAUR,SAAU,EAAhF,CAAT,CAHY,CAIZ;;cACA,MAAM,IAAIW,qBAAJ,CAAkB,GAAlB,EAAuB;gBAACD,OAAO,EAAG,6BAA4BtB,GAAG,CAACsB,OAAQ,EAAnD;gBAAsDH,EAAE,EAAEC,SAAS,IAAI,WAAvE;gBAAoFI,IAAI,EAAEZ;cAA1F,CAAvB,CAAN;YACD;UACF;QACF,CAnDH;MAoDD,CA3DM,CAAP;IA4DD;EACF,CA1FD;;EA4FA,SAASxB,eAAT,CAAyBX,KAAzB,EAAgCI,KAAhC,EAAuC/B,eAAvC,EAAwD;IACtD;IACA,IAAI+B,KAAK,IAAI/B,eAAb,EAA8B;MAC5BI,KAAK,CAAE,kBAAiBuB,KAAM,gBAAeI,KAAM,0CAAyC/B,eAAgB,IAAvG,CAAL;MACA,OAAO2B,KAAP;IACD;EACF;;EAGD,SAASf,WAAT,CAAqBjB,MAArB,EAA6B;IAC3B,MAAM,CAACgF,KAAD,IAAUhF,MAAM,CAACiF,GAAP,CAAW,QAAX,CAAhB;IACA,OAAOD,KAAK,GAAGA,KAAK,CAAChB,KAAT,GAAiB,EAA7B;EACD;;EAED,SAASY,kBAAT,CAA4BT,SAA5B,EAAuC;IACrC;IACA1D,KAAK,CAAE,sEAAqE0D,SAAS,CAAC3C,MAAO,GAAxF,CAAL;IACA,OAAOoB,SAAP;EACD;AAEF,C"}

package/dist/candidate-search/index.spec.js

@@ -0,0 +1,161 @@
+"use strict";
+
+var _chai = require("chai");
+
+var _fixura = require("@natlibfi/fixura");
+
+var _fixugenHttpClient = _interopRequireDefault(require("@natlibfi/fixugen-http-client"));
+
+var _marcRecord = require("@natlibfi/marc-record");
+
+var _melindaCommons = require("@natlibfi/melinda-commons");
+
+var _ = _interopRequireWildcard(require("."));
+
+var _debug = _interopRequireDefault(require("debug"));
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+*
+* @licstart  The following is the entire license notice for the JavaScript code in this file.
+*
+* Melinda record matching modules for Javascript
+*
+* Copyright (C) 2020-2022 University Of Helsinki (The National Library Of Finland)
+*
+* This file is part of melinda-record-matching-js
+*
+* melinda-record-matching-js program is free software: you can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as
+* published by the Free Software Foundation, either version 3 of the
+* License, or (at your option) any later version.
+*
+* melinda-record-matching-js is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU Lesser General Public License for more details.
+*
+* You should have received a copy of the GNU Affero General Public License
+* along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*
+* @licend  The above is the entire license notice
+* for the JavaScript code in this file.
+*
+*/
+const debug = (0, _debug.default)('@natlibfi/melinda-record-matching:candidate-search:test');
+describe('candidate-search', () => {
+  (0, _fixugenHttpClient.default)({
+    callback,
+    path: [__dirname, '..', '..', 'test-fixtures', 'candidate-search', 'index'],
+    recurse: false,
+    fixura: {
+      reader: _fixura.READERS.JSON
+    }
+  }); // eslint-disable-next-line max-statements
+
+  async function callback({
+    getFixture,
+    factoryOptions,
+    searchOptions,
+    expectedFactoryError = false,
+    expectedSearchError = false,
+    enabled = true
+  }) {
+    const url = 'http://foo.bar';
+
+    if (!enabled) {
+      return;
+    }
+
+    if (expectedFactoryError) {
+      if (expectedFactoryError.isCandidateSearchError) {
+        (0, _chai.expect)(() => (0, _.default)({ ...formatFactoryOptions(),
+          url
+        })).to.throw(_.CandidateSearchError, new RegExp(expectedFactoryError, 'u'));
+        return;
+      }
+
+      (0, _chai.expect)(() => (0, _.default)({ ...formatFactoryOptions(),
+        url
+      })).to.throw(new RegExp(expectedFactoryError, 'u'));
+      return;
+    }
+
+    const search = (0, _.default)({ ...formatFactoryOptions(),
+      url
+    });
+    await iterate({
+      searchOptions,
+      expectedSearchError
+    });
+
+    function formatFactoryOptions() {
+      debug(`Using factoryOptions: ${JSON.stringify(factoryOptions)}`);
+      return { ...factoryOptions,
+        maxRecordsPerRequest: factoryOptions.maxRecordsPerRequest || 1,
+        maxServerResults: factoryOptions.maxServerResults || undefined,
+        record: new _marcRecord.MarcRecord(factoryOptions.record, {
+          subfieldValues: false
+        })
+      };
+    } // eslint-disable-next-line max-statements
+
+
+    async function iterate({
+      searchOptions,
+      expectedSearchError,
+      expectedErrorStatus,
+      count = 1
+    }) {
+      const expectedResults = getFixture(`expectedResults${count}.json`);
+
+      if (expectedSearchError) {
+        // eslint-disable-line functional/no-conditional-statement
+        try {
+          await search(searchOptions);
+          throw new Error('Expected an error');
+        } catch (err) {
+          debug(`Got an error: ${err}`);
+          (0, _chai.expect)(err).to.be.an('error');
+          const errorMessage = err instanceof _melindaCommons.Error ? err.payload.message : err.message;
+          const errorStatus = err instanceof _melindaCommons.Error ? err.status : undefined;
+          debug(`errorMessage: ${errorMessage}, errorStatus: ${errorStatus}`);
+          (0, _chai.expect)(errorMessage).to.match(new RegExp(expectedSearchError, 'u'));
+
+          if (expectedErrorStatus) {
+            (0, _chai.expect)(errorStatus).to.be(expectedErrorStatus);
+            return;
+          }
+
+          return;
+        }
+      } // eslint-disable-next-line functional/no-conditional-statement
+
+
+      if (!expectedSearchError) {
+        const results = await search(searchOptions);
+        (0, _chai.expect)(formatResults(results)).to.eql(expectedResults);
+      }
+
+      function formatResults(results) {
+        debug(results); //eslint-disable-line
+
+        return { ...results,
+          records: results.records.map(({
+            record,
+            id
+          }) => ({
+            id,
+            record: record.toObject()
+          }))
+        };
+      }
+    }
+  }
+});
+//# sourceMappingURL=index.spec.js.map

package/dist/candidate-search/index.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.spec.js","names":["debug","createDebugLogger","describe","generateTests","callback","path","__dirname","recurse","fixura","reader","READERS","JSON","getFixture","factoryOptions","searchOptions","expectedFactoryError","expectedSearchError","enabled","url","isCandidateSearchError","expect","createSearchInterface","formatFactoryOptions","to","throw","CandidateSearchError","RegExp","search","iterate","stringify","maxRecordsPerRequest","maxServerResults","undefined","record","MarcRecord","subfieldValues","expectedErrorStatus","count","expectedResults","Error","err","be","an","errorMessage","MatchingError","payload","message","errorStatus","status","match","results","formatResults","eql","records","map","id","toObject"],"sources":["../../src/candidate-search/index.spec.js"],"sourcesContent":["/**\n*\n* @licstart  The following is the entire license notice for the JavaScript code in this file.\n*\n* Melinda record matching modules for Javascript\n*\n* Copyright (C) 2020-2022 University Of Helsinki (The National Library Of Finland)\n*\n* This file is part of melinda-record-matching-js\n*\n* melinda-record-matching-js program is free software: you can redistribute it and/or modify\n* it under the terms of the GNU Lesser General Public License as\n* published by the Free Software Foundation, either version 3 of the\n* License, or (at your option) any later version.\n*\n* melinda-record-matching-js is distributed in the hope that it will be useful,\n* but WITHOUT ANY WARRANTY; without even the implied warranty of\n* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n* GNU Lesser General Public License for more details.\n*\n* You should have received a copy of the GNU Affero General Public License\n* along with this program.  If not, see <http://www.gnu.org/licenses/>.\n*\n* @licend  The above is the entire license notice\n* for the JavaScript code in this file.\n*\n*/\n\nimport {expect} from 'chai';\nimport {READERS} from '@natlibfi/fixura';\nimport generateTests from '@natlibfi/fixugen-http-client';\nimport {MarcRecord} from '@natlibfi/marc-record';\nimport {Error as MatchingError} from '@natlibfi/melinda-commons';\nimport createSearchInterface, {CandidateSearchError} from '.';\nimport createDebugLogger from 'debug';\n\nconst debug = createDebugLogger('@natlibfi/melinda-record-matching:candidate-search:test');\n\ndescribe('candidate-search', () => {\n  generateTests({\n    callback,\n    path: [__dirname, '..', '..', 'test-fixtures', 'candidate-search', 'index'],\n    recurse: false,\n    fixura: {\n      reader: READERS.JSON\n    }\n  });\n\n  // eslint-disable-next-line max-statements\n  async function callback({getFixture, factoryOptions, searchOptions, expectedFactoryError = false, expectedSearchError = false, enabled = true}) {\n    const url = 'http://foo.bar';\n\n    if (!enabled) {\n      return;\n    }\n\n    if (expectedFactoryError) {\n      if (expectedFactoryError.isCandidateSearchError) {\n        expect(() => createSearchInterface({...formatFactoryOptions(), url})).to.throw(CandidateSearchError, new RegExp(expectedFactoryError, 'u'));\n        return;\n      }\n\n      expect(() => createSearchInterface({...formatFactoryOptions(), url})).to.throw(new RegExp(expectedFactoryError, 'u'));\n      return;\n    }\n\n    const search = createSearchInterface({...formatFactoryOptions(), url});\n    await iterate({searchOptions, expectedSearchError});\n\n    function formatFactoryOptions() {\n      debug(`Using factoryOptions: ${JSON.stringify(factoryOptions)}`);\n      return {\n        ...factoryOptions,\n        maxRecordsPerRequest: factoryOptions.maxRecordsPerRequest || 1,\n        maxServerResults: factoryOptions.maxServerResults || undefined,\n        record: new MarcRecord(factoryOptions.record, {subfieldValues: false})\n      };\n    }\n\n    // eslint-disable-next-line max-statements\n    async function iterate({searchOptions, expectedSearchError, expectedErrorStatus, count = 1}) {\n      const expectedResults = getFixture(`expectedResults${count}.json`);\n\n      if (expectedSearchError) { // eslint-disable-line functional/no-conditional-statement\n        try {\n          await search(searchOptions);\n          throw new Error('Expected an error');\n        } catch (err) {\n          debug(`Got an error: ${err}`);\n          expect(err).to.be.an('error');\n          const errorMessage = err instanceof MatchingError ? err.payload.message : err.message;\n          const errorStatus = err instanceof MatchingError ? err.status : undefined;\n          debug(`errorMessage: ${errorMessage}, errorStatus: ${errorStatus}`);\n          expect(errorMessage).to.match(new RegExp(expectedSearchError, 'u'));\n\n          if (expectedErrorStatus) {\n            expect(errorStatus).to.be(expectedErrorStatus);\n            return;\n          }\n          return;\n        }\n      }\n\n      // eslint-disable-next-line functional/no-conditional-statement\n      if (!expectedSearchError) {\n        const results = await search(searchOptions);\n        expect(formatResults(results)).to.eql(expectedResults);\n      }\n\n      function formatResults(results) {\n        debug(results); //eslint-disable-line\n        return {\n          ...results,\n          records: results.records.map(({record, id}) => ({id, record: record.toObject()}))\n        };\n      }\n\n    }\n  }\n});\n"],"mappings":";;AA4BA;;AACA;;AACA;;AACA;;AACA;;AACA;;AACA;;;;;;;;AAlCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAUA,MAAMA,KAAK,GAAG,IAAAC,cAAA,EAAkB,yDAAlB,CAAd;AAEAC,QAAQ,CAAC,kBAAD,EAAqB,MAAM;EACjC,IAAAC,0BAAA,EAAc;IACZC,QADY;IAEZC,IAAI,EAAE,CAACC,SAAD,EAAY,IAAZ,EAAkB,IAAlB,EAAwB,eAAxB,EAAyC,kBAAzC,EAA6D,OAA7D,CAFM;IAGZC,OAAO,EAAE,KAHG;IAIZC,MAAM,EAAE;MACNC,MAAM,EAAEC,eAAA,CAAQC;IADV;EAJI,CAAd,EADiC,CAUjC;;EACA,eAAeP,QAAf,CAAwB;IAACQ,UAAD;IAAaC,cAAb;IAA6BC,aAA7B;IAA4CC,oBAAoB,GAAG,KAAnE;IAA0EC,mBAAmB,GAAG,KAAhG;IAAuGC,OAAO,GAAG;EAAjH,CAAxB,EAAgJ;IAC9I,MAAMC,GAAG,GAAG,gBAAZ;;IAEA,IAAI,CAACD,OAAL,EAAc;MACZ;IACD;;IAED,IAAIF,oBAAJ,EAA0B;MACxB,IAAIA,oBAAoB,CAACI,sBAAzB,EAAiD;QAC/C,IAAAC,YAAA,EAAO,MAAM,IAAAC,SAAA,EAAsB,EAAC,GAAGC,oBAAoB,EAAxB;UAA4BJ;QAA5B,CAAtB,CAAb,EAAsEK,EAAtE,CAAyEC,KAAzE,CAA+EC,sBAA/E,EAAqG,IAAIC,MAAJ,CAAWX,oBAAX,EAAiC,GAAjC,CAArG;QACA;MACD;;MAED,IAAAK,YAAA,EAAO,MAAM,IAAAC,SAAA,EAAsB,EAAC,GAAGC,oBAAoB,EAAxB;QAA4BJ;MAA5B,CAAtB,CAAb,EAAsEK,EAAtE,CAAyEC,KAAzE,CAA+E,IAAIE,MAAJ,CAAWX,oBAAX,EAAiC,GAAjC,CAA/E;MACA;IACD;;IAED,MAAMY,MAAM,GAAG,IAAAN,SAAA,EAAsB,EAAC,GAAGC,oBAAoB,EAAxB;MAA4BJ;IAA5B,CAAtB,CAAf;IACA,MAAMU,OAAO,CAAC;MAACd,aAAD;MAAgBE;IAAhB,CAAD,CAAb;;IAEA,SAASM,oBAAT,GAAgC;MAC9BtB,KAAK,CAAE,yBAAwBW,IAAI,CAACkB,SAAL,CAAehB,cAAf,CAA+B,EAAzD,CAAL;MACA,OAAO,EACL,GAAGA,cADE;QAELiB,oBAAoB,EAAEjB,cAAc,CAACiB,oBAAf,IAAuC,CAFxD;QAGLC,gBAAgB,EAAElB,cAAc,CAACkB,gBAAf,IAAmCC,SAHhD;QAILC,MAAM,EAAE,IAAIC,sBAAJ,CAAerB,cAAc,CAACoB,MAA9B,EAAsC;UAACE,cAAc,EAAE;QAAjB,CAAtC;MAJH,CAAP;IAMD,CA5B6I,CA8B9I;;;IACA,eAAeP,OAAf,CAAuB;MAACd,aAAD;MAAgBE,mBAAhB;MAAqCoB,mBAArC;MAA0DC,KAAK,GAAG;IAAlE,CAAvB,EAA6F;MAC3F,MAAMC,eAAe,GAAG1B,UAAU,CAAE,kBAAiByB,KAAM,OAAzB,CAAlC;;MAEA,IAAIrB,mBAAJ,EAAyB;QAAE;QACzB,IAAI;UACF,MAAMW,MAAM,CAACb,aAAD,CAAZ;UACA,MAAM,IAAIyB,KAAJ,CAAU,mBAAV,CAAN;QACD,CAHD,CAGE,OAAOC,GAAP,EAAY;UACZxC,KAAK,CAAE,iBAAgBwC,GAAI,EAAtB,CAAL;UACA,IAAApB,YAAA,EAAOoB,GAAP,EAAYjB,EAAZ,CAAekB,EAAf,CAAkBC,EAAlB,CAAqB,OAArB;UACA,MAAMC,YAAY,GAAGH,GAAG,YAAYI,qBAAf,GAA+BJ,GAAG,CAACK,OAAJ,CAAYC,OAA3C,GAAqDN,GAAG,CAACM,OAA9E;UACA,MAAMC,WAAW,GAAGP,GAAG,YAAYI,qBAAf,GAA+BJ,GAAG,CAACQ,MAAnC,GAA4ChB,SAAhE;UACAhC,KAAK,CAAE,iBAAgB2C,YAAa,kBAAiBI,WAAY,EAA5D,CAAL;UACA,IAAA3B,YAAA,EAAOuB,YAAP,EAAqBpB,EAArB,CAAwB0B,KAAxB,CAA8B,IAAIvB,MAAJ,CAAWV,mBAAX,EAAgC,GAAhC,CAA9B;;UAEA,IAAIoB,mBAAJ,EAAyB;YACvB,IAAAhB,YAAA,EAAO2B,WAAP,EAAoBxB,EAApB,CAAuBkB,EAAvB,CAA0BL,mBAA1B;YACA;UACD;;UACD;QACD;MACF,CArB0F,CAuB3F;;;MACA,IAAI,CAACpB,mBAAL,EAA0B;QACxB,MAAMkC,OAAO,GAAG,MAAMvB,MAAM,CAACb,aAAD,CAA5B;QACA,IAAAM,YAAA,EAAO+B,aAAa,CAACD,OAAD,CAApB,EAA+B3B,EAA/B,CAAkC6B,GAAlC,CAAsCd,eAAtC;MACD;;MAED,SAASa,aAAT,CAAuBD,OAAvB,EAAgC;QAC9BlD,KAAK,CAACkD,OAAD,CAAL,CAD8B,CACd;;QAChB,OAAO,EACL,GAAGA,OADE;UAELG,OAAO,EAAEH,OAAO,CAACG,OAAR,CAAgBC,GAAhB,CAAoB,CAAC;YAACrB,MAAD;YAASsB;UAAT,CAAD,MAAmB;YAACA,EAAD;YAAKtB,MAAM,EAAEA,MAAM,CAACuB,QAAP;UAAb,CAAnB,CAApB;QAFJ,CAAP;MAID;IAEF;EACF;AACF,CAjFO,CAAR"}