Remove pre-deploy legacy webhook compatibility paths by Copilot · Pull Request #5166 · AsyncTI4/TI4_map_generator_bot

Copilot · 2026-05-31T03:53:52Z

This branch introduced webhook functionality with temporary legacy compatibility, but the branch has not been deployed yet. This PR removes those compatibility paths so the feature ships with a single, clean subscription-based model.

Legacy path removal
- Removed game-stored webhook config flow (/game webhook) and deleted GameWebhook + GameWebhookConfig.
- Removed legacy dispatch branch from WebhookGameEventNotifier (dispatchLegacyWebhook), leaving subscription dispatch as the only delivery path.
Subscription-only delivery model
- Kept notifier dispatch wired exclusively through GameWebhookSubscriptionService#getCallbackUrls(...).
- Moved URL validation responsibility into WebhookDispatchService so dispatch remains self-contained after config deletion.
Behavior/documentation alignment
- Updated webhook notifier tests to assert subscription-driven dispatch (and removed legacy-config gating expectations).
- Updated integration docs to describe API-managed webhook subscriptions instead of /game webhook command configuration.

// before
dispatchLegacyWebhook(game, payload);
dispatchWebhookSubscriptions(game, eventType, payload);

// after
dispatchWebhookSubscriptions(game, eventType, payload);

Co-authored-by: jamesrudolph <39609802+jamesrudolph@users.noreply.github.com>

Copilot

Pull request overview

Adds a per-game outbound webhook feature so external systems can subscribe to a fixed set of TI4 game-state transitions (active player change, phase change, agenda voting started/resolved, player passed, game ended). Configuration is persisted in the per-game stored-values map via a new /game webhook slash subcommand, and a Spring service dispatches JSON payloads asynchronously with timeouts and a small retry.

Changes:

New ti4.service.webhook package: event-type enum, payload record, config helper, notifier interface + Spring impl + static facade, async dispatch service.
Wired emission into core game-flow choke points (Game.updateActivePlayer, StartPhaseService phase transitions, AgendaHelper.startTheVoting/resolveTime, PassService.passPlayerForRound, EndGameService.gameEndStuff).
Added /game webhook slash subcommand, integrator docs in WEBSITE_INTEGRATION.md, and unit tests for WebhookGameEventNotifier.

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
WEBSITE_INTEGRATION.md	Documents webhook setup, event types, payload schema, delivery semantics.
src/main/java/ti4/service/webhook/GameEventNotifier.java	Notifier interface for the six game events.
src/main/java/ti4/service/webhook/GameEventNotifierFacade.java	Static facade resolving the notifier bean from Spring with a silent no-op fallback.
src/main/java/ti4/service/webhook/WebhookGameEventNotifier.java	Spring impl that builds payloads, gates on config (enabled/FoW), and dispatches.
src/main/java/ti4/service/webhook/WebhookDispatchService.java	Async HTTP POST with timeout + simple retry/backoff using `EgressClientManager`.
src/main/java/ti4/service/webhook/GameWebhookEventPayload.java	Record describing the JSON payload schema.
src/main/java/ti4/service/webhook/GameWebhookEventType.java	Enum of supported event-type identifiers.
src/main/java/ti4/service/webhook/GameWebhookConfig.java	Stored-value helpers for URL/enabled/FoW-allowed and basic URL validation.
src/main/java/ti4/discord/interactions/commands/game/GameWebhook.java	New `/game webhook` slash subcommand for set/inspect/clear/toggle.
src/main/java/ti4/discord/interactions/commands/game/GameCommand.java	Registers the new `GameWebhook` subcommand.
src/main/java/ti4/game/Game.java	Emits `active_player_changed` from `updateActivePlayer`.
src/main/java/ti4/service/game/StartPhaseService.java	Emits `phase_changed` for strategy/action/statusHomework/agenda transitions.
src/main/java/ti4/service/game/EndGameService.java	Emits `game_ended` in `gameEndStuff`.
src/main/java/ti4/helpers/AgendaHelper.java	Emits `agenda_voting_started`/`agenda_resolved` from voting flow.
src/main/java/ti4/service/turn/PassService.java	Emits `player_passed` when a player passes.
src/test/java/ti4/service/webhook/WebhookGameEventNotifierTest.java	Tests notifier gating, payload building, and exception containment.

+    public static boolean isWebhookUrlValid(String webhookUrl) {
+        try {
+            URI uri = URI.create(webhookUrl);
+            String scheme = uri.getScheme();
+            return uri.getHost() != null && ("http".equalsIgnoreCase(scheme) || "https".equalsIgnoreCase(scheme));
+        } catch (RuntimeException e) {
+            return false;
+        }
+    }


+        String urlDisplay = GameWebhookConfig.getWebhookUrl(game).orElse("<not set>");
+        String response = "Webhook config for `" + game.getName() + "`"
+                + (updated ? " updated.\n" : ":\n")
+                + "- URL: " + urlDisplay + "\n"
+                + "- Enabled: " + GameWebhookConfig.isWebhookEnabled(game) + "\n"
+                + "- Allow FoW: " + GameWebhookConfig.isFowAllowed(game);
+        MessageHelper.sendMessageToEventChannel(event, response);


+                HttpRequest request = HttpRequest.newBuilder()
+                        .uri(URI.create(webhookUrl))
+                        .timeout(REQUEST_TIMEOUT)
+                        .header("Content-Type", "application/json")
+                        .POST(HttpRequest.BodyPublishers.ofString(jsonMapper.writeValueAsString(payload)))
+                        .build();


+    public static boolean isWebhookEnabled(Game game) {
+        String enabled = game.getStoredValue(WEBHOOK_ENABLED_KEY);
+        return enabled.isEmpty() || Boolean.parseBoolean(enabled);
+    }


+    public void dispatch(Game game, String webhookUrl, GameWebhookEventPayload payload) {
+        ExecutorServiceManager.runAsync(
+                "webhook_dispatch_" + game.getName(), () -> sendWithRetry(game, webhookUrl, payload));
+    }


+                BotLogger.warning(
+                        new LogOrigin(game),
+                        "Webhook dispatch returned status "
+                                + response.statusCode()
+                                + " on attempt "
+                                + attempt
+                                + ". Response: "
+                                + response.body());


+public class WebhookDispatchService {
+    private static final Duration REQUEST_TIMEOUT = Duration.ofSeconds(5);
+    private static final int MAX_ATTEMPTS = 2;
+    private static final long RETRY_DELAY_MILLIS = 500L;
+
+    private final JsonMapper jsonMapper = JsonMapperManager.basic();
+
+    public void dispatch(Game game, String webhookUrl, GameWebhookEventPayload payload) {
+        ExecutorServiceManager.runAsync(
+                "webhook_dispatch_" + game.getName(), () -> sendWithRetry(game, webhookUrl, payload));
+    }


        game.setPhaseOfGame("agendaVoting");
+        GameEventNotifierFacade.notifyAgendaVotingStarted(game);


+    private static GameEventNotifier notifier() {
+        try {
+            return SpringContext.getBean(GameEventNotifier.class);
+        } catch (RuntimeException e) {
+            return NO_OP_NOTIFIER;
+        }
+    }


+    public GameWebhook() {
+        super("webhook", "Set or inspect game webhook notifications", true, false);
+        addOptions(new OptionData(OptionType.STRING, OPTION_URL, "Webhook URL to send game event notifications to"));
+        addOptions(new OptionData(OptionType.BOOLEAN, OPTION_ENABLED, "Enable or disable webhook notifications"));
+        addOptions(new OptionData(
+                OptionType.BOOLEAN, OPTION_ALLOW_FOW, "Allow notifications for FoW games (default false for privacy)"));
+        addOptions(new OptionData(OptionType.BOOLEAN, OPTION_CLEAR, "Clear all webhook configuration"));
+    }


github-actions · 2026-05-31T04:00:46Z

🔬 Test Results

✅ JSON Validation Passed

All changed JSON files are valid.

✅ Formatting Checks Passed

All files pass Spotless formatting.

✅ JUnit Tests Passed

All tests passed successfully.

Co-authored-by: jamesrudolph <39609802+jamesrudolph@users.noreply.github.com>

Copilot AI and others added 2 commits May 31, 2026 02:30

Add webhook event pipeline and config command

7972685

Co-authored-by: jamesrudolph <39609802+jamesrudolph@users.noreply.github.com>

Apply formatting and complete webhook validation

c5d7d54

Co-authored-by: jamesrudolph <39609802+jamesrudolph@users.noreply.github.com>

Copilot AI assigned Copilot and jamesrudolph May 31, 2026

Copilot created this pull request from a session on behalf of jamesrudolph May 31, 2026 03:53 View session

jamesrudolph marked this pull request as ready for review May 31, 2026 03:54

jamesrudolph requested a review from Copilot May 31, 2026 03:55

Copilot started reviewing on behalf of jamesrudolph May 31, 2026 03:55 View session

Copilot AI reviewed May 31, 2026

View reviewed changes

Copilot started work on behalf of jamesrudolph May 31, 2026 13:08 View session

Copilot AI and others added 3 commits May 31, 2026 13:14

Plan webhook subscription API changes

2fa8e22

Co-authored-by: jamesrudolph <39609802+jamesrudolph@users.noreply.github.com>

Add public webhook subscription API and persistence

4b7d426

Co-authored-by: jamesrudolph <39609802+jamesrudolph@users.noreply.github.com>

Polish webhook subscription dispatch wiring

95996f1

Co-authored-by: jamesrudolph <39609802+jamesrudolph@users.noreply.github.com>

Copilot AI changed the title ~~Add per-game webhook event notifications for core TI4 game-state transitions~~ Add API-keyed public webhook subscriptions per game with event-type filtering May 31, 2026

Copilot finished work on behalf of jamesrudolph May 31, 2026 13:18

Copilot AI requested a review from jamesrudolph May 31, 2026 13:18

Merge branch 'master' into copilot/add-turn-phase-webhook-feature

59a064d

jamesrudolph requested a review from wholton May 31, 2026 13:21

Copilot started work on behalf of jamesrudolph May 31, 2026 13:47 View session

Copilot AI and others added 4 commits May 31, 2026 13:54

Plan legacy webhook handling removal

ef4e6de

Co-authored-by: jamesrudolph <39609802+jamesrudolph@users.noreply.github.com>

Remove legacy webhook delivery path

9516e6b

Co-authored-by: jamesrudolph <39609802+jamesrudolph@users.noreply.github.com>

Fix webhook notifier tests after legacy removal

8dcd09a

Co-authored-by: jamesrudolph <39609802+jamesrudolph@users.noreply.github.com>

Revert accidental AutoPing fixture timestamp change

55a8f74

Co-authored-by: jamesrudolph <39609802+jamesrudolph@users.noreply.github.com>

Copilot AI changed the title ~~Add API-keyed public webhook subscriptions per game with event-type filtering~~ Remove pre-deploy legacy webhook compatibility paths May 31, 2026

Copilot finished work on behalf of jamesrudolph May 31, 2026 13:58

Copilot started work on behalf of jamesrudolph May 31, 2026 14:01 View session

Copilot finished work on behalf of jamesrudolph May 31, 2026 14:04

BullX92 mentioned this pull request Jun 11, 2026

Add API-key based game webhooks for turn and phase changes #5222

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Remove pre-deploy legacy webhook compatibility paths - #5166

Remove pre-deploy legacy webhook compatibility paths#5166
jamesrudolph with Copilot wants to merge 10 commits into
masterfrom
copilot/add-turn-phase-webhook-feature

Copilot AI commented May 31, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions Bot commented May 31, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		game.setPhaseOfGame("agendaVoting");
		GameEventNotifierFacade.notifyAgendaVotingStarted(game);

Uh oh!

Conversation

Copilot AI commented May 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

github-actions Bot commented May 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔬 Test Results

✅ JSON Validation Passed

✅ Formatting Checks Passed

✅ JUnit Tests Passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented May 31, 2026 •

edited

Loading

github-actions Bot commented May 31, 2026 •

edited

Loading