Skip to content

test(user): look up bans by user_id filter to avoid pagination flake #259

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
nijeesh-stream wants to merge 1 commit into
base: main
Choose a base branch
from
+79 −24
Open

test(user): look up bans by user_id filter to avoid pagination flake #259

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
103 changes: 79 additions & 24 deletions src/test/java/io/getstream/chat/java/UserTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,17 @@ public class UserTest extends BasicTest {
/**
* Clear zombie bans left over from prior CI runs that died before their cleanup could fire.
* {@code User.queryBanned().request()} returns a paginated slice; once enough bans accumulate on
* the shared test app, the just-created ban under test ends up past the first page and the {@code
* assertTrue(bans.stream().anyMatch(...))} assertion fails. Best-effort sweep.
* the shared test app, every page reads back the same zombies and the {@link #findBanFor} lookup
* still has to wade through them. Best-effort sweep: regular, shadow, and channel-scoped bans are
* each unbanned with the right qualifiers so the queue actually drains.
*/
@BeforeAll
static void cleanupLeftoverBans() {
// queryBanned() returns a paginated slice, so a single pass only clears
// the first page. Loop until either the response is empty or we stop
// making progress; cap iterations to avoid running forever against a
// poisoned app.
Set<String> seen = new HashSet<>();
for (int round = 0; round < 20; round++) {
// The same (userId, shadow, channelCid) triple is only attempted once across
// rounds; we keep looping as long as we're still removing something so the
// shared CI app eventually drains regardless of how it was poisoned.
Set<String> tried = new HashSet<>();
for (int round = 0; round < 50; round++) {
List<Ban> bans;
try {
bans = User.queryBanned().request().getBans();
Expand All @@ -55,9 +55,15 @@ static void cleanupLeftoverBans() {
for (var ban : bans) {
if (ban.getUser() == null || ban.getUser().getId() == null) continue;
String id = ban.getUser().getId();
if (!seen.add(id)) continue;
boolean shadow = Boolean.TRUE.equals(ban.getShadow());
Channel channel = ban.getChannel();
String key = id + "|" + shadow + "|" + (channel == null ? "" : channel.getCId());
if (!tried.add(key)) continue;
try {
User.unban(id).request();
var req = User.unban(id);
if (shadow) req.shadow(true);
if (channel != null) req.type(channel.getType()).id(channel.getId());
req.request();
unbannedThisRound++;
} catch (StreamException ignored) {
// In-use or already-deleted; skip.
Expand All @@ -67,6 +73,44 @@ static void cleanupLeftoverBans() {
}
}

/**
* Look up the current ban for a specific user via {@code query_banned_users} filtered by {@code
* user_id}. Returns an empty {@link Optional} when the user has no recorded ban.
*
* <p>Used by the moderation tests so their assertions do not depend on which slice of the global
* ban list happens to come back on the first page of the shared CI app.
*/
private static Optional<Ban> findBanFor(String userId) {
try {
return User.queryBanned()
.filterCondition("user_id", Map.of("$eq", userId))
.request()
.getBans()
.stream()
.filter(ban -> ban.getUser() != null && userId.equals(ban.getUser().getId()))
.findFirst();
} catch (StreamException e) {
return Optional.empty();
}
}

/**
* Remove any app-wide ban for {@code userId}, regular or shadow. Errors are swallowed so callers
* can use this from a {@code finally} block without masking a real test failure.
*/
private static void bestEffortUnban(String userId) {
try {
User.unban(userId).request();
} catch (StreamException ignored) {
// Best-effort cleanup; ignore.
}
try {
User.unban(userId).shadow(true).request();
} catch (StreamException ignored) {
// Best-effort cleanup; ignore.
}
}

@DisplayName("Can list users with no Exception")
@Test
void whenListingUsers_thenNoException() {
Expand Down Expand Up @@ -225,8 +269,11 @@ void whenBanUser_thenIsBanned() {
Assertions.assertDoesNotThrow(() -> usersUpsertRequest.request());
Assertions.assertDoesNotThrow(
() -> User.ban().userId(testUserRequestObject.getId()).targetUserId(userId).request());
List<Ban> bans = Assertions.assertDoesNotThrow(() -> User.queryBanned().request()).getBans();
Assertions.assertTrue(bans.stream().anyMatch(ban -> ban.getUser().getId().equals(userId)));
try {
Assertions.assertTrue(findBanFor(userId).isPresent(), "Expected ban for user " + userId);
} finally {
bestEffortUnban(userId);
}
}

@DisplayName("Can ban user with delete reactions")
Expand All @@ -244,8 +291,11 @@ void whenBanUserWithDeleteReactions_thenIsBanned() {
.targetUserId(userId)
.deleteReactions(true)
.request());
List<Ban> bans = Assertions.assertDoesNotThrow(() -> User.queryBanned().request()).getBans();
Assertions.assertTrue(bans.stream().anyMatch(ban -> ban.getUser().getId().equals(userId)));
try {
Assertions.assertTrue(findBanFor(userId).isPresent(), "Expected ban for user " + userId);
} finally {
bestEffortUnban(userId);
}
}

@DisplayName("Can shadow ban user")
Expand All @@ -259,10 +309,14 @@ void whenShadowBanUser_thenIsShadowBanned() {
Assertions.assertDoesNotThrow(
() ->
User.shadowBan().userId(testUserRequestObject.getId()).targetUserId(userId).request());
List<Ban> bans = Assertions.assertDoesNotThrow(() -> User.queryBanned().request()).getBans();
var banned =
bans.stream().filter(ban -> ban.getUser().getId().equals(userId)).findFirst().get();
Assertions.assertTrue(banned.getShadow());
try {
var banned =
findBanFor(userId)
.orElseThrow(() -> new AssertionError("Expected shadow ban for user " + userId));
Assertions.assertTrue(banned.getShadow(), "Expected ban to be a shadow ban");
} finally {
bestEffortUnban(userId);
}
}

@DisplayName("Can list banned user")
Expand All @@ -274,8 +328,11 @@ void whenListingBannedUsers_thenContainsBanned() {
Assertions.assertDoesNotThrow(() -> usersUpsertRequest.request());
Assertions.assertDoesNotThrow(
() -> User.ban().userId(testUserRequestObject.getId()).targetUserId(userId).request());
List<Ban> bans = Assertions.assertDoesNotThrow(() -> User.queryBanned().request()).getBans();
Assertions.assertTrue(bans.stream().anyMatch(ban -> ban.getUser().getId().equals(userId)));
try {
Assertions.assertTrue(findBanFor(userId).isPresent(), "Expected ban for user " + userId);
} finally {
bestEffortUnban(userId);
}
}

@DisplayName("Can deactivate user")
Expand Down Expand Up @@ -469,11 +526,9 @@ void whenUnbanUser_thenIsNotBannedAnymore() {
Assertions.assertDoesNotThrow(() -> usersUpsertRequest.request());
Assertions.assertDoesNotThrow(
() -> User.ban().userId(testUserRequestObject.getId()).targetUserId(userId).request());
List<Ban> bans = Assertions.assertDoesNotThrow(() -> User.queryBanned().request()).getBans();
Assertions.assertTrue(bans.stream().anyMatch(ban -> ban.getUser().getId().equals(userId)));
Assertions.assertTrue(findBanFor(userId).isPresent(), "Expected ban for user " + userId);
Assertions.assertDoesNotThrow(() -> User.unban(userId).request());
bans = Assertions.assertDoesNotThrow(() -> User.queryBanned().request()).getBans();
Assertions.assertFalse(bans.stream().anyMatch(ban -> ban.getUser().getId().equals(userId)));
Assertions.assertTrue(findBanFor(userId).isEmpty(), "Expected ban to be cleared for " + userId);
}

@DisplayName("Can remove a shadow ban")
Expand Down
Loading