|
| 1 | +/* |
| 2 | + * Copyright 2020 Spotify AB |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +import { Kafka, SeekEntry } from 'kafkajs'; |
| 18 | +import { Logger } from 'winston'; |
| 19 | +import { ConnectionOptions } from 'tls'; |
| 20 | + |
| 21 | +export type PartitionOffset = { |
| 22 | + id: number; |
| 23 | + offset: string; |
| 24 | +}; |
| 25 | + |
| 26 | +export type TopicOffset = { |
| 27 | + topic: string; |
| 28 | + partitions: PartitionOffset[]; |
| 29 | +}; |
| 30 | + |
| 31 | +export type Options = { |
| 32 | + clientId: string; |
| 33 | + brokers: string[]; |
| 34 | + ssl?: ConnectionOptions; |
| 35 | + logger: Logger; |
| 36 | +}; |
| 37 | + |
| 38 | +export interface KafkaApi { |
| 39 | + fetchTopicOffsets(topic: string): Promise<Array<PartitionOffset>>; |
| 40 | + fetchGroupOffsets(groupId: string): Promise<Array<TopicOffset>>; |
| 41 | +} |
| 42 | + |
| 43 | +export class KafkaJsApiImpl implements KafkaApi { |
| 44 | + private readonly kafka: Kafka; |
| 45 | + private readonly logger: Logger; |
| 46 | + |
| 47 | + constructor(options: Options) { |
| 48 | + options.logger.debug( |
| 49 | + `creating kafka client with clientId=${options.clientId} and brokers=${options.brokers}`, |
| 50 | + ); |
| 51 | + |
| 52 | + this.kafka = new Kafka(options); |
| 53 | + this.logger = options.logger; |
| 54 | + } |
| 55 | + |
| 56 | + async fetchTopicOffsets(topic: string): Promise<Array<PartitionOffset>> { |
| 57 | + this.logger.debug(`fetching topic offsets for ${topic}`); |
| 58 | + |
| 59 | + const admin = this.kafka.admin(); |
| 60 | + await admin.connect(); |
| 61 | + |
| 62 | + try { |
| 63 | + return KafkaJsApiImpl.toPartitionOffsets( |
| 64 | + await admin.fetchTopicOffsets(topic), |
| 65 | + ); |
| 66 | + } finally { |
| 67 | + await admin.disconnect(); |
| 68 | + } |
| 69 | + } |
| 70 | + |
| 71 | + async fetchGroupOffsets(groupId: string): Promise<Array<TopicOffset>> { |
| 72 | + this.logger.debug(`fetching consumer group offsets for ${groupId}`); |
| 73 | + |
| 74 | + const admin = this.kafka.admin(); |
| 75 | + await admin.connect(); |
| 76 | + |
| 77 | + try { |
| 78 | + const groupOffsets = await admin.fetchOffsets({ groupId }); |
| 79 | + |
| 80 | + return groupOffsets.map(topicOffset => ({ |
| 81 | + topic: topicOffset.topic, |
| 82 | + partitions: KafkaJsApiImpl.toPartitionOffsets(topicOffset.partitions), |
| 83 | + })); |
| 84 | + } finally { |
| 85 | + await admin.disconnect(); |
| 86 | + } |
| 87 | + } |
| 88 | + |
| 89 | + private static toPartitionOffsets( |
| 90 | + result: Array<SeekEntry>, |
| 91 | + ): Array<PartitionOffset> { |
| 92 | + return result.map(seekEntry => ({ |
| 93 | + id: seekEntry.partition, |
| 94 | + offset: seekEntry.offset, |
| 95 | + })); |
| 96 | + } |
| 97 | +} |
0 commit comments