Skip to content

Pass up more cluster metadata #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Pass up more cluster metadata #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/clients/base/base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,8 +409,8 @@ export class Base<OptionsType extends BaseOptions = BaseOptions> extends EventEm

// This should never change, but we act defensively here
for (const broker of metadata.brokers) {
const { host, port } = broker
brokers.set(broker.nodeId, { host, port })
const { host, port, rack } = broker
brokers.set(broker.nodeId, { host, port, rack })
}

this.#metadata.brokers = brokers
Expand All @@ -428,7 +428,9 @@ export class Base<OptionsType extends BaseOptions = BaseOptions> extends EventEm
partitions[rawPartition.partitionIndex] = {
leader: rawPartition.leaderId,
leaderEpoch: rawPartition.leaderEpoch,
replicas: rawPartition.replicaNodes
replicas: rawPartition.replicaNodes,
isr: rawPartition.isrNodes,
offlineReplicas: rawPartition.offlineReplicas
}
}

Expand Down
5 changes: 4 additions & 1 deletion src/clients/base/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { type Broker, type ConnectionOptions } from '../../network/connection.ts'
import { type NullableString } from '../../protocol/definitions.ts'
import { type Metrics } from '../metrics.ts'

export interface TopicWithPartitionAndOffset {
Expand All @@ -11,6 +12,8 @@ export interface ClusterPartitionMetadata {
leader: number
leaderEpoch: number
replicas: number[]
isr: number[]
offlineReplicas: number[]
}

export interface ClusterTopicMetadata {
Expand All @@ -22,7 +25,7 @@ export interface ClusterTopicMetadata {

export interface ClusterMetadata {
id: string
brokers: Map<number, Broker>
brokers: Map<number, Broker & { rack: NullableString }>
Copy link
Contributor

@ShogunPanda ShogunPanda Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mind using a new type for this?

Like: export interface BrokerWithRack extends Broker { rack: NullableString }

Copy link
Contributor Author

@lp247 lp247 Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, will do

topics: Map<string, ClusterTopicMetadata>
lastUpdate: number
}
Expand Down
6 changes: 3 additions & 3 deletions test/clients/base/sasl-oauthbearer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ test('should connect to SASL protected broker using SASL/OAUTHBEARER', async t =

const metadata = await base.metadata({ topics: [] })

deepStrictEqual(metadata.brokers.get(1), saslBroker)
deepStrictEqual(metadata.brokers.get(1), { ...saslBroker, rack: null })
})

test('should handle authentication errors', async t => {
Expand Down Expand Up @@ -103,7 +103,7 @@ test('should accept a function as credential provider', async t => {

const metadata = await base.metadata({ topics: [] })

deepStrictEqual(metadata.brokers.get(1), saslBroker)
deepStrictEqual(metadata.brokers.get(1), { ...saslBroker, rack: null })
})

test('should accept an async function as credential provider', async t => {
Expand Down Expand Up @@ -134,7 +134,7 @@ test('should accept an async function as credential provider', async t => {

const metadata = await base.metadata({ topics: [] })

deepStrictEqual(metadata.brokers.get(1), saslBroker)
deepStrictEqual(metadata.brokers.get(1), { ...saslBroker, rack: null })
})

test('should handle sync credential provider errors', async t => {
Expand Down
6 changes: 3 additions & 3 deletions test/clients/base/sasl.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ for (const mechanism of allowedSASLMechanisms) {

const metadata = await base.metadata({ topics: [] })

deepStrictEqual(metadata.brokers.get(1), saslBroker)
deepStrictEqual(metadata.brokers.get(1), { ...saslBroker, rack: null })
})

test(`${mechanism} - should handle authentication errors`, async t => {
Expand Down Expand Up @@ -90,7 +90,7 @@ for (const mechanism of allowedSASLMechanisms) {

const metadata = await base.metadata({ topics: [] })

deepStrictEqual(metadata.brokers.get(1), saslBroker)
deepStrictEqual(metadata.brokers.get(1), { ...saslBroker, rack: null })
})

test(`${mechanism} - should accept an async function as credential provider`, async t => {
Expand All @@ -113,7 +113,7 @@ for (const mechanism of allowedSASLMechanisms) {

const metadata = await base.metadata({ topics: [] })

deepStrictEqual(metadata.brokers.get(1), saslBroker)
deepStrictEqual(metadata.brokers.get(1), { ...saslBroker, rack: null })
})

test(`${mechanism} - should handle sync credential provider errors`, async t => {
Expand Down