fix: added test coverage and some nits

openedx · Jul 30, 2024 · 06a1aa8 · 06a1aa8
1 parent 42aa483
commit 06a1aa8
Show file tree

Hide file tree

Showing 4 changed files with 143 additions and 7 deletions.
diff --git a/src/components/microlearning/VideoDetailPage.jsx b/src/components/microlearning/VideoDetailPage.jsx
@@ -78,11 +78,11 @@ const VideoDetailPage = () => {
               <h2 data-testid="video-title" className="mb-0">
                 {videoData?.courseTitle}
               </h2>
-              <span className="small ml-2 mt-2">
+              <span className="small ml-2 mt-2 text-nowrap">
                 {videoData?.videoDuration && `(${videoData?.videoDuration} minutes)`}
               </span>
             </div>
-            <p className="small align-self-stretch text-justify mb-2">
+            <p className="small align-self-stretch mb-2">
               {videoData?.videoSummary}
             </p>
             { videoData?.videoSkills?.length > 0 && (
@@ -110,9 +110,11 @@ const VideoDetailPage = () => {
               </div>
             )}
           </div>
-          <div className="video-player-wrapper position-relative mw-100 overflow-hidden my-4 mt-2">
-            <VideoPlayer videoURL={videoData?.videoUrl} customOptions={customOptions} />
-          </div>
+          { videoData?.videoUrl && (
+            <div className="video-player-wrapper position-relative mw-100 overflow-hidden my-4 mt-2">
+              <VideoPlayer videoURL={videoData?.videoUrl} customOptions={customOptions} />
+            </div>
+          )}
         </article>
         <MediaQuery minWidth={breakpoints.large.minWidth}>
           {matches => matches && (

diff --git a/src/components/video/data/tests/hooks.test.js b/src/components/video/data/tests/hooks.test.js
@@ -0,0 +1,70 @@
+import { renderHook } from '@testing-library/react-hooks';
+import { logError } from '@edx/frontend-platform/logging';
+import { useTranscripts } from '../hooks';
+import { fetchAndAddTranscripts } from '../service';
+
+// Mocking dependencies
+jest.mock('../service', () => ({
+  fetchAndAddTranscripts: jest.fn(),
+}));
+
+jest.mock('@edx/frontend-platform/logging', () => ({
+  logError: jest.fn(),
+}));
+
+describe('useTranscripts', () => {
+  const customOptions = {
+    showTranscripts: true,
+    transcriptUrls: {
+      en: 'https://example.com/transcript-en.txt',
+    },
+  };
+  const mockPlayer = {};
+
+  it('should set isLoading to true initially if showTranscripts is true', () => {
+    const { result } = renderHook(() => useTranscripts({ player: mockPlayer, customOptions }));
+    expect(result.current.isLoading).toBe(true);
+  });
+
+  it('should fetch and set textTracks and transcriptUrl correctly', async () => {
+    const textTracks = { en: 'https://example.com/transcript-en.txt' };
+    fetchAndAddTranscripts.mockResolvedValueOnce(textTracks);
+
+    const { result, waitForNextUpdate } = renderHook(() => useTranscripts({ player: mockPlayer, customOptions }));
+
+    await waitForNextUpdate();
+
+    expect(result.current.isLoading).toBe(false);
+    expect(result.current.textTracks).toEqual(textTracks);
+    expect(result.current.transcriptUrl).toBe(textTracks.en);
+  });
+
+  it('should log error and set isLoading to false if fetching transcripts fails', async () => {
+    const errorMessage = 'Error fetching transcripts';
+    fetchAndAddTranscripts.mockRejectedValueOnce(new Error(errorMessage));
+
+    const { result, waitForNextUpdate } = renderHook(() => useTranscripts({ player: mockPlayer, customOptions }));
+
+    await waitForNextUpdate();
+
+    expect(logError).toHaveBeenCalledWith(`Error fetching transcripts for player: Error: ${errorMessage}`);
+    expect(result.current.isLoading).toBe(false);
+    expect(result.current.textTracks).toEqual([]);
+    expect(result.current.transcriptUrl).toBeNull();
+  });
+
+  it('should not fetch transcripts if showTranscripts is false', async () => {
+    const customOptionsWithoutTranscripts = {
+      showTranscripts: false,
+      transcriptUrls: undefined,
+    };
+
+    const { result } = renderHook(() => useTranscripts({
+      player: mockPlayer,
+      customOptions: customOptionsWithoutTranscripts,
+    }));
+
+    expect(result.current.textTracks).toEqual([]);
+    expect(result.current.transcriptUrl).toBeNull();
+  });
+});
diff --git a/src/components/video/tests/VideoJS.test.jsx b/src/components/video/tests/VideoJS.test.jsx
@@ -1,8 +1,15 @@
 import React from 'react';
-import { VideoJS } from '..';
+import { waitFor } from '@testing-library/react';
 import { renderWithRouter } from '../../../utils/tests';
+import VideoJS from '../VideoJS';
+import { useTranscripts } from '../data';
 
+// Mocking the 'videojs-vjstranscribe' and 'useTranscripts' hook
 jest.mock('videojs-vjstranscribe');
+jest.mock('../data', () => ({
+  useTranscripts: jest.fn(),
+  usePlayerOptions: jest.fn(),
+}));
 
 const hlsUrl = 'https://test-domain.com/test-prefix/id.m3u8';
 const ytUrl = 'https://www.youtube.com/watch?v=oHg5SJYRHA0';
@@ -26,6 +33,14 @@ const YoutubeVideoOptions = {
 };
 
 describe('VideoJS', () => {
+  beforeEach(() => {
+    useTranscripts.mockReturnValue({
+      isLoading: false,
+      textTracks: {},
+      transcriptUrl: null,
+    });
+  });
+
   it('Renders VideoJS components correctly for HLS videos.', () => {
     const { container } = renderWithRouter(<VideoJS options={HLSVideoOptions} />);
     expect(container.querySelector('.video-js-wrapper')).toBeTruthy();
@@ -39,4 +54,53 @@ describe('VideoJS', () => {
     expect(container.querySelector('.vjs-big-play-centered')).toBeTruthy();
     expect(container.querySelector('video-js')).toBeTruthy();
   });
+
+  it('Renders VideoJS components correctly with transcripts.', async () => {
+    const customOptions = {
+      showTranscripts: true,
+      transcriptUrls: {
+        en: 'https://example.com/transcript-en.txt',
+      },
+    };
+
+    useTranscripts.mockReturnValue({
+      isLoading: false,
+      textTracks: {
+        en: 'https://example.com/transcript-en.txt',
+      },
+      transcriptUrl: 'https://example.com/transcript-en.txt',
+    });
+
+    const { container } = renderWithRouter(<VideoJS options={HLSVideoOptions} customOptions={customOptions} />);
+
+    await waitFor(() => {
+      expect(container.querySelector('.video-js-wrapper')).toBeTruthy();
+      expect(container.querySelector('.vjs-big-play-centered')).toBeTruthy();
+      expect(container.querySelector('video-js')).toBeTruthy();
+      expect(container.querySelector('#vjs-transcribe')).toBeTruthy();
+    });
+  });
+
+  it('Does not initialize VideoJS player while transcripts are loading.', async () => {
+    const customOptions = {
+      showTranscripts: true,
+      transcriptUrls: {
+        en: 'https://example.com/transcript-en.txt',
+      },
+    };
+
+    useTranscripts.mockReturnValue({
+      isLoading: true,
+      textTracks: {},
+      transcriptUrl: null,
+    });
+
+    const { container } = renderWithRouter(<VideoJS options={HLSVideoOptions} customOptions={customOptions} />);
+
+    await waitFor(() => {
+      expect(container.querySelector('.video-js-wrapper')).toBeTruthy();
+      expect(container.querySelector('.vjs-big-play-centered')).toBeFalsy();
+      expect(container.querySelector('video-js')).toBeFalsy();
+    });
+  });
 });
diff --git a/src/components/video/tests/VideoPlayer.test.jsx b/src/components/video/tests/VideoPlayer.test.jsx
@@ -1,6 +1,6 @@
 import React from 'react';
 import { waitFor } from '@testing-library/react';
-import { VideoPlayer } from '..'; // Assuming VideoPlayer is exported as named export
+import VideoPlayer from '../VideoPlayer';
 import { renderWithRouter } from '../../../utils/tests';
 
 const hlsUrl = 'https://test-domain.com/test-prefix/id.m3u8';