[Bug]: Dashboard widgets registered via OCA.Dashboard.register() sometimes never mount (spinner forever) – Vue 3 non-deep `callbacks` watcher race
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 62/100
- Tipo de issue
- Error
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- javascript
- Área
- frontend
Línea de trabajo
La race está en apps/dashboard/src/DashboardApp.vue: el watcher no profundo de callbacks no se dispara cuando register(app, callback) añade una clave, así que rerenderPanels() solo se llama desde el final de created(). Empieza leyendo el watcher, register() y rerenderPanels(), y luego reproduce con red limitada para que un widget se registre después de la respuesta de la API de widgets. Terminado cuando un widget registrado tarde todavía se monta, por ejemplo llamando a rerenderPanels() en register() o haciendo profundo el watcher, sin romper los paneles ya montados.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
⚠️ 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
- Enable the Recommendations app and keep "Recommended files" on the dashboard.
- Open the dashboard with an empty browser cache, or with extra network latency (DevTools throttling, or a reverse proxy/tunnel in front of Nextcloud).
- The "Recommended files" panel sometimes keeps spinning forever. In the network tab,
/recommendations/alwaysreturns 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.
- Lenguaje dominante
- PHP
- Estrellas
- 37.6k
- Forks
- 5.4k
- Merge medio
- 1 d 16 h
- PR fusionados (30 d)
- 660
Preparar el entorno
Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de nextcloud/server
-
35-feedback
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Los mantenedores suelen responder en 1 día
-
[Bug]:Posiblemente ocupada @lazerg la tomó hoy. Abierto0. Needs triage 35-feedback bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
Link share editor: "Custom permissions" is checked for a new link sharePosiblemente ocupada @lazerg la tomó hoy. Abierto0. Needs triage bug feature: sharing regression
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
0. Needs triage 35-feedback bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Los mantenedores suelen responder en 1 día
Todos los issues de nextcloud/server
Issues similares
-
bug good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
quantum-php/framework#692 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 70/100
ajeetraina/awesome-docker-sbx#559 ·
-
PHP 8.6 supportAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
Saisie des adressesAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
pantaflex44/Tiquettes#116 · 1 comentario ·
-
dependencies enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
novalo-dev/Prestashop-MCP-Server#329 ·
Los mantenedores suelen responder en 1 día