[Bug]: Dashboard widgets registered via OCA.Dashboard.register() sometimes never mount (spinner forever) – Vue 3 non-deep `callbacks` watcher race

Ouverte Adaptée aux débutants
#66,926 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
62/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Active
Stack technique
javascript
Domaine
frontend

Piste de recherche

La race se trouve dans apps/dashboard/src/DashboardApp.vue : le watcher non deep de callbacks ne se déclenche pas lorsque register(app, callback) ajoute une clé, donc rerenderPanels() n'est appelé qu'à la fin de created(). Commence par lire le watcher, register() et rerenderPanels(), puis reproduis avec un réseau bridé afin qu'un widget s'enregistre après la réponse de l'API widgets. Terminé lorsqu'un widget enregistré tardivement se monte encore, par exemple en appelant rerenderPanels() dans register() ou en rendant le watcher deep, sans casser les panneaux déjà montés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

35-feedback
⚠️ This issue respects the following points: ⚠️
  • This is a bug, not a question or a configuration/webserver/proxy issue.
  • This issue is not already reported on Github OR Nextcloud Community Forum (I've searched it).
  • Nextcloud Server is up to date.
  • I agree to follow Nextcloud's Code of Conduct.
Bug description

Dashboard widgets that use the JavaScript OCA.Dashboard.register() API (e.g. Recommended files, also Photos / Teams) sometimes show the loading spinner forever. A reload (F5), or going to Files and back, often fixes it. The server API returns the data every time (/ocs/v2.php/apps/recommendations/api/v1/recommendations/always → 200 with items), so the problem is in the frontend.

Root cause: in apps/dashboard/src/DashboardApp.vue (current master too):

watch: {
	callbacks() {
		this.$nextTick(() => this.rerenderPanels())
	},
},
// ...
register(app, callback) {
	this.callbacks[app] = callback
},

Since the move to Vue 3, a non-deep watcher on an object does not fire when a key is added (only when the whole object is replaced). So register() never triggers rerenderPanels(). The only call left is the one at the end of created(), which runs after GET /ocs/v2.php/apps/dashboard/api/v1/widgets (and the v2 item fetches) finish.

Widgets register in DOMContentLoaded (e.g. recommendations src/dashboard.js). That event only fires after all module scripts on the page and their chunks are loaded and executed (more than 100 chunk requests on our instance). If the widgets API response arrives before DOMContentLoaded, rerenderPanels() has already run. The callback is stored but never called, and the panel stays loading for good. With a warm browser cache, DOMContentLoaded fires earlier and the race is usually won. That is why the bug looks random and a reload "fixes" it. It shows up much more often behind a reverse proxy / tunnel with some latency.

Quick check of the Vue 3 behaviour:

const { reactive, watch } = require('vue') // 3.5.x
const data = reactive({ callbacks: {} })
let fired = 0
watch(() => data.callbacks, () => fired++)
data.callbacks.recommendations = () => {}
setTimeout(() => console.log(fired), 10) // -> 0

Suggested fix (applied locally on the compiled bundle, which fixes it for us):

 register(app, callback) {
 	this.callbacks[app] = callback
+	this.$nextTick(() => this.rerenderPanels())
 },

(or make the watcher deep: true). rerenderPanels() already skips panels that are mounted, so calling it more often is safe.

Steps to reproduce
  1. Enable the Recommendations app and keep "Recommended files" on the dashboard.
  2. Open the dashboard with an empty browser cache, or with extra network latency (DevTools throttling, or a reverse proxy/tunnel in front of Nextcloud).
  3. The "Recommended files" panel sometimes keeps spinning forever. In the network tab, /recommendations/always returns the items, but the widget is never mounted.
Expected behavior

The widget mounts whenever its register() call happens, also when that is after the first rerenderPanels().

Nextcloud Server version

35 (35.0.2)

Operating system

Other (official nextcloud:35.0.2-apache Docker image)

PHP engine version

PHP 8.5

Web server

Apache (supported)

Database engine version

MariaDB

Is this bug present after an update or on a fresh install?

Not sure — first noticed on 35.0.2 (the bug is in the code since the dashboard moved to Vue 3)

Are you using the Nextcloud Server Encryption module?

Encryption is Disabled

What user-backends are you using?
  • Default user-backend (database)
Configuration report
Not relevant (frontend race, reproducible from the code above)
List of activated Apps
dashboard 8.0.0, recommendations 8.0.0, photos 8.0.0, circles 35.0.0
Nextcloud Signing status
No errors before the local workaround patch of dist/dashboard-main.mjs
Nextcloud Logs
No server-side errors; all API requests return 200.
Additional info

Affects every widget that uses OCA.Dashboard.register() (recommendations, photos, circles/teams). API v2 widgets are not affected.

Langage dominant
PHP
Étoiles
37.6k
Forks
5.4k
Merge moyen
1 j 16 h
PR mergées (30 j)
660

Préparer son environnement

Ouvrir dans Codespaces

Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de nextcloud/server

Toutes les issues de nextcloud/server

Issues similaires

Plus d'issues PHP

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.