Skip to content

Commit

Permalink
[3669] Add migration participant to hide label borders by default
Browse files Browse the repository at this point in the history 
Bug: #3669
Signed-off-by: Florian ROUËNÉ <[email protected]>
  • Loading branch information
@frouene
frouene committed Jul 1, 2024
1 parent e9a515e commit a6ee1ba
Show file tree
Hide file tree
Showing 6 changed files with 592 additions and 70 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ image:doc/screenshots/insideLabelPositions.png[Inside label positions, 70%]
- https://github.com/eclipse-sirius/sirius-web/issues/3645[#3645] [core] Revert earlier change made in #3595 which caused regressions
- https://github.com/eclipse-sirius/sirius-web/issues/3651[#3651] [diagram] Improve performances when interacting with the diagram, especially when dragging a node
- https://github.com/eclipse-sirius/sirius-web/issues/3641[#3641] [core] Do not fetch representation content when we only need the metadata

- https://github.com/eclipse-sirius/sirius-web/issues/3669[#3669] [diagram] Add migration participant to hide label borders by default

== v2024.5.0

Expand Down
55 changes: 55 additions & 0 deletions ...ditingcontext/migration/participants/DiagramLabelStyleBorderSizeMigrationParticipant.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
/*******************************************************************************
* Copyright (c) 2024 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.editingcontext.migration.participants;

import com.google.gson.JsonObject;

import java.util.Optional;

import org.eclipse.emf.ecore.EObject;
import org.eclipse.sirius.components.emf.migration.api.IMigrationParticipant;
import org.eclipse.sirius.components.view.diagram.EdgeDescription;
import org.eclipse.sirius.components.view.diagram.NodeDescription;
import org.springframework.stereotype.Service;

/**
* MigrationParticipant that update the BorderStyle of NodeLabelStyle.
*
* @author mcharfadi
*/
@Service
public class DiagramLabelStyleBorderSizeMigrationParticipant implements IMigrationParticipant {

private static final String PARTICIPANT_VERSION = "2024.7.0-202407011045";

@Override
public String getVersion() {
return PARTICIPANT_VERSION;
}

@Override
public void postObjectLoading(EObject eObject, JsonObject jsonObject) {
if (eObject instanceof NodeDescription nodeDescription) {
var optionalNodeDescriptionData = Optional.ofNullable(jsonObject.getAsJsonObject("data"));
optionalNodeDescriptionData.ifPresent(nodeDescriptionData -> {
var optionalInsideLabel = Optional.ofNullable(nodeDescriptionData.get("insideLabel"));
optionalInsideLabel.ifPresent(insideLabel -> nodeDescription.getInsideLabel().getStyle().setBorderSize(0));
var optionalOutsideLabels = Optional.ofNullable(nodeDescriptionData.get("outsideLabels"));
optionalOutsideLabels.ifPresent(outsideLabels -> nodeDescription.getOutsideLabels().forEach(outsideLabelDescription -> outsideLabelDescription.getStyle().setBorderSize(0)));
});
} else if (eObject instanceof EdgeDescription edgeDescription) {
var optionalEdgeDescriptionData = Optional.ofNullable(jsonObject.getAsJsonObject("data"));
optionalEdgeDescriptionData.ifPresent(edgeDescriptionData -> edgeDescription.getStyle().setBorderSize(0));
}
}
}
4 changes: 4 additions & 0 deletions ...eb/backend/sirius-web/src/test/java/org/eclipse/sirius/web/data/MigrationIdentifiers.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ public final class MigrationIdentifiers {

public static final UUID MIGRATION_STUDIO_DIAGRAM_HIERARCHY = UUID.fromString("35f1cd7b-e5bb-443d-95ef-bab372a92b0f");

public static final UUID MIGRATION_DIAGRAM_LABEL_STYLE_BORDER_SIZE_STUDIO = UUID.fromString("8ce6147e-1f5b-426f-b1be-dfeabd37a50a");

public static final String MIGRATION_DIAGRAM_LABEL_STYLE_BORDER_SIZE_STUDIO_DIAGRAM = "DiagramLabelStyle#borderSize migration";

private MigrationIdentifiers() {
// Prevent instantiation
}
Expand Down
281 changes: 281 additions & 0 deletions ...e/sirius/web/services/migration/DiagramLabelStyleBorderSizeMigrationParticipantTests.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,281 @@
/*******************************************************************************
* Copyright (c) 2024 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.services.migration;

import static org.assertj.core.api.Assertions.assertThat;

import com.jayway.jsonpath.JsonPath;

import java.io.ByteArrayInputStream;
import java.nio.charset.StandardCharsets;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import java.util.UUID;
import java.util.function.BiFunction;
import java.util.function.Predicate;

import org.eclipse.sirius.components.core.api.IEditingContext;
import org.eclipse.sirius.components.core.api.IEditingContextSearchService;
import org.eclipse.sirius.components.core.api.IInput;
import org.eclipse.sirius.components.core.api.IPayload;
import org.eclipse.sirius.components.emf.ResourceMetadataAdapter;
import org.eclipse.sirius.components.emf.migration.api.IMigrationParticipant;
import org.eclipse.sirius.components.emf.migration.api.MigrationData;
import org.eclipse.sirius.components.graphql.api.UploadFile;
import org.eclipse.sirius.components.graphql.tests.ExecuteEditingContextFunctionInput;
import org.eclipse.sirius.components.graphql.tests.ExecuteEditingContextFunctionRunner;
import org.eclipse.sirius.components.graphql.tests.ExecuteEditingContextFunctionSuccessPayload;
import org.eclipse.sirius.components.view.diagram.DiagramDescription;
import org.eclipse.sirius.web.AbstractIntegrationTests;
import org.eclipse.sirius.web.application.document.dto.UploadDocumentInput;
import org.eclipse.sirius.web.application.document.dto.UploadDocumentSuccessPayload;
import org.eclipse.sirius.web.application.editingcontext.EditingContext;
import org.eclipse.sirius.web.data.MigrationIdentifiers;
import org.eclipse.sirius.web.tests.graphql.UploadDocumentMutationRunner;
import org.eclipse.sirius.web.tests.services.api.IGivenCommittedTransaction;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.jdbc.Sql;
import org.springframework.test.context.jdbc.SqlConfig;
import org.springframework.test.context.transaction.TestTransaction;
import org.springframework.transaction.annotation.Transactional;

import reactor.test.StepVerifier;

/**
* Integration tests of DiagramLabelStyleBorderSizeMigrationParticipant.
*
* @author frouene
*/
@Transactional
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class DiagramLabelStyleBorderSizeMigrationParticipantTests extends AbstractIntegrationTests {

@Autowired
private IEditingContextSearchService editingContextSearchService;

@Autowired
private IGivenCommittedTransaction givenCommittedTransaction;

@Autowired
private ExecuteEditingContextFunctionRunner executeEditingContextFunctionRunner;

@Autowired
private UploadDocumentMutationRunner uploadDocumentMutationRunner;

@Autowired
private List<IMigrationParticipant> migrationParticipants;

@Test
@DisplayName("Given a project with an old model, DiagramLabelStyleBorderSizeMigrationParticipant migrates the model correctly")
@Sql(scripts = { "/scripts/migration.sql" }, executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD)
@Sql(scripts = { "/scripts/cleanup.sql" }, executionPhase = Sql.ExecutionPhase.AFTER_TEST_METHOD, config = @SqlConfig(transactionMode = SqlConfig.TransactionMode.ISOLATED))
public void givenAnOldModelMigrationParticipantCanBeContributedToUpdateTheModel() {
var optionalEditingContext = this.editingContextSearchService.findById(MigrationIdentifiers.MIGRATION_DIAGRAM_LABEL_STYLE_BORDER_SIZE_STUDIO.toString());
assertThat(optionalEditingContext).isPresent();
this.testIsMigrationSuccessful(optionalEditingContext.get());
}

@Test
@DisplayName("Given an uploaded project with an old model, DiagramLabelStyleBorderSizeMigrationParticipant migrates the model correctly")
@Sql(scripts = { "/scripts/migration.sql" }, executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD)
@Sql(scripts = { "/scripts/cleanup.sql" }, executionPhase = Sql.ExecutionPhase.AFTER_TEST_METHOD, config = @SqlConfig(transactionMode = SqlConfig.TransactionMode.ISOLATED))
public void givenAnOldViewDiagramMigrationServiceIsExecutedProperly() {
var content = """
{
"json": { "version": "1.0", "encoding": "utf-8" },
"ns": {
"diagram": "http://www.eclipse.org/sirius-web/diagram",
"view": "http://www.eclipse.org/sirius-web/view"
},
"content": [
{
"id": "9674f8f7-ff1a-4061-bb32-a4a235a9c2ca",
"eClass": "view:View",
"data": {
"descriptions": [
{
"id": "c1a0ae1c-8420-4aa7-b443-1a05044076e2",
"eClass": "diagram:DiagramDescription",
"data": {
"name": "DiagramLabelStyle#borderSize migration",
"domainType": "flow::System",
"edgeDescriptions": [
{
"data": {
"centerLabelExpression": "",
"name": "LabelBorderSize Edge",
"semanticCandidatesExpression": "",
"sourceNodeDescriptions": [
"//@descriptions.0/@nodeDescriptions.0"
],
"sourceNodesExpression": "aql:self",
"style": {
"data": {
"color": "//@colorPalettes.0/@colors.0"
},
"eClass": "diagram:EdgeStyle",
"id": "748824cb-cd5f-42fe-95a8-4f21172ba2ce"
},
"targetNodeDescriptions": [
"//@descriptions.0/@nodeDescriptions.1"
],
"targetNodesExpression": "aql:self.linkedTo"
},
"eClass": "diagram:EdgeDescription",
"id": "c1077629-a4ec-4232-8eb5-5209b58c7464"
}
],
"nodeDescriptions": [
{
"id": "4d1ec4d1-dd2c-4cb2-bbed-df02f0babbd8",
"eClass": "diagram:NodeDescription",
"data": {
"name": "LabelBorderSize migration",
"domainType": "flow::CompositeProcessor",
"insideLabel": {
"data": {
"style": {
"eClass": "diagram:InsideLabelStyle",
"id": "d70178c4-d36f-40d7-a3ab-ef8568e4ee2b"
}
},
"eClass": "diagram:InsideLabelDescription",
"id": "046b48ee-4554-4d8a-a457-5391b690d2a9"
},
"outsideLabels": [
{
"data": {
"style": {
"eClass": "diagram:OutsideLabelStyle",
"id": "c69b0853-26ab-40b0-979d-f0a4974ad865"
}
},
"eClass": "diagram:OutsideLabelDescription",
"id": "fd8638cc-8ebb-48e6-bf3f-2c09206f6a09"
},
{
"data": {
"style": {
"eClass": "diagram:OutsideLabelStyle",
"id": "601e5a1d-3d8a-49bc-96b9-f0c47ee594ee"
}
},
"eClass": "diagram:OutsideLabelDescription",
"id": "a8a2bf4c-82b7-4050-b4e7-09fd26a2f7c0"
}
],
"childrenLayoutStrategy": {
"id": "558f8558-bee6-4ae9-8dc7-4344efe2b83e",
"eClass": "diagram:FreeFormLayoutStrategyDescription"
},
"style": {
"data": {
"background": "//@colorPalettes.0/@colors.0",
"borderColor": "//@colorPalettes.0/@colors.0"
},
"eClass": "diagram:RectangularNodeStyleDescription",
"id": "dacddb12-7c2c-4463-bf71-a7c3e68e2132"
}
}
}
]
}
}
]
}
}
]
}
""";
this.uploadDocument(MigrationIdentifiers.MIGRATION_DIAGRAM_LABEL_STYLE_BORDER_SIZE_STUDIO.toString(), "test_upload", content);
}

private void uploadDocument(String editingContextId, String name, String content) {
this.givenCommittedTransaction.commit();

var file = new UploadFile(name, new ByteArrayInputStream(content.getBytes(StandardCharsets.UTF_8)));
var input = new UploadDocumentInput(UUID.randomUUID(), editingContextId, file);
var result = this.uploadDocumentMutationRunner.run(input);

TestTransaction.flagForCommit();
TestTransaction.end();

String typename = JsonPath.read(result, "$.data.uploadDocument.__typename");
assertThat(typename).isEqualTo(UploadDocumentSuccessPayload.class.getSimpleName());

Predicate<IPayload> predicate = payload -> Optional.of(payload)
.filter(ExecuteEditingContextFunctionSuccessPayload.class::isInstance)
.map(ExecuteEditingContextFunctionSuccessPayload.class::cast)
.map(ExecuteEditingContextFunctionSuccessPayload::result)
.filter(Boolean.class::isInstance)
.map(Boolean.class::cast)
.orElse(false);

var optionalLastMigrationData = this.migrationParticipants.stream()
.sorted(Comparator.comparing(IMigrationParticipant::getVersion).reversed())
.map(migrationParticipant -> new MigrationData(migrationParticipant.getClass().getSimpleName(), migrationParticipant.getVersion()))
.findFirst();
assertThat(optionalLastMigrationData).isPresent();
var lastMigrationData = optionalLastMigrationData.get();

BiFunction<IEditingContext, IInput, IPayload> function = (editingContext, executeEditingContextFunctionInput) -> {
var isMigrated = Optional.of(editingContext)
.filter(EditingContext.class::isInstance)
.map(EditingContext.class::cast)
.map(siriusWebEditingContext -> siriusWebEditingContext.getViews().stream()
.anyMatch(view -> view.eResource().eAdapters().stream()
.filter(ResourceMetadataAdapter.class::isInstance)
.map(ResourceMetadataAdapter.class::cast)
.filter(resourceMetadataAdapter -> resourceMetadataAdapter.getMigrationData() != null)
.anyMatch(resourceMetadataAdapter -> resourceMetadataAdapter.getMigrationData().migrationVersion().equals(lastMigrationData.migrationVersion())
&& resourceMetadataAdapter.getMigrationData().lastMigrationPerformed().equals(lastMigrationData.lastMigrationPerformed()))
))
.orElse(false);
return new ExecuteEditingContextFunctionSuccessPayload(executeEditingContextFunctionInput.id(), isMigrated);
};

var mono = this.executeEditingContextFunctionRunner.execute(new ExecuteEditingContextFunctionInput(UUID.randomUUID(), editingContextId, function));
StepVerifier.create(mono)
.expectNextMatches(predicate)
.thenCancel()
.verify();
}

private void testIsMigrationSuccessful(IEditingContext editingContext) {
if (editingContext instanceof EditingContext siriusWebEditingContext) {
var optionalDiagramDescription = siriusWebEditingContext.getViews().stream().flatMap(view -> view.getDescriptions().stream())
.filter(representationDescription -> representationDescription.getName().equals(MigrationIdentifiers.MIGRATION_DIAGRAM_LABEL_STYLE_BORDER_SIZE_STUDIO_DIAGRAM)).findFirst();
assertThat(optionalDiagramDescription).isPresent();
assertThat(optionalDiagramDescription.get()).isInstanceOf(DiagramDescription.class);
optionalDiagramDescription.ifPresent(representationDescription -> {
if (representationDescription instanceof DiagramDescription diagramDescription) {
assertThat(diagramDescription.getNodeDescriptions()).hasSize(1);
diagramDescription.getNodeDescriptions().forEach(nodeDescription -> {
assertThat(nodeDescription.getInsideLabel().getStyle().getBorderSize()).isEqualTo(0);
assertThat(nodeDescription.getOutsideLabels()).hasSize(2);
assertThat(nodeDescription.getOutsideLabels()).allMatch(outsideLabelDescription -> outsideLabelDescription.getStyle().getBorderSize() == 0);
});
assertThat(diagramDescription.getEdgeDescriptions()).hasSize(1);
diagramDescription.getEdgeDescriptions().forEach(edgeDescription -> {
assertThat(edgeDescription.getStyle().getBorderSize()).isEqualTo(0);
});
}
});
}
}

}
Loading

0 comments on commit a6ee1ba

Please sign in to comment.