Handle partial node query successes when all nodes are selected

[alyssadai]

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]

Blocked by neurobagel/planning#96

[rmanaem]

Unblocked since neurobagel/planning#96 has been addressed

[surchs]

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]

@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]

🚀 Issue was released in v0.2.0 🚀