Implement ValidationMiddleware (priority 15) for action pipeline #297

New issue

Closed

opened 2026-03-16 01:59:23 +00:00 by freemo · 0 comments

freemo commented

2026-03-16 01:59:23 +00:00

Owner

Metadata

Key	Value
Branch	`feature/m1-validation-middleware`
Commit Message	`feat: implement ValidationMiddleware at priority 15 for action pipeline`
Parent Epic	#291 — Input Validation Framework

Background and Context

The action middleware pipeline processes commands through a series of middleware stages ordered by priority. The Input Validation Framework must be integrated into this pipeline so that validation runs automatically for every command. ValidationMiddleware sits at priority 15, which places it after PermissionCheck (priority 5) and AliveCheck (priority 10), ensuring that permissions and liveness are verified before spending cycles on input validation.

Expected Behavior

ValidationMiddleware is a middleware class registered at priority 15 in the action pipeline. When a command is dispatched:

It retrieves the command class's declared parameters (from the Parameter DSL).
If the command has no declared parameters, it passes through (backward compatibility with un-migrated commands).
If parameters are declared, it runs the ValidationPipeline with the raw input and context.
On success, it attaches the ValidatedParams hash to the context and calls the next middleware.
On failure, it sends error messages to the player and short-circuits (does not call the next middleware).

class ValidationMiddleware < Middleware
  priority 15

  def call(context)
    command_class = context.command_class
    return yield if command_class.declared_params.empty?

    result = ValidationPipeline.run(command_class, context.raw_input, context)
    if result.valid?
      context.validated_params = result.params
      yield
    else
      context.player.output(result.errors.join("\n"))
    end
  end
end

Acceptance Criteria

ValidationMiddleware is registered at priority 15 in the action pipeline.
Commands with no declared parameters pass through without validation.
Commands with declared parameters are run through ValidationPipeline.
Successful validation attaches ValidatedParams to the command context.
Failed validation sends all error messages to the player.
Failed validation short-circuits the pipeline (handler is not executed).
Priority ordering is correct: PermissionCheck (5) → AliveCheck (10) → ValidationMiddleware (15).

Subtasks

Code

Create ValidationMiddleware class extending the base middleware class.
Set priority to 15.
Implement pass-through for commands without declared parameters.
Integrate ValidationPipeline.run call with context propagation.
Attach ValidatedParams to context on success.
Implement short-circuit on validation failure with error output.
Register middleware in the action pipeline configuration.

Quality

Docs: Update YARD comments on affected classes and methods. Update relevant Docusaurus documentation pages if applicable.
Tests (Cucumber): Add tests/unit/validation_middleware.feature covering pass-through for no-param commands, successful validation with params attached, failed validation with error output and short-circuit, priority ordering verification, backward compatibility.
Tests (Cucumber Integration): Add integration feature in tests/integration/ for ValidationMiddleware intercepting commands in the action pipeline.
Tests (Profiling): Run bundle exec rake unit_profile and verify no performance regressions.
Quality: Verify coverage >=97% via bundle exec rake unit. If coverage is <97% then review the current unit test coverage report at build/tests/unit/coverage/ and use it to write new Cucumber based unit tests to improve coverage. Specifically, write Cucumber/Gherkin style unit tests that are descriptively named and specifically improve coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun bundle exec rake unit to verify all tests pass and coverage is above >=97%. Only mark this as complete once coverage is >=97%, if not repeat this task as many times as is needed until coverage reaches >=97%.
Quality: Run bundle exec rake (default task: unit tests with coverage) and bundle exec rake integration, fix any errors if needed ensuring both pass across entire code base, do not ignore any failure even if it seems unrelated to this commit, fix it.

Definition of Done

This issue is complete when:

All subtasks above are completed and checked off.
A Git commit is created where the first line of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation.
The commit is pushed to the remote on the branch matching the Branch in Metadata exactly.
The commit is submitted as a pull request to master, reviewed, and merged before this issue is marked done.

## Metadata | Key | Value | |-----|-------| | **Branch** | `feature/m1-validation-middleware` | | **Commit Message** | `feat: implement ValidationMiddleware at priority 15 for action pipeline` | | **Parent Epic** | #291 — Input Validation Framework | ## Background and Context The action middleware pipeline processes commands through a series of middleware stages ordered by priority. The Input Validation Framework must be integrated into this pipeline so that validation runs automatically for every command. ValidationMiddleware sits at priority 15, which places it after PermissionCheck (priority 5) and AliveCheck (priority 10), ensuring that permissions and liveness are verified before spending cycles on input validation. ## Expected Behavior `ValidationMiddleware` is a middleware class registered at priority 15 in the action pipeline. When a command is dispatched: 1. It retrieves the command class's declared parameters (from the Parameter DSL). 2. If the command has no declared parameters, it passes through (backward compatibility with un-migrated commands). 3. If parameters are declared, it runs the `ValidationPipeline` with the raw input and context. 4. On success, it attaches the `ValidatedParams` hash to the context and calls the next middleware. 5. On failure, it sends error messages to the player and short-circuits (does not call the next middleware). ```ruby class ValidationMiddleware < Middleware priority 15 def call(context) command_class = context.command_class return yield if command_class.declared_params.empty? result = ValidationPipeline.run(command_class, context.raw_input, context) if result.valid? context.validated_params = result.params yield else context.player.output(result.errors.join("\n")) end end end ``` ## Acceptance Criteria - [ ] `ValidationMiddleware` is registered at priority 15 in the action pipeline. - [ ] Commands with no declared parameters pass through without validation. - [ ] Commands with declared parameters are run through `ValidationPipeline`. - [ ] Successful validation attaches `ValidatedParams` to the command context. - [ ] Failed validation sends all error messages to the player. - [ ] Failed validation short-circuits the pipeline (handler is not executed). - [ ] Priority ordering is correct: PermissionCheck (5) → AliveCheck (10) → ValidationMiddleware (15). ## Subtasks ### Code - [ ] Create `ValidationMiddleware` class extending the base middleware class. - [ ] Set priority to 15. - [ ] Implement pass-through for commands without declared parameters. - [ ] Integrate `ValidationPipeline.run` call with context propagation. - [ ] Attach `ValidatedParams` to context on success. - [ ] Implement short-circuit on validation failure with error output. - [ ] Register middleware in the action pipeline configuration. ### Quality - [ ] Docs: Update YARD comments on affected classes and methods. Update relevant Docusaurus documentation pages if applicable. - [ ] Tests (Cucumber): Add `tests/unit/validation_middleware.feature` covering pass-through for no-param commands, successful validation with params attached, failed validation with error output and short-circuit, priority ordering verification, backward compatibility. - [ ] Tests (Cucumber Integration): Add integration feature in `tests/integration/` for ValidationMiddleware intercepting commands in the action pipeline. - [ ] Tests (Profiling): Run `bundle exec rake unit_profile` and verify no performance regressions. - [ ] Quality: Verify coverage >=97% via `bundle exec rake unit`. If coverage is <97% then review the current unit test coverage report at `build/tests/unit/coverage/` and use it to write new Cucumber based unit tests to improve coverage. Specifically, write Cucumber/Gherkin style unit tests that are descriptively named and specifically improve coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun `bundle exec rake unit` to verify all tests pass and coverage is above >=97%. Only mark this as complete once coverage is >=97%, if not repeat this task as many times as is needed until coverage reaches >=97%. - [ ] Quality: Run `bundle exec rake` (default task: unit tests with coverage) and `bundle exec rake integration`, fix any errors if needed ensuring both pass across **entire** code base, do not ignore any failure even if it seems unrelated to this commit, fix it. ## Definition of Done This issue is complete when: - All subtasks above are completed and checked off. - A Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation. - The commit is pushed to the remote on the branch matching the **Branch** in Metadata exactly. - The commit is submitted as a **pull request** to `master`, reviewed, and **merged** before this issue is marked done.