Websocket support

[kenpachiii]

Fixes #207 and #228

Description of Issue Fixed
Added fixes to @pavel-ignatiev fork to add websocket support.

Changes proposed in this pull request:

• DRY'd out code to remove similar functions.
• Expanded DomainInfo class to include management of default values and setting values.
• Upgraded all apigateway endpoints to version 2, except for createdomain for rest. As only version 1 will work for that.
• Changed customDomain to take in a list of domains.
• Uses a Map() iterator on lifecycle hooks to process each domain and allows for skipping domains that dont need changes or ones that are disabled.
• Some minorish restructuring so the plugin will fail fast. Mostly around initializeDomainManager() function previously initializevariables() which will only return enabled domains.

[codyseibert]

My one suggestion would be to allow customDomain to be backwards compatible and fall back on the previous solution if an array is not provided.

Something else I'm noticing is that occasionally when I run this it seems to just get stuck. The last log that prints out is "Created API mapping for".... I'm looking into this now.

[idhard]

what is blocking this pull request? would love to see this being released , thanks

[Gr8z]

+1

[idhard]

ping @captainsidd any chance you could review this pull request ? thanks

[kenpachiii]

Looks good

[adam-nielsen]

Are there any instructions on how to use this while we wait for it to get merged? I only just discovered this functionality is missing as I was in the process of trying to set up a custom domain for a Websocket service!

EDIT: Worked it out, git clone, npm run build, copy folder into own project's node_modules folder.

I get an error this.serverless.service.custom.customDomain.map is not a function which tells me I am running the correct code, however once I change this to an array as shown in the README, then I get nothing. No errors, no custom domains, no websocket domain.

Looking at the SLS_DEBUG logs, it looks like this is because the first domain is already done (why doesn't it print it in the summary like it used to?) and the second one failed because I had made up the name to see if the PR was working or not!

Serverless: [AWS apigatewayv2 200 0.286s 0 retries] getApiMappings({ DomainName: 'main.domain' })
Domain Manager: Path for main.domain is already current. Skipping...
Serverless: [AWS cloudformation 200 0.187s 0 retries] describeStackResource({ LogicalResourceId: 'WebsocketsApi',
  StackName: 'mystack' })
Serverless: [AWS apigatewayv2 404 0.192s 0 retries] getApiMappings({ DomainName: 'websocket.domain' })
Domain Manager: NotFoundException: Invalid domain name identifier specified
Domain Manager: Invalid domain name identifier specified

Will try again once I can get the new domain created, but it might be nice to handle this error in case someone makes a typo in their domain one day, rather than silently failing!

UPDATE: Once I put in a valid domain everything worked. sls create_domain looks good, and deploying works for both the REST endpoint and the Websocket endpoint.

I guess once the code is updated so that it's backwards compatible (accepting a non-array parameter) then it should be ready to merge? I also note that doesn't print a summary of the configured domains unless they have changed, so might be good to have that shown as well, just to confirm it's actually doing something as I get no output at all from it unless I use SLS_DEBUG. That and giving a nicer error message as above instead of failing silently!

[Gr8z]

Its been 4 months, and still hasn't been merged...

[AlastairTaft]

We're running in prod without a custom domain 😬

[adam-nielsen]

My understanding is that this PR is unlikely to be merged until it's changed so that it is backwards compatible with existing serverless.yml files, otherwise once it's changed it'll break things for everyone else.

I had to remove the whole stack and redeploy to change a URL (a bug in CloudFront apparently) and as a result the production URL changed, so I'm glad I had already deployed the custom domain name with this PR, as it meant nothing consuming my service broke!

[jan-wilhelm]

I would love to see this merged. Really useful and necessary feature, thanks for the work!

[592da]

any updates please ?
really critical for us...

thanks

[592da]

tested it,
for some reason, it fails - probably because of one of the while loops...

FATAL ERROR: Ineffective mark-compacts near heap limit Allocation failed - JavaScript heap out of memory

  customDomain:
    - domainName: apis.yyyy.com
      basePath: ${self:provider.stage}
      certificateName: "*.yyyy.com"
      certificateArn: arn:aws:acm:us-east-1:......
      createRoute53Record: true
      endpointType: "regional"
      securityPolicy: tls_1_2
      websocket: true

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities (and 0 Security Hotspots to review)
0 Code Smells

No Coverage information
No Duplication information

[aoskotsky-amplify]

I'm closing this PR because I believe it's been implemented with #319. If you feel this PR is still needed then feel free to reopen it.