Update views after enhancements - Githubissues

Riduidel / aadarchi

A maven archetype to generate easily projects allowing architecture description using a mix of C4, agile architecture, Asciidoc and PlantUML

https://riduidel.github.io/aadarchi/

Apache License 2.0

40 stars 12 forks source link

Update views after enhancements #274

Closed Riduidel closed 1 year ago

Riduidel commented 1 year ago

Currently, views are created at workspace.dsl loading. This prevents enhancements (typically maven ones).

Hopefully, the enhancer already exists : it is ViewUpdater, located into architecture-documentation.

So

Move ViewUpdater into base project org.ndx.aadarchi.base.enhancers.graph package
In ViewUpdater, remove the name based check and only apply view updating on filtered view (https://github.com/structurizr/dsl/blob/master/docs/language-reference.md#filtered-view)
Add in documentation (but where?) the fact that view updating will be based on filtered view

Riduidel commented 1 year ago

@AcevedoR In this issue we're talking about updating views after having let all enhancers run. What would you prefer ?

We update the existing view with all nodes from observed element (that's what the ViewUpdater currently do)
We create a new view with added elements ? In that case, we would have to give that new view a name (that's why I was thinking about filtered views, but I don't think they really serve that purpose, I thinkk it would be better to clone the view with a new name)

Se-C12 commented 1 year ago

do I have to include or exclude some elements for the filtered view?

Riduidel commented 1 year ago

No, you take all elements added during discovery to current diagram. That's exactly what ViewUpdater do. However, if you have any idea on how to have some views updated while others are not it could be very cool.

Riduidel commented 1 year ago

So, steps are

[x] Rework ArchitectureEnhancer#enhancerVisitViews(...) to add handling of FilteredView
[x] Add support of FilteredView in ViewEnhancer
[x] Add default noop implementation in ViewEnhancerAdapter
[x] Move ViewUpdater in base module
[x] Remove the various if in ViewUpdater
[ ] Rework the ViewUpdater to process onlyComponentViewandContainerViewhaving the propertyaadarchi.update.viewset totrue` (or anything non false)
[ ] Call the correct view update method

Riduidel commented 1 year ago

Seems like updating structurizr to latest version would allow definition of properties in views (see https://github.com/structurizr/java/releases/tag/v1.16.1) which in turn would allow us to reuse the initial view updated with an aadarchi.auto.include property set to true (or any non-false value).

@Sese-collab Can you take a look at that possibility ?