azure/runtime/ms-rest/test/userAgentFilterTests.js

Microsoft Azure Client Library for node

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.

var assert = require('assert');
var should = require('should');

var UserAgentFilter = require('../lib/filters/msRestUserAgentFilter');
const userAgentHeader = 'user-agent';

describe('ms-rest user agent filter', function () {

  it('should construct user agent header when supplied empty array', function (done) {
    var callback = function () { return; };
    var mocknext = function (resource, cb) { return; };

    var userAgentArray = [];
    var userAgentFilter = UserAgentFilter.create(userAgentArray);
    var resource = { headers: {} };
    userAgentFilter(resource, mocknext, callback);

    resource.should.be.ok;
    resource.headers[userAgentHeader].should.containEql('Node');
    resource.headers[userAgentHeader].should.containEql('Azure-SDK-For-Node');
    done();
  });

  it('should not modify user agent header if already present', function (done) {
    var callback = function () { return; };
    var mocknext = function (resource, cb) { return; };
    var genericRuntime = 'ms-rest';
    var azureRuntime = 'ms-rest-azure';
    var azureSDK = 'Azure-SDK-For-Node';
    var userAgentArray = [`${genericRuntime}/v1.0.0`, `${azureRuntime}/v1.0.0`];

    var userAgentFilter = UserAgentFilter.create(userAgentArray);
    var customUA = 'my custom user agent';
    var resource = {
      headers: {
        'user-agent': customUA
      }
    };

    userAgentFilter(resource, mocknext, callback);

    resource.should.be.ok;
    var actualUA = resource.headers[userAgentHeader];
    
    actualUA.should.not.containEql('Node');
    actualUA.should.not.containEql(azureSDK);
    actualUA.should.not.containEql(azureRuntime);
    actualUA.should.containEql(customUA);

    done();
  });

  it('should insert azure-sdk-for-node at right position', function (done) {
    var callback = function () { return; };
    var mocknext = function (resource, cb) { return; };

    var genericRuntime = 'ms-rest';
    var azureRuntime = 'ms-rest-azure';
    var azureSDK = 'Azure-SDK-For-Node';
    var userAgentArray = [`${genericRuntime}/v1.0.0`, `${azureRuntime}/v1.0.0`];
    var userAgentFilter = UserAgentFilter.create(userAgentArray);
    var resource = { headers: {} };

    userAgentFilter(resource, mocknext, callback);
    resource.should.be.ok;

    var deconstructedUserAgent = resource.headers[userAgentHeader].split(' ');
    deconstructedUserAgent.should.be.ok;

    var indexOfAzureRuntime = deconstructedUserAgent.findIndex((e) => e.startsWith(azureRuntime));
    assert.notEqual(indexOfAzureRuntime, -1, `did not find ${azureRuntime} in user agent`);

    var indexOfAzureSDK = deconstructedUserAgent.indexOf(azureSDK);
    assert.notEqual(indexOfAzureSDK, -1, `did not find ${azureSDK} in user agent`);

    assert.equal(indexOfAzureSDK, 1 + indexOfAzureRuntime, `${azureSDK} is not in the right place in user agent string`);

    done();
  });
});