From 3380d33d6f9c2c22a50b35a759519b90723f33a4 Mon Sep 17 00:00:00 2001 From: mister-ben <1676039+mister-ben@users.noreply.github.com> Date: Sun, 11 Aug 2024 08:21:10 +0200 Subject: [PATCH] chore: Remove safe-json-parse (#8790) ## Description Removes an old unmaintained dependency that isn't needed any more. ## Specific Changes proposed Replace safe-json-parse with `JSON.parse` ## Requirements Checklist - [x] Feature implemented / Bug fixed - [ ] If necessary, more likely in a feature request than a bug fix - [x] Change has been verified in an actual browser (Chrome, Firefox, IE) - [ ] Unit Tests updated or fixed - [ ] Docs/guides updated - [ ] Example created ([starter template on JSBin](https://codepen.io/gkatsev/pen/GwZegv?editors=1000#0)) - [x] Has no DOM changes which impact accessiblilty or trigger warnings (e.g. Chrome issues tab) - [x] Has no changes to JSDoc which cause `npm run docs:api` to error - [ ] Reviewed by Two Core Contributors --- package.json | 1 - src/js/player.js | 12 +++++------- test/unit/setup.test.js | 19 +++++++++++++++++++ test/unit/tracks/text-track-settings.test.js | 3 +-- 4 files changed, 25 insertions(+), 10 deletions(-) diff --git a/package.json b/package.json index 1e956ced2d..a221665d08 100644 --- a/package.json +++ b/package.json @@ -94,7 +94,6 @@ "m3u8-parser": "^7.1.0", "mpd-parser": "^1.2.2", "mux.js": "^7.0.1", - "safe-json-parse": "4.0.0", "videojs-contrib-quality-levels": "4.1.0", "videojs-font": "4.2.0", "videojs-vtt.js": "0.15.5" diff --git a/src/js/player.js b/src/js/player.js index e9c7300a56..8282f9c409 100644 --- a/src/js/player.js +++ b/src/js/player.js @@ -22,7 +22,6 @@ import { bufferedPercent } from './utils/buffer.js'; import * as stylesheet from './utils/stylesheet.js'; import FullscreenApi from './fullscreen-api.js'; import MediaError from './media-error.js'; -import safeParseTuple from 'safe-json-parse/tuple'; import {merge} from './utils/obj'; import {silencePromise, isPromise} from './utils/promise'; import textTrackConverter from './tracks/text-track-list-converter.js'; @@ -5231,13 +5230,12 @@ class Player extends Component { // Check if data-setup attr exists. if (dataSetup !== null) { // Parse options JSON - // If empty string, make it a parsable json object. - const [err, data] = safeParseTuple(dataSetup || '{}'); - - if (err) { - log.error(err); + try { + // If empty string, make it a parsable json object. + Object.assign(tagOptions, JSON.parse(dataSetup || '{}')); + } catch (e) { + log.error('data-setup', e); } - Object.assign(tagOptions, data); } Object.assign(baseOptions, tagOptions); diff --git a/test/unit/setup.test.js b/test/unit/setup.test.js index 3d0d2f505c..030235e793 100644 --- a/test/unit/setup.test.js +++ b/test/unit/setup.test.js @@ -1,5 +1,7 @@ /* eslint-env qunit */ import TestHelpers from './test-helpers.js'; +import sinon from 'sinon'; +import window from 'global/window'; QUnit.module('Setup'); @@ -19,3 +21,20 @@ QUnit.test('should set options from data-setup even if autoSetup is not called b assert.ok(player.options_.playsinline === true); player.dispose(); }); + +QUnit.test('should log an error if data-setup has invalid JSON', function(assert) { + const logError = sinon.spy(window.console, 'error'); + + const el = TestHelpers.makeTag(); + + el.setAttribute( + 'data-setup', + "{'controls': true}" + ); + + const player = TestHelpers.makePlayer({}, el); + + assert.ok(logError.calledWith('VIDEOJS:', 'ERROR:', 'data-setup')); + player.dispose(); + window.console.error.restore(); +}); diff --git a/test/unit/tracks/text-track-settings.test.js b/test/unit/tracks/text-track-settings.test.js index 6b8ffe4076..e20a93664a 100644 --- a/test/unit/tracks/text-track-settings.test.js +++ b/test/unit/tracks/text-track-settings.test.js @@ -2,7 +2,6 @@ import TextTrackSettings from '../../../src/js/tracks/text-track-settings.js'; import TestHelpers from '../test-helpers.js'; import * as Events from '../../../src/js/utils/events.js'; -import safeParseTuple from 'safe-json-parse/tuple'; import sinon from 'sinon'; import window from 'global/window'; import Component from '../../../src/js/component.js'; @@ -120,7 +119,7 @@ QUnit.test('should update settings', function(assert) { Events.trigger(player.$('.vjs-done-button'), 'click'); assert.deepEqual( - safeParseTuple(window.localStorage.getItem('vjs-text-track-settings'))[1], + JSON.parse(window.localStorage.getItem('vjs-text-track-settings')), newSettings, 'values are saved' );