fix: prevent infinite re-render loop from issue retry callbacks (#2550)
This commit is contained in:
committed by
dermotduffy
parent
c3d3dd3934
commit
3fe5e4004a
@@ -1,6 +1,7 @@
|
||||
import type { IssueTriggerContext } from 'issue';
|
||||
|
||||
import type { ConditionStateChange } from '../../condition-trigger/conditions/types';
|
||||
import { contentsChanged, ignoreFunctionIdentity } from '../../utils/basic';
|
||||
import { isActionAllowedBasedOnInteractionState } from '../../utils/interaction-mode';
|
||||
import { RetryTimer } from '../../utils/retry-timer';
|
||||
import type { CardIssueManagerAPI } from '../types';
|
||||
@@ -8,6 +9,7 @@ import { IssueStateManager } from './state-manager';
|
||||
import type {
|
||||
Issue,
|
||||
IssueKey,
|
||||
IssuePresence,
|
||||
IssueReadOnlyState,
|
||||
IssueTriggerContextKey,
|
||||
} from './types';
|
||||
@@ -34,11 +36,9 @@ export class IssueManager {
|
||||
});
|
||||
private _suspended = false;
|
||||
|
||||
// Reentrancy guard: evaluate() calls setState() on the condition state
|
||||
// manager, which fires listeners synchronously -- including the one
|
||||
// registered in this constructor. Without this guard, detectDynamic()
|
||||
// and presence computation would run twice per evaluation.
|
||||
private _evaluating = false;
|
||||
// The issue presence from the last evaluation, compared against on the next
|
||||
// one to decide whether a re-render is needed.
|
||||
private _lastPresence: IssuePresence = new Map();
|
||||
|
||||
constructor(api: CardIssueManagerAPI) {
|
||||
this._api = api;
|
||||
@@ -71,40 +71,42 @@ export class IssueManager {
|
||||
this.evaluate();
|
||||
}
|
||||
|
||||
// Evaluate all dynamic issues against current state, then react to any
|
||||
// changes: notify, update condition state, and schedule retries.
|
||||
// Evaluate all dynamic issues against current state, re-render the card if
|
||||
// the issue presence changed, and schedule retries.
|
||||
//
|
||||
// Detection of "anything changed" is delegated to the condition state
|
||||
// manager: IssuePresence is a Map<IssueKey, IssueDescription>, so its
|
||||
// deep equality check naturally catches both presence-set churn (issues
|
||||
// IssuePresence is a Map<IssueKey, IssueDescription>, so comparing the new
|
||||
// presence against the previous one catches both presence-set churn (issues
|
||||
// appearing/disappearing) and content-level churn (an issue swapping
|
||||
// sub-states without changing its key, e.g. ConnectionIssue going from
|
||||
// 'lost' to 'starting').
|
||||
// sub-states without changing its key, e.g. ConnectionIssue going from 'lost'
|
||||
// to 'starting').
|
||||
public evaluate(): void {
|
||||
if (this._suspended || this._evaluating) {
|
||||
if (this._suspended) {
|
||||
return;
|
||||
}
|
||||
|
||||
this._evaluating = true;
|
||||
try {
|
||||
const state = this._api.getConditionStateManager().getState();
|
||||
this._stateManager.detectDynamic(state);
|
||||
const state = this._api.getConditionStateManager().getState();
|
||||
this._stateManager.detectDynamic(state);
|
||||
|
||||
if (
|
||||
this._api.getConditionStateManager().setState({
|
||||
issues: this._stateManager.getIssuePresence(),
|
||||
})
|
||||
) {
|
||||
// Re-render to show the change. The re-render also re-attempts
|
||||
// initialization, which matters when a blocking notice like "Home
|
||||
// Assistant is starting" clears and the card can finally initialize.
|
||||
this._api.getCardElementManager().update();
|
||||
}
|
||||
// getIssuePresence() rebuilds notifications fresh each call, so a retry
|
||||
// control embeds a new callback closure every time; ignore that identity
|
||||
// churn so only an observable change in the issue set or its content
|
||||
// triggers a re-render.
|
||||
const presence = this._stateManager.getIssuePresence();
|
||||
const changed = contentsChanged(
|
||||
presence,
|
||||
this._lastPresence,
|
||||
ignoreFunctionIdentity,
|
||||
);
|
||||
this._lastPresence = presence;
|
||||
|
||||
this._scheduleRetryIfNeeded();
|
||||
} finally {
|
||||
this._evaluating = false;
|
||||
if (changed) {
|
||||
// Re-render to show the change. The re-render also re-attempts
|
||||
// initialization, which matters when a blocking notice like "Home
|
||||
// Assistant is starting" clears and the card can finally initialize.
|
||||
this._api.getCardElementManager().update();
|
||||
}
|
||||
|
||||
this._scheduleRetryIfNeeded();
|
||||
}
|
||||
|
||||
// Attempts a retry for the given issue. Pass `force = true` for user-
|
||||
|
||||
@@ -30,10 +30,9 @@ export interface KeyedIssueDescription {
|
||||
|
||||
// Map of currently active issues keyed by IssueKey, with each entry's value
|
||||
// being the issue's current rendered description. Stored as a Map (not just a
|
||||
// Set of keys) so that sub-state changes within an issue -- e.g.
|
||||
// ConnectionIssue swapping between 'lost' and 'starting' -- are reflected as
|
||||
// real value-level diffs to the condition state, triggering re-renders and any
|
||||
// user-defined conditions that depend on issue state.
|
||||
// Set of keys) so that sub-state changes within an issue -- e.g. ConnectionIssue
|
||||
// swapping between 'lost' and 'starting' -- surface as value-level diffs when
|
||||
// IssueManager compares presence between evaluations, triggering a re-render.
|
||||
export type IssuePresence = Map<IssueKey, IssueDescription>;
|
||||
export interface IssueReadOnlyState {
|
||||
hasFullCardIssue(): boolean;
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
import type { IssuePresence } from '../../card-controller/issues/types';
|
||||
import type { KeysState, MicrophoneState } from '../../card-controller/types';
|
||||
import type { AdvancedCameraCardView } from '../../config/schema/common/const';
|
||||
import type { ViewDisplayMode } from '../../config/schema/common/display';
|
||||
@@ -6,6 +5,16 @@ import type { AdvancedCameraCardConfig } from '../../config/schema/types';
|
||||
import type { HomeAssistant } from '../../ha/types';
|
||||
import type { MediaLoadedInfo } from '../../types';
|
||||
|
||||
// ConditionStateManager checks each written field with lodash isEqual. Prefer
|
||||
// plain immutable data: functions (callbacks) compare by identity, and opaque
|
||||
// objects get deep-walked through their enumerable state, which is rarely a
|
||||
// meaningful equality contract. Store such a value only when its reference is
|
||||
// the intended state (`mediaLoadedInfo`'s MediaPlayerController, which
|
||||
// consumers also reference-compare) or its identity is stable across writes
|
||||
// (`hass`'s methods).
|
||||
//
|
||||
// Counterexample: Rebuilding an equivalent function callback each write making
|
||||
// the field look changed when nothing observable did.
|
||||
export interface ConditionState {
|
||||
call?: boolean;
|
||||
camera?: string;
|
||||
@@ -22,7 +31,6 @@ export interface ConditionState {
|
||||
mediaLoadedInfo?: MediaLoadedInfo | null;
|
||||
microphone?: MicrophoneState;
|
||||
panel?: boolean;
|
||||
issues?: IssuePresence;
|
||||
hass?: HomeAssistant;
|
||||
|
||||
// Generic media target identifier. See @view/target-id for details.
|
||||
|
||||
@@ -329,6 +329,16 @@ export const generateFloatApproximatelyEqualsCustomizer = (
|
||||
};
|
||||
};
|
||||
|
||||
// For change-detection equality: a function's identity churns and is not
|
||||
// observable state, so two functions compare equal; a function appearing or
|
||||
// disappearing is still a real change. Only apply where a data field beside the
|
||||
// callback carries the meaningful change, not where a function's identity is
|
||||
// itself the state (e.g. a controller keyed by which element it wraps).
|
||||
export const ignoreFunctionIdentity = (a: unknown, b: unknown): boolean | undefined =>
|
||||
typeof a === 'function' || typeof b === 'function'
|
||||
? typeof a === 'function' && typeof b === 'function'
|
||||
: undefined;
|
||||
|
||||
export const convertHTTPAdressToWebsocket = (url: string): string => {
|
||||
return url.replace(/^http/i, 'ws');
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user