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

feat: light esm build #765

Merged
merged 5 commits into from
Dec 26, 2024
Merged

feat: light esm build #765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8aba3ee
feat: light esm build
tsi Dec 16, 2024
2fce097
chore: esm tests
tsi Dec 16, 2024
d6d4145
chore: e2e & devServer
tsi Dec 17, 2024
0af275e
chore: e2e
tsi Dec 17, 2024
23db0cd
Merge branch 'edge' into ME-18455-light-esm
tsi Dec 26, 2024
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
64 changes: 64 additions & 0 deletions docs/es-modules/all.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>Cloudinary Video Player</title>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not critical but the title should match the example name ....same comment for the second example as well.

<link
href="https://res.cloudinary.com/cloudinary-marketing/image/upload/f_auto,q_auto/c_scale,w_32,e_hue:290/creative_staging/cloudinary_internal/Website/Brand%20Updates/Favicon/cloudinary_web_favicon_192x192.png"
rel="icon"
type="image/png"
/>
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<div class="container p-4 col-12 col-md-9 col-xl-6">
<nav class="nav mb-2">
<a href="/index.html">&#60;&#60; Back to examples index</a>
</nav>
<h1>Cloudinary Video Player</h1>
<h3 class="mb-4"><code>/all</code> build</h3>

<p>Using the <code>/all</code> build, you get a build that already includes all plugins (except the big <code>/dash</code> plugin), saving you the need to import them separately</p>

<video
id="player"
class="cld-video-player cld-fluid"
crossorigin="anonymous"
controls
muted
playsinline
></video>

<p class="mt-4">
<a href="https://cloudinary.com/documentation/cloudinary_video_player#installation"
>Full documentation</a
>
</p>
</div>

<script type="module">
import { videoPlayer } from 'cloudinary-video-player/all';
import 'cloudinary-video-player/cld-video-player.min.css';

const player = videoPlayer('player', {
cloudName: 'demo',
publicId: 'dog',
autoplay: true,
chapters: {
0: 'Chapter I',
3: 'Chapter II',
8: 'Chapter III',
}
});
</script>

<!-- Bootstrap -->
<link
href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css"
rel="stylesheet"
integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T"
crossorigin="anonymous"
/>
</body>
</html>
3 changes: 3 additions & 0 deletions docs/es-modules/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ <h3 class="mt-4">Code examples:</h3>
<li><a href="./ui-config.html">UI Config</a></li>
<li><a href="./vast-vpaid.html">VAST & VPAID Support</a></li>
<li><a href="./360.html">VR/360 Videos</a></li>
<hr>
<li><a href="./all.html"><code>/all</code> build</a></li>
<li><a href="./light.html"><code>/light</code> build</a></li>
</ul>
</div>
</body>
Expand Down
65 changes: 65 additions & 0 deletions docs/es-modules/light.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>Cloudinary Video Player</title>
<link
href="https://res.cloudinary.com/cloudinary-marketing/image/upload/f_auto,q_auto/c_scale,w_32,e_hue:290/creative_staging/cloudinary_internal/Website/Brand%20Updates/Favicon/cloudinary_web_favicon_192x192.png"
rel="icon"
type="image/png"
/>
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<div class="container p-4 col-12 col-md-9 col-xl-6">
<nav class="nav mb-2">
<a href="/index.html">&#60;&#60; Back to examples index</a>
</nav>
<h1>Cloudinary Video Player</h1>
<h3 class="mb-4"><code>/light</code> build</h3>

<p>Using the <code>/light</code> build gives you the smallest possible bundle-size</p>

<video
id="player"
class="cld-video-player cld-fluid"
crossorigin="anonymous"
controls
muted
playsinline
></video>

<p class="mt-4">
<a href="https://cloudinary.com/documentation/cloudinary_video_player#installation"
>Full documentation</a
>
</p>
</div>

<script type="module">
import { videoPlayer } from 'cloudinary-video-player/light';
import 'cloudinary-video-player/light/chapters';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would this work import 'cloudinary-video-player/chapters'? if so i think its preferable since the current syntax implies that this is a light plugin which is not true in my eyes (The plugin is the same)

Also this way the imports are not consistent with the css import

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, unfortunately it won't work since both /chapters and /light/chapters are importing videojs, but they were compiled using a different videojs core.
I tried multiple things to work around it but unfortunately nothing worked 100% in all of the full/light/esm/cdn variants :(

import 'cloudinary-video-player/cld-video-player.min.css';

const player = videoPlayer('player', {
cloudName: 'demo',
publicId: 'dog',
autoplay: true,
chapters: {
0: 'Chapter I',
3: 'Chapter II',
8: 'Chapter III',
}
});
</script>

<!-- Bootstrap -->
<link
href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css"
rel="stylesheet"
integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T"
crossorigin="anonymous"
/>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/es-modules/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"private": true,
"version": "0.0.1",
"scripts": {
"prepare-player": "cd ../../ && npm i && npm run build-es",
"prepare-player": "cd ../../ && npm i && npm run build-all",
"install-player": "npm i ../../ --no-save",
"prepare": "npm run prepare-player && npm run install-player",
"update-edge": "npm i",
Expand Down
16 changes: 13 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,14 @@
".": {
"types": "./types/cld-video-player.d.ts",
"import": "./lib/cld-video-player.js",
"require": "./dist/cld-video-player.js"
"require": "./dist/cld-video-player.min.js"
},
"./*": "./lib/*"
"./*": "./lib/*",
"./light": {
"import": "./lib/light/index.js",
"require": "./dist/cld-video-player.light.min.js"
},
"./light/*": "./lib/light/*"
},
"scripts": {
"prepare": "shx cp env.example.js env.js",
Expand All @@ -34,7 +39,8 @@
"build-es": "WEBPACK_BUILD_MIN=1 webpack --config webpack/es6.config.js --progress --color",
"build-light": "WEBPACK_BUILD_LIGHT=1 WEBPACK_BUILD_MIN=1 webpack --config webpack/build.config.js --progress --color",
"build-light-dev": "WEBPACK_BUILD_LIGHT=1 webpack --config webpack/build.config.js --progress --color --mode=development",
"build-all": "npm run clean && npm run build && npm run build-dev && npm run build-light && npm run build-light-dev && npm run build-es",
"build-light-es": "WEBPACK_BUILD_LIGHT=1 WEBPACK_BUILD_MIN=1 webpack --config webpack/es-light.config.js --progress --color",
"build-all": "npm run clean && npm run build && npm run build-dev && npm run build-light && npm run build-light-dev && npm run build-light-es && npm run build-es",
"analyze": "webpack --config webpack/analyzer.config.js",
"analyze:light": "WEBPACK_BUILD_LIGHT=1 webpack --config webpack/analyzer.config.js",
"postbuild-all": "bundlewatch",
Expand Down Expand Up @@ -74,6 +80,10 @@
{
"path": "./lib/all.js",
"maxSize": "288kb"
},
{
"path": "./lib/light/index.js",
"maxSize": "135kb"
}
]
},
Expand Down
1 change: 0 additions & 1 deletion src/index.all.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ export * from './index.js';
export * from './plugins/chapters/chapters.js';
export * from './plugins/ima/ima.js';
export * from './plugins/playlist/playlist.js';
export * from './plugins/styled-text-tracks/styled-text-tracks.js';
export * from './plugins/interaction-areas/interaction-areas.service.js';
export * from './components/shoppable-bar/shoppable-widget.js';

Expand Down
6 changes: 1 addition & 5 deletions src/plugins/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
import 'videojs-per-source-behaviors';

// #if (!process.env.WEBPACK_BUILD_LIGHT)
import './videojs-http-source-selector/plugin';
// #endif

import aiHighlightsGraph from './ai-highlights-graph';
import analytics from './analytics';
import autoplayOnScroll from './autoplay-on-scroll';
Expand All @@ -14,6 +10,7 @@ import contextMenu from './context-menu';
import floatingPlayer from './floating-player';
import pacedTranscript from './paced-transcript';
import srtTextTracks from './srt-text-tracks';
import styledTextTracks from './styled-text-tracks';
import vttThumbnails from './vtt-thumbnails';

