Skip to content

Check remote API status #425

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

Draft
wants to merge 12 commits into
base: develop
Choose a base branch
from
Draft

Check remote API status #425

wants to merge 12 commits into from

Conversation

ilicfilip
Copy link
Collaborator

@ilicfilip ilicfilip commented Apr 14, 2025

Context

We ping our API for a lot of things, not just for registration and getting data but also getting badge graphics and etc.

We have fallback for images and we cache API response for 5 minutes if the response from our server was empty, but users don't know that which can be confusing.

This PR adds following:

  • A note on the Settings page if the Page types are not loaded from API
  • A button on the Settings page which pings our server and displays a status message (so user can check API status in the real time).
  • Improves check for "Save settings" task, to add it only if Page types are fetched from our server

The thing that still needs to be implemented is some kind of notice, probably on the PP Dashboard page when it is detected that some API call has failed.

Fixes #422

Copy link
Contributor

github-actions bot commented Apr 14, 2025

Test on Playground
Test this pull request on the Playground or download the zip.

@ilicfilip
Copy link
Collaborator Author

@tacoverdo , I have added everything we talked about in the meeting except the notice, on the PP Dashboard screen, that Page Types are not fetched from our server - we said that we might replace the content of the Challenge widget with it.

The reason is that if our API is not working a lot of things will not work, including the Onboard process. Then again, if some data is fetched from our API, for example Challenge content - do we want to replace it with the notice?

Since there is an info about the Page Types not being loaded from our server (and the button for testing API status) on the Settings page maybe that is enough for now?

This is the note which is displayed to the user if pages are not loaded:
There seems to be a problem with loading page types from our server. Please try again later or check the API status.

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.

Settings page is missing settings for new installs of Progress Planner
1 participant