frontend/src/hooks/useActions.test.ts

// Copyright (c) 2025-2026, RTE (https://www.rte-france.com)
// This Source Code Form is subject to the terms of the Mozilla Public License, version 2.0.
// If a copy of the Mozilla Public License, version 2.0 was not distributed with this file,
// you can obtain one at http://mozilla.org/MPL/2.0/.
// SPDX-License-Identifier: MPL-2.0
// This file is part of Co-Study4Grid a Power Grid Study tool Assistant Interface to help solve contigencies for a grid state under study. 

import { describe, it, expect, vi, beforeEach } from 'vitest';
import { renderHook, act } from '@testing-library/react';
import { useActions } from './useActions';
import { interactionLogger } from '../utils/interactionLogger';
import type { ActionDetail, AnalysisResult } from '../types';

describe('useActions — interaction logging', () => {
    beforeEach(() => {
        interactionLogger.clear();
    });

    it('logs action_favorited when handleActionFavorite is called', () => {
        const { result } = renderHook(() => useActions());
        const mockSetResult = vi.fn();

        act(() => {
            result.current.handleActionFavorite('act_42', mockSetResult);
        });

        const log = interactionLogger.getLog();
        expect(log).toHaveLength(1);
        expect(log[0].type).toBe('action_favorited');
        expect(log[0].details).toEqual({ action_id: 'act_42' });
    });

    it('logs action_rejected when handleActionReject is called', () => {
        const { result } = renderHook(() => useActions());

        act(() => {
            result.current.handleActionReject('act_99');
        });

        const log = interactionLogger.getLog();
        expect(log).toHaveLength(1);
        expect(log[0].type).toBe('action_rejected');
        expect(log[0].details).toEqual({ action_id: 'act_99' });
    });

    it('logs manual_action_simulated when handleManualActionAdded is called', () => {
        const { result } = renderHook(() => useActions());
        const mockSetResult = vi.fn();
        const mockOnSelect = vi.fn();
        const detail = {
            description_unitaire: 'Test action',
            rho_before: [1.1],
            rho_after: [0.9],
            max_rho: 0.9,
            max_rho_line: 'LINE_A',
            is_rho_reduction: true,
        };

        act(() => {
            result.current.handleManualActionAdded('manual_1', detail, ['LINE_A'], mockSetResult, mockOnSelect);
        });

        const log = interactionLogger.getLog();
        expect(log).toHaveLength(1);
        expect(log[0].type).toBe('manual_action_simulated');
        expect(log[0].details).toEqual({ action_id: 'manual_1' });
    });

    it('logs each action interaction independently', () => {
        const { result } = renderHook(() => useActions());
        const mockSetResult = vi.fn();

        act(() => {
            result.current.handleActionFavorite('act_1', mockSetResult);
            result.current.handleActionReject('act_2');
            result.current.handleActionFavorite('act_3', mockSetResult);
        });

        const log = interactionLogger.getLog();
        expect(log).toHaveLength(3);
        expect(log[0].type).toBe('action_favorited');
        expect(log[0].details.action_id).toBe('act_1');
        expect(log[1].type).toBe('action_rejected');
        expect(log[1].details.action_id).toBe('act_2');
        expect(log[2].type).toBe('action_favorited');
        expect(log[2].details.action_id).toBe('act_3');
    });

    it('clearActionState does not generate a log event', () => {
        const { result } = renderHook(() => useActions());

        act(() => {
            result.current.clearActionState();
        });

        expect(interactionLogger.getLog()).toHaveLength(0);
    });

    // Bug 5: re-simulating an existing action (editing Target MW / tap and
    // clicking "Re-simulate") must NOT promote it into the Selected
    // Actions bucket. A recommender-suggested card must stay in Suggested,
    // and a recommender-suggested action's is_manual flag must not flip.
    describe('handleActionResimulated (Bug 5)', () => {
        const newDetail: ActionDetail = {
            description_unitaire: 'resimulated',
            rho_before: [1.1],
            rho_after: [0.7],
            max_rho: 0.7,
            max_rho_line: 'LINE_B',
            is_rho_reduction: true,
            load_shedding_details: [
                { load_name: 'LOAD_1', voltage_level_id: 'VL_1', shedded_mw: 4.2 },
            ],
        };

        it('does not add the action id to selectedActionIds or manuallyAddedIds', () => {
            const { result } = renderHook(() => useActions());
            let captured: AnalysisResult | null = null;
            const mockSetResult = (updater: unknown) => {
                if (typeof updater === 'function') {
                    captured = (updater as (p: AnalysisResult | null) => AnalysisResult | null)({
                        pdf_path: null, pdf_url: null, actions: {
                            load_shedding_L1: {
                                description_unitaire: 'initial',
                                rho_before: [1.1],
                                rho_after: [0.9],
                                max_rho: 0.9,
                                max_rho_line: 'LINE_B',
                                is_rho_reduction: true,
                                is_manual: false,
                            },
                        },
                        lines_overloaded: ['LINE_A'],
                        message: '',
                        dc_fallback: false,
                    });
                }
            };
            const mockOnSelect = vi.fn();

            act(() => {
                result.current.handleActionResimulated(
                    'load_shedding_L1',
                    newDetail,
                    ['LINE_A'],
                    mockSetResult as React.Dispatch<React.SetStateAction<AnalysisResult | null>>,
                    mockOnSelect,
                );
            });

            expect(result.current.selectedActionIds.has('load_shedding_L1')).toBe(false);
            expect(result.current.manuallyAddedIds.has('load_shedding_L1')).toBe(false);
            // The force-select callback is still fired so the diagram
            // re-fetches with the new state.
            expect(mockOnSelect).toHaveBeenCalledWith('load_shedding_L1');
            // The action detail got updated, but is_manual stays false
            // because the existing entry had is_manual=false.
            expect(captured?.actions.load_shedding_L1.rho_after).toEqual([0.7]);
            expect(captured?.actions.load_shedding_L1.is_manual).toBe(false);
        });

        it('preserves an existing is_manual=true flag on resimulation', () => {
            const { result } = renderHook(() => useActions());
            let captured: AnalysisResult | null = null;
            const mockSetResult = (updater: unknown) => {
                if (typeof updater === 'function') {
                    captured = (updater as (p: AnalysisResult | null) => AnalysisResult | null)({
                        pdf_path: null, pdf_url: null, actions: {
                            load_shedding_L1: {
                                description_unitaire: 'initial',
                                rho_before: [1.1],
                                rho_after: [0.9],
                                max_rho: 0.9,
                                max_rho_line: 'LINE_B',
                                is_rho_reduction: true,
                                is_manual: true,
                            },
                        },
                        lines_overloaded: ['LINE_A'],
                        message: '',
                        dc_fallback: false,
                    });
                }
            };

            act(() => {
                result.current.handleActionResimulated(
                    'load_shedding_L1',
                    newDetail,
                    ['LINE_A'],
                    mockSetResult as React.Dispatch<React.SetStateAction<AnalysisResult | null>>,
                    vi.fn(),
                );
            });

            expect(captured?.actions.load_shedding_L1.is_manual).toBe(true);
        });

        // Regression guard: handleManualActionAdded still promotes into
        // both sets (the "add brand-new manual action" path is unchanged).
        it('handleManualActionAdded still promotes into Selected and Manually-Added', () => {
            const { result } = renderHook(() => useActions());

            act(() => {
                result.current.handleManualActionAdded(
                    'new_manual_action',
                    newDetail,
                    ['LINE_A'],
                    vi.fn(),
                    vi.fn(),
                );
            });

            expect(result.current.selectedActionIds.has('new_manual_action')).toBe(true);
            expect(result.current.manuallyAddedIds.has('new_manual_action')).toBe(true);
        });

        it('does NOT log from the hook on resimulation (logging moved to ActionFeed)', () => {
            // action_mw_resimulated / pst_tap_resimulated events need the
            // user-edited target value, which is only known at the call
            // site (ActionFeed.handleResimulate / handleResimulateTap).
            // The hook itself must stay silent — previously it logged a
            // misleading 'manual_action_simulated' event that conflated
            // the two flows and made replay impossible.
            const { result } = renderHook(() => useActions());

            act(() => {
                result.current.handleActionResimulated(
                    'act_7',
                    newDetail,
                    [],
                    vi.fn(),
                    vi.fn(),
                );
            });

            const log = interactionLogger.getLog();
            expect(log.some(e => e.type === 'manual_action_simulated' && e.details.action_id === 'act_7')).toBe(false);
            expect(log.some(e => e.type === 'action_mw_resimulated' && e.details.action_id === 'act_7')).toBe(false);
            expect(log.some(e => e.type === 'pst_tap_resimulated' && e.details.action_id === 'act_7')).toBe(false);
        });
    });

    // Regression for the manual-sim overload-name fix. The backend's
    // ``simulate_manual_action`` returns ``lines_overloaded`` populated
    // from ``obs.name_line`` — grid2op's synthetic ``line_<i>`` strings
    // when no ``_analysis_context`` is set yet, which the frontend's
    // ``displayName`` resolver has no mapping for. The hook used to
    // promote that array into ``result.lines_overloaded`` whenever the
    // prev value was empty, poisoning the ActionCard's "Overload
    // loading after" row. Now App.tsx falls back to
    // ``n1Diagram.lines_overloaded`` (authoritative pypowsybl-style
    // identifiers) and the hook leaves ``lines_overloaded`` empty so
    // the fallback can take effect. Only step1 / session reload write
    // the field.
    describe('lines_overloaded poisoning regression', () => {
        const detail: ActionDetail = {
            description_unitaire: 'test',
            rho_before: [1.1],
            rho_after: [0.9],
            max_rho: 0.9,
            max_rho_line: 'LINE_X',
            is_rho_reduction: true,
        };

        it('handleManualActionAdded does NOT promote response lines_overloaded into result.lines_overloaded (prev is null)', () => {
            const { result } = renderHook(() => useActions());
            let captured: AnalysisResult | null = null;
            const setResult = (updater: unknown) => {
                if (typeof updater === 'function') {
                    captured = (updater as (p: AnalysisResult | null) => AnalysisResult | null)(null);
                }
            };

            act(() => {
                result.current.handleManualActionAdded(
                    'manual_x',
                    detail,
                    // Manual-sim response field — grid2op synthetic names.
                    ['line_0', 'line_1'],
                    setResult as React.Dispatch<React.SetStateAction<AnalysisResult | null>>,
                    vi.fn(),
                );
            });

            expect(captured).not.toBeNull();
            // Stays empty — App.tsx will fall back to n1Diagram.
            expect(captured!.lines_overloaded).toEqual([]);
            // The action detail still lands in result.actions.
            expect(captured!.actions.manual_x).toBeDefined();
            expect(captured!.actions.manual_x.is_manual).toBe(true);
        });

        it('handleManualActionAdded preserves an existing analysis result lines_overloaded (post-step1)', () => {
            const { result } = renderHook(() => useActions());
            let captured: AnalysisResult | null = null;
            const setResult = (updater: unknown) => {
                if (typeof updater === 'function') {
                    captured = (updater as (p: AnalysisResult | null) => AnalysisResult | null)({
                        pdf_path: null, pdf_url: null, actions: {},
                        // step1 wrote the friendly pypowsybl-style names.
                        lines_overloaded: ['BEON L31CPVAN'],
                        message: '', dc_fallback: false,
                    });
                }
            };

            act(() => {
                result.current.handleManualActionAdded(
                    'manual_x',
                    detail,
                    // Even when the response would have polluted the field
                    // with grid2op synthetic names, the existing step1
                    // value must survive.
                    ['line_0'],
                    setResult as React.Dispatch<React.SetStateAction<AnalysisResult | null>>,
                    vi.fn(),
                );
            });

            expect(captured!.lines_overloaded).toEqual(['BEON L31CPVAN']);
        });

        it('handleActionResimulated does NOT promote response lines_overloaded into result.lines_overloaded', () => {
            const { result } = renderHook(() => useActions());
            let captured: AnalysisResult | null = null;
            const setResult = (updater: unknown) => {
                if (typeof updater === 'function') {
                    captured = (updater as (p: AnalysisResult | null) => AnalysisResult | null)({
                        pdf_path: null, pdf_url: null,
                        actions: {
                            existing: {
                                description_unitaire: 'before',
                                rho_before: [1.1], rho_after: [1.0],
                                max_rho: 1.0, max_rho_line: 'A',
                                is_rho_reduction: false, is_manual: false,
                            },
                        },
                        // Pre-existing analysis-result list — must stay.
                        lines_overloaded: ['BEON L31CPVAN'],
                        message: '', dc_fallback: false,
                    });
                }
            };

            act(() => {
                result.current.handleActionResimulated(
                    'existing',
                    detail,
                    ['line_0', 'line_1'],
                    setResult as React.Dispatch<React.SetStateAction<AnalysisResult | null>>,
                    vi.fn(),
                );
            });

            expect(captured!.lines_overloaded).toEqual(['BEON L31CPVAN']);
            expect(captured!.actions.existing.rho_after).toEqual([0.9]);
        });
    });

    // `origin` records action provenance — distinct from `is_manual`,
    // which is an overloaded UI-state flag (also stamped true when the
    // operator stars a recommender suggestion). `origin` is set once at
    // creation and never changes.
    describe('action origin provenance', () => {
        const detail: ActionDetail = {
            description_unitaire: 'test',
            rho_before: [1.1],
            rho_after: [0.9],
            max_rho: 0.9,
            max_rho_line: 'LINE_X',
            is_rho_reduction: true,
        };

        const captureSetResult = (initial: AnalysisResult | null) => {
            let captured: AnalysisResult | null = null;
            const setResult = (updater: unknown) => {
                if (typeof updater === 'function') {
                    captured = (updater as (p: AnalysisResult | null) => AnalysisResult | null)(initial);
                }
            };
            return { setResult: setResult as React.Dispatch<React.SetStateAction<AnalysisResult | null>>, get: () => captured };
        };

        it('handleManualActionAdded stamps origin="user" by default', () => {
            const { result } = renderHook(() => useActions());
            const { setResult, get } = captureSetResult(null);

            act(() => {
                result.current.handleManualActionAdded('manual_x', detail, [], setResult, vi.fn());
            });

            expect(get()!.actions.manual_x.origin).toBe('user');
        });

        it('handleManualActionAdded accepts a custom origin (unsimulated-pin path passes the model)', () => {
            const { result } = renderHook(() => useActions());
            const { setResult, get } = captureSetResult(null);

            act(() => {
                result.current.handleManualActionAdded('pin_x', detail, [], setResult, vi.fn(), 'random_overflow');
            });

            expect(get()!.actions.pin_x.origin).toBe('random_overflow');
        });

        it('handleManualActionAdded keeps a pre-existing origin (first provenance wins)', () => {
            const { result } = renderHook(() => useActions());
            const { setResult, get } = captureSetResult({
                pdf_path: null, pdf_url: null,
                actions: {
                    act_1: { ...detail, origin: 'expert', is_manual: false },
                },
                lines_overloaded: [], message: '', dc_fallback: false,
            });

            act(() => {
                // Even though the default origin is "user", the existing
                // recommender origin must survive.
                result.current.handleManualActionAdded('act_1', detail, [], setResult, vi.fn());
            });

            expect(get()!.actions.act_1.origin).toBe('expert');
        });

        it('handleActionResimulated preserves the existing origin', () => {
            const { result } = renderHook(() => useActions());
            const { setResult, get } = captureSetResult({
                pdf_path: null, pdf_url: null,
                actions: {
                    act_1: { ...detail, origin: 'random_overflow', is_manual: false },
                },
                lines_overloaded: [], message: '', dc_fallback: false,
            });

            act(() => {
                result.current.handleActionResimulated('act_1', detail, [], setResult, vi.fn());
            });

            // Re-simulation changes metrics, never provenance.
            expect(get()!.actions.act_1.origin).toBe('random_overflow');
        });

        it('handleActionFavorite does NOT change the origin of a recommender suggestion', () => {
            const { result } = renderHook(() => useActions());
            const { setResult, get } = captureSetResult({
                pdf_path: null, pdf_url: null,
                actions: {
                    act_1: { ...detail, origin: 'expert', is_manual: false },
                },
                lines_overloaded: [], message: '', dc_fallback: false,
            });

            act(() => {
                result.current.handleActionFavorite('act_1', setResult);
            });

            // Starring stamps is_manual=true but the action still
            // *originated* from the model.
            expect(get()!.actions.act_1.is_manual).toBe(true);
            expect(get()!.actions.act_1.origin).toBe('expert');
        });
    });
});