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

fix(Config Schema): Recognize provider.websocketsDescription #10663

Merged
merged 1 commit into from Feb 8, 2022

Conversation

j0k3r
Copy link
Contributor

@j0k3r j0k3r commented Feb 8, 2022

I used it back with the v1 version, and now on v2 (at least) I got a Configuration warning when defining that value:

Serverless: Configuration warning at 'provider': unrecognized property 'websocketsDescription'

The value is used in different places but is missing in the config schema.
I've also updated the doc about it.

Simple schema to reproduce the warning:

service: serverless-ws-test

provider:
  name: aws
  runtime: nodejs12.x
  websocketsApiRouteSelectionExpression: $request.body.route
  websocketsDescription: Hi, I'm here to trigger a warning!

functions:
  wsHandler:
    handler: handler.wsHandler
    events:
      - websocket:
          route: $connect
      - websocket:
          route: $disconnect
      - websocket:
          route: $default

I used it back with the v1 version, and now on v2 (at least) I got a _Configuration warning_ when defining that value:

```
Serverless: Configuration warning at 'provider': unrecognized property 'websocketsDescription'
```

The value is used in different places but is missing in the config schema.
I've also updated the doc about it.
@codecov
Copy link

codecov bot commented Feb 8, 2022

Codecov Report

Merging #10663 (31743bf) into main (e66c865) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #10663   +/-   ##
=======================================
  Coverage   86.40%   86.40%           
=======================================
  Files         299      299           
  Lines       12377    12379    +2     
=======================================
+ Hits        10694    10696    +2     
  Misses       1683     1683           
Impacted Files Coverage Δ
lib/plugins/aws/provider.js 94.59% <ø> (ø)
bin/serverless.js 51.06% <0.00%> (+2.17%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e66c865...31743bf. Read the comment docs.

Copy link
Contributor

@pgrzesik pgrzesik left a comment

Choose a reason for hiding this comment

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

Great catch, thanks a lot @j0k3r 🙇

@pgrzesik pgrzesik changed the title Config schema: add websocketsDescription fix(Config Schema): Recognize provider.websocketsDescription Feb 8, 2022
@pgrzesik pgrzesik merged commit 9778751 into serverless:main Feb 8, 2022
@j0k3r j0k3r deleted the fix/config-websocket-description branch February 8, 2022 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants