nextcloud / nextcloud/richdocuments

Improve remote availability checking

Open
#2,124 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

1. to develop setup technical debt
Dominant language
JavaScript
Stars
453
Forks
147
Avg merge
14h 54m
Merged PRs (30d)
83

Description

Currently the discovery/capabilities endpoints are fetched and then cached quite heavily, which leads to opening documents not working properly if the Collabora server is temporarily not available when the cache expires. Users need to do a full page reload and the cache needs to expire before a restarted Collabora server can be used for editing again.

In order to improve this we should work on handling the metadata fetching more gracefully.

  • Put discovery/capabilities response into a common service
  • Fetch them once every hour, if unavailable retry every minute
  • If a page load does not have an active server (in capabilities)
    • Retry fetching on document open instead of downloading the file and show a proper error
    • This might need some internal wrapper around capabilities in the richdocuments frontend code to be able to update the state or a way to refetch capabilities and update them in the @nextcloud/capabilities npm package.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing discovery and capabilities fetching in the richdocuments frontend, then inspect how @nextcloud/capabilities exposes and updates cached state. Compare the document-open path with the file-download fallback; done means unavailable servers are retried on the stated schedule and document opening reports a proper error or recovers after capabilities are refreshed.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.