feat: unify income payment cards and drop period comparisons (WealthLedger/main#33) (#83)
Backend verify / commits (push) Skipped
Backend verify / security (push) Successful in 13s
Backend verify / verify (push) Failing after 7m1s

feat: unify income payment cards and drop period comparisons (WealthLedger/main#33)
This commit was merged in pull request #83.
This commit is contained in:
2026-10-13 18:16:46 +03:00
parent 90486d4237
commit 31b0e15579
14 changed files with 230 additions and 274 deletions
@@ -8,6 +8,7 @@ const allowedFields = new Set([
'asOf', 'asOf',
'attempts', 'attempts',
'brokerageAccountId', 'brokerageAccountId',
'channelState',
'clientRequestId', 'clientRequestId',
'code', 'code',
'count', 'count',
@@ -15,12 +16,15 @@ const allowedFields = new Set([
'environment', 'environment',
'found', 'found',
'grpcCode', 'grpcCode',
'headersReceived',
'method', 'method',
'operation', 'operation',
'queueWaitMs',
'requestId', 'requestId',
'route', 'route',
'service', 'service',
'status', 'status',
'trackingId',
'userId', 'userId',
]); ]);
+64 -1
View File
@@ -1,5 +1,6 @@
import { status } from '@grpc/grpc-js'; import { Metadata, status } from '@grpc/grpc-js';
import { NotFoundException, ServiceUnavailableException } from '@nestjs/common'; import { NotFoundException, ServiceUnavailableException } from '@nestjs/common';
import { EventEmitter } from 'node:events';
import { TbankOperationState } from './tbank-protocol'; import { TbankOperationState } from './tbank-protocol';
import { TbankClient } from './tbank.client'; import { TbankClient } from './tbank.client';
@@ -136,6 +137,68 @@ describe('TbankClient operations', () => {
); );
jest.useRealTimers(); jest.useRealTimers();
}); });
it('distinguishes a gRPC deadline from queue delay without logging upstream secrets', async () => {
const logger = { event: jest.fn() };
const client = Object.assign(Object.create(TbankClient.prototype) as TbankClient, {
logger,
queue: { size: 0, run: (operation: () => Promise<unknown>) => operation() },
});
const channel = { getConnectivityState: () => 1 };
const service = {
getChannel: () => channel,
getAccounts: (_input: unknown, _metadata: unknown, _options: unknown, callback: (error: unknown) => void) => {
const call = new EventEmitter();
void Promise.resolve().then(() => callback({ code: status.DEADLINE_EXCEEDED, details: 'Bearer secret' }));
return call;
},
};
const invoke = (client as unknown as { call: (token: string, service: unknown, method: string, input: object) => Promise<unknown> }).call.bind(client);
jest.useFakeTimers();
try {
const failed = invoke('secret', service, 'getAccounts', {});
await Promise.all([
expect(failed).rejects.toBeInstanceOf(ServiceUnavailableException),
jest.advanceTimersByTimeAsync(1000),
]);
expect(logger.event).toHaveBeenLastCalledWith('error', 'tbank.rpc.failed', expect.objectContaining({
operation: 'getAccounts', grpcCode: status.DEADLINE_EXCEEDED,
queueWaitMs: 0, channelState: 'CONNECTING', headersReceived: false,
}));
expect(JSON.stringify(logger.event.mock.calls)).not.toContain('secret');
} finally {
jest.useRealTimers();
}
});
it('records response headers and a validated upstream tracking ID', async () => {
const logger = { event: jest.fn() };
const client = Object.assign(Object.create(TbankClient.prototype) as TbankClient, {
logger,
queue: { size: 0, run: (operation: () => Promise<unknown>) => operation() },
});
const headers = new Metadata();
headers.set('x-tracking-id', '123e4567-e89b-12d3-a456-426614174000');
headers.set('authorization', 'Bearer secret');
const service = {
getChannel: () => ({ getConnectivityState: () => 2 }),
getAccounts: (_input: unknown, _metadata: unknown, _options: unknown, callback: (error: null, response: object) => void) => {
const call = new EventEmitter();
void Promise.resolve().then(() => {
call.emit('metadata', headers);
callback(null, { accounts: [] });
});
return call;
},
};
const invoke = (client as unknown as { call: (token: string, service: unknown, method: string, input: object) => Promise<unknown> }).call.bind(client);
await expect(invoke('secret', service, 'getAccounts', {})).resolves.toEqual({ accounts: [] });
expect(logger.event).toHaveBeenLastCalledWith('debug', 'tbank.rpc.completed', expect.objectContaining({
channelState: 'READY', headersReceived: true,
trackingId: '123e4567-e89b-12d3-a456-426614174000',
}));
expect(JSON.stringify(logger.event.mock.calls)).not.toContain('secret');
});
}); });
describe('TbankClient metadata retries', () => { describe('TbankClient metadata retries', () => {
+43 -4
View File
@@ -2,6 +2,7 @@ import {
ChannelCredentials, ChannelCredentials,
Client, Client,
ClientUnaryCall, ClientUnaryCall,
connectivityState,
loadPackageDefinition, loadPackageDefinition,
Metadata, Metadata,
ServiceError, ServiceError,
@@ -60,6 +61,12 @@ type Unary<Request, Response> = (
callback: (error: null | ServiceError, response: Response) => void, callback: (error: null | ServiceError, response: Response) => void,
) => ClientUnaryCall; ) => ClientUnaryCall;
type TbankClientService = Client & Record<string, Unary<never, never>>; type TbankClientService = Client & Record<string, Unary<never, never>>;
type RpcDiagnostics = {
channelState?: string;
headersReceived?: boolean;
queueWaitMs?: number;
trackingId?: string;
};
export type TbankDecimal = { nano?: number | string; units?: number | string }; export type TbankDecimal = { nano?: number | string; units?: number | string };
export type TbankMoney = TbankDecimal & { currency?: string }; export type TbankMoney = TbankDecimal & { currency?: string };
export type TbankAccount = { export type TbankAccount = {
@@ -511,15 +518,20 @@ export class TbankClient {
for (let attempts = FIRST_ATTEMPT; attempts <= RPC_MAX_ATTEMPTS; attempts += ATTEMPT_INCREMENT) { for (let attempts = FIRST_ATTEMPT; attempts <= RPC_MAX_ATTEMPTS; attempts += ATTEMPT_INCREMENT) {
const startedAt = performance.now(); const startedAt = performance.now();
const queueFull = this.queue.size >= MAX_QUEUE_SIZE; const queueFull = this.queue.size >= MAX_QUEUE_SIZE;
const diagnostics: RpcDiagnostics = {};
try { try {
if (queueFull) { if (queueFull) {
throw new ServiceUnavailableException({ code: TbankErrorCode.Unavailable }); throw new ServiceUnavailableException({ code: TbankErrorCode.Unavailable });
} }
const response = await this.queue.run(() => const response = await this.queue.run(() => {
this.request<Response>(token, client, method, request), diagnostics.queueWaitMs = Math.round(performance.now() - startedAt);
return this.request<Response>(
token, client, method, request, diagnostics,
); );
});
this.logger.event('debug', 'tbank.rpc.completed', { this.logger.event('debug', 'tbank.rpc.completed', {
operation: method, operation: method,
...diagnostics,
attempts, attempts,
durationMs: Math.round(performance.now() - startedAt), durationMs: Math.round(performance.now() - startedAt),
}); });
@@ -537,6 +549,7 @@ export class TbankClient {
if (retryable && attempts < RPC_MAX_ATTEMPTS) { if (retryable && attempts < RPC_MAX_ATTEMPTS) {
this.logger.event('warn', 'tbank.rpc.retry', { this.logger.event('warn', 'tbank.rpc.retry', {
operation: method, operation: method,
...diagnostics,
...failureContext, ...failureContext,
attempts, attempts,
durationMs: Math.round(performance.now() - startedAt), durationMs: Math.round(performance.now() - startedAt),
@@ -546,6 +559,7 @@ export class TbankClient {
} }
this.logger.event('error', 'tbank.rpc.failed', { this.logger.event('error', 'tbank.rpc.failed', {
operation: method, operation: method,
...diagnostics,
...failureContext, ...failureContext,
attempts: queueFull ? NO_RPC_ATTEMPTS : attempts, attempts: queueFull ? NO_RPC_ATTEMPTS : attempts,
durationMs: Math.round(performance.now() - startedAt), durationMs: Math.round(performance.now() - startedAt),
@@ -573,17 +587,42 @@ export class TbankClient {
client: TbankClientService, client: TbankClientService,
method: string, method: string,
request: object, request: object,
diagnostics?: RpcDiagnostics,
): Promise<Response> { ): Promise<Response> {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
const metadata = new Metadata(); const metadata = new Metadata();
metadata.set('Authorization', `Bearer ${token}`); metadata.set('Authorization', `Bearer ${token}`);
// A channel state is a snapshot, not proof that this particular call reached the server.
const channel = diagnostics && client.getChannel();
if (diagnostics) diagnostics.headersReceived = false;
// eslint-disable-next-line security/detect-object-injection -- Service and method names are internal RPC selections, not request input. // eslint-disable-next-line security/detect-object-injection -- Service and method names are internal RPC selections, not request input.
client[method]( const call = client[method](
request as never, request as never,
metadata, metadata,
{ deadline: new Date(Date.now() + requestDeadlineMs) }, { deadline: new Date(Date.now() + requestDeadlineMs) },
(error, response) => (error ? reject(error) : resolve(response)), (error, response) => {
if (diagnostics && channel) {
diagnostics.channelState = connectivityState[
channel.getConnectivityState(false)
];
}
if (error) reject(error);
else resolve(response);
},
); );
if (diagnostics) {
call.on('metadata', (headers: Metadata) => {
diagnostics.headersReceived = true;
const trackingId = headers.get('x-tracking-id')[0];
// Only a UUID may enter logs; never forward arbitrary upstream metadata.
if (
typeof trackingId === 'string' &&
/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test(trackingId)
) {
diagnostics.trackingId = trackingId;
}
});
}
}); });
} }
} }
@@ -67,28 +67,6 @@ export class IncomeSummaryDto {
declare calculatedAt: string; declare calculatedAt: string;
} }
export class IncomeComparisonCurrencyDto {
@ApiProperty()
declare currency: string;
@ApiProperty({ type: IncomeCurrencySummaryDto })
declare selected: IncomeCurrencySummaryDto;
@ApiProperty({ type: IncomeCurrencySummaryDto })
declare compared: IncomeCurrencySummaryDto;
@ApiProperty({ type: IncomeCurrencySummaryDto })
declare difference: IncomeCurrencySummaryDto;
}
export class IncomeComparisonDto {
@ApiProperty({ type: IncomePeriodDto })
declare period: IncomePeriodDto;
@ApiProperty({ type: IncomeComparisonCurrencyDto, isArray: true })
declare totalsByCurrency: IncomeComparisonCurrencyDto[];
}
export class IncomeBucketDto { export class IncomeBucketDto {
@ApiProperty({ type: IncomePeriodDto }) @ApiProperty({ type: IncomePeriodDto })
declare period: IncomePeriodDto; declare period: IncomePeriodDto;
@@ -135,12 +113,6 @@ export class IncomeAnalyticsEntryDto extends BrokerageOperationDto {
} }
export class IncomeAnalyticsDto extends IncomeSummaryDto { export class IncomeAnalyticsDto extends IncomeSummaryDto {
@ApiProperty({ type: IncomeComparisonDto, nullable: true })
declare previous: IncomeComparisonDto | null;
@ApiProperty({ type: IncomeComparisonDto, nullable: true })
declare yearComparison: IncomeComparisonDto | null;
@ApiProperty({ enum: ['day', 'week', 'month'] }) @ApiProperty({ enum: ['day', 'week', 'month'] })
declare bucketGranularity: 'day' | 'month' | 'week'; declare bucketGranularity: 'day' | 'month' | 'week';
@@ -162,7 +134,7 @@ export class IncomeSummaryResourceDto {
declare meta: InvestmentResourceMetaDto; declare meta: InvestmentResourceMetaDto;
} }
const incomeDependencyRoles = ['selected', 'previous', 'year'] as const; const incomeDependencyRoles = ['selected'] as const;
export class IncomeDependencyDto extends InvestmentDependencyDto { export class IncomeDependencyDto extends InvestmentDependencyDto {
@ApiProperty({ enum: incomeDependencyRoles }) @ApiProperty({ enum: incomeDependencyRoles })
@@ -17,7 +17,7 @@ describe('IncomeAnalyticsService', () => {
beforeEach(() => jest.clearAllMocks()); beforeEach(() => jest.clearAllMocks());
it('labels each comparison dependency independently of its resource key', async () => { it('labels the selected dependency independently of its resource key', async () => {
seed([]); seed([]);
const response = await service.analytics( const response = await service.analytics(
'user', 'user',
@@ -27,32 +27,10 @@ describe('IncomeAnalyticsService', () => {
); );
expect(response.meta.dependencies).toEqual([ expect(response.meta.dependencies).toEqual([
expect.objectContaining({ role: 'selected', resourceKey: 'period/0' }), expect.objectContaining({ role: 'selected', resourceKey: 'period/0' }),
expect.objectContaining({ role: 'previous', resourceKey: 'period/1' }),
expect.objectContaining({ role: 'year', resourceKey: 'period/2' }),
]); ]);
}); expect(
response.meta.dependencies.some((dependency) => dependency.role !== 'selected'),
it('labels an unavailable leap-day comparison as year', async () => { ).toBe(false);
operations.collectRanges.mockImplementation(
(_user: string, _account: string, build: () => unknown[]) =>
build().map((_, index) => ({ items: [], meta: completeMeta(index) })),
);
const response = await service.analytics(
'user',
'account',
'2024-02-29',
'2024-02-29',
);
expect(response.meta.dependencies).toEqual([
expect.objectContaining({ role: 'selected' }),
expect.objectContaining({ role: 'previous' }),
expect.objectContaining({
role: 'year',
availability: 'temporarily-unavailable',
unavailableReason: 'CALENDAR_OR_ACCOUNT_HISTORY',
}),
]);
expect(response.data?.yearComparison).toBeNull();
}); });
function seed(items: BrokerageOperationDto[]) { function seed(items: BrokerageOperationDto[]) {
@@ -63,7 +41,7 @@ describe('IncomeAnalyticsService', () => {
build: (opened?: Date) => unknown[], build: (opened?: Date) => unknown[],
) => { ) => {
build(undefined); build(undefined);
return [items, [], []].map((items, index) => ({ return [items].map((items, index) => ({
items, items,
meta: completeMeta(index), meta: completeMeta(index),
})); }));
@@ -247,8 +225,6 @@ describe('IncomeAnalyticsService', () => {
entry('transfer', 'OPERATION_TYPE_DIVIDEND_TRANSFER', '99', 'RUB'), entry('transfer', 'OPERATION_TYPE_DIVIDEND_TRANSFER', '99', 'RUB'),
entry('usd', 'OPERATION_TYPE_COUPON', '1', 'USD'), entry('usd', 'OPERATION_TYPE_COUPON', '1', 'USD'),
], ],
[],
[],
].map((items, index) => ({ items, meta: completeMeta(index) })); ].map((items, index) => ({ items, meta: completeMeta(index) }));
}, },
); );
@@ -6,7 +6,6 @@ import {
compare, compare,
decimalFromString, decimalFromString,
formatDecimal, formatDecimal,
subtract,
} from '../../../common/decimal'; } from '../../../common/decimal';
import { isTbankProtocolValue, TbankOperationType } from '../../../integrations/tbank/tbank-protocol'; import { isTbankProtocolValue, TbankOperationType } from '../../../integrations/tbank/tbank-protocol';
import { DateOnlyRange, moscowDate } from '../investment-calendar'; import { DateOnlyRange, moscowDate } from '../investment-calendar';
@@ -18,7 +17,6 @@ import {
import { import {
IncomeAnalyticsEntryDto, IncomeAnalyticsEntryDto,
IncomeAnalyticsResourceDto, IncomeAnalyticsResourceDto,
IncomeComparisonDto,
IncomeCurrencySummaryDto, IncomeCurrencySummaryDto,
IncomeDependencyDto, IncomeDependencyDto,
IncomeInstrumentDto, IncomeInstrumentDto,
@@ -47,14 +45,11 @@ export class IncomeAnalyticsService {
accountId: string, accountId: string,
observe = false, observe = false,
): Promise<IncomeSummaryResourceDto> { ): Promise<IncomeSummaryResourceDto> {
let plan = planIncomePeriod(undefined, undefined); const plan = planIncomePeriod(undefined, undefined);
const [selected] = await this.operations.collectRanges( const [selected] = await this.operations.collectRanges(
userId, userId,
accountId, accountId,
(openedAt) => { () => [plan.selected],
plan = planIncomePeriod(undefined, undefined, openedAt);
return [plan.selected];
},
observe, observe,
); );
if (selected.items === null) return { data: null, meta: selected.meta }; if (selected.items === null) return { data: null, meta: selected.meta };
@@ -77,44 +72,17 @@ export class IncomeAnalyticsService {
to: string | undefined, to: string | undefined,
observe = false, observe = false,
): Promise<IncomeAnalyticsResourceDto> { ): Promise<IncomeAnalyticsResourceDto> {
let plan = planIncomePeriod(from, to); const plan = planIncomePeriod(from, to);
const periods = await this.operations.collectRanges( const [current] = await this.operations.collectRanges(
userId, userId,
accountId, accountId,
(openedAt) => { () => [plan.selected],
plan = planIncomePeriod(from, to, openedAt);
return [
plan.selected,
plan.previous,
...(plan.yearAgo ? [plan.yearAgo] : []),
];
},
observe, observe,
); );
const [current, prior, year] = periods;
// Preserve the legacy order while consumers migrate to explicit roles.
const dependencies: IncomeDependencyDto[] = [ const dependencies: IncomeDependencyDto[] = [
{ ...current.meta, role: 'selected' }, { ...current.meta, role: 'selected' },
{ ...prior.meta, role: 'previous' },
{
...(plan.yearAgo && year
? year.meta
: investmentResourceMeta({
resourceKey: 'income/yearAgo', // gitleaks:allow public resource identifier
dataRevision: 'unavailable',
availability: 'missing',
fetchedAt: null,
freshForMs: 0,
work: null,
unavailableReason: 'CALENDAR_OR_ACCOUNT_HISTORY',
})),
role: 'year',
},
]; ];
const states = periods.map((period) => period.meta.sync); const work = current.meta.sync;
const work =
states.find((state) => state.state === 'running') ??
states.find((state) => state.state === 'failed');
const meta = { const meta = {
...investmentResourceMeta({ ...investmentResourceMeta({
resourceKey: `income/${accountId}/${plan.selected.from}/${plan.selected.to}`, resourceKey: `income/${accountId}/${plan.selected.from}/${plan.selected.to}`,
@@ -127,7 +95,9 @@ export class IncomeAnalyticsService {
? new Date(current.meta.lastSuccessfulAt) ? new Date(current.meta.lastSuccessfulAt)
: null, : null,
freshForMs: current.meta.freshness === 'fresh' ? Infinity : STALE_FRESHNESS_MS, freshForMs: current.meta.freshness === 'fresh' ? Infinity : STALE_FRESHNESS_MS,
work: work?.id ? { ...work, id: work.id } : null, work: work.id
? { id: work.id, state: work.state, errorCode: work.errorCode }
: null,
coverage: current.meta.coverage, coverage: current.meta.coverage,
dependencies, dependencies,
}), }),
@@ -147,14 +117,6 @@ export class IncomeAnalyticsService {
selected, selected,
current.meta.lastSuccessfulAt, current.meta.lastSuccessfulAt,
), ),
previous:
prior.items === null
? null
: comparison(selected, plan.previous, qualifying(prior.items)),
yearComparison:
plan.yearAgo && year?.items !== null && year
? comparison(selected, plan.yearAgo, qualifying(year.items))
: null,
bucketGranularity: plan.granularity, bucketGranularity: plan.granularity,
buckets: buckets(plan.selected, plan.granularity, selected), buckets: buckets(plan.selected, plan.granularity, selected),
instruments: instruments(selected), instruments: instruments(selected),
@@ -198,38 +160,6 @@ function totals(entries: BrokerageOperationDto[]): IncomeCurrencySummaryDto[] {
.map(([currency, total]) => presentTotal(currency, total)); .map(([currency, total]) => presentTotal(currency, total));
} }
function comparison(
selectedEntries: BrokerageOperationDto[],
comparedPeriod: DateOnlyRange,
comparedEntries: BrokerageOperationDto[],
): IncomeComparisonDto {
const selected = new Map(
totals(selectedEntries).map((total) => [total.currency, total]),
);
const compared = new Map(
totals(comparedEntries).map((total) => [total.currency, total]),
);
const currencies = [
...new Set([...selected.keys(), ...compared.keys()]),
// eslint-disable-next-line sonarjs/no-alphabetical-sort -- Code-unit ordering is intentional for canonical keys and ISO dates; locale collation would change persisted bindings.
].sort();
return {
period: comparedPeriod,
totalsByCurrency: currencies.map((currency) => {
const current =
selected.get(currency) ?? presentTotal(currency, zeroTotal());
const prior =
compared.get(currency) ?? presentTotal(currency, zeroTotal());
return {
currency,
selected: current,
compared: prior,
difference: difference(current, prior),
};
}),
};
}
function buckets( function buckets(
range: DateOnlyRange, range: DateOnlyRange,
granularity: IncomeBucketGranularity, granularity: IncomeBucketGranularity,
@@ -293,22 +223,6 @@ function instrumentKey(entry: BrokerageOperationDto): string {
return `operation:${entry.account ? `${entry.account.id}:` : ''}${entry.id}`; return `operation:${entry.account ? `${entry.account.id}:` : ''}${entry.id}`;
} }
function difference(
left: IncomeCurrencySummaryDto,
right: IncomeCurrencySummaryDto,
): IncomeCurrencySummaryDto {
return presentTotal(left.currency, {
coupon: subtract(
decimalFromString(left.coupon.value),
decimalFromString(right.coupon.value),
),
dividend: subtract(
decimalFromString(left.dividend.value),
decimalFromString(right.dividend.value),
),
});
}
function zeroTotal(): Total { function zeroTotal(): Total {
return { coupon: { value: 0n, scale: 0 }, dividend: { value: 0n, scale: 0 } }; return { coupon: { value: 0n, scale: 0 }, dividend: { value: 0n, scale: 0 } };
} }
@@ -23,16 +23,14 @@ describe('income period planning', () => {
} }
}); });
it('uses a full previous month, skips impossible year-ago dates, and keeps empty buckets', () => { it('keeps empty buckets and skips removed comparison ranges', () => {
const fullMonth = planIncomePeriod('2026-03-01', '2026-03-31');
expect(fullMonth.previous).toEqual({
from: '2026-02-01',
to: '2026-02-28',
});
expect(planIncomePeriod('2024-02-29', '2024-02-29').yearAgo).toBeNull();
expect( expect(
rangeBuckets({ from: '2026-01-01', to: '2026-02-15' }, 'week'), rangeBuckets({ from: '2026-01-01', to: '2026-02-15' }, 'week'),
).toHaveLength(7); ).toHaveLength(7);
expect(planIncomePeriod('2026-03-01', '2026-03-31')).toEqual({
selected: { from: '2026-03-01', to: '2026-03-31' },
granularity: 'day',
});
}); });
it('accepts multi-year periods and creates monthly buckets for the entire range', () => { it('accepts multi-year periods and creates monthly buckets for the entire range', () => {
@@ -43,7 +41,6 @@ describe('income period planning', () => {
expect(plan.selected).toEqual({ from: '2020-01-01', to: '2025-12-31' }); expect(plan.selected).toEqual({ from: '2020-01-01', to: '2025-12-31' });
expect(plan.granularity).toBe('month'); expect(plan.granularity).toBe('month');
expect(rangeBuckets(plan.selected, plan.granularity)).toHaveLength(72); expect(rangeBuckets(plan.selected, plan.granularity)).toHaveLength(72);
expect(plan.yearAgo).toEqual({ from: '2019-01-01', to: '2024-12-31' });
}); });
it('does not send the unfinished Moscow day as a future instant', () => { it('does not send the unfinished Moscow day as a future instant', () => {
@@ -14,45 +14,28 @@ const MONDAY_WEEKDAY_INDEX = 1;
const INCLUSIVE_DAY_OFFSET = 1; const INCLUSIVE_DAY_OFFSET = 1;
const NEXT_DAY_OFFSET = 1; const NEXT_DAY_OFFSET = 1;
const PREVIOUS_MONTH_LAST_DAY = 0; const PREVIOUS_MONTH_LAST_DAY = 0;
const PREVIOUS_DAY_OFFSET = -1;
const PREVIOUS_YEAR_OFFSET = 1;
const DATE_COMPONENT_DIGITS = 2;
const DAILY_BUCKET_MAX_DAYS = 45; const DAILY_BUCKET_MAX_DAYS = 45;
const WEEKLY_BUCKET_MAX_DAYS = 180; const WEEKLY_BUCKET_MAX_DAYS = 180;
const DAYS_PER_WEEK = 7; const DAYS_PER_WEEK = 7;
const ISO_MONTH_LENGTH = 7; const ISO_MONTH_LENGTH = 7;
const ISO_YEAR_LENGTH = 4;
export type IncomeBucketGranularity = 'day' | 'month' | 'week'; export type IncomeBucketGranularity = 'day' | 'month' | 'week';
export function planIncomePeriod( export function planIncomePeriod(
from: string | undefined, from: string | undefined,
to: string | undefined, to: string | undefined,
openedDate?: Date,
): { ): {
granularity: IncomeBucketGranularity; granularity: IncomeBucketGranularity;
previous: DateOnlyRange;
selected: DateOnlyRange; selected: DateOnlyRange;
yearAgo: DateOnlyRange | null;
} { } {
if (Boolean(from) !== Boolean(to)) throw invalidPeriod(); if (Boolean(from) !== Boolean(to)) throw invalidPeriod();
const today = moscowDate(new Date()); const today = moscowDate(new Date());
const selected = const selected =
from && to ? { from, to } : { from: firstOfMonth(today), to: today }; from && to ? { from, to } : { from: firstOfMonth(today), to: today };
assertRange(selected, today); assertRange(selected, today);
const previous = isFullMonth(selected)
? previousMonth(selected.from)
: shiftDays(selected, -rangeDays(selected));
const candidate = yearAgo(selected);
const yearAgoRange =
candidate && (!openedDate || candidate.from >= moscowDate(openedDate))
? candidate
: null;
return { return {
selected, selected,
previous,
yearAgo: yearAgoRange,
granularity: granularity:
rangeDays(selected) <= DAILY_BUCKET_MAX_DAYS rangeDays(selected) <= DAILY_BUCKET_MAX_DAYS
? 'day' ? 'day'
@@ -136,34 +119,6 @@ function endOfMonth(value: string): string {
return new Date(Date.UTC(year, month, PREVIOUS_MONTH_LAST_DAY)).toISOString().slice(ISO_DATE_START, ISO_DATE_LENGTH); return new Date(Date.UTC(year, month, PREVIOUS_MONTH_LAST_DAY)).toISOString().slice(ISO_DATE_START, ISO_DATE_LENGTH);
} }
function isFullMonth(range: DateOnlyRange): boolean {
return (
range.from === firstOfMonth(range.from) && range.to === endOfMonth(range.to)
);
}
function previousMonth(from: string): DateOnlyRange {
const last = addDays(firstOfMonth(from), PREVIOUS_DAY_OFFSET);
return { from: firstOfMonth(last), to: last };
}
function shiftDays(range: DateOnlyRange, days: number): DateOnlyRange {
return { from: addDays(range.from, days), to: addDays(range.to, days) };
}
function yearAgo(range: DateOnlyRange): DateOnlyRange | null {
const shift = (value: string) => {
const [year, month, day] = dateParts(value);
const result = `${String(year - PREVIOUS_YEAR_OFFSET).padStart(ISO_YEAR_LENGTH, '0')}-${String(month).padStart(DATE_COMPONENT_DIGITS, '0')}-${String(day).padStart(DATE_COMPONENT_DIGITS, '0')}`;
return utcDate(result).toISOString().slice(ISO_DATE_START, ISO_DATE_LENGTH) === result
? result
: null;
};
const from = shift(range.from);
const to = shift(range.to);
return from && to ? { from, to } : null;
}
function invalidPeriod(): BadRequestException { function invalidPeriod(): BadRequestException {
return new BadRequestException({ code: IncomeErrorCode.InvalidPeriod }); return new BadRequestException({ code: IncomeErrorCode.InvalidPeriod });
} }
@@ -17,7 +17,7 @@ describe('screen dependency and history planning', () => {
}, },
], ],
}; };
it('prioritizes discovery, selected/comparisons, then history; Moscow dates are converted once', () => { it('prioritizes discovery, the selected period, then history; Moscow dates are converted once', () => {
const plan = planInvestmentScreen( const plan = planInvestmentScreen(
{ {
screen: 'income', screen: 'income',
@@ -32,6 +32,17 @@ describe('screen dependency and history planning', () => {
const selected = plan.sources.filter( const selected = plan.sources.filter(
(source) => source.kind === 'operations' && source.priority === 'screen', (source) => source.kind === 'operations' && source.priority === 'screen',
); );
// The single selected range is chunked into month-aligned intervals.
expect(selected).toHaveLength(2);
expect(
selected.every(
(source) =>
source.from != null &&
source.from.toISOString() >= '2024-01-31T21:00:00.000Z' &&
source.to != null &&
source.to.toISOString() <= '2024-02-29T21:00:00.000Z',
),
).toBe(true);
expect( expect(
selected.some( selected.some(
(source) => source.from?.toISOString() === '2024-01-31T21:00:00.000Z', (source) => source.from?.toISOString() === '2024-01-31T21:00:00.000Z',
@@ -42,9 +53,7 @@ describe('screen dependency and history planning', () => {
(source) => source.to?.toISOString() === '2024-02-29T21:00:00.000Z', (source) => source.to?.toISOString() === '2024-02-29T21:00:00.000Z',
), ),
).toBe(true); ).toBe(true);
expect(plan.unavailable).toEqual([ expect(plan.unavailable).toEqual([]);
{ resourceKey: 'income/yearAgo', reason: 'calendar_or_account_boundary' }, // gitleaks:allow public resource identifier
]);
const firstHistory = plan.sources.findIndex( const firstHistory = plan.sources.findIndex(
(source) => source.priority === 'history', (source) => source.priority === 'history',
); );
@@ -111,13 +111,6 @@ export function planInvestmentScreen(
priority: 'screen' as const, priority: 'screen' as const,
})), })),
); );
const knownOpening =
accounts.length && accounts.every((account) => account.openedOn)
? new Date(
// eslint-disable-next-line sonarjs/no-alphabetical-sort -- Code-unit ordering is intentional for canonical keys and ISO dates; locale collation would change persisted bindings.
`${accounts.map((account) => account.openedOn ?? '').sort()[0]}T00:00:00+03:00`,
)
: undefined;
if (!context.membershipKnown) return { sources, unavailable, now }; if (!context.membershipKnown) return { sources, unavailable, now };
if ( if (
['account', 'accounts', 'bond', 'events', 'stock'].includes(screen.screen) ['account', 'accounts', 'bond', 'events', 'stock'].includes(screen.screen)
@@ -142,23 +135,9 @@ export function planInvestmentScreen(
const period = planIncomePeriod( const period = planIncomePeriod(
screen.screen === 'income' ? screen.from : undefined, screen.screen === 'income' ? screen.from : undefined,
screen.screen === 'income' ? screen.to : undefined, screen.screen === 'income' ? screen.to : undefined,
knownOpening,
); );
for (const range of [ const bounds = dateOnlyBounds(period.selected, now);
period.selected,
...(screen.screen === 'income'
? [period.previous, ...(period.yearAgo ? [period.yearAgo] : [])]
: []),
]) {
const bounds = dateOnlyBounds(range, now);
operations(bounds.from, bounds.to); operations(bounds.from, bounds.to);
}
if (screen.screen === 'income' && !period.yearAgo) {
unavailable.push({
resourceKey: 'income/yearAgo', // gitleaks:allow public resource identifier
reason: 'calendar_or_account_boundary',
});
}
if (screen.screen === 'account') { if (screen.screen === 'account') {
const range = ledgerRange( const range = ledgerRange(
screen.from, screen.from,
@@ -451,7 +451,11 @@ export class BrokerageOperationsService {
key: `${period.from}/${period.to}`, key: `${period.from}/${period.to}`,
movingEnd: false, movingEnd: false,
})); }));
return periods.map((period, index) => { const rows = saved?.rows ?? [];
const instruments = await this.metadata.savedMany(
rows.map((row) => row.payload as TbankOperationItem),
);
return periods.map((period) => {
const targets = (saved?.connection.accounts ?? []).map((account) => ({ const targets = (saved?.connection.accounts ?? []).map((account) => ({
accountId: account.accountId, accountId: account.accountId,
...period, ...period,
@@ -487,8 +491,7 @@ export class BrokerageOperationsService {
null; null;
const confirmed = confirmedOperationRanges(plan.intervals, sources); const confirmed = confirmedOperationRanges(plan.intervals, sources);
const meta = investmentResourceMeta({ const meta = investmentResourceMeta({
// eslint-disable-next-line security/detect-object-injection -- The numeric index enumerates the three comparison periods. resourceKey: `income/${accountId}/selected/${period.key}`,
resourceKey: `income/${accountId}/${['selected', 'previous', 'yearAgo'][index]}/${period.key}`,
dataRevision: saved?.binding ?? 'missing', dataRevision: saved?.binding ?? 'missing',
availability: !known availability: !known
? 'missing' ? 'missing'
@@ -542,7 +545,7 @@ export class BrokerageOperationsService {
return { return {
meta, meta,
items: complete items: complete
? (saved?.rows ?? []) ? rows
.filter((row) => .filter((row) =>
plan.intervals.some( plan.intervals.some(
(interval) => (interval) =>
@@ -556,6 +559,10 @@ export class BrokerageOperationsService {
row.payload as TbankOperationItem, row.payload as TbankOperationItem,
row.occurredAt, row.occurredAt,
), ),
logoName:
instruments
.get(metadataKey(row.payload as TbankOperationItem))
?.data?.brand?.logoName?.trim() || null,
...(accountId === 'all' ...(accountId === 'all'
? { ? {
account: { account: {
@@ -2,6 +2,7 @@ import { BadRequestException, Injectable } from '@nestjs/common';
import { import {
add, add,
type Decimal,
decimalFromString, decimalFromString,
formatDecimal, formatDecimal,
isZero, isZero,
@@ -280,7 +281,7 @@ function dateWindow(query: UpcomingEventsQueryDto) {
} }
function incomeTotals(events: UpcomingEventDto[]): MoneyDto[] { function incomeTotals(events: UpcomingEventDto[]): MoneyDto[] {
const totals = new Map<string, ReturnType<typeof decimalFromString>>(); const totals = new Map<string, Decimal>();
for (const event of events) { for (const event of events) {
if (!['coupon', 'dividend'].includes(event.type) || !event.projectedAmount) { if (!['coupon', 'dividend'].includes(event.type) || !event.projectedAmount) {
continue; continue;
+18 -2
View File
@@ -77,7 +77,7 @@ describe('OpenAPI contract (integration)', () => {
} }
}); });
it('exposes required semantic income dependency roles', () => { it('exposes only the selected income dependency role and no comparison data', () => {
const schemas = createOpenApiDocument(app).components?.schemas; const schemas = createOpenApiDocument(app).components?.schemas;
expect(schemas?.IncomeAnalyticsResourceDto).toMatchObject({ expect(schemas?.IncomeAnalyticsResourceDto).toMatchObject({
properties: { properties: {
@@ -100,9 +100,25 @@ describe('OpenAPI contract (integration)', () => {
expect(dependency.required).toContain('role'); expect(dependency.required).toContain('role');
expect(dependency).toMatchObject({ expect(dependency).toMatchObject({
properties: { properties: {
role: { type: 'string', enum: ['selected', 'previous', 'year'] }, role: { type: 'string', enum: ['selected'] },
}, },
}); });
const analytics = schemas?.IncomeAnalyticsDto;
assert(analytics && !('$ref' in analytics));
expect(analytics.required).toEqual(
expect.arrayContaining([
'accountId',
'period',
'totalsByCurrency',
'calculatedAt',
'bucketGranularity',
'buckets',
'instruments',
'entries',
]),
);
expect(analytics.properties).not.toHaveProperty('previous');
expect(analytics.properties).not.toHaveProperty('yearComparison');
}); });
it('generates the runtime contract without server startup or deployment configuration', async () => { it('generates the runtime contract without server startup or deployment configuration', async () => {
+52 -28
View File
@@ -124,7 +124,7 @@ describe('local income completeness and exact money (SQLite)', () => {
} }
} }
}); });
it('returns exact selected sums without a false zero comparison; reopen and observe need no RPC', async () => { it('returns exact selected sums; reopen and observe need no RPC', async () => {
for (let index = 0; index < 2; index++) { for (let index = 0; index < 2; index++) {
const result = await read(); const result = await read();
assert(result.data); assert(result.data);
@@ -140,22 +140,55 @@ describe('local income completeness and exact money (SQLite)', () => {
.filter((row) => row.id === 'same') .filter((row) => row.id === 'same')
.map((row) => row.account?.id), .map((row) => row.account?.id),
).toEqual(['a', 'b']); ).toEqual(['a', 'b']);
expect(result.data.previous).toBeNull();
expect(result.data.yearComparison).toBeNull();
expect(result.meta.dependencies.map(({ role }) => role)).toEqual([ expect(result.meta.dependencies.map(({ role }) => role)).toEqual([
'selected', 'selected',
'previous',
'year',
]); ]);
const previous = result.meta.dependencies.find(({ role }) => role === 'previous');
expect(previous?.availability).toBe('temporarily-unavailable');
expect(previous?.completeness).toBe('incomplete');
expect(result.data.calculatedAt).toBe('2025-02-01T00:00:00.000Z'); expect(result.data.calculatedAt).toBe('2025-02-01T00:00:00.000Z');
await prisma.$disconnect(); await prisma.$disconnect();
} }
expect(upstream.getOpenAccounts).not.toHaveBeenCalled(); expect(upstream.getOpenAccounts).not.toHaveBeenCalled();
expect(upstream.getOperationsByCursor).not.toHaveBeenCalled(); expect(upstream.getOperationsByCursor).not.toHaveBeenCalled();
}); });
it('uses saved instrument logos for income entries without changing their financial data', async () => {
const before = await read();
const base = before.data;
assert(base);
const fetchedAt = new Date();
await prisma.tbankOperation.update({
where: {
userId_revision_accountId_brokerOperationId: {
userId: 'income-owner', revision, accountId: 'a', brokerOperationId: 'same',
},
},
data: {
payload: {
id: 'same', figi: 'income-figi', type: 'OPERATION_TYPE_COUPON',
date: { seconds: String(Date.parse('2025-01-15Z') / 1000) },
payment: { units: '10', nano: 1, currency: 'rub' },
},
},
});
await prisma.tbankInstrument.create({
data: {
provider: 'tbank', uid: 'income-uid', figi: 'income-figi',
instrumentType: 'bond', fetchedAt,
metadata: { uid: 'income-uid', figi: 'income-figi', name: 'Bond', brand: { logoName: 'bond.png' } },
},
});
await prisma.tbankInstrumentLookup.create({
data: {
provider: 'tbank', identifierType: 'figi', identifier: 'income-figi',
matchedUids: ['income-uid'], fetchedAt,
},
});
const after = await read();
assert(after.data);
expect(after.data.entries.find((entry) => entry.account?.id === 'a' && entry.id === 'same')?.logoName).toBe('bond.png');
expect(after.data.entries.find((entry) => entry.account?.id === 'b' && entry.id === 'same')?.logoName).toBeNull();
expect(after.data.totalsByCurrency).toEqual(base.totalsByCurrency);
expect(after.data.calculatedAt).toBe(base.calculatedAt);
expect(upstream.getOperationsByCursor).not.toHaveBeenCalled();
});
it('requires every account and separates missing, partial and confirmed empty periods', async () => { it('requires every account and separates missing, partial and confirmed empty periods', async () => {
await prisma.tbankOperationCoverage.deleteMany({ await prisma.tbankOperationCoverage.deleteMany({
where: { accountId: 'b' }, where: { accountId: 'b' },
@@ -176,15 +209,7 @@ describe('local income completeness and exact money (SQLite)', () => {
).toEqual([]); ).toEqual([]);
expect(upstream.getOperationsByCursor).not.toHaveBeenCalled(); expect(upstream.getOperationsByCursor).not.toHaveBeenCalled();
}); });
it('completes previous/yearAgo independently and counts corrected identities once', async () => { it('counts corrected identities once for the selected period', async () => {
for (const account of ['a', 'b']) {
await coverage(account, new Date('2024-11-30T21:00:00Z'), from);
await coverage(
account,
new Date('2023-12-31T21:00:00Z'),
new Date('2024-01-31T21:00:00Z'),
);
}
await prisma.tbankOperation.updateMany({ await prisma.tbankOperation.updateMany({
where: { accountId: 'a', brokerOperationId: 'same' }, where: { accountId: 'a', brokerOperationId: 'same' },
data: { data: {
@@ -197,14 +222,12 @@ describe('local income completeness and exact money (SQLite)', () => {
}, },
}); });
const result = await read(); const result = await read();
assert(result.data?.previous && result.data.yearComparison); assert(result.data);
expect(result.data.entries).toHaveLength(6); expect(result.data.entries).toHaveLength(6);
expect( expect(
result.data.previous.totalsByCurrency[0].difference.total.value, result.data.totalsByCurrency.find(({ currency }) => currency === 'RUB')
).toBe('25.000000002'); ?.total,
expect( ).toEqual({ currency: 'RUB', value: '25.000000002' });
result.data.yearComparison.totalsByCurrency[0].compared.total.value,
).toBe('0');
}); });
it('preserves the complete financial result and timestamp through failed atomic reconciliation', async () => { it('preserves the complete financial result and timestamp through failed atomic reconciliation', async () => {
const before = await read(); const before = await read();
@@ -276,12 +299,13 @@ describe('local income completeness and exact money (SQLite)', () => {
const response = await get('all', undefined, false).expect(200); const response = await get('all', undefined, false).expect(200);
expect((response.body as IncomeAnalyticsResourceDto).data).not.toBeNull(); expect((response.body as IncomeAnalyticsResourceDto).data).not.toBeNull();
}); });
it('distinguishes unavailable calendar comparison without scheduling it', async () => { it('plans only the selected period for a leap day without scheduling it', async () => {
const result = await read('a', 'from=2024-02-29&to=2024-02-29'); const result = await read('a', 'from=2024-02-29&to=2024-02-29');
expect( expect(result.meta.dependencies.map(({ role }) => role)).toEqual([
result.meta.dependencies.find(({ role }) => role === 'year') 'selected',
?.unavailableReason, ]);
).toBe('CALENDAR_OR_ACCOUNT_HISTORY'); expect(result.meta.dependencies[0].availability).toBe('temporarily-unavailable');
expect(result.data).toBeNull();
expect(upstream.getOperationsByCursor).not.toHaveBeenCalled(); expect(upstream.getOperationsByCursor).not.toHaveBeenCalled();
}); });
}); });