25824106726

Committed 13 May 2026 08:18PM UTC coverage: 56.422% (+12.0%) from 44.469%

Build # 25824106726

Build Type

Pull #62

github

Committed by

web-flow

Commit Message

Merge d21bdb263 into 61c98c8d0

Pull Request Pull Request #62: INS-1615

Coverage Stats

309 of 498 branches covered (62.05%)

Branch coverage included in aggregate %.

297 of 417 new or added lines in 11 files covered. (71.22%)

36 existing lines in 1 file now uncovered.

574 of 1067 relevant lines covered (53.8%)

13.79 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

68.81

/Services/resourceQueryGenerator.js

1	const {
2	RESOURCE_HIGHLIGHT_FIELDS,
3	RESOURCE_IDENTIFIER_FIELD,
4	RESOURCE_SEARCH_FIELDS,
5	} = require('../Utils/resourceFields.js');	3✔
6
7	let queryGenerator = {};	3✔
8
9	queryGenerator.getSearchAggregationQuery = (searchText) => {	3✔
NEW 10	let body = {	×
11	size: 10,
12	from: 0
13	};
14
NEW 15	let compoundQuery = {};	×
NEW 16	compoundQuery.bool = {};	×
NEW 17	compoundQuery.bool.must = [];	×
18
NEW 19	const strArr = searchText.trim().split(" ");	×
NEW 20	const result = [];	×
NEW 21	strArr.forEach((term) => {	×
NEW 22	const t = term.trim();	×
NEW 23	if (t.length > 2) {	×
NEW 24	result.push(t);	×
25	}
26	});
NEW 27	const keywords = result.length === 0 ? "" : result.join(" ");	×
NEW 28	if(keywords != ""){	×
NEW 29	const termArr = keywords.split(" ");	×
NEW 30	termArr.forEach((term) => {	×
NEW 31	let searchTerm = term.trim();	×
NEW 32	if(searchTerm != ""){	×
NEW 33	let clause = {};	×
NEW 34	clause.bool = {};	×
NEW 35	clause.bool.should = [];	×
NEW 36	let dsl = {};	×
NEW 37	dsl.multi_match = {};	×
NEW 38	dsl.multi_match.query = searchTerm;	×
39	//dsl.multi_match.analyzer = "standard_analyzer";
NEW 40	dsl.multi_match.fields = [	×
41	'resource_title',
42	// "data_resource_name",
43	// "resource_name",
44	// "desc",
45	// "primary_resource_scope",
46	// "poc",
47	// "poc_email",
48	// "published_in",
49	// "program_name",
50	// "project_name"
51	];
52	// clause.bool.should.push(dsl);
NEW 53	let nestedFields = [	×
54	];
NEW 55	nestedFields.map((f) => {	×
NEW 56	let idx = f.indexOf('.');	×
NEW 57	let parent = f.substring(0, idx);	×
NEW 58	dsl = {};	×
NEW 59	dsl.nested = {};	×
NEW 60	dsl.nested.path = parent;	×
NEW 61	dsl.nested.query = {};	×
NEW 62	dsl.nested.query.match = {};	×
NEW 63	dsl.nested.query.match[f] = {"query":searchTerm};	×
64	// clause.bool.should.push(dsl);
65	});
NEW 66	dsl = {};	×
NEW 67	dsl.nested = {};	×
NEW 68	dsl.nested.path = "projects";	×
NEW 69	dsl.nested.query = {};	×
NEW 70	dsl.nested.query.bool = {};	×
NEW 71	dsl.nested.query.bool.should = [];	×
NEW 72	let m = {};	×
NEW 73	m.match = {	×
74	"projects.p_k": searchTerm
75	};
76	// dsl.nested.query.bool.should.push(m);
NEW 77	m = {};	×
NEW 78	m.nested = {};	×
NEW 79	m.nested.path = "projects.p_v";	×
NEW 80	m.nested.query = {};	×
NEW 81	m.nested.query.match = {};	×
NEW 82	m.nested.query.match["projects.p_v.k"] = {"query":searchTerm};	×
83	// dsl.nested.query.bool.should.push(m);
84	// clause.bool.should.push(dsl);
85
NEW 86	dsl = {};	×
NEW 87	dsl.nested = {};	×
NEW 88	dsl.nested.path = "additional";	×
NEW 89	dsl.nested.query = {};	×
NEW 90	dsl.nested.query.bool = {};	×
NEW 91	dsl.nested.query.bool.should = [];	×
NEW 92	m = {};	×
NEW 93	m.match = {	×
94	"additional.attr_name": searchTerm
95	};
96	// dsl.nested.query.bool.should.push(m);
NEW 97	m = {};	×
NEW 98	m.nested = {};	×
NEW 99	m.nested.path = "additional.attr_set";	×
NEW 100	m.nested.query = {};	×
NEW 101	m.nested.query.match = {};	×
NEW 102	m.nested.query.match["additional.attr_set.k"] = {"query":searchTerm};	×
103	// dsl.nested.query.bool.should.push(m);
104	// clause.bool.should.push(dsl);
NEW 105	compoundQuery.bool.must.push(clause);	×
106	}
107	});
108	} else {
NEW 109	return null;	×
110	}
111
NEW 112	if (compoundQuery.bool.must.length > 0) {	×
NEW 113	body.query = compoundQuery;	×
114	}
115
NEW 116	let agg = {};	×
NEW 117	agg.myAgg = {};	×
NEW 118	agg.myAgg.terms = {};	×
NEW 119	agg.myAgg.terms.field = "dbGaP_phs";	×
NEW 120	agg.myAgg.terms.size = 1000;	×
121
122	// body.aggs = agg;
NEW 123	return body;	×
124	};
125
126	queryGenerator.getFiltersClause = (filters) => {	3✔
127	// Handle null or invalid parameter
128	if (	54✔
129	!filters \|\|	147✔
130	typeof filters !== 'object' \|\|
131	Array.isArray(filters)
132	) {
133	return null;	9✔
134	}
135
136	// Ignore filters with no values selected
137	const cleanedFilters = Object.fromEntries(	45✔
138	Object.entries(filters).filter(([field, values]) => Array.isArray(values) && values.length > 0)	68✔
139	);
140
141	// If no filters, then return null
142	if (Object.entries(cleanedFilters).length <= 0) {	45✔
143	return null;	9✔
144	}
145
146	const clause = Object.entries(cleanedFilters).map(([field, values]) => ({	66✔
147	'terms': {
148	[field]: values
149	}
150	}));
151
152	return clause;	36✔
153	}
154
155	queryGenerator.getHighlightClause = () => {	3✔
156	const fieldsMap = RESOURCE_HIGHLIGHT_FIELDS.reduce((acc, field) => {	30✔
157	acc[field] = { number_of_fragments: 0 };	360✔
158	return acc;	360✔
159	}, {});
160
161	return {	30✔
162	pre_tags: ["<b>"],
163	post_tags: ["</b>"],
164	fields: fieldsMap,
165	};
166	};
167
168	queryGenerator.getSortClause = (options) => {	3✔
169	// Handle null or wrong type
170	if (!options \|\| typeof options !== 'object' \|\| Array.isArray(options)) {	29✔
171	return null;	3✔
172	}
173
174	// Check whether a sort object exists
175	if (!options.sort \|\| typeof options.sort !== 'object' \|\| Array.isArray(options.sort)) {	26✔
176	return null;	3✔
177	}
178
179	// Check whether the sort object has a 'k' and 'v' property
180	if (!options.sort.k \|\| !options.sort.v) {	23!
NEW 181	return null;	×
182	}
183
184	// Check whether the sort property and direction are strings
185	if (typeof options.sort.k !== 'string' \|\| typeof options.sort.v !== 'string') {	23!
NEW 186	return null;	×
187	}
188
189	// Return the sort clause
190	return {	23✔
191	[options.sort.k]: options.sort.v,
192	};
193	};
194
195	queryGenerator.getTextSearchConditions = (searchText) => {	3✔
196	// Handle null parameter
197	if (!searchText \|\| typeof searchText !== 'string') {	54✔
198	return null;	15✔
199	}
200
201	const conditions = [];	39✔
202	const searchTerms = searchText.trim().split(' ').map(	39✔
203	term => term.trim()	75✔
204	).filter(
205	term => term.length > 2	75✔
206	);
207	const uniqueSearchTerms = searchTerms.filter((term, idx) => {	39✔
208	return searchTerms.indexOf(term) === idx;	72✔
209	});
210
211	// Check again that actual search terms exist
212	if (uniqueSearchTerms.length <= 0) {	39✔
213	return null;	3✔
214	}
215
216	// Add a search condition for finding each term in any of the resource fields
217	uniqueSearchTerms.forEach((term) => {	36✔
218	const dsl = {	72✔
219	'multi_match': {
220	'query': term,
221	'fields': RESOURCE_SEARCH_FIELDS,
222	}
223	};
224
225	conditions.push(dsl);	72✔
226	});
227
228	return conditions;	36✔
229	};
230
231	/**
232	* Constructs a search query for the resources index
233	* @param {String} searchText The text to search for
234	* @param {Object} filters The filters to apply
235	* @param {Object} options Sort and pagination options
236	* @param {Array} returnFields The fields to return
237	* @returns {Object\|null} The OpenSearch query body object, or a scroll request descriptor when deep pagination is required, or null if validation fails.
238	*/
239	queryGenerator.getSearchQueryV2 = (searchText, filters, options, returnFields) => {	3✔
240	const MAX_RESULT_WINDOW = 10000;	38✔
241	const DEFAULT_SCROLL_KEEPALIVE = '2m';	38✔
242
243	const body = {	38✔
244	from: 0,
245	size: 10,
246	};
247	const compoundQuery = {	38✔
248	'bool': {
249	},
250	};
251	let filtersClause;
252	let sortClause;
253	let textSearchClause;
254
255	// Check searchText type
256	// Loose null equality treats undefined as null
257	if (searchText != null && typeof searchText !== 'string') {	38✔
258	return null;	1✔
259	}
260
261	// Check filters type
262	if (filters != null && (typeof filters !== 'object' \|\| Array.isArray(filters))) {	37✔
263	return null;	2✔
264	}
265
266	// Check options type
267	if (options != null && (typeof options !== 'object' \|\| Array.isArray(options))) {	35✔
268	return null;	2✔
269	}
270
271	// Check returnFields type and length
272	if (!Array.isArray(returnFields) \|\| returnFields.length <= 0) {	33✔
273	return null;	4✔
274	}
275
276	filtersClause = queryGenerator.getFiltersClause(filters);	29✔
277	textSearchClause = queryGenerator.getTextSearchConditions(searchText);	29✔
278
279	body['_source'] = returnFields ?? false;	29!
280
281	// We already verified that options is the right type if it's not null
282	// We must still verify that options is truthy
283	if (options) {	26!
284	const pageSize = Number(options.pageInfo?.pageSize);	26✔
285	if (Number.isFinite(pageSize) && pageSize > 0) {	26✔
286	body.size = Math.trunc(pageSize);	18✔
287	}
288
289	const page = Number(options.pageInfo?.page);	26✔
290	if (Number.isFinite(page) && page > 0) {	26✔
291	body.from = body.size * (Math.trunc(page) - 1);	19✔
292	}
293	}
294
295	sortClause = queryGenerator.getSortClause(options);	29✔
296
297	if (sortClause != null) {	29✔
298	body.sort = [sortClause];	23✔
299	}
300
301	if (filtersClause != null) {	29✔
302	compoundQuery.bool['filter'] = filtersClause;	23✔
303	}
304
305	if (textSearchClause != null) {	29✔
306	compoundQuery.bool.must = textSearchClause;	20✔
307	}
308
309	if (compoundQuery.bool.must?.length > 0 \|\| compoundQuery.bool.filter) {	29✔
310	body.query = compoundQuery;	25✔
311	}
312
313	body.highlight = queryGenerator.getHighlightClause();	29✔
314
315	const requestedFrom = Number(body.from ?? 0);	29✔
316	const requestedSize = Number(body.size ?? 10);	38✔
317	const safeRequestedFrom = Number.isFinite(requestedFrom) ? requestedFrom : 0;	38✔
318	const safeRequestedSize = Number.isFinite(requestedSize) ? requestedSize : 10;	38✔
319	const needsScroll = (safeRequestedFrom + safeRequestedSize) > MAX_RESULT_WINDOW;	38✔
320
321	if (!needsScroll) {	25!
322	return body;	4✔
323	}
324
325	// Scroll requests should not rely on `from`/deep pagination; we fetch batches and discard until offset.
326	const scrollBody = {	4✔
327	...body,
328	from: 0,
329	};
330
331	return {	4✔
332	useScroll: true,
333	scroll: DEFAULT_SCROLL_KEEPALIVE,
334	requestedFrom: safeRequestedFrom,
335	requestedSize: safeRequestedSize,
336	body: scrollBody,
337	};
338	};
339
340	/**
341	* Generates a bucket aggregation query on resource properties
342	* @param {String} searchText The text to search for
343	* @param {Object} searchFilters The filters to apply
344	* @param {String} excludedField The field to exclude from the filters
345	* @returns {Object} Opensearch query to retrieve filter counts
346	*/
347	queryGenerator.getResourceFiltersQuery = (searchText, searchFilters, excludedField) => {	3✔
348	// Borrow some of the search query
349	const body = {};	6✔
350	const compoundQuery = {	6✔
351	'bool': {
352	'must': [],
353	},
354	};
355	const filtersClause = queryGenerator.getFiltersClause(Object.fromEntries(	6✔
356	Object.entries(searchFilters).filter( // Remove excluded field from filters
357	([filterName]) => filterName != excludedField	12✔
358	)
359	));
360	const textSearchClause = queryGenerator.getTextSearchConditions(searchText);	6✔
361
362	if (filtersClause != null) {	6!
363	compoundQuery.bool['filter'] = filtersClause;	6✔
364	}
365
366	if (textSearchClause != null) {	6!
367	compoundQuery.bool.must = textSearchClause;	6✔
368	}
369
370	if (compoundQuery.bool.must.length > 0 \|\| compoundQuery.bool.filter) {	6!
371	body.query = compoundQuery;	6✔
372	}
373
374	// Customize search query
375	body.aggs = {};	6✔
376	body.size = 0;	6✔
377
378	// Aggregate on the target field
379	body.aggs[excludedField] = {	6✔
380	'terms': {
381	'field': excludedField,
382	'order': {
383	'_key': 'asc'
384	},
385	'size': 100000
386	}
387	};
388
389	return body;	3✔
390	};
391	/**
392	* Generates a count query for Opensearch using the same filters as getSearchQueryV2 and getResourceFiltersQuery.
393	* @param {String} searchText The text to search for
394	* @param {Object} searchFilters The filters to apply
395	* @returns {Object} Opensearch count query
396	*/
397	queryGenerator.getResourceCountQuery = (searchText, searchFilters) => {	3✔
398	const body = {};	19✔
399
400	// Build the main compound query using existing query logic
401	const compoundQuery = {	19✔
402	'bool': {
403	'must': [],
404	},
405	};
406
407	const filtersClause = queryGenerator.getFiltersClause(searchFilters);	19✔
408	const textSearchClause = queryGenerator.getTextSearchConditions(searchText);	19✔
409
410	if (filtersClause != null) {	19✔
411	compoundQuery.bool['filter'] = filtersClause;	7✔
412	}
413
414	if (textSearchClause != null) {	19✔
415	compoundQuery.bool.must = textSearchClause;	10✔
416	}
417
418	if (compoundQuery.bool.must.length > 0 \|\| compoundQuery.bool.filter) {	19✔
419	body.query = compoundQuery;	13✔
420	}
421
422	return body;	3✔
423	};
424
425	queryGenerator.getResourceByIdQuery = (id) => {	3✔
426	return {	2✔
427	size: 1,
428	from: 0,
429	query: {
430	term: {
431	[RESOURCE_IDENTIFIER_FIELD]: id,
432	},
433	},
434	};
435	};
436
437	module.exports = queryGenerator;	3✔

CBIIT / INS-REST-WebService / 25824106726

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous