fix(upstream-list): use exact match search on upstream list [KHCP-11054]

Kong · Mar 12, 2024 · 84ff6ac · 84ff6ac
1 parent 6718c8d
commit 84ff6ac
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 6 deletions.
diff --git a/packages/entities/entities-shared/src/composables/tests/useFetchUrlBuilder.spec.ts b/packages/entities/entities-shared/src/composables/tests/useFetchUrlBuilder.spec.ts
@@ -48,7 +48,7 @@ describe('useFetchUrlBuilder()', () => {
     expect(builder(query)).toBe('http://foo.bar/entity/testQuery/')
   })
 
-  it('should apply correct query schema for konnect', () => {
+  it('should apply correct query schema for konnect when isExactMatch is not activated', () => {
     const config = {
       apiBaseUrl: '/',
       app: 'konnect',
@@ -68,4 +68,26 @@ describe('useFetchUrlBuilder()', () => {
 
     expect(builder(query)).toBe('http://foo.bar/entity?filter[name][contains]=testQuery')
   })
+
+  it('should apply correct query schema for konnect when isExactMatch activated', () => {
+    const config = {
+      apiBaseUrl: '/',
+      app: 'konnect',
+      controlPlaneId: 'default',
+      isExactMatch: true,
+    } as KonnectConfig
+
+    const builder = useFetchUrlBuilder(config, 'http://foo.bar/entity')
+
+    const query: FetcherParams = {
+      page: 1,
+      pageSize: 10,
+      offset: 0,
+      sortColumnKey: 'name',
+      sortColumnOrder: 'asc',
+      query: 'testQuery',
+    }
+
+    expect(builder(query)).toBe('http://foo.bar/entity/testQuery/')
+  })
 })
diff --git a/packages/entities/entities-shared/src/composables/useFetchUrlBuilder.ts b/packages/entities/entities-shared/src/composables/useFetchUrlBuilder.ts
@@ -33,12 +33,15 @@ export default function useFetchUrlBuilder(
     try {
       let urlWithParams: URL = new URL(baseRequestUrl.value.href)
       if (isExactMatch.value && query) {
-        // Using exact match
+        // handle
+        // 1) all konnect usage or
+        // 2) kongManager usage with _config.value.isExactMatch === true
         urlWithParams.search = '' // trim any query params
-        urlWithParams = _config.value.app === 'konnect'
-          ? new URL(`${urlWithParams.href}?filter[name][contains]=${query}`)
-          : new URL(`${urlWithParams.href}/${query}/`)
+        urlWithParams = _config.value.isExactMatch
+          ? new URL(`${urlWithParams.href}/${query}/`)
+          : new URL(`${urlWithParams.href}?filter[name][contains]=${query}`)
       } else {
+        // handle kongManager usage with _config.value.isExactMatch === false
         if (!isExactMatch.value) {
           // Using fuzzy match
           new URLSearchParams(query).forEach((value, key) => {

diff --git a/packages/entities/entities-shared/src/types/app-config.ts b/packages/entities/entities-shared/src/types/app-config.ts
@@ -16,6 +16,8 @@ export interface KonnectConfig extends BaseAppConfig {
   app: 'konnect'
   /** The control plane id */
   controlPlaneId: string
+  /** Should use exact match */
+  isExactMatch?: boolean
 }
 
 /** Base config properties for Kong Manager. All entity configs should extend this interface for the app. */

diff --git a/packages/entities/entities-upstreams-targets/docs/upstreams-list.md b/packages/entities/entities-upstreams-targets/docs/upstreams-list.md
@@ -84,7 +84,7 @@ A table component for upstreams.
     - type: `boolean`
     - required: `false`
     - default: `undefined`
-    - *Specific to Kong Manager*. Whether to use exact match.
+    - Whether to use exact match.
 
   - `disableSorting`:
     - type: `boolean`