Parser do not validate and throw error when parameters are provided but address is null

[derberg]

Like in the subject.

Document:

asyncapi: 3.0.0
info:
  title: Account Service
  version: 1.0.0
  description: This service is in charge of processing user signups
channels:
  userSignedup:
    address: user/signedup
    parameters:
      test:
        description: I should get an error that I provide a parameter but there are no parameters in the address, or basically address in `null`
    messages:
      UserSignedUp:
        $ref: '#/components/messages/UserSignedUp'
operations:
  sendUserSignedup:
    action: send
    channel:
      $ref: '#/channels/userSignedup'
    messages:
      - $ref: '#/channels/userSignedup/messages/UserSignedUp'
components:
  messages:
    UserSignedUp:
      payload:
        type: object
        properties:
          displayName:
            type: string
            description: Name of the user
          email:
            type: string
            format: email
            description: Email of the user

it should not be a valid document and I should get an error saying that I have parameters but there are no parameters in the address

[jonaslagoni]

We need to adapt the spectral rules to solve this issue. Here is how:

• Use the v2 rule that does this for AsyncAPI v2:

  parser-js/src/ruleset/v2/ruleset.ts

  Line 69 in 0a765c1

  'asyncapi2-channel-parameters': {

• Add it to the core ruleset: https://github.com/asyncapi/parser-js/blob/next-major-spec/src/ruleset/ruleset.ts
• Make the v3 rule look for the address not in the key of the key/value pair, but in the value.address instead.

This issue is marked as good first issue, but it's a medium difficulty!

Remember to target the next-major-spec branch.

[jonaslagoni]

/gfi typescript

[smoya]

We need to adapt the spectral rules to solve this issue. Here is how:

• Use the v2 rule that does this for AsyncAPI v2:

  parser-js/src/ruleset/v2/ruleset.ts

  Line 69 in 0a765c1

  'asyncapi2-channel-parameters': {

Note that the linked rule only applies for channels with parameters in their address. Otherwise, it just skips it. See the following code that executes for the channel address:

parser-js/src/ruleset/v2/functions/channelParameters.ts

Line 25 in 0a765c1

if (parameters.length === 0) return;

We need to additionally make it fail in case there are parameters defined for such a channel but they are not added into the address. This is the usecase @derberg shared.

Remember to target the next-major-spec branch.

This is not anymore a requirement since all v3-related stuff has been merged now to master.

cc @Min2who

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️