feat: streaming entities
Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
* Entity management service
|
||||
*/
|
||||
|
||||
import { transceivePost } from './transceive';
|
||||
import { transceivePost, transceiveStream } from './transceive';
|
||||
import type {
|
||||
EntityListRequest,
|
||||
EntityListResponse,
|
||||
@@ -21,6 +21,10 @@ import type {
|
||||
EntityTransmitRequest,
|
||||
EntityTransmitResponse,
|
||||
EntityInterface,
|
||||
EntityStreamRequest,
|
||||
EntityStreamLine,
|
||||
EntityStreamEntityLine,
|
||||
EntityStreamDoneLine,
|
||||
} from '../types/entity';
|
||||
import { useIntegrationStore } from '@KTXC/stores/integrationStore';
|
||||
import { EntityObject } from '../models';
|
||||
@@ -157,6 +161,41 @@ export const entityService = {
|
||||
async transmit(request: EntityTransmitRequest): Promise<EntityTransmitResponse> {
|
||||
return await transceivePost<EntityTransmitRequest, EntityTransmitResponse>('entity.transmit', request);
|
||||
},
|
||||
|
||||
/**
|
||||
* Stream entities as NDJSON, invoking onEntity for each entity as it arrives.
|
||||
*
|
||||
* The server emits one entity per line so the caller receives entities
|
||||
* progressively rather than waiting for the full collection to load.
|
||||
*
|
||||
* @param request - stream request parameters (same shape as list)
|
||||
* @param onEntity - called synchronously for each entity as it is received
|
||||
*
|
||||
* @returns Promise resolving to { total } when the stream completes
|
||||
*/
|
||||
async stream(
|
||||
request: EntityStreamRequest,
|
||||
onEntity: (entity: EntityObject) => void
|
||||
): Promise<{ total: number }> {
|
||||
let total = 0;
|
||||
|
||||
await transceiveStream<EntityStreamRequest, EntityStreamLine>(
|
||||
'entity.stream',
|
||||
request,
|
||||
(line) => {
|
||||
if (line.type === 'entity') {
|
||||
onEntity(createEntityObject(line as EntityStreamEntityLine));
|
||||
} else if (line.type === 'done') {
|
||||
total = (line as EntityStreamDoneLine).total;
|
||||
} else if (line.type === 'error') {
|
||||
throw new Error(`[entity.stream] ${line.message}`);
|
||||
}
|
||||
// 'meta' lines are silently consumed
|
||||
}
|
||||
);
|
||||
|
||||
return { total };
|
||||
},
|
||||
};
|
||||
|
||||
export default entityService;
|
||||
|
||||
@@ -48,3 +48,68 @@ export async function transceivePost<TRequest, TResponse>(
|
||||
|
||||
return response.data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Stream an NDJSON API response, calling onLine for each parsed line.
|
||||
*
|
||||
* The server emits one JSON object per line with a `type` discriminant
|
||||
* (meta / entity / done / error). The caller interprets each line via onLine.
|
||||
* Throwing inside onLine aborts the stream.
|
||||
*
|
||||
* @param operation - Operation name, e.g. 'entity.stream'
|
||||
* @param data - Operation-specific request data
|
||||
* @param onLine - Synchronous callback invoked for every parsed line.
|
||||
* May throw to abort the stream.
|
||||
* @param user - Optional user identifier override
|
||||
*/
|
||||
export async function transceiveStream<TRequest, TLine = any>(
|
||||
operation: string,
|
||||
data: TRequest,
|
||||
onLine: (line: TLine) => void,
|
||||
user?: string
|
||||
): Promise<void> {
|
||||
const request: ApiRequest<TRequest> = {
|
||||
version: API_VERSION,
|
||||
transaction: generateTransactionId(),
|
||||
operation,
|
||||
data,
|
||||
user,
|
||||
};
|
||||
|
||||
await fetchWrapper.post(API_URL, request, {
|
||||
//headers: { 'Accept': 'application/x-ndjson' },
|
||||
headers: { 'Accept': 'application/json' },
|
||||
onStream: async (response) => {
|
||||
if (!response.body) {
|
||||
throw new Error(`[${operation}] Response body is not readable`);
|
||||
}
|
||||
|
||||
const reader = response.body.getReader();
|
||||
const decoder = new TextDecoder();
|
||||
let buffer = '';
|
||||
|
||||
try {
|
||||
while (true) {
|
||||
const { done, value } = await reader.read();
|
||||
if (done) break;
|
||||
|
||||
buffer += decoder.decode(value, { stream: true });
|
||||
const lines = buffer.split('\n');
|
||||
buffer = lines.pop()!; // retain any incomplete trailing chunk
|
||||
|
||||
for (const line of lines) {
|
||||
if (!line.trim()) continue;
|
||||
onLine(JSON.parse(line) as TLine);
|
||||
}
|
||||
}
|
||||
|
||||
// flush any remaining bytes still in the buffer
|
||||
if (buffer.trim()) {
|
||||
onLine(JSON.parse(buffer) as TLine);
|
||||
}
|
||||
} finally {
|
||||
reader.releaseLock();
|
||||
}
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user