Skip to content

refactor(rum): use resolveRumDomainKey from spacecat-shared-rum-api-client #2648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Kanishkavijay39 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

refactor(rum): use resolveRumDomainKey from spacecat-shared-rum-api-client #2648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c13a2f8
refactor(rum): use resolveRumDomainKey from spacecat-shared-rum-api-c…
Jun 19, 2026
3a42a1a
fix(rum): add error boundary around resolveRumDomainKey
Jun 19, 2026
001c046
Merge branch 'main' into SITES-46321-rum-domainkey-shared-helper
Kanishkavijay39 Jun 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@
"@adobe/spacecat-shared-http-utils": "1.29.1",
"@adobe/spacecat-shared-ims-client": "1.12.7",
"@adobe/spacecat-shared-launchdarkly-client": "1.3.0",
"@adobe/spacecat-shared-rum-api-client": "2.40.13",
"@adobe/spacecat-shared-rum-api-client": "2.43.1",
"@adobe/spacecat-shared-scrape-client": "2.6.3",
"@adobe/spacecat-shared-slack-client": "1.6.7",
"@adobe/spacecat-shared-tier-client": "1.5.1",
Expand Down
70 changes: 6 additions & 64 deletions src/support/rum-config-service.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,14 @@
* governing permissions and limitations under the License.
*/

import RUMAPIClient from '@adobe/spacecat-shared-rum-api-client';
import { resolveRumDomainKey } from '@adobe/spacecat-shared-rum-api-client';
import { Config } from '@adobe/spacecat-shared-data-access/src/models/site/config.js';

const RUM_CHECK_TIMEOUT_MS = 3000;

/**
* Checks whether the site has a RUM domain key and optionally persists the result.
*
* Tries candidates in priority order (override-first, www variants as fallback) and
* stops on the first successful domain key lookup. The 3 s timeout is a shared budget
* across the full candidate loop, not a per-domain limit.
* Candidate resolution and timeout logic live in the shared
* {@link resolveRumDomainKey} helper; this function owns only the save semantics.
*
* When called with the default { save: true }, this function applies the rumConfig
* update and saves the site internally.
Expand All @@ -41,70 +38,15 @@ const RUM_CHECK_TIMEOUT_MS = 3000;
* @returns {Promise<boolean>} true if a RUM domain key was found.
*/
export async function updateRumConfig(site, context, { save = true } = {}) {
const { log } = context;

const siteConfig = site.getConfig();
const overrideBaseURL = siteConfig.getFetchConfig()?.overrideBaseURL;

let overrideHostname = null;
if (overrideBaseURL) {
try {
overrideHostname = new URL(overrideBaseURL).hostname;
} catch {
log.warn(`[rum-config-service] Malformed overrideBaseURL for site ${site.getId()}: ${overrideBaseURL}, falling back to baseURL`);
}
}

const baseHostname = new URL(site.getBaseURL()).hostname;
const withWwwFallback = (d) => (d && !d.startsWith('www.') ? `www.${d}` : null);

const domains = [...new Set([
overrideHostname,
withWwwFallback(overrideHostname),
baseHostname,
withWwwFallback(baseHostname),
].filter(Boolean))];

let hasDomainKey = false;
let timeoutId;
let cancelled = false;

const rumApiClient = RUMAPIClient.createFrom(context);

try {
await Promise.race([
(async () => {
for (const domain of domains) {
if (cancelled) {
break;
}
try {
// eslint-disable-next-line no-await-in-loop
await rumApiClient.retrieveDomainkey(domain);
hasDomainKey = true;
return;
} catch (e) {
log.info(`[rum-config-service] RUM check failed for ${domain}: ${e.message}`);
}
}
if (!hasDomainKey) {
log.warn(`[rum-config-service] No domain key found across all candidates: ${domains.join(', ')}`);
}
})(),
new Promise((_, reject) => {
timeoutId = setTimeout(() => {
cancelled = true;
reject(new Error('RUM check timed out'));
}, RUM_CHECK_TIMEOUT_MS);
}),
]);
({ hasDomainKey } = await resolveRumDomainKey(site, context));
} catch (e) {
log.warn(`[rum-config-service] RUM check failed: ${e.message}`);
} finally {
clearTimeout(timeoutId);
context.log.warn(`[rum-config-service] resolveRumDomainKey failed: ${e.message}`);
}

if (save) {
const siteConfig = site.getConfig();
siteConfig.updateRumConfig(hasDomainKey);
site.setConfig(Config.toDynamoItem(siteConfig));
await site.save();
Expand Down
139 changes: 20 additions & 119 deletions test/support/rum-config-service.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,19 @@ describe('rum-config-service', () => {
const sandbox = sinon.createSandbox();

let updateRumConfig;
let retrieveDomainkeyStub;
let rumApiClientStub;
let resolveRumDomainKeyStub;
let toDynamoItemStub;
let site;
let siteConfig;
let context;

before(async () => {
retrieveDomainkeyStub = sandbox.stub();
rumApiClientStub = { retrieveDomainkey: retrieveDomainkeyStub };
resolveRumDomainKeyStub = sandbox.stub();
toDynamoItemStub = sandbox.stub().returns({});

({ updateRumConfig } = await esmock('../../src/support/rum-config-service.js', {
'@adobe/spacecat-shared-rum-api-client': {
default: { createFrom: () => rumApiClientStub },
resolveRumDomainKey: resolveRumDomainKeyStub,
},
'@adobe/spacecat-shared-data-access/src/models/site/config.js': {
Config: { toDynamoItem: toDynamoItemStub },
Expand All @@ -47,7 +45,6 @@ describe('rum-config-service', () => {
sandbox.reset();

siteConfig = {
getFetchConfig: sandbox.stub().returns({}),
updateRumConfig: sandbox.stub(),
};

Expand All @@ -63,60 +60,54 @@ describe('rum-config-service', () => {
});

describe('updateRumConfig', () => {
it('sets hasDomainKey true and saves when RUM key is found on base hostname', async () => {
retrieveDomainkeyStub.resolves('dom-key-abc');
it('returns true and saves when resolveRumDomainKey finds a key', async () => {
resolveRumDomainKeyStub.resolves({ hasDomainKey: true, timedOut: false });

const result = await updateRumConfig(site, context);

expect(result).to.be.true;
expect(resolveRumDomainKeyStub).to.have.been.calledOnceWith(site, context);
expect(siteConfig.updateRumConfig).to.have.been.calledOnceWith(true);
expect(toDynamoItemStub).to.have.been.calledOnceWith(siteConfig);
expect(site.setConfig).to.have.been.calledOnce;
expect(site.save).to.have.been.calledOnce;
});

it('falls back to www.example.com when example.com lookup fails', async () => {
retrieveDomainkeyStub
.withArgs('example.com').rejects(new Error('not found'))
.withArgs('www.example.com').resolves('dom-key-www');
it('returns false and saves when resolveRumDomainKey finds no key', async () => {
resolveRumDomainKeyStub.resolves({ hasDomainKey: false, timedOut: false });

const result = await updateRumConfig(site, context);

expect(result).to.be.true;
expect(retrieveDomainkeyStub).to.have.been.calledWith('example.com');
expect(retrieveDomainkeyStub).to.have.been.calledWith('www.example.com');
expect(siteConfig.updateRumConfig).to.have.been.calledOnceWith(true);
expect(result).to.be.false;
expect(siteConfig.updateRumConfig).to.have.been.calledOnceWith(false);
expect(toDynamoItemStub).to.have.been.calledOnceWith(siteConfig);
expect(site.setConfig).to.have.been.calledOnce;
expect(site.save).to.have.been.calledOnce;
});

it('sets hasDomainKey false and saves when all candidates fail', async () => {
retrieveDomainkeyStub.rejects(new Error('not found'));
it('returns false and saves when resolveRumDomainKey times out', async () => {
resolveRumDomainKeyStub.resolves({ hasDomainKey: false, timedOut: true });

const result = await updateRumConfig(site, context);

expect(result).to.be.false;
expect(siteConfig.updateRumConfig).to.have.been.calledOnceWith(false);
expect(toDynamoItemStub).to.have.been.calledOnceWith(siteConfig);
expect(site.setConfig).to.have.been.calledOnce;
expect(site.save).to.have.been.calledOnce;
});

it('sets hasDomainKey false and clears timer when RUM check times out', async () => {
retrieveDomainkeyStub.returns(new Promise(() => {})); // never resolves
it('returns false and saves when resolveRumDomainKey throws unexpectedly', async () => {
resolveRumDomainKeyStub.rejects(new Error('unexpected internal error'));

const clock = sinon.useFakeTimers();
const promise = updateRumConfig(site, context);
await clock.tickAsync(4000);
const result = await promise;
clock.restore();
const result = await updateRumConfig(site, context);

expect(result).to.be.false;
expect(context.log.warn).to.have.been.calledWithMatch(/resolveRumDomainKey failed/);
expect(siteConfig.updateRumConfig).to.have.been.calledOnceWith(false);
expect(site.setConfig).to.have.been.calledOnce;
expect(site.save).to.have.been.calledOnce;
});

it('skips config mutation and save when { save: false } is passed', async () => {
retrieveDomainkeyStub.resolves('dom-key-abc');
resolveRumDomainKeyStub.resolves({ hasDomainKey: true, timedOut: false });

const result = await updateRumConfig(site, context, { save: false });

Expand All @@ -125,95 +116,5 @@ describe('rum-config-service', () => {
expect(site.setConfig).to.not.have.been.called;
expect(site.save).to.not.have.been.called;
});

it('tries overrideBaseURL hostname first when set', async () => {
siteConfig.getFetchConfig.returns({ overrideBaseURL: 'https://override.example.com' });
retrieveDomainkeyStub
.withArgs('override.example.com').resolves('dom-key-override');

const result = await updateRumConfig(site, context);

expect(result).to.be.true;
expect(retrieveDomainkeyStub.firstCall.args[0]).to.equal('override.example.com');
expect(retrieveDomainkeyStub).to.have.been.calledOnce;
});

it('falls back through override www, base, and base www when override bare fails', async () => {
siteConfig.getFetchConfig.returns({ overrideBaseURL: 'https://override.example.com' });
retrieveDomainkeyStub.withArgs('override.example.com')
.rejects(new Error('not found'));
retrieveDomainkeyStub.withArgs('www.override.example.com')
.rejects(new Error('not found'));
retrieveDomainkeyStub.withArgs('example.com')
.rejects(new Error('not found'));
retrieveDomainkeyStub.withArgs('www.example.com')
.resolves('dom-key-www');

const result = await updateRumConfig(site, context);

expect(result).to.be.true;
expect(retrieveDomainkeyStub.args.map((a) => a[0])).to.deep.equal([
'override.example.com',
'www.override.example.com',
'example.com',
'www.example.com',
]);
});

it('does not duplicate www candidate when overrideBaseURL already has www', async () => {
siteConfig.getFetchConfig.returns({ overrideBaseURL: 'https://www.override.example.com' });
retrieveDomainkeyStub.resolves('dom-key-www');

await updateRumConfig(site, context);

const calledDomains = retrieveDomainkeyStub.args.map((a) => a[0]);
expect(calledDomains.filter((d) => d === 'www.override.example.com')).to.have.lengthOf(1);
});

it('falls back to baseURL when overrideBaseURL is malformed', async () => {
siteConfig.getFetchConfig.returns({ overrideBaseURL: 'not-a-valid-url' });
retrieveDomainkeyStub.resolves('dom-key-abc');

const result = await updateRumConfig(site, context);

expect(result).to.be.true;
expect(context.log.warn).to.have.been.calledWithMatch(/Malformed overrideBaseURL/);
expect(retrieveDomainkeyStub.firstCall.args[0]).to.equal('example.com');
});

it('does not add bare variant when baseURL already starts with www', async () => {
site = { ...site, getBaseURL: () => 'https://www.example.com' };
retrieveDomainkeyStub.resolves('dom-key-www');

const result = await updateRumConfig(site, context);

expect(result).to.be.true;
const calledDomains = retrieveDomainkeyStub.args.map((a) => a[0]);
expect(calledDomains).to.deep.equal(['www.example.com']);
});

it('stops iterating candidates once cancelled by timeout', async () => {
let rejectFirst;
retrieveDomainkeyStub.withArgs('example.com').returns(
new Promise((_, reject) => { rejectFirst = reject; }),
);
retrieveDomainkeyStub.withArgs('www.example.com').resolves('dom-key-www');

const clock = sinon.useFakeTimers();
const resultPromise = updateRumConfig(site, context);

await clock.tickAsync(4000); // fires timeout, sets cancelled=true
clock.restore();

rejectFirst(new Error('slow network'));
// drain microtasks so inner IIFE processes the rejection and checks cancelled
await new Promise(setImmediate);

const result = await resultPromise;

expect(result).to.be.false;
expect(retrieveDomainkeyStub).to.have.been.calledOnce;
expect(retrieveDomainkeyStub).not.to.have.been.calledWith('www.example.com');
});
});
});
Loading