[4652] Add support for project to library dependencies

Bug: eclipse-sirius#4652 Signed-off-by: Gwendal Daniel <[email protected]>
gdaniel · Feb 28, 2025 · 378a452 · 378a452
1 parent 8f1d319
commit 378a452
Show file tree

Hide file tree

Showing 22 changed files with 657 additions and 10 deletions.
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -45,6 +45,10 @@ See the new interface `org.eclipse.sirius.components.emf.services.api.IRepresent
 - https://github.com/eclipse-sirius/sirius-web/issues/4597[#4597] [sirius-web] Add a command to publish libraries from studios
 The command creates a library for each _RepresentationDescription_ and _Domain_ in the studio, and creates the dependencies between them.
 A _shared components_ library can be created in the process to store elements that are needed by other libraries but are not stored in libraries themselves.
+- https://github.com/eclipse-sirius/sirius-web/issues/4652[#4652] [sirius-web] Add support for project to library dependencies
+Project can have dependencies to libraries, which are loaded along the project's semantic data.
+Loading a library in the editing context loads all the libraries it transitively depends on.
+A new predicate `IReadOnlyObjectPredicate` has been added with a default implementation that returns `true` if the object is in a library.
 
 
 === Improvements

diff --git a/...java/org/eclipse/sirius/web/application/editingcontext/services/EditingContextLoader.java b/...java/org/eclipse/sirius/web/application/editingcontext/services/EditingContextLoader.java
@@ -24,6 +24,7 @@
 import org.eclipse.sirius.web.application.editingcontext.services.api.IEditingContextLoader;
 import org.eclipse.sirius.web.application.editingcontext.services.api.IEditingContextMigrationParticipantPredicate;
 import org.eclipse.sirius.web.application.editingcontext.services.api.IResourceLoader;
+import org.eclipse.sirius.web.application.library.services.api.IEditingContextLibraryLoader;
 import org.eclipse.sirius.web.domain.boundedcontexts.semanticdata.SemanticData;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -41,22 +42,27 @@ public class EditingContextLoader implements IEditingContextLoader {
 
     private final IResourceLoader resourceLoader;
 
+    private final IEditingContextLibraryLoader editingContextLibraryLoader;
+
     private final List<IEditingContextRepresentationDescriptionProvider> representationDescriptionProviders;
 
     private final List<IEditingContextProcessor> editingContextProcessors;
 
     private final List<IEditingContextMigrationParticipantPredicate> migrationParticipantPredicates;
 
-    public EditingContextLoader(IResourceLoader resourceLoader, List<IEditingContextRepresentationDescriptionProvider> representationDescriptionProviders, List<IEditingContextProcessor> editingContextProcessors, List<IEditingContextMigrationParticipantPredicate> migrationParticipantPredicates) {
+    public EditingContextLoader(IResourceLoader resourceLoader, IEditingContextLibraryLoader editingContextLibraryLoader, List<IEditingContextRepresentationDescriptionProvider> representationDescriptionProviders, List<IEditingContextProcessor> editingContextProcessors, List<IEditingContextMigrationParticipantPredicate> migrationParticipantPredicates) {
         this.resourceLoader = Objects.requireNonNull(resourceLoader);
+        this.editingContextLibraryLoader = Objects.requireNonNull(editingContextLibraryLoader);
         this.representationDescriptionProviders = Objects.requireNonNull(representationDescriptionProviders);
         this.editingContextProcessors = Objects.requireNonNull(editingContextProcessors);
         this.migrationParticipantPredicates = Objects.requireNonNull(migrationParticipantPredicates);
     }
 
+    @Override
     public void load(EditingContext editingContext, SemanticData semanticData) {
         this.editingContextProcessors.forEach(processor -> processor.preProcess(editingContext));
 
+        this.editingContextLibraryLoader.loadLibraries(editingContext);
         this.loadSemanticData(editingContext, semanticData);
 
         this.representationDescriptionProviders.forEach(representationDescriptionProvider -> {

diff --git a/...java/org/eclipse/sirius/web/application/library/services/EditingContextLibraryLoader.java b/...java/org/eclipse/sirius/web/application/library/services/EditingContextLibraryLoader.java
@@ -0,0 +1,101 @@
+/*******************************************************************************
+ * Copyright (c) 2025 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.web.application.library.services;
+
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.Set;
+
+import org.eclipse.emf.common.util.URI;
+import org.eclipse.emf.ecore.resource.Resource;
+import org.eclipse.sirius.components.core.api.IEditingContext;
+import org.eclipse.sirius.web.application.UUIDParser;
+import org.eclipse.sirius.web.application.editingcontext.EditingContext;
+import org.eclipse.sirius.web.application.editingcontext.services.api.IEditingContextMigrationParticipantPredicate;
+import org.eclipse.sirius.web.application.editingcontext.services.api.IResourceLoader;
+import org.eclipse.sirius.web.application.library.services.api.IEditingContextLibraryLoader;
+import org.eclipse.sirius.web.domain.boundedcontexts.library.Library;
+import org.eclipse.sirius.web.domain.boundedcontexts.library.services.api.ILibrarySearchService;
+import org.eclipse.sirius.web.domain.boundedcontexts.semanticdata.SemanticData;
+import org.eclipse.sirius.web.domain.boundedcontexts.semanticdata.SemanticDataDependency;
+import org.eclipse.sirius.web.domain.boundedcontexts.semanticdata.services.api.ISemanticDataSearchService;
+import org.springframework.stereotype.Service;
+
+/**
+ * Loads libraries into the editing context.
+ *
+ * @author gdaniel
+ */
+@Service
+public class EditingContextLibraryLoader implements IEditingContextLibraryLoader {
+
+    private final ISemanticDataSearchService semanticDataSearchService;
+
+    private final ILibrarySearchService librarySearchService;
+
+    private final IResourceLoader resourceLoader;
+
+    private final List<IEditingContextMigrationParticipantPredicate> migrationParticipantPredicates;
+
+    public EditingContextLibraryLoader(ISemanticDataSearchService semanticDataSearchService, ILibrarySearchService librarySearchService, IResourceLoader resourceLoader, List<IEditingContextMigrationParticipantPredicate> migrationParticipantPredicates) {
+        this.semanticDataSearchService = Objects.requireNonNull(semanticDataSearchService);
+        this.librarySearchService = Objects.requireNonNull(librarySearchService);
+        this.resourceLoader = Objects.requireNonNull(resourceLoader);
+        this.migrationParticipantPredicates = Objects.requireNonNull(migrationParticipantPredicates);
+    }
+
+    @Override
+    public void loadLibraries(IEditingContext editingContext) {
+        if (editingContext instanceof EditingContext siriusWebEditingContext) {
+            Set<Library> librariesToLoad = this.getLibrariesToLoad(siriusWebEditingContext);
+            for (Library library : librariesToLoad) {
+                Optional<SemanticData> librarySemanticData = this.semanticDataSearchService.findById(library.getSemanticData().getId());
+                if (librarySemanticData.isPresent()) {
+                    librarySemanticData.get().getDocuments().forEach(document -> {
+                        URI libraryResourceURI = URI.createURI(LIBRARY_SCHEME + ":///" + document.getId().toString());
+                        if (siriusWebEditingContext.getDomain().getResourceSet().getResource(libraryResourceURI, false) == null) {
+                            Optional<Resource> resource = this.resourceLoader.toResource(siriusWebEditingContext.getDomain().getResourceSet(), document.getId().toString(), document.getName(), document.getContent(),
+                                    this.migrationParticipantPredicates.stream().anyMatch(predicate -> predicate.test(editingContext.getId())));
+                            resource.ifPresent(r -> {
+                                siriusWebEditingContext.getDomain().getResourceSet().getURIConverter().getURIMap().put(r.getURI(), libraryResourceURI);
+                                r.setURI(libraryResourceURI);
+                            });
+                        }
+                    });
+                }
+            }
+        }
+    }
+
+    private Set<Library> getLibrariesToLoad(EditingContext editingContext) {
+        Set<Library> librariesToLoad = new LinkedHashSet<>();
+        List<Library> editingContextLibraries = new UUIDParser().parse(editingContext.getId())
+                .flatMap(semanticDataId -> this.semanticDataSearchService.findById(semanticDataId))
+                .map(SemanticData::getDependencies)
+                .orElse(List.of())
+                .stream()
+                .map(SemanticDataDependency::libraryId)
+                .map(this.librarySearchService::findById)
+                .filter(Optional::isPresent)
+                .map(Optional::get)
+                .toList();
+
+        for (Library library : editingContextLibraries) {
+            librariesToLoad.add(library);
+            librariesToLoad.addAll(this.librarySearchService.findAllTransitiveDependencyLibrariesByLibrary(library));
+        }
+        return librariesToLoad;
+    }
+}
diff --git a/...org/eclipse/sirius/web/application/library/services/api/IEditingContextLibraryLoader.java b/...org/eclipse/sirius/web/application/library/services/api/IEditingContextLibraryLoader.java
@@ -0,0 +1,28 @@
+/*******************************************************************************
+ * Copyright (c) 2025 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.web.application.library.services.api;
+
+import org.eclipse.sirius.components.core.api.IEditingContext;
+
+/**
+ * Loads libraries into the editing context.
+ *
+ * @author gdaniel
+ */
+public interface IEditingContextLibraryLoader {
+
+    String LIBRARY_SCHEME = "library";
+
+    void loadLibraries(IEditingContext editingContext);
+
+}
diff --git a/...a/org/eclipse/sirius/web/application/object/services/ComposedReadOnlyObjectPredicate.java b/...a/org/eclipse/sirius/web/application/object/services/ComposedReadOnlyObjectPredicate.java
@@ -0,0 +1,52 @@
+/*******************************************************************************
+ * Copyright (c) 2025 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.web.application.object.services;
+
+import java.util.List;
+import java.util.Objects;
+
+import org.eclipse.sirius.web.application.object.services.api.IDefaultReadOnlyObjectPredicate;
+import org.eclipse.sirius.web.application.object.services.api.IReadOnlyObjectPredicate;
+import org.eclipse.sirius.web.application.object.services.api.IReadOnlyObjectPredicateDelegate;
+import org.springframework.stereotype.Service;
+
+/**
+ * Implementation of {@link IReadOnlyObjectPredicate} which delegates to {@link IReadOnlyObjectPredicateDelegate} or fallback to
+ * {@link IDefaultReadOnlyObjectPredicate}.
+ *
+ * @author gdaniel
+ */
+@Service
+public class ComposedReadOnlyObjectPredicate implements IReadOnlyObjectPredicate {
+
+    private final List<IReadOnlyObjectPredicateDelegate> readOnlyObjectPredicateDelegate;
+
+    private final IDefaultReadOnlyObjectPredicate defaultReadOnlyObjectPredicate;
+
+    public ComposedReadOnlyObjectPredicate(List<IReadOnlyObjectPredicateDelegate> readOnlyObjectPredicateDelegate, IDefaultReadOnlyObjectPredicate defaultReadOnlyObjectPredicate) {
+        this.readOnlyObjectPredicateDelegate = Objects.requireNonNull(readOnlyObjectPredicateDelegate);
+        this.defaultReadOnlyObjectPredicate = Objects.requireNonNull(defaultReadOnlyObjectPredicate);
+    }
+
+    @Override
+    public boolean test(Object object) {
+        var optionalDelegate = this.readOnlyObjectPredicateDelegate.stream()
+                .filter(delegate -> delegate.canHandle(object))
+                .findFirst();
+        if (optionalDelegate.isPresent()) {
+            return optionalDelegate.get().test(object);
+        }
+        return this.defaultReadOnlyObjectPredicate.test(object);
+    }
+
+}
diff --git a/...va/org/eclipse/sirius/web/application/object/services/DefaultReadOnlyObjectPredicate.java b/...va/org/eclipse/sirius/web/application/object/services/DefaultReadOnlyObjectPredicate.java
@@ -0,0 +1,48 @@
+/*******************************************************************************
+ * Copyright (c) 2025 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.web.application.object.services;
+
+import java.util.Objects;
+import java.util.Optional;
+
+import org.eclipse.emf.common.util.URI;
+import org.eclipse.emf.ecore.EObject;
+import org.eclipse.emf.ecore.resource.Resource;
+import org.eclipse.sirius.web.application.library.services.api.IEditingContextLibraryLoader;
+import org.eclipse.sirius.web.application.object.services.api.IDefaultReadOnlyObjectPredicate;
+import org.springframework.stereotype.Service;
+
+/**
+ * The default service used to test if an object is read-only.
+ *
+ * @author gdaniel
+ */
+@Service
+public class DefaultReadOnlyObjectPredicate implements IDefaultReadOnlyObjectPredicate {
+
+    @Override
+    public boolean test(Object object) {
+        boolean result = false;
+        if (object instanceof EObject eObject) {
+            result = Optional.ofNullable(eObject.eResource())
+                    .map(Resource::getURI)
+                    .map(URI::scheme)
+                    .filter(scheme -> Objects.equals(scheme, IEditingContextLibraryLoader.LIBRARY_SCHEME))
+                    .isPresent();
+        } else if (object instanceof Resource resource) {
+            result = Objects.equals(resource.getURI().scheme(), IEditingContextLibraryLoader.LIBRARY_SCHEME);
+        }
+        return result;
+    }
+
+}
diff --git a/...g/eclipse/sirius/web/application/object/services/api/IDefaultReadOnlyObjectPredicate.java b/...g/eclipse/sirius/web/application/object/services/api/IDefaultReadOnlyObjectPredicate.java
@@ -0,0 +1,24 @@
+/*******************************************************************************
+ * Copyright (c) 2025 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.web.application.object.services.api;
+
+import java.util.function.Predicate;
+
+/**
+ * The default service used to test if an object is read-only.
+ *
+ * @author gdaniel
+ */
+public interface IDefaultReadOnlyObjectPredicate extends Predicate<Object> {
+
+}
diff --git a/...java/org/eclipse/sirius/web/application/object/services/api/IReadOnlyObjectPredicate.java b/...java/org/eclipse/sirius/web/application/object/services/api/IReadOnlyObjectPredicate.java
@@ -0,0 +1,24 @@
+/*******************************************************************************
+ * Copyright (c) 2025 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.web.application.object.services.api;
+
+import java.util.function.Predicate;
+
+/**
+ * Used to test if an object is read-only.
+ *
+ * @author gdaniel
+ */
+public interface IReadOnlyObjectPredicate extends Predicate<Object> {
+
+}
diff --git a/.../eclipse/sirius/web/application/object/services/api/IReadOnlyObjectPredicateDelegate.java b/.../eclipse/sirius/web/application/object/services/api/IReadOnlyObjectPredicateDelegate.java
@@ -0,0 +1,26 @@
+/*******************************************************************************
+ * Copyright (c) 2025 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.web.application.object.services.api;
+
+import java.util.function.Predicate;
+
+/**
+ * Used to test if an object is read-only.
+ *
+ * @author gdaniel
+ */
+public interface IReadOnlyObjectPredicateDelegate extends Predicate<Object> {
+
+    boolean canHandle(Object object);
+
+}