Merge pull request #109 from radiovisual/misc-updates

feat!: fix cjs export; return undefined instead of null
radiovisual · Feb 18, 2024 · eafa37e · eafa37e
2 parents 71d3fbb + 92407c8
commit eafa37e
Show file tree

Hide file tree

Showing 27 changed files with 11,113 additions and 10,846 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -11,15 +11,15 @@ jobs:
       matrix:
         node-version:
           - 16
-          - 14
+          - 18
+          - latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install
       - run: npm test
-      - uses: codecov/codecov-action@v1
-        if: matrix.node-version == 14
+      - uses: codecov/codecov-action@v3
         with:
-          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/__tests__/builds/cjs-module.test.js b/__tests__/builds/cjs-module.test.js
@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+/* eslint-disable unicorn/prefer-module */
+const getVideoId = require('../../dist/get-video-id.js');
+
+describe('bundled CJS module', () => {
+	test('has the expected API', () => {
+		expect(typeof getVideoId).toBe('function');
+		expect(getVideoId('https://www.youtube.com/watch?v=1234').id).toBe('1234');
+	});
+});
diff --git a/__tests__/builds/index.html b/__tests__/builds/index.html
@@ -14,7 +14,7 @@
      <span id="video-id"></span>
 
      <!-- Load getVideoId UMD module -->
-     <script src="../../dist/get-video-id.js"></script>
+     <script src="../../dist/get-video-id.umd.js"></script>
 
      <!-- Now we are free to use getVideoId in the browser -->
      <script>

diff --git a/__tests__/builds/umd-module.test.js b/__tests__/builds/umd-module.test.js
@@ -1,6 +1,6 @@
 /* istanbul ignore file */
 /* eslint-disable unicorn/prefer-module */
