refactor(ruleset)!: improve match code efficiency and properly handle status #1255

ecrupper · 2025-02-17T21:08:05Z

steps:
  - name: test
    image: alpine:latest
    ruleset:
      event: pull_request
      branch: [ hotfix-* ]
      operator: or
    commands:
      - echo blah

The above does not purge. It only gets skipped when the worker handles skipping. The compiler should be corrected here and return FALSE when the above is calculated with rule data == push on main for example

Further, I refactored the match code to be more efficient. I removed the unnecessary Parallel key, which will be addressed in a follow-up worker PR, which introduces stage status.

Added some bench mark testing which is just there for fun right now, but I used it to confirm the improvements by comparing these changes to main. Improvement of about half a second, which definitely adds up over parsing thousands of rulesets.

Another thing I added was separation of if and unless operators/matchers if defined. Otherwise, they'll inherit from the Ruleset like usual (non-breaking).

codecov · 2025-02-17T21:09:03Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.61%. Comparing base (3da62c5) to head (e61458c).

❌ Your project check has failed because the head coverage (56.61%) is below the target coverage (90.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1255      +/-   ##
==========================================
+ Coverage   56.55%   56.61%   +0.06%     
==========================================
  Files         630      630              
  Lines       35710    35663      -47     
==========================================
- Hits        20195    20190       -5     
+ Misses      14828    14800      -28     
+ Partials      687      673      -14

Files with missing lines	Coverage Δ
compiler/native/compile.go	`70.37% <100.00%> (+0.06%)`	⬆️
compiler/native/native.go	`80.74% <ø> (ø)`
compiler/registry/github/github.go	`100.00% <ø> (ø)`
compiler/types/pipeline/container.go	`83.67% <100.00%> (+0.75%)`	⬆️
compiler/types/pipeline/ruleset.go	`100.00% <100.00%> (+21.71%)`	⬆️
compiler/types/pipeline/secret.go	`94.59% <100.00%> (ø)`
compiler/types/pipeline/stage.go	`96.34% <100.00%> (ø)`
compiler/types/yaml/buildkite/ruleset.go	`83.81% <100.00%> (+1.99%)`	⬆️
compiler/types/yaml/yaml/ruleset.go	`66.36% <100.00%> (+3.17%)`	⬆️
database/build/build.go	`51.72% <ø> (ø)`
... and 15 more

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

bug

github-actions · 2025-03-20T13:55:35Z

compiler/registry/github/github.go

@@ -30,7 +30,7 @@ func (c *client) Equal(other *client) bool {
 // New returns a Registry implementation that integrates
 // with GitHub or a GitHub Enterprise instance.
 //
-//nolint:revive // ignore returning unexported client
+
 func New(ctx context.Context, address, token string) (*client, error) {


🚫 [golangci] _{reported by reviewdog 🐶}
unexported-return: exported func New returns unexported type *github.client, which can be annoying to use (revive)

github-actions · 2025-03-20T13:55:35Z

database/settings/settings.go

@@ -42,7 +42,7 @@ type (

 // New creates and returns a Vela service for integrating with settings in the database.
 //
-//nolint:revive // ignore returning unexported engine
+
 func New(opts ...EngineOpt) (*engine, error) {


🚫 [golangci] _{reported by reviewdog 🐶}
unexported-return: exported func New returns unexported type *settings.engine, which can be annoying to use (revive)

github-actions · 2025-03-20T13:55:36Z

database/step/step.go

@@ -40,7 +40,7 @@ type (

 // New creates and returns a Vela service for integrating with steps in the database.
 //
-//nolint:revive // ignore returning unexported engine
+
 func New(opts ...EngineOpt) (*engine, error) {


🚫 [golangci] _{reported by reviewdog 🐶}
unexported-return: exported func New returns unexported type *step.engine, which can be annoying to use (revive)

github-actions · 2025-03-20T13:55:36Z

database/service/service.go

@@ -40,7 +40,7 @@ type (

 // New creates and returns a Vela service for integrating with services in the database.
 //
-//nolint:revive // ignore returning unexported engine
+
 func New(opts ...EngineOpt) (*engine, error) {


🚫 [golangci] _{reported by reviewdog 🐶}
unexported-return: exported func New returns unexported type *service.engine, which can be annoying to use (revive)

github-actions · 2025-03-20T13:55:36Z

database/repo/repo.go

@@ -42,7 +42,7 @@ type (

 // New creates and returns a Vela service for integrating with repos in the database.
 //
-//nolint:revive // ignore returning unexported engine
+
 func New(opts ...EngineOpt) (*engine, error) {


🚫 [golangci] _{reported by reviewdog 🐶}
unexported-return: exported func New returns unexported type *repo.engine, which can be annoying to use (revive)

github-actions · 2025-03-20T13:55:39Z

database/dashboard/dashboard.go

@@ -53,7 +53,7 @@ type (

 // New creates and returns a Vela service for integrating with dashboards in the database.
 //
-//nolint:revive // ignore returning unexported engine
+
 func New(opts ...EngineOpt) (*engine, error) {


🚫 [golangci] _{reported by reviewdog 🐶}
unexported-return: exported func New returns unexported type *dashboard.engine, which can be annoying to use (revive)

github-actions · 2025-03-20T13:55:40Z

secret/vault/vault.go

@@ -59,7 +59,7 @@ type (

 // New returns a Secret implementation that integrates with a Vault secrets engine.
 //
-//nolint:revive // ignore returning unexported client
+
 func New(opts ...ClientOpt) (*client, error) {


🚫 [golangci] _{reported by reviewdog 🐶}
unexported-return: exported func New returns unexported type *vault.client, which can be annoying to use (revive)

github-actions · 2025-03-20T13:55:40Z

scm/github/github.go

@@ -74,7 +74,7 @@ type client struct {
 // New returns a SCM implementation that integrates with
 // a GitHub or a GitHub Enterprise instance.
 //
-//nolint:revive // ignore returning unexported client
+
 func New(ctx context.Context, opts ...ClientOpt) (*client, error) {


🚫 [golangci] _{reported by reviewdog 🐶}
unexported-return: exported func New returns unexported type *github.client, which can be annoying to use (revive)

github-actions · 2025-03-20T13:55:40Z

scm/github/github.go

@@ -238,7 +238,7 @@ func (c *client) ValidateGitHubApp(ctx context.Context) error {
 //
 // This function is intended for running tests only.
 //
-//nolint:revive // ignore returning unexported client
+
 func NewTest(urls ...string) (*client, error) {


🚫 [golangci] _{reported by reviewdog 🐶}
unexported-return: exported func NewTest returns unexported type *github.client, which can be annoying to use (revive)

github-actions · 2025-03-20T13:55:41Z

compiler/native/native.go

@@ -55,7 +55,7 @@ type client struct {

 // FromCLIContext returns a Pipeline implementation that integrates with the supported registries.
 //
-//nolint:revive // ignore returning unexported client
+
 func FromCLIContext(ctx *cli.Context) (*client, error) {


🚫 [golangci] _{reported by reviewdog 🐶}
unexported-return: exported func FromCLIContext returns unexported type *native.client, which can be annoying to use (revive)

fix(ruleset): proper match for status with Or operator

2cb6f52

ecrupper requested a review from a team as a code owner February 17, 2025 21:08

plyr4 previously approved these changes Feb 17, 2025

View reviewed changes

KellyMerrick previously approved these changes Feb 17, 2025

View reviewed changes

refactor match code

fc8d0a5

ecrupper changed the title ~~fix(ruleset): proper match for status with Or operator~~ refactor(ruleset)!: improve match code efficiency and properly handle status Feb 18, 2025

Merge branch 'main' into fix/match-status-operator

e7a7ac5

timhuynh94 previously approved these changes Mar 12, 2025

View reviewed changes

KellyMerrick previously approved these changes Mar 12, 2025

View reviewed changes

ecrupper and others added 2 commits March 14, 2025 14:14

Merge branch 'main' into fix/match-status-operator

93cce3f

Merge branch 'main' into fix/match-status-operator

e61458c

ecrupper dismissed stale reviews from KellyMerrick and timhuynh94 via e61458c March 20, 2025 13:54

github-actions bot reviewed Mar 20, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(ruleset)!: improve match code efficiency and properly handle status #1255

refactor(ruleset)!: improve match code efficiency and properly handle status #1255

ecrupper commented Feb 17, 2025 •

edited

Loading

codecov bot commented Feb 17, 2025 •

edited

Loading

github-actions bot Mar 20, 2025

github-actions bot Mar 20, 2025

github-actions bot Mar 20, 2025

github-actions bot Mar 20, 2025

github-actions bot Mar 20, 2025

github-actions bot Mar 20, 2025

github-actions bot Mar 20, 2025

github-actions bot Mar 20, 2025

github-actions bot Mar 20, 2025

github-actions bot Mar 20, 2025

refactor(ruleset)!: improve match code efficiency and properly handle status #1255

Are you sure you want to change the base?

refactor(ruleset)!: improve match code efficiency and properly handle status #1255

Conversation

ecrupper commented Feb 17, 2025 • edited Loading

codecov bot commented Feb 17, 2025 • edited Loading

Codecov Report

github-actions bot Mar 20, 2025

Choose a reason for hiding this comment

github-actions bot Mar 20, 2025

Choose a reason for hiding this comment

github-actions bot Mar 20, 2025

Choose a reason for hiding this comment

github-actions bot Mar 20, 2025

Choose a reason for hiding this comment

github-actions bot Mar 20, 2025

Choose a reason for hiding this comment

github-actions bot Mar 20, 2025

Choose a reason for hiding this comment

github-actions bot Mar 20, 2025

Choose a reason for hiding this comment

github-actions bot Mar 20, 2025

Choose a reason for hiding this comment

github-actions bot Mar 20, 2025

Choose a reason for hiding this comment

github-actions bot Mar 20, 2025

Choose a reason for hiding this comment

ecrupper commented Feb 17, 2025 •

edited

Loading

codecov bot commented Feb 17, 2025 •

edited

Loading