If no matching tags, do not attempt tag search (#5839)

* do not attempt search if no matching tags

* fix timing on test

* commit again in hopes that github will run checks

* add back null tag check

* add some better documentation to tests

Co-authored-by: Andrew Henry <[email protected]>

Author: scottbell

e2e/tests/functional/plugins/notebook/notebookWithCouchDB.e2e.spec.js

@@ -27,7 +27,7 @@ This test suite is dedicated to tests which verify the basic operations surround
 const { test, expect } = require('../../../../baseFixtures');
 const { createDomainObjectWithDefaults } = require('../../../../appActions');
 
-test.describe('Notebook Network Request Inspection @couchdb', () => {
+test.describe('Notebook Tests with CouchDB @couchdb', () => {
     let testNotebook;
     test.beforeEach(async ({ page }) => {
         //Navigate to baseURL
@@ -221,6 +221,45 @@ test.describe('Notebook Network Request Inspection @couchdb', () => {
 
         expect(filterNonFetchRequests(addingNotebookElementsRequests).length).toBeLessThanOrEqual(4);
     });
+
+    test('Search tests', async ({ page }) => {
+        test.info().annotations.push({
+            type: 'issue',
+            description: 'https://github.com/akhenry/openmct-yamcs/issues/69'
+        });
+        await page.locator('text=To start a new entry, click here or drag and drop any object').click();
+        await page.locator('[aria-label="Notebook Entry Input"]').click();
+        await page.locator('[aria-label="Notebook Entry Input"]').fill(`First Entry`);
+        await page.locator('[aria-label="Notebook Entry Input"]').press('Enter');
+
+        // Add three tags
+        await page.hover(`button:has-text("Add Tag")`);
+        await page.locator(`button:has-text("Add Tag")`).click();
+        await page.locator('[placeholder="Type to select tag"]').click();
+        await page.locator('[aria-label="Autocomplete Options"] >> text=Science').click();
+        await page.waitForSelector('[aria-label="Tag"]:has-text("Science")');
+
+        await page.hover(`button:has-text("Add Tag")`);
+        await page.locator(`button:has-text("Add Tag")`).click();
+        await page.locator('[placeholder="Type to select tag"]').click();
+        await page.locator('[aria-label="Autocomplete Options"] >> text=Drilling').click();
+        await page.waitForSelector('[aria-label="Tag"]:has-text("Drilling")');
+
+        await page.hover(`button:has-text("Add Tag")`);
+        await page.locator(`button:has-text("Add Tag")`).click();
+        await page.locator('[placeholder="Type to select tag"]').click();
+        await page.locator('[aria-label="Autocomplete Options"] >> text=Driving').click();
+        await page.waitForSelector('[aria-label="Tag"]:has-text("Driving")');
+
+        await page.locator('[aria-label="OpenMCT Search"] input[type="search"]').click();
+        await page.locator('[aria-label="OpenMCT Search"] input[type="search"]').fill('Sc');
+        await expect(page.locator('[aria-label="Search Result"]').first()).toContainText("Science");
+        await expect(page.locator('[aria-label="Search Result"]').first()).not.toContainText("Driving");
+
+        await page.locator('[aria-label="OpenMCT Search"] input[type="search"]').click();
+        await page.locator('[aria-label="OpenMCT Search"] input[type="search"]').fill('Xq');
+        await expect(page.locator('text=No results found')).toBeVisible();
+    });
 });
 
 // Try to reduce indeterminism of browser requests by only returning fetch requests.

e2e/tests/functional/plugins/notebook/tags.e2e.spec.js

@@ -116,7 +116,7 @@ test.describe('Tagging in Notebooks @addInit', () => {
 
         await page.locator('[aria-label="OpenMCT Search"] input[type="search"]').click();
         await page.locator('[aria-label="OpenMCT Search"] input[type="search"]').fill('Xq');
-        await expect(page.locator('[aria-label="Search Result"]')).toBeHidden();
+        await expect(page.locator('text=No results found')).toBeVisible();
     });
 
     test('Can delete tags', async ({ page }) => {

src/api/annotation/AnnotationAPI.js

@@ -346,6 +346,10 @@ export default class AnnotationAPI extends EventEmitter {
     */
     async searchForTags(query, abortController) {
         const matchingTagKeys = this.#getMatchingTags(query);
+        if (!matchingTagKeys.length) {
+            return [];
+        }
+
         const searchResults = (await Promise.all(this.openmct.objects.search(matchingTagKeys, abortController, this.openmct.objects.SEARCH_TYPES.TAGS))).flat();
         const filteredDeletedResults = searchResults.filter((result) => {
             return !(result._deleted);

src/api/annotation/AnnotationAPISpec.js

@@ -185,5 +185,10 @@ describe("The Annotation API", () => {
             expect(results).toBeDefined();
             expect(results.length).toEqual(1);
         });
+        it("returns no tags for empty search", async () => {
+            const results = await openmct.annotation.searchForTags('q');
+            expect(results).toBeDefined();
+            expect(results.length).toEqual(0);
+        });
     });
 });

src/plugins/persistence/couch/CouchSearchProvider.js

@@ -90,6 +90,10 @@ class CouchSearchProvider {
     }
 
     searchForTags(tagsArray, abortSignal) {
+        if (!tagsArray || !tagsArray.length) {
+            return [];
+        }
+
         const filter = {
             "selector": {
                 "$and": [

src/ui/layout/search/GrandSearchSpec.js

@@ -232,6 +232,8 @@ describe("GrandSearch", () => {
     it("should render an object search result if new object added", async () => {
         const composition = openmct.composition.get(mockFolderObject);
         composition.add(mockNewObject);
+        // after adding, need to wait a beat for the folder to be indexed
+        await Vue.nextTick();
         await grandSearchComponent.$children[0].searchEverything('apple');
         await Vue.nextTick();
         const searchResults = document.querySelectorAll('[aria-label="New Apple Test Folder folder result"]');
@@ -271,6 +273,13 @@ describe("GrandSearch", () => {
         expect(annotationResults[1].innerText).toContain('Driving');
     });
 
+    it("should render no annotation search results if no match", async () => {
+        await grandSearchComponent.$children[0].searchEverything('Qbert');
+        await Vue.nextTick();
+        const annotationResults = document.querySelectorAll('[aria-label="Search Result"]');
+        expect(annotationResults.length).toBe(0);
+    });
+
     it("should preview object search results in edit mode if object clicked", async () => {
         await grandSearchComponent.$children[0].searchEverything('Folder');
         grandSearchComponent._provided.openmct.router.path = [mockDisplayLayout];