Skip to content

Commit 64dd18c

Browse files
onobconobc
authored
Use PulsarTopicBuilder in Pulsar binder (#2999)
Spring for Apache Pulsar introduced support for default tenant and namespace for Pulsar topics in spring-projects/spring-pulsar@6d23378. This ensures that all topic names are fully-qualified (using the default tenant and namespace when not fully-qualified).
1 parent fe1392e commit 64dd18c

File tree

5 files changed

+41
-27
lines changed

5 files changed

+41
-27
lines changed

‎binders/pulsar-binder/spring-cloud-stream-binder-pulsar/src/main/java/org/springframework/cloud/stream/binder/pulsar/config/PulsarBinderConfiguration.java‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2023-2023 the original author or authors.
2+
* Copyright 2023-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -29,6 +29,7 @@
2929
import org.springframework.pulsar.core.PulsarAdministration;
3030
import org.springframework.pulsar.core.PulsarConsumerFactory;
3131
import org.springframework.pulsar.core.PulsarTemplate;
32+
import org.springframework.pulsar.core.PulsarTopicBuilder;
3233
import org.springframework.pulsar.core.SchemaResolver;
3334
import org.springframework.pulsar.support.header.JacksonUtils;
3435
import org.springframework.pulsar.support.header.JsonPulsarHeaderMapper;
@@ -39,6 +40,7 @@
3940
* Pulsar binder {@link Configuration}.
4041
*
4142
* @author Soby Chacko
43+
* @author Chris Bono
4244
*/
4345
@Configuration(proxyBeanMethods = false)
4446
@ConditionalOnMissingBean(Binder.class)
@@ -48,8 +50,9 @@ public class PulsarBinderConfiguration {
4850

4951
@Bean
5052
public PulsarTopicProvisioner pulsarTopicProvisioner(PulsarAdministration pulsarAdministration,
51-
PulsarBinderConfigurationProperties pulsarBinderConfigurationProperties) {
52-
return new PulsarTopicProvisioner(pulsarAdministration, pulsarBinderConfigurationProperties);
53+
PulsarBinderConfigurationProperties pulsarBinderConfigurationProperties,
54+
PulsarTopicBuilder topicBuilder) {
55+
return new PulsarTopicProvisioner(pulsarAdministration, pulsarBinderConfigurationProperties, topicBuilder);
5356
}
5457

5558
@Bean

‎binders/pulsar-binder/spring-cloud-stream-binder-pulsar/src/main/java/org/springframework/cloud/stream/binder/pulsar/provisioning/PulsarTopicProvisioner.java‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2022-2023 the original author or authors.
2+
* Copyright 2022-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -27,12 +27,13 @@
2727
import org.springframework.cloud.stream.provisioning.ProvisioningProvider;
2828
import org.springframework.lang.Nullable;
2929
import org.springframework.pulsar.core.PulsarAdministration;
30-
import org.springframework.pulsar.core.PulsarTopic;
30+
import org.springframework.pulsar.core.PulsarTopicBuilder;
3131

3232
/**
3333
* Pulsar topic provisioner.
3434
*
3535
* @author Soby Chacko
36+
* @author Chris Bono
3637
*/
3738
public class PulsarTopicProvisioner implements
3839
ProvisioningProvider<ExtendedConsumerProperties<PulsarConsumerProperties>, ExtendedProducerProperties<PulsarProducerProperties>> {
@@ -41,10 +42,19 @@ public class PulsarTopicProvisioner implements
4142

4243
private final PulsarBinderConfigurationProperties pulsarBinderConfigurationProperties;
4344

45+
private final PulsarTopicBuilder topicBuilder;
46+
4447
public PulsarTopicProvisioner(PulsarAdministration pulsarAdministration,
4548
PulsarBinderConfigurationProperties pulsarBinderConfigurationProperties) {
49+
this(pulsarAdministration, pulsarBinderConfigurationProperties, new PulsarTopicBuilder());
50+
}
51+
52+
public PulsarTopicProvisioner(PulsarAdministration pulsarAdministration,
53+
PulsarBinderConfigurationProperties pulsarBinderConfigurationProperties,
54+
PulsarTopicBuilder topicBuilder) {
4655
this.pulsarAdministration = pulsarAdministration;
4756
this.pulsarBinderConfigurationProperties = pulsarBinderConfigurationProperties;
57+
this.topicBuilder = topicBuilder;
4858
}
4959

5060
@Override
@@ -53,7 +63,7 @@ public ProducerDestination provisionProducerDestination(String name,
5363
throws ProvisioningException {
5464
Integer partitionCountFromBinding = pulsarProducerProperties.getExtension().getPartitionCount();
5565
var partitionCount = getPartitionCount(partitionCountFromBinding);
56-
var pulsarTopic = PulsarTopic.builder(name).numberOfPartitions(partitionCount).build();
66+
var pulsarTopic = this.topicBuilder.name(name).numberOfPartitions(partitionCount).build();
5767
this.pulsarAdministration.createOrModifyTopics(pulsarTopic);
5868
return new PulsarDestination(pulsarTopic.topicName(), pulsarTopic.numberOfPartitions());
5969
}
@@ -72,7 +82,7 @@ public ConsumerDestination provisionConsumerDestination(String name, String grou
7282
throws ProvisioningException {
7383
var partitionCountFromBinding = pulsarConsumerProperties.getExtension().getPartitionCount();
7484
var partitionCount = getPartitionCount(partitionCountFromBinding);
75-
var pulsarTopic = PulsarTopic.builder(name).numberOfPartitions(partitionCount).build();
85+
var pulsarTopic = this.topicBuilder.name(name).numberOfPartitions(partitionCount).build();
7686
this.pulsarAdministration.createOrModifyTopics(pulsarTopic);
7787
return new PulsarDestination(pulsarTopic.topicName(), pulsarTopic.numberOfPartitions());
7888
}

‎binders/pulsar-binder/spring-cloud-stream-binder-pulsar/src/test/java/org/springframework/cloud/stream/binder/pulsar/PulsarBinderTests.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2023-2023 the original author or authors.
2+
* Copyright 2023-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -55,6 +55,7 @@
5555
import org.springframework.pulsar.core.DefaultSchemaResolver;
5656
import org.springframework.pulsar.core.PulsarAdministration;
5757
import org.springframework.pulsar.core.PulsarTemplate;
58+
import org.springframework.pulsar.core.PulsarTopicBuilder;
5859
import org.springframework.pulsar.support.header.JsonPulsarHeaderMapper;
5960
import org.springframework.util.Assert;
6061
import org.springframework.util.MimeTypeUtils;
@@ -101,7 +102,8 @@ protected String getClassUnderTestName() {
101102
protected PulsarTestBinder getBinder() {
102103
var pulsarAdministration = new PulsarAdministration(PulsarTestContainerSupport.getHttpServiceUrl());
103104
var configProps = new PulsarBinderConfigurationProperties();
104-
var provisioner = new PulsarTopicProvisioner(pulsarAdministration, configProps);
105+
var topicBuilder = new PulsarTopicBuilder();
106+
var provisioner = new PulsarTopicProvisioner(pulsarAdministration, configProps, topicBuilder);
105107
var producerFactory = new DefaultPulsarProducerFactory<>(pulsarClient);
106108
var pulsarTemplate = new PulsarTemplate<>(producerFactory);
107109
var consumerFactory = new DefaultPulsarConsumerFactory<>(pulsarClient,

‎binders/pulsar-binder/spring-cloud-stream-binder-pulsar/src/test/java/org/springframework/cloud/stream/binder/pulsar/PulsarTopicProvisionerTests.java‎

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2023-2023 the original author or authors.
2+
* Copyright 2023-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -50,17 +50,7 @@ void provisionThroughProducerBindingWithDefaultPartitioning() {
5050
new PulsarProducerProperties());
5151
ProducerDestination producerDestination = pulsarTopicProvisioner.provisionProducerDestination("foo",
5252
properties);
53-
verifyAndAssert(pulsarAdministration, producerDestination.getName(), "foo", 0);
54-
}
55-
56-
private static void verifyAndAssert(PulsarAdministration pulsarAdministration, String actualProducerDestination,
57-
String expectedProducerDestination, int expectedPartitionCount) {
58-
ArgumentCaptor<PulsarTopic> pulsarTopicArgumentCaptor = ArgumentCaptor.forClass(PulsarTopic.class);
59-
verify(pulsarAdministration, times(1)).createOrModifyTopics(pulsarTopicArgumentCaptor.capture());
60-
assertThat(actualProducerDestination).isEqualTo(expectedProducerDestination);
61-
PulsarTopic pulsarTopic = pulsarTopicArgumentCaptor.getValue();
62-
assertThat(pulsarTopic.topicName()).isEqualTo(expectedProducerDestination);
63-
assertThat(pulsarTopic.numberOfPartitions()).isEqualTo(expectedPartitionCount);
53+
verifyAndAssert(pulsarAdministration, producerDestination.getName(), "persistent://public/default/foo", 0);
6454
}
6555

6656
@Test
@@ -73,7 +63,7 @@ void provisionThroughConsumerBindingWithDefaultPartitioning() {
7363
new PulsarConsumerProperties());
7464
ConsumerDestination consumerDestination = pulsarTopicProvisioner.provisionConsumerDestination("bar", "",
7565
properties);
76-
verifyAndAssert(pulsarAdministration, consumerDestination.getName(), "bar", 0);
66+
verifyAndAssert(pulsarAdministration, consumerDestination.getName(), "persistent://public/default/bar", 0);
7767
}
7868

7969
@Test
@@ -87,7 +77,7 @@ void provisioningOnProducerBindingWithPartitionsSetAtTheBinderProperties() {
8777
new PulsarProducerProperties());
8878
ProducerDestination producerDestination = pulsarTopicProvisioner.provisionProducerDestination("foo",
8979
properties);
90-
verifyAndAssert(pulsarAdministration, producerDestination.getName(), "foo", 4);
80+
verifyAndAssert(pulsarAdministration, producerDestination.getName(), "persistent://public/default/foo", 4);
9181
}
9282

9383
@Test
@@ -101,7 +91,7 @@ void provisioningOnProducerBindingWithPartitionsSetAtTheBindingProperties() {
10191
properties.getExtension().setPartitionCount(4);
10292
ProducerDestination producerDestination = pulsarTopicProvisioner.provisionProducerDestination("foo",
10393
properties);
104-
verifyAndAssert(pulsarAdministration, producerDestination.getName(), "foo", 4);
94+
verifyAndAssert(pulsarAdministration, producerDestination.getName(), "persistent://public/default/foo", 4);
10595
}
10696

10797
@Test
@@ -115,7 +105,7 @@ void provisionThroughConsumerBindingWithPartitionsSetAtTheBinderProperties() {
115105
new PulsarConsumerProperties());
116106
ConsumerDestination consumerDestination = pulsarTopicProvisioner.provisionConsumerDestination("bar", "",
117107
properties);
118-
verifyAndAssert(pulsarAdministration, consumerDestination.getName(), "bar", 4);
108+
verifyAndAssert(pulsarAdministration, consumerDestination.getName(), "persistent://public/default/bar", 4);
119109
}
120110

121111
@Test
@@ -130,7 +120,16 @@ void provisionThroughConsumerBindingWithPartitionsSetAtTheBindingProperties() {
130120
pulsarConsumerProperties);
131121
ConsumerDestination consumerDestination = pulsarTopicProvisioner.provisionConsumerDestination("bar", "",
132122
properties);
133-
verifyAndAssert(pulsarAdministration, consumerDestination.getName(), "bar", 4);
123+
verifyAndAssert(pulsarAdministration, consumerDestination.getName(), "persistent://public/default/bar", 4);
134124
}
135125

126+
private static void verifyAndAssert(PulsarAdministration pulsarAdministration, String actualProducerDestination,
127+
String expectedProducerDestination, int expectedPartitionCount) {
128+
ArgumentCaptor<PulsarTopic> pulsarTopicArgumentCaptor = ArgumentCaptor.forClass(PulsarTopic.class);
129+
verify(pulsarAdministration, times(1)).createOrModifyTopics(pulsarTopicArgumentCaptor.capture());
130+
assertThat(actualProducerDestination).isEqualTo(expectedProducerDestination);
131+
PulsarTopic pulsarTopic = pulsarTopicArgumentCaptor.getValue();
132+
assertThat(pulsarTopic.topicName()).isEqualTo(expectedProducerDestination);
133+
assertThat(pulsarTopic.numberOfPartitions()).isEqualTo(expectedPartitionCount);
134+
}
136135
}

‎bom/spring-cloud-starter-parent/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<parent>
77
<groupId>org.springframework.boot</groupId>
88
<artifactId>spring-boot-starter-parent</artifactId>
9-
<version>3.4.0-M1</version>
9+
<version>3.4.0-M2</version>
1010
<relativePath/>
1111
</parent>
1212
<groupId>org.springframework.cloud</groupId>

0 commit comments

Comments
 (0)