-const getVideoId = require('../../dist/get-video-id.js');
+const getVideoId = require('../../dist/get-video-id.umd.js');
 
 describe('bundled umd module', () => {
 	test('has the expected API', () => {

diff --git a/__tests__/dailymotion.test.js b/__tests__/dailymotion.test.js
@@ -28,11 +28,11 @@ describe('Dailymotion', () => {
 
 	test('Dailymotion returns the service', () => {
 		expect(fn('http://www.dailymotion.com/video/1234').service).toBe('dailymotion');
-		expect(fn('http://www.dailymotion.com/video/1234').id).toBe('1234');
 	});
 
 	test('Dailymotion short link', () => {
 		expect(fn('http://dai.ly/x2no31b').id).toBe('x2no31b');
+		expect(fn('http://dai.ly/x2no31b').service).toBe('dailymotion');
 	});
 
 	test('Dailymotion dynamic id', () => {

diff --git a/__tests__/google-redirect.test.js b/__tests__/google-redirect.test.js
@@ -43,9 +43,9 @@ describe('Google Redirects', () => {
 		expect(fn(url).service).toBe('microsoftstream');
 	});
 
-	test('google link returns null as id and service if missing url parameter', () => {
+	test('google link returns undefined as id and service if missing url parameter', () => {
 		const url = 'https://www.google.cz/url?sa=t&rct=j&q=&esrc=s&source=web&cd=2&ved=0ahUKEwiz9P3Aw5DVAhUDZVAKHcegCi8QuAIINDAB&usg=AFQjCNG0kTPdL8nC6zCi2QoZ1KVeTXH-pw';
-		expect(fn(url).id).toBe(null);
-		expect(fn(url).service).toBe(null);
+		expect(fn(url).id).toBeUndefined();
+		expect(fn(url).service).toBeUndefined();
 	});
 });
diff --git a/__tests__/index.test.js b/__tests__/index.test.js
@@ -7,10 +7,10 @@ test('expects a string', () => {
 	}).toThrow(/get-video-id expects a string/);
 });
 
-test('returns null as id and service', () => {
+test('returns undefined as id and service', () => {
 	const expected = {
-		id: null,
-		service: null,
+		id: undefined,
+		service: undefined,
 	};
 	expect(fn('foo')).toMatchObject(expected);
 	expect(fn('<iframe')).toMatchObject(expected);

diff --git a/__tests__/microsoft-stream.test.js b/__tests__/microsoft-stream.test.js
@@ -30,7 +30,7 @@ describe('Microsoft Stream', () => {
 
 	test('microsoft stream links returns undefined id if id missing', () => {
 		const object = fn('https://web.microsoftstream.com/video');
-		expect(object.id).toBe(undefined);
+		expect(object.id).toBeUndefined();
 		expect(object.service).toBe('microsoftstream');
 	});
 });
diff --git a/__tests__/tiktok.test.js b/__tests__/tiktok.test.js
@@ -20,7 +20,7 @@ describe('TikTok', () => {
 
 	test('returns undefined for unknown video ids', () => {
 		const actual = fn('http://www.tiktok.com');
-		expect(actual.id).toBe(undefined);
+		expect(actual.id).toBeUndefined();
 		expect(actual.service).toBe('tiktok');
 	});
 });

diff --git a/__tests__/utils/extract-google-redirection-url.test.js b/__tests__/utils/extract-google-redirection-url.test.js
@@ -0,0 +1,30 @@
+import extractGoogleRedirectionUrl from '../../src/utils/extract-google-redirection-url.js';
+
+describe('extractGoogleRedirectionUrl', () => {
+	test('throws TypeError if input is not a string', () => {
+		expect(() => extractGoogleRedirectionUrl(123)).toThrow(TypeError);
+		expect(() => extractGoogleRedirectionUrl({})).toThrow(TypeError);
+		expect(() => extractGoogleRedirectionUrl([])).toThrow(TypeError);
+	});
+
+	test('returns input as is if it does not contain Google redirect URL', () => {
+		const nonGoogleUrl = 'https://www.example.com';
+		expect(extractGoogleRedirectionUrl(nonGoogleUrl)).toBe(nonGoogleUrl);
+	});
+
+	test('extracts and decodes URL from a Google redirect URL', () => {
+		const expectedUrl = 'https://www.youtube.com/watch?v=dQw4w9WgXcQ';
+		const googleRedirectUrl = `https://www.google.cz/url?sa=t&rct=j&q=&esrc=s&source=web&cd=1&ved=123&url=${encodeURIComponent(expectedUrl)}`;
+		expect(extractGoogleRedirectionUrl(googleRedirectUrl)).toBe(expectedUrl);
+	});
+
+	test('returns trimmed input if it does not match Google redirect pattern', () => {
+		const nonMatchingUrl = '     https://www.google.com/search?q=openai    ';
+		expect(extractGoogleRedirectionUrl(nonMatchingUrl)).toBe(nonMatchingUrl.trim());
+	});
+
+	test('returns input as-is if the value is not a URL', () => {
+		const nonMatchingUrl = 'lorem ipsum';
+		expect(extractGoogleRedirectionUrl(nonMatchingUrl)).toBe(nonMatchingUrl);
+	});
+});
diff --git a/__tests__/utils/get-src.test.js b/__tests__/utils/get-src.test.js
@@ -28,11 +28,11 @@ describe('get-src', () => {
 	});
 
 	test('returns undefined when no src= is found', () => {
-		expect(fn('hello')).toBe(undefined);
-		expect(fn('<iframe')).toBe(undefined);
+		expect(fn('hello')).toBeUndefined();
+		expect(fn('<iframe')).toBeUndefined();
 	});
 
 	test('single quotes return undefined', () => {
-		expect(fn(' src=\'noop\' ')).toBe(undefined);
+		expect(fn(' src=\'noop\' ')).toBeUndefined();
 	});
 });
diff --git a/__tests__/utils/sanitize-url.test.js b/__tests__/utils/sanitize-url.test.js
@@ -0,0 +1,33 @@
+import sanitizeUrl from '../../src/utils/sanitize-url.js';
+
+describe('sanitize-url', () => {
+	test('returns the URL without modification for valid URL strings', () => {
+		const url = 'https://example.com';
+		expect(sanitizeUrl(url)).toBe(url);
+	});
+
+	test('throws TypeError for non-string inputs', () => {
+		const input = 123;
+		expect(() => sanitizeUrl(input)).toThrow(TypeError);
+	});
+
+	test('trims leading or trailing spaces', () => {
+		const url = ' https://example.com ';
+		expect(sanitizeUrl(url)).toBe('https://example.com');
+	});
+
+	test('removes leading "www."', () => {
+		const url = 'https://www.example.com';
+		expect(sanitizeUrl(url)).toBe('https://example.com');
+	});
+
+	test('extracts src from an iframe input', () => {
+		const iframeHtml = '<iframe src="https://example.com"></iframe>';
+		expect(sanitizeUrl(iframeHtml)).toBe('https://example.com');
+	});
+
+	test('returns an empty string when getSrc returns undefined for an iframe', () => {
+		const iframeHtml = '<iframe></iframe>';
+		expect(sanitizeUrl(iframeHtml)).toBe('');
+	});
+});
diff --git a/__tests__/videopress.test.js b/__tests__/videopress.test.js
@@ -30,7 +30,7 @@ describe('Videopress', () => {
 
 	test('videopress links returns undefined id if id missing', () => {
 		const object = fn('https://videopress.com');
-		expect(object.id).toBe(undefined);
+		expect(object.id).toBeUndefined();
 		expect(object.service).toBe('videopress');
 	});
 });
diff --git a/__tests__/vimeo.test.js b/__tests__/vimeo.test.js
@@ -81,7 +81,7 @@ describe('Vimeo', () => {
 
 	test('vimeo links returns undefined id if id missing', () => {
 		const object = fn('https://www.vimeo.co');
-		expect(object.id).toBe(undefined);
+		expect(object.id).toBeUndefined();
 		expect(object.service).toBe('vimeo');
 	});
 

diff --git a/__tests__/vine.test.js b/__tests__/vine.test.js
@@ -42,7 +42,7 @@ describe('Vine', () => {
 
 	test('vine links returns undefined id if id missing', () => {
 		const object = fn('https://vine.co');
-		expect(object.id).toBe(undefined);
+		expect(object.id).toBeUndefined();
 		expect(object.service).toBe('vine');
 	});
 });
diff --git a/__tests__/youtube.test.js b/__tests__/youtube.test.js
@@ -186,23 +186,22 @@ describe('Youtube', () => {
 		expect(fn('https://www.youtube.com/live/ABC1230').id).toBe('ABC1230');
 		expect(fn('www.youtube-nocookie.com/live/ABC12301?feature=share').id).toBe('ABC12301');
 		expect(fn('http://www.youtube.com/live/ABC12302?feature=share').id).toBe('ABC12302');
-
 		expect(fn('http://www.youtube.com/live/ABC12302?feature=share').service).toBe('youtube');
 	});
 
 	test('youtube links returns undefined id if id missing', () => {
 		const object = fn('https://www.youtube.com');
-		expect(object.id).toBe(undefined);
+		expect(object.id).toBeUndefined();
 		expect(object.service).toBe('youtube');
 	});
 
-	test('removes time hash at end of string ', () => {
+	test('extracts ids from urls with time hashes', () => {
 		expect(fn('https://www.youtube.com/watch?v=G-3YxlZIhus#t=0m10s').id).toBe('G-3YxlZIhus');
 		expect(fn('http://www.youtube.com/watch?v=G-3YxlZIhus#t=0m10s').id).toBe('G-3YxlZIhus');
 		expect(fn('http://www.youtube.com/watch?v=G-3YxlZIhus#t=0m10s').service).toBe('youtube');
 	});
 
-	test('removes trailing parameters from youtube urls', () => {
+	test('extracts ids from urls with trailing parameters', () => {
 		expect(fn('http://youtu.be/G-3YxlZIhus&feature=channel').id).toBe('G-3YxlZIhus');
 		expect(fn('http://youtube.com/vi/G-3YxlZIhus&feature=channel').id).toBe('G-3YxlZIhus');
 		expect(fn('http://youtube.com/vi/G-3YxlZIhus&feature=channel').service).toBe('youtube');

diff --git a/babel.config.js b/babel.config.js
diff --git a/babel.config.json b/babel.config.json
@@ -0,0 +1,9 @@
+{
+	"env": {
+		"test": {
+			"plugins": [
+				"@babel/plugin-transform-modules-commonjs"
+			]
+		}
+	}
+}
diff --git a/index.d.ts b/index.d.ts
@@ -1,6 +1,6 @@
 export default function getVideoId(
 	url: string
 ): {
-	id: string | null;
-	service: 'youtube' | 'vimeo' | 'vine' | 'videopress' | 'microsoftstream' | 'tiktok' | 'dailymotion' | null;
+	id: string | undefined;
+	service: 'youtube' | 'vimeo' | 'vine' | 'videopress' | 'microsoftstream' | 'tiktok' | 'dailymotion' | undefined;
 };