Skip to content

A local-first personal finance app

7.5 KB
Raw Blame
import { send } from '@actual-app/core/platform/client/connection';
import * as monthUtils from '@actual-app/core/shared/months';
import { getNormalisedString } from '@actual-app/core/shared/normalisation';
import { unicodeLike } from '@actual-app/core/shared/unicodeLike';
import type { Handlers } from '@actual-app/core/types/handlers';
import type {
  CategoryEntity,
  CategoryGroupEntity,
  RuleConditionEntity,
} from '@actual-app/core/types/models';
import type { SyncedPrefs } from '@actual-app/core/types/prefs';

import type { QueryDataEntity } from '#components/reports/ReportOptions';

import type { BudgetMonthCell } from './budgetMonthCell';

type BudgetDataConditionsOp = 'and' | 'or';

async function mapWithConcurrency<TItem, TResult>(
  items: TItem[],
  concurrency: number,
  mapper: (item: TItem, index: number) => Promise<TResult>,
): Promise<TResult[]> {
  if (items.length === 0) {
    return [];
  }

  const results: TResult[] = new Array(items.length);
  const safeConcurrency = Math.max(1, Math.min(concurrency, items.length));
  let nextIndex = 0;

  const workers = Array.from({ length: safeConcurrency }, async () => {
    while (true) {
      const currentIndex = nextIndex;
      nextIndex += 1;
      if (currentIndex >= items.length) {
        return;
      }

      results[currentIndex] = await mapper(items[currentIndex], currentIndex);
    }
  });

  await Promise.all(workers);
  return results;
}

export function isSupportedCategoryCondition(
  condition: RuleConditionEntity,
): boolean {
  if (condition.field !== 'category' && condition.field !== 'category_group') {
    return false;
  }

  if (condition.op === 'is' || condition.op === 'isNot') {
    return condition.value === null || typeof condition.value === 'string';
  }

  if (condition.op === 'oneOf' || condition.op === 'notOneOf') {
    return (
      Array.isArray(condition.value) &&
      condition.value.every(id => id === null || typeof id === 'string')
    );
  }

  if (
    condition.op === 'contains' ||
    condition.op === 'doesNotContain' ||
    condition.op === 'matches'
  ) {
    return typeof condition.value === 'string';
  }

  return false;
}

export function filterCategoriesByConditions<
  TCategory extends { id: string | null; name: string; group: string | null },
>(
  categories: TCategory[],
  categoryGroups: CategoryGroupEntity[],
  conditions: RuleConditionEntity[] | undefined,
  conditionsOp: BudgetDataConditionsOp | undefined,
) {
  if (!conditions || conditions.length === 0) {
    return categories;
  }

  const categoryConditions = conditions.filter(
    (
      cond,
    ): cond is Extract<
      RuleConditionEntity,
      { field: 'category' | 'category_group' }
    > =>
      !cond.customName &&
      (cond.field === 'category' || cond.field === 'category_group'),
  );

  if (categoryConditions.length === 0) {
    return categories;
  }

  const categoryGroupNameById = new Map(
    categoryGroups.map(group => [group.id, group.name] as const),
  );

  // If we can't safely interpret any category condition, do not attempt to
  // filter categories (better to be broad than silently exclude data).
  if (!categoryConditions.every(isSupportedCategoryCondition)) {
    return categories;
  }

  const evaluateCondition = (
    category: TCategory,
    condition: Extract<
      RuleConditionEntity,
      { field: 'category' | 'category_group' }
    >,
  ): boolean => {
    const key =
      condition.field === 'category_group' ? category.group : category.id;
    const textValue =
      condition.field === 'category_group'
        ? (categoryGroupNameById.get(key ?? '') ?? key)
        : category.id === null
          ? null
          : category.name;

    if (condition.op === 'is') {
      return key === condition.value;
    }

    if (condition.op === 'isNot') {
      return key !== condition.value;
    }

    if (condition.op === 'oneOf') {
      return (
        Array.isArray(condition.value) && condition.value.some(id => id === key)
      );
    }

    if (condition.op === 'notOneOf') {
      return (
        Array.isArray(condition.value) &&
        condition.value.length > 0 &&
        !condition.value.some(id => id === key)
      );
    }

    if (
      (condition.op === 'contains' || condition.op === 'doesNotContain') &&
      typeof condition.value === 'string'
    ) {
      const matches = unicodeLike(
        '%' + getNormalisedString(condition.value) + '%',
        textValue === null ? null : getNormalisedString(textValue),
      );
      return condition.op === 'contains'
        ? !!matches
        : textValue === null || !matches;
    }

    if (condition.op === 'matches' && typeof condition.value === 'string') {
      // Skip long patterns without excluding possible transaction-query matches.
      if (condition.value.length > 256) {
        return true;
      }
      try {
        return new RegExp(condition.value).test(textValue ?? '');
      } catch {
        return false;
      }
    }

    return true;
  };

  const op: BudgetDataConditionsOp = conditionsOp === 'or' ? 'or' : 'and';

  return categories.filter(cat =>
    op === 'or'
      ? categoryConditions.some(cond => evaluateCondition(cat, cond))
      : categoryConditions.every(cond => evaluateCondition(cat, cond)),
  );
}

