Unable to map domain to WS API when both REST and WS APIs are defined externally

[dankochetov]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Bug Report

Error Description
When both provider.apiGateway.restApiId and provider.apiGateway.websocketApiId are set and custom domains are required for both, the plugin maps both rest and websocket domains to the REST API.

Domain Manager Configuration

provider:
  apiGateway:
    restApiId: <id>
    restApiRootResourceId: <id>
    websocketApiId: <id>

custom:
  customDomain:
    rest:
      domainName: foo.api.bar.tld
      certificateArn: ${env:API_DOMAIN_CERTIFICATE_ARN}
      basePath: foo
      endpointType: edge
    websocket:
      domainName: foo.ws-api.bar.tld
      basePath: foo
      endpointType: regional

Versions

• Domain Manager version(s): 4.1.1
• Node/npm version: Node 10.20.1/npm 6.14.4
• Serverless Version: 1.69.0
• Lambda Code: JS

Possible Solution
This line is probably causing the issue:

serverless-domain-manager/src/index.ts

Line 683 in 13649ca

if (this.serverless.service.provider.apiGateway && this.serverless.service.provider.apiGateway.restApiId) {

It always returns the REST API ID when it's set and doesn't check if we're actually looking for the WS API ID.

[RickMeasham]

There are quite a number of issues with the getApiId function. A band-aid fix for all of them might be to include the ability to set it in the customDomain clause (using refs or functions or strings)

[okgolove]

Facing the same issue.

It is not necessary to specify external websocketApiId. Even Cloudformation creates a websocket api gw by itself a domain is mapped to a rest api gw.