// Lazy loaded plugins
Expand All @@ -22,7 +19,6 @@ import imaPlugin from './ima';
import interactionAreas from './interaction-areas';
import playlist from './playlist';
import shoppable from './shoppable-plugin';
import styledTextTracks from './styled-text-tracks';

const plugins = {
aiHighlightsGraph,
Expand Down
4 changes: 2 additions & 2 deletions src/utils/get-analytics-player-options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ const getCloudinaryOptions = (cloudinaryOptions = {}) => ({
});

const getTranscriptOptions = (textTracks = {}) => {
const tracksArr = [textTracks.captions, ...textTracks.subtitles];
const tracksArr = [textTracks.captions, ...(textTracks.subtitles || [])];
return {
textTracks: hasConfig(textTracks),
textTracksLength: tracksArr.length,
textTracksOptions: hasConfig(textTracks.options) || Object.keys(textTracks.options).join(','),
textTracksOptions: hasConfig(textTracks.options) && Object.keys(textTracks.options).join(','),
Comment on lines +23 to +27
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how these two changes are related to exporting light version?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They don't, just fixed a warning I got while working on this

pacedTextTracks: hasConfig(textTracks) && JSON.stringify(textTracks || {}).includes('"maxWords":') || null,
wordHighlight: hasConfig(textTracks) && JSON.stringify(textTracks || {}).includes('"wordHighlight":') || null,
transcriptLanguages: tracksArr.filter((track) => !track.url).map((track) => track.language || '').join(',') || null,
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/specs/linksConsoleErrorsEsmPage.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ for (const link of ESM_LINKS) {
*/
vpTest('ESM page Link count test', async ({ page }) => {
await page.goto(ESM_URL);
const expectedNumberOfLinks = 32;
const expectedNumberOfLinks = 34;
const numberOfLinks = await page.getByRole('link').count();
expect(numberOfLinks).toBe(expectedNumberOfLinks);
});
Expand Down
2 changes: 2 additions & 0 deletions test/e2e/testData/ExampleLinkNames.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,6 @@ export enum ExampleLinkName {
VR360Videos = 'VR/360 Videos',
EmbeddedIframePlayer = 'Embedded (iframe) player',
ESMImports = 'ESM Imports',
AllBuild = '/all build',
LightBuild = '/light build',
}
2 changes: 2 additions & 0 deletions test/e2e/testData/esmPageLinksData.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ export const ESM_LINKS: ExampleLinkType[] = [
{ name: ExampleLinkName.UIConfig, endpoint: 'ui-config' },
{ name: ExampleLinkName.VASTAndVPAIDSupport, endpoint: 'vast-vpaid' },
{ name: ExampleLinkName.VR360Videos, endpoint: '360' },
{ name: ExampleLinkName.AllBuild, endpoint: 'all' },
{ name: ExampleLinkName.LightBuild, endpoint: 'light' },
];

/**
Expand Down
1 change: 0 additions & 1 deletion webpack/dev.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ module.exports = merge(webpackCommon, {
],

devServer: {
host: env.devServer.host || 'localhost',
port: env.devServer.port || 3000,
open: [isLight ? 'index.html?light=true' : 'index.html'],
headers: {
Expand Down
17 changes: 17 additions & 0 deletions webpack/es-light.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
const { merge } = require('webpack-merge');
const webpackConfig = require('./es6.config');
const path = require('path');

delete webpackConfig.entry; // overwrite
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could be that there is something in webpack-merge api that allows you to overwrite when merging which maybe can be easier to read as it is more explict ? (Just a thought, i did not really go and checked their API)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought delete webpackConfig.entry would be as explicit as it gets, what could be more explicit than that? :)


module.exports = merge(webpackConfig, {

entry: {
'index': './index.es.js'
},

output: {
path: path.resolve(__dirname, '../lib/light'),
}

});
Loading