Tests except stream shift. (#6050)

Author: michelinewu

app/components-react/windows/go-live/useGoLiveSettings.ts

@@ -114,7 +114,6 @@ class GoLiveSettingsState extends StreamInfoView<IGoLiveSettingsState> {
             ),
           });
 
-          console.log('updating ', otherEnabledTarget, ' to disabled');
           // Update the settings to disable the other enabled platform
           updated = {
             platforms: {

app/components-react/windows/settings/Stream.tsx

@@ -586,6 +586,7 @@ function CustomDestinationList() {
 
           {shouldShowPrimeLabel ? (
             <ButtonHighlighted
+              name="customDestUltraBtn"
               onClick={() => addCustomDest(true)}
               filled
               text={$t('Ultra')}

test/helpers/modules/forms/form.ts

@@ -282,29 +282,32 @@ export async function readFields(...args: unknown[]): Promise<TFormData> {
 
 /**
  * A shortcut for useForm().assertFormContains()
+ * Pass `indexKey` and `valueKey` to control field lookup (defaults: 'name', 'displayValue')
  */
 export async function assertFormContains(
   formData: TFormData,
-  indexKey?: string,
+  messageOrIndexKey?: string,
+  indexKeyOrValueKey?: string,
   valueKey?: string,
 ): Promise<unknown>;
 export async function assertFormContains(
   formName: string,
   formData: TFormData,
-  indexKey?: string,
+  messageOrIndexKey?: string,
+  indexKeyOrValueKey?: string,
   valueKey?: string,
 ): Promise<unknown>;
 export async function assertFormContains(...args: any[]): Promise<unknown> {
   if (typeof args[0] === 'string') {
-    const [formName, formData, indexKey, valueKey] = args;
+    const [formName, formData, ...rest] = args;
     // TODO: fake hook
     // eslint-disable-next-line react-hooks/rules-of-hooks
-    return useForm(formName).assertFormContains(formData, indexKey, valueKey);
+    return useForm(formName).assertFormContains(formData, ...rest);
   } else {
-    const [formData, indexKey, valueKey] = args;
+    const [formData, ...rest] = args;
     // TODO: fake hook
     // eslint-disable-next-line react-hooks/rules-of-hooks
-    return useForm().assertFormContains(formData, indexKey, valueKey);
+    return useForm().assertFormContains(formData, ...rest);
   }
 }
 

test/helpers/modules/streaming.ts

@@ -20,6 +20,12 @@ import { sleep } from '../sleep';
 import { fillForm, TFormData, useForm } from './forms';
 import { setOutputResolution, showSettingsWindow } from './settings/settings';
 import { StreamSettingsService } from '../../../app/services/settings/streaming';
+import {
+  WebsocketService,
+  IStreamShiftRequested,
+  IStreamShiftActionCompleted,
+} from '../../../app/services/websocket';
+import { RestreamService } from '../../../app/services/restream';
 
 /**
  * Go live and wait for stream start
@@ -153,13 +159,14 @@ export async function waitForSettingsWindowLoaded() {
 }
 
 async function waitForStreamShift() {
-  // eslint-disable-next-line react-hooks/rules-of-hooks
-  await useMainWindow(async () => {
-    const streamShifted = await isDisplayed('span=Another stream detected', { timeout: 5000 });
-    if (streamShifted) {
-      await click('span=Force Start');
-    }
-  });
+  // The "Another stream detected" prompt renders in the child window (GoLive)
+  // via promptAction (Ant Design modal). Check the child window for the prompt
+  // and dismiss it if found so the go live flow can proceed.
+  await focusChild();
+  const streamShifted = await isDisplayed('span=Another stream detected', { timeout: 5000 });
+  if (streamShifted) {
+    await click('span=Force Start');
+  }
 }
 
 export async function switchAdvancedMode() {
@@ -238,3 +245,34 @@ export async function addCustomDestination(name: string, url: string, streamKey:
   });
   await clickButton('Save');
 }
+
+/**
+ * Mock a Stream Shift socket event
+ *
+ * @param type - 'streamSwitchRequest' (switch to another device) or
+ *               'switchActionComplete' (switch to the current device)
+ * @param identifier - stream id
+ */
+export async function fireStreamShiftSocketEvent(
+  type: IStreamShiftRequested['type'] | IStreamShiftActionCompleted['type'],
+  identifier: string,
+): Promise<void> {
+  const event: IStreamShiftRequested | IStreamShiftActionCompleted = {
+    type,
+    for: '',
+    data: { identifier },
+    event_id: `test_${type}`,
+  };
+  (await getApiClient())
+    .getResource<WebsocketService>('WebsocketService')
+    .sendSocketEventForTest(event);
+}
+
+/**
+ * Emit directly on RestreamService.isLive, triggering the GoLive window's subscription
+ * without going through the real HTTP API. Pass true to show the "Another stream detected"
+ * prompt; pass false to clear it.
+ */
+export async function fireIsLiveEvent(isLive: boolean): Promise<void> {
+  (await getApiClient()).getResource<RestreamService>('RestreamService').emitIsLiveForTest(isLive);
+}

test/helpers/modules/user.ts

@@ -1,6 +1,11 @@
 import { getContext, TExecutionContext } from '../webdriver';
 import { TPlatform } from '../../../app/services/platforms';
-import { ITestUserFeatures, reserveUserFromPool, logIn as userLogin } from '../webdriver/user';
+import {
+  ITestUser,
+  ITestUserFeatures,
+  reserveUserFromPool,
+  logIn as userLogin,
+} from '../webdriver/user';
 import { click, clickButton } from './core';
 import { fillForm } from './forms';
 import { showSettingsWindow } from './settings/settings';
@@ -14,9 +19,13 @@ export function logIn(
   return userLogin(getContext(), platform, features, waitForUI, isOnboardingTest);
 }
 
-export async function addCustomDestination(t: TExecutionContext) {
-  const user = await reserveUserFromPool(t, 'twitch');
-  const name = 'MyCustomDest';
+export async function addCustomDestination(
+  t: TExecutionContext,
+  destName?: string,
+  testUser?: ITestUser,
+) {
+  const user = testUser ?? (await reserveUserFromPool(t, 'twitch'));
+  const name = destName ?? 'MyCustomDest';
 
   // add new destination
   await showSettingsWindow('Stream');

test/regular/highlighter.ts

@@ -1,20 +1,24 @@
 import { test, useWebdriver } from '../helpers/webdriver';
 import { setTemporaryRecordingPath } from '../helpers/modules/settings/settings';
-import { click, clickButton, focusMain, select, waitForDisplayed } from '../helpers/modules/core';
+import { clickButton, focusMain, isDisplayed, waitForDisplayed } from '../helpers/modules/core';
 import { showPage } from '../helpers/modules/navigation';
 import {
+  clickGoLive,
   prepareToGoLive,
   stopStream,
   tryToGoLive,
+  waitForSettingsWindowLoaded,
   waitForStreamStart,
 } from '../helpers/modules/streaming';
 import { logIn } from '../helpers/modules/user';
 import { saveReplayBuffer } from '../helpers/modules/replay-buffer';
-import { assertFormContains, fillForm } from '../helpers/modules/forms';
+import { fillForm } from '../helpers/modules/forms';
 import { withUser } from '../helpers/webdriver/user';
 const path = require('path');
 const fs = require('fs');
 
+// not a react hook
+// eslint-disable-next-line react-hooks/rules-of-hooks
 useWebdriver();
 
 test('Highlighter save and export', async t => {
@@ -45,11 +49,53 @@ test('Highlighter save and export', async t => {
   t.true(fs.existsSync(exportLocation), 'The video file should exist');
 });
 
-test.skip('AI Highlighter', withUser('twitch', { prime: true }), async t => {
-  const recordingDir = await setTemporaryRecordingPath();
-
+test('AI Highlighter', withUser('twitch', { prime: true }), async t => {
+  // AI Highlighter install button shows
   await showPage('Highlighter');
-  await clickButton('Install AI Highlighter App');
+  await waitForDisplayed('[name="installHighlighter"]');
 
+  // Go live with AI Highlighter enabled
   await prepareToGoLive();
+  await clickGoLive();
+  await waitForSettingsWindowLoaded();
+
+  await fillForm({
+    title: 'Test stream',
+    twitchGame: 'Fortnite',
+  });
+
+  // Highlighter div shows
+  await waitForSettingsWindowLoaded();
+  t.true(
+    await isDisplayed('[name="install-highlighter"]'),
+    'Case 1: Highlighter card should show for supported game',
+  );
+
+  // Highlighter div hides
+  await fillForm({
+    twitchGame: 'DOOM',
+  });
+  await waitForSettingsWindowLoaded();
+  t.false(
+    await isDisplayed('[name="install-highlighter"]'),
+    'Case 2: Highlighter card should hide for not supported game',
+  );
+
+  // Highlighter div shows again
+  await fillForm({
+    twitchGame: 'Fortnite',
+  });
+  await waitForSettingsWindowLoaded();
+  t.true(
+    await isDisplayed('[name="install-highlighter"]'),
+    'Case 3: Highlighter card should show when changing from an unsupported game to a supported game',
+  );
+  await clickButton('Close');
+  await clickGoLive();
+  await waitForSettingsWindowLoaded();
+  t.true(
+    await isDisplayed('[name="install-highlighter"]'),
+    'Case 5: Highlighter card should show for supported game when opening go live window',
+  );
+  await clickButton('Close');
 });