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.

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

build(awslint): Add RuleFilterSet class to cache include/exclude rules. #27319

Merged
merged 3 commits into from
Sep 28, 2023

Conversation

mikewrighton
Copy link
Contributor

@mikewrighton mikewrighton commented Sep 27, 2023

Incremental fix to awslint performance. The shouldEvaluate() method is invoked for every context of every rule of every linter. The rule filter matching that was called from this method was iterating over the include/exclude list each time, and since we now have 2k+ rule filters, this was taking a long time( 55s for aws-cdk-lib).

This PR caches those rule filters and causes most lookups to be O(1), taking the evaluation time from 55s to 18ms. One minor limitation in the cache is that you can no longer use a 'startsWith' asterisk in the code portion of the filter, though you can still use an 'anyString' wildcard for the whole. This is explained better in the the comments:

  /**
   * Rule filter format is code:scope e.g. 'docs-public-apis:aws-cdk-lib.TagType'.
   * Wildcards can be used in the following ways:
   *
   * 1. Match any code e.g.: '*:aws-cdk-lib.TagType'
   * 2. Match any scope e.g.: 'docs-public-apis:*'
   * 3. Match any scope prefix e.g.: 'docs-public-apis:aws-cdk-lib.Tag*'
   */

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 p2 label Sep 27, 2023
@aws-cdk-automation aws-cdk-automation requested a review from a team September 27, 2023 16:37
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Sep 27, 2023
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.

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.

@mikewrighton mikewrighton changed the title Add RuleFilterSet class to cache include/exclude rules. build(awslint): Add RuleFilterSet class to cache include/exclude rules. Sep 27, 2023
@aws-cdk-automation aws-cdk-automation dismissed their stale review September 27, 2023 16:54

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

@mikewrighton mikewrighton marked this pull request as ready for review September 27, 2023 19:30
@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Sep 27, 2023
@mergify
Copy link
Contributor

mergify bot commented Sep 28, 2023

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Sep 28, 2023
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@mergify mergify bot merged commit 0c66a20 into main Sep 28, 2023
17 checks passed
@mergify mergify bot deleted the mikewrighton-rulespecs branch September 28, 2023 08:49
@mergify
Copy link
Contributor

mergify bot commented Sep 28, 2023

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants