Skip to content

[XState] Enable XState inspector conditionally #237503

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

Merged
merged 3 commits into from
Oct 6, 2025
Merged

[XState] Enable XState inspector conditionally #237503

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d17bc2b
feat: enable xstate logging conditionally
tonyghiani Oct 3, 2025
9ffc7bd
feat: persist preference across page reloads
tonyghiani Oct 3, 2025
a8889a2
Merge branch 'main' into chore/enable-xstate-logging-by-option
tonyghiani Oct 6, 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
42 changes: 40 additions & 2 deletions src/platform/packages/shared/kbn-xstate-utils/src/console_inspector.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
* License v3.0 only", or the "Server Side Public License, v 1".
*/

/* eslint-disable no-console */

/* eslint-disable no-var */

import type {
ActorRefLike,
AnyActorRef,
Expand All @@ -17,13 +21,47 @@ import type {
} from 'xstate5';
import { isDevMode } from './dev_tools';

declare global {
var __XSTATE_LOGGER_ENABLED__: boolean;
var toggleXstateInspector: () => void;
}

let isHelpMessageLogged = false;
const setupDevToolsInspector = () => {
if (!isHelpMessageLogged) {
console.info(
`ℹ️ To toggle the XState inspector, for advanced debugging, run toggleXstateInspector() on your browser console.`
);
isHelpMessageLogged = true;

const isEnabled = localStorage.getItem('__XSTATE_LOGGER_ENABLED__') === 'true';

globalThis.__XSTATE_LOGGER_ENABLED__ = isEnabled;
globalThis.toggleXstateInspector = toggleXstateInspector;
}
};

const toggleXstateInspector = () => {
globalThis.__XSTATE_LOGGER_ENABLED__ = !globalThis.__XSTATE_LOGGER_ENABLED__;
localStorage.setItem(
'__XSTATE_LOGGER_ENABLED__',
globalThis.__XSTATE_LOGGER_ENABLED__.toString()
);

console.info(
`ℹ️ XState inspector ${globalThis.__XSTATE_LOGGER_ENABLED__ ? 'enabled' : 'disabled'}`
);
};

export const createConsoleInspector = () => {
if (!isDevMode()) {
return () => {};
}

// eslint-disable-next-line no-console
const log = console.info.bind(console);
setupDevToolsInspector();

const log = (...args: Parameters<typeof console.info>) =>
globalThis.__XSTATE_LOGGER_ENABLED__ ? console.info(...args) : undefined;

const logActorEvent = (actorEvent: InspectedActorEvent) => {
if (isActorRef(actorEvent.actorRef)) {
Expand Down