Skip to content
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.

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

First rewrite of the uSubscription spec #238

Merged
merged 2 commits into from
Nov 25, 2024
Merged

Conversation

AnotherDaniel
Copy link
Contributor

@AnotherDaniel AnotherDaniel commented Sep 10, 2024

Restructuring and partial rewrite of this spec; specific focus on:

  • more detailed explanations of concepts like remote subscriptions
  • migrate diagrams into embedded mermaid
  • add OFT-style requirements markers

@AnotherDaniel AnotherDaniel added the documentation Improvements or additions to documentation label Sep 10, 2024
@AnotherDaniel AnotherDaniel self-assigned this Sep 10, 2024
@sophokles73
Copy link
Contributor

sophokles73 commented Oct 31, 2024

@AnotherDaniel are you still working on this? IMHO it would be great, if these changes could make it into 1.6.0 ...

@AnotherDaniel
Copy link
Contributor Author

Yes, still on it, or rather back on it after many weeks of "distractions"... let me see where I've left this...

@sophokles73
Copy link
Contributor

@AnotherDaniel it is very, very hard to keep track of the changes when you force push changes, because it removes all of my original comments from the diff view :-(

@AnotherDaniel
Copy link
Contributor Author

AnotherDaniel commented Nov 5, 2024

Sorry for that - I rebased on current main, didn't realise that would break the diff view. Won't do that again.

Essentially, I accepted all your suggestions, plus I pulled in new requirements to cover all methods from the usubscription.proto definition, new ones to be found in the "Subscription" and "Reset" sections.

Copy link
Contributor

@sophokles73 sophokles73 left a comment

Choose a reason for hiding this comment

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

I have made some comments on the Subscribe operation which should also apply to the other operations accordingly.
In general, the spec item IDs should probably better contain usubscription instead of usubscribe, e.g. dsn~usubscription-... instead of dsn~usubscribe-....

@AnotherDaniel
Copy link
Contributor Author

Let me know if you're reasonably happy with this iteration, then I'll squash the commits to prep for merge.

Copy link
Contributor

@sophokles73 sophokles73 left a comment

Choose a reason for hiding this comment

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

I still do not see any value in splitting up the different types of invalid topic UUris ... my proposal could be applied to all operation specs.
But if you feel that this is necessary, then please go ahead and merge.

Copy link
Contributor

@sophokles73 sophokles73 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@stevenhartley stevenhartley left a comment

Choose a reason for hiding this comment

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

A number of comments.

@AnotherDaniel
Copy link
Contributor Author

Many small and medium changes to address review feedback. Pls have another look @stevenhartley and @sophokles73

Copy link
Contributor

@sophokles73 sophokles73 left a comment

Choose a reason for hiding this comment

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

LGTM

@sophokles73 sophokles73 added this to the v1.6.0-alpha.4 milestone Nov 14, 2024
@sophokles73
Copy link
Contributor

@stevenhartley would you mind taking another look? Your approval is required before we can merge this PR ...

Copy link
Contributor

@stevenhartley stevenhartley left a comment

Choose a reason for hiding this comment

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

@AnotherDaniel , I don't understand why the sequence diagrams shows another lifeline for the SubscriptionChange, this notification is sent to the uApp so it is clearer if you show a different line type to mean notification vs RPC as it is a message sent to uApp (per the old diagrams). Also the colors are hard to see in dark mode (the lines are grey), I think you can set the line color to be black.

image

Copy link
Contributor

@stevenhartley stevenhartley left a comment

Choose a reason for hiding this comment

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

Please also rebase as you seem to have accidentally pulled in other things on main on this PR

Pull notification fixes into every diagram
Copy link
Contributor

@stevenhartley stevenhartley left a comment

Choose a reason for hiding this comment

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

Last comment @AnotherDaniel , can you add a legend that explains the arrows (ex. this is a RPC request vs response, vs publish, vs notification)? Thank you

Copy link
Contributor

@stevenhartley stevenhartley left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for your patience @AnotherDaniel

@stevenhartley stevenhartley merged commit fec4ce9 into main Nov 25, 2024
1 check passed
@AnotherDaniel AnotherDaniel deleted the rework_usubscription branch November 25, 2024 16:02
@AnotherDaniel
Copy link
Contributor Author

Yay, this was a long time coming! ;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants