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

Handle partial node query successes when all nodes are selected #60

Closed
alyssadai opened this issue Jan 25, 2024 · 5 comments · Fixed by #97
Closed

Handle partial node query successes when all nodes are selected #60

alyssadai opened this issue Jan 25, 2024 · 5 comments · Fixed by #97
Assignees
Labels
feat:add The first minimal viable change that implements a new functionality. released This issue/pull request has been released. type:feature Effort to deliver new features, feature changes & improvements

Comments

@alyssadai
Copy link
Contributor

alyssadai commented Jan 25, 2024

See https://github.com/neurobagel/federation-api/blob/350469a3a72d9ac6278d8371116c195b95a1b276/app/api/models.py#L57-L62 for what the new response from the federation API should look like.

Note that node API responses have not changed their shape at all.

UI behaviour should be:

  • complete succes:
    • all nodes respond correctly
    • -> no change
  • partial failure:
    • at least one node does not respond / errors,
    • and at least one node responds correctly
    • -> show successful results normally, have a warning toast for each node that has failed.
  • complete failure
    • none of the nodes have responded
    • -> do not show any results, instead show an error message in the results area
    • -> also show an error toast and say that all nodes have failed.

optional -> auto-remove all the nodes that have failed?

@alyssadai alyssadai added feat:add The first minimal viable change that implements a new functionality. type:feature Effort to deliver new features, feature changes & improvements labels Jan 25, 2024
@alyssadai
Copy link
Contributor Author

Blocked by neurobagel/planning#96

@surchs surchs transferred this issue from neurobagel/old-query-tool Mar 7, 2024
@rmanaem
Copy link
Contributor

rmanaem commented Mar 13, 2024

Unblocked since neurobagel/planning#96 has been addressed

@surchs
Copy link
Contributor

surchs commented Mar 26, 2024

This would be a good deal easier if we had up to date examples of the expected responses. I made an issue to provide these here neurobagel/neurobagel_examples#31

@surchs
Copy link
Contributor

surchs commented Mar 26, 2024

@neurobagel/dev what would a partially successful federated API query response look like? I.e. how would I know that any nodes have failed to respond / which nodes didn't respond?

edit: answering my own question with the current test from f-API:
https://github.com/neurobagel/federation-api/blob/771b1a2fd21030ee3a6fe1a8bc6c37db401a8fd1/tests/test_query.py#L60-L74

But want to reiterate: we need to have a reference example for these responses. Either just the static files / shapes / response objects, or - better - that and also a live staging deployment we can play with!

@surchs
Copy link
Contributor

surchs commented Apr 11, 2024

🚀 Issue was released in v0.2.0 🚀

@surchs surchs added the released This issue/pull request has been released. label Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat:add The first minimal viable change that implements a new functionality. released This issue/pull request has been released. type:feature Effort to deliver new features, feature changes & improvements
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants