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(x/data): update query service and commands #1156

Merged
merged 24 commits into from
Jun 15, 2022

Conversation

ryanchristo
Copy link
Member

@ryanchristo ryanchristo commented Jun 6, 2022

Description

Ref: #714 / #1152

This pull request makes the following changes:

  • updates ByIRI and ByHash to AnchorByIRI and AnchorByHash for clarification
  • updates AttestorsByIRI and AttestorsByHash to AttestationsByIRI and AttestationsByHash for clarification
  • updates ContentEntry to AnchorInfo and moves to query.go for consistent query response type naming
  • updates AttestorEntry to AttestationInfo and moves to query.go for consistent query response type naming
  • updates conversion queries to not use the Query prefix for clarification (we are not querying state)
  • removes conversion queries by the properties of each hash type and add post option for ConvertHashToIRI
  • updates all other queries ByHash to include post option providing previously excluded gRPC REST endpoints
  • updates comments and tests to reflect the changes listed above and cleans up integration tests

If need be, I can break this up into smaller pull requests but one thing led to another...


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)

@codecov
Copy link

codecov bot commented Jun 6, 2022

Codecov Report

Merging #1156 (eaa2fcd) into master (eb742da) will decrease coverage by 0.13%.
The diff coverage is 93.20%.

@@            Coverage Diff             @@
##           master    #1156      +/-   ##
==========================================
- Coverage   69.59%   69.45%   -0.14%     
==========================================
  Files         221      227       +6     
  Lines       23082    23283     +201     
==========================================
+ Hits        16064    16172     +108     
- Misses       5638     5712      +74     
- Partials     1380     1399      +19     
Flag Coverage Δ
experimental-codecov 69.72% <93.20%> (+0.06%) ⬆️
stable-codecov 64.08% <93.20%> (+0.02%) ⬆️

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

@ryanchristo ryanchristo marked this pull request as ready for review June 10, 2022 05:08
@ryanchristo ryanchristo marked this pull request as draft June 11, 2022 19:19
@ryanchristo ryanchristo marked this pull request as ready for review June 13, 2022 04:49
@ryanchristo
Copy link
Member Author

Ready for review again. I can walk through the changes and break out into small pull requests if needed.

@ryanchristo ryanchristo changed the title refactor(x/data): descriptive api naming and endpoints refactor(x/data): descriptive api naming updated query service Jun 13, 2022
@ryanchristo ryanchristo changed the title refactor(x/data): descriptive api naming updated query service refactor(x/data): descriptive api naming update query service Jun 13, 2022
@ryanchristo ryanchristo changed the title refactor(x/data): descriptive api naming update query service refactor(x/data): update query service and commands Jun 13, 2022
Copy link
Contributor

@technicallyty technicallyty left a comment

Choose a reason for hiding this comment

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

pre-approving. just needs iterator closes & paginations mentioned above 👍🏻

x/data/server/query_resolvers_by_hash.go Outdated Show resolved Hide resolved
x/data/server/query_resolvers_by_iri.go Outdated Show resolved Hide resolved
x/data/server/query_resolvers_by_url.go Outdated Show resolved Hide resolved
ryanchristo and others added 2 commits June 14, 2022 12:03
Co-authored-by: Tyler <48813565+technicallyty@users.noreply.github.com>
@ryanchristo ryanchristo merged commit 97c30d6 into master Jun 15, 2022
@ryanchristo ryanchristo deleted the ryan/714-data-api-audit branch June 15, 2022 16:14
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.

3 participants