@edd-kernel/core
v0.2.0-alpha.1
Published
Shared EDD Kernel implementation: options, serialization, polling, state, logging and error normalization.
Maintainers
Readme
@edd-kernel/core
Shared EDD Kernel implementation: client option normalization, message serialization, polling, consumer state, logging, unhandled-handler delivery policy and provider error normalization.
This package belongs to the EDD Kernel package family. It sits between
@edd-kernel/contracts and the provider packages.
Install it when you build a provider or reuse the kernel helpers directly. If you
only need to type an EDD client or catch EDD errors, depend on
@edd-kernel/contracts alone.
Install
npm install @edd-kernel/core @edd-kernel/contractsUsage
import { normalizeClientOptions, runProviderOperation } from '@edd-kernel/core';
const options = normalizeClientOptions({ concurrency: 4 });
// No raw SDK failure leaves here: it comes back as a kernel error carrying the
// provider, the target and the original object in `cause`.
await runProviderOperation(async () => publish(payload), 'aws-sqs', 'orders');What it provides
| Module | Responsibility |
| --------------------- | -------------------------------------------------------- |
| options | client and consume option defaults and normalization |
| serialization | JSON and raw message serialization and idempotency keys |
| polling | the shared polling consumer used by pull-based providers |
| state | consumer lifecycle state |
| logging | logger and debug-aware event reporting |
| delivery | unhandled handler error policy, ack or nack |
| error-normalization | provider failures mapped onto the kernel error contract |
| records | plain record detection used by serialization |
Error normalization
Target-not-found and permission failures are normalized, because a caller must
branch on them without knowing which provider is behind the contract. Every other
failure keeps the provider message and gains provider, target and code, with
the original error preserved in cause.
Errors that already are EddKernelError keep their class and instance. Only the
context they are missing is filled in.
License
MIT
