Skip to content

A local-first personal finance app

9.4 KB
Raw Blame
import type { ScheduleEntity } from '@actual-app/core/types/models';
import type { Template } from '@actual-app/core/types/models/templates';

import { migrateTemplatesToAutomations } from './migrateTemplatesToAutomations';

function schedule(id: string, name: string): ScheduleEntity {
  return {
    id,
    name,
    rule: 'rule-1',
    next_date: '2026-01-01',
    completed: false,
    posts_transaction: false,
    tombstone: false,
    _payee: 'payee-1',
    _account: 'account-1',
    _amount: 0,
    _amountOp: 'is',
    _date: '2026-01-01',
    _conditions: [],
    _actions: [],
  };
}

describe('migrateTemplatesToAutomations', () => {
  it('drops simple templates that have no limit and no monthly amount', () => {
    // these would otherwise be pushed as a phantom 'fixed' entry that
    // crashes FixedAutomationReadOnly (no .amount, no .period)
    const simpleTemplate = {
      type: 'simple',
      directive: 'template',
      priority: 5,
    } satisfies Template;

    expect(migrateTemplatesToAutomations([simpleTemplate])).toEqual([]);
  });

  it('migrates a standalone `#template 0` (no limit) into a $0 fixed entry', () => {
    const simpleTemplate = {
      type: 'simple',
      directive: 'template',
      priority: 5,
      monthly: 0,
    } satisfies Template;

    const result = migrateTemplatesToAutomations([simpleTemplate]);

    expect(result).toHaveLength(1);
    expect(result[0].displayType).toBe('fixed');
    expect(result[0].template).toMatchObject({
      type: 'periodic',
      amount: 0,
      period: { period: 'month', amount: 1 },
      directive: 'template',
      priority: 5,
    });
  });

  it('migrates a goal directive to a long-term goal entry', () => {
    const goalTemplate = {
      type: 'goal',
      amount: 1000,
      directive: 'goal',
    } satisfies Template;

    const [entry, ...rest] = migrateTemplatesToAutomations([goalTemplate]);
    expect(rest).toHaveLength(0);
    expect(entry.displayType).toBe('goal');
    expect(entry.template).toEqual(goalTemplate);
  });

  it('expands a simple template with limit into limit and refill entries', () => {
    const simpleTemplate = {
      type: 'simple',
      directive: 'template',
      priority: 7,
      limit: {
        amount: 120,
        hold: true,
        period: 'monthly',
        start: '2026-02-01',
      },
    } satisfies Template;

    const result = migrateTemplatesToAutomations([simpleTemplate]);

    expect(result).toHaveLength(2);
    expect(result[0].displayType).toBe('limit');
    expect(result[0].template).toEqual({
      type: 'limit',
      amount: 120,
      hold: true,
      period: 'monthly',
      start: '2026-02-01',
      directive: 'template',
      priority: null,
    });
    expect(result[1].displayType).toBe('refill');
    expect(result[1].template).toEqual({
      type: 'refill',
      directive: 'template',
      priority: 7,
    });
  });

  it('expands a simple template with monthly amount into one periodic entry', () => {
    const simpleTemplate = {
      type: 'simple',
      directive: 'template',
      priority: 3,
      monthly: 45,
    } satisfies Template;

    const result = migrateTemplatesToAutomations([simpleTemplate]);

    expect(result).toHaveLength(1);
    expect(result[0].displayType).toBe('fixed');
    expect(result[0].template).toMatchObject({
      type: 'periodic',
      amount: 45,
      period: {
        period: 'month',
        amount: 1,
      },
      directive: 'template',
      priority: 3,
    });
    expect(result[0].template).toMatchObject({
      starting: expect.any(String),
    });
  });

  it('expands `#template 0 up to N` into a standalone limit (no refill, no $0 contribution)', () => {
    const simpleTemplate = {
      type: 'simple',
      directive: 'template',
      priority: 4,
      monthly: 0,
      limit: {
        amount: 1000,
        hold: false,
        period: 'monthly',
      },
    } satisfies Template;

    const result = migrateTemplatesToAutomations([simpleTemplate]);

    expect(result).toHaveLength(1);
    expect(result.map(entry => entry.displayType)).toEqual(['limit']);
    expect(result[0].template).toMatchObject({
      type: 'limit',
      amount: 1000,
      directive: 'template',
    });
  });

  it('expands a simple template with both limit and monthly into limit + periodic (no implicit refill)', () => {
    // `#template 20 up to 200 per week` budgets 20/month and caps at the
    // limit — the engine's runSimple returns just the monthly value, so
    // there is no implicit refill-to-cap behaviour to migrate.
    const simpleTemplate = {
      type: 'simple',
      directive: 'template',
      priority: 11,
      monthly: 20,
      limit: {
        amount: 200,
        hold: false,
        period: 'weekly',
      },
    } satisfies Template;

    const result = migrateTemplatesToAutomations([simpleTemplate]);

    expect(result).toHaveLength(2);
    expect(result.map(entry => entry.displayType)).toEqual(['limit', 'fixed']);
    expect(result[1].template).toMatchObject({
      type: 'periodic',
      amount: 20,
      directive: 'template',
      priority: 11,
    });
  });

  it('splits a periodic template with an `up to` limit into fixed + limit entries', () => {
    // `#template 32.5 repeat every 1 days starting 2025-02-01 up to 2500`: the
    // fixed editor can't show the inline cap, so the limit must become its own
    // entry rather than vanishing and re-serialising as a duplicate `up to`.
    const periodicTemplate = {
      type: 'periodic',
      directive: 'template',
      priority: 2,
      amount: 32.5,
      period: { period: 'day', amount: 1 },
      starting: '2025-02-01',
      limit: {
        amount: 2500,
        hold: false,
        period: 'monthly',
      },
    } satisfies Template;

    const result = migrateTemplatesToAutomations([periodicTemplate]);

    expect(result).toHaveLength(2);
    expect(result.map(entry => entry.displayType)).toEqual(['fixed', 'limit']);
    expect(result[0].template).toEqual({
      type: 'periodic',
      directive: 'template',
      priority: 2,
      amount: 32.5,
      period: { period: 'day', amount: 1 },
      starting: '2025-02-01',
    });
    expect(result[1].template).toEqual({
      type: 'limit',
      amount: 2500,
      hold: false,
      period: 'monthly',
      start: undefined,
      directive: 'template',
      priority: null,
    });
  });

  it('splits a remainder template with an `up to` limit into remainder + limit entries', () => {
    const remainderTemplate = {
      type: 'remainder',
      directive: 'template',
      priority: null,
      weight: 2,
      limit: {
        amount: 500,
        hold: true,
        period: 'monthly',
      },
    } satisfies Template;

    const result = migrateTemplatesToAutomations([remainderTemplate]);

    expect(result).toHaveLength(2);
    expect(result.map(entry => entry.displayType)).toEqual([
      'remainder',
      'limit',
    ]);
    expect(result[0].template).toEqual({
      type: 'remainder',
      directive: 'template',
      priority: null,
      weight: 2,
    });
    expect(result[1].template).toMatchObject({
      type: 'limit',
      amount: 500,
      hold: true,
      period: 'monthly',
    });
  });

  it('leaves a periodic template without a limit as a single fixed entry', () => {
    const periodicTemplate = {
      type: 'periodic',
      directive: 'template',
      priority: 2,
      amount: 10,
      period: { period: 'month', amount: 1 },
      starting: '2025-02-01',
    } satisfies Template;

    const result = migrateTemplatesToAutomations([periodicTemplate]);

    expect(result).toHaveLength(1);
    expect(result[0].displayType).toBe('fixed');
    expect(result[0].template).toEqual(periodicTemplate);
  });

  it('creates a single entry for non-simple templates', () => {
    const scheduleTemplate = {
      type: 'schedule',
      directive: 'template',
      priority: 1,
      name: 'rent',
    } satisfies Template;

    const result = migrateTemplatesToAutomations([scheduleTemplate]);

    expect(result).toHaveLength(1);
    expect(result[0].displayType).toBe('schedule');
    expect(result[0].template).toEqual(scheduleTemplate);
  });

  it('fills in scheduleId for a name-only schedule template', () => {
    const scheduleTemplate = {
      type: 'schedule',
      directive: 'template',
      priority: 1,
      name: 'Rent',
    } satisfies Template;

    const result = migrateTemplatesToAutomations(
      [scheduleTemplate],
      [schedule('sched-1', 'Rent')],
    );

    expect(result[0].template).toMatchObject({
      scheduleId: 'sched-1',
      name: 'Rent',
    });
  });

  it('refreshes a stale name from scheduleId after a rename', () => {
    const scheduleTemplate = {
      type: 'schedule',
      directive: 'template',
      priority: 1,
      scheduleId: 'sched-1',
      name: 'Old Name',
    } satisfies Template;

    const result = migrateTemplatesToAutomations(
      [scheduleTemplate],
      [schedule('sched-1', 'New Name')],
    );

    expect(result[0].template).toMatchObject({
      scheduleId: 'sched-1',
      name: 'New Name',
    });
  });

  it('leaves a schedule template untouched when no schedule matches', () => {
    const scheduleTemplate = {
      type: 'schedule',
      directive: 'template',
      priority: 1,
      scheduleId: 'missing',
      name: 'Gone',
    } satisfies Template;

    const result = migrateTemplatesToAutomations(
      [scheduleTemplate],
      [schedule('sched-1', 'Rent')],
    );

    expect(result[0].template).toEqual(scheduleTemplate);
  });
});