Skip to content

[1861] Split responsibilities of SysONLibraryPublicationHandler #1874

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
flatombe wants to merge 1 commit into
base: cooldown
Choose a base branch
from
Open

[1861] Split responsibilities of SysONLibraryPublicationHandler #1874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ A new compartment named _satisfy requirements_ has also been added to `PartDefin
- https://github.com/eclipse-syson/syson/issues/1818[#1818] [diagrams] On _Interconnection View_ diagrams, the top-level palette no longer proposes to create `Attributes` and `Ports`, which can not actually be displayed on the diagram's background.
The tools are still available in the palette of e.g. `Parts`.
- https://github.com/eclipse-syson/syson/issues/1819[#1819] [diagrams] In diagrams, when using _direct edit_ tool, you can now set a _multiplicity range part_ [n..n] after or before a _typing part_, _subsetting part_ or _redefinition part_.
- https://github.com/eclipse-syson/syson/issues/1861[#1861] [publication] Split SysONLibraryPublicationHandler in 2 so the publishing logic can be extended or re-used through the ISysMLLibraryPublisher API.

=== New features

Expand Down
210 changes: 18 additions & 192 deletions ...c/main/java/org/eclipse/syson/application/publication/SysONLibraryPublicationHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2025 Obeo.
* Copyright (c) 2025, 2026 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
Expand All @@ -12,89 +12,48 @@
*******************************************************************************/
package org.eclipse.syson.application.publication;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import java.util.stream.Collectors;

import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.sirius.components.core.api.ErrorPayload;
import org.eclipse.sirius.components.core.api.IEditingContextSearchService;
import org.eclipse.sirius.components.core.api.IPayload;
import org.eclipse.sirius.components.core.api.SuccessPayload;
import org.eclipse.sirius.components.emf.ResourceMetadataAdapter;
import org.eclipse.sirius.components.emf.services.api.IEMFEditingContext;
import org.eclipse.sirius.components.events.ICause;
import org.eclipse.sirius.components.representations.Message;
import org.eclipse.sirius.components.representations.MessageLevel;
import org.eclipse.sirius.web.application.editingcontext.services.DocumentData;
import org.eclipse.sirius.web.application.editingcontext.services.EPackageEntry;
import org.eclipse.sirius.web.application.editingcontext.services.api.IResourceToDocumentService;
import org.eclipse.sirius.web.application.library.dto.PublishLibrariesInput;
import org.eclipse.sirius.web.application.library.services.LibraryMetadataAdapter;
import org.eclipse.sirius.web.application.library.services.api.ILibraryApplicationService;
import org.eclipse.sirius.web.application.library.services.api.ILibraryPublicationHandler;
import org.eclipse.sirius.web.application.studio.services.library.api.DependencyGraph;
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.project.Project;
import org.eclipse.sirius.web.domain.boundedcontexts.project.services.api.IProjectSearchService;
import org.eclipse.sirius.web.domain.boundedcontexts.projectsemanticdata.services.api.IProjectSemanticDataSearchService;
import org.eclipse.sirius.web.domain.boundedcontexts.semanticdata.Document;
import org.eclipse.sirius.web.domain.boundedcontexts.semanticdata.SemanticData;
import org.eclipse.sirius.web.domain.boundedcontexts.semanticdata.services.api.ISemanticDataCreationService;
import org.eclipse.sirius.web.domain.services.IResult;
import org.eclipse.sirius.web.domain.services.Success;
import org.eclipse.syson.application.publication.api.ISysONLibraryDependencyCollector;
import org.eclipse.syson.sysml.SysmlPackage;
import org.eclipse.syson.sysml.util.ElementUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.eclipse.syson.application.publication.api.ISysMLLibraryPublisher;
import org.springframework.data.jdbc.core.mapping.AggregateReference;
import org.springframework.stereotype.Service;

/**
* {@link ILibraryPublicationHandler} for publishing libraries in SysON.
*
* @see ILibraryApplicationService
* @see SysONLibraryPublicationListener
* @author flatombe
*/
@Service
public class SysONLibraryPublicationHandler implements ILibraryPublicationHandler {
private static final Logger LOGGER = LoggerFactory.getLogger(SysONLibraryPublicationHandler.class);

private final IEditingContextSearchService editingContextSearchService;

private final ISemanticDataCreationService semanticDataCreationService;

private final IResourceToDocumentService resourceToDocumentService;

private final IProjectSemanticDataSearchService projectSemanticDataSearchService;

private final IProjectSearchService projectSearchService;

private final ILibrarySearchService librarySearchService;

private final ISysONLibraryDependencyCollector sysonLibraryDependencyCollector;
private final ISysMLLibraryPublisher sysONSysMLLibraryPublisher;

public SysONLibraryPublicationHandler(final IEditingContextSearchService editingContextSearchService,
final ISemanticDataCreationService semanticDataCreationService,
final IResourceToDocumentService resourceToDocumentService,
final IProjectSemanticDataSearchService projectSemanticDataSearchService, final IProjectSearchService projectSearchService,
final ILibrarySearchService librarySearchService,
final ISysONLibraryDependencyCollector sysonLibraryDependencyCollector) {
this.projectSearchService = Objects.requireNonNull(projectSearchService);
final IProjectSemanticDataSearchService projectSemanticDataSearchService,
final IProjectSearchService projectSearchService,
final ISysMLLibraryPublisher sysONSysMLLibraryPublisher) {
this.editingContextSearchService = Objects.requireNonNull(editingContextSearchService);
this.semanticDataCreationService = Objects.requireNonNull(semanticDataCreationService);
this.resourceToDocumentService = Objects.requireNonNull(resourceToDocumentService);
this.projectSemanticDataSearchService = Objects.requireNonNull(projectSemanticDataSearchService);
this.librarySearchService = Objects.requireNonNull(librarySearchService);
this.sysonLibraryDependencyCollector = Objects.requireNonNull(sysonLibraryDependencyCollector);
this.projectSearchService = Objects.requireNonNull(projectSearchService);
this.sysONSysMLLibraryPublisher = Objects.requireNonNull(sysONSysMLLibraryPublisher);
}

@Override
Expand All @@ -107,147 +66,14 @@ public IPayload handle(final PublishLibrariesInput input) {
return this.projectSearchService.findById(input.projectId())
.map(project -> this.projectSemanticDataSearchService.findByProjectId(AggregateReference.to(input.projectId()))
.flatMap(projectSemanticData -> this.editingContextSearchService.findById(projectSemanticData.getSemanticData().getId().toString()))
.filter(IEMFEditingContext.class::isInstance)
.map(IEMFEditingContext.class::cast)
.map(editingContext -> this.handle(input, project, editingContext.getDomain().getResourceSet()))
.orElseGet(() -> new ErrorPayload(input.id(),
List.of(new Message("Could not find the editing context of project '%s'.".formatted(project.getName()), MessageLevel.ERROR)))))
.map(editingContext -> this.sysONSysMLLibraryPublisher.publish(
input,
editingContext,
project.getId(),
project.getName(),
input.version(),
input.description()))
.orElseGet(() -> new ErrorPayload(input.id(), List.of(new Message("Could not find the editing context of project '%s'.".formatted(project.getName()), MessageLevel.ERROR)))))
.orElseGet(() -> new ErrorPayload(input.id(), List.of(new Message("Could not find project with ID '%s'.".formatted(input.projectId()), MessageLevel.ERROR))));
}

protected IPayload handle(final PublishLibrariesInput input, final Project project, final ResourceSet resourceSet) {
final IPayload result;

final String libraryName = project.getName();
final String libraryVersion = input.version();

if (this.librarySearchService.findByNamespaceAndNameAndVersion(project.getId(), libraryName, libraryVersion).isPresent()) {
// There is already a Library from our namespace with that name and version.
result = new ErrorPayload(input.id(),
List.of(new Message("Library '%s' (version '%s') already exists in namespace '%s'.".formatted(libraryName, libraryVersion, project.getId()), MessageLevel.ERROR)));
} else {
final Set<Resource> resourcesToPublish = this.getProperSysMLRootContents(resourceSet);
if (!resourcesToPublish.isEmpty()) {
DependencyGraph<Resource> dependencyGraph = this.sysonLibraryDependencyCollector.collectDependencies(resourceSet);

List<AggregateReference<SemanticData, UUID>> dependencies = this.getDependencies(dependencyGraph, resourcesToPublish);

final Optional<SemanticData> maybePublishedLibrarySemanticData = this.publishAsLibrary(input, resourcesToPublish, libraryName, libraryVersion, dependencies);
// After this transaction is done, SysONLibraryPublicationListener reacts by also creating the
// associated Library metadata.

result = maybePublishedLibrarySemanticData
.map(publishedLibrary -> (IPayload) new SuccessPayload(input.id(),
List.of(new Message(
"Successfully published the SysML contents of project '%s' as version '%s' of library '%s'.".formatted(project.getName(),
libraryVersion,
libraryName),
MessageLevel.SUCCESS))))
.orElseGet(
() -> new ErrorPayload(input.id(),
List.of(new Message("Failed to publish the SysML contents of project '%s' as a library.".formatted(project.getName(), project.getId()),
MessageLevel.ERROR))));
} else {
result = new ErrorPayload(input.id(),
List.of(new Message("There are no SysML contents in project '%s' to publish as library.".formatted(project.getName()), MessageLevel.ERROR)));
}
}
return result;
}

private List<AggregateReference<SemanticData, UUID>> getDependencies(DependencyGraph<Resource> dependencyGraph, final Set<Resource> resourcesToPublish) {
List<AggregateReference<SemanticData, UUID>> dependencies = new ArrayList<>();

for (Resource resourceToPublish : resourcesToPublish) {
for (Resource dependencyCandidate : dependencyGraph.getDependencies(resourceToPublish)) {
Optional<LibraryMetadataAdapter> optionalLibraryMetadata = dependencyCandidate.eAdapters().stream()
.filter(LibraryMetadataAdapter.class::isInstance)
.map(LibraryMetadataAdapter.class::cast)
.findFirst();
if (optionalLibraryMetadata.isPresent()) {
LibraryMetadataAdapter libraryMetadataAdapter = optionalLibraryMetadata.get();
this.librarySearchService.findByNamespaceAndNameAndVersion(libraryMetadataAdapter.getNamespace(), libraryMetadataAdapter.getName(), libraryMetadataAdapter.getVersion())
.map(Library::getSemanticData)
.ifPresentOrElse(dependencies::add, () -> LOGGER.warn("Cannot retrieve library {}:{}:{}", libraryMetadataAdapter.getNamespace(), libraryMetadataAdapter.getName(),
libraryMetadataAdapter.getVersion()));
}
// Ignore the resource if it isn't a library: all non-library resources are published in a single
// library in SysON.
}
}
return dependencies.stream()
.distinct()
.toList();
}

protected Optional<SemanticData> publishAsLibrary(final ICause parentCause, final Set<Resource> resources, final String name, final String version,
final List<AggregateReference<SemanticData, UUID>> dependencies) {
final ICause cause = new SysONPublishedLibrarySemanticDataCreationRequested(parentCause, name);
// Remove the imported flag on the resource: the resource is now a library, and its read-only/read-write nature
// should be determined by its import kind (reference or copy), and not whether it was imported from a textual
// SysML file in the first place.
resources.forEach(resource -> ElementUtil.setIsImported(resource, false));
return this.createSemanticData(cause, resources, dependencies);
}

protected Optional<SemanticData> createSemanticData(final ICause event, final Collection<Resource> resources, final List<AggregateReference<SemanticData, UUID>> dependencies) {
final List<DocumentData> documentDatas = resources.stream()
.map(resource -> this.resourceToDocumentService.toDocument(resource, false))
.filter(Optional::isPresent)
.map(Optional::get)
.toList();
final List<Document> documents = documentDatas.stream()
.map(DocumentData::document)
.toList();
final List<String> domains = documentDatas.stream()
.map(DocumentData::ePackageEntries)
.flatMap(List::stream)
.map(EPackageEntry::nsURI)
.distinct()
.toList();

final IResult<SemanticData> creationResult = this.semanticDataCreationService.create(event, documents, domains, dependencies);
if (creationResult instanceof Success<SemanticData> creationSuccess) {
return Optional.ofNullable(creationSuccess.data());
} else {
return Optional.empty();
}
}

protected Set<Resource> getProperSysMLRootContents(final ResourceSet resourceSet) {
Objects.requireNonNull(resourceSet);

final List<Resource> dependencies = this.getDependenciesToPublishedLibraries(resourceSet);
return resourceSet.getResources().stream()
.filter(resource -> !dependencies.contains(resource))
.collect(Collectors.toSet());
}

protected List<Resource> getDependenciesToPublishedLibraries(ResourceSet resourceSet) {
return resourceSet.getResources().stream()
.filter(resource -> this.getLibraryMetadata(resource).isPresent()
|| resource.getURI().scheme().equals(ElementUtil.KERML_LIBRARY_SCHEME)
|| resource.getURI().scheme().equals(ElementUtil.SYSML_LIBRARY_SCHEME))
.toList();
}

protected Optional<LibraryMetadataAdapter> getLibraryMetadata(final Resource resource) {
return resource.eAdapters().stream()
.filter(LibraryMetadataAdapter.class::isInstance)
.map(LibraryMetadataAdapter.class::cast)
.findFirst();
}

protected boolean isSysmlContent(final EObject rootEObject) {
return rootEObject.eClass().getEPackage() == SysmlPackage.eINSTANCE;
}

protected String getResourceName(final Resource resource) {
return resource.eAdapters().stream()
.filter(ResourceMetadataAdapter.class::isInstance)
.map(ResourceMetadataAdapter.class::cast)
.map(ResourceMetadataAdapter::getName)
.findFirst()
.orElse(null);
}
}
12 changes: 5 additions & 7 deletions .../main/java/org/eclipse/syson/application/publication/SysONLibraryPublicationListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2025 Obeo.
* Copyright (c) 2025, 2026 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
Expand All @@ -14,7 +14,6 @@

import java.util.Objects;

import org.eclipse.sirius.web.application.library.dto.PublishLibrariesInput;
import org.eclipse.sirius.web.domain.boundedcontexts.library.Library;
import org.eclipse.sirius.web.domain.boundedcontexts.library.services.api.ILibraryCreationService;
import org.eclipse.sirius.web.domain.boundedcontexts.semanticdata.SemanticData;
Expand Down Expand Up @@ -42,16 +41,15 @@ public SysONLibraryPublicationListener(final ILibraryCreationService libraryCrea
@Transactional(propagation = Propagation.REQUIRES_NEW)
@TransactionalEventListener
public void onSemanticDataCreatedEvent(final SemanticDataCreatedEvent semanticDataCreatedEvent) {
if (semanticDataCreatedEvent.causedBy() instanceof SysONPublishedLibrarySemanticDataCreationRequested request
&& request.causedBy() instanceof PublishLibrariesInput publishLibrariesInput) {
if (semanticDataCreatedEvent.causedBy() instanceof SysONPublishedLibrarySemanticDataCreationRequested request) {
final SemanticData createdSemanticData = semanticDataCreatedEvent.semanticData();

final Library createdLibrary = Library.newLibrary()
.namespace(publishLibrariesInput.projectId())
.namespace(request.libraryNamespace())
.name(request.libraryName())
.version(request.libraryVersion())
.description(request.libraryDescription())
.semanticData(AggregateReference.to(createdSemanticData.getId()))
.version(publishLibrariesInput.version())
.description(publishLibrariesInput.description())
.build(semanticDataCreatedEvent);
this.libraryCreationService.createLibrary(createdLibrary);
}
Expand Down
15 changes: 11 additions & 4 deletions ...pse/syson/application/publication/SysONPublishedLibrarySemanticDataCreationRequested.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2025 Obeo.
* Copyright (c) 2025, 2026 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
Expand Down Expand Up @@ -27,16 +27,23 @@
public record SysONPublishedLibrarySemanticDataCreationRequested(
UUID id,
ICause causedBy,
String libraryName) implements ICause {
String libraryNamespace,
String libraryName,
String libraryVersion,
String libraryDescription) implements ICause {

public SysONPublishedLibrarySemanticDataCreationRequested(final ICause cause, final String libraryName) {
this(UUID.randomUUID(), cause, libraryName);
public SysONPublishedLibrarySemanticDataCreationRequested(final ICause cause, final String libraryNamespace, final String libraryName, final String libraryVersion,
final String libraryDescription) {
this(UUID.randomUUID(), cause, libraryNamespace, libraryName, libraryVersion, libraryDescription);
}

public SysONPublishedLibrarySemanticDataCreationRequested {
Objects.requireNonNull(id);
Objects.requireNonNull(causedBy);
Objects.requireNonNull(libraryNamespace);
Objects.requireNonNull(libraryName);
Objects.requireNonNull(libraryVersion);
Objects.requireNonNull(libraryDescription);
}

}
Loading
Loading