feat(redirects): pass github token to data sources

fixes #480 (the "pass the x-github-token along" part)

src/BaseConfig.js

@@ -58,6 +58,15 @@ class BaseConfig {
     return this;
   }
 
+  /**
+   * Empty method to allow subclasses to intercept setting the
+   * GitHub token, if authentication option are provided in the
+   * repo options.
+   */
+  withGithubToken() {
+    return this;
+  }
+
   /**
    * Set the base repository to fetch a config from
    * @param {string} owner username or org
@@ -87,6 +96,9 @@ class BaseConfig {
       url,
       options,
     };
+    if (options && options.headers && /^token /.test(options.headers.authorization)) {
+      this.withGithubToken(options.headers.authorization.replace(/token /, ''));
+    }
     return this;
   }
 

src/DynamicRedirect.js

@@ -57,13 +57,19 @@ class DynamicRedirect {
     this._data = null;
     this._logger = logger;
     this._transactionID = null;
+    this._githubToken = null;
   }
 
   withTransactionID(id) {
     this._transactionID = id;
     return this;
   }
 
+  withGithubToken(token) {
+    this._githubToken = token;
+    return this;
+  }
+
   async fetch() {
     if (!this._data) {
       try {
@@ -78,6 +84,7 @@ class DynamicRedirect {
         const res = await fetch(url.href, {
           headers: {
             'x-request-id': this._transactionID,
+            'x-github-token': this._githubToken,
           },
         });
         const text = await res.text();

src/RedirectConfig.js

@@ -45,6 +45,11 @@ class RedirectConfig extends SchemaDerivedConfig {
     return this;
   }
 
+  withGithubToken(token) {
+    this.rrhandler.withGithubToken(token);
+    return this;
+  }
+
   async match(path) {
     const resolved = await Promise.all(this.redirects.map((redirect) => redirect.match(path)));
     return resolved.find((o) => o);

src/RedirectRuleHandler.js

@@ -23,6 +23,11 @@ const RedirectRuleHandler = () => ({
     return this;
   },
 
+  withGithubToken(token) {
+    this._token = token;
+    return this;
+  },
+
   get(target, prop) {
     const index = Number.parseInt(prop, 10);
     if (!Number.isNaN(index) && index >= 0) {
@@ -32,6 +37,7 @@ const RedirectRuleHandler = () => ({
         return new Redirect(item);
       }
       return new DynamicRedirect(item, this.logger)
+        .withGithubToken(this._token)
         .withTransactionID(this._transactionID);
     }
     return target[prop];

test/redirectconfigs.test.js

@@ -31,6 +31,7 @@ describe('Redirects Config Loading (from GitHub)', () => {
 
     server.get('https://adobeioruntime.net/api/v1/web/helix/helix-services/:path').intercept((req, res) => {
       assert.equal(req.headers['x-request-id'], 'random');
+      assert.equal(req.headers['x-github-token'], 'fake');
 
       if (req.query.src.startsWith('https://adobe.sharepoint.com/')) {
         return res.status(200).json([
@@ -100,6 +101,7 @@ describe('Redirects Config Loading (from GitHub)', () => {
       .withCache({ maxSize: 1 })
       .withConfigPath(path.resolve(SPEC_ROOT, 'dynamic.yaml'))
       .withTransactionID('random')
+      .withGithubToken('fake')
       .init();
 
     assert.deepEqual(config.toJSON().redirects, [