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

feat(DPE-35): Created Collections rules #86

Merged
merged 11 commits into from
Aug 12, 2024
Merged

Conversation

sps-benjacobs
Copy link
Contributor

@sps-benjacobs sps-benjacobs commented Jul 11, 2024

Impact testing results are about 8 more errors in total. The execution time for the impact testing is within a second or so compared to the current ruleset in the main branch.

Performance testing results are okay. These changes will create about 700 more errors or warnings within this Open API document suite we use. About 564 of those 700 errors/warnings are mainly concentrated in a few documents. The two rules sps-missing-pagination-query-parameters and sps-no-collection-paging-capability are the ones that are causing the most errors since not all GET endpoints are not designed with collections capabilities. Execution time is still within a second or so of the current ruleset on the main branch.

@sps-benjacobs sps-benjacobs requested a review from a team as a code owner July 11, 2024 21:45
@sps-benjacobs sps-benjacobs changed the title feat: Created Collections rules (DPE-135) feat: Created Collections rules (DPE-35) Jul 11, 2024
@sps-benjacobs sps-benjacobs changed the title feat: Created Collections rules (DPE-35) feat(DPE-35): Created Collections rules Jul 12, 2024
Copy link
Contributor

@brandonsahadeo brandonsahadeo left a comment

Choose a reason for hiding this comment

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

Looks good! The impact overall is pretty minimal, so I'd say lets go ahead and roll this out incrementally starting Monday Morning 🫡

Copy link
Member

@travisgosselin travisgosselin left a comment

Choose a reason for hiding this comment

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

Added some considerations. Also, I'm a bit worried about making too many assumptions about endpoints being collections. What is the impact seen on specifically network API related specs for these? like Documents / Items / Printables? (sps-missing-pagination-query-parameters and sps-no-collection-paging-capability)

rulesets/src/collections.ruleset.yml Show resolved Hide resolved
rulesets/src/collections.ruleset.yml Outdated Show resolved Hide resolved
rulesets/src/collections.ruleset.yml Show resolved Hide resolved
rulesets/src/collections.ruleset.yml Outdated Show resolved Hide resolved
rulesets/src/collections.ruleset.yml Outdated Show resolved Hide resolved
rulesets/src/collections.ruleset.yml Outdated Show resolved Hide resolved
rulesets/src/collections.ruleset.yml Outdated Show resolved Hide resolved
rulesets/src/collections.ruleset.yml Outdated Show resolved Hide resolved
rulesets/src/collections.ruleset.yml Outdated Show resolved Hide resolved
@sps-benjacobs
Copy link
Contributor Author

Here are the results of the Summary of performance testing:

  • increased execution time by about 2 seconds
  • 763 new errors
    • I haven't looked into which rule causes the most errors but I am assuming it sps-missing-pagination-query-parameters and sps-no-collection-paging-capability since they are the two rules that are the most rigid ones within this rule expansion
  • 5 new warnings

Here are the results of the Summary of Impact testing:

Sevices warnings errors time (seconds)
documents 0 7 3.5
items 0 8 3.65
lookup-store 0 0 3.1
odo-bridge 0 2 3.02
printables 0 0 3.36
rules-management 0 0 2.91

This resulted in 16 new errors.
Error Break down:

Rules count
sps-missing-pagination-query-parameters 14
sps-no-collection-paging-capability 2
total 16

Copy link
Contributor

@markdebeer markdebeer left a comment

Choose a reason for hiding this comment

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

Looks great! Just a few spelling issues

EthanHonzikSPS and others added 3 commits August 9, 2024 14:18
…t-filter.test.js

Co-authored-by: Mark DeBeer <[email protected]>
Signed-off-by: Ethan Honzik <[email protected]>
…t-filter.test.js

Co-authored-by: Mark DeBeer <[email protected]>
Signed-off-by: Ethan Honzik <[email protected]>
…t-filter.test.js

Co-authored-by: Mark DeBeer <[email protected]>
Signed-off-by: Ethan Honzik <[email protected]>
@EthanHonzikSPS EthanHonzikSPS merged commit 1ad59f3 into main Aug 12, 2024
2 checks passed
@EthanHonzikSPS EthanHonzikSPS deleted the collections-rules branch August 12, 2024 15:17
SPSCommerce-VSTS-BOT pushed a commit that referenced this pull request Aug 12, 2024
# [1.13.0](v1.12.0...v1.13.0) (2024-08-12)

### Features

* **DPE-35:** Created Collections rules ([#86](#86)) ([1ad59f3](1ad59f3))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants