(@aws-cdk/aws-apigatewayv2-alpha): Cannot get API Gateway to trigger connect or disconnect

[brucegl]

What is the problem?

Not sure if the problem is with my code, the documentation or the implementation. After deploying the stack, the AWS console correctly displays an API Gateway trigger at the page Lambda>Functions>connect>Configuration>Triggers, however, the following is also displayed:

API Gateway:
arn:aws:execute-api:eu-west-1:1234567890:7sfj6g3ekl//$connect
x The API with ID 7sfj453ekl doesn’t include a route with path /* having an integration arn:aws:lambda:eu-west-1:1234567890:function:process_connect_requests.

If I'm doing something wrong, it's probably in the following lines:

    const webSocketConnectIntegration = new WebSocketLambdaIntegration("ConnectIntegration", connectFunction);
    const webSocketDisconnectIntegration = new WebSocketLambdaIntegration("DisconnectIntegration", disconnectFunction);

    const webSocketApi = new apigwv2.WebSocketApi(this, "WebSocket API", {
      apiName: "webSocket",
      routeSelectionExpression: "$request.body.action",
      connectRouteOptions: { integration: webSocketConnectIntegration },
      disconnectRouteOptions: { integration: webSocketDisconnectIntegration },
    });

Reproduction Steps

import { Duration, RemovalPolicy, Stack, StackProps } from "aws-cdk-lib";
import { Construct } from "constructs";
import * as dynamodb from "aws-cdk-lib/aws-dynamodb";
import * as lambda from "aws-cdk-lib/aws-lambda";
import * as path from "path";
import * as apigwv2 from "@aws-cdk/aws-apigatewayv2-alpha";
import { WebSocketLambdaIntegration } from "@aws-cdk/aws-apigatewayv2-integrations-alpha";

export class ApigwStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);

    const webSocketTableName = "WebSocketConnections";

    const connectFunction = new lambda.Function(this, "Connect Function", {
      functionName: "process_connect_requests",
      runtime: lambda.Runtime.NODEJS_14_X,
      handler: "index.handler",
      code: lambda.Code.fromAsset(path.join(__dirname, "../functions/connect")),
      timeout: Duration.seconds(5),
      environment: {
        TABLE_NAME: webSocketTableName,
      },
    });

    const disconnectFunction = new lambda.Function(this, "Disconnect Function", {
      functionName: "process_disconnect_requests",
      runtime: lambda.Runtime.NODEJS_14_X,
      handler: "index.handler",
      code: lambda.Code.fromAsset(path.join(__dirname, "../functions/disconnect")),
      timeout: Duration.seconds(5),
      environment: {
        TABLE_NAME: webSocketTableName,
      },
    });

    const webSocketLogTable = new dynamodb.Table(this, "WebSocket Log Table", {
      tableName: webSocketTableName,
      partitionKey: { name: "ConnectionId", type: dynamodb.AttributeType.STRING },
      removalPolicy: RemovalPolicy.DESTROY, // not recommended for production
    });
    webSocketLogTable.grantReadWriteData(connectFunction);
    webSocketLogTable.grantReadWriteData(disconnectFunction);

    const webSocketConnectIntegration = new WebSocketLambdaIntegration("ConnectIntegration", connectFunction);
    const webSocketDisconnectIntegration = new WebSocketLambdaIntegration("DisconnectIntegration", disconnectFunction);

    const webSocketApi = new apigwv2.WebSocketApi(this, "WebSocket API", {
      apiName: "webSocket",
      routeSelectionExpression: "$request.body.action",
      connectRouteOptions: { integration: webSocketConnectIntegration },
      disconnectRouteOptions: { integration: webSocketDisconnectIntegration },
    });

    const webSocketStage = new apigwv2.WebSocketStage(this, "Production Stage", {
      webSocketApi: webSocketApi,
      stageName: "prod",
      autoDeploy: true,
    });
  }
}

Please use the typical example connect/disconnect code

What did you expect to happen?

Something like the following to be displayed in Lambda>Functions>connect>Configuration>Triggers

API Gateway: WSM
arn:aws:execute-api:eu-west-1:1234567890:cogh633tqf/*/$connect
API endpoint: https://cogh633tqf.execute-api.eu-west-1.amazonaws.com/prod/
Details
API type: WEBSOCKET
Authorization: NONE
Method: $connect
Stage: prod

What actually happened?

wscat cannot connect

CDK CLI Version

2.17.0 (build f9cd009)

Framework Version

No response

Node.js Version

v16.13.0node.js

OS

Linux Mint

Language

Typescript

Language Version

No response

Other information

No response

[brucegl]

Typescript version is 4.5.5

[brucegl]

A bit of an update... if I remove the (dis)connectRouteOptions, I can add these routes using the AWS console as a workaround.

[ryparker]

Hey @brucegl 👋🏻

Thanks for opening the issue with us. I was able to reproduce this and i've uploaded the full code with documentation to this repo.

This might be a bug in the AWS console. Have you noticed any functional problems that might be caused be related to this?

[ryparker]

Here's a screenshot of the error:

[brucegl]

Hi @ryparker, I think the issue goes beyond the AWS console as I was also unable to wscat -c to the endpoint.

[Spider-ant]

If you view (through console) the websocket api route integration request (see screenshot) you will see the lambda function is set to the lambda function name. If the websocket integration applied the function arn instead it would likely fix the issue. (see warning in the screenshot)

[brucegl]

Thanks @Spider-ant, I'll see if I can codify it with the lambda arn next time I build a stack

[oyatrides]

any updates on this ? having the same error

[TanjaBayer]

Same here, the generated template as the following permissions:

"websocketapitestwebsocketapiconnectRoutedefaultwebsocketroutePermission": {
   "Type": "AWS::Lambda::Permission",
   "Properties": {
    "Action": "lambda:InvokeFunction",
    "FunctionName": {
     "Fn::GetAtt": [
      "websocketapiMyLambda",
      "Arn"
     ]
    },
    "Principal": "apigateway.amazonaws.com",
    "SourceArn": {
     "Fn::Join": [
      "",
      [
       "arn:",
       {
        "Ref": "AWS::Partition"
       },
       ":execute-api:us-east-2:*********:",
       {
        "Ref": "websocketapitestwebsocketapi"
       },
       "/*/*$connect"
      ]
     ]
    }
   }

I think one of the /* before the $connect should not be there, this makes the aws-apigateway unusable.

I ended up using the Cloudformation contruct instead of the higher level L2 Construct here are the required steps for it: #2872 (comment)

[astroalek]

Same problem here with version 2.86

[katzrkool]

Same problem in CDK v1.

[ashishpandey001]

this issue has been open for 16 months, are there no plans to resolve this and make the L2 construct usable?

If not, can we mark the construct as broken so people don't waste their time using it over the L1 constructs?

[WillDelish]

I am also experiencing this issue and have wasted a bit of time troubleshooting my lambda when it never triggers to begin with due to this bug. Will switch to a different construct, but its unfortunate this has been open for so long without marking the construct as broken

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.