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

api: return empty lists from fetchApplications and fetchAppLocalStates #1010

Merged
merged 1 commit into from May 25, 2022

Conversation

erer1243
Copy link
Contributor

Currently, fetchApplications and fetchAppLocalStates in handlers.go declare their result slices using var. This causes those slices to be initialized to nil. In turn, when there are no applications/app local states to be found, the rest endpoints that use these methods end up returning null in the response json instead of an empty list. E.g. querying /v2/accounts/{account-id}/apps-local-state for an account not participating in any contracts will return { 'apps-local-states': null, 'round': ... }. This has caused some confusion, as the rest api docs do not acknowledge this possibility.

This PR changes the behavior of those two methods to create their slices using make. This causes the endpoints to return empty lists instead of null.

@CLAassistant
Copy link

CLAassistant commented May 24, 2022

CLA assistant check
All committers have signed the CLA.

@codecov
Copy link

codecov bot commented May 24, 2022

Codecov Report

Merging #1010 (3d4a8e9) into develop (f26fca1) will decrease coverage by 0.03%.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##           develop    #1010      +/-   ##
===========================================
- Coverage    59.58%   59.54%   -0.04%     
===========================================
  Files           45       45              
  Lines         8353     8353              
===========================================
- Hits          4977     4974       -3     
- Misses        2918     2920       +2     
- Partials       458      459       +1     
Impacted Files Coverage Δ
api/handlers.go 72.68% <100.00%> (ø)
fetcher/fetcher.go 34.64% <0.00%> (-1.32%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f26fca1...3d4a8e9. Read the comment docs.

@winder winder changed the title handlers.go fetchApplications, fetchAppLocalStates make empty slice api: return empty lists instead of null from fetchApplications and fetchAppLocalStates May 25, 2022
@winder winder added bug Something isn't working Bug-Fix and removed bug Something isn't working labels May 25, 2022
@winder winder changed the title api: return empty lists instead of null from fetchApplications and fetchAppLocalStates api: return empty lists from fetchApplications and fetchAppLocalStates May 25, 2022
@winder winder merged commit 9f1dea3 into algorand:develop May 25, 2022
@winder
Copy link
Contributor

winder commented May 25, 2022

Thanks for the PR!

Eric-Warehime added a commit that referenced this pull request Jun 16, 2022
* return empty lists from fetchApplications and fetchAppLocalStates (#1010)

* Update model to converge with algod (#1005)

* New Feature: Adds Data Directory Support (#1012)

- Updates the go-algorand submodule hash to point to rel/beta
- Moves the cpu profiling file, pid file and indexer configuration file
  to be options of only the daemon sub-command
- Changes os.Exit() to be a panic with a special handler.  This is so
  that defer's are handled instead of being ignored.
- Detects auto-loading configuration files in the data directory and
  issues errors if equivalent command line arguments are supplied.
- Updates the README with instructions on how to use the auto-loading
  configuration files and the data directory.

* Update mockery version

Co-authored-by: erer1243 <1377477+erer1243@users.noreply.github.com>
Co-authored-by: AlgoStephenAkiki <85183435+AlgoStephenAkiki@users.noreply.github.com>
Eric-Warehime added a commit that referenced this pull request Jul 21, 2022
* Local Ledger (#1011)

* integrate block processor

* Local Ledger Deployment (#1013)

* add simple local ledger migration

* add deleted opts

* fast catchup (#1023)

* add fast catchup

* Localledger merge (#1036)

* return empty lists from fetchApplications and fetchAppLocalStates (#1010)

* Update model to converge with algod (#1005)

* New Feature: Adds Data Directory Support (#1012)

- Updates the go-algorand submodule hash to point to rel/beta
- Moves the cpu profiling file, pid file and indexer configuration file
  to be options of only the daemon sub-command
- Changes os.Exit() to be a panic with a special handler.  This is so
  that defer's are handled instead of being ignored.
- Detects auto-loading configuration files in the data directory and
  issues errors if equivalent command line arguments are supplied.
- Updates the README with instructions on how to use the auto-loading
  configuration files and the data directory.

* Update mockery version

Co-authored-by: erer1243 <1377477+erer1243@users.noreply.github.com>
Co-authored-by: AlgoStephenAkiki <85183435+AlgoStephenAkiki@users.noreply.github.com>

* recovery scenario (#1024)

* handle ledger recovery scenario

* refactor create genesis block (#1026)

* refactor create genesis block

* Adds Local Ledger Readme (#1035)

* Adds Local Ledger Readme

Resolves #4109

Starts Readme docs

* Update docs/LocalLedger.md

Co-authored-by: Will Winder <wwinder.unh@gmail.com>

* Update docs/LocalLedger.md

Co-authored-by: Will Winder <wwinder.unh@gmail.com>

* Update docs/LocalLedger.md

Co-authored-by: Will Winder <wwinder.unh@gmail.com>

* Removed troubleshooting section

Co-authored-by: Will Winder <wwinder.unh@gmail.com>

* update ledger file path and migration (#1042)

* LocalLedger Refactoring + Catchpoint Service (#1049)

Part 1

    cleanup genesis file access.
    put node catchup into a function that can be swapped out with the catchup service.
    pass the indexer logger into the block processor.
    move open ledger into a util function, and move the initial state util function into a new ledger util file.
    add initial catchupservice implementation.
    move ledger init from daemon.go to constructor.
    Merge multiple read genesis functions.

Part 2

    Merge local_ledger migration package into blockprocessor.
    Rename Migration to Initialize
    Use logger in catchup service catchup

Part 3

    Update submodule and use NewWrappedLogger.
    Make util.CreateInitState private

* build: merge develop into localledger/integration (#1062)

* Ledger init status (#1058)

* Generate an error if the catchpoint is not valid for initialization. (#1075)

* Use main logger in handler and fetcher. (#1077)

* Switch from fullNode catchup to catchpoint catchup service. (#1076)

* Refactor daemon, add more tests (#1039)

Refactors daemon cmd into separate, testable pieces.

* Merge develop into localledger/integration (#1083)

* Misc Local Ledger cleanup (#1086)

* Update processor/blockprocessor/initialize.go

Co-authored-by: Zeph Grunschlag <tzaffi@users.noreply.github.com>

* commit

* fix function call args

* RFC-0001: Rfc 0001 impl (#1069)

Adds an Exporter interface and a noop exporter implementation with factory methods for construction

* Fix test errors

* Add/fix tests

* Add postgresql_exporter tests

* Update config loading

* Change BlockExportData to pointers

* Move and rename ExportData

* Add Empty func to BlockData

* Add comment

Co-authored-by: shiqizng <80276844+shiqizng@users.noreply.github.com>
Co-authored-by: shiqi.zheng@algorand.com <shiqi.zheng@algorand.com>
Co-authored-by: erer1243 <1377477+erer1243@users.noreply.github.com>
Co-authored-by: AlgoStephenAkiki <85183435+AlgoStephenAkiki@users.noreply.github.com>
Co-authored-by: Will Winder <wwinder.unh@gmail.com>
Co-authored-by: Zeph Grunschlag <tzaffi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants