Merge pull request #265 from PolicyEngine/feat/current-law-selector

Add current law selector to sim setup

Author: anth-volk

app/src/flows/simulationCreationFlow.ts

@@ -25,6 +25,7 @@ export const SimulationCreationFlow: Flow = {
           returnTo: 'SimulationSetupFrame',
         },
         loadExisting: 'SimulationSelectExistingPolicyFrame',
+        selectCurrentLaw: 'SimulationSetupFrame',
       },
     },
     SimulationSelectExistingPolicyFrame: {

app/src/frames/simulation/SimulationSetupPolicyFrame.tsx

@@ -1,10 +1,20 @@
 import { useState } from 'react';
+import { useDispatch, useSelector } from 'react-redux';
 import FlowView from '@/components/common/FlowView';
+import { useCurrentCountry } from '@/hooks/useCurrentCountry';
+import { selectCurrentPosition } from '@/reducers/activeSelectors';
+import { createPolicyAtPosition } from '@/reducers/policyReducer';
+import { RootState } from '@/store';
 import { FlowComponentProps } from '@/types/flow';
 
-type SetupAction = 'createNew' | 'loadExisting';
+type SetupAction = 'createNew' | 'loadExisting' | 'selectCurrentLaw';
 
 export default function SimulationSetupPolicyFrame({ onNavigate }: FlowComponentProps) {
+  const dispatch = useDispatch();
+  const country = useCurrentCountry();
+  const currentPosition = useSelector((state: RootState) => selectCurrentPosition(state));
+  const currentLawId = useSelector((state: RootState) => state.metadata.currentLawId);
+
   const [selectedAction, setSelectedAction] = useState<SetupAction | null>(null);
 
   function handleClickCreateNew() {
@@ -15,13 +25,42 @@ export default function SimulationSetupPolicyFrame({ onNavigate }: FlowComponent
     setSelectedAction('loadExisting');
   }
 
+  function handleClickCurrentLaw() {
+    setSelectedAction('selectCurrentLaw');
+  }
+
+  function handleSubmitCurrentLaw() {
+    // Create current law policy at the current position
+    dispatch(
+      createPolicyAtPosition({
+        position: currentPosition,
+        policy: {
+          id: currentLawId.toString(),
+          label: 'Current law',
+          parameters: [], // Empty parameters = current law
+          isCreated: true, // Already exists (it's the baseline)
+          countryId: country,
+        },
+      })
+    );
+  }
+
   function handleClickSubmit() {
-    if (selectedAction) {
+    if (selectedAction === 'selectCurrentLaw') {
+      handleSubmitCurrentLaw();
+      onNavigate(selectedAction);
+    } else if (selectedAction) {
       onNavigate(selectedAction);
     }
   }
 
   const buttonPanelCards = [
+    {
+      title: 'Current Law',
+      description: 'Use the baseline tax-benefit system with no reforms',
+      onClick: handleClickCurrentLaw,
+      isSelected: selectedAction === 'selectCurrentLaw',
+    },
     {
       title: 'Load Existing Policy',
       description: 'Use a policy you have already created',

app/src/tests/fixtures/frames/SimulationSetupPolicyFrameMocks.ts

@@ -0,0 +1,107 @@
+import { vi } from 'vitest';
+import { RootState } from '@/store';
+
+// Test constants
+export const TEST_CURRENT_LAW_IDS = {
+  US: 2,
+  UK: 1,
+} as const;
+
+export const TEST_COUNTRIES = {
+  US: 'us',
+  UK: 'uk',
+} as const;
+
+// Button order constants for testing
+export const BUTTON_ORDER = {
+  CURRENT_LAW: 0,
+  LOAD_EXISTING: 1,
+  CREATE_NEW: 2,
+} as const;
+
+export const BUTTON_TEXT = {
+  CURRENT_LAW: {
+    title: 'Current Law',
+    description: 'Use the baseline tax-benefit system with no reforms',
+  },
+  LOAD_EXISTING: {
+    title: 'Load Existing Policy',
+    description: 'Use a policy you have already created',
+  },
+  CREATE_NEW: {
+    title: 'Create New Policy',
+    description: 'Build a new policy',
+  },
+} as const;
+
+// Mock navigation function
+export const mockOnNavigate = vi.fn();
+
+// Mock dispatch function
+export const mockDispatch = vi.fn();
+
+// Helper to create mock Redux state for SimulationSetupPolicyFrame
+export const createMockSimulationSetupPolicyState = (overrides?: {
+  countryId?: string;
+  currentLawId?: number;
+  mode?: 'standalone' | 'report';
+  activeSimulationPosition?: 0 | 1;
+}): Partial<RootState> => {
+  const {
+    countryId = TEST_COUNTRIES.US,
+    currentLawId = TEST_CURRENT_LAW_IDS.US,
+    mode = 'standalone',
+    activeSimulationPosition = 0,
+  } = overrides || {};
+
+  return {
+    metadata: {
+      currentCountry: countryId,
+      loading: false,
+      error: null,
+      variables: {},
+      parameters: {},
+      entities: {},
+      variableModules: {},
+      economyOptions: { region: [], time_period: [], datasets: [] },
+      currentLawId,
+      basicInputs: [],
+      modelledPolicies: { core: {}, filtered: {} },
+      version: '1.0.0',
+      parameterTree: null,
+    },
+    report: {
+      id: '',
+      label: null,
+      countryId: countryId as any,
+      apiVersion: null,
+      simulationIds: [],
+      status: 'pending',
+      output: null,
+      createdAt: new Date().toISOString(),
+      updatedAt: new Date().toISOString(),
+      activeSimulationPosition,
+      mode,
+    },
+    policy: {
+      policies: [null, null],
+    },
+  };
+};
+
+// Expected policy payloads for current law
+export const expectedCurrentLawPolicyUS = {
+  id: TEST_CURRENT_LAW_IDS.US.toString(),
+  label: 'Current law',
+  parameters: [],
+  isCreated: true,
+  countryId: TEST_COUNTRIES.US,
+};
+
+export const expectedCurrentLawPolicyUK = {
+  id: TEST_CURRENT_LAW_IDS.UK.toString(),
+  label: 'Current law',
+  parameters: [],
+  isCreated: true,
+  countryId: TEST_COUNTRIES.UK,
+};

app/src/tests/fixtures/integration/currentLawFlowMocks.ts

@@ -0,0 +1,106 @@
+import { vi } from 'vitest';
+import { countryIds } from '@/libs/countries';
+import type { Population } from '@/types/ingredients/Population';
+
+// Test constants for current law integration tests
+export const INTEGRATION_TEST_COUNTRIES = {
+  US: 'us',
+  UK: 'uk',
+} as const;
+
+export const INTEGRATION_TEST_CURRENT_LAW_IDS = {
+  US: 2,
+  UK: 1,
+} as const;
+
+// Mock metadata for US with current law ID
+export const mockUSMetadata = {
+  status: 'success',
+  message: null,
+  result: {
+    variables: {},
+    parameters: {},
+    entities: {},
+    variableModules: {},
+    economy_options: {
+      region: [{ name: 'us', label: 'United States' }],
+      time_period: [{ name: 2025, label: '2025' }],
+      datasets: [],
+    },
+    current_law_id: INTEGRATION_TEST_CURRENT_LAW_IDS.US,
+    basicInputs: [],
+    modelled_policies: { core: {}, filtered: {} },
+    version: '1.0.0',
+  },
+};
+
+// Mock metadata for UK with current law ID
+export const mockUKMetadata = {
+  status: 'success',
+  message: null,
+  result: {
+    variables: {},
+    parameters: {},
+    entities: {},
+    variableModules: {},
+    economy_options: {
+      region: [{ name: 'uk', label: 'United Kingdom' }],
+      time_period: [{ name: 2025, label: '2025' }],
+      datasets: [],
+    },
+    current_law_id: INTEGRATION_TEST_CURRENT_LAW_IDS.UK,
+    basicInputs: [],
+    modelled_policies: { core: {}, filtered: {} },
+    version: '1.0.0',
+  },
+};
+
+// Expected current law policy objects after creation
+export const expectedCurrentLawPolicyUS = {
+  id: INTEGRATION_TEST_CURRENT_LAW_IDS.US.toString(),
+  label: 'Current law',
+  parameters: [],
+  isCreated: true,
+  countryId: INTEGRATION_TEST_COUNTRIES.US,
+};
+
+export const expectedCurrentLawPolicyUK = {
+  id: INTEGRATION_TEST_CURRENT_LAW_IDS.UK.toString(),
+  label: 'Current law',
+  parameters: [],
+  isCreated: true,
+  countryId: INTEGRATION_TEST_COUNTRIES.UK,
+};
+
+// Mock population for simulation setup
+export const mockPopulation: Population = {
+  label: 'Test Population',
+  isCreated: true,
+  household: {
+    id: 'household-123',
+    countryId: 'us' as (typeof countryIds)[number],
+    householdData: {
+      people: {},
+    },
+  },
+  geography: null,
+};
+
+// Helper to create mock fetch implementation for metadata
+export const createMetadataFetchMock = (country: string) => {
+  return vi.fn().mockImplementation((url: string) => {
+    if (url.includes(`/${country}/metadata`)) {
+      const metadata = country === 'us' ? mockUSMetadata : mockUKMetadata;
+      return Promise.resolve({
+        ok: true,
+        status: 200,
+        json: () => Promise.resolve(metadata),
+      });
+    }
+    return Promise.resolve({
+      ok: false,
+      status: 404,
+      json: () => Promise.resolve({ error: 'Not found' }),
+    });
+  });
+};