Skip to content

feat: support healthCheckGracePeriod in QueueProcessingFargateService #34231

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

TrevorBurnham
Copy link
Contributor

Closes #34220

Reason for this change

QueueProcessingFargateService supports the ECS deployment circuit breaker, but doesn't currently offer any way to configure the health check grace period used by the circuit breaker, as FargateService does. This PR rectifies that discrepancy.

Description of changes

Added the healthCheckGracePeriod property to QueueProcessingFargateService, matching the corresponding property on FargateService.

Describe any new or updated permissions being added

None.

Description of how you validated changes

I've added a unit test to verify that the property is passed to the underlying FargateService.

Checklist


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

@github-actions github-actions bot added the beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK label Apr 23, 2025
@aws-cdk-automation aws-cdk-automation requested a review from a team April 23, 2025 17:54
@github-actions github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 labels Apr 23, 2025
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

(This review is outdated)

@TrevorBurnham TrevorBurnham force-pushed the queue-processing-fargate-service-health-check-grace-period branch from 7b968c9 to bdd5249 Compare April 23, 2025 18:16
@TrevorBurnham
Copy link
Contributor Author

TrevorBurnham commented Apr 23, 2025

Clarification Request: The PR linter is failing with

Features must contain a change to an integration test file and the resulting snapshot.

I've tried to satisfy this requirement, but the instructions in CONTRIBUTING.md are either incorrect or incomplete.

Here are the steps I went through:

  1. Freshly cloned the repo on my Mac
  2. Ran yarn install
  3. Ran npx lerna run build --skip-nx-cache, which had a failure in the @aws-cdk/cx-api:build target (unrelated I believe)
  4. Ran cd packages/aws-cdk-lib && yarn test, where every test failed with errors like Cannot find module '../dist/core/cfn-utils-provider.generated' from 'core/lib/private/cfn-utils-provider.ts'
  5. Ran cd packages/@aws-cdk-testing/framework-integ && yarn integ test/aws-ecs-patterns/test/fargate/integ.queue-processing-fargate-service-grace-period.js --update-on-failed, which gave me "No such integ test".

The test failures suggest that the build is incomplete, despite me running the build command as described in CONTRIBUTING.md.

@aws-cdk-automation aws-cdk-automation added the pr/reviewer-clarification-requested The contributor has requested clarification on feedback, a failing build, or a failing PR Linter run label Apr 23, 2025
@shikha372 shikha372 self-assigned this Apr 24, 2025
@shikha372
Copy link
Contributor

shikha372 commented Apr 28, 2025

te, despite me running the build command as described in CONTRIBUTING.md.

Thanks @TrevorBurnham for submitting this PR, from your description of the error packages/@aws-cdk-testing/framework-integ && yarn integ test/aws-ecs-patterns/test/fargate/integ.queue-processing-fargate-service-grace-period.js --update-on-failed, which gave me "No such integ test". , can you see the compiled file in local with your changes.

For successfully building the integration test with latest changes from aws-cdk lib, you can run
npx lerna run build --scope=aws-cdk-lib --scope=@aws-cdk-testing/framework-integ —scope=@aws-cdk —skip-nx-cache

@shikha372 shikha372 removed the pr/reviewer-clarification-requested The contributor has requested clarification on feedback, a failing build, or a failing PR Linter run label Apr 28, 2025
@TrevorBurnham TrevorBurnham force-pushed the queue-processing-fargate-service-health-check-grace-period branch 2 times, most recently from a7056b1 to 0810eeb Compare April 29, 2025 01:17
@TrevorBurnham TrevorBurnham force-pushed the queue-processing-fargate-service-health-check-grace-period branch from fbcc2b2 to f12fb56 Compare April 29, 2025 01:18
@TrevorBurnham
Copy link
Contributor Author

@shikha372 Thank you! That command allowed me to run the integration test.

@aws-cdk-automation aws-cdk-automation dismissed their stale review April 29, 2025 01:19

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

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Apr 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aws-ecs: Should QueueProcessingFargateService support healthCheckGracePeriod?
3 participants