[MAGNOLIA-9290] YAML configuration error only reported in Definitions app, not console Created: 09/Feb/24  Updated: 09/Feb/24

Status: Open
Project: Magnolia
Component/s: None
Affects Version/s: 6.2.42
Fix Version/s: None

Type: Bug Priority: Neutral
Reporter: Chris Jennings Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: File example-rest-client.yaml     File example-webhook.yaml    
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Bug DoR:
[ ]* Steps to reproduce, expected, and actual results filled
[ ]* Affected version filled

 Description   

Steps to reproduce

  1. Create a light module with the two attached definitions, one rest client and one webhook using the rest client.
  2. With Magnolia running, modify the webhook config as shown in the source so that the rest client is incorrectly referenced. The webhook now refers to a non-existent rest client.
  3. Open the Definitions app and see that there is a "Severe" error message attached to the webhook config, "A rest client definition [NotTheExampleRestClient] does not exist"  

Expected results

When YAML config is reloaded we parse it for errors and show them in the server console output. As a developer working on many YAML files, it is easier to watch a terminal than it is to keep on opening/refreshing the Definitions app so this is a useful feature. It would be reasonable to expect the naming mismatch to appear here alongside any syntax errors.

Actual results

No mention is made of the error. Only the Definitions app shows a message.


Generated at Mon Feb 12 04:40:20 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.