akamai-edgegrid 3.1.4 → 3.3.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # RELEASE NOTES
 
+## 3.3.0 (Nov 08, 2022)
+
+#### IMPROVEMENTS:
+* Update various dependencies
+
+#### BUG FIXES
+* Fix adding `User-Agent` header to the request
+
+## 3.2.0 (Apr 26, 2022)
+
+#### IMPROVEMENTS:
+* Add Typescript declaration file ([#71](https://github.com/akamai/AkamaiOPEN-edgegrid-node/issues/71))
+
 ## 3.1.4 (Mar 24, 2022)
 
 #### IMPROVEMENTS:

package/index.d.ts

@@ -0,0 +1,33 @@
+import { AxiosError, AxiosResponse } from "axios";
+
+declare class EdgeGrid {
+    constructor(clientTokenOrOptions: string | object,
+        clientSecret?: string,
+        accessToken?: string,
+        host?: string,
+        debug?: boolean);
+
+    request: object;
+    config: object;
+
+    /**
+    * Sends the request and invokes the callback function.
+    *
+    * @param  {Function} callback The callback function.
+    * @return EdgeGrid object (self)
+    */
+    send(callback: (error: AxiosError, response?: AxiosResponse, body?: string) => void): EdgeGrid;
+
+    /**
+    * Builds the request using the properties of the local config Object.
+     *
+    * @param  {Object} req The request Object. Can optionally contain a
+    *                      'headersToSign' property: An ordered list header names
+    *                      that will be included in the signature. This will be
+    *                      provided by specific APIs.
+    * @return EdgeGrid object (self)
+    */
+    auth(req: object): EdgeGrid;
+}
+
+export = EdgeGrid;

package/index.test-d.ts

@@ -0,0 +1,19 @@
+import { expectType } from 'tsd';
+import EdgeGrid = require('.')
+
+const eg = new EdgeGrid({
+    path: '/path/to/.edgerc',
+    section: 'section-name'
+});
+
+expectType<EdgeGrid>(eg)
+
+var req = {
+    path: '/diagnostic-tools/v1/locations',
+    method: 'GET',
+    headers: {},
+    body: 'bodyData'
+}
+expectType<EdgeGrid>(eg.auth(req))
+
+expectType<EdgeGrid>(eg.send((error, resp, body) => console.log(body)))

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "akamai-edgegrid",
-  "version": "3.1.4",
+  "version": "3.3.0",
   "description": "Authentication handler for the Akamai OPEN EdgeGrid Authentication scheme in Node.js",
   "main": "index.js",
   "scripts": {
-    "test": "EDGEGRID_ENV=test ./node_modules/.bin/mocha $(find test -name '*.js')"
+    "test": "EDGEGRID_ENV=test ./node_modules/.bin/mocha $(find test -name '*.js')",
+    "ci": "EDGEGRID_ENV=test MOCHA_FILE=./test/tests.xml nyc --reporter cobertura --report-dir test/coverage/ ./node_modules/.bin/mocha --reporter mocha-junit-reporter --reporter-options jenkinsMode=true --reporter-options antMode=true $(find test -name '*.js')"
   },
   "repository": {
     "type": "git",
@@ -24,12 +25,15 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
-    "axios": "^0.26.0",
+    "axios": "^1.1.2",
     "log4js": "^6.4.0",
-    "uuid": "^8.3.2"
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "mocha": "^9.1.3",
-    "nock": "^13.2.2"
+    "mocha": "^10.0.0",
+    "mocha-junit-reporter": "^2.1.0",
+    "nock": "^13.2.2",
+    "nyc": "^15.1.0",
+    "tsd": "^0.24.1"
   }
 }

package/src/api.js

@@ -48,24 +48,17 @@ const EdgeGrid = function (client_token, client_secret, access_token, host, debu
  * @return EdgeGrid object (self)
  */
 EdgeGrid.prototype.auth = function (req) {
-    let headers = {
-        'Content-Type': "application/json"
-    };
-    if (process.env['AKAMAI_CLI'] && process.env['AKAMAI_CLI_VERSION']) {
-        headers['User-Agent'] = (headers['User-Agent'] ? headers['User-Agent'] + " " : "") + `AkamaiCLI/${process.env['AKAMAI_CLI_VERSION']}`;
-    }
-    if (process.env['AKAMAI_CLI_COMMAND'] && process.env['AKAMAI_CLI_COMMAND_VERSION']) {
-        headers['User-Agent'] = (headers['User-Agent'] ? headers['User-Agent'] + " " : "") + `AkamaiCLI-${process.env['AKAMAI_CLI_COMMAND']}/${process.env['AKAMAI_CLI_COMMAND_VERSION']}`;
-    }
     req = helpers.extend(req, {
         baseURL: this.config.host,
         url: req.path,
         method: 'GET',
-        headers: headers,
+        headers: {},
         maxRedirects: 0,
         body: ''
     });
 
+    req.headers = helpers.extendHeaders(req.headers)
+
     let isTarball = req.body instanceof Uint8Array && req.headers['Content-Type'] === 'application/gzip';
 
     // Convert body object to properly formatted string
@@ -90,6 +83,12 @@ EdgeGrid.prototype.auth = function (req) {
     return this;
 };
 
+/**
+ * Sends the request and invokes the callback function.
+ *
+ * @param  {Function} callback The callback function.
+ * @return EdgeGrid object (self)
+ */
 EdgeGrid.prototype.send = function (callback) {
     axios(this.request).then(response => {
         callback(null, response, JSON.stringify(response.data));

package/src/helpers.js

@@ -108,7 +108,7 @@ module.exports = {
         return dataToSignStr;
     },
 
-    extend: function (a, b) {
+     extend: function (a, b) {
         let key;
 
         for (key in b) {
@@ -120,6 +120,27 @@ module.exports = {
         return a;
     },
 
+    extendHeaders: function (headers) {
+        if (!headers.hasOwnProperty('Content-Type')) {
+            headers['Content-Type'] = "application/json";
+        }
+
+        let userAgents = [headers['User-Agent']];
+        if (process.env['AKAMAI_CLI'] && process.env['AKAMAI_CLI_VERSION']) {
+            userAgents.push(`AkamaiCLI/${process.env['AKAMAI_CLI_VERSION']}`);
+        }
+        if (process.env['AKAMAI_CLI_COMMAND'] && process.env['AKAMAI_CLI_COMMAND_VERSION']) {
+            userAgents.push(`AkamaiCLI-${process.env['AKAMAI_CLI_COMMAND']}/${process.env['AKAMAI_CLI_COMMAND_VERSION']}`);
+        }
+
+        userAgents = userAgents.filter(v => v)
+        if (userAgents.length > 0) {
+            headers['User-Agent'] = userAgents.join(' ')
+        }
+
+        return headers;
+    },
+
     isRedirect: function (statusCode) {
         return [
             300, 301, 302, 303, 307

package/test/src/api_test.js

@@ -186,6 +186,10 @@ describe('Api', function () {
             it('ensures a url is properly declared', function () {
                 assert.strictEqual(this.api.request.url, 'https://base.com/foo');
             });
+
+            it('ensures no User-Agent is added when AkamaiCLI env variables not set', function () {
+                assert.ok(!this.api.request.headers.hasOwnProperty('User-Agent'));
+            })
         });
 
         describe('when more specific request options are passed', function () {
@@ -196,7 +200,10 @@ describe('Api', function () {
                     body: {
                         foo: 'bar'
                     },
-                    somethingArbitrary: 'someValue'
+                    somethingArbitrary: 'someValue',
+                    headers: {
+                        'User-Agent': 'testUserAgent'
+                    }
                 });
             });
 
@@ -220,6 +227,10 @@ describe('Api', function () {
             it('extends the default request options with any others specified', function () {
                 assert.strictEqual(this.api.request.somethingArbitrary, 'someValue');
             });
+
+            it('ensures provided User-Agent header is preserved', function () {
+                assert.strictEqual(this.api.request.headers['User-Agent'], 'testUserAgent');
+            });
         });
 
         describe("when gzip response format is expected", function () {
@@ -248,6 +259,77 @@ describe('Api', function () {
                 assert.strictEqual(this.api.request["responseType"], "arraybuffer");
             });
         });
+
+        describe("when akamai cli user agent is expected", function () {
+            beforeEach(function () {
+                process.env['AKAMAI_CLI'] = 'AkamaiCLI';
+                process.env['AKAMAI_CLI_VERSION'] = '1.0.0';
+                process.env['AKAMAI_CLI_COMMAND'] = 'command';
+                process.env['AKAMAI_CLI_COMMAND_VERSION'] = '0.0.1';
+            });
+
+            afterEach(function () {
+                process.env['AKAMAI_CLI'] = '';
+                process.env['AKAMAI_CLI_VERSION'] = '';
+                process.env['AKAMAI_CLI_COMMAND'] = '';
+                process.env['AKAMAI_CLI_COMMAND_VERSION'] = '';
+            })
+
+            describe("when no User-Agent set in the request", function () {
+                beforeEach(function () {
+                    this.api.auth({
+                        path: '/foo'
+                    });
+                });
+
+                it("should set User-Agent", function () {
+                    assert.strictEqual(this.api.request.headers['User-Agent'], 'AkamaiCLI/1.0.0 AkamaiCLI-command/0.0.1');
+                });
+            });
+
+            describe("when User-Agent is already in the request", function () {
+                beforeEach(function () {
+                    this.api.auth({
+                        path: '/foo',
+                        headers: {
+                            'User-Agent': 'testAgent'
+                        }
+                    });
+                });
+
+                it("should append to already present User-Agent header", function () {
+                    assert.strictEqual(this.api.request.headers['User-Agent'], 'testAgent AkamaiCLI/1.0.0 AkamaiCLI-command/0.0.1');
+                });
+            });
+
+            describe("when only AkamaiCLI info is set", function () {
+                beforeEach(function () {
+                    process.env['AKAMAI_CLI_COMMAND'] = '';
+                    process.env['AKAMAI_CLI_COMMAND_VERSION'] = '';
+                    this.api.auth({
+                        path: '/foo'
+                    });
+                });
+
+                it("should only set AkamaiCLI/version User-Agent", function () {
+                    assert.strictEqual(this.api.request.headers['User-Agent'], 'AkamaiCLI/1.0.0');
+                });
+            });
+
+            describe("when only AkamaiCLI command info is set", function () {
+                beforeEach(function () {
+                    process.env['AKAMAI_CLI'] = '';
+                    process.env['AKAMAI_CLI_VERSION'] = '';
+                    this.api.auth({
+                        path: '/foo'
+                    });
+                });
+
+                it("should only set AkamaiCLI/version User-Agent", function () {
+                    assert.strictEqual(this.api.request.headers['User-Agent'], 'AkamaiCLI-command/0.0.1');
+                });
+            });
+        });
     });
 
     describe('#send', function () {

package/test1/bundle.json

@@ -1,5 +0,0 @@
-{
-    "edgeworker-version": "1.0",
-    "description" : "Four Events"
-}
-

package/test1/main.js

@@ -1,15 +0,0 @@
-export function onClientRequest(request) {
-	request.addHeader('EW_CLIENT_REQ', 'Automation Client Req');
-}
-
-export function onClientResponse(request, response) {
-	response.addHeader('EW_CLIENT_RSP', 'Automation Client Rsp');
-}
-
-export function onOriginResponse(request, response) {
-  response.addHeader('EW_ORIGIN_RSP', 'Automation Origin Rsp');
-}
-
-export function onOriginRequest(request) {
-	request.addHeader('EW_ORIGIN_REQ', 'Automation Origin Req');
-}

package/test1 2/bundle.json

@@ -1,5 +0,0 @@
-{
-    "edgeworker-version": "1.0",
-    "description" : "Four Events"
-}
-

package/test1 2/main.js

@@ -1,15 +0,0 @@
-export function onClientRequest(request) {
-	request.addHeader('EW_CLIENT_REQ', 'Automation Client Req');
-}
-
-export function onClientResponse(request, response) {
-	response.addHeader('EW_CLIENT_RSP', 'Automation Client Rsp');
-}
-
-export function onOriginResponse(request, response) {
-  response.addHeader('EW_ORIGIN_RSP', 'Automation Origin Rsp');
-}
-
-export function onOriginRequest(request) {
-	request.addHeader('EW_ORIGIN_REQ', 'Automation Origin Req');
-}

package/test5/bundle.json

@@ -1,5 +0,0 @@
-{
-    "edgeworker-version": "1.0",
-    "description" : "Four Events"
-}
-

package/test5/main.js

@@ -1,15 +0,0 @@
-export function onClientRequest(request) {
-	request.addHeader('EW_CLIENT_REQ', 'Automation Client Req');
-}
-
-export function onClientResponse(request, response) {
-	response.addHeader('EW_CLIENT_RSP', 'Automation Client Rsp');
-}
-
-export function onOriginResponse(request, response) {
-  response.addHeader('EW_ORIGIN_RSP', 'Automation Origin Rsp');
-}
-
-export function onOriginRequest(request) {
-	request.addHeader('EW_ORIGIN_REQ', 'Automation Origin Req');
-}