@zaycev.dev/origami v1.1.0

Origami

Origami — мультиплатформенная библитека, которая дает гарантию доставки запроса и ответа вне зависимости от сетевых сбоев. Размещайте сервисы в разных зонах и не обращайте внимание на качество канала между ними.

Возможности

• микросервисная архитектура
• гарантия доставки запроса
• гарантия доставки ответа
• мультиплатформенность
• возможность управлять конкурентностью запросов
• конкурентные запросы с разделением по ключу
• отложенная доставка запроса
• балансировка round-robin
• предотвращение дублирования запросов

Зависимости

Для работы необходим Redis. Вся разработка велась на версии Redis 6.2.

Ответственность

Origami гарантирует доставку при нестабильной работе сети. В случае непредвиденной остановки Redis или вашего приложения часть данных может быть потеряна или повреждена. Вы должны сами следить за работаспособностью Redis и вашего приложени.

Установка

Установка производится с помощью менеджера пакетов NPM

npm install @zaycev.dev/origami

Использование

Пример использования, запуск простого сервиса

import {Origami} from '@zaycev.dev/origami';



// инициализация клинта
const origami = new Origami({
    noneName: 'eu-west-01',
    appName: 'Sample service',
    
    connection: {
        host: 'redis.host',
        port: 6379,
    },
    password: 'redispassword',
});



// интерфейты параметров запроса и ответа

interface IParams {
    foo: number;
    bar: number;
};
interface IResponse {
    sum: number;
}



// инициализация сервиса
origami.channel<IParams, IResponse>('math.sum', {concurrent: 1}, async (params: IParams, requestId: string, senderId: string): Promise<IResponse> => {
    const foobar = params.foo + params.bar;
    
    return {
        sum: foobar,
    };
});



// запуск клиента
await origami.start();



// запрос к сервису
const sum = await origami.request<IResponse, IParams>('math.sum', {foo: 1234, bar: 4321});



// остановка клиента
await origami.stop();

Описание параметров

Параметры инициализации клиента

Парамеры создания канала

origami.channel(channelName, channelOptions, channelHandler(parameters, requestId, senderId));

Параметры отправки запроса

origami.request(channelName, parameters, options);

Тело ответа

const response = await origami.request(...);

const {
    ok,
    code,
    result,
    executorId,
} = response;

License

Origami is available under the MIT license.

Contact

Copyright (c) 2023 Origami

Github