Fix/domain search incomplete (#384)

* filter out deprecated domains and other non registered domains.

* adding retry logic and a way to query the whole domain list.

* replace with constant

* fixed constant naming

* add test for domain list filtering

Author: just-at-uber

server/router/helpers/combine.js

@@ -0,0 +1,28 @@
+// Copyright (c) 2021 Uber Technologies Inc.
+//
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+const combine = data => (...callbacks) =>
+  callbacks.reduce(
+    (accumulator, callback) => (accumulator = callback(accumulator)),
+    data
+  );
+
+module.exports = combine;

server/router/helpers/index.js

@@ -20,6 +20,7 @@
 // THE SOFTWARE.
 
 const buildQueryString = require('./build-query-string');
+const combine = require('./combine');
 const delay = require('./delay');
 const isAdvancedVisibilityEnabled = require('./is-advanced-visibility-enabled');
 const listWorkflows = require('./list-workflows');
@@ -29,6 +30,7 @@ const replacer = require('./replacer');
 
 module.exports = {
   buildQueryString,
+  combine,
   delay,
   isAdvancedVisibilityEnabled,
   listWorkflows,

server/router/services/domain-service/constants.js

@@ -21,10 +21,14 @@
 
 const DOMAIN_LIST_DELAY_MS = 100;
 const DOMAIN_LIST_PAGE_SIZE = 100;
+const DOMAIN_LIST_RETRY_MAX = 3;
 const DOMAIN_LIST_SEARCH_SIZE = 10;
+const DOMAIN_STATUS_REGISTERED = 'REGISTERED';
 
 module.exports = {
   DOMAIN_LIST_DELAY_MS,
   DOMAIN_LIST_PAGE_SIZE,
+  DOMAIN_LIST_RETRY_MAX,
   DOMAIN_LIST_SEARCH_SIZE,
+  DOMAIN_STATUS_REGISTERED,
 };

server/router/services/domain-service/helpers/fetch-domain-list-next-page.js

@@ -19,20 +19,46 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-const { DOMAIN_LIST_DELAY_MS, DOMAIN_LIST_PAGE_SIZE } = require('../constants');
+const {
+  DOMAIN_LIST_DELAY_MS,
+  DOMAIN_LIST_PAGE_SIZE,
+  DOMAIN_LIST_RETRY_MAX,
+} = require('../constants');
 const { delay } = require('../../../helpers');
 
 const fetchDomainListNextPage = async ({
   ctx,
   domainList = [],
   nextPageToken = '',
+  retryCount = 0,
 }) => {
-  const data = await ctx.cadence.listDomains({
-    pageSize: DOMAIN_LIST_PAGE_SIZE,
-    nextPageToken: nextPageToken
-      ? Buffer.from(encodeURIComponent(nextPageToken), 'base64')
-      : undefined,
-  });
+  let data;
+
+  if (retryCount >= DOMAIN_LIST_RETRY_MAX) {
+    return domainList;
+  }
+
+  try {
+    data = await ctx.cadence.listDomains({
+      pageSize: DOMAIN_LIST_PAGE_SIZE,
+      nextPageToken: nextPageToken
+        ? Buffer.from(encodeURIComponent(nextPageToken), 'base64')
+        : undefined,
+    });
+  } catch (error) {
+    console.error(
+      `fetchDomainListNextPage retry: ${retryCount} error: ${error.toString()}`
+    );
+
+    await delay(DOMAIN_LIST_DELAY_MS);
+
+    return fetchDomainListNextPage({
+      ctx,
+      nextPageToken,
+      domainList,
+      retryCount: retryCount + 1,
+    });
+  }
 
   domainList.splice(domainList.length, 0, ...data.domains);
 

server/router/services/domain-service/helpers/fetch-domain-list.js

@@ -19,13 +19,15 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
+const { combine } = require('../../../helpers');
 const fetchDomainListNextPage = require('./fetch-domain-list-next-page');
+const filterDomainList = require('./filter-domain-list');
 const sortDomainList = require('./sort-domain-list');
 
 const fetchDomainList = ctx => async () => {
   const domainList = await fetchDomainListNextPage({ ctx });
 
-  return sortDomainList(domainList);
+  return combine(domainList)(filterDomainList, sortDomainList);
 };
 
 module.exports = fetchDomainList;

server/router/services/domain-service/helpers/filter-domain-list.js

@@ -0,0 +1,29 @@
+// Copyright (c) 2021 Uber Technologies Inc.
+//
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+const { DOMAIN_STATUS_REGISTERED } = require('../constants');
+
+const filterDomainList = domainList =>
+  domainList.filter(
+    domain => domain.domainInfo.status === DOMAIN_STATUS_REGISTERED
+  );
+
+module.exports = filterDomainList;

server/router/services/domain-service/helpers/filter-domain-list.spec.js

@@ -0,0 +1,56 @@
+// Copyright (c) 2021 Uber Technologies Inc.
+//
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+import filterDomainList from './filter-domain-list';
+
+describe('filterDomainList', () => {
+  describe('when a registered domain is in domainList', () => {
+    const domainList = [
+      {
+        domainInfo: {
+          status: 'REGISTERED',
+        },
+      },
+    ];
+
+    it('should return this domain in the returned list.', () => {
+      const output = filterDomainList(domainList);
+
+      expect(output.length).toEqual(1);
+    });
+  });
+
+  describe('when a deprecated domain is in the domainList', () => {
+    const domainList = [
+      {
+        domainInfo: {
+          status: 'DEPRECATED',
+        },
+      },
+    ];
+
+    it('should not return this domain in the returned list.', () => {
+      const output = filterDomainList(domainList);
+
+      expect(output.length).toEqual(0);
+    });
+  });
+});

server/router/services/domain-service/helpers/index.js

@@ -21,13 +21,15 @@
 
 const fetchDomainListNextPage = require('./fetch-domain-list-next-page');
 const fetchDomainList = require('./fetch-domain-list');
+const filterDomainList = require('./filter-domain-list');
 const getDomainList = require('./get-domain-list');
 const getMatchingDomains = require('./get-matching-domains');
 const sortDomainList = require('./sort-domain-list');
 
 module.exports = {
   fetchDomainListNextPage,
   fetchDomainList,
+  filterDomainList,
   getDomainList,
   getMatchingDomains,
   sortDomainList,

server/router/services/domain-service/index.js

@@ -28,10 +28,14 @@ class DomainService {
 
   async searchDomains(ctx) {
     const { cacheManager } = this;
-    const { querystring } = ctx.query;
+    const { all, querystring } = ctx.query;
 
     const domainList = await getDomainList({ cacheManager, ctx });
 
+    if (all) {
+      return domainList;
+    }
+
     return getMatchingDomains({ domainList, querystring });
   }
 }