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.

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

Update to AsyncApi 3.0 #507

Merged
merged 14 commits into from
Jan 26, 2024
Merged

Update to AsyncApi 3.0 #507

merged 14 commits into from
Jan 26, 2024

Conversation

timonback
Copy link
Member

@timonback timonback commented Dec 20, 2023 •
edited
Loading

This PR + feature branch is intended to allow the migration to AsyncApi 3.0 step-by-step.

Feel free to open any PR against this feature branch (instead of the master branch).

Preview: https://deploy-preview-507--springwolf-ui.netlify.app/springwolf-ui/asyncapi-ui.html

Verification: https://studio.asyncapi.com using i.e. https://raw.githubusercontent.com/springwolf/springwolf-core/feat/asyncapi-3/springwolf-examples/springwolf-kafka-example/src/test/resources/asyncapi.json

Closes #494

@netlify Netlify
Copy link

netlify bot commented Dec 20, 2023 •
edited
Loading

✅ Deploy Preview for springwolf-ui canceled.

Name Link
🔨 Latest commit 3d4a433
🔍 Latest deploy log https://app.netlify.com/sites/springwolf-ui/deploys/65b145ca9d52590008f007d5

@timonback timonback mentioned this pull request Dec 20, 2023
Closed
@timonback timonback force-pushed the feat/asyncapi-3 branch 2 times, most recently from 5755bd6 to b7ede27 Compare January 7, 2024 13:52
@timonback timonback mentioned this pull request Jan 10, 2024
Closed
@timonback
Copy link
Member Author

timonback commented Jan 13, 2024 •
edited
Loading

Collection of items missing/worth for discussion:

  • All operations need an action
  • All operations need a channel ref
  • All operation keys require at least topic name, action, method (operation identifier) - since by convention all messages[] arrays contain exactly one entry
  • AsyncListener metadata is basically a OperationBinding -> ui will read metadata from the operation (i.e. description)
  • Fix message reference by either using /channels// instead of components or registering messages in (own section of) schemasService
  • Review all TODO: markers
  • Review all FIXME markers
  • Does the channel message reference need to include the action? Can the channel message for a receive and sent action be the same class, but different through a channelbinding?
  • ^-> same but for message: allow to display kafka multi-payload-topic MonetaryAmount messageBinding (messages are refed by (class) name and therefore message bindings might go missing)
  • demonstrate generic bindings plugin -> in JMS (not sqs anymore)

timonback and others added 12 commits January 19, 2024 17:39
@timonback
feat(ui): prepare springwolf for AsyncApi 3.0 (wip)
b9d98e0 
feat(ui): remove testing code

feat(ui): remove asyncApi 2.0 hint about publish/subscribe

feat(ui): add parsing error boundary

feat(ui): add license chip

feat(ui): add notification.service.ts

feat(ui): rename Channel to ChannelOperation

also fix bindings

feat(ui): update asyncapi mapper (wip)

feat(ui): add todos

feat(ui): update asyncapi models to v3

chore(ui): split model packages

chore(ui): download asyncapi document only once

refactor(ui): re-organize components

chore(ui): use asyncapi v3 mock

chore(ui): remove IE support

chore(ui): move favicon.ico to assets
@timonback
feat(asyncapi): update package description
83baad5
@timonback
feat(asyncapi): add todos
33d7cb4
@aerfus @timonback
Enhancement: Add More Spec Details to the UI (#517)
08b3d71 
* test: ignore line ending in generated specs assertions

Is failing in Windows OS

Refs #378

* refactor(kafka): add primitive payload, example of `minimum` value

To visualize in UI

Refs #378

test(kafka): add primitive types

More data to demonstrate + type badges check

* refactor(ui): add schema properties template

To reuse for primitive types

Refs #378

* feat(ui): add `type` badge to schema payload header

 No intuitive way to check whether the payload is an objects or a string

Refs #378

* feat(ui): add minimum and maximum values to the spec`s model

Feature request

Refs #378

* feat(ui): display primitive type info

Feature request.
Only properties has info displayed

Refs #378

* feat(ui): display minimum and maximum values

Feature request.

Refs #378

* Revert "test: ignore line ending in generated specs assertions"

This reverts commit 07a6b30.
@ctasada @timonback
feat: Replaced usage of jAsyncAPI by the new springwolf-asyncapi modu…
b6d1c3e 
…le (#523)

* feat: Replaced usage of jAsyncAPI by the new springwolf-asyncapi module

We migrate from jAsyncAPI, with support for AsyncAPI v2, to the new SpringWolf-AsyncAPI module, which supports AsyncAPI v3.

This PR is only a first step. Plenty of tests are still not working and others are partially commented.

Please take a look to the multiple FIXMEs in the code
@ctasada @timonback
Replaced Springwolf-Core Message related classes by their Springwolf-…
7ea1d96 
…AsyncAPI equivalent. (#527)

Fixes some FIXMEs and removes duplicated classes
@ctasada @timonback
AsyncAPI v3 Migration Fixes (#533)
0daaaa7 
* fix: Multiple fixes related with Channel Messages

Some of the tests are failing due to some AssertJ recursion issue. Help is welcome

* fix: Minor properties fixes

* fix: Fixes to AMQP

Some fixes to the AMQP plugin and example (Still not finished)

* fix: Minor properties fixes

* fix: Migrated asyncapi.json examples to v3

* fix: Migration to AsyncAPI v3

As per https://www.asyncapi.com/docs/migration/migrating-to-v3

For a channel with multiple messages, you specify multiple key-value pairs. For a channel with just one message, you use a single key-value pair.

That means that the use of 'oneOf' is removed.

* fix: Improved support for Channel Messages

Fixed different bugs and limitations with the publishing of Messages in a Channel with the AsyncAPI v3 spec

* fix: Fixed Channel Merger

When merging Channels, the messages were not merged. This is now fixed.

* fix: Added basic support for Operations

Still plenty of errors, but Operations are now appearing in the AsyncAPI v3 output.

* fix: AsyncAPI module test
@timonback @ctasada
Feat/asyncapi v3 UI fixes (#539)
70e4d25 
* fix: Added missing comparison code

Those missing annotations were causing some
tests to fail

* fix: AMQP operation binding

As per documentation, 'deliveryMode' can only be 1 or 2. The default value 0 was incorrect

* fix: Added Channel Ref to Operation

* test: update asyncapi.json files based on current state in the branch

Generate asyncapi.actual.json files by running in _springwolf_examples_ folder:

`../gradlew test --tests "**.ApiIntegrationTest" --continue`

* test(kafka): update asyncapi model

* feat(ui): move asyncapi v3 changes

---------

Co-authored-by: Carlos Tasada <ctasada@gmail.com>
@ctasada @timonback
fix: Fixed core tests (#540)
a9e65e6 
* fix: Fixed core tests

Fixed the failing tests after migrating to AsyncAPI v3

* fix: Fixed AMQP integration

The AMQP was adding both 'exchange' & 'queue' keys, but it should only include the
one related with the binding type.

Also, deliveryMode can be ONLY 1 or 2, the
default value 0 which was used in different places is wrong.

* fix: Fixed AMQP integration

The AMQP was adding both 'exchange' & 'queue' keys, but it should only include the
one related with the binding type.

Also, deliveryMode can be ONLY 1 or 2, the
default value 0 which was used in different places is wrong.
@timonback
Feat/message as component (#541)
67cd62d 
* feat: move messages to components

* feat: add ChannelMessageReference

allows to link from an operation to the message within a specific channel

* chore: update asyncapi.json

* feat(ui): update after message was moved to components

* fix(ui): map operation binding correctly

* feat(core): remove ChannelMessageReference

* test(example): simplify creation of asyncapi.json files

* test(asyncapi): change channel messages type back to Message

* refactor(asyncapi): rename MessageReference static message

Better indicate what the reference points to

* chore: spotless

* test: fix DefaultChannelsServiceIntegrationTest

* test(kafka): remove duplicated primitite-topic consumer

* feat(core): use AsyncApi 3.0 OperationAction

* feat(ui): show contact info

* chore: update dependency list
@ctasada @timonback
Different fixes in the asyncapi v3 spec examples (#543)
1f373d0 
* fix: Minor fix to core spec example

The asyncapi test sample had a minor issue when validated with https://studio.asyncapi.com/

* fix: Minor fix to sns-plugin spec example

The asyncapi test sample had a minor issue when validated with https://studio.asyncapi.com/

We need to properly configure those values, something that I will take care of in the next PR

* fix: Minor fix to sqs-plugin spec example

The asyncapi test sample had a minor issue when validated with https://studio.asyncapi.com/

We need to properly configure those values, something that I will take care of in the next PR

* Fixed styles

* fix: Fixed broken tests

* fix: Added support to sqs-plugin to generate the minimum needed values

To pass the SQS Binding AsyncAPI validation, we need to provide some required fields. This commit adds the minimum values needed.

* fix: Added support to sns-plugin to generate the minimum needed values

To pass the SNS Binding AsyncAPI validation, we need to provide some required fields. This commit adds the minimum values needed.

* fix: Removed small batch of pending FIXMEs

* fix: Removed small batch of pending FIXMEs

* fix: Removed small batch of pending FIXMEs

* fix: Fixed the cloudstream-plugin

The cloudstream-plugin was not generating the operations section of the AsyncAPI spec. Now is fixed and validated.

Multiple FIXMEs were fixed and removed too

* fix: Removed unused methods

* fix: Fixed CloudStream operation action typo

* fix: Removed unneeded channelId field from ChannelObject

* fix: Fixed some code analysis complains

* fix: Fixed Operation messages bug

Whe configuring annotations on the class level, the generated Operations didn't have the proper message references.

This fixes the latest blocking FIXME

* fix: Schema Properties

The Schema Properties should support any kind of value, like booleans.

Making the property accept `Object` seems a more flexible approach.
@timonback
Feat/asyncapi 3: more fixes (#550)
0fe6a84 
* chore: typo

* fix: correct Listener=receive, Publisher=send operationAction

* feat(kafka): handle kafka message binding key

* chore: update example json

* feat(core): all operation include the action in the id

refactor: rename operationName to operationId

* feat(cloud-stream): align asyncapi.json structure

* feat(ui): show message when bindings are missing

* chore: resolve open FIXME

* chore: fix dependencies
@timonback timonback marked this pull request as ready for review January 19, 2024 16:52
ctasada
ctasada reviewed Jan 20, 2024
View reviewed changes
...amir/springwolf/addons/common_model_converters/converters/monetaryamount/MonetaryAmount.java Outdated Show resolved Hide resolved
...in/java/io/github/stavshamir/springwolf/asyncapi/v3/model/channel/message/MessageObject.java Show resolved Hide resolved
...rc/main/java/io/github/stavshamir/springwolf/asyncapi/scanners/channels/ChannelsScanner.java Outdated Show resolved Hide resolved
.../stavshamir/springwolf/asyncapi/scanners/channels/operationdata/annotation/AsyncMessage.java Show resolved Hide resolved
springwolf-core/src/main/java/io/github/stavshamir/springwolf/asyncapi/types/AsyncAPI.java Show resolved Hide resolved
springwolf-ui/README.md Show resolved Hide resolved
...mir/springwolf/asyncapi/scanners/channels/operationdata/annotation/SqsAsyncQueueBinding.java Show resolved Hide resolved
...springwolf/asyncapi/scanners/channels/operationdata/annotation/SqsAsyncOperationBinding.java Show resolved Hide resolved
...springwolf/asyncapi/scanners/channels/operationdata/annotation/SnsAsyncOperationBinding.java Show resolved Hide resolved
@aerfus
Support exclusiveMinimum and exclusiveMaximum (#560)
75f2156 
* feat(ui): add exclusiveMinimum and exclusiveMaximum values to the spec`s model
Feature request

Refs #378

* refactor(ui): reimplement range temple model

For further extension

Refs #378

* feat(ui): add support for exclusiveMinimum and exclusiveMaximum

Feature request

Refs #378

* refactor(ui): separate schema range as a component

For further extensions and maintenance

Refs #378

* test: add exclusiveMinimum to example Dto

To test changes visually

Refs #378
@ctasada ctasada mentioned this pull request Jan 24, 2024
Closed
2 tasks
@timonback timonback merged commit 02de447 into master Jan 26, 2024
19 checks passed
@timonback timonback deleted the feat/asyncapi-3 branch January 26, 2024 13:32
@timonback timonback mentioned this pull request Apr 21, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ctasada ctasada ctasada left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update to AsyncApi spec 3.0
3 participants
@timonback @ctasada @aerfus