3.2.0 Release

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+### Overview
+
+N/A
+
+### Change Details (Specifics)
+
+N/A
+
+### Related Ticket(s)
+
+N/A

.github/workflows/build.yml

@@ -12,7 +12,7 @@ on:
         type: boolean
         description: fail the build if vulnerabilities are found
         required: true 
-        default: false
+        default: true
 jobs:
   build:
     name: Build Image
@@ -102,4 +102,4 @@ jobs:
       with:
         status: ${{ job.status }}
         steps: ${{ toJson(steps) }}
-      if: always()
+      if: always()

.github/workflows/test.yml

@@ -0,0 +1,39 @@
+name: Test
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - "*.*.*"
+      - "main"
+      - "master"
+  pull_request:
+    branches:
+      - "*"
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Test Changes
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22.x"
+          cache: "npm"
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Run Vitest
+        run: npm run test:ci
+
+      - name: Coveralls GitHub Action
+        uses: coverallsapp/github-action@v2
+        continue-on-error: true

.gitignore

@@ -5,6 +5,7 @@
 /build
 
 # misc
+coverage
 .DS_Store
 .env
 .env.local

Dockerfile

@@ -1,10 +1,12 @@
-FROM node:22-alpine3.20 AS fnl_base_image
+FROM node:22-alpine3.23 AS fnl_base_image
 
 ENV PORT 8081
 ENV NODE_ENV production
 
 WORKDIR /usr/src/app
 
+RUN npm install -g npm@latest
+
 COPY package*.json ./
 
 RUN npm ci --only=production

README.md

@@ -1,4 +1,7 @@
-# CCDC Backend
+# C3DC Rest Backend
+
+[![Test](https://github.com/CBIIT/INS-REST-WebService/actions/workflows/test.yml/badge.svg)](https://github.com/CBIIT/INS-REST-WebService/actions/workflows/test.yml)
+[![Coverage Status](https://coveralls.io/repos/github/CBIIT/INS-REST-WebService/badge.svg?branch=copilot/sub-pr-39)](https://coveralls.io/github/CBIIT/INS-REST-WebService?branch=main)
 
 ## Table of Contents
 

Services/queryGenerator.js

@@ -169,41 +169,30 @@ queryGenerator.getFiltersClause = (filters) => {
   return clause;
 }
 
-queryGenerator.getTextSearchClause = (searchText) => {
-  const clause = {
-    'bool': {
-      'should': []
-    }
-  };
-  const strArr = searchText.trim().split(' ');
-  const result = strArr.map(
+queryGenerator.getTextSearchConditions = (searchText) => {
+  const conditions = [];
+  const searchTerms = searchText.trim().split(' ').map(
     term => term.trim()
   ).filter(
     term => term.length > 2
   );
-  const keywords = result.length === 0 ? '' : result.join(' ');
-
-  // No search terms, so return null
-  if (keywords == '') {
-    return null;
-  }
-
-  const termArr = keywords.split(' ').map((t) => t.trim());
-  const uniqueTermArr = termArr.filter((t, idx) => {
-    return termArr.indexOf(t) === idx;
+  const uniqueSearchTerms = searchTerms.filter((term, idx) => {
+    return searchTerms.indexOf(term) === idx;
   });
-  uniqueTermArr.filter((term) => term.trim() != '').forEach((term) => {
-    let dsl = {};
-    let searchTerm = term.trim();
 
-    dsl.multi_match = {
-      'query': searchTerm,
-      'fields': DATASET_FIELDS.map((field) => `${field}.search`),
+  // Add a search condition for finding each term in any of the dataset fields
+  uniqueSearchTerms.forEach((term) => {
+    const dsl = {
+      'multi_match': {
+        'query': term,
+        'fields': DATASET_FIELDS.map((field) => `${field}.search`),
+      }
     };
-    clause.bool.should.push(dsl);
+
+    conditions.push(dsl);
   });
 
-  return clause;
+  return conditions;
 };
 
 queryGenerator.getSearchQueryV2 = (searchText, filters, options, returnFields) => {
@@ -214,7 +203,7 @@ queryGenerator.getSearchQueryV2 = (searchText, filters, options, returnFields) =
     },
   };
   const filtersClause = queryGenerator.getFiltersClause(filters);
-  const textSearchClause = queryGenerator.getTextSearchClause(searchText);
+  const textSearchClause = queryGenerator.getTextSearchConditions(searchText);
 
   body['_source'] = returnFields;
 
@@ -228,7 +217,7 @@ queryGenerator.getSearchQueryV2 = (searchText, filters, options, returnFields) =
   }
 
   if (textSearchClause != null) {
-    compoundQuery.bool.must.push(textSearchClause);
+    compoundQuery.bool.must = textSearchClause;
   }
 
   if (compoundQuery.bool.must.length > 0 || compoundQuery.bool.filter) {
@@ -244,10 +233,10 @@ queryGenerator.getSearchQueryV2 = (searchText, filters, options, returnFields) =
   // body.aggs = agg;
   // Add sort parameters
   if (options?.sort) {
-    body.sort = [];
-    const tmp = {};
-    tmp[options.sort.k] = options.sort.v;
-    body.sort.push(tmp);
+    body.sort = []; // Initialize a list of sort clauses
+    const sortClause = {};
+    sortClause[options.sort.k] = options.sort.v; // In our API, "k" is the property name, and "v" is the direction
+    body.sort.push(sortClause);
   }
 
   body.highlight = {
@@ -305,17 +294,17 @@ queryGenerator.getDatasetFiltersQuery = (searchText, searchFilters, excludedFiel
       ([filterName]) => filterName != excludedField
     )
   ));
-  const textSearchClause = queryGenerator.getTextSearchClause(searchText);
+  const textSearchClause = queryGenerator.getTextSearchConditions(searchText);
 
   if (filtersClause != null) {
     compoundQuery.bool['filter'] = filtersClause;
   }
 
   if (textSearchClause != null) {
-    compoundQuery.bool.must.push(textSearchClause);
+    compoundQuery.bool.must = textSearchClause;
   }
 
-  if (compoundQuery.bool.must.length > 0) {
+  if (compoundQuery.bool.must.length > 0 || compoundQuery.bool.filter) {
     body.query = compoundQuery;
   }
 

Utils/index.test.js

@@ -0,0 +1,79 @@
+import { describe, it, expect } from 'vitest';
+const utils = require('./index.js');
+
+describe('getSearchableText', () => {
+  it('should return filtered text with terms longer than 2 characters', () => {
+    const result = utils.getSearchableText('hello world test');
+    expect(result).toBe('hello world test');
+  });
+
+  it('should filter out terms with 2 or fewer characters', () => {
+    const result = utils.getSearchableText('hello to a world');
+    expect(result).toBe('hello world');
+  });
+
+  it('should handle extra spaces between words', () => {
+    const result = utils.getSearchableText('hello   world   test');
+    expect(result).toBe('hello world test');
+  });
+
+  it('should handle leading and trailing spaces', () => {
+    const result = utils.getSearchableText('  hello world  ');
+    expect(result).toBe('hello world');
+  });
+
+  it('should return empty string when all terms are 2 or fewer characters', () => {
+    const result = utils.getSearchableText('a to in at');
+    expect(result).toBe('');
+  });
+
+  it('should return empty string for empty input', () => {
+    const result = utils.getSearchableText('');
+    expect(result).toBe('');
+  });
+
+  it('should return empty string for whitespace only input', () => {
+    const result = utils.getSearchableText('   ');
+    expect(result).toBe('');
+  });
+
+  it('should handle single word longer than 2 characters', () => {
+    const result = utils.getSearchableText('test');
+    expect(result).toBe('test');
+  });
+
+  it('should filter out single word with 2 or fewer characters', () => {
+    const result = utils.getSearchableText('at');
+    expect(result).toBe('');
+  });
+
+  it('should handle mixed case text', () => {
+    const result = utils.getSearchableText('Hello WORLD Test');
+    expect(result).toBe('Hello WORLD Test');
+  });
+
+  it('should preserve special characters in terms longer than 2 characters', () => {
+    const result = utils.getSearchableText('test-123 data@2024');
+    expect(result).toBe('test-123 data@2024');
+  });
+
+  it('should handle terms with exactly 3 characters', () => {
+    const result = utils.getSearchableText('the cat dog');
+    expect(result).toBe('the cat dog');
+  });
+
+  it('should filter terms with exactly 2 characters', () => {
+    const result = utils.getSearchableText('in on at to my cat');
+    expect(result).toBe('cat');
+  });
+
+  it('should filter terms with exactly 1 character', () => {
+    const result = utils.getSearchableText('a b c test hello');
+    expect(result).toBe('test hello');
+  });
+
+  it('should handle complex mixed input', () => {
+    const result = utils.getSearchableText('  a  hello   to  world  in  test  ');
+    expect(result).toBe('hello world test');
+  });
+});