feat: update example doc to use DatadogLambda #289
Conversation
lym953
force-pushed
the
yiming.luo/step-function-refactor
branch
from
feb86a7 to
feb6e4f
Compare
lym953
force-pushed
the
yiming.luo/step-function-refactor2
branch
2 times, most recently
from
43990ce to
1fe6976
Compare
lym953
changed the title
![datadog-datadog-prod-us1[bot]](https://avatars.githubusercontent.com/u/365230?s=60&v=4){kind=small}
| export class CdkStepFunctionsTypeScriptStack extends Stack { | ||
| constructor(scope: Construct, id: string, props?: StackProps) { | ||
| super(scope, id, props); | ||
|
|
||
| console.log("Creating Hello World TypeScript stack"); | ||
|
|
||
| const helloLambdaFunction = new lambda.Function(this, "hello-python", { | ||
| runtime: lambda.Runtime.PYTHON_3_12, | ||
| timeout: Duration.seconds(10), | ||
| memorySize: 256, | ||
| code: lambda.Code.fromAsset("../lambda/python", { | ||
| bundling: { | ||
| image: lambda.Runtime.PYTHON_3_12.bundlingImage, | ||
| command: ["bash", "-c", "pip install -r requirements.txt -t /asset-output && cp -aT . /asset-output"], | ||
| }, | ||
| }), | ||
| handler: "hello.lambda_handler", | ||
| }); | ||
|
|
||
| const stateMachine = new sfn.StateMachine(this, "MyStateMachine", { | ||
| definitionBody: sfn.DefinitionBody.fromChainable( | ||
| new tasks.LambdaInvoke(this, "MyLambdaTask", { | ||
| lambdaFunction: helloLambdaFunction, | ||
| }).next(new sfn.Succeed(this, "GreetedWorld")), | ||
| ), | ||
| }); | ||
|
|
||
| console.log("Instrumenting Step Functions in TypeScript stack with Datadog"); | ||
|
|
||
| const datadogSfn = new DatadogStepFunctions(this, "Datadog", {}); | ||
| datadogSfn.addStateMachines([stateMachine]); | ||
| } | ||
| } |
There was a problem hiding this comment.
⚪ Code Quality Violation
This class is unnecessary (...read more)
This rule advises against the unnecessary use of classes that contain only static members, or nothing. In JavaScript, classes are primarily used for object-oriented programming, where each instance of a class has its own state and behavior. Static members, on the other hand, belong to the class itself and not to any instance of the class.
When a class contains only static members, it does not make use of JavaScript's object-oriented capabilities, and it can be more difficult to understand, test, and maintain than necessary. In order to avoid this issue, consider using regular functions and variables instead of static class members. This makes your code easier to understand and maintain, and it allows you to make better use of JavaScript's features.
src/interfaces.ts
Outdated
| @@ -97,3 +97,5 @@ export interface Node { | |||
| } | |||
|
|
|||
| export type LambdaFunction = lambda.Function | lambda.SingletonFunction; | |||
|
|
|||
| export interface DatadogStepFunctionsProps {} | |||
There was a problem hiding this comment.
⚪ Code Quality Violation
An empty interface is equivalent to `{}`. (...read more)
Do not use empty interfaces.
| import { CdkStepFunctionsTypeScriptStack } from "../lib/cdk-step-functions-typescript-stack"; | ||
|
|
||
| const app = new cdk.App(); | ||
| new CdkStepFunctionsTypeScriptStack(app, "CdkStepFunctionsTypeScriptStack", {}); |
There was a problem hiding this comment.
⚪ Code Quality Violation
Do not use 'new' for side effects. (...read more)
A lonely instance is almost always useless. Do not create objects without assigning them to a variable that you will use later.
| ), | ||
| }); | ||
|
|
||
| console.log("Instrumenting Step Functions in TypeScript stack with Datadog"); |
There was a problem hiding this comment.
🟠 Code Quality Violation
Unexpected console statement. (...read more)
Debugging with console is not considered a bad practice, but it's easy to forget about console statements and leave them in production code. There is no need to pollute production builds with debugging statements.
| constructor(scope: Construct, id: string, props?: StackProps) { | ||
| super(scope, id, props); | ||
|
|
||
| console.log("Creating Hello World TypeScript stack"); |
There was a problem hiding this comment.
🟠 Code Quality Violation
Unexpected console statement. (...read more)
Debugging with console is not considered a bad practice, but it's easy to forget about console statements and leave them in production code. There is no need to pollute production builds with debugging statements.
src/datadog-step-functions.ts
Outdated
| this.props = props; | ||
| } | ||
|
|
||
| public addStateMachines(_stateMachines: sfn.StateMachine[], _construct?: Construct): void {} |
There was a problem hiding this comment.
🔴 Code Quality Violation
| public addStateMachines(_stateMachines: sfn.StateMachine[], _construct?: Construct): void {} | |
| public addStateMachines(_stateMachines: sfn.StateMachine[], _construct?: Construct): void {/* empty */} |
Empty statement. (...read more)
Empty or non-functional blocks in the code can be misleading and lead to maintenance difficulties. They can also lead to a false sense of security or functionality. While they may not directly introduce security issues, their presence can suggest that some logic or error handling is implemented when it is not.
lym953
force-pushed
the
yiming.luo/step-function-refactor2
branch
from
329adc6 to
75d532f
Compare
What does this PR do?
Make example code in
README.mdto use:
DatadogLambdainstead ofDatadogDatadogLambdaPropsinstead ofDatadogPropsMotivation
The renaming is to make it cleaner to add
DatadogStepFunctionclass later. Details in [RFC] Changing API for Datadog CDK ConstructTesting Guidelines
Additional Notes
Types of Changes
Check all that apply