Skip to content

CAIP-302 Add includeInvisible agent datafeed parameter #853

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

Merged
symphony-enrico merged 4 commits into from
Feb 6, 2026
+48 −22
Merged

CAIP-302 Add includeInvisible agent datafeed parameter #853

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
13630d4
CAIP-302 Add includeInvisible agent datafeed parameter
symphony-enrico Feb 3, 2026
fdc4877
Update DatafeedLoopV2Test.java
symphony-enrico Feb 3, 2026
321a084
custom tag
symphony-enrico Feb 3, 2026
174d8be
javadoc
symphony-enrico Feb 6, 2026
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
5 changes: 5 additions & 0 deletions symphony-bdk-config/src/main/java/com/symphony/bdk/core/config/model/BdkDatafeedConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ public class BdkDatafeedConfig {
private String version = "v2";
private String idFilePath;
private BdkRetryConfig retry = new BdkRetryConfig(BdkRetryConfig.INFINITE_MAX_ATTEMPTS);
/**
* Agent 26.2.1 or later required to enable includeInvisible.
*/
private boolean includeInvisible = false;
private String tag;

public void setVersion(String version) {
if ("v1".equalsIgnoreCase(version)) {
Expand Down
2 changes: 1 addition & 1 deletion symphony-bdk-core/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ dependencies {
}

// OpenAPI code generation
def apiBaseUrl = "https://raw.githubusercontent.com/finos/symphony-api-spec/ee09734380226ac1109a1513156ceefac3bd5a1e"
def apiBaseUrl = "https://raw.githubusercontent.com/finos/symphony-api-spec/5526c5e81cb2313c4aab18119b526534652ba98e"
def generatedFolder = "$buildDir/generated/openapi"
def apisToGenerate = [
Agent: 'agent/agent-api-public-deprecated.yaml',
Expand Down
26 changes: 23 additions & 3 deletions ...ny-bdk-core/src/main/java/com/symphony/bdk/core/service/datafeed/impl/DatafeedLoopV2.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import com.symphony.bdk.http.api.ApiException;

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.apiguardian.api.API;

import java.util.List;
Expand Down Expand Up @@ -47,13 +48,16 @@ public class DatafeedLoopV2 extends AbstractAckIdEventLoop {
* Datahose feeds are in the format *_p_*, e.g. "d25098517ec62f1fc65cd111667a8386_p_be940".
*/
private static final Pattern FANOUT_FEED_PATTERN = Pattern.compile("^[^\\s_]+_f(_[^\\s_]+)?$");
private static final String FANOUT_TYPE = "fanout";

private final RetryWithRecoveryBuilder<?> retryWithRecoveryBuilder;
private final RetryWithRecovery<Void> readDatafeed;
private final RetryWithRecovery<V5Datafeed> retrieveDatafeed;
private final RetryWithRecovery<V5Datafeed> createDatafeed;
private final RetryWithRecovery<Void> deleteDatafeed;

private final V5DatafeedCreateBody datafeedCreateBody;

private V5Datafeed datafeed;

public DatafeedLoopV2(DatafeedApi datafeedApi, AuthSession authSession, BdkConfig config, UserV2 botInfo) {
Expand Down Expand Up @@ -87,6 +91,14 @@ public DatafeedLoopV2(DatafeedApi datafeedApi, AuthSession authSession, BdkConfi
.supplier(this::doDeleteDatafeed)
.ignoreException(ApiException::isClientError)
.build();

datafeedCreateBody = new V5DatafeedCreateBody();
if (config.getDatafeed().isIncludeInvisible()) {
datafeedCreateBody.setIncludeInvisible(true);
}
if (StringUtils.isNotBlank(config.getDatafeed().getTag())) {
datafeedCreateBody.setTag(config.getDatafeed().getTag());
}
}

@Override
Expand All @@ -108,7 +120,7 @@ private V5Datafeed doCreateDatafeed() throws ApiException {
return this.datafeedApi.createDatafeed(
this.authSession.getSessionToken(),
this.authSession.getKeyManagerToken(),
new V5DatafeedCreateBody()
datafeedCreateBody
);
}

Expand All @@ -118,10 +130,18 @@ private V5Datafeed doRetrieveDatafeed() throws ApiException {
this.authSession.getKeyManagerToken(),
null
);
return feeds.stream().filter(this::isFanoutFeed).findFirst().orElse(null);
return feeds.stream().filter(this::isMatchingFeed).findFirst().orElse(null);
}

private boolean isFanoutFeed(V5Datafeed d) {
private boolean isMatchingFeed(V5Datafeed d) {
if (this.datafeedCreateBody.getTag() != null) {
if (this.datafeedCreateBody.getTag().equals(d.getId())
&& FANOUT_TYPE.equalsIgnoreCase(d.getType())) {
return true;
} else {
return false;
}
}
final String datafeedId = d.getId();
return datafeedId != null && FANOUT_FEED_PATTERN.matcher(datafeedId).matches();
}
Expand Down
36 changes: 18 additions & 18 deletions ...dk-core/src/test/java/com/symphony/bdk/core/service/datafeed/impl/DatafeedLoopV2Test.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ void testStartWithoutTag() throws ApiException, AuthUnauthorizedException {
void testStartInvalidExistingFeeds(String invalidExistingFeedId) throws ApiException, AuthUnauthorizedException {
when(datafeedApi.listDatafeed(TOKEN, TOKEN, null))
.thenReturn(Collections.singletonList(new V5Datafeed().id(invalidExistingFeedId)));
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody())).thenReturn(
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody().includeInvisible(true))).thenReturn(
new V5Datafeed().id(DATAFEED_ID));

AckId ackId = new AckId().ackId(datafeedService.getAckId());
Expand All @@ -138,7 +138,7 @@ void testStartInvalidExistingFeeds(String invalidExistingFeedId) throws ApiExcep

this.datafeedService.start();

V5DatafeedCreateBody datafeedCreateBody = new V5DatafeedCreateBody();
V5DatafeedCreateBody datafeedCreateBody = new V5DatafeedCreateBody().includeInvisible(true);
verify(datafeedApi, times(1)).listDatafeed(TOKEN, TOKEN, null);
verify(datafeedApi, times(1)).createDatafeed(TOKEN, TOKEN, datafeedCreateBody);
verify(datafeedApi, times(1)).readDatafeed(DATAFEED_ID, TOKEN, TOKEN, ackId);
Expand All @@ -149,7 +149,7 @@ void testStartInvalidExistingFeeds(String invalidExistingFeedId) throws ApiExcep
void testStartValidExistingFeeds(String validExistingFeedId) throws ApiException, AuthUnauthorizedException {
when(datafeedApi.listDatafeed(TOKEN, TOKEN, null))
.thenReturn(Collections.singletonList(new V5Datafeed().id(validExistingFeedId)));
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody())).thenReturn(
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody().includeInvisible(true))).thenReturn(
new V5Datafeed().id(validExistingFeedId));

AckId ackId = new AckId().ackId(datafeedService.getAckId());
Expand All @@ -160,7 +160,7 @@ void testStartValidExistingFeeds(String validExistingFeedId) throws ApiException

this.datafeedService.start();

V5DatafeedCreateBody datafeedCreateBody = new V5DatafeedCreateBody();
V5DatafeedCreateBody datafeedCreateBody = new V5DatafeedCreateBody().includeInvisible(true);
verify(datafeedApi, times(1)).listDatafeed(TOKEN, TOKEN, null);
verify(datafeedApi, times(0)).createDatafeed(TOKEN, TOKEN, datafeedCreateBody);
verify(datafeedApi, times(1)).readDatafeed(validExistingFeedId, TOKEN, TOKEN, ackId);
Expand Down Expand Up @@ -337,7 +337,7 @@ private ArgumentMatcher<AckId> eqAckId(String ackId) {
@Test
void testStartEmptyListDatafeed() throws ApiException, AuthUnauthorizedException {
when(datafeedApi.listDatafeed(TOKEN, TOKEN, null)).thenReturn(Collections.emptyList());
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody())).thenReturn(
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody().includeInvisible(true))).thenReturn(
new V5Datafeed().id(DATAFEED_ID));
AckId initialAckId = new AckId().ackId("");
final String secondAckId = "ack-id";
Expand All @@ -349,11 +349,11 @@ void testStartEmptyListDatafeed() throws ApiException, AuthUnauthorizedException
this.datafeedService.start();

verify(datafeedApi, times(1)).listDatafeed(TOKEN, TOKEN, null);
verify(datafeedApi, times(1)).createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody());
verify(datafeedApi, times(1)).createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody().includeInvisible(true));
verify(datafeedApi, times(1)).readDatafeed(DATAFEED_ID, TOKEN, TOKEN, initialAckId);
assertEquals(secondAckId, datafeedService.getAckId());
}

@Test
void testClientErrorTriggersDatafeedRecreation() throws ApiException, AuthUnauthorizedException {
when(datafeedApi.listDatafeed(TOKEN, TOKEN, null)).thenReturn(
Expand All @@ -370,7 +370,7 @@ void testClientErrorTriggersDatafeedRecreation() throws ApiException, AuthUnauth
.thenThrow(new ApiException(400, ""));
when(datafeedApi.deleteDatafeed(DATAFEED_ID, TOKEN, TOKEN)).thenReturn(null);

when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody())).thenReturn(
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody().includeInvisible(true))).thenReturn(
new V5Datafeed().id(secondDatafeedId));
when(datafeedApi.readDatafeed(secondDatafeedId, TOKEN, TOKEN, initialAckId))
.thenReturn(new V5EventList().addEventsItem(
Expand Down Expand Up @@ -470,43 +470,43 @@ void testStartErrorListDatafeedThenRetrySuccess() throws ApiException, AuthUnaut
@Test
void testStartAuthErrorCreateDatafeed() throws ApiException, AuthUnauthorizedException {
when(datafeedApi.listDatafeed(TOKEN, TOKEN, null)).thenReturn(Collections.emptyList());
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody())).thenThrow(
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody().includeInvisible(true))).thenThrow(
new ApiException(401, "unauthorized-error"));
doThrow(AuthUnauthorizedException.class).when(authSession).refresh();

assertThrows(AuthUnauthorizedException.class, this.datafeedService::start);
verify(datafeedApi, times(1)).listDatafeed(TOKEN, TOKEN, null);
verify(datafeedApi, times(1)).createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody());
verify(datafeedApi, times(1)).createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody().includeInvisible(true));
}

@Test
void testStartClientErrorCreateDatafeed() throws ApiException {
when(datafeedApi.listDatafeed(TOKEN, TOKEN, null)).thenReturn(Collections.emptyList());
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody())).thenThrow(
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody().includeInvisible(true))).thenThrow(
new ApiException(400, "client-error"));

assertThrows(ApiException.class, this.datafeedService::start);
verify(datafeedApi, times(1)).listDatafeed(TOKEN, TOKEN, null);
verify(datafeedApi, times(2)).createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody());
verify(datafeedApi, times(2)).createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody().includeInvisible(true));
}

@Test
void testStartServerErrorCreateDatafeed() throws ApiException {
when(datafeedApi.listDatafeed(TOKEN, TOKEN, null)).thenReturn(Collections.emptyList());
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody())).thenThrow(
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody().includeInvisible(true))).thenThrow(
new ApiException(502, "server-error"));

assertThrows(ApiException.class, this.datafeedService::start);
verify(datafeedApi, times(1)).listDatafeed(TOKEN, TOKEN, null);
verify(datafeedApi, times(2)).createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody());
verify(datafeedApi, times(2)).createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody().includeInvisible(true));
}

@Test
void testStartClientErrorReadDatafeedAndClientErrorCreateDatafeed() throws ApiException, AuthUnauthorizedException {
AckId ackId = new AckId().ackId(datafeedService.getAckId());
when(datafeedApi.listDatafeed(TOKEN, TOKEN, null)).thenReturn(
Collections.singletonList(new V5Datafeed().id(DATAFEED_ID)));
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody()))
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody().includeInvisible(true)))
.thenThrow(new ApiException(400, "ALB: No matching rule found"))
.thenReturn(new V5Datafeed().id("recreate-df-id"));
when(datafeedApi.readDatafeed(DATAFEED_ID, TOKEN, TOKEN, ackId)).thenThrow(new ApiException(400, "client-error"));
Expand All @@ -520,7 +520,7 @@ void testStartClientErrorReadDatafeedAndClientErrorCreateDatafeed() throws ApiEx
verify(datafeedApi, times(1)).readDatafeed(DATAFEED_ID, TOKEN, TOKEN, ackId);
verify(datafeedApi, times(1)).readDatafeed("recreate-df-id", TOKEN, TOKEN, ackId);
verify(datafeedApi, times(1)).deleteDatafeed(DATAFEED_ID, TOKEN, TOKEN);
verify(datafeedApi, times(2)).createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody());
verify(datafeedApi, times(2)).createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody().includeInvisible(true));
}

@Test
Expand Down Expand Up @@ -613,7 +613,7 @@ void testStartClientErrorDeleteDatafeed() throws ApiException, AuthUnauthorizedE
AckId ackId = new AckId().ackId(datafeedService.getAckId());
when(datafeedApi.listDatafeed(TOKEN, TOKEN, null)).thenReturn(
Collections.singletonList(new V5Datafeed().id(DATAFEED_ID)));
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody())).thenReturn(
when(datafeedApi.createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody().includeInvisible(true))).thenReturn(
new V5Datafeed().id("recreate-df-id"));
when(datafeedApi.readDatafeed(DATAFEED_ID, TOKEN, TOKEN, ackId)).thenThrow(new ApiException(400, "client-error"));
when(datafeedApi.readDatafeed("recreate-df-id", TOKEN, TOKEN, ackId))
Expand All @@ -626,7 +626,7 @@ void testStartClientErrorDeleteDatafeed() throws ApiException, AuthUnauthorizedE
verify(datafeedApi, times(1)).listDatafeed(TOKEN, TOKEN, null);
verify(datafeedApi, times(1)).readDatafeed(DATAFEED_ID, TOKEN, TOKEN, ackId);
verify(datafeedApi, times(1)).readDatafeed("recreate-df-id", TOKEN, TOKEN, ackId);
verify(datafeedApi, times(1)).createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody());
verify(datafeedApi, times(1)).createDatafeed(TOKEN, TOKEN, new V5DatafeedCreateBody().includeInvisible(true));
verify(datafeedApi, times(1)).deleteDatafeed(DATAFEED_ID, TOKEN, TOKEN);
}

Expand Down
1 change: 1 addition & 0 deletions symphony-bdk-core/src/test/resources/config/config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ app:
path: /Users/local/conf/agent/privatekey.pem

datafeed:
includeInvisible: true
retry:
maxAttempts: 2

Loading