Skip to content

fix(TS): replace 'any' with types for event data (listener parameter) #3027

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

fix(TS): replace 'any' with types for event data (listener parameter) #3027

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b340272
fix(TS): replace 'any' with types for event data (listener parameter)
metalwarrior665 Jun 26, 2025
acdcdaa
fix: remove 'any' casting because we don't need unnecesary type param
metalwarrior665 Jun 26, 2025
8105b82
fix: pass plain SystemInfo without any defaults as we don't use the d…
metalwarrior665 Jun 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions packages/core/src/events/event_manager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,25 @@ export const enum EventType {
EXIT = 'exit',
}

export interface EventTypeToArgs<SystemInfo = Record<string, unknown>> {
[EventType.PERSIST_STATE]: [{ isMigrating: boolean; isAborting: boolean }];
[EventType.SYSTEM_INFO]: [
{ createdAt: Date; cpuCurrentUsage: number; isCpuOverloaded: boolean; memCurrentBytes?: number } & SystemInfo,
];
[EventType.MIGRATING]: [any];
[EventType.ABORTING]: [any];
[EventType.EXIT]: [any];
}

export type EventTypeName = EventType | 'systemInfo' | 'persistState' | 'migrating' | 'aborting' | 'exit';

interface Intervals {
persistState?: BetterIntervalID;
systemInfo?: BetterIntervalID;
}

export abstract class EventManager {
protected events = new AsyncEventEmitter();
export abstract class EventManager<SystemInfo> {
protected events = new AsyncEventEmitter<EventTypeToArgs<SystemInfo>>();
Copy link
Member

@vladfrangu vladfrangu Jun 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One of these days we ought to move to having the class as the EventEmitter, but not today :D

protected initialized = false;
protected intervals: Intervals = {};
protected log = log.child({ prefix: 'Events' });
Expand All @@ -42,7 +52,7 @@ export abstract class EventManager {

const persistStateIntervalMillis = this.config.get('persistStateIntervalMillis')!;
this.intervals.persistState = betterSetInterval((intervalCallback: () => unknown) => {
this.emit(EventType.PERSIST_STATE, { isMigrating: false });
this.emit(EventType.PERSIST_STATE, { isMigrating: false, isAborting: false });
intervalCallback();
}, persistStateIntervalMillis);
this.initialized = true;
Expand All @@ -61,25 +71,25 @@ export abstract class EventManager {
this.initialized = false;

// Emit final PERSIST_STATE event
this.emit(EventType.PERSIST_STATE, { isMigrating: false });
this.emit(EventType.PERSIST_STATE, { isMigrating: false, isAborting: false });

// Wait for PERSIST_STATE to process
await this.waitForAllListenersToComplete();
}

on(event: EventTypeName, listener: (...args: any[]) => any): void {
on(event: EventTypeName, listener: (...args: EventTypeToArgs[EventTypeName]) => any): void {
this.events.on(event, listener);
}

off(event: EventTypeName, listener?: (...args: any[]) => any): void {
off(event: EventTypeName, listener?: (...args: EventTypeToArgs[EventTypeName]) => any): void {
if (listener) {
this.events.removeListener(event, listener);
} else {
this.events.removeAllListeners(event);
}
}

emit(event: EventTypeName, ...args: unknown[]): void {
emit(event: EventTypeName, ...args: EventTypeToArgs[EventTypeName]): void {
this.events.emit(event, ...args);
}

Expand Down
12 changes: 9 additions & 3 deletions packages/core/src/events/local_event_manager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,16 @@ import { getCurrentCpuTicksV2, getMemoryInfo, getMemoryInfoV2, isContainerized }
import log from '@apify/log';
import { betterClearInterval, betterSetInterval } from '@apify/utilities';

import type { SystemInfo } from '../autoscaling';
import { EventManager, EventType } from './event_manager';

export class LocalEventManager extends EventManager {
interface LocalSystemInfo {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
interface LocalSystemInfo {
export interface LocalSystemInfo {

createdAt: Date;
cpuCurrentUsage: number;
isCpuOverloaded: boolean;
memCurrentBytes?: number;
}

export class LocalEventManager extends EventManager<LocalSystemInfo> {
private previousTicks = { idle: 0, total: 0 };

/**
Expand Down Expand Up @@ -79,7 +85,7 @@ export class LocalEventManager extends EventManager {
createdAt: new Date(),
...(await this.createCpuInfo(options)),
...(await this.createMemoryInfo()),
} as SystemInfo;
};
}

private async createCpuInfo(options: { maxUsedCpuRatio: number }) {
Expand Down
Loading