feat: add stock screener
This commit is contained in:
@@ -282,3 +282,141 @@ describe('TbankClient metadata retries', () => {
|
||||
expect(jest.getTimerCount()).toBe(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('TbankClient share catalog', () => {
|
||||
const token = 'token';
|
||||
const catalogSize = 40;
|
||||
let client: TbankClient;
|
||||
let call: jest.Mock;
|
||||
let logger: {
|
||||
event: jest.Mock<void, [string, string, Record<string, number | string>]>;
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
call = jest.fn();
|
||||
logger = {
|
||||
event: jest.fn<void, [string, string, Record<string, number | string>]>(),
|
||||
};
|
||||
client = Object.assign(
|
||||
Object.create(TbankClient.prototype) as TbankClient,
|
||||
{ call, logger },
|
||||
);
|
||||
});
|
||||
|
||||
it('fetches the full share catalog through Shares with INSTRUMENT_STATUS_ALL', async () => {
|
||||
const instruments = [{ ticker: 'AFLT', uid: 'uid-aflt' }];
|
||||
call.mockResolvedValue({ instruments });
|
||||
|
||||
await expect(client.getAllShares(token)).resolves.toEqual(instruments);
|
||||
expect(call).toHaveBeenCalledWith('token', undefined, 'shares', {
|
||||
instrumentStatus: 'INSTRUMENT_STATUS_ALL',
|
||||
});
|
||||
});
|
||||
|
||||
it('returns the whole catalog including a fitting instrument beyond the first 30 text matches', async () => {
|
||||
const catalog = Array.from({ length: catalogSize }, (_, index) => {
|
||||
const fitting = index === catalogSize - 1;
|
||||
return {
|
||||
apiTradeAvailableFlag: fitting,
|
||||
buyAvailableFlag: fitting,
|
||||
ticker: fitting ? 'FIT' : `T${index}`,
|
||||
uid: fitting ? 'uid-fit' : `uid-${index}`,
|
||||
};
|
||||
});
|
||||
call.mockResolvedValue({ instruments: catalog });
|
||||
|
||||
const shares = await client.getAllShares(token);
|
||||
|
||||
expect(shares).toEqual(catalog);
|
||||
expect(shares).toHaveLength(catalogSize);
|
||||
expect(shares).toContainEqual({
|
||||
apiTradeAvailableFlag: true,
|
||||
buyAvailableFlag: true,
|
||||
ticker: 'FIT',
|
||||
uid: 'uid-fit',
|
||||
});
|
||||
});
|
||||
|
||||
it('rejects when the source refuses instead of returning an empty success', async () => {
|
||||
const error = new ServiceUnavailableException({
|
||||
code: 'TBANK_UNAVAILABLE',
|
||||
});
|
||||
call.mockRejectedValue(error);
|
||||
|
||||
await expect(client.getAllShares(token)).rejects.toBe(error);
|
||||
});
|
||||
|
||||
it('rejects when the response carries no instrument list', async () => {
|
||||
call.mockResolvedValue({});
|
||||
|
||||
await expect(client.getAllShares(token)).rejects.toBeInstanceOf(
|
||||
ServiceUnavailableException,
|
||||
);
|
||||
});
|
||||
|
||||
it('rejects an empty instrument list with the public unavailable code', async () => {
|
||||
call.mockResolvedValue({ instruments: [] });
|
||||
|
||||
const failure = await client
|
||||
.getAllShares(token)
|
||||
.catch((error: unknown) => error);
|
||||
|
||||
expect(failure).toBeInstanceOf(ServiceUnavailableException);
|
||||
expect((failure as ServiceUnavailableException).getResponse()).toEqual({
|
||||
code: 'TBANK_UNAVAILABLE',
|
||||
});
|
||||
});
|
||||
|
||||
it('rejects a non-list instrument payload as uninterpretable', async () => {
|
||||
call.mockResolvedValue({ instruments: 'corrupted' });
|
||||
|
||||
await expect(client.getAllShares(token)).rejects.toBeInstanceOf(
|
||||
ServiceUnavailableException,
|
||||
);
|
||||
});
|
||||
|
||||
it('rejects an uninterpretable entry without instrument identity', async () => {
|
||||
call.mockResolvedValue({
|
||||
instruments: [
|
||||
{ ticker: 'FIT', uid: 'uid-fit' },
|
||||
{ ticker: 'BROKEN' },
|
||||
],
|
||||
});
|
||||
|
||||
await expect(client.getAllShares(token)).rejects.toBeInstanceOf(
|
||||
ServiceUnavailableException,
|
||||
);
|
||||
});
|
||||
|
||||
it('registers asOf and source instrument count on a successful catalog fetch', async () => {
|
||||
call.mockResolvedValue({
|
||||
instruments: [{ uid: 'uid-a' }, { uid: 'uid-b' }],
|
||||
});
|
||||
|
||||
await client.getAllShares(token);
|
||||
|
||||
expect(logger.event).toHaveBeenCalledWith(
|
||||
'info',
|
||||
'tbank.shares.catalog.fetched',
|
||||
expect.objectContaining({ count: 2, operation: 'shares' }),
|
||||
);
|
||||
expect(logger.event.mock.calls[0][2].asOf).toEqual(expect.any(String));
|
||||
});
|
||||
|
||||
it('logs a distinguishable failure without secrets when the catalog is unusable', async () => {
|
||||
call.mockResolvedValue({ instruments: [] });
|
||||
|
||||
await expect(client.getAllShares('secret-token')).rejects.toBeInstanceOf(
|
||||
ServiceUnavailableException,
|
||||
);
|
||||
|
||||
expect(logger.event).toHaveBeenCalledWith(
|
||||
'error',
|
||||
'tbank.shares.catalog.unusable',
|
||||
expect.objectContaining({ operation: 'shares' }),
|
||||
);
|
||||
expect(JSON.stringify(logger.event.mock.calls)).not.toContain(
|
||||
'secret-token',
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user