Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(appconfig): fix some awslint errors, explicitly exempt others #28671

Merged
merged 6 commits into from
Jan 18, 2024
Merged

chore(appconfig): fix some awslint errors, explicitly exempt others #28671

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9677e6b
chore(appconfig): audit awslint errors
chenjane-dev Jan 11, 2024
0d85b3f
Merge branch 'main' into awslint
paulhcsun Jan 16, 2024
40cb836
break up events linter errors
chenjane-dev Jan 17, 2024
3bb7425
Merge branch 'main' into awslint
kaizencc Jan 17, 2024
3cf35c4
use regex to remove some extra errors
kaizencc Jan 17, 2024
323ed09
Merge branch 'main' into awslint
kaizencc Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 68 additions & 4 deletions packages/@aws-cdk/aws-appconfig-alpha/awslint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,77 @@
"docs-public-apis:@aws-cdk/aws-appconfig-alpha.IApplication",

"no-unused-type:@aws-cdk/aws-appconfig-alpha.PredefinedDeploymentStrategyId",
"ref-via-interface:@aws-cdk/aws-appconfig-alpha.Application.addAgentToEcs.taskDef",
"props-physical-name:@aws-cdk/aws-appconfig-alpha.ApplicationProps",
"props-physical-name:@aws-cdk/aws-appconfig-alpha.DeploymentStrategyProps",
"props-physical-name:@aws-cdk/aws-appconfig-alpha.EnvironmentProps",
"props-physical-name:@aws-cdk/aws-appconfig-alpha.ExtensionProps",
"events-in-interface",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is this awslint error fixed in this PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed by adding these methods to the application interface

https://github.com/aws/aws-cdk/pull/28671/files#diff-95c038ca91ae8a09cd48e458bab9f54f352b47fc300fda6502045c1fbf4e26fb

"events-method-signature",
"events-generic"
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Application.on",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Application.onDeploymentBaking",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chenjane-dev nit: i know i told you to add each individual linter exemption, because if not, and we stabilized, then we would be exempting events-method-signature everywhere. However, I don't think we need the individual params[0] and params[1] either. Having the onDeploymentBaking linter error is enough uniqueness i think

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't include them at first but then was getting the errors on the params[0] and params[1]

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok i'll check this out for you. seems weird if true but i believe you :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

used * to get it to work

