fix(exp-opportunities): bump the rumapi client version and rename the…

… audit

package.json

@@ -60,7 +60,7 @@
     "@adobe/spacecat-shared-data-access": "1.43.3",
     "@adobe/spacecat-shared-google-client": "1.2.2",
     "@adobe/spacecat-shared-http-utils": "1.6.8",
-    "@adobe/spacecat-shared-rum-api-client": "https://gitpkg.now.sh/adobe/spacecat-shared/packages/spacecat-shared-rum-api-client?0ffe830c28130f8ad8050a5c8ac0226ccd54e3b0",
+    "@adobe/spacecat-shared-rum-api-client": "2.9.0",
     "@adobe/spacecat-shared-rum-api-client-v1": "npm:@adobe/[email protected]",
     "@aws-sdk/client-lambda": "3.637.0",
     "@aws-sdk/credential-provider-node": "3.637.0",

src/opportunities/opportunities.js → src/experimentation-opportunities/experimentation-opportunities.js

@@ -10,7 +10,6 @@
  * governing permissions and limitations under the License.
  */
 
-/* c8 ignore start */
 import RUMAPIClient from '@adobe/spacecat-shared-rum-api-client';
 import { AuditBuilder } from '../common/audit-builder.js';
 import { getRUMDomainkey } from '../support/utils.js';
@@ -22,8 +21,6 @@ const OPPTY_QUERIES = [
   'high-organic-low-ctr',
 ];
 
-let log = console;
-
 /**
  * Audit handler container for all the opportunities
  * @param {*} auditUrl
@@ -32,10 +29,8 @@ let log = console;
  * @returns
  */
 
-export async function opportunitiesHandler(auditUrl, context, site) {
-  log = context.log;
-  log.info(`Received Opportunities audit request for ${auditUrl}`);
-  const startTime = process.hrtime();
+export async function handler(auditUrl, context, site) {
+  const { log } = context;
 
   const rumAPIClient = RUMAPIClient.createFrom(context);
   const domainkey = await getRUMDomainkey(site.getBaseURL(), context);
@@ -47,28 +42,18 @@ export async function opportunitiesHandler(auditUrl, context, site) {
   };
 
   const queryResults = await rumAPIClient.queryMulti(OPPTY_QUERIES, options);
-  const auditData = {
-    experimentationOpportunities: [],
-  };
-  for (const queryResult of Object.keys(queryResults)) {
-    if (OPPTY_QUERIES.includes(queryResult)) {
-      auditData.experimentationOpportunities.push(...queryResults[queryResult]);
-    }
-  }
-
-  const endTime = process.hrtime(startTime);
-  const elapsedSeconds = endTime[0] + endTime[1] / 1e9;
-  const formattedElapsed = elapsedSeconds.toFixed(2);
+  const experimentationOpportunities = Object.values(queryResults).flatMap((oppty) => oppty);
 
-  log.info(`Opportunities Audit is completed in ${formattedElapsed} seconds for ${auditUrl}`);
+  log.info(`Found ${experimentationOpportunities.length} many experimentation opportunites for ${auditUrl}`);
 
   return {
-    auditResult: auditData,
+    auditResult: {
+      experimentationOpportunities,
+    },
     fullAuditRef: auditUrl,
   };
 }
 
 export default new AuditBuilder()
-  .withRunner(opportunitiesHandler)
+  .withRunner(handler)
   .build();
-/* c8 ignore stop */

src/index.js

@@ -29,7 +29,7 @@ import experimentation from './experimentation/handler.js';
 import conversion from './conversion/handler.js';
 import essExperimentationDaily from './experimentation-ess/daily.js';
 import essExperimentationAll from './experimentation-ess/all.js';
-import opportunities from './opportunities/opportunities.js';
+import experimentationOpportunities from './experimentation-opportunities/experimentation-opportunities.js';
 import costs from './costs/handler.js';
 import structuredData from './structured-data/handler.js';
 
@@ -46,7 +46,7 @@ const HANDLERS = {
   conversion,
   'experimentation-ess-daily': essExperimentationDaily,
   'experimentation-ess-all': essExperimentationAll,
-  opportunities,
+  'experimentation-opportunities': experimentationOpportunities,
   costs,
   'structured-data': structuredData,
   dummy: (message) => ok(message),
@@ -68,7 +68,7 @@ async function run(message, context) {
   const { log } = context;
   const { type, url } = message;
 
-  log.info(`Audit req received for url: ${url}`);
+  log.info(`Received ${type} audit request for: ${url}`);
 
   const handler = HANDLERS[type];
   if (!handler) {
@@ -82,11 +82,11 @@ async function run(message, context) {
   try {
     const result = await (typeof handler.run === 'function' ? handler.run(message, context) : handler(message, context));
 
-    log.info(`Audit for ${type} completed in ${getElapsedSeconds(startTime)} seconds`);
+    log.info(`${type} audit for ${url} completed in ${getElapsedSeconds(startTime)} seconds`);
 
     return result;
   } catch (e) {
-    log.error(`Audit failed after ${getElapsedSeconds(startTime)} seconds`, e);
+    log.error(`${type} audit for ${url} failed after ${getElapsedSeconds(startTime)} seconds`, e);
     return internalServerError();
   }
 }

test/audits/opportunities.test.js → test/audits/experimentation-opportunities.test.js

@@ -16,7 +16,7 @@ import { expect, use } from 'chai';
 import sinon from 'sinon';
 import sinonChai from 'sinon-chai';
 import nock from 'nock';
-import { opportunitiesHandler } from '../../src/opportunities/opportunities.js';
+import { handler } from '../../src/experimentation-opportunities/experimentation-opportunities.js';
 import { MockContextBuilder } from '../shared.js';
 import opportunitiesData from '../fixtures/opportunitiesdata.json' assert { type: 'json' };
 
@@ -91,7 +91,7 @@ describe('Opportunities Tests', () => {
     const site = {
       getBaseURL: () => 'https://abc.com',
     };
-    const auditData = await opportunitiesHandler(url, context, site);
+    const auditData = await handler(url, context, site);
 
     const expected = Object.values(opportunitiesData).flatMap((data) => data);