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.

Sign up for GitHub

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

Jump to bottom

feat(ecocredit): query batches by credit class name #885

Merged
merged 6 commits into from
Mar 15, 2022
Merged

feat(ecocredit): query batches by credit class name #885

merged 6 commits into from
Mar 15, 2022

Conversation

technicallyty
Copy link
Contributor

@technicallyty technicallyty commented Mar 14, 2022 •
edited by zube bot
Loading

Description

  • adds a query for batches under a given credit class

ref: #167

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)

@technicallyty technicallyty mentioned this pull request Mar 14, 2022
Closed
4 tasks
@codecov
Copy link

codecov bot commented Mar 14, 2022 •
edited
Loading

Codecov Report

Merging #885 (ccf626e) into master (888f8a5) will decrease coverage by 46.78%.
The diff coverage is 50.00%.

❗ Current head ccf626e differs from pull request most recent head 8196d3d. Consider uploading reports for the commit 8196d3d to get more accurate results

@@             Coverage Diff             @@
##           master     #885       +/-   ##
===========================================
- Coverage   74.02%   27.24%   -46.79%     
===========================================
  Files         171      196       +25     
  Lines       22115    72807    +50692     
===========================================
+ Hits        16371    19837     +3466     
- Misses       4631    51230    +46599     
- Partials     1113     1740      +627
Flag Coverage Δ
experimental-codecov 27.22% <50.00%> (-46.78%) ⬇️
stable-codecov 23.88% <50.00%> (-42.71%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

ryanchristo
ryanchristo approved these changes Mar 15, 2022
View reviewed changes
Copy link
Member

@ryanchristo ryanchristo 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 to me. One question. Pre-approving.

x/ecocredit/server/core/query_batches_by_class.go Outdated
Comment on lines 20 to 21
// we put a "-" after the class name to avoid including class names outside of the query (i.e. a query for C01 could technically include C011 otherwise).
it, err := k.stateStore.BatchInfoStore().List(ctx, api.BatchInfoBatchDenomIndexKey{}.WithBatchDenom(class.Name+"-"), ormlist.Paginate(pg))
Copy link
Member

Choose a reason for hiding this comment

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

I was able to successfully run the tests without "-" added here. Are you sure this is necessary?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's not that queries won't run successfully, its that it could include classes you weren't necessarily querying for.

Like in the example in the comment, if there are two classes, "C01" and "C011" (for whatever reason), without the added "-", it would include "C011" or any other class that starts with C01. the "-" ensures we only get C01 batches

Copy link
Contributor Author

Choose a reason for hiding this comment

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

added a test case to highlight this, if you remove the dash you'll see it fails without it

@technicallyty technicallyty merged commit f0faf4c into master Mar 15, 2022
@technicallyty technicallyty deleted the ty/167-batch_by_class branch March 15, 2022 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aleem1314 aleem1314 aleem1314 approved these changes

@ryanchristo ryanchristo ryanchristo approved these changes

@aaronc aaronc Awaiting requested review from aaronc

@robert-zaremba robert-zaremba Awaiting requested review from robert-zaremba

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@technicallyty @ryanchristo @aleem1314