chore: address feedback

elastic · Feb 8, 2023 · 9d70d94 · 9d70d94
1 parent c248f7e
commit 9d70d94
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 26 deletions.
diff --git a/common/types.d.ts b/common/types.d.ts
@@ -115,15 +115,17 @@ export type GenerateCodeOptions = {
   actions: Steps;
   isProject: boolean;
 };
+
+export type ActionGeneratedCallback = (event: IpcRendererEvent, actions: ActionContext[]) => void;
 export interface IElectronAPI {
   exportScript: (string) => Promise<boolean>;
   recordJourney: (url: string) => Promise<void>;
   stopRecording: () => void;
   pauseRecording: () => Promise<void>;
   resumeRecording: () => Promise<void>;
-  onActionGenerated: (
+  addActionGeneratedListener(
     callback: (event: IpcRendererEvent, actions: ActionContext[]) => void
-  ) => () => void;
+  ): () => void;
   generateCode: (params: GenerateCodeOptions) => Promise<string>;
   openExternalLink: (url: string) => Promise<void>;
   runTest: (

diff --git a/electron/api/recordJourney.ts b/electron/api/recordJourney.ts
@@ -47,7 +47,7 @@ export async function recordJourney(
 
     // Listen to actions from Playwright recording session
     const actionsHandler = (actions: ActionInContext[]) => {
-      browserWindow.webContents.send('change', actions);
+      browserWindow.webContents.send('actions-generated', actions);
     };
     actionListener.on('actions', actionsHandler);
 

diff --git a/electron/preload.ts b/electron/preload.ts
@@ -21,14 +21,8 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 */
-import type {
-  ActionContext,
-  GenerateCodeOptions,
-  IElectronAPI,
-  RunJourneyOptions,
-  TestEvent,
-} from '../common/types';
-import { contextBridge, ipcRenderer, IpcRendererEvent } from 'electron';
+import type { IElectronAPI } from '../common/types';
+import { contextBridge, ipcRenderer } from 'electron';
 
 const electronAPI: IElectronAPI = {
   exportScript: async contents => {
@@ -46,25 +40,20 @@ const electronAPI: IElectronAPI = {
   resumeRecording: async () => {
     await ipcRenderer.invoke('set-mode', 'recording');
   },
-  onActionGenerated: (
-    callback: (_event: IpcRendererEvent, actions: ActionContext[]) => void
-  ): (() => void) => {
-    ipcRenderer.on('change', callback);
+  addActionGeneratedListener: listener => {
+    ipcRenderer.on('actions-generated', listener);
     return () => {
-      ipcRenderer.removeAllListeners('change');
+      ipcRenderer.removeAllListeners('actions-generated');
     };
   },
-  generateCode: async (params: GenerateCodeOptions) => {
+  generateCode: async params => {
     return ipcRenderer.invoke('actions-to-code', params);
   },
-  openExternalLink: async (url: string) => {
+  openExternalLink: async url => {
     await ipcRenderer.invoke('open-external-link', url);
   },
-  runTest: async (
-    params: RunJourneyOptions,
-    callback: (_event: IpcRendererEvent, data: TestEvent) => void
-  ) => {
-    ipcRenderer.on('test-event', callback);
+  runTest: async (params, listener) => {
+    ipcRenderer.on('test-event', listener);
     await ipcRenderer.invoke('run-journey', params);
   },
   removeOnTestListener: () => {

diff --git a/src/App.tsx b/src/App.tsx
@@ -91,7 +91,7 @@ export default function App() {
         return generateMergedIR(prevSteps, nextSteps);
       });
     };
-    const removeListener = electronAPI.onActionGenerated(listener);
+    const removeListener = electronAPI.addActionGeneratedListener(listener);
     return removeListener;
   }, [electronAPI, setSteps]);
 

diff --git a/src/helpers/test/defaults.ts b/src/helpers/test/defaults.ts
@@ -88,7 +88,7 @@ export const getCommunicationContextDefaults = (): ICommunicationContext => ({
     stopRecording: jest.fn(),
     pauseRecording: jest.fn(),
     resumeRecording: jest.fn(),
-    onActionGenerated: jest.fn(),
+    addActionGeneratedListener: jest.fn(),
     generateCode: jest.fn(),
     openExternalLink: jest.fn(),
     runTest: jest.fn(),

diff --git a/src/helpers/test/mockApi.ts b/src/helpers/test/mockApi.ts
@@ -31,7 +31,7 @@ export function getMockElectronApi(overrides?: Partial<IElectronAPI>): IElectron
     stopRecording: jest.fn(),
     pauseRecording: jest.fn(),
     resumeRecording: jest.fn(),
-    onActionGenerated: jest.fn(),
+    addActionGeneratedListener: jest.fn(),
     generateCode: jest.fn(),
     openExternalLink: jest.fn(),
     runTest: jest.fn(),