export async function fetchBudgetData({
  startDate,
  endDate,
  interval,
  categories,
  categoryGroups,
  conditions,
  conditionsOp,
  budgetType = 'envelope',
}: {
  startDate: string;
  endDate: string;
  interval: string;
  categories: CategoryEntity[];
  categoryGroups: CategoryGroupEntity[];
  conditions?: RuleConditionEntity[];
  conditionsOp?: BudgetDataConditionsOp;
  budgetType?: SyncedPrefs['budgetType'];
}): Promise<{ assets: QueryDataEntity[]; debts: QueryDataEntity[] }> {
  const groupById = new Map(categoryGroups.map(g => [g.id, g] as const));
  const assets: QueryDataEntity[] = [];
  const debts: QueryDataEntity[] = [];

  const filteredCategories = filterCategoriesByConditions(
    categories,
    categoryGroups,
    conditions,
    conditionsOp,
  );

  const months = monthUtils.rangeInclusive(
    monthUtils.getMonth(startDate),
    monthUtils.getMonth(endDate),
  );

  const monthFetchConcurrency = 8;
  const endpointName: keyof Handlers =
    budgetType === 'tracking'
      ? 'tracking-budget-month'
      : 'envelope-budget-month';

  const monthDataList = await mapWithConcurrency(
    months,
    monthFetchConcurrency,
    async month => ({
      month,
      monthData: await send(endpointName, { month }),
    }),
  );

  for (const { month, monthData } of monthDataList) {
    const dateKey =
      interval === 'Yearly'
        ? month.slice(0, 4)
        : interval === 'Quarterly'
          ? monthUtils.quarterFromDate(month)
          : month;

    for (const cat of filteredCategories) {
      if (cat.is_income) {
        continue;
      }

      const budgetCell = monthData.find((cell: BudgetMonthCell) =>
        cell.name.endsWith(`budget-${cat.id}`),
      );

      const amount = Number(budgetCell?.value) || 0;
      if (amount === 0) {
        continue;
      }

      const group = cat.group ? groupById.get(cat.group) : undefined;

      const entry: QueryDataEntity = {
        date: dateKey,
        category: cat.id,
        categoryHidden: cat.hidden ?? false,
        categoryGroup: cat.group ?? '',
        categoryGroupHidden: group?.hidden ?? false,
        account: '',
        accountOffBudget: false,
        payee: '',
        transferAccount: '',
        amount,
      };

      if (amount > 0) {
        assets.push(entry);
      } else {
        debts.push(entry);
      }
    }
  }

  return { assets, debts };
}