refactor/communication-commands #505

Merged

scion merged 24 commits from refactor/communication-commands into master 2026-05-29 16:54:56 -07:00

Conversation 0 Commits 24 Files changed 42 +5226 -858

scion commented 2026-05-27 20:08:03 -07:00

Owner

Copy link

Major refactor of all forms of communication. Brought all the command implementations for communication commands together into a single command driven by configuration that lives in the database and comes with an editor to change it from inside the game. From the perspective of a player it should look and work exactly the same, but now admins can create and edit "channels" on the fly as much as they want with no code changes.

Major refactor of all forms of communication. Brought all the command implementations for communication commands together into a single command driven by configuration that lives in the database and comes with an editor to change it from inside the game. From the perspective of a player it should look and work exactly the same, but now admins can create and edit "channels" on the fly as much as they want with no code changes.

scion added 12 commits 2026-05-27 20:08:04 -07:00

Phase 1: Database schema for configurable communication channels ... 5fd3ec20e1

Add the foundation entities, enums, repository, and seed data loader
for the data-driven communication channel refactor:

- PoolType enum: ROOM, ZONE, WORLD, ALL_ONLINE candidate pools
- FilterType enum: NOT_SENDER, NOT_TARGET, ROLE, CLAN, LEVEL_MIN, LEVEL_MAX
- CommChannel entity: name, description, format strings, pool type,
  direct target type, aliases, and cascaded ChannelFilter list
- ChannelFilter entity: filter type and parameter linked to a channel
- CommChannelRepository: JPA repository with case-insensitive lookup
- CommChannelLoader: seeds the 6 existing channels (SAY, EMOTE, SHOUT,
  GOSSIP, TELL, WHISPER) with identical behavior at startup

Phase 2: Unified CommChannelCommand ... 927f6d8421

Add the single command that replaces all six individual comm commands
(Say, Emote, Shout, Gossip, Tell, Whisper).

- CommChannelCommand: @PostConstruct loads all CommChannel entities
  and dynamically registers a syntax for each. At runtime the first
  binding token determines which channel to dispatch to.

- Local output is formatted using the channel's localFormat string
  with sender/target/message arguments resolved per channel type.

- Remote delivery dispatches via existing CommService methods
  (sendToRoom, sendToZone, sendToAll, sendTo) based on the channel's
  pool type, preserving identical behavior.

- Bystander notifications (e.g. Whisper) are handled when the channel
  has a bystanderFormat configured.

- RepositoryBundle extended with CommChannelRepository so the command
  can look up channel configuration at runtime.

Fix compile errors from Phase 2 ... 17291f608f

- AbstractCommand: change syntaxes field from private to protected so
  CommChannelCommand can clear and re-register syntaxes at runtime

- RepositoryBundleTest: add new CommChannelRepository mock parameter
  to match the updated constructor signature

Prefer a clearSyntaxes() helper over broadening syntaxes visibility ... 91014f7a53

Add a protected clearSyntaxes() method to AbstractCommand so subclasses
can rebuild their syntax list without needing direct access to the
private syntaxes field. Restore syntaxes to private.

old PostConstruct annotation doesn't work in new Spring 09fb2659b3

Phase 3: Add deliverChannel() to CommService ... c7d8cb9036

Introduce the unified delivery method driven by CommChannel config:

- deliverChannel(): single entry point that builds a candidate pool,
  applies all ChannelFilter predicates, and delivers the appropriately
  formatted message to each recipient.

- buildPool(): constructs the initial candidate pool by pool type
  (ROOM, ZONE, WORLD, ALL_ONLINE). Returns only player-controlled
  characters in a valid room.

- filterPool() / filterMatches(): apply each ChannelFilter predicate
  (NOT_SENDER, NOT_TARGET, ROLE are fully implemented; CLAN,
  LEVEL_MIN, LEVEL_MAX return true as pass-through until the model
  supports those fields).

- CommChannelCommand now delegates all remote delivery to
  deliverChannel() instead of calling individual sendToRoom/Zone/All
  methods with a manual switch.

Legacy sendToRoom/Zone/All methods are preserved for existing non-channel
code (ForceCommand, etc.).

Phase 4: Add menu-driven channel configuration UI ... 1a0afde9be

- ChannelConfigCommand: thin wrapper that transitions into the admin menu
- ChannelConfigQuestion: main menu (List/Create/Edit/Delete/View/Exit)
- ChannelConfigTargetQuestion: numbered channel picker for Edit/Delete/View
- ChannelConfigCreateQuestion: step-by-step wizard to create new channels
- ChannelConfigEditQuestion: field edit menu with filter management

Fixes:
- Use arrow-style switch syntax consistently (no mixing colon/break with arrow)
- Use java.lang.Enum.valueOf instead of nonexistent java.util.Enum

Phase 5: Redirect comm command references to commChannelCommand and add CHANNELCONFIG ... 582928473f

- Update SAY, TELL, WHISPER, SHOUT, GOSSIP, and EMOTE CommandReference entries
  to point to 'commChannelCommand' bean instead of individual command classes
- Add CHANNELCONFIG command reference (priority 30) pointing to
  'channelConfigCommand' bean for admin channel configuration
- CHANNELCONFIG is automatically available to Implementors via existing
  blanket permission model

Fix mutation test coverage gaps in communication command tests ... ee17942583

- Add test for CommChannelCommand.init() via reflection to cover @PostConstruct
- Add test verifying registerSyntaxes() calls clearSyntaxes() before re-registering
- Strengthen CommChannel.addFilter() test to verify setChannel back-reference
- Add PoolTypeTest and FilterTypeTest for getDescription() enum coverage
- Add ChannelFilterTest for getId() and getChannel() coverage
- Add CommChannelTest covering getAliases() and removeFilter()
- Add CommServiceDeliverChannelTest for delivery path coverage

These changes address NO_COVERAGE and SURVIVED mutations across
PoolType, FilterType, ChannelFilter, CommChannel, and CommChannelCommand.

Fix channel config target validation and wizard state cleanup ... f84bfbb608

- Reject TokenType.INVALID as a valid direct target type in both
  ChannelConfigCreateQuestion and ChannelConfigEditQuestion
- Set nextStep to null before clearing wizard state in STEP_DESCRIPTION
  so the wizard step attribute isn't re-set after cleanup

Add test coverage for channel config null handling and edge cases ... 9830eb64ed

- ChannelConfigCreateQuestionTest: section headers, null wizard step test
- ChannelConfigEditQuestionTest: section headers, null field rendering tests
- ChannelConfigQuestionTest: tests for null pool type, description,
  and direct target in channel list output
- ChannelConfigTargetQuestionTest: new test for target selection edge cases

remove refactor plan a38fa58a87

scion added 3 commits 2026-05-28 01:13:55 -07:00

move CHEDIT into the correct section and give it the right name c53b012aa2

every command needs a syntax, even if it's empty a8ec396325

add DependsOn so the channels are there when it loads, use CommandReference instead of player input for channel name cf266fe775

scion added 1 commit 2026-05-28 01:27:27 -07:00

forgot to update tests 9302aa1d3b

scion changed title from refactor/communication-commands to WIP: refactor/communication-commands 2026-05-28 01:40:22 -07:00

scion added the

enhancement

refactor

labels 2026-05-28 01:40:54 -07:00

scion self-assigned this 2026-05-28 01:40:58 -07:00

qwen added 1 commit 2026-05-28 16:46:02 -07:00

fix: prevent ClassCastException in TELL/WHISPER commands ... caa8ce320c

The TELL and WHISPER commands were throwing ClassCastException because
broadcast channel syntaxes (single QUOTED_WORDS token) could match input
intended for direct-target channels (TARGET + QUOTED_WORDS) before the
more specific direct-target syntax was tried. This resulted in a 2-token
binding being passed to code expecting 3 tokens, causing String-to-
MudCharacter cast failure.

Fixes:

1. registerSyntaxes() now sorts channels so direct-target channels
   (TELL, WHISPER) are registered before broadcast channels (SAY, EMOTE,
   etc.), giving the more specific syntax first priority in matching.

2. execute() guards against a wrong binding count for direct-target
   channels: if fewer than 3 bindings arrive for a channel that
   expects a target + message, it returns silently instead of crashing.

Tests added:

- testDirectTargetSyntaxesRegisteredBeforeBroadcast: verifies sorting
- testTellWithWrongBindingCountReturnsSilently: verifies guard for TELL
- testWhisperWithWrongBindingCountReturnsSilently: verifies guard for WHISPER

qwen added 1 commit 2026-05-29 07:54:34 -07:00

Split CommChannelCommand into broadcast and direct-target variants ... 39c00bccae

The original CommChannelCommand registered both broadcast (SAY, SHOUT, etc.)
and direct-target (TELL, WHISPER) syntaxes on a single command bean. When
CommandQuestion looped through these syntaxes trying to match input, the
broadcast [QUOTED_WORDS] syntax could match a direct-target command like
"tell jeff hello" as ["TELL", "jeff hello"] if the target player couldn't
be resolved — resulting in only 2 bindings instead of the expected 3,
and producing silent empty output.

The fix is two separate command beans:

- CommChannelCommand: registers only broadcast channels (no directTargetType)
  with a [QUOTED_WORDS] syntax.
- DirectCommChannelCommand: registers only direct-target channels with a
  [TARGET_TYPE, QUOTED_WORDS] syntax.

TELL and WHISPER CommandReference entries now point to
directCommChannelCommand instead of commChannelCommand. Admin channel
questions call registerSyntaxes() on both beans.

scion added 1 commit 2026-05-29 09:01:17 -07:00

only show one error message, and only on failure 0d106bdaf4

scion changed title from WIP: refactor/communication-commands to refactor/communication-commands 2026-05-29 09:04:10 -07:00

qwen added 1 commit 2026-05-29 13:27:33 -07:00

fix: return to filter sub-menu after adding a channel filter ... 5a6af571c0

When editing a channel and adding a filter, the code was resetting
the edit state to null (main menu) instead of returning to the
filter management sub-menu (STATE_FILTER_SUB). This caused the
next user input to be interpreted as the filter type prompt again,
resulting in spurious 'Invalid filter type' errors.

Apply the same fix to:
- STATE_FILTER_ADD_TYPE on success (NOT_SENDER/NOT_TARGET paths)
- STATE_FILTER_ADD_TYPE on invalid input (IllegalArgumentException)
- STATE_FILTER_ADD_PARAM on success and on internal error

Add tests verifying the return state for all three cases.

qwen added 1 commit 2026-05-29 15:26:01 -07:00

Standardize ChannelConfig menus to use MenuPane/MenuItem ... b632ae56de

Refactor ChannelConfigEditQuestion and ChannelConfigTargetQuestion to
use the standard MenuPane/MenuItem/MenuTitle/MenuPrompt pattern instead
of hand-crafted output.append lines. This brings the channel editor
menus in line with other editors (RoomEditor, ItemEditor, NPCCreature
Editor) for consistent look and feel:

- ChannelConfigEditQuestion: uses MenuPane with dynamic title
  "Edit Channel: <name>" and MenuItem entries for each field
- ChannelConfigEditQuestion: filter sub-menu now renders via its
  own MenuPane with "Filter Management" title
- ChannelConfigTargetQuestion: uses MenuPane with "Select Channel"
  title and MenuItem entries for each channel
- ChannelConfigTargetQuestion: added "X" Cancel option to back out
- Updated tests to match new MenuPane output format

scion added 1 commit 2026-05-29 15:27:58 -07:00

javax annotation doesn't work anymore ... 1be0d1008e

# Conflicts:
#	agonyforge-mud-demo/src/main/java/com/agonyforge/mud/demo/config/CommandLoader.java
#	agonyforge-mud-demo/src/main/java/com/agonyforge/mud/demo/config/ProfessionLoader.java
#	agonyforge-mud-demo/src/main/java/com/agonyforge/mud/demo/config/SpeciesLoader.java
#	agonyforge-mud-demo/src/main/java/com/agonyforge/mud/demo/config/WorldLoader.java

qwen added 1 commit 2026-05-29 15:54:43 -07:00

fix: replace put(key, null) with remove(key) in ChannelConfigEditQuestion ... a2ef8ccc4d

ConcurrentHashMap.put(key, null) throws NullPointerException, but the
production WebSocket session attributes are backed by ConcurrentHashMap
(via Spring SimpMessageHeaderAccessor). This caused NPEs when editing any
channel field (local/remote format, bystander, pool type, target,
description, filter sub-menu back, filter remove).

Replace all .put(ChanConfigField, null) with .remove(ChanConfigField)
in handleFieldInput. Semantically equivalent for clearing state, but
works correctly with ConcurrentHashMap.

Also add tests using a real ConcurrentHashMap as the attributes map to
regress against this bug.

scion added 1 commit 2026-05-29 16:33:57 -07:00

Merge branch 'master' into refactor/communication-commands 47fd0d66a7

scion merged commit efdff09d3d into master 2026-05-29 16:54:56 -07:00

scion deleted branch refactor/communication-commands 2026-05-29 16:54:56 -07:00

scion referenced this pull request from a commit 2026-05-29 16:54:56 -07:00

Merge pull request 'refactor/communication-commands' (#505) from refactor/communication-commands into master

scion referenced this pull request 2026-05-31 00:16:28 -07:00

General solution for comms channels #405

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels   

bug

Something isn't working

  

dependencies

Pull requests that update a dependency file

  

documentation

Improvements or additions to documentation

  

duplicate

This issue or pull request already exists

  

enhancement

New feature or request

  

good first issue

Good for newcomers

  

help wanted

Extra attention is needed

  

invalid

This doesn't seem right

  

java

Pull requests that update java code

  

question

Further information is requested

  

refactor

Refactor of existing code

  

wontfix

This will not be worked on

No labels

bug

dependencies

documentation

duplicate

enhancement

good first issue

help wanted

invalid

java

question

refactor

wontfix

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

scion

2 participants

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

agony-forge/agonyforge!505

No description provided.