refactor: with Julian

Signed-off-by: Miroslav Bajtoš <[email protected]>

Author: bajtos

main/activity-log.js

@@ -1,7 +1,7 @@
 'use strict'
 
 /** @typedef {import('./typings').Activity} Activity */
-/** @typedef {import('./typings').RecordActivityOptions}  RecordActivityOptions */
+/** @typedef {import('./typings').RecordActivityArgs}  RecordActivityArgs */
 
 const Store = require('electron-store')
 const crypto = require('node:crypto')
@@ -18,10 +18,10 @@ class ActivityLog {
   }
 
   /**
-   * @param {RecordActivityOptions} args
+   * @param {RecordActivityArgs} args
    * @returns {Activity}
    */
-  recordActivity ({ source, type, message }) {
+  record ({ source, type, message }) {
     /** @type {Activity} */
     const activity = {
       id: crypto.randomUUID(),

main/index.js

@@ -16,7 +16,7 @@ const { ActivityLog } = require('./activity-log')
 const { ipcMain } = require('electron/main')
 
 /** @typedef {import('./typings').Activity} Activity */
-/** @typedef {import('./typings').RecordActivityOptions} RecordActivityOptions */
+/** @typedef {import('./typings').RecordActivityArgs} RecordActivityOptions */
 
 const inTest = (process.env.NODE_ENV === 'test')
 const isDev = !app.isPackaged && !inTest
@@ -55,7 +55,7 @@ if (!app.requestSingleInstanceLock() && !inTest) {
 
 /** @type {import('./typings').Context} */
 const ctx = {
-  resumeActivityStream,
+  startActivityStream,
   recordActivity,
   manualCheckForUpdates: () => { throw new Error('never get here') },
   showUI: () => { throw new Error('never get here') },
@@ -97,7 +97,7 @@ let isActivityStreamFlowing = false
  * @param {RecordActivityOptions} opts
  */
 function recordActivity (opts) {
-  const activity = activityLog.recordActivity(opts)
+  const activity = activityLog.record(opts)
   if (isActivityStreamFlowing) emitActivity(activity)
 }
 
@@ -108,7 +108,7 @@ function emitActivity (activity) {
   ipcMain.emit(ipcMainEvents.ACTIVITY_LOGGED, activity)
 }
 
-function resumeActivityStream () {
+function startActivityStream () {
   isActivityStreamFlowing = true
   const existingEntries = activityLog.getAllEntries()
   for (const it of existingEntries) emitActivity(it)

main/ipc.js

@@ -31,8 +31,8 @@ function setupIpcMain (/** @type {Context} */ ctx) {
   ipcMain.handle('station:getUserConsent', stationConfig.getUserConsent)
   ipcMain.handle('station:setUserConsent', (_event, consent) => stationConfig.setUserConsent(consent))
 
-  ipcMain.handle('station:resumeActivityStream', (_event, _args) => {
-    return ctx.resumeActivityStream()
+  ipcMain.handle('station:startActivityStream', (_event, _args) => {
+    return ctx.startActivityStream()
   })
 }
 

main/preload.js

@@ -3,7 +3,7 @@
 const { contextBridge, ipcRenderer } = require('electron')
 
 contextBridge.exposeInMainWorld('electron', {
-  resumeActivityStream: () => ipcRenderer.invoke('station:resumeActivityStream'),
+  startActivityStream: () => ipcRenderer.invoke('station:startActivityStream'),
 
   /**
    * @param {(Activity: import('./typings').Activity) => void} callback

main/test/activity-log.test.js

@@ -4,14 +4,14 @@ const assert = require('assert').strict
 const { ActivityLog } = require('../activity-log')
 const { assertTimestampIsCloseToNow, pickProps } = require('./test-helpers')
 
-/** @typedef {import('../typings').RecordActivityOptions} RecordActivityOptions */
+/** @typedef {import('../typings').RecordActivityArgs} RecordActivityOptions */
 
 describe('ActivityLog', function () {
   beforeEach(function () { return ActivityLog.reset() })
 
   it('record activities and assign them timestamp and id ', function () {
     const activityLog = new ActivityLog()
-    const activityCreated = activityLog.recordActivity(givenActivity({
+    const activityCreated = activityLog.record(givenActivity({
       source: 'Station',
       type: 'info',
       message: 'Hello world!'
@@ -33,18 +33,18 @@ describe('ActivityLog', function () {
 
   it('assigns unique ids', function () {
     const activityLog = new ActivityLog()
-    activityLog.recordActivity(givenActivity({ message: 'one' }))
-    activityLog.recordActivity(givenActivity({ message: 'two' }))
+    activityLog.record(givenActivity({ message: 'one' }))
+    activityLog.record(givenActivity({ message: 'two' }))
     assert.deepStrictEqual(activityLog.getAllEntries().map(it => pickProps(it, 'id', 'message')), [
       { id: '1', message: 'one' },
       { id: '2', message: 'two' }
     ])
   })
 
   it('preserves activities across restarts', function () {
-    new ActivityLog().recordActivity(givenActivity({ message: 'first run' }))
+    new ActivityLog().record(givenActivity({ message: 'first run' }))
     const activityLog = new ActivityLog()
-    activityLog.recordActivity(givenActivity({ message: 'second run' }))
+    activityLog.record(givenActivity({ message: 'second run' }))
     assert.deepStrictEqual(activityLog.getAllEntries().map(it => pickProps(it, 'id', 'message')), [
       { id: '1', message: 'first run' },
       { id: '2', message: 'second run' }
@@ -56,7 +56,7 @@ describe('ActivityLog', function () {
 
     const log = new ActivityLog()
     for (let i = 0; i < 110; i++) {
-      log.recordActivity(givenActivity({ message: `activity ${i}` }))
+      log.record(givenActivity({ message: `activity ${i}` }))
     }
     const entries = log.getAllEntries()
     assert.deepStrictEqual(

main/typings.d.ts

@@ -9,15 +9,11 @@ export interface Activity {
   message: string;
 }
 
-export interface RecordActivityOptions {
-  type: ActivityType;
-  source: ActivitySource;
-  message: string;
-}
+export type RecordActivityArgs = Omit<Activity, 'id' | 'timestamp'>;
 
 export interface Context {
-  recordActivity(activity: RecordActivityOptions): void;
-  resumeActivityStream(): void;
+  recordActivity(activity: RecordActivityArgs): void;
+  startActivityStream(): void;
 
   showUI: () => void
   loadWebUIFromDist: import('electron-serve').loadURL

renderer/src/main.tsx

@@ -1,9 +1,9 @@
 import React from 'react'
 import ReactDOM from 'react-dom/client'
 import { BrowserRouter } from 'react-router-dom'
+import { Activity } from '../../main/typings'
 import App from './App'
 import './index.css'
-import { Activity } from '../../main/typings'
 
 ReactDOM.createRoot(
   // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -34,6 +34,6 @@ window.electron.onActivityLogged(activity => {
   console.log('[ACTIVITIES]', activities)
 })
 
-window.electron.resumeActivityStream().then(() => {
+window.electron.startActivityStream().then(() => {
   console.log('ACTIVITY STREAM RESUMED')
 })

renderer/src/typings.d.ts

@@ -3,7 +3,7 @@ import { Activity } from '../main/typings'
 export declare global {
   interface Window {
     electron: {
-      resumeActivityStream(): Promise<Activity[]>,
+      startActivityStream(): Promise<Activity[]>,
       onActivityLogged(callback: (activity: Activity) => void),
 
       saturnNode: {