Add rule for coordination between services of different contexts #348

mLeveIST · 2023-09-15T18:24:48Z

Overview

This change provides a way to represent coordination between services of different contexts, with the addition of a Coordination rule in the Application and Process Layer of Bounded Contexts. Example in CML:

ContextMap TestMap {
    contains ContextA
    contains ContextB

    ContextA <- ContextB
}

BoundedContext ContextA {
    Application {
        Coordination CoordinationA {
            ContextA::ServiceA::stepA;
            ContextB::ServiceB::stepB;
        }

        Service ServiceA {
            void stepA();
        }
    }
}

BoundedContext ContextB {
    Application {
        Service ServiceB {
            void stepB();
        }
    }
}

A Coordination can be visualised in a BPMN diagram with Sketch Miner, where each context will be represented as a different actor, and each operation as a task. The example above generates the following code:

ContextA: service ServiceA.stepA
ContextB: service ServiceB.stepB

Motivation

The main drive for this rule is to be able to model in CML processes that span multiple Bounded Contexts, like Sagas. CML does already provides a Flow rule to model processes, but these processes are restricted to a single Bounded Context and the rule has a focus on modelling Event/Command flows for Event Storming.

Technical Details

The following sections specify details on the implementation of the rule.

Validation

Since the steps of a coordination are composed of references to other rules, the following verifications are done to avoid ambiguity when pinpointing the step operation:

A reference to an outer context must be reachable by Context Map relationships
A reference to a service must originate from an Application Layer Service
A reference to an operation should be unique within the service

IDE integration

The following features were implemented for the IDE when writing in CML:

Formatting for the rule
Step wise visualisation of validation errors
BPMN Sketch Miner diagram code generation
Quick-fix to generate and open a Coordination in BPMN Sketch Miner website

add mappings between bounded contexts

- Remove 'sagaOrchestrator' - Refactor step '.' to '::'

- Fix wrong reference to validator file in generator - Update validation logic and messages - Remove scope reduction

- Add sketchminer generator - Add generator tests

codecov · 2023-09-18T06:09:13Z

Codecov Report

Merging #348 (59f7924) into master (314b9ca) will decrease coverage by 0.4%.
The diff coverage is 77.6%.

@@            Coverage Diff             @@
##             master    #348     +/-   ##
==========================================
- Coverage      93.0%   92.6%   -0.4%     
- Complexity     2354    2406     +52     
==========================================
  Files           204     209      +5     
  Lines          6344    6490    +146     
  Branches        851     875     +24     
==========================================
+ Hits           5902    6016    +114     
- Misses          214     225     +11     
- Partials        228     249     +21

Files	Coverage Δ
...ntextmapper/dsl/ide/actions/CMLActionRegistry.java	`86.0% <100.0%> (+0.1%)`	⬆️
...pl/OpenCoordinationInSketchMinerCommandMapper.java	`100.0% <100.0%> (ø)`
...etchminer/SketchMinerCoordinationModelCreator.java	`100.0% <100.0%> (ø)`
.../generator/sketchminer/SketchMinerLinkCreator.java	`100.0% <100.0%> (ø)`
...tchminer/converter/SimplifiedCoordinationStep.java	`100.0% <100.0%> (ø)`
...rg/contextmapper/dsl/scoping/CMLScopingHelper.java	`72.0% <ø> (ø)`
...ntextmapper/dsl/validation/ValidationMessages.java	`0.0% <ø> (ø)`
...textmapper/dsl/validation/UniquenessValidator.java	`83.5% <85.7%> (+0.1%)`	⬆️
...r/converter/Coordination2SketchMinerConverter.java	`87.0% <87.0%> (ø)`
...textmapper/dsl/generator/SketchMinerGenerator.java	`69.2% <50.0%> (-4.5%)`	⬇️
... and 2 more

stefan-ka · 2023-09-18T06:16:51Z

Thanks for creating the PR @mLeveIST ;)
I will probably need a few days until you get a response (review comments)...
Best regards,
Stefan

stefan-ka

Hi @mLeveIST

I have a few small comments (only code-level details), but overall this is very good work 👌 Looking forward to merge it 😊

Can you maybe have a look at the comments? If something is not clear I can help or we discuss it in a short meeting. Another thing we have to prepare is documentation on the website (repo: https://github.com/ContextMapper/contextmapper.github.io).

Best regards,
Stefan

...org/contextmapper/dsl/ide/tests/quickfixes/OpenCoordinationInBPMNSketchMinerActionTest.xtend

stefan-ka · 2023-10-10T07:51:37Z

...r.dsl.tests/src/org/contextmapper/dsl/generators/sketchminer/SketchMinerLinkCreatorTest.java

+
+	@Test
+	@DisabledOnOs(OS.WINDOWS)
+	public void canCreateSketchMinerLinkForCoordinationModelUnix() throws IOException {


We should also add these tests for Windows. Do you have a Windows machine to test it? Otherwise I can do that...

Unfortunately I could not test it on a Windows :(

org.contextmapper.dsl.tests/src/org/contextmapper/dsl/ApplicationLayerDSLParsingTest.xtend

org.contextmapper.dsl/src/org/contextmapper/dsl/cml/CMLModelObjectsResolvingHelper.java

...pper.dsl/src/org/contextmapper/dsl/validation/ApplicationCoordinationSemanticsValidator.java

mLeveIST · 2023-10-10T16:12:50Z

Hello Stefan,

Thank you for the review!
I will tag you once I have addressed the comments :)

Best regards,
Miguel

mLeveIST · 2023-10-11T10:54:29Z

Hello @stefan-ka,

I added most of the changes you requested, just missing the test for the Windows machine...
I also added some additional tests for the code coverage.

Regarding the documentation, can this be added to the Application and Process Layer page?

If you have the time this or next week, I wouldn't mind having a small meeting to discuss the results of Coordinations as is, and if you think it is worthwhile to expand upon it in the future (having the type of coordination, the synchronicity of the steps, if they can relate to flows).

Best regards,
Miguel

stefan-ka · 2023-10-11T12:18:24Z

Hi @mLeveIST

Thank you! I will try to do the tests on Windows... I will come back to you regarding a meeting. Probably next week earliest.

Best regards,
Stefan

stefan-ka · 2023-10-12T16:09:22Z

Sorry @mLeveIST, I forgot to answer your question regarding documentation.

I would say, yes. Or create a new page but then we have to link it on the application layer page.

Best regards,
Stefan

stefan-ka · 2023-10-12T17:40:35Z

Hi @mLeveIST

I just realized that we have many other issues with unit tests on Windows 🫣
I suggest we fix that we a separate PR later. I have to fix several other tests to run on Windows...

From my point of view we can then merge it. But lets give @socadk a chance to test the new feature as well.

We'll come back to you.

Best regards,
Stefan

stefan-ka · 2023-11-14T08:22:54Z

Hi @mLeveIST

We tested your feature and it looks good from our side, so I merged it right now :)
We'll have to see when we will make the next Context Mapper release; hopefully we can publish one by the end of this year.

Were you already able to do something regarding documentation? ;) I can also put it on my own TODO-list, but I think it would be good if you could do it; also to provide proper background information.

Best regards,
Stefan

mLeveIST · 2023-11-16T15:09:19Z

Hi @stefan-ka,

Thank you for the update! That's great to know.
Regarding documentation, I'll have a pull request for it and also the examples repo soon, most likely sometime next week if that's ok.

Best regards,
Miguel

stefan-ka · 2023-11-16T15:13:00Z

Perfect, thanks @mLeveIST!

mLeveIST and others added 20 commits July 5, 2023 18:45

chore: update gitignore

45bb0bc

add mappings between bounded contexts

2719cf7

fix

9f0f718

define mappings directly

076274a

Add functionality representation in CML

e8efcd9

Merge pull request #1 from socialsoftware/feature/add-mappings

c756755

add mappings between bounded contexts

Merge branch 'develop' into feature/cml-saga-concept

067e844

fix functionality step validation

e6ec8a9

Add ';' to end of functionality step syntax

589bc05

Add scope reduction for functionality steps

1e256d2

Add format rules for functionalities

b2a3164

Remove 'uses' syntax from branch

1b78af6

Refactor term 'Functionality' to 'Coordination'

2d156f1

- Remove 'sagaOrchestrator' - Refactor step '.' to '::'

Refactor Coordination validation

716052d

- Fix wrong reference to validator file in generator - Update validation logic and messages - Remove scope reduction

Add CML tests for Coordination construct

7a86561

Add BPMN generator for Coordinations

f596f76

- Add sketchminer generator - Add generator tests

Add Coordination sketchminer converter

fc38a85

Fix "::" notation conflict with sketchminer syntax

533522e

Add quickfix to open Coordination in skechminer

25916d2

Merge branch 'master' into feature/cml-saga-concept

384a52a

stefan-ka requested changes Oct 10, 2023

View reviewed changes

mLeveIST added 5 commits October 10, 2023 17:50

Fix copyright notice year on new classes

c7a58c3

Remove excess of new lines

b9176d1

Fix possible resolving of unrelated upstream BCs

50804fa

Split coordination validator into multiple checks

128a066

Add additional tests

59f7924

stefan-ka merged commit cc42f8d into ContextMapper:master Nov 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add rule for coordination between services of different contexts #348

Add rule for coordination between services of different contexts #348

mLeveIST commented Sep 15, 2023

codecov bot commented Sep 18, 2023 •

edited

Loading

stefan-ka commented Sep 18, 2023

stefan-ka left a comment

stefan-ka Oct 10, 2023

mLeveIST Oct 11, 2023

mLeveIST commented Oct 10, 2023

mLeveIST commented Oct 11, 2023

stefan-ka commented Oct 11, 2023

stefan-ka commented Oct 12, 2023

stefan-ka commented Oct 12, 2023

stefan-ka commented Nov 14, 2023

mLeveIST commented Nov 16, 2023

stefan-ka commented Nov 16, 2023

Add rule for coordination between services of different contexts #348

Add rule for coordination between services of different contexts #348

Conversation

mLeveIST commented Sep 15, 2023

Overview

Motivation

Technical Details

Validation

IDE integration

codecov bot commented Sep 18, 2023 • edited Loading

Codecov Report

stefan-ka commented Sep 18, 2023

stefan-ka left a comment

Choose a reason for hiding this comment

stefan-ka Oct 10, 2023

Choose a reason for hiding this comment

mLeveIST Oct 11, 2023

Choose a reason for hiding this comment

mLeveIST commented Oct 10, 2023

mLeveIST commented Oct 11, 2023

stefan-ka commented Oct 11, 2023

stefan-ka commented Oct 12, 2023

stefan-ka commented Oct 12, 2023

stefan-ka commented Nov 14, 2023

mLeveIST commented Nov 16, 2023

stefan-ka commented Nov 16, 2023

codecov bot commented Sep 18, 2023 •

edited

Loading