(apigatewayv2): Change defaultStage to an IHttpStage

[hffmnn]

❓ General Issue

The Question

Via #14541 the metricXXX method moved from IStage to IHttpStage. The defaultStage of a HttpApi returns a IStage, so the methods are not available.

Question: How to access the methods of the default stage?

Environment

• CDK CLI Version:
• Module Version: > 1.103.0
• Node.js Version: v12.19.0
• OS: macOS BigSur
• Language (Version): TypeScript (4.2.4)

Other information

When casting api.defaultStage! as IHttpStage; and calling the metricXXX methods generate the expected code, so I guess the defaultStage could return IHttpStage directly?

[peterwoodworth]

I don't think there's currently any way to access the methodXXX functions on property defaultStage when using an HttpApi.

Edit: You can cast the default stage as an IHttpStage to use the methodXXX functions like so:

const httpApi = new apigw.HttpApi(this, "MyHttpApi")
let defaultStage = httpApi.defaultStage as apigw.IHttpStage;
defaultStage.metricCount()

---

This is where the CDK creates the default HttpStage.

aws-cdk/packages/@aws-cdk/aws-apigatewayv2/lib/http/api.ts

Lines 430 to 435 in ae24d8a

	if (props?.createDefaultStage === undefined || props.createDefaultStage === true) {
	this.defaultStage = new HttpStage(this, 'DefaultStage', {
	httpApi: this,
	autoDeploy: true,
	domainMapping: props?.defaultDomainMapping,
	});

However, since the property is declared as an IStage

aws-cdk/packages/@aws-cdk/aws-apigatewayv2/lib/http/api.ts

Line 368 in ae24d8a

public readonly defaultStage: IStage | undefined;

that is the only part of the HttpStage which prevents you from being able to access the methods.

I don't see why the property can't directly return the IHttpStage, @nija-at was it intentional to remove the methods here? Seems like the change was only related to the WebSocket

[peterwoodworth]

I'll be closing this now because the workaround I posted above is pretty simple. If anyone would like to revisit changing the defaultStage prop to an IHttpStage ping me and let me know 😄

[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.

[hffmnn]

@peterwoodworth Personally I would not close it and label it as good first issue instead. There is a workaround (and I described your workaround already in the initial issue description) but still, it is an issue of an imprecise type.

[peterwoodworth]

you're right, relabeled as a feature request

[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.