Dashboard API#21346

Merged

rullzer merged 17 commits intomasterfrom

enh/20930/dashboard

Jul 15, 2020

Member

juliusknorr commented Jun 9, 2020 •

edited

Loading

This PR is the first part of the planned dashboard work. For now it contains the following parts:

Deprecating the old dashboard API
Add a simplified new API as proposed in Dashboard overview #20930
Add a new dashboard app that mainly takes care of providing dom elements so that apps can render their own views into it.

A reference panel implementation can be found in nextcloud/recommendations#229

Required steps for implementing a panel as an app developer: 📖 nextcloud/documentation#2168

ToDo

Migrate from event to app boostrap Add dedicated API for apps' bootstrapping process #20865
Logo icon: Maybe a circle instead, referencing the Nextcloud logo @jancborchardt

Follow-up

Implement dynamic sorting and adding/removing panels (follow up PR)
App store category for apps supporting dashboard (follow up PR)
Check if we can make the default app dynamic depending on a user setting (follow up PR)
Decide if this should be the default app and how the order of apps should be in the app menu (follow up PR)
Updating Nextcloud with the new Dashboard app and the old one installed will need Use shipped.json file from new release updater#255 to make sure the app is properly replaced
- With a spearate app directory, using the same app id as the current dashboard app should not be an issue if we have a higher app version available

juliusknorr requested review from ChristophWurst, jancborchardt and rullzer

June 9, 2020 17:03

ChristophWurst reviewed

View reviewed changes

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

rullzer added the 2. developing label

Member

jancborchardt commented Jun 11, 2020

Great work, added some design & layout fixes. Now just needs the panels (or mocks) for Calendar, Mail and Talk. :)

ChristophWurst reviewed

View reviewed changes

apps/dashboard/src/App.vue Outdated Show resolved Hide resolved

juliusknorr force-pushed the enh/20930/dashboard branch 2 times, most recently from 30a3f3a to 4ab2dc5 Compare

June 23, 2020 15:05

juliusknorr added 3. to review and removed 2. developing labels

juliusknorr marked this pull request as ready for review

June 23, 2020 15:28

Member Author

juliusknorr commented Jun 23, 2020

Acceptance tests would still need some more work due to the new default app, but this should be good for a first review round until those are figured out. 😉

juliusknorr added the enhancement label

ChristophWurst reviewed

View reviewed changes

apps/dashboard/appinfo/info.xml Show resolved Hide resolved

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

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

apps/dashboard/src/App.vue Outdated Show resolved Hide resolved

lib/public/Dashboard/IManager.php Outdated Show resolved Hide resolved

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

lib/public/Dashboard/IRegisterPanelEvent.php Outdated Show resolved Hide resolved

Member

rullzer commented Jun 24, 2020

Acceptance tests would still need some more work due to the new default app, but this should be good for a first review round until those are figured out. wink

Maybe as discussed we don't add it as default just yet. only when we think it is ready?

juliusknorr force-pushed the enh/20930/dashboard branch from 45e3cdc to 4a39d36 Compare

June 24, 2020 11:05

Member Author

juliusknorr commented Jun 24, 2020

Maybe as discussed we don't add it as default just yet. only when we think it is ready?

Yes, I've dropped that for now and added it to the todo list for the next steps.

Member Author

juliusknorr commented Jun 24, 2020

/compile amend /

npmbuildbot-nextcloud bot force-pushed the enh/20930/dashboard branch from 4a39d36 to 477e89d Compare

June 24, 2020 12:56

juliusknorr force-pushed the enh/20930/dashboard branch from 477e89d to 61db82c Compare

June 24, 2020 15:27

This was referenced Jun 24, 2020

card dashboard nextcloud/deck#1934

Merged

Add docs for new dashboard api nextcloud/documentation#2168

Merged

ChristophWurst requested changes

View reviewed changes

lib/private/Dashboard/Manager.php Show resolved Hide resolved

juliusknorr force-pushed the enh/20930/dashboard branch from 2e3bb89 to 2825e4d Compare

June 26, 2020 14:06

juliusknorr requested a review from ChristophWurst

June 26, 2020 14:06

juliusknorr mentioned this pull request

Dashboard frontend enhancements #21598

Merged

9 tasks

ChristophWurst approved these changes

View reviewed changes

lib/private/Dashboard/Manager.php Show resolved Hide resolved

ChristophWurst reviewed

View reviewed changes

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

juliusknorr requested a review from MorrisJobke

July 7, 2020 09:56

juliusknorr force-pushed the enh/20930/dashboard branch from cb7fecd to af3c51f Compare

July 14, 2020 10:32

juliusknorr and others added 16 commits

July 15, 2020 09:24


          Add new dashboard public API

673d70d

Signed-off-by: Julius Härtl <jus@bitgrid.net>


          Deprecate old dashboard API

544fcdb

Signed-off-by: Julius Härtl <jus@bitgrid.net>


          Add dashboard app

5a18749

Signed-off-by: Julius Härtl <jus@bitgrid.net>


          Modify dashboard welcome sentences

4b9d47f

Signed-off-by: Jan-Christoph Borchardt <hey@jancborchardt.net>


          Fix Dashboard layout, positioning and responsiveness

829bf1a

Signed-off-by: Jan-Christoph Borchardt <hey@jancborchardt.net>


          Separate icon from translatable text

a0cd760

Signed-off-by: Julius Härtl <jus@bitgrid.net>


          Update autoloader

86a7d16

Signed-off-by: Julius Härtl <jus@bitgrid.net>


          Move to lazy panel registration during registration context

81e5593

Signed-off-by: Julius Härtl <jus@bitgrid.net>


          Deprecate panel register event right away but keep it for not breakin…

f7c04b0

…g backward compatible apps

Signed-off-by: Julius Härtl <jus@bitgrid.net>


          Initialize panels early to make sure that scripts can be loaded

66ce9ed

Signed-off-by: Julius Härtl <jus@bitgrid.net>


          Cleanup public api methods

b71de68

Signed-off-by: Julius Härtl <jus@bitgrid.net>


          Update Dashboard app icon

879b756

Signed-off-by: Jan-Christoph Borchardt <hey@jancborchardt.net>


          Add load method for apps to bootstrap their panels

31a1494

Signed-off-by: Julius Härtl <jus@bitgrid.net>


          Load more than one panel

e6fb1b9

Signed-off-by: Julius Härtl <jus@bitgrid.net>


          Dashboard strict typing

35bdb99

Signed-off-by: Julius Härtl <jus@bitgrid.net>


          Include name in translatable greeting

0c35218

Signed-off-by: Julius Härtl <jus@bitgrid.net>

juliusknorr force-pushed the enh/20930/dashboard branch 2 times, most recently from 053f7cf to 1026be8 Compare

July 15, 2020 07:33

Member Author

juliusknorr commented Jul 15, 2020

/compile amend /


          Bump bundles

6b2bb32

Signed-off-by: Julius Härtl <jus@bitgrid.net>

juliusknorr force-pushed the enh/20930/dashboard branch from 1026be8 to 6b2bb32 Compare

July 15, 2020 08:54

Member Author

juliusknorr commented Jul 15, 2020

Ah it was the missing map file.

rullzer merged commit f04f932 into master

rullzer deleted the enh/20930/dashboard branch

July 15, 2020 09:10

Member

MorrisJobke commented Jul 15, 2020

Breaks master tests - let me fix them.

MorrisJobke added a commit that referenced this pull request


          Fix integration test due to new dashboard app

8dd48f3

See #21346

Signed-off-by: Morris Jobke <hey@morrisjobke.de>

MorrisJobke mentioned this pull request

Fix integration test due to new dashboard app #21849

Merged

Member

MorrisJobke commented Jul 15, 2020

Breaks master tests - let me fix them.

jancborchardt added the feature: dashboard label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

ChristophWurst ChristophWurst approved these changes

nickvergessen nickvergessen approved these changes

rullzer Awaiting requested review from rullzer

jancborchardt Awaiting requested review from jancborchardt

MorrisJobke Awaiting requested review from MorrisJobke

skjnldsv Awaiting requested review from skjnldsv

Labels

3. to review enhancement feature: dashboard