fix(geolocation): remove geolocation utility, replace with new DDO service method - getLocation (#10547)

annawen1 · web-flow · commit 558faaf3b700 · 2023-06-07T22:18:31.000Z
### Related Ticket(s) [GeoLocation service]: API endpoint has been retired, switch to DDO #10546 ### Description As the API endpoint we were using before to detect user's location (country code) has been retired by the webmaster team, new method is to grab from the DDO (`digitalData.user.location`) populated by the IBM analytics script. This PR adds a new method the DDO service, which grabs the location from the DDO in the page and removes all instances of the geolocation utility which no longer works. ### Changelog **New** - `getLocation()` method under the DDO service - have the `Locale` service use the new DDO `getLocation` method instead **Removed** - instances of the `geolocation` utility
diff --git a/packages/react/.env.example b/packages/react/.env.example
@@ -13,9 +13,6 @@ SEARCH_TYPEAHEAD_API=<host for ibm.com search, e.g. https://www-api.ibm.com>
 MARKETING_SEARCH_VERSION=<api version for ibm.com marketing search, e.g. v3>
 MARKETING_SEARCH_HOST=<host for ibm.com marketing search, e.g. https://www.ibm.com>
 
-# Geolocation
-GEO_API=<endpoint for getting user country by geolocation>
-
 # VideoPlayer
 KALTURA_PARTNER_ID=<Kaltura partner id, e.g. 243342>
 KALTURA_UICONF_ID=<Kaltura uiconf id, e.g. 12905712>
diff --git a/packages/services/src/services/DDO/DDO.js b/packages/services/src/services/DDO/DDO.js
@@ -132,6 +132,19 @@ class DDOAPI {
       return root.digitalData.page.pageInfo.language;
     });
   }
+
+  /**
+   * Gets the country location of the user based on data populated by IBM analytics script.
+   * Application should `window.digitalData` up-front, e.g. in a `<script>` tag in `<head>`.
+   * For quick developerment purpose, what `ibm-common.js` automatically populates can be used.
+   *
+   * @returns {Promise<*>} Promise object
+   */
+  static async getLocation() {
+    return await this.isReady().then(() => {
+      return root.digitalData.user.location.country.toLowerCase();
+    });
+  }
 }
 
 export default DDOAPI;
diff --git a/packages/services/src/services/DDO/__tests__/DDO.test.js b/packages/services/src/services/DDO/__tests__/DDO.test.js
@@ -39,6 +39,12 @@ describe('DDOAPI', () => {
     expect(root.digitalData.page.pageInfo.version).toEqual('dds.v1.0.0');
   });
 
+  it('should return the country location', async () => {
+    await DDOAPI.getLocation();
+
+    expect(root.digitalData.user.location.country).toEqual('US');
+  });
+
   it('should set a loop if the data layer is not ready', async () => {
     root.digitalData.page.isDataLayerReady = false;
     jest.useFakeTimers();
diff --git a/packages/services/src/services/DDO/__tests__/data/response.json b/packages/services/src/services/DDO/__tests__/data/response.json
@@ -1,12 +1,7 @@
 {
   "page": {
     "attributes": {
-      "pageidQueryStrings": [
-        "q",
-        "s",
-        "tabType[0]",
-        "tabType%5B0%5D"
-      ],
+      "pageidQueryStrings": ["q", "s", "tabType[0]", "tabType%5B0%5D"],
       "agentMobileOS": "unknown"
     },
     "category": {
@@ -156,6 +151,11 @@
       "isCountryMemberOfEU": false,
       "isCountryRequiringExplicitConsent": false
     },
+    "location": {
+      "country": "US",
+      "stateProvince": "NJ",
+      "city": "NEWARK"
+    },
     "profile": {
       "dw": {},
       "ex": {},
diff --git a/packages/services/src/services/Locale/Locale.js b/packages/services/src/services/Locale/Locale.js
@@ -6,7 +6,7 @@
  */
 
 import axios from 'axios';
-import geolocation from '../../internal/vendor/@carbon/ibmdotcom-utilities/utilities/geolocation/geolocation';
+import { DDOAPI } from '../DDO';
 import ipcinfoCookie from '../../internal/vendor/@carbon/ibmdotcom-utilities/utilities/ipcinfoCookie/ipcinfoCookie';
 import root from 'window-or-global';
 
@@ -173,7 +173,7 @@ class LocaleAPI {
    *
    * Grab the locale from the `lang` attribute from html, else
    * check if ipcinfo cookie exists (ipcinfoCookie util)
-   * if not, retrieve the user's locale through geolocation util + gets user's
+   * if not, retrieve the user's locale through DDO service + gets user's
    * browser language preference then set the cookie
    *
    * @returns {object} object with lc and cc
@@ -197,7 +197,7 @@ class LocaleAPI {
       await this.getList(cookie);
       return cookie;
     } else {
-      const cc = await geolocation();
+      const cc = await DDOAPI.getLocation();
       /**
        * get language preference from browser
        * can return in either 'en-US' format or 'en' so will need to extract language only
diff --git a/packages/services/src/services/Locale/__tests__/Locale.test.js b/packages/services/src/services/Locale/__tests__/Locale.test.js
@@ -4,12 +4,10 @@
  * This source code is licensed under the Apache-2.0 license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import {
-  geolocation,
-  ipcinfoCookie,
-} from '../../../internal/vendor/@carbon/ibmdotcom-utilities';
+import { ipcinfoCookie } from '../../../internal/vendor/@carbon/ibmdotcom-utilities';
 import digitalDataResponse from '../../DDO/__tests__/data/response.json';
 import LocaleAPI from '../Locale';
+import { DDOAPI } from '../../DDO';
 import mockAxios from 'axios';
 import oldSession from './data/timestamp_response.json';
 import response from './data/response.json';
@@ -25,10 +23,11 @@ jest.mock(
   })
 );
 
-jest.mock(
-  '../../../internal/vendor/@carbon/ibmdotcom-utilities/utilities/geolocation/geolocation',
-  () => jest.fn(() => Promise.resolve('us'))
-);
+jest.mock('../../DDO', () => ({
+  DDOAPI: {
+    getLocation: jest.fn(() => Promise.resolve('us')),
+  },
+}));
 
 describe('LocaleAPI', () => {
   const handles = [];
@@ -445,33 +444,33 @@ describe('LocaleAPI', () => {
     expect(locale).toEqual({ cc: 'us', lc: 'en' });
   });
 
-  it('should get locale from geolocation on missing cookie', async () => {
+  it('should get locale from DDO on missing cookie', async () => {
     ipcinfoCookie.get.mockImplementation(() => false);
 
     await LocaleAPI.getLocale();
 
-    expect(geolocation).toHaveBeenCalledTimes(1);
+    expect(DDOAPI.getLocation).toHaveBeenCalledTimes(1);
   });
 
-  it('should get locale from geolocation on missing cookie lc', async () => {
-    geolocation.mockClear();
+  it('should get locale from DDO on missing cookie lc', async () => {
+    DDOAPI.getLocation.mockClear();
     ipcinfoCookie.get.mockImplementation(() => ({ cc: 'testCC' }));
 
     await LocaleAPI.getLocale();
 
-    expect(geolocation).toHaveBeenCalledTimes(1);
+    expect(DDOAPI.getLocation).toHaveBeenCalledTimes(1);
   });
 
-  it('should get locale from geolocation on missing cookie cc', async () => {
-    geolocation.mockClear();
+  it('should get locale from DDO on missing cookie cc', async () => {
+    DDOAPI.getLocation.mockClear();
     ipcinfoCookie.get.mockImplementation(() => ({ lc: 'testLC' }));
 
     await LocaleAPI.getLocale();
 
-    expect(geolocation).toHaveBeenCalledTimes(1);
+    expect(DDOAPI.getLocation).toHaveBeenCalledTimes(1);
   });
 
-  it('should get locale from geolocation', async () => {
+  it('should get locale from DDO', async () => {
     ipcinfoCookie.set.mockClear();
     ipcinfoCookie.get.mockImplementation(() => false);
 
@@ -483,7 +482,7 @@ describe('LocaleAPI', () => {
   });
 
   it('should get undefined locale on no cc', async () => {
-    geolocation.mockImplementation(() => Promise.resolve(false));
+    DDOAPI.getLocation.mockImplementation(() => Promise.resolve(false));
 
     const locale = await LocaleAPI.getLocale();
     expect(locale).toBeUndefined();
diff --git a/packages/utilities/carbon.yml b/packages/utilities/carbon.yml
@@ -2,13 +2,16 @@
 library:
   id: ibmdotcom-utilities
   name: IBM.com Utilities
-  description: Apply JavaScript ES6 utility classes that adhere to IBM’s web standards.
+  description:
+    Apply JavaScript ES6 utility classes that adhere to IBM’s web standards.
   externalDocsUrl: https://carbon-design-system.github.io/carbon-for-ibm-dotcom/utilities
   noIndex: true
 assets:
   altlangs:
     name: altlangs
-    description: Utility to grab all alternative languages on the page. this scrapes the page of all elements and returns as a readable object.
+    description:
+      Utility to grab all alternative languages on the page. this scrapes the
+      page of all elements and returns as a readable object.
     type: function
     platform: web
     status: stable
@@ -30,7 +33,9 @@ assets:
       - utility
   decode-string:
     name: decodeString
-    description: Utility function to parse and decode text content. Strings can become encoded for various reasons. This utility decodes those strings.
+    description:
+      Utility function to parse and decode text content. Strings can become
+      encoded for various reasons. This utility decodes those strings.
     type: function
     platform: web
     status: stable
@@ -63,7 +68,9 @@ assets:
       - utility
   ipc-info-cookie:
     name: ipcinfoCookie
-    description: Utility to set and get the ipcInfo cookie needed to determine country and language code.
+    description:
+      Utility to set and get the ipcInfo cookie needed to determine country and
+      language code.
     type: function
     platform: web
     status: stable
@@ -74,7 +81,11 @@ assets:
       - utility
   format-video-caption:
     name: formatVideoCaption
-    description: The default g11n formatter for video caption, combining video name and video duration. Components using this function should have a mechanism to allow translators to replace it with one accomodating the preferences of specific locale.
+    description:
+      The default g11n formatter for video caption, combining video name and
+      video duration. Components using this function should have a mechanism to
+      allow translators to replace it with one accomodating the preferences of
+      specific locale.
     type: function
     platform: web
     status: stable
@@ -85,7 +96,12 @@ assets:
       - utility
   format-video-duration:
     name: formatVideoDuration
-    description: The default g11n formatter for video duration. Components using this function should have a mechanism to allow translators to replace it with one accomodating the preferences of specific locale, or to replace it with general-purpose g11n formatting library. (e.g. moment, though it’s too big for us to make it a hard dependency)
+    description:
+      The default g11n formatter for video duration. Components using this
+      function should have a mechanism to allow translators to replace it with
+      one accomodating the preferences of specific locale, or to replace it with
+      general-purpose g11n formatting library. (e.g. moment, though it’s too big
+      for us to make it a hard dependency)
     type: function
     platform: web
     status: stable
@@ -94,20 +110,10 @@ assets:
     externalDocsUrl: https://carbon-design-system.github.io/carbon-for-ibm-dotcom/utilities/global.html#formatVideoDuration
     tags:
       - utility
-  geolocation:
-    name: geolocation
-    description: Utility to retrieve user’s country code based on their IP address
-    type: function
-    platform: web
-    status: stable
-    framework: vanilla
-    noIndex: true
-    externalDocsUrl: https://carbon-design-system.github.io/carbon-for-ibm-dotcom/utilities/global.html#geolocation
-    tags:
-      - utility
   load-non-latin-plex:
     name: loadNonLatinPlex
-    description: Utility to load in the corresponding non-Latin Plex font if necessary
+    description:
+      Utility to load in the corresponding non-Latin Plex font if necessary
     type: function
     platform: web
     status: stable
@@ -161,7 +167,8 @@ assets:
       - utility
   smooth-scroll:
     name: smoothScroll
-    description: Utility handles smoothScroll on the anchor element after onClick
+    description:
+      Utility handles smoothScroll on the anchor element after onClick
     type: function
     platform: web
     status: stable
diff --git a/packages/utilities/src/utilities/geolocation/__tests__/geolocation.test.js b/packages/utilities/src/utilities/geolocation/__tests__/geolocation.test.js
diff --git a/packages/utilities/src/utilities/geolocation/geolocation.js b/packages/utilities/src/utilities/geolocation/geolocation.js
diff --git a/packages/utilities/src/utilities/geolocation/index.js b/packages/utilities/src/utilities/geolocation/index.js
diff --git a/packages/utilities/src/utilities/index.js b/packages/utilities/src/utilities/index.js
@@ -12,7 +12,6 @@ export * from './deprecate';
 export * from './escaperegexp';
 export * from './featureflag';
 export * from './formatVideoCaption';
-export * from './geolocation';
 export * from './ipcinfoCookie';
 export * from './loadNonLatinPlex';
 export * from './markdownToHtml';
diff --git a/packages/web-components/.env.example b/packages/web-components/.env.example
@@ -13,9 +13,6 @@ SEARCH_TYPEAHEAD_API=<host for ibm.com search, e.g. https://www-api.ibm.com>
 MARKETING_SEARCH_VERSION=<api version for ibm.com marketing search, e.g. v3>
 MARKETING_SEARCH_HOST=<host for ibm.com marketing search, e.g. https://www.ibm.com>
 
-# Geolocation
-GEO_API=<endpoint for getting user country by geolocation>
-
 # VideoPlayer
 KALTURA_PARTNER_ID=<Kaltura partner id, e.g. 243342>
 KALTURA_UICONF_ID=<Kaltura uiconf id, e.g. 12905712>
