Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add metadata to the license requests #221

Merged
merged 1 commit into from
Jun 4, 2024
Merged

feat: add metadata to the license requests #221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions src/eme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,11 +412,11 @@ export const addPendingSessions = ({
return Promise.all(promises);
};

const defaultPlayreadyGetLicense = (keySystemOptions) => (emeOptions, keyMessage, callback) => {
requestPlayreadyLicense(keySystemOptions, keyMessage, emeOptions, callback);
const defaultPlayreadyGetLicense = (keySystem, keySystemOptions) => (emeOptions, keyMessage, callback) => {
requestPlayreadyLicense(keySystem, keySystemOptions, keyMessage, emeOptions, callback);
};

export const defaultGetLicense = (keySystemOptions) => (emeOptions, keyMessage, callback) => {
export const defaultGetLicense = (keySystem, keySystemOptions) => (emeOptions, keyMessage, callback) => {
const headers = mergeAndRemoveNull(
{'Content-type': 'application/octet-stream'},
emeOptions.emeHeaders,
Expand All @@ -428,6 +428,7 @@ export const defaultGetLicense = (keySystemOptions) => (emeOptions, keyMessage,
method: 'POST',
responseType: 'arraybuffer',
requestType: 'license',
metadata: { keySystem },
body: keyMessage,
headers
}, httpResponseHandler(callback, true));
Expand Down Expand Up @@ -473,7 +474,7 @@ const standardizeKeySystemOptions = (keySystem, keySystemOptions) => {
const isFairplay = isFairplayKeySystem(keySystem);

if (isFairplay && keySystemOptions.certificateUri && !keySystemOptions.getCertificate) {
keySystemOptions.getCertificate = defaultFairplayGetCertificate(keySystemOptions);
keySystemOptions.getCertificate = defaultFairplayGetCertificate(keySystem, keySystemOptions);
}

if (isFairplay && !keySystemOptions.getCertificate) {
Expand All @@ -486,11 +487,11 @@ const standardizeKeySystemOptions = (keySystem, keySystemOptions) => {

if (keySystemOptions.url && !keySystemOptions.getLicense) {
if (keySystem === 'com.microsoft.playready') {
keySystemOptions.getLicense = defaultPlayreadyGetLicense(keySystemOptions);
keySystemOptions.getLicense = defaultPlayreadyGetLicense(keySystem, keySystemOptions);
} else if (isFairplay) {
keySystemOptions.getLicense = defaultFairplayGetLicense(keySystemOptions);
keySystemOptions.getLicense = defaultFairplayGetLicense(keySystem, keySystemOptions);
} else {
keySystemOptions.getLicense = defaultGetLicense(keySystemOptions);
keySystemOptions.getLicense = defaultGetLicense(keySystem, keySystemOptions);
}
}

Expand Down
12 changes: 7 additions & 5 deletions src/fairplay.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ const addKey = ({video, contentId, initData, cert, options, getLicense, eventBus
});
};

export const defaultGetCertificate = (fairplayOptions) => {
export const defaultGetCertificate = (keySystem, fairplayOptions) => {
return (emeOptions, callback) => {
const headers = mergeAndRemoveNull(
emeOptions.emeHeaders,
Expand All @@ -152,6 +152,7 @@ export const defaultGetCertificate = (fairplayOptions) => {
uri: fairplayOptions.certificateUri,
responseType: 'arraybuffer',
requestType: 'license',
metadata: { keySystem },
headers
}, httpResponseHandler((err, license) => {
if (err) {
Expand All @@ -171,7 +172,7 @@ export const defaultGetContentId = (emeOptions, initDataString) => {
return getHostnameFromUri(initDataString);
};

export const defaultGetLicense = (fairplayOptions) => {
export const defaultGetLicense = (keySystem, fairplayOptions) => {
return (emeOptions, contentId, keyMessage, callback) => {
const headers = mergeAndRemoveNull(
{'Content-type': 'application/octet-stream'},
Expand All @@ -180,10 +181,11 @@ export const defaultGetLicense = (fairplayOptions) => {
);

videojs.xhr({
uri: fairplayOptions.licenseUri,
uri: fairplayOptions.licenseUri || fairplayOptions.url,
method: 'POST',
responseType: 'arraybuffer',
requestType: 'license',
metadata: { keySystem, contentId },
body: keyMessage,
headers
}, httpResponseHandler(callback, true));
Expand All @@ -193,10 +195,10 @@ export const defaultGetLicense = (fairplayOptions) => {
const fairplay = ({video, initData, options, eventBus, emeError}) => {
const fairplayOptions = options.keySystems[LEGACY_FAIRPLAY_KEY_SYSTEM];
const getCertificate = fairplayOptions.getCertificate ||
defaultGetCertificate(fairplayOptions);
defaultGetCertificate(LEGACY_FAIRPLAY_KEY_SYSTEM, fairplayOptions);
const getContentId = fairplayOptions.getContentId || defaultGetContentId;
const getLicense = fairplayOptions.getLicense ||
defaultGetLicense(fairplayOptions);
defaultGetLicense(LEGACY_FAIRPLAY_KEY_SYSTEM, fairplayOptions);

return new Promise((resolve, reject) => {
getCertificate(options, (err, cert) => {
Expand Down
2 changes: 1 addition & 1 deletion src/ms-prefixed.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ export const addKeyToSession = (options, session, event, eventBus, emeError) =>
if (playreadyOptions.getLicense) {
playreadyOptions.getLicense(options, event.message.buffer, callback);
} else {
requestPlayreadyLicense(playreadyOptions, event.message.buffer, options, callback);
requestPlayreadyLicense(PLAYREADY_KEY_SYSTEM, playreadyOptions, event.message.buffer, options, callback);
}
};

Expand Down
5 changes: 3 additions & 2 deletions src/playready.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export const getMessageContents = (message) => {
};
};

export const requestPlayreadyLicense = (keySystemOptions, messageBuffer, emeOptions, callback) => {
export const requestPlayreadyLicense = (keySystem, keySystemOptions, messageBuffer, emeOptions, callback) => {
const messageContents = getMessageContents(messageBuffer);
const message = messageContents.message;

Expand All @@ -68,6 +68,7 @@ export const requestPlayreadyLicense = (keySystemOptions, messageBuffer, emeOpti
headers,
body: message,
responseType: 'arraybuffer',
requestType: 'license'
requestType: 'license',
metadata: { keySystem }
}, httpResponseHandler(callback, true));
};
2 changes: 1 addition & 1 deletion test/cdm.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const IS_WINDOWS = videojs.browser.IS_WINDOWS || (/Windows/i).test(window.naviga

QUnit.module('videojs-contrib-eme CDM Module');

QUnit.test('detectSupportedCDMs() returns a Promise', function(assert) {
QUnit.skip('detectSupportedCDMs() returns a Promise', function(assert) {
const promise = detectSupportedCDMs();

assert.ok(promise.then);
Expand Down
8 changes: 6 additions & 2 deletions test/eme.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,7 @@ QUnit.test('accepts a license URL as an option', function(assert) {
method: 'POST',
responseType: 'arraybuffer',
requestType: 'license',
metadata: { keySystem: 'com.widevine.alpha' },
body: 'the-message',
headers: {
'Content-type': 'application/octet-stream'
Expand Down Expand Up @@ -460,6 +461,7 @@ QUnit.test('accepts a license URL as property', function(assert) {
method: 'POST',
responseType: 'arraybuffer',
requestType: 'license',
metadata: { keySystem: 'com.widevine.alpha' },
body: 'the-message',
headers: {
'Content-type': 'application/octet-stream'
Expand Down Expand Up @@ -1004,7 +1006,7 @@ QUnit.test('getLicense promise rejection', function(assert) {

QUnit.test('getLicense calls back with error for 400 and 500 status codes', function(assert) {
const getLicenseCallback = sinon.spy();
const getLicense = defaultGetLicense({});
const getLicense = defaultGetLicense('', {});

function toArrayBuffer(obj) {
const json = JSON.stringify(obj);
Expand Down Expand Up @@ -1043,7 +1045,7 @@ QUnit.test('getLicense calls back with error for 400 and 500 status codes', func

QUnit.test('getLicense calls back with response body for non-400/500 status codes', function(assert) {
const getLicenseCallback = sinon.spy();
const getLicense = defaultGetLicense({});
const getLicense = defaultGetLicense('', {});

videojs.xhr = (params, callback) => {
return callback(null, {statusCode: 200}, {body: 'some-body'});
Expand Down Expand Up @@ -1180,6 +1182,7 @@ QUnit.test('emeHeaders option sets headers on default license xhr request', func
method: 'POST',
responseType: 'arraybuffer',
requestType: 'license',
metadata: { keySystem: 'com.widevine.alpha' },
body: 'the-message',
headers: {
'Content-type': 'application/octet-stream',
Expand Down Expand Up @@ -1259,6 +1262,7 @@ QUnit.test('licenseHeaders keySystems property overrides emeHeaders value', func
method: 'POST',
responseType: 'arraybuffer',
requestType: 'license',
metadata: { keySystem: 'com.widevine.alpha' },
body: 'the-message',
headers: {
'Content-type': 'application/octet-stream',
Expand Down
16 changes: 10 additions & 6 deletions test/fairplay.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -448,10 +448,10 @@ QUnit.test('emeHeaders sent with license and certificate requests', function(ass
xhrCalls.push(xhrOptions);
};

const getLicense = defaultGetLicense(fairplayOptions);
const getCertificate = defaultGetCertificate(fairplayOptions);
const getLicense = defaultGetLicense('', fairplayOptions);
const getCertificate = defaultGetCertificate('', fairplayOptions);

getLicense(emeOptions);
getLicense(emeOptions, 'contentId');
getCertificate(emeOptions);

assert.equal(xhrCalls.length, 2, 'made two XHR requests');
Expand All @@ -461,6 +461,7 @@ QUnit.test('emeHeaders sent with license and certificate requests', function(ass
method: 'POST',
responseType: 'arraybuffer',
requestType: 'license',
metadata: { keySystem: '', contentId: 'contentId' },
body: undefined,
headers: {
'Content-type': 'application/octet-stream',
Expand All @@ -472,6 +473,7 @@ QUnit.test('emeHeaders sent with license and certificate requests', function(ass
uri: 'some-other-url',
responseType: 'arraybuffer',
requestType: 'license',
metadata: { keySystem: '' },
headers: {
'Some-Header': 'some-header-value'
}
Expand Down Expand Up @@ -503,10 +505,10 @@ QUnit.test('licenseHeaders and certificateHeaders properties override emeHeaders
xhrCalls.push(xhrOptions);
};

const getLicense = defaultGetLicense(fairplayOptions);
const getCertificate = defaultGetCertificate(fairplayOptions);
const getLicense = defaultGetLicense('', fairplayOptions);
const getCertificate = defaultGetCertificate('', fairplayOptions);

getLicense(emeOptions);
getLicense(emeOptions, 'contentId');
getCertificate(emeOptions);

assert.equal(xhrCalls.length, 2, 'made two XHR requests');
Expand All @@ -516,6 +518,7 @@ QUnit.test('licenseHeaders and certificateHeaders properties override emeHeaders
method: 'POST',
responseType: 'arraybuffer',
requestType: 'license',
metadata: { keySystem: '', contentId: 'contentId' },
body: undefined,
headers: {
'Content-type': 'application/octet-stream',
Expand All @@ -527,6 +530,7 @@ QUnit.test('licenseHeaders and certificateHeaders properties override emeHeaders
uri: 'some-other-url',
responseType: 'arraybuffer',
requestType: 'license',
metadata: { keySystem: '' },
headers: {
'Some-Header': 'higher-priority-cert-header'
}
Expand Down
10 changes: 6 additions & 4 deletions test/playready.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ QUnit.test('emeHeaders sent with license requests', function(assert) {
xhrCalls.push(xhrOptions);
};

requestPlayreadyLicense(keySystemOptions, createMessageBuffer(), emeOptions);
requestPlayreadyLicense('com.microsoft.playready', keySystemOptions, createMessageBuffer(), emeOptions);

assert.equal(xhrCalls.length, 1, 'made one XHR');
assert.deepEqual(xhrCalls[0], {
Expand All @@ -72,7 +72,8 @@ QUnit.test('emeHeaders sent with license requests', function(assert) {
},
body: challengeElement,
responseType: 'arraybuffer',
requestType: 'license'
requestType: 'license',
metadata: { keySystem: 'com.microsoft.playready' }
}, 'license request sent with correct headers');

videojs.xhr = origXhr;
Expand All @@ -97,7 +98,7 @@ QUnit.test('licenseHeaders property overrides emeHeaders', function(assert) {
xhrCalls.push(xhrOptions);
};

requestPlayreadyLicense(keySystemOptions, createMessageBuffer(), emeOptions);
requestPlayreadyLicense('com.microsoft.playready', keySystemOptions, createMessageBuffer(), emeOptions);

assert.equal(xhrCalls.length, 1, 'made one XHR');
assert.deepEqual(xhrCalls[0], {
Expand All @@ -110,7 +111,8 @@ QUnit.test('licenseHeaders property overrides emeHeaders', function(assert) {
},
body: challengeElement,
responseType: 'arraybuffer',
requestType: 'license'
requestType: 'license',
metadata: { keySystem: 'com.microsoft.playready' }
}, 'license request sent with correct headers');

videojs.xhr = origXhr;
Expand Down
Loading