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

refactor!(collections): don't panic when initializing collections #14323

Merged
merged 9 commits into from
Dec 24, 2022

Conversation

aaronc
Copy link
Member

@aaronc aaronc commented Dec 15, 2022

Description

This changes the collections API to not panic because of schema errors by using a builder pattern, addressing #14267 (comment)


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Comment on lines +44 to +57
for prefix := range s.schema.collectionsByPrefix {
for prefix2 := range s.schema.collectionsByPrefix {
// don't compare the prefix to itself
if prefix == prefix2 {
continue
}

// if one prefix is the prefix of the other we have an overlap and
// this schema is corrupt
if strings.HasPrefix(prefix, prefix2) {
return Schema{}, fmt.Errorf("schema has overlapping prefixes 0x%x and 0x%x", prefix, prefix2)
}
}
}

Check failure

Code scanning / gosec

the value in the range statement should be _ unless copying a map: want: for key := range m

got *ast.RangeStmt; expected exactly 1 statement (either append or delete) in a range with a map
Comment on lines +45 to +56
for prefix2 := range s.schema.collectionsByPrefix {
// don't compare the prefix to itself
if prefix == prefix2 {
continue
}

// if one prefix is the prefix of the other we have an overlap and
// this schema is corrupt
if strings.HasPrefix(prefix, prefix2) {
return Schema{}, fmt.Errorf("schema has overlapping prefixes 0x%x and 0x%x", prefix, prefix2)
}
}

Check failure

Code scanning / gosec

the value in the range statement should be _ unless copying a map: want: for key := range m

expected exactly 1 statement (either append, delete, or copying to another map) in a range with a map, got 2
Copy link
Contributor

Choose a reason for hiding this comment

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

?

Copy link
Contributor

@testinginprod testinginprod left a comment

Choose a reason for hiding this comment

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

LGTM, would maybe like only the panic on re-using a builder to be explicit.

collections/go.mod Outdated Show resolved Hide resolved
}

schema := *s.schema
s.schema = nil // this makes the builder unusable
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe an explicit panic check is better to debug than a nil pointer dereference I think

Copy link
Member

Choose a reason for hiding this comment

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

added, can you check?

@sonarcloud
Copy link

sonarcloud bot commented Dec 23, 2022

[Cosmos SDK] Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@tac0turtle tac0turtle enabled auto-merge (squash) December 24, 2022 10:49
@sonarcloud
Copy link

sonarcloud bot commented Dec 24, 2022

[Cosmos SDK - Collections] Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@tac0turtle tac0turtle merged commit 1d2de85 into main Dec 24, 2022
@tac0turtle tac0turtle deleted the aaronc/collections-schema-no-panic branch December 24, 2022 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants