@rsdk/kafka.common 4.11.0-next.1 → 4.11.1

package/CHANGELOG.md

@@ -3,10 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [4.11.0-next.1](https://github.com/R-Vision/rsdk/compare/v4.11.0-next.0...v4.11.0-next.1) (2024-07-04)
+## [4.11.1](https://github.com/R-Vision/rsdk/compare/v4.11.0...v4.11.1) (2024-07-04)
 
 **Note:** Version bump only for package @rsdk/kafka.common
 
+## [4.11.0](https://github.com/R-Vision/rsdk/compare/v4.11.0-next.0...v4.11.0) (2024-07-04)
+
+### Features
+
+* add KAFKA_CONSUMER_GROUP env ([#248](https://github.com/R-Vision/rsdk/issues/248)) ([966922e](https://github.com/R-Vision/rsdk/commit/966922eda900a71df3bc260a1eb7cf6a3dc7e5c1))
+
+## [4.11.0-next.1](https://github.com/R-Vision/rsdk/compare/v4.11.0-next.0...v4.11.0-next.1) (2024-07-04)
+
+### Features
+
+* add KAFKA_CONSUMER_GROUP env ([#248](https://github.com/R-Vision/rsdk/issues/248)) ([966922e](https://github.com/R-Vision/rsdk/commit/966922eda900a71df3bc260a1eb7cf6a3dc7e5c1))
+
 ## [4.11.0-next.0](https://github.com/R-Vision/rsdk/compare/v4.10.2...v4.11.0-next.0) (2024-07-04)
 
 **Note:** Version bump only for package @rsdk/kafka.common

package/dist/client/kafka.config.d.ts

@@ -1,4 +1,7 @@
 import { Config } from '@rsdk/core';
+export declare const VALID_TOPIC_NAME: RegExp;
 export declare class KafkaConfig extends Config {
     readonly brokers: string[];
+    readonly consumerGroupSuffix?: string;
+    readonly fromBeginning: boolean;
 }

package/dist/client/kafka.config.js

@@ -9,10 +9,14 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KafkaConfig = void 0;
+exports.KafkaConfig = exports.VALID_TOPIC_NAME = void 0;
+const common_1 = require("@rsdk/common");
 const core_1 = require("@rsdk/core");
+exports.VALID_TOPIC_NAME = /^[a-z]+(_[a-z]+)*$/;
 let KafkaConfig = class KafkaConfig extends core_1.Config {
     brokers;
+    consumerGroupSuffix;
+    fromBeginning;
 };
 exports.KafkaConfig = KafkaConfig;
 __decorate([
@@ -21,6 +25,24 @@ __decorate([
     }),
     __metadata("design:type", Array)
 ], KafkaConfig.prototype, "brokers", void 0);
+__decorate([
+    (0, core_1.Property)('KAFKA_CONSUMER_GROUP_SUFFIX', new core_1.StringParser(exports.VALID_TOPIC_NAME), {
+        description: (0, common_1.text) `
+      Kafka consumer group suffix in snake case. Suffix will
+      be appended to the consumer group id`,
+        defaultValue: undefined,
+    }),
+    __metadata("design:type", String)
+], KafkaConfig.prototype, "consumerGroupSuffix", void 0);
+__decorate([
+    (0, core_1.Property)('KAFKA_CONSUMER_FROM_BEGINNING', new core_1.BoolParser(), {
+        description: (0, common_1.text) `
+      When consumer group for this consumer is created, offset will be set to 0
+      (not every time consumer reconnects!)`,
+        defaultValue: false,
+    }),
+    __metadata("design:type", Boolean)
+], KafkaConfig.prototype, "fromBeginning", void 0);
 exports.KafkaConfig = KafkaConfig = __decorate([
     (0, core_1.ConfigSection)()
 ], KafkaConfig);

package/dist/client/kafka.config.js.map

@@ -1 +1 @@
-{"version":3,"file":"kafka.config.js","sourceRoot":"","sources":["../../src/client/kafka.config.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAMoB;AAGb,IAAM,WAAW,GAAjB,MAAM,WAAY,SAAQ,aAAM;IAI5B,OAAO,CAAY;CAC7B,CAAA;AALY,kCAAW;AAIb;IAHR,IAAA,eAAQ,EAAC,eAAe,EAAE,IAAI,kBAAW,CAAC,IAAI,mBAAY,EAAE,CAAC,EAAE;QAC9D,WAAW,EAAE,uBAAuB;KACrC,CAAC;;4CAC0B;sBAJjB,WAAW;IADvB,IAAA,oBAAa,GAAE;GACH,WAAW,CAKvB"}
+{"version":3,"file":"kafka.config.js","sourceRoot":"","sources":["../../src/client/kafka.config.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yCAAoC;AACpC,qCAOoB;AAEP,QAAA,gBAAgB,GAAG,oBAAoB,CAAC;AAG9C,IAAM,WAAW,GAAjB,MAAM,WAAY,SAAQ,aAAM;IAI5B,OAAO,CAAY;IAQnB,mBAAmB,CAAU;IAQ7B,aAAa,CAAW;CAClC,CAAA;AArBY,kCAAW;AAIb;IAHR,IAAA,eAAQ,EAAC,eAAe,EAAE,IAAI,kBAAW,CAAC,IAAI,mBAAY,EAAE,CAAC,EAAE;QAC9D,WAAW,EAAE,uBAAuB;KACrC,CAAC;;4CAC0B;AAQnB;IANR,IAAA,eAAQ,EAAC,6BAA6B,EAAE,IAAI,mBAAY,CAAC,wBAAgB,CAAC,EAAE;QAC3E,WAAW,EAAE,IAAA,aAAI,EAAA;;2CAEsB;QACvC,YAAY,EAAE,SAAS;KACxB,CAAC;;wDACoC;AAQ7B;IANR,IAAA,eAAQ,EAAC,+BAA+B,EAAE,IAAI,iBAAU,EAAE,EAAE;QAC3D,WAAW,EAAE,IAAA,aAAI,EAAA;;4CAEuB;QACxC,YAAY,EAAE,KAAK;KACpB,CAAC;;kDAC+B;sBApBtB,WAAW;IADvB,IAAA,oBAAa,GAAE;GACH,WAAW,CAqBvB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/kafka.common",
-  "version": "4.11.0-next.1",
+  "version": "4.11.1",
   "description": "Common functionality for kafka consumers and producers",
   "license": "Apache License 2.0",
   "publishConfig": {
@@ -26,5 +26,5 @@
     "lodash": "^4.17.21",
     "protobufjs": "^7.2.3"
   },
-  "gitHead": "c20f377a0ff6b5110ae02fdce0517024d84ea150"
+  "gitHead": "50e48dd58a91c63d0afb04a5db908f8911ac5945"
 }

package/src/client/kafka.config.spec.ts

@@ -0,0 +1,17 @@
+import { VALID_TOPIC_NAME } from './kafka.config';
+
+describe('StringMatcher', () => {
+  it('should accept correct topic names', () => {
+    expect(VALID_TOPIC_NAME.test('abcd_absd')).toBe(true);
+    expect(VALID_TOPIC_NAME.test('lower_case_case_case')).toBe(true);
+    expect(VALID_TOPIC_NAME.test('lower')).toBe(true);
+  });
+
+  it('should reject invalid topic names', () => {
+    expect(VALID_TOPIC_NAME.test('abcd1234')).toBe(false);
+    expect(VALID_TOPIC_NAME.test('abcd_Av')).toBe(false);
+    expect(VALID_TOPIC_NAME.test('abcd_')).toBe(false);
+    expect(VALID_TOPIC_NAME.test('_abcd')).toBe(false);
+    expect(VALID_TOPIC_NAME.test('Av')).toBe(false);
+  });
+});

package/src/client/kafka.config.ts

@@ -1,15 +1,35 @@
+import { text } from '@rsdk/common';
 import {
   ArrayParser,
+  BoolParser,
   Config,
   ConfigSection,
   Property,
   StringParser,
 } from '@rsdk/core';
 
+export const VALID_TOPIC_NAME = /^[a-z]+(_[a-z]+)*$/;
+
 @ConfigSection()
 export class KafkaConfig extends Config {
   @Property('KAFKA_BROKERS', new ArrayParser(new StringParser()), {
     description: 'List of Kafka brokers',
   })
   readonly brokers!: string[];
+
+  @Property('KAFKA_CONSUMER_GROUP_SUFFIX', new StringParser(VALID_TOPIC_NAME), {
+    description: text`
+      Kafka consumer group suffix in snake case. Suffix will
+      be appended to the consumer group id`,
+    defaultValue: undefined,
+  })
+  readonly consumerGroupSuffix?: string;
+
+  @Property('KAFKA_CONSUMER_FROM_BEGINNING', new BoolParser(), {
+    description: text`
+      When consumer group for this consumer is created, offset will be set to 0
+      (not every time consumer reconnects!)`,
+    defaultValue: false,
+  })
+  readonly fromBeginning!: boolean;
 }