"events-method-signature:@aws-cdk/aws-appconfig-alpha.Application.onDeploymentBaking.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Application.onDeploymentBaking.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Application.onDeploymentComplete",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Application.onDeploymentComplete.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Application.onDeploymentComplete.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Application.onDeploymentRolledBack",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Application.onDeploymentRolledBack.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Application.onDeploymentRolledBack.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Application.onDeploymentStart",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Application.onDeploymentStart.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Application.onDeploymentStart.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Application.onDeploymentStep",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Application.onDeploymentStep.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Application.onDeploymentStep.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Environment.on",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Environment.onDeploymentBaking",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Environment.onDeploymentBaking.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Environment.onDeploymentBaking.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Environment.onDeploymentComplete",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Environment.onDeploymentComplete.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Environment.onDeploymentComplete.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Environment.onDeploymentRolledBack",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Environment.onDeploymentRolledBack.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Environment.onDeploymentRolledBack.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Environment.onDeploymentStart",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Environment.onDeploymentStart.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Environment.onDeploymentStart.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Environment.onDeploymentStep",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Environment.onDeploymentStep.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.Environment.onDeploymentStep.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.HostedConfiguration.on",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.HostedConfiguration.onDeploymentBaking",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.HostedConfiguration.onDeploymentBaking.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.HostedConfiguration.onDeploymentBaking.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.HostedConfiguration.onDeploymentComplete",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.HostedConfiguration.onDeploymentComplete.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.HostedConfiguration.onDeploymentComplete.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.HostedConfiguration.onDeploymentRolledBack",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.HostedConfiguration.onDeploymentRolledBack.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.HostedConfiguration.onDeploymentRolledBack.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.HostedConfiguration.onDeploymentStart",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.HostedConfiguration.onDeploymentStart.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.HostedConfiguration.onDeploymentStart.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.HostedConfiguration.onDeploymentStep",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.HostedConfiguration.onDeploymentStep.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.HostedConfiguration.onDeploymentStep.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration.on",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration.onDeploymentBaking",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration.onDeploymentBaking.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration.onDeploymentBaking.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration.onDeploymentComplete",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration.onDeploymentComplete.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration.onDeploymentComplete.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration.onDeploymentRolledBack",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration.onDeploymentRolledBack.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration.onDeploymentRolledBack.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration.onDeploymentStart",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration.onDeploymentStart.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration.onDeploymentStart.params[1]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration.onDeploymentStep",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration.onDeploymentStep.params[0]",
"events-method-signature:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration.onDeploymentStep.params[1]",
"events-generic:@aws-cdk/aws-appconfig-alpha.Application",
"events-generic:@aws-cdk/aws-appconfig-alpha.Environment",
"events-generic:@aws-cdk/aws-appconfig-alpha.HostedConfiguration",
"events-generic:@aws-cdk/aws-appconfig-alpha.SourcedConfiguration"
]
}
81 changes: 80 additions & 1 deletion packages/@aws-cdk/aws-appconfig-alpha/lib/application.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,85 @@ export interface IApplication extends cdk.IResource {
* Returns the list of associated environments.
*/
get environments(): IEnvironment[];

/**
* Adds an extension defined by the action point and event destination
* and also creates an extension association to an application.
*
* @param actionPoint The action point which triggers the event
* @param eventDestination The event that occurs during the extension
* @param options Options for the extension
*/
on(actionPoint: ActionPoint, eventDestination: IEventDestination, options?: ExtensionOptions): void;

/**
* Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the
* provided event destination and also creates an extension association to an application.
*
* @param eventDestination The event that occurs during the extension
* @param options Options for the extension
*/
preCreateHostedConfigurationVersion(eventDestination: IEventDestination, options?: ExtensionOptions): void;

/**
* Adds a PRE_START_DEPLOYMENT extension with the provided event destination and
* also creates an extension association to an application.
*
* @param eventDestination The event that occurs during the extension
* @param options Options for the extension
*/
preStartDeployment(eventDestination: IEventDestination, options?: ExtensionOptions): void;
/**
* Adds an ON_DEPLOYMENT_START extension with the provided event destination and
* also creates an extension association to an application.
*
* @param eventDestination The event that occurs during the extension
* @param options Options for the extension
*/
onDeploymentStart(eventDestination: IEventDestination, options?: ExtensionOptions): void;

/**
* Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and
* also creates an extension association to an application.
*
* @param eventDestination The event that occurs during the extension
* @param options Options for the extension
*/
onDeploymentStep(eventDestination: IEventDestination, options?: ExtensionOptions): void;

/**
* Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and
* also creates an extension association to an application.
*
* @param eventDestination The event that occurs during the extension
* @param options Options for the extension
*/
onDeploymentBaking(eventDestination: IEventDestination, options?: ExtensionOptions): void;

/**
* Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and
* also creates an extension association to an application.
*
* @param eventDestination The event that occurs during the extension
* @param options Options for the extension
*/
onDeploymentComplete(eventDestination: IEventDestination, options?: ExtensionOptions): void;

/**
* Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and
* also creates an extension association to an application.
*
* @param eventDestination The event that occurs during the extension
* @param options Options for the extension
*/
onDeploymentRolledBack(eventDestination: IEventDestination, options?: ExtensionOptions): void;

/**
* Adds an extension association to the application.
*
* @param extension The extension to create an association for
*/
addExtension(extension: IExtension): void;
}

/**
Expand Down Expand Up @@ -296,7 +375,7 @@ export class Application extends ApplicationBase {
/**
* Adds the AWS AppConfig Agent as a container to the provided ECS task definition.
*
* @param taskDef The ECS task definition
* @param taskDef The ECS task definition [disable-awslint:ref-via-interface]
kaizencc marked this conversation as resolved.
Show resolved Hide resolved
*/
public static addAgentToEcs(taskDef: ecs.TaskDefinition) {
taskDef.addContainer('AppConfigAgentContainer', {
Expand Down