@opra/kafka 1.0.0-beta.3 → 1.0.0-beta.4

package/cjs/augmentation/{msg-operation.augmentation.js → opra-common.augmentation.js}

@@ -4,7 +4,7 @@ require("@opra/core");
 const common_1 = require("@opra/common");
 const constants_js_1 = require("../constants.js");
 /** Implementation **/
-common_1.classes.MsgOperationDecoratorFactory.augment((decorator, decoratorChain) => {
+common_1.classes.RpcOperationDecoratorFactory.augment((decorator, decoratorChain) => {
     decorator.Kafka = (config) => {
         decoratorChain.push((_, target, propertyKey) => {
             if (typeof config === 'function') {

package/cjs/index.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-require("./augmentation/msg-operation.augmentation.js");
+require("./augmentation/opra-common.augmentation.js");
 tslib_1.__exportStar(require("./constants.js"), exports);
 tslib_1.__exportStar(require("./kafka-adapter.js"), exports);
 tslib_1.__exportStar(require("./kafka-context.js"), exports);
 tslib_1.__exportStar(require("./request-parser.js"), exports);
-tslib_1.__exportStar(require("./types.js"), exports);

package/cjs/kafka-adapter.js

@@ -17,24 +17,25 @@ const signalTraps = ['SIGTERM', 'SIGINT', 'SIGUSR2'];
 class KafkaAdapter extends core_1.PlatformAdapter {
     /**
      *
-     * @param init
+     * @param config
      * @constructor
      */
-    constructor(init) {
-        super(init.document, init);
+    constructor(config) {
+        super(config.document, config);
         this._controllerInstances = new Map();
         this._consumers = new Map();
-        this.protocol = 'msg';
+        this.protocol = 'rpc';
         this.platform = KafkaAdapter.PlatformName;
-        if (!(init.document.api instanceof common_1.MsgApi && init.document.api.platform === KafkaAdapter.PlatformName)) {
+        if (!(config.document.api instanceof common_1.RpcApi && config.document.api.platform === KafkaAdapter.PlatformName)) {
             throw new TypeError(`The document doesn't expose a Kafka Api`);
         }
-        this.interceptors = [...(init.interceptors || [])];
+        this._config = config;
+        this.interceptors = [...(config.interceptors || [])];
         this.kafka = new kafkajs_1.Kafka({
-            ...init,
-            logCreator: init.logger ? () => this._createLogCreator(init.logger) : undefined,
+            ...config.client,
+            logCreator: config.logger ? () => this._createLogCreator(config.logger, config.logExtra) : undefined,
         });
-        this._logger = init.logger;
+        this._logger = config.logger;
         globalErrorTypes.forEach(type => {
             process.on(type, e => {
                 this._emitError(e);
@@ -46,7 +47,7 @@ class KafkaAdapter extends core_1.PlatformAdapter {
         });
     }
     get api() {
-        return this.document.msgApi;
+        return this.document.rpcApi;
     }
     /**
      * Starts the service
@@ -72,7 +73,7 @@ class KafkaAdapter extends core_1.PlatformAdapter {
                 }
             }
         }
-        await Promise.allSettled(Array.from(this._consumers.keys()).map(c => c.disconnect()));
+        await Promise.allSettled(Array.from(this._consumers.values()).map(c => c.consumer.disconnect()));
         this._consumers.clear();
         this._controllerInstances.clear();
     }
@@ -90,7 +91,7 @@ class KafkaAdapter extends core_1.PlatformAdapter {
         if (this._consumers.size > 0)
             return;
         /** Create consumers */
-        for (const controller of this.document.msgApi.controllers.values()) {
+        for (const controller of this.document.rpcApi.controllers.values()) {
             let instance = controller.instance;
             if (!instance && controller.ctor)
                 instance = new controller.ctor();
@@ -111,16 +112,34 @@ class KafkaAdapter extends core_1.PlatformAdapter {
         if (typeof instance[operation.name] !== 'function')
             return;
         const proto = controller.ctor?.prototype || Object.getPrototypeOf(controller.instance);
+        // this._config.consumers
         let operationOptions = Reflect.getMetadata(constants_js_1.KAFKA_OPERATION_METADATA, proto, operation.name);
         const configResolver = Reflect.getMetadata(constants_js_1.KAFKA_OPERATION_METADATA_RESOLVER, proto, operation.name);
         if (configResolver) {
             const cfg = await configResolver();
             operationOptions = { ...operationOptions, ...cfg };
         }
-        const groupId = operationOptions?.groupId || constants_js_1.KAFKA_DEFAULT_GROUP;
-        const options = { ...operationOptions, groupId };
-        const consumer = this.kafka.consumer(options);
-        this._consumers.set(consumer, { consumer, controller, instance, operation, options });
+        const consumerConfig = {
+            groupId: constants_js_1.KAFKA_DEFAULT_GROUP,
+        };
+        if (typeof operationOptions?.consumer === 'object') {
+            if (this._consumers.has(operationOptions.consumer.groupId)) {
+                throw new Error(`Operation consumer for groupId (${operationOptions.consumer.groupId}) already exists`);
+            }
+            Object.assign(consumerConfig, operationOptions?.consumer);
+        }
+        else if (operationOptions?.consumer) {
+            const x = this._config.consumers?.[operationOptions.consumer];
+            Object.assign(consumerConfig, { ...x, groupId: operationOptions.consumer });
+        }
+        const consumer = this.kafka.consumer(consumerConfig);
+        this._consumers.set(consumerConfig.groupId, {
+            consumer,
+            controller,
+            instance,
+            operation,
+            options: { ...operationOptions },
+        });
         if (typeof controller.onInit === 'function')
             controller.onInit.call(instance, controller);
     }
@@ -268,9 +287,4 @@ class KafkaAdapter extends core_1.PlatformAdapter {
     }
 }
 exports.KafkaAdapter = KafkaAdapter;
-/**
- * @namespace KafkaAdapter
- */
-(function (KafkaAdapter) {
-    KafkaAdapter.PlatformName = 'kafka';
-})(KafkaAdapter || (exports.KafkaAdapter = KafkaAdapter = {}));
+KafkaAdapter.PlatformName = 'kafka';

package/cjs/kafka-context.js

@@ -4,10 +4,10 @@ exports.KafkaContext = void 0;
 const core_1 = require("@opra/core");
 class KafkaContext extends core_1.ExecutionContext {
     constructor(init) {
-        super({ ...init, document: init.adapter.document, protocol: 'msg' });
+        super({ ...init, document: init.adapter.document, protocol: 'rpc' });
         this.adapter = init.adapter;
         this.platform = init.adapter.platform;
-        this.protocol = 'msg';
+        this.protocol = 'rpc';
         if (init.controller)
             this.controller = init.controller;
         if (init.controllerInstance)

package/esm/augmentation/{msg-operation.augmentation.js → opra-common.augmentation.js}

@@ -2,7 +2,7 @@ import '@opra/core';
 import { classes } from '@opra/common';
 import { KAFKA_OPERATION_METADATA, KAFKA_OPERATION_METADATA_RESOLVER } from '../constants.js';
 /** Implementation **/
-classes.MsgOperationDecoratorFactory.augment((decorator, decoratorChain) => {
+classes.RpcOperationDecoratorFactory.augment((decorator, decoratorChain) => {
     decorator.Kafka = (config) => {
         decoratorChain.push((_, target, propertyKey) => {
             if (typeof config === 'function') {

package/esm/index.js

@@ -1,6 +1,5 @@
-import './augmentation/msg-operation.augmentation.js';
+import './augmentation/opra-common.augmentation.js';
 export * from './constants.js';
 export * from './kafka-adapter.js';
 export * from './kafka-context.js';
 export * from './request-parser.js';
-export * from './types.js';

package/esm/kafka-adapter.js

@@ -1,4 +1,4 @@
-import { MsgApi } from '@opra/common';
+import { RpcApi } from '@opra/common';
 import { kAssetCache, PlatformAdapter } from '@opra/core';
 import { Kafka, logLevel } from 'kafkajs';
 import { vg } from 'valgen';
@@ -14,24 +14,25 @@ const signalTraps = ['SIGTERM', 'SIGINT', 'SIGUSR2'];
 export class KafkaAdapter extends PlatformAdapter {
     /**
      *
-     * @param init
+     * @param config
      * @constructor
      */
-    constructor(init) {
-        super(init.document, init);
+    constructor(config) {
+        super(config.document, config);
         this._controllerInstances = new Map();
         this._consumers = new Map();
-        this.protocol = 'msg';
+        this.protocol = 'rpc';
         this.platform = KafkaAdapter.PlatformName;
-        if (!(init.document.api instanceof MsgApi && init.document.api.platform === KafkaAdapter.PlatformName)) {
+        if (!(config.document.api instanceof RpcApi && config.document.api.platform === KafkaAdapter.PlatformName)) {
             throw new TypeError(`The document doesn't expose a Kafka Api`);
         }
-        this.interceptors = [...(init.interceptors || [])];
+        this._config = config;
+        this.interceptors = [...(config.interceptors || [])];
         this.kafka = new Kafka({
-            ...init,
-            logCreator: init.logger ? () => this._createLogCreator(init.logger) : undefined,
+            ...config.client,
+            logCreator: config.logger ? () => this._createLogCreator(config.logger, config.logExtra) : undefined,
         });
-        this._logger = init.logger;
+        this._logger = config.logger;
         globalErrorTypes.forEach(type => {
             process.on(type, e => {
                 this._emitError(e);
@@ -43,7 +44,7 @@ export class KafkaAdapter extends PlatformAdapter {
         });
     }
     get api() {
-        return this.document.msgApi;
+        return this.document.rpcApi;
     }
     /**
      * Starts the service
@@ -69,7 +70,7 @@ export class KafkaAdapter extends PlatformAdapter {
                 }
             }
         }
-        await Promise.allSettled(Array.from(this._consumers.keys()).map(c => c.disconnect()));
+        await Promise.allSettled(Array.from(this._consumers.values()).map(c => c.consumer.disconnect()));
         this._consumers.clear();
         this._controllerInstances.clear();
     }
@@ -87,7 +88,7 @@ export class KafkaAdapter extends PlatformAdapter {
         if (this._consumers.size > 0)
             return;
         /** Create consumers */
-        for (const controller of this.document.msgApi.controllers.values()) {
+        for (const controller of this.document.rpcApi.controllers.values()) {
             let instance = controller.instance;
             if (!instance && controller.ctor)
                 instance = new controller.ctor();
@@ -108,16 +109,34 @@ export class KafkaAdapter extends PlatformAdapter {
         if (typeof instance[operation.name] !== 'function')
             return;
         const proto = controller.ctor?.prototype || Object.getPrototypeOf(controller.instance);
+        // this._config.consumers
         let operationOptions = Reflect.getMetadata(KAFKA_OPERATION_METADATA, proto, operation.name);
         const configResolver = Reflect.getMetadata(KAFKA_OPERATION_METADATA_RESOLVER, proto, operation.name);
         if (configResolver) {
             const cfg = await configResolver();
             operationOptions = { ...operationOptions, ...cfg };
         }
-        const groupId = operationOptions?.groupId || KAFKA_DEFAULT_GROUP;
-        const options = { ...operationOptions, groupId };
-        const consumer = this.kafka.consumer(options);
-        this._consumers.set(consumer, { consumer, controller, instance, operation, options });
+        const consumerConfig = {
+            groupId: KAFKA_DEFAULT_GROUP,
+        };
+        if (typeof operationOptions?.consumer === 'object') {
+            if (this._consumers.has(operationOptions.consumer.groupId)) {
+                throw new Error(`Operation consumer for groupId (${operationOptions.consumer.groupId}) already exists`);
+            }
+            Object.assign(consumerConfig, operationOptions?.consumer);
+        }
+        else if (operationOptions?.consumer) {
+            const x = this._config.consumers?.[operationOptions.consumer];
+            Object.assign(consumerConfig, { ...x, groupId: operationOptions.consumer });
+        }
+        const consumer = this.kafka.consumer(consumerConfig);
+        this._consumers.set(consumerConfig.groupId, {
+            consumer,
+            controller,
+            instance,
+            operation,
+            options: { ...operationOptions },
+        });
         if (typeof controller.onInit === 'function')
             controller.onInit.call(instance, controller);
     }
@@ -264,9 +283,4 @@ export class KafkaAdapter extends PlatformAdapter {
         };
     }
 }
-/**
- * @namespace KafkaAdapter
- */
-(function (KafkaAdapter) {
-    KafkaAdapter.PlatformName = 'kafka';
-})(KafkaAdapter || (KafkaAdapter = {}));
+KafkaAdapter.PlatformName = 'kafka';

package/esm/kafka-context.js

@@ -1,10 +1,10 @@
 import { ExecutionContext } from '@opra/core';
 export class KafkaContext extends ExecutionContext {
     constructor(init) {
-        super({ ...init, document: init.adapter.document, protocol: 'msg' });
+        super({ ...init, document: init.adapter.document, protocol: 'rpc' });
         this.adapter = init.adapter;
         this.platform = init.adapter.platform;
-        this.protocol = 'msg';
+        this.protocol = 'rpc';
         if (init.controller)
             this.controller = init.controller;
         if (init.controllerInstance)

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@opra/kafka",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0-beta.4",
   "description": "Opra Kafka package",
   "author": "Panates",
   "license": "MIT",
   "dependencies": {
-    "@opra/common": "^1.0.0-beta.3",
-    "@opra/core": "^1.0.0-beta.3",
+    "@opra/common": "^1.0.0-beta.4",
+    "@opra/core": "^1.0.0-beta.4",
     "node-events-async": "^1.0.0",
     "tslib": "^2.7.0",
     "valgen": "^5.10.0"

package/types/augmentation/opra-common.augmentation.d.ts

@@ -0,0 +1,7 @@
+import '@opra/core';
+import { KafkaAdapter } from '../kafka-adapter.js';
+declare module '@opra/common' {
+    interface RpcOperationDecorator {
+        Kafka(config: KafkaAdapter.OperationOptions | (() => KafkaAdapter.OperationOptions | Promise<KafkaAdapter.OperationOptions>)): this;
+    }
+}

package/types/index.d.cts

@@ -1,6 +1,5 @@
-import './augmentation/msg-operation.augmentation.js';
+import './augmentation/opra-common.augmentation.js';
 export * from './constants.js';
 export * from './kafka-adapter.js';
 export * from './kafka-context.js';
 export * from './request-parser.js';
-export * from './types.js';

package/types/index.d.ts

@@ -1,6 +1,5 @@
-import './augmentation/msg-operation.augmentation.js';
+import './augmentation/opra-common.augmentation.js';
 export * from './constants.js';
 export * from './kafka-adapter.js';
 export * from './kafka-context.js';
 export * from './request-parser.js';
-export * from './types.js';

package/types/kafka-adapter.d.ts

@@ -1,21 +1,53 @@
-import { ApiDocument, MsgApi, MsgController, MsgOperation, OpraSchema } from '@opra/common';
+import { ApiDocument, OpraSchema, RpcApi, RpcController, RpcOperation } from '@opra/common';
 import { type ILogger, PlatformAdapter } from '@opra/core';
-import { type Consumer, Kafka, type KafkaConfig } from 'kafkajs';
+import { type Consumer, ConsumerConfig, Kafka, type KafkaConfig } from 'kafkajs';
 import type { StrictOmit } from 'ts-gems';
 import { KafkaContext } from './kafka-context.js';
-import type { KafkaOperationOptions } from './types.js';
+/**
+ * @namespace KafkaAdapter
+ */
+export declare namespace KafkaAdapter {
+    type NextCallback = () => Promise<any>;
+    interface Config extends PlatformAdapter.Options {
+        client: StrictOmit<KafkaConfig, 'logCreator' | 'logLevel'>;
+        consumers?: Record<string, StrictOmit<ConsumerConfig, 'groupId'>>;
+        document: ApiDocument;
+        interceptors?: (InterceptorFunction | IKafkaInterceptor)[];
+        logger?: ILogger;
+        logExtra?: boolean;
+    }
+    interface OperationOptions {
+        /**
+         * groupId or ConsumerConfig
+         */
+        consumer?: string | ConsumerConfig;
+        fromBeginning?: boolean;
+    }
+    /**
+     * @type InterceptorFunction
+     */
+    type InterceptorFunction = IKafkaInterceptor['intercept'];
+    /**
+     * @interface IKafkaInterceptor
+     */
+    type IKafkaInterceptor = {
+        intercept(context: KafkaContext, next: NextCallback): Promise<any>;
+    };
+}
 /**
  *
  * @class KafkaAdapter
  */
 export declare class KafkaAdapter extends PlatformAdapter {
-    protected _controllerInstances: Map<MsgController, any>;
-    protected _consumers: Map<Consumer, {
+    static readonly PlatformName = "kafka";
+    protected _config: KafkaAdapter.Config;
+    protected _controllerInstances: Map<RpcController, any>;
+    protected _consumers: Map<string, {
         consumer: Consumer;
-        controller: MsgController;
+        controller: RpcController;
         instance: any;
-        operation: MsgOperation;
-        options: KafkaOperationOptions;
+        operation: RpcOperation;
+        options: KafkaAdapter.OperationOptions;
     }>;
     protected _logger?: ILogger;
     readonly kafka: Kafka;
@@ -24,11 +56,11 @@ export declare class KafkaAdapter extends PlatformAdapter {
     interceptors: (KafkaAdapter.InterceptorFunction | KafkaAdapter.IKafkaInterceptor)[];
     /**
      *
-     * @param init
+     * @param config
      * @constructor
      */
-    constructor(init: KafkaAdapter.InitArguments);
-    get api(): MsgApi;
+    constructor(config: KafkaAdapter.Config);
+    get api(): RpcApi;
     /**
      * Starts the service
      */
@@ -49,7 +81,7 @@ export declare class KafkaAdapter extends PlatformAdapter {
      *
      * @protected
      */
-    protected _initConsumer(controller: MsgController, instance: any, operation: MsgOperation): Promise<void>;
+    protected _initConsumer(controller: RpcController, instance: any, operation: RpcOperation): Promise<void>;
     protected _start(): Promise<void>;
     /**
      * Starts all consumers
@@ -57,10 +89,10 @@ export declare class KafkaAdapter extends PlatformAdapter {
      */
     protected _startConsumer(args: {
         consumer: Consumer;
-        controller: MsgController;
+        controller: RpcController;
         instance: any;
-        operation: MsgOperation;
-        options: KafkaOperationOptions;
+        operation: RpcOperation;
+        options: KafkaAdapter.OperationOptions;
     }): Promise<void>;
     protected _emitError(e: any): void;
     protected _createLogCreator(logger: ILogger, logExtra?: boolean): ({ namespace, level, log }: {
@@ -69,26 +101,3 @@ export declare class KafkaAdapter extends PlatformAdapter {
         log: any;
     }) => any;
 }
-/**
- * @namespace KafkaAdapter
- */
-export declare namespace KafkaAdapter {
-    const PlatformName = "kafka";
-    type NextCallback = () => Promise<void>;
-    interface InitArguments extends StrictOmit<KafkaConfig, 'logCreator' | 'logLevel'>, PlatformAdapter.Options {
-        document: ApiDocument;
-        interceptors?: (InterceptorFunction | IKafkaInterceptor)[];
-        logger?: ILogger;
-        logExtra?: boolean;
-    }
-    /**
-     * @type InterceptorFunction
-     */
-    type InterceptorFunction = IKafkaInterceptor['intercept'];
-    /**
-     * @interface IKafkaInterceptor
-     */
-    type IKafkaInterceptor = {
-        intercept(context: KafkaContext, next: NextCallback): Promise<void>;
-    };
-}

package/types/kafka-context.d.ts

@@ -1,4 +1,4 @@
-import { MsgController, MsgOperation, OpraSchema } from '@opra/common';
+import { OpraSchema, RpcController, RpcOperation } from '@opra/common';
 import { ExecutionContext } from '@opra/core';
 import type { KafkaMessage } from 'kafkajs';
 import type { AsyncEventEmitter } from 'node-events-async';
@@ -6,9 +6,9 @@ import type { KafkaAdapter } from './kafka-adapter.js';
 export declare namespace KafkaContext {
     interface Initiator extends Omit<ExecutionContext.Initiator, 'document' | 'protocol'> {
         adapter: KafkaAdapter;
-        controller?: MsgController;
+        controller?: RpcController;
         controllerInstance?: any;
-        operation?: MsgOperation;
+        operation?: RpcOperation;
         operationHandler?: Function;
         topic: string;
         partition: number;
@@ -24,9 +24,9 @@ export declare class KafkaContext extends ExecutionContext implements AsyncEvent
     readonly protocol: OpraSchema.Transport;
     readonly platform: string;
     readonly adapter: KafkaAdapter;
-    readonly controller?: MsgController;
+    readonly controller?: RpcController;
     readonly controllerInstance?: any;
-    readonly operation?: MsgOperation;
+    readonly operation?: RpcOperation;
     readonly operationHandler?: Function;
     readonly key: any;
     readonly payload: any;

package/types/parsers/binary.parser.d.ts

@@ -1,2 +1,2 @@
-import type { RequestParseFunction } from '../types.js';
+import type { RequestParseFunction } from '../request-parser.js';
 export declare const binaryParser: RequestParseFunction;

package/types/parsers/string.parser.d.ts

@@ -1,2 +1,2 @@
-import type { RequestParseFunction } from '../types.js';
+import type { RequestParseFunction } from '../request-parser.js';
 export declare const stringParser: RequestParseFunction;

package/types/request-parser.d.ts

@@ -1,2 +1,2 @@
-import type { RequestParseFunction } from './types.js';
+export type RequestParseFunction = (buffer: Buffer) => any;
 export declare const RequestParser: Record<string, RequestParseFunction>;

package/cjs/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/esm/types.js

@@ -1 +0,0 @@
-export {};

package/types/augmentation/msg-operation.augmentation.d.ts

@@ -1,7 +0,0 @@
-import '@opra/core';
-import { KafkaOperationOptions } from '../types.js';
-declare module '@opra/common' {
-    interface MsgOperationDecorator {
-        Kafka(config: KafkaOperationOptions | (() => KafkaOperationOptions | Promise<KafkaOperationOptions>)): this;
-    }
-}

package/types/types.d.ts

@@ -1,8 +0,0 @@
-import type { MsgOperationResponse } from '@opra/common';
-import { ConsumerConfig } from 'kafkajs';
-export type RequestParseFunction = (buffer: Buffer) => any;
-export interface KafkaOperationOptions extends ConsumerConfig {
-    fromBeginning?: boolean;
-}
-export interface KafkaOperationResponseOptions extends MsgOperationResponse.Options {
-}