Skip to content

[1.x] Allow to detect Entities which no longer match subscription criteria #1504

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

Jump to bottom
Merged
merged 23 commits into from
Mar 6, 2023
Merged

[1.x] Allow to detect Entities which no longer match subscription criteria #1504

merged 23 commits into from
Mar 6, 2023

Conversation

@armiol
Copy link
Contributor

@armiol armiol commented Mar 6, 2023 •
edited
Loading

This changeset adds an ability to subscribe to changes in Entity states, which make them no longer matching the subscription criteria.

In particular, this will always be the case if Entity becomes archived or deleted.

The new endpoint is available for Spine client under whenNoLongerMatching() DSL, and is a part of Client's request API:

    Client client = client();
    client
        /* ... */
        .subscribeTo(Task.class)
        .observe((task) -> { /* ... */ })
        .whenNoLongerMatching(TaskId.class, (idOfNonMatchingEntity) -> { /* ... */})
        .post();

These changes will also become available to other clients (such as web-related client), once this PR is merged.

The library version is now set to 1.9.0-SNAPSHOT.10.

armiol added 13 commits February 7, 2023 15:43
@armiol
Bump the version to 1.9.0-SNAPSHOT.10.
5120156
@armiol
Begin handling EntityDeleted in scope of subscription updates.
03a47b0
@armiol
Choose proper UpdateHandler according to the type URL of the incomi…
c9c26b9 
…ng event.
@armiol
Collapse some if statements, but not all (go fish, PMD).
b815997
@armiol
Update the report files.
5670172
@armiol
Handle EntityArchived, EntityRestored, and EntityUnarchived in …
e75fd43 
…respect to the existing `Subscription`s.
@armiol
Add the definitions to allow changing the TaskAggregate lifecycle f…
92c1095 
…lags.

Rename the test definitions to make it specific to `Client` tests. Adjust the destination packages for commands and events.
@armiol
Move TaskAggregate under .given.
fbe0473 
Handle lifecycle-changing commands.
@armiol
Rename the test according to the convention.
e6b6070 
Migrate to the recently updated domain language. Extract bits to the corresponding `...TestEnv`.
@armiol
Update the import statement.
5d0a3d6
@armiol
Test the Client's subscription API behaviour in respect to deleting…
74a634b 
…/restoring and archiving/unarchiving.
@armiol
Improve the documentation.
35eee6b
@armiol
Squeeze in an ability to subscribe to noLongerMatching case in `Ent…
61b6470 
…ity` updates.
@armiol armiol self-assigned this Mar 6, 2023
@armiol armiol marked this pull request as ready for review March 6, 2023 13:54
@armiol
Copy link
Contributor Author

armiol commented Mar 6, 2023

@alexander-yevsyukov @dmdashenkov PTAL.

dmdashenkov
dmdashenkov approved these changes Mar 6, 2023
View reviewed changes
Copy link
Contributor

@dmdashenkov dmdashenkov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with a couple of minor suggestions.

client/src/main/java/io/spine/client/SubscriptionRequest.java Outdated

@Override
protected Optional<StreamObserver<SubscriptionUpdate>> chain() {
if(null == nlmConsumer) {
Copy link
Contributor

@dmdashenkov dmdashenkov Mar 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if(null == nlmConsumer) {
if (null == nlmConsumer) {

server/src/main/java/io/spine/server/stand/EntityRemovalHandler.java Outdated
/**
* Handles the {@link EntityDeleted} events in respect to the {@code Subscription}.
*/
final class EntityRemovalHandler extends NoLongerMatchingHandler {
Copy link
Contributor

@dmdashenkov dmdashenkov Mar 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

EntityDeletionHandler?

@armiol armiol merged commit c8c159e into 1.x-dev Mar 6, 2023
@armiol armiol deleted the 1.x-support-entity-removals-subscriptions branch March 6, 2023 15:08
@armiol armiol mentioned this pull request Mar 6, 2023
Merged
@armiol armiol mentioned this pull request Jun 4, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alexander-yevsyukov alexander-yevsyukov Awaiting requested review from alexander-yevsyukov

1 more reviewer

@dmdashenkov dmdashenkov dmdashenkov approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@armiol armiol

Labels

None yet

Projects

No open projects
v1.9
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@armiol @dmdashenkov