Dashboard API for clients #26430

julien-nc · 2021-04-06T09:27:06Z

This brings a new dashboard API endpoint which provides a standardized way to get enabled widgets content for Nextcloud clients. For the moment, only widgets displaying an ordered list of items can be accessed by this API. It could be extended to other kinds of content later.

The new WidgetItem class is a generic representation of one widget element.
The initial IWidget interface can still be used by widgets. The new IAPIWidget interface just adds a getItems method which returns an array of WidgetItem.

Here are the changes made to GitHub integration dashboard widget to implement this client API:
nextcloud/integration_github@e888d8f#diff-322e5fa76010510d00333c44839783ab8b832362c8719b4b54ae08a6b99e853bR44

apps/dashboard/appinfo/routes.php

apps/dashboard/lib/Controller/DashboardController.php

apps/dashboard/appinfo/routes.php

lib/public/Dashboard/Model/WidgetItem.php

juliusknorr

General structure seems fine, there are some php-cs and psalm failures besides my comments.

juliusknorr · 2021-04-08T09:09:13Z

Once merged this should also be documented in https://docs.nextcloud.com/server/21/developer_manual/digging_deeper/dashboard.html

julien-nc · 2021-04-08T11:58:02Z

@juliushaertl Thanks for the review. Link added, php-cs/psalm error fixed and rebased on master.

apps/dashboard/lib/Controller/DashboardApiController.php

lib/public/Dashboard/Model/WidgetItem.php

juliusknorr · 2021-04-13T18:18:02Z

apps/dashboard/lib/Controller/DashboardApiController.php

+		$widgets = $this->dashboardManager->getWidgets();
+		foreach ($widgets as $widget) {
+			if ($widget instanceof IAPIWidget && in_array($widget->getId(), $userLayout)) {
+				$items[$widget->getId()] = array_map(function (WidgetItem $item) {


There shouldn't be a need or the mapping if the WidgetItem implements JsonSerializable

What do you mean?
How would you serialize each item?

https://3v4l.org/n0PPI

juliusknorr

Some smaller additional comments but otherwise 👍

MorrisJobke · 2021-05-21T14:20:45Z

🏓

skjnldsv · 2021-06-02T15:04:33Z

Moved to 23

julien-nc · 2021-06-08T13:10:55Z

@juliushaertl @MorrisJobke @skjnldsv Rebased on master, affected milestone 22 again (it does not break anything and it's ready).

I don't know why the ci/drone/pr fails...

juliusknorr · 2021-06-09T05:03:09Z

From https://drone.nextcloud.com/nextcloud/server/6078/1/3

The autoloaders are not up to date
Please run: bash build/autoloaderchecker.sh
And commit the result

juliusknorr · 2021-06-09T05:04:09Z

Other drone failures seem unrelated

MorrisJobke

Code looks good (beside the one nitpick) 👍

juliusknorr · 2021-06-14T07:49:57Z

🏓 @eneiluj

skjnldsv · 2021-06-14T12:18:25Z

@artonge could you have a look at this and see if you can find any blockers? :)

artonge · 2021-06-14T13:07:26Z

The code scanning warnings should get fixed. And it would be saner with Julius' suggestion for the JSON serialisation. Beside that, LGTM. But I might not be the best juge for php code yet 😉

artonge

Oh nop, comments are wrong 😞 .

lib/public/Dashboard/IAPIWidget.php

lib/public/Dashboard/Model/WidgetItem.php

…dget interface Signed-off-by: Julien Veyssier <[email protected]>

Signed-off-by: Julius Härtl <[email protected]>

juliusknorr · 2021-06-15T19:36:45Z

Rebased and pushed the updated autoloader.

julien-nc added enhancement 3. to review Waiting for reviews feature: dashboard labels Apr 6, 2021

julien-nc added this to the Nextcloud 22 milestone Apr 6, 2021

julien-nc requested a review from juliusknorr April 6, 2021 09:27

nickvergessen reviewed Apr 6, 2021

View reviewed changes

apps/dashboard/appinfo/routes.php Outdated Show resolved Hide resolved

nickvergessen reviewed Apr 6, 2021

View reviewed changes

apps/dashboard/lib/Controller/DashboardController.php Outdated Show resolved Hide resolved

julien-nc requested a review from nickvergessen April 6, 2021 11:48

nickvergessen reviewed Apr 6, 2021

View reviewed changes

apps/dashboard/appinfo/routes.php Outdated Show resolved Hide resolved

julien-nc force-pushed the enh/dashboard-api branch from f38c81b to e44d9b8 Compare April 6, 2021 12:26

julien-nc requested a review from nickvergessen April 6, 2021 12:28

juliusknorr reviewed Apr 8, 2021

View reviewed changes

lib/public/Dashboard/Model/WidgetItem.php Outdated Show resolved Hide resolved

juliusknorr reviewed Apr 8, 2021

View reviewed changes

lib/public/Dashboard/Model/WidgetItem.php Show resolved Hide resolved

juliusknorr reviewed Apr 8, 2021

View reviewed changes

juliusknorr added the pending documentation This pull request needs an associated documentation update label Apr 8, 2021

julien-nc force-pushed the enh/dashboard-api branch 2 times, most recently from c40f928 to 4e4d921 Compare April 8, 2021 10:59

julien-nc mentioned this pull request Apr 8, 2021

[WIP] Dashboard API for clients nextcloud/documentation#6360

Merged

juliusknorr reviewed Apr 13, 2021

View reviewed changes

apps/dashboard/lib/Controller/DashboardApiController.php Outdated Show resolved Hide resolved

juliusknorr reviewed Apr 13, 2021

View reviewed changes

lib/public/Dashboard/Model/WidgetItem.php Outdated Show resolved Hide resolved

juliusknorr reviewed Apr 13, 2021

View reviewed changes

juliusknorr approved these changes Apr 13, 2021

View reviewed changes

julien-nc force-pushed the enh/dashboard-api branch from 4e4d921 to 69fc91b Compare April 14, 2021 09:18

MorrisJobke mentioned this pull request May 20, 2021

22 beta1 #26953

Merged

MorrisJobke mentioned this pull request May 26, 2021

22.0.0 beta 2 #27111

Merged

98 tasks

blizzz mentioned this pull request Jun 2, 2021

22.0.0 beta 3 #27342

Merged

57 tasks

skjnldsv modified the milestones: Nextcloud 22, Nextcloud 23 Jun 2, 2021

julien-nc force-pushed the enh/dashboard-api branch from 69fc91b to af47bfb Compare June 7, 2021 15:52

julien-nc modified the milestones: Nextcloud 23, Nextcloud 22 Jun 8, 2021

julien-nc force-pushed the enh/dashboard-api branch from af47bfb to 3f8dff7 Compare June 8, 2021 11:59

juliusknorr requested review from skjnldsv and MorrisJobke June 9, 2021 05:03

MorrisJobke approved these changes Jun 10, 2021

View reviewed changes

MorrisJobke mentioned this pull request Jun 10, 2021

22.0.0 Beta 4 #27458

Merged

59 tasks

artonge requested changes Jun 14, 2021

View reviewed changes

lib/public/Dashboard/IAPIWidget.php Show resolved Hide resolved

lib/public/Dashboard/IAPIWidget.php Show resolved Hide resolved

lib/public/Dashboard/Model/WidgetItem.php Show resolved Hide resolved

lib/public/Dashboard/Model/WidgetItem.php Show resolved Hide resolved

artonge approved these changes Jun 15, 2021

View reviewed changes

Julien Veyssier and others added 2 commits June 15, 2021 21:34

implement dashboard API for clients, new WidgetItem class, new IAPIWi…

e15270c

…dget interface Signed-off-by: Julien Veyssier <[email protected]>

Update autoloader

08899c8

Signed-off-by: Julius Härtl <[email protected]>

juliusknorr force-pushed the enh/dashboard-api branch from 3f8dff7 to 08899c8 Compare June 15, 2021 19:36

juliusknorr added 4. to release Ready to be released and/or waiting for tests to finish and removed 3. to review Waiting for reviews labels Jun 15, 2021

juliusknorr merged commit 51add75 into master Jun 16, 2021

juliusknorr deleted the enh/dashboard-api branch June 16, 2021 09:34

blizzz mentioned this pull request Jun 16, 2021

22.0.0 beta 5 #27525

Merged

45 tasks

ChristophWurst removed the pending documentation This pull request needs an associated documentation update label Jul 5, 2021

This was referenced Aug 23, 2022

Extend dashboard api to allow listing of widgets #33658

Merged

implement dashboard api for recommended files nextcloud/recommendations#543

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dashboard API for clients #26430

Dashboard API for clients #26430

julien-nc commented Apr 6, 2021

juliusknorr left a comment

juliusknorr commented Apr 8, 2021

julien-nc commented Apr 8, 2021

juliusknorr Apr 13, 2021

julien-nc Apr 14, 2021

nickvergessen Jun 9, 2021

juliusknorr left a comment

MorrisJobke commented May 21, 2021

skjnldsv commented Jun 2, 2021

julien-nc commented Jun 8, 2021

juliusknorr commented Jun 9, 2021

juliusknorr commented Jun 9, 2021

MorrisJobke left a comment

juliusknorr commented Jun 14, 2021

skjnldsv commented Jun 14, 2021

artonge commented Jun 14, 2021

artonge left a comment •

edited

Loading

juliusknorr commented Jun 15, 2021

Dashboard API for clients #26430

Dashboard API for clients #26430

Conversation

julien-nc commented Apr 6, 2021

juliusknorr left a comment

Choose a reason for hiding this comment

juliusknorr commented Apr 8, 2021

julien-nc commented Apr 8, 2021

juliusknorr Apr 13, 2021

Choose a reason for hiding this comment

julien-nc Apr 14, 2021

Choose a reason for hiding this comment

nickvergessen Jun 9, 2021

Choose a reason for hiding this comment

juliusknorr left a comment

Choose a reason for hiding this comment

MorrisJobke commented May 21, 2021

skjnldsv commented Jun 2, 2021

julien-nc commented Jun 8, 2021

juliusknorr commented Jun 9, 2021

juliusknorr commented Jun 9, 2021

MorrisJobke left a comment

Choose a reason for hiding this comment

juliusknorr commented Jun 14, 2021

skjnldsv commented Jun 14, 2021

artonge commented Jun 14, 2021

artonge left a comment • edited Loading

Choose a reason for hiding this comment

juliusknorr commented Jun 15, 2021

artonge left a comment •

edited

Loading