fix(lambda): update the type of LogFormat option #28127

tomoish · 2023-11-24T09:54:47Z

The logFormat option in the FunctionOptions interface should accept one of the LogFormat enum options.

This PR updates the type of the LogFormat option to LogFormat instead of string.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

TastefulElk · 2023-11-26T00:03:24Z

packages/aws-cdk-lib/aws-lambda/lib/function.ts

@@ -466,7 +466,7 @@ export interface FunctionOptions extends EventInvokeConfigOptions {
   * Sets the logFormat for the function.
   * @default Text format
   */
-  readonly logFormat?: string;
+  readonly logFormat?: LogFormat;


I think this would be a breaking change since it's currently possible (arguably encouraged by the type) to set the property to the strings "JSON" or "Text".

I suggest adding | keyof LogFormat which would let the user use either the enum or type-safe strings

Suggested change

readonly logFormat?: LogFormat;

readonly logFormat?: LogFormat | keyof typeof LogFormat;

Thank you for your comment.
I will modify logFormat type to accept both the enum and type-safe strings

Thank you for your suggestion.
Your comment realised me that my first change would be a breaking change.
Both of my first change and your suggestion can't accept both of the enum or type-safe strings.
Therefore, I changed the type of logFormat as readonly logFormat?: LogFormat | `${LogFormat}`; due to accept both of lambda.LogFormat.TEXT and string 'Text'.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

scanlonp

I believe we add validation that the text passed in is either 'Text' or 'JSON'? This will prevent random strings from being passed in. We could add it in the getLoggingConfig function on 1089-1103 of function.ts. While this would technically be breaking for anyone who passed in a bad value, I would assume any LogFormat value other than those two would cause a deployment failure. This would corral the problem fully.

tomoish · 2023-12-11T06:16:41Z

I believe we add validation that the text passed in is either 'Text' or 'JSON'? This will prevent random strings from being passed in. We could add it in the getLoggingConfig function on 1089-1103 of function.ts. While this would technically be breaking for anyone who passed in a bad value, I would assume any LogFormat value other than those two would cause a deployment failure. This would corral the problem fully.

Thank you for your comment.
I will add a validation.

Pull request has been modified.

aws-cdk-automation · 2023-12-11T06:57:03Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 8bfd2d6
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

kaizencc

I don't have a problem with this as is, since the values in which this would be a breaking change would never have worked. That being said, we must sanity check this in our JSII-target languages to make sure that this doesn't somehow break those users. We cannot merge this in without doing that

Unless @tomoish you are willing to do this I'm mostly adding in this note to myself to test this later.

tomoish · 2023-12-14T02:11:04Z

I don't have a problem with this as is, since the values in which this would be a breaking change would never have worked. That being said, we must sanity check this in our JSII-target languages to make sure that this doesn't somehow break those users. We cannot merge this in without doing that

Unless @tomoish you are willing to do this I'm mostly adding in this note to myself to test this later.

Hello, @kaizencc.

Thank you for your comment.

I might not be able to perform the sanity check for the JSII-target languages.
Would you be willing to take on this task?

kaizencc

It looks like in python, the readonly logFormat?: LogFormat |${LogFormat}; gets converted to:

log_format: typing.Optional[typing.Union[builtins.str, "LogFormat"]] = None,

which is not a breaking change. however, it also negates the impact of this PR since it still permits all strings (and the point of this PR is to restrict these strings to 'TEXT' and 'JSON'.

We want to do a better job of catering to all our languages, not just typescript. So I don't think I want to go down this path. Instead, we should deprecate logFormat and create a new variable, loggingFormat, which has the correct type. (If you hate the loggingFormat name for some reason, I'll also allow logFormatV2 or feel free to come up with alternatives).

The deprecation will nag users to move to the new prop, where we will successfully restrict typing for all languages, and problem (not-so-elegantly) solved.

kaizencc · 2023-12-22T21:53:43Z

@tomoish ^

tomoish · 2023-12-23T07:40:21Z

Thank you for your consideration, @kaizencc.

I wasn't familiar with jsii, so I was researching how changing the type of logFormat fromreadonly logFormat?: LogFormat | \`${LogFormat}`; to readonly logFormat?: LogFormat | "Text" | "JSON";, thereby explicitly restricting logFormat string to only 'Text' and 'JSON', would be translated in other languages.

If you have any information on this, I would like to know. Also, if this approach does not resolve the issue, I would accept your proposal.

In this new loggingFormat, are we considering a type like readonly logFormat?: LogFormat; that does not allow string?

kaizencc · 2023-12-29T04:10:33Z

@tomoish

In this new loggingFormat, are we considering a type like readonly logFormat?: LogFormat; that does not allow string?

Correct

If you have any information on this, I would like to know. Also, if this approach does not resolve the issue, I would accept your proposal.

I'm not too familiar with jsii myself unfortunately, but I believe what happens is that any type in typescript like "TEXT" becomes a string type in python and maybe other languages as well.

tomoish · 2023-12-29T13:43:49Z

Thank you for your response, @kaizencc.
I understand the new arguments and how they are converted to other languages.
I will try to implement loggingFormat.

aws-cdk-automation · 2024-01-12T00:08:27Z

This PR has been in the CHANGES REQUESTED state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week.

aws-cdk-automation · 2024-01-19T00:08:29Z

This PR has been deemed to be abandoned, and will be automatically closed. Please create a new PR for these changes if you think this decision has been made in error.

> # Issue > > The issue is that LogFormat is a String so it doesn't allow the enum LogFormat. > # Solution > > Created a new enum for the LoggingFormat and added testing. So the solution sets these values as potential environment variables. The main difference is LoggingFormat is assigned to an enum instead of a string. > # Important Design Decisions > > This is so that an enum could be used for LoggingFormat without breaking JSII target languages. Some background information is in this pr #28127. Was a recommended solution here. #28127 > > Remember to follow the [CONTRIBUTING GUIDE] and [DESIGN GUIDELINES] for any > code you submit. > > [CONTRIBUTING GUIDE]: https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md > [DESIGN GUIDELINES]: https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md Closes #28114. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

fix(lambda): change type of LogFormat option

1737b1e

github-actions bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK bug This issue is a bug. p2 labels Nov 24, 2023

aws-cdk-automation requested a review from a team November 24, 2023 09:55

aws-cdk-automation previously requested changes Nov 24, 2023

View reviewed changes

TastefulElk reviewed Nov 26, 2023

View reviewed changes

TastefulElk mentioned this pull request Nov 26, 2023

feat(lambda): support for advanced logging #28039

Merged

tomoish added 7 commits November 28, 2023 13:16

add unit tests

ca05c6b

fix logFormat type

3589102

Fix indentation

873afcb

Fix unit tests

ab24800

Add integration test

90c020d

Change the type of logFormat

8a6ba0d

Add snapshot

f0273f8

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Nov 29, 2023

github-actions bot mentioned this pull request Dec 1, 2023

Monthly PR metrics report - November 2023 #28212

Closed

scanlonp previously requested changes Dec 5, 2023

View reviewed changes

scanlonp self-assigned this Dec 5, 2023

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 5, 2023

tomoish added 2 commits December 11, 2023 15:28

Add validation tests

7110b67

Add validation

8bfd2d6

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 11, 2023

kaizencc reviewed Dec 13, 2023

View reviewed changes

kaizencc requested changes Dec 21, 2023

View reviewed changes

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 21, 2023

AnuragMohapatra mentioned this pull request Dec 23, 2023

fix(aws-lambda): Fix the log format type on logging configurations #28475

Closed

tomoish mentioned this pull request Jan 17, 2024

feat(lambda): use loggingFormat instead of logFormat #28736

Closed

aws-cdk-automation added the closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. label Jan 19, 2024

aws-cdk-automation closed this Jan 19, 2024

ConnorRobertson mentioned this pull request Jan 31, 2024

feat(lambda): support enums in loggingFormat #28942

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(lambda): update the type of LogFormat option #28127

fix(lambda): update the type of LogFormat option #28127

tomoish commented Nov 24, 2023

aws-cdk-automation left a comment

TastefulElk Nov 26, 2023

tomoish Nov 28, 2023

tomoish Nov 29, 2023

scanlonp left a comment

tomoish commented Dec 11, 2023

aws-cdk-automation commented Dec 11, 2023

kaizencc left a comment •

edited

Loading

tomoish commented Dec 14, 2023

kaizencc left a comment

kaizencc commented Dec 22, 2023

tomoish commented Dec 23, 2023

kaizencc commented Dec 29, 2023 •

edited

Loading

tomoish commented Dec 29, 2023

aws-cdk-automation commented Jan 12, 2024

aws-cdk-automation commented Jan 19, 2024

	readonly logFormat?: LogFormat;
	readonly logFormat?: LogFormat \| keyof typeof LogFormat;

fix(lambda): update the type of LogFormat option #28127

fix(lambda): update the type of LogFormat option #28127

Conversation

tomoish commented Nov 24, 2023

aws-cdk-automation left a comment

Choose a reason for hiding this comment

TastefulElk Nov 26, 2023

Choose a reason for hiding this comment

tomoish Nov 28, 2023

Choose a reason for hiding this comment

tomoish Nov 29, 2023

Choose a reason for hiding this comment

scanlonp left a comment

Choose a reason for hiding this comment

tomoish commented Dec 11, 2023

aws-cdk-automation commented Dec 11, 2023

AWS CodeBuild CI Report

kaizencc left a comment • edited Loading

Choose a reason for hiding this comment

tomoish commented Dec 14, 2023

kaizencc left a comment

Choose a reason for hiding this comment

kaizencc commented Dec 22, 2023

tomoish commented Dec 23, 2023

kaizencc commented Dec 29, 2023 • edited Loading

tomoish commented Dec 29, 2023

aws-cdk-automation commented Jan 12, 2024

aws-cdk-automation commented Jan 19, 2024

kaizencc left a comment •

edited

Loading

kaizencc commented Dec 29, 2023 •

edited

Loading