[doc] Add the ADR for supporting any kind of object as semantic eleme…

…nt in trees Signed-off-by: Jerome Gout <[email protected]>
jerome-obeo · Jul 15, 2024 · 70a563e · 70a563e
1 parent d1964bc
commit 70a563e
Show file tree

Hide file tree

Showing 12 changed files with 36 additions and 11 deletions.
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -8,6 +8,7 @@
 
 === Architectural decision records
 
+- [ADR-152] Add support for any kind of object as semantic element in the tree representation
 
 === Deprecation warning
 
@@ -42,7 +43,7 @@
 
 === Architectural decision records
 
-[ADR-151] Improve Diagram Subscription Lifecycle
+- [ADR-151] Improve Diagram Subscription Lifecycle
 
 === Deprecation warning
 

diff --git a/...drs/137_use_a_common_identification_strategy_for_transient_representations.adoc b/...drs/137_use_a_common_identification_strategy_for_transient_representations.adoc
@@ -1,4 +1,4 @@
-= [ADR-137] Use a common identification strategy for transient representations
+= ADR-137 Use a common identification strategy for transient representations
 
 == Context
 

diff --git a/doc/adrs/138_allow_consumers_to_reuse_smaller_parts_of_the_sirius_web_backend.adoc b/doc/adrs/138_allow_consumers_to_reuse_smaller_parts_of_the_sirius_web_backend.adoc
@@ -1,4 +1,4 @@
-= [ADR-138] Allow consumers to reuse smaller parts of the Sirius Web backend
+= ADR-138 Allow consumers to reuse smaller parts of the Sirius Web backend
 
 == Context
 

diff --git a/doc/adrs/141_factorize-graphql_queries_in_tests.adoc b/doc/adrs/141_factorize-graphql_queries_in_tests.adoc
@@ -1,4 +1,4 @@
-= [ADR-141] Factorize GraphQL queries in tests
+= ADR-141 Factorize GraphQL queries in tests
 
 == Context
 

diff --git a/doc/adrs/142_add_report_on_document_upload.adoc b/doc/adrs/142_add_report_on_document_upload.adoc
@@ -1,4 +1,4 @@
-= [ADR-142] Add report on document upload
+= ADR-142 Add report on document upload
 
 == Context
 

diff --git a/doc/adrs/143_handle_documents_upload_with_other_formats_than_json_and_xmi.adoc b/doc/adrs/143_handle_documents_upload_with_other_formats_than_json_and_xmi.adoc
@@ -1,4 +1,4 @@
-= [ADR-143] Handle documents upload with other formats than JSON and XMI
+= ADR-143 Handle documents upload with other formats than JSON and XMI
 
 == Context
 

diff --git a/doc/adrs/145_add_a_hook_to_update_nodes_in_reactflow.adoc b/doc/adrs/145_add_a_hook_to_update_nodes_in_reactflow.adoc
@@ -1,4 +1,4 @@
-= [ADR-145] Add a hook to update nodes in ReactFlow
+= ADR-145 Add a hook to update nodes in ReactFlow
 
 == Context
 

diff --git a/doc/adrs/146_contribute_representation_metadata_for_transient_representations.adoc b/doc/adrs/146_contribute_representation_metadata_for_transient_representations.adoc
@@ -1,4 +1,4 @@
-= [ADR-146] Add support for contributing representation metadata for transient representations
+= ADR-146 Add support for contributing representation metadata for transient representations
 
 == Context
 

diff --git a/doc/adrs/147_overlapping_nodes.adoc b/doc/adrs/147_overlapping_nodes.adoc
@@ -1,4 +1,4 @@
-= [ADR-147] Add support for overlapping nodes
+= ADR-147 Add support for overlapping nodes
 
 == Context
 

diff --git a/doc/adrs/148_improves_edge_layout.adoc b/doc/adrs/148_improves_edge_layout.adoc
@@ -1,4 +1,4 @@
-= [ADR-148] Improve edge layout
+= ADR-148 Improve edge layout
 
 == Context
 

diff --git a/doc/adrs/151_improve_diagram_subscription_lifecycle.adoc b/doc/adrs/151_improve_diagram_subscription_lifecycle.adoc
@@ -1,4 +1,4 @@
-= [ADR-151] Improve Diagram Subscription Lifecycle
+= ADR-151 Improve Diagram Subscription Lifecycle
 
 == Context
 

diff --git a/...support_for_any_kind_of_object_as_semantic_element_in_the_tree_description.adoc b/...support_for_any_kind_of_object_as_semantic_element_in_the_tree_description.adoc
@@ -0,0 +1,24 @@
+= ADR-152 Add support for any kind of object as semantic element in the tree representation
+
+== Context
+
+Sirius Web doesn't provide in its Tree description API a way to retrieve the model element associated to a TreeItem.
+At the moment Sirius Web Explorer relies on `IObjectSearchService.getObject()` to retrieve the object associated to a given TreeItem node using its `id`.
+While it works, it is restricted to objects that have been considered as semantic elements by the server.
+
+In order to extend the tree capabilities to handle any kind of object, we need to be able to extend this behavior.
+For that, we will provide a mechanism to find an object associated to a TreeItem using its id.
+
+== Decision
+
+We will add a new field `Function<VariableManager, Object> treeItemObjectProvider` in `org.eclipse.sirius.components.trees.description.TreeDescription` and in its builder.
+Existing usages of `org.eclipse.sirius.components.trees.description.TreeDescription` should be completed by providing a default object retrieval mechanism which can delegate its behavior to `IObjectSearchService.getObject()`.
+
+`o.e.s.w.a.v.explorer.services.DeleteObjectTreeItemEventHandler` and `o.e.s.w.a.v.explorer.services.RenameObjectTreeItemEventHandler` should be updated, because they rely on the `IObjectSearchService.getObject()` service to retrieve the object before performing the deletion or renaming operations.
+`o.e.s.w.a.v.explorer.services.ExplorerNavigationService` and `o.e.s.w.a.v.explorer.services.ExpandAllTreePathProvider` are also retrieving the object associated to a TreeItem using `IObjectSearchService.getObject()` service.
+
+They should instead get the object by calling `treeItemObjectProvider` specified on the tree description of the Sirius Web Explorer in our case.
+
+== Status
+
+Work in progress