Skip to content

Commit

Permalink
fix(FEC-7123): remove clientTag from default config and get it as par…
Browse files Browse the repository at this point in the history
…am (#30)
  • Loading branch information
yairans authored Sep 26, 2017
1 parent b4f143e commit 3a080e2
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 14 deletions.
1 change: 0 additions & 1 deletion src/k-provider/ovp/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ const defaultConfig: Object = {
beUrl: "http://www.kaltura.com/api_v3",
baseUrl: "https://cdnapisec.kaltura.com",
serviceParams: {
clientTag: "playkit-js",
apiVersion: '3.3.0',
format: 1
}
Expand Down
5 changes: 3 additions & 2 deletions src/k-provider/ovp/loaders/data-loader-manager.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,12 @@ export default class DataLoaderManager {

/**
* @constructor
* @param {string} pVersion The player version
* @param {string} partnerID Then partner ID
* @param {string} ks The ks
*/
constructor(partnerID: number, ks: string = "") {
this._multiRequest = OvpService.getMultirequest(ks, partnerID);
constructor(pVersion: string, partnerID: number, ks: string = "") {
this._multiRequest = OvpService.getMultirequest(pVersion, ks, partnerID);
}

/**
Expand Down
12 changes: 10 additions & 2 deletions src/k-provider/ovp/ovp-provider.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ export class OvpProvider {
* @type {number}
*/
partnerID: number;
/**
* @member - pVersion the player version
* @type {string}
* @private
*/
_pVersion: string;
/**
* @member - is anonymous
* @type {boolean}
Expand All @@ -61,11 +67,13 @@ export class OvpProvider {

/**
* @constructor
* @param {string} pVersion The player version
* @param {number} partnerID The partner ID
* @param {string} [ks=""] The provider ks (has empty string as default value)
* @param {Object} [config] The provider config(optional)
*/
constructor(partnerID: number, ks: string = "", config?: Object) {
constructor(pVersion: string, partnerID: number, ks: string = "", config?: Object) {
this._pVersion = pVersion;
this.partnerID = partnerID;
this.ks = ks;
this._isAnonymous = !this.ks;
Expand All @@ -83,7 +91,7 @@ export class OvpProvider {
if (uiConfId != null) {
this._uiConfId = uiConfId;
}
this._dataLoader = new DataLoaderManager(this.partnerID, this.ks);
this._dataLoader = new DataLoaderManager(this._pVersion, this.partnerID, this.ks);
return new Promise((resolve, reject) => {
if (this.validateParams(entryId, uiConfId)) {
let ks: string = this.ks;
Expand Down
5 changes: 3 additions & 2 deletions src/k-provider/ovp/services/ovp-service.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,15 @@ export default class OvpService {
/**
* Gets a new instance of MultiRequestBuilder with ovp params
* @function getMultirequest
* @param {string} pVersion The player version
* @param {string} ks The ks
* @param {string} partnerId The partner ID
* @returns {MultiRequestBuilder} The multi request builder
* @static
*/
static getMultirequest(ks: string, partnerId?: number): MultiRequestBuilder {
static getMultirequest(pVersion: string, ks: string, partnerId?: number): MultiRequestBuilder {
let ovpParams = config.serviceParams;
Object.assign(ovpParams, {ks: ks});
Object.assign(ovpParams, {ks: ks, clientTag: 'html5:v' + pVersion});
if (partnerId) {
Object.assign(ovpParams, {partnerId: partnerId});
}
Expand Down
5 changes: 3 additions & 2 deletions src/k-provider/ovp/services/stats-service.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,17 @@ export default class StatsService extends OvpService {
/**
* Creates an instance of RequestBuilder for stats.collect
* @function collect
* @param {string} pVersion The player version
* @param {string} ks - The ks
* @param {Object} event - The event data
* @param {string} baseUrl - The service base URL
* @returns {RequestBuilder} - The request builder
* @static
*/
static collect(ks: string, event: Object, baseUrl: string): RequestBuilder {
static collect(pVersion: string, ks: string, event: Object, baseUrl: string): RequestBuilder {
let ovpParams = Configuration.get();
let serviceParams = {};
Object.assign(serviceParams, ovpParams.serviceParams, {ks: ks}, event);
Object.assign(serviceParams, ovpParams.serviceParams, {ks: ks, clientTag: 'html5:v' + pVersion}, event);
let request = new RequestBuilder();
request.service = SERVICE_NAME;
request.action = "collect";
Expand Down
8 changes: 5 additions & 3 deletions test/src/k-provider/ovp/ovp-provider.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@ describe('OvpProvider.partnerId:1082342', function () {
let provider;
let sandbox;
let partnerId = 1082342;
let pVersion = '1.2.3';

beforeEach(() => {
sandbox = sinon.sandbox.create();
provider = new OvpProvider(partnerId);
provider = new OvpProvider(pVersion, partnerId);
});

afterEach(() => {
Expand Down Expand Up @@ -47,7 +48,7 @@ describe('OvpProvider.partnerId:1082342', function () {
it('should return config with plugins and without drm data', (done) => {
let entryID = "1_rsrdfext";
let uiConfID = 38621471;
provider = new OvpProvider(partnerId);
provider = new OvpProvider(pVersion, partnerId);
sinon.stub(MultiRequestBuilder.prototype, "execute").callsFake(
function () {
return new Promise((resolve) => {
Expand Down Expand Up @@ -124,10 +125,11 @@ describe('OvpProvider.partnerId:1068292', function () {
let sandbox;
let partnerId = 1068292;
let ks = 'NTAwZjViZWZjY2NjNTRkNGEyMjU1MTg4OGE1NmUwNDljZWJkMzk1MXwxMDY4MjkyOzEwNjgyOTI7MTQ5MDE3NjE0NjswOzE0OTAwODk3NDYuMDIyNjswO3ZpZXc6Kix3aWRnZXQ6MTs7';
let pVersion = '1.2.3';

beforeEach(() => {
sandbox = sinon.sandbox.create();
provider = new OvpProvider(partnerId, ks);
provider = new OvpProvider(pVersion, partnerId, ks);
});

afterEach(() => {
Expand Down
5 changes: 3 additions & 2 deletions test/src/k-provider/ovp/services/stats-service.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {param} from '../../../../../src/util/param'

describe('stats service - collect', function () {
let ovpParams, ks, event;
let pVersion = '1.2.3';

beforeEach(function () {
ovpParams = Configuration.get();
Expand All @@ -14,13 +15,13 @@ describe('stats service - collect', function () {

it('should be proper values', function () {
let baseUrl = 'some url';
let request = StatsService.collect(ks, event, baseUrl);
let request = StatsService.collect(pVersion, ks, event, baseUrl);
(request instanceof RequestBuilder).should.be.true;
request.service.should.be.equal('stats');
request.action.should.be.equal('collect');
request.method.should.be.equal('GET');
request.url.should.be.equal(baseUrl + '?service=' + request.service + '&action=' + request.action + '&' + param(request.params));
request.tag.should.be.equal('stats-collect');
request.params.should.deep.equal(Object.assign({}, ovpParams.serviceParams, {ks: ks}, event));
request.params.should.deep.equal(Object.assign({}, ovpParams.serviceParams, {ks: ks, clientTag: 'html5:v' + pVersion}, event));
});
});

0 comments on commit 3a080e2

Please sign in to comment.