Skip to content

Commit be9c7eb

Browse files
Brutus5000Brutus5000
authored
Add force relay option to ice adapter based on ice session (#3392)
1 parent f242ab4 commit be9c7eb

File tree

8 files changed

+103
-59
lines changed

8 files changed

+103
-59
lines changed

‎src/main/java/com/faforever/client/api/IceSession.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,7 @@
55

66
import java.util.List;
77

8-
public record IceSession(@NotNull String id, @NotNull List<CoturnServer> servers) {
8+
public record IceSession(
9+
@NotNull String id, boolean forceRelay, @NotNull List<CoturnServer> servers
10+
) {
911
}

‎src/main/java/com/faforever/client/fa/relay/ice/CoturnService.java‎

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,12 @@
1010
import org.springframework.context.annotation.Lazy;
1111
import org.springframework.stereotype.Service;
1212
import reactor.core.publisher.Flux;
13+
import reactor.core.publisher.Mono;
1314

15+
import java.util.List;
1416
import java.util.Set;
1517

18+
1619
@Lazy
1720
@RequiredArgsConstructor
1821
@Service
@@ -23,18 +26,25 @@ public class CoturnService {
2326

2427
public Flux<IceServer> getActiveCoturns() {
2528
return fafApiAccessor.getApiObject("/ice/server", IceServerResponse.class)
26-
.flatMapIterable(IceServerResponse::servers)
29+
.flatMapIterable(IceServerResponse::servers)
2730
.switchIfEmpty(Flux.empty());
2831
}
2932

30-
public Flux<CoturnServer> getSelectedCoturns(int gameId) {
31-
Flux<CoturnServer> coturnServerFlux = fafApiAccessor.getApiObject("/ice/session/game/" + gameId, IceSession.class)
32-
.flatMapIterable(IceSession::servers);
33-
34-
Set<String> preferredCoturnIds = forgedAlliancePrefs.getPreferredCoturnIds();
35-
36-
return coturnServerFlux.filter(coturnServer -> preferredCoturnIds.contains(coturnServer.getId()))
37-
.switchIfEmpty(coturnServerFlux)
38-
.switchIfEmpty(Flux.empty());
33+
public Mono<IceSession> getIceSession(int gameId) {
34+
Set<String> preferredCoturns = forgedAlliancePrefs.getPreferredCoturnIds();
35+
return fafApiAccessor.getApiObject("/ice/session/game/" + gameId, IceSession.class).map(session -> {
36+
List<CoturnServer> preferredServers = session.servers()
37+
.stream()
38+
.filter(
39+
coturnServer -> preferredCoturns.contains(coturnServer.getId()))
40+
.toList();
41+
42+
if (preferredServers.isEmpty()) {
43+
return session;
44+
} else {
45+
return new IceSession(session.id(), session.forceRelay(), preferredServers);
46+
}
47+
});
3948
}
49+
4050
}

‎src/main/java/com/faforever/client/fa/relay/ice/IceAdapter.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public interface IceAdapter {
1515

1616
void onGpgGameMessage(GpgGameOutboundMessage message);
1717

18-
CompletableFuture<Integer> start(int gameId);
18+
CompletableFuture<Integer> start(int gameId, boolean forceRelay);
1919

2020
void stop();
2121

‎src/main/java/com/faforever/client/fa/relay/ice/IceAdapterImpl.java‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ public void onGpgGameMessage(GpgGameOutboundMessage message) {
131131
}
132132

133133
@Override
134-
public CompletableFuture<Integer> start(int gameId) {
134+
public CompletableFuture<Integer> start(int gameId, boolean forceRelay) {
135135
return CompletableFuture.supplyAsync(() -> {
136136
Path workDirectory = Path.of(System.getProperty("nativeDir", "lib")).toAbsolutePath();
137137

@@ -145,7 +145,7 @@ public CompletableFuture<Integer> start(int gameId) {
145145
throw new CompletionException("Unable to find open port for ICE and GPG", exception);
146146
}
147147

148-
List<String> cmd = buildCommand(workDirectory, adapterPort, gpgPort, gameId);
148+
List<String> cmd = buildCommand(workDirectory, adapterPort, gpgPort, gameId, forceRelay);
149149
try {
150150
startIceAdapterProcess(workDirectory, cmd);
151151
} catch (IOException e) {
@@ -215,7 +215,7 @@ void initializeIceAdapterConnection(int adapterPort) {
215215
}
216216

217217
@VisibleForTesting
218-
List<String> buildCommand(Path workDirectory, int adapterPort, int gpgPort, int gameId) {
218+
List<String> buildCommand(Path workDirectory, int adapterPort, int gpgPort, int gameId, boolean forceRelay) {
219219
PlayerInfo currentPlayer = playerService.getCurrentPlayer();
220220

221221
String classpath = getBinaryName(workDirectory) + JavaUtil.CLASSPATH_SEPARATOR + getJavaFXClassPathJars();
@@ -241,6 +241,11 @@ List<String> buildCommand(Path workDirectory, int adapterPort, int gpgPort, int
241241

242242
cmd.addAll(standardIceOptions);
243243

244+
if (forceRelay) {
245+
cmd.add("--force-relay");
246+
log.debug("Forcing ice adapter relay connection");
247+
}
248+
244249
if (forgedAlliancePrefs.isShowIceAdapterDebugWindow()) {
245250
cmd.add("--debug-window");
246251
cmd.add("--info-window");

‎src/main/java/com/faforever/client/game/GameRunner.java‎

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -213,8 +213,8 @@ CompletableFuture<Void> startOnlineGame(GameLaunchResponse gameLaunchResponse) {
213213

214214
@VisibleForTesting
215215
CompletableFuture<Void> prepareAndLaunchGameWhenReady(String featuredModName, Set<String> simModUids,
216-
@Nullable String mapFolderName,
217-
Supplier<CompletableFuture<GameLaunchResponse>> gameLaunchSupplier) {
216+
@Nullable String mapFolderName,
217+
Supplier<CompletableFuture<GameLaunchResponse>> gameLaunchSupplier) {
218218
CompletableFuture<Void> updateFeaturedModFuture = featuredModService.updateFeaturedModToLatest(featuredModName,
219219
false);
220220

@@ -391,12 +391,12 @@ private Process launchOnlineGame(GameParameters gameParameters, Integer gpgPort,
391391
}
392392

393393
private CompletableFuture<Integer> startIceAdapter(int uid) {
394-
return iceAdapter.start(uid)
395-
.thenCompose(icePort -> coturnService.getSelectedCoturns(uid)
396-
.collectList()
397-
.doOnNext(iceAdapter::setIceServers)
398-
.thenReturn(icePort)
399-
.toFuture());
394+
return coturnService.getIceSession(uid)
395+
.toFuture()
396+
.thenCompose(session -> iceAdapter.start(uid, session.forceRelay()).thenApply(result -> {
397+
iceAdapter.setIceServers(session.servers());
398+
return result;
399+
}));
400400
}
401401

402402
private Mono<League> getDivisionInfo(String leaderboard) {
@@ -417,17 +417,16 @@ private void handleTermination(Process finishedProcess) {
417417
int exitCode = finishedProcess.exitValue();
418418
log.info("Forged Alliance terminated with exit code {}", exitCode);
419419
Optional<Path> logFilePath = loggingService.getMostRecentGameLogFile();
420-
Optional<String> logFileContent = logFilePath
421-
.map(file -> {
422-
try {
423-
final String logFileText = logMasker.maskMessage(Files.readString(file));
424-
Files.writeString(file, logFileText);
425-
return logFileText;
426-
} catch (IOException e) {
427-
log.warn("Could not open log file", e);
428-
return null;
429-
}
430-
});
420+
Optional<String> logFileContent = logFilePath.map(file -> {
421+
try {
422+
final String logFileText = logMasker.maskMessage(Files.readString(file));
423+
Files.writeString(file, logFileText);
424+
return logFileText;
425+
} catch (IOException e) {
426+
log.warn("Could not open log file", e);
427+
return null;
428+
}
429+
});
431430

432431
if (!gameKilled) {
433432
if (exitCode != 0) {
@@ -455,13 +454,11 @@ private void alertOnBadExit(int exitCode, Optional<Path> logFilePath, Optional<S
455454
} else {
456455
notificationService.addNotification(new ImmediateNotification(i18n.get("errorTitle"),
457456
i18n.get("game.crash", exitCode,
458-
logFilePath.map(Path::toString).orElse("")),
459-
WARN, List.of(new Action(i18n.get("game.open.log"),
460-
() -> platformService.reveal(
461-
logFilePath.orElse(
462-
operatingSystem.getLoggingDirectory()))),
463-
new DismissAction(i18n)),
464-
getAnalysisButtonIfNecessary(logFileContent).orElse(null)));
457+
logFilePath.map(Path::toString)
458+
.orElse("")), WARN, List.of(
459+
new Action(i18n.get("game.open.log"),
460+
() -> platformService.reveal(logFilePath.orElse(operatingSystem.getLoggingDirectory()))),
461+
new DismissAction(i18n)), getAnalysisButtonIfNecessary(logFileContent).orElse(null)));
465462
}
466463
}
467464

‎src/test/java/com/faforever/client/fa/relay/ice/CoturnServiceTest.java‎

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919

2020
import java.util.List;
2121

22+
import static org.hamcrest.MatcherAssert.assertThat;
23+
import static org.hamcrest.Matchers.contains;
2224
import static org.mockito.ArgumentMatchers.any;
2325
import static org.mockito.ArgumentMatchers.endsWith;
2426
import static org.mockito.ArgumentMatchers.eq;
@@ -50,40 +52,49 @@ public void testGetActiveCoturns() {
5052
}
5153

5254
@Test
53-
public void TestGetSelectedCoturnsNoActiveSelected() {
55+
public void TestGetIceSessionNoActiveSelected() {
5456
forgedAlliancePrefs.getPreferredCoturnIds().add("1");
5557

5658
CoturnServer otherServer = new CoturnServer();
5759
otherServer.setId("0");
58-
when(fafApiAccessor.getApiObject(any(), any())).thenReturn(Mono.just(new IceSession("someSessionId", List.of(otherServer))));
60+
when(fafApiAccessor.getApiObject(any(), any())).thenReturn(
61+
Mono.just(new IceSession("someSessionId", false, List.of(otherServer))));
5962

60-
StepVerifier.create(instance.getSelectedCoturns(123)).expectNext(otherServer).verifyComplete();
63+
StepVerifier.create(instance.getIceSession(123))
64+
.assertNext(session -> assertThat(session.servers(), contains(otherServer)))
65+
.verifyComplete();
6166

6267
verify(fafApiAccessor).getApiObject(endsWith("123"), eq(IceSession.class));
6368
}
6469

6570
@Test
66-
public void testGetSelectedCoturnsNoneSelected() {
71+
public void testGetIceSessionNonePreferredSelected() {
6772
CoturnServer otherServer = new CoturnServer();
6873
otherServer.setId("0");
69-
when(fafApiAccessor.getApiObject(any(), any())).thenReturn(Mono.just(new IceSession("someSessionId", List.of(otherServer))));
74+
when(fafApiAccessor.getApiObject(any(), any())).thenReturn(
75+
Mono.just(new IceSession("someSessionId", false, List.of(otherServer))));
7076

71-
StepVerifier.create(instance.getSelectedCoturns(123)).expectNext(otherServer).verifyComplete();
77+
StepVerifier.create(instance.getIceSession(123))
78+
.assertNext(session -> assertThat(session.servers(), contains(otherServer)))
79+
.verifyComplete();
7280

7381
verify(fafApiAccessor).getApiObject(endsWith("123"), eq(IceSession.class));
7482
}
7583

7684
@Test
77-
public void testGetSelectedCoturnsActiveSelected() {
85+
public void testGetIceSessionActiveSelected() {
7886
forgedAlliancePrefs.getPreferredCoturnIds().add("1");
7987

8088
CoturnServer otherServer = new CoturnServer();
8189
otherServer.setId("0");
8290
CoturnServer selectedServer = new CoturnServer();
8391
selectedServer.setId("1");
84-
when(fafApiAccessor.getApiObject(any(), any())).thenReturn(Mono.just(new IceSession("someSessionId", List.of(otherServer, selectedServer))));
92+
when(fafApiAccessor.getApiObject(any(), any())).thenReturn(
93+
Mono.just(new IceSession("someSessionId", false, List.of(otherServer, selectedServer))));
8594

86-
StepVerifier.create(instance.getSelectedCoturns(123)).expectNext(selectedServer).verifyComplete();
95+
StepVerifier.create(instance.getIceSession(123))
96+
.assertNext(session -> assertThat(session.servers(), contains(selectedServer)))
97+
.verifyComplete();
8798

8899
verify(fafApiAccessor).getApiObject(endsWith("123"), eq(IceSession.class));
89100
}

‎src/test/java/com/faforever/client/fa/relay/ice/IceAdapterImplTest.java‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ public void testBuildCommand() throws Exception {
120120
when(tokenRetriever.getRefreshedTokenValue()).thenReturn(Mono.just("someToken"));
121121
forgedAlliancePrefs.setShowIceAdapterDebugWindow(true);
122122

123-
List<String> command = instance.buildCommand(Path.of("."), 0, 0, 4711);
123+
List<String> command = instance.buildCommand(Path.of("."), 0, 0, 4711, false);
124124

125125
assertEquals(javaExecutablePath.toAbsolutePath().toString(), command.getFirst());
126126
assertEquals("-Dorg.ice4j.ipv6.DISABLED=true", command.get(1));
@@ -159,11 +159,27 @@ public void testAllowIpv6() throws Exception {
159159
when(playerService.getCurrentPlayer()).thenReturn(currentPlayer);
160160
when(tokenRetriever.getRefreshedTokenValue()).thenReturn(Mono.just("someToken"));
161161

162-
List<String> command = instance.buildCommand(Path.of("."), 0, 0, 4711);
162+
List<String> command = instance.buildCommand(Path.of("."), 0, 0, 4711, false);
163163

164164
assertFalse(command.contains("-Dorg.ice4j.ipv6.DISABLED=true"));
165165
}
166166

167+
@Test
168+
public void testForceRelay() throws Exception {
169+
Path javaExecutablePath = Path.of("some", "path", "java");
170+
171+
clientProperties.getApi().setBaseUrl("http://faf-api");
172+
173+
when(operatingSystem.getJavaExecutablePath()).thenReturn(javaExecutablePath);
174+
PlayerInfo currentPlayer = PlayerInfoBuilder.create().defaultValues().get();
175+
when(playerService.getCurrentPlayer()).thenReturn(currentPlayer);
176+
when(tokenRetriever.getRefreshedTokenValue()).thenReturn(Mono.just("someToken"));
177+
178+
List<String> command = instance.buildCommand(Path.of("."), 0, 0, 4711, true);
179+
180+
assertTrue(command.contains("--force-relay"));
181+
}
182+
167183
@Test
168184
public void testStop() throws Exception {
169185
instance.stop();

‎src/test/java/com/faforever/client/game/GameRunnerTest.java‎

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package com.faforever.client.game;
22

3+
import com.faforever.client.api.IceSession;
34
import com.faforever.client.builders.GameInfoBuilder;
45
import com.faforever.client.builders.GameLaunchMessageBuilder;
56
import com.faforever.client.builders.NewGameInfoBuilder;
@@ -53,11 +54,11 @@
5354
import org.mockito.InjectMocks;
5455
import org.mockito.Mock;
5556
import org.mockito.Spy;
56-
import reactor.core.publisher.Flux;
5757
import reactor.core.publisher.Mono;
5858
import reactor.test.publisher.TestPublisher;
5959

6060
import java.io.IOException;
61+
import java.util.List;
6162
import java.util.Set;
6263
import java.util.concurrent.CompletableFuture;
6364
import java.util.concurrent.ExecutorService;
@@ -160,11 +161,12 @@ public void setUp() throws Exception {
160161
return null;
161162
}).when(fxApplicationThreadExecutor).execute(any());
162163
lenient().when(fafServerAccessor.getEvents(NoticeInfo.class)).thenReturn(testNoticePublisher.flux());
163-
lenient().when(coturnService.getSelectedCoturns(anyInt())).thenReturn(Flux.empty());
164+
lenient().when(coturnService.getIceSession(anyInt()))
165+
.thenReturn(Mono.just(new IceSession("someSessionId", false, List.of())));
164166
lenient().when(preferencesService.hasValidGamePath()).thenReturn(true);
165167
lenient().when(fafServerAccessor.connectionStateProperty()).thenReturn(new SimpleObjectProperty<>());
166168
lenient().when(replayServer.start(anyInt())).thenReturn(completedFuture(LOCAL_REPLAY_PORT));
167-
lenient().when(iceAdapter.start(anyInt())).thenReturn(completedFuture(GPG_PORT));
169+
lenient().when(iceAdapter.start(anyInt(), anyBoolean())).thenReturn(completedFuture(GPG_PORT));
168170
lenient().when(playerService.getCurrentPlayer()).thenReturn(junitPlayer);
169171
lenient().when(process.pid()).thenReturn(10L);
170172

@@ -189,8 +191,9 @@ private void mockStartGameProcess(GameLaunchResponse gameLaunchResponse) throws
189191
}
190192
lenient().when(forgedAllianceLaunchService.launchOnlineGame(any(), anyInt(), anyInt())).thenReturn(process);
191193
lenient().when(replayServer.start(anyInt())).thenReturn(completedFuture(LOCAL_REPLAY_PORT));
192-
lenient().when(iceAdapter.start(anyInt())).thenReturn(completedFuture(GPG_PORT));
193-
lenient().when(coturnService.getSelectedCoturns(anyInt())).thenReturn(Flux.empty());
194+
lenient().when(iceAdapter.start(anyInt(), anyBoolean())).thenReturn(completedFuture(GPG_PORT));
195+
lenient().when(coturnService.getIceSession(anyInt()))
196+
.thenReturn(Mono.just(new IceSession("someSessionId", false, List.of())));
194197
lenient().when(process.onExit()).thenReturn(new CompletableFuture<>());
195198
lenient().when(process.exitValue()).thenReturn(0);
196199
lenient().when(process.isAlive()).thenReturn(true);
@@ -219,8 +222,8 @@ public void testStartOnlineGlobalGame() throws Exception {
219222
verify(leaderboardService, never()).getActiveLeagueEntryForPlayer(any(), any());
220223
verify(mapService, never()).downloadIfNecessary(any());
221224
verify(replayServer).start(uid);
222-
verify(iceAdapter).start(uid);
223-
verify(coturnService).getSelectedCoturns(uid);
225+
verify(iceAdapter).start(uid, false);
226+
verify(coturnService).getIceSession(uid);
224227
verify(iceAdapter).setIceServers(anyCollection());
225228
assertTrue(instance.isRunning());
226229
assertEquals(uid, instance.getRunningGame().getId());

0 commit comments

Comments
 (0)