Merge pull request #337 from adobe/issue-336

chore: set user agent header

src/extension/background.js

@@ -331,6 +331,37 @@ function checkViewDocSource(id) {
   });
 }
 
+/**
+ * Appends sidekick name and version to the user-agent header for all requests to
+ * admin.hlx.page and rum.hlx.page.
+ */
+async function setUserAgentHeader() {
+  // remove existing rule first
+  await chrome.declarativeNetRequest.updateDynamicRules({ removeRuleIds: [100] });
+  const manifest = chrome.runtime.getManifest();
+  await chrome.declarativeNetRequest.updateDynamicRules({
+    addRules: [
+      {
+        id: 100,
+        priority: 1,
+        action: {
+          type: 'modifyHeaders',
+          requestHeaders: [
+            {
+              operation: 'set',
+              header: 'user-agent',
+              value: `${navigator.userAgent} Sidekick/${manifest.version}`,
+            },
+          ],
+        },
+        condition: {
+          requestDomains: ['admin.hlx.page', 'rum.hlx.page'],
+        },
+      },
+    ],
+  });
+}
+
 /**
  * Sets the x-auth-token header for all requests to admin.hlx.page if project config
  * has an auth token.
@@ -408,6 +439,7 @@ async function storeAuthToken(owner, repo, token) {
     log.info(`sidekick extension installed (${reason})`);
     await updateHelpContent();
     await updateProjectConfigs();
+    await setUserAgentHeader();
     await updateAdminAuthHeaderRules();
   });
 

test/utils.js

@@ -708,7 +708,7 @@ export function Nock() {
   ) => {
     // nock stray rum requests
     nocker('https://rum.hlx.page/')
-      .get(/.*/)
+      .post(/.*/)
       .optionally()
       .reply(200)
       .persist();