Skip to content

feat(dashboard): add ITeamWidget and team scope to the dashboard API #66521

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
stediefan wants to merge 1 commit into
base: master
Choose a base branch
from
+807 −41
Draft

feat(dashboard): add ITeamWidget and team scope to the dashboard API #66521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 127 additions & 38 deletions apps/dashboard/lib/Controller/DashboardApiController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
use OCP\AppFramework\Http\Attribute\NoAdminRequired;
use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCS\OCSBadRequestException;
use OCP\AppFramework\OCS\OCSNotFoundException;
use OCP\AppFramework\OCSController;
use OCP\AppFramework\Services\IAppConfig;
use OCP\Config\IUserConfig;
Expand All @@ -26,11 +28,14 @@
use OCP\Dashboard\IManager;
use OCP\Dashboard\IOptionWidget;
use OCP\Dashboard\IReloadableWidget;
use OCP\Dashboard\ITeamWidget;
use OCP\Dashboard\IWidget;
use OCP\Dashboard\Model\WidgetButton;
use OCP\Dashboard\Model\WidgetItem;
use OCP\Dashboard\Model\WidgetOptions;
use OCP\IRequest;
use OCP\Teams\ITeamManager;
use Psr\Log\LoggerInterface;

/**
* @psalm-import-type DashboardWidget from ResponseDefinitions
Expand All @@ -47,6 +52,8 @@ public function __construct(
private IUserConfig $userConfig,
private ?string $userId,
private DashboardService $service,
private ITeamManager $teamManager,
private LoggerInterface $logger,
) {
parent::__construct($appName, $request);
}
Expand All @@ -69,6 +76,44 @@ static function (IWidget $widget) use ($widgetIds) {
);
}

private function resolveTeam(?string $teamId): ?string {
if ($teamId === null) {
return null;
}
if ($teamId === '') {
throw new OCSBadRequestException('Empty team ID');
}
if ($this->userId === null || !$this->teamManager->isMemberOfTeam($teamId, $this->userId)) {
throw new OCSNotFoundException('Team not found');
}
return $teamId;
}

/**
* @param list<string> $widgetIds
* @return array<string, ITeamWidget>
*/
private function getTeamWidgets(string $teamId, array $widgetIds): array {
$widgets = [];
foreach ($this->dashboardManager->getWidgets() as $id => $widget) {
if (!$widget instanceof ITeamWidget || ($widgetIds !== [] && !in_array($id, $widgetIds, true))) {
continue;
}
try {
if ($widget->isEnabledForTeam($teamId, $this->userId)) {
$widgets[$id] = $widget;
}
} catch (\Throwable $e) {
$this->logger->warning('Failed to check dashboard widget applicability for team', [
'widget' => $id,
'team' => $teamId,
'exception' => $e,
]);
}
}
return $widgets;
}

/**
* Get the items for the widgets
*
Expand Down Expand Up @@ -104,15 +149,34 @@ public function getWidgetItems(array $sinceIds = [], int $limit = 7, array $widg
* @param int $limit Limit number of result items per widget, not more than 30 are allowed
* @psalm-param int<1, 30> $limit
* @param list<string> $widgets Limit results to specific widgets
* @param ?string $teamId Team to show widgets for; omit for the personal dashboard
* @return DataResponse<Http::STATUS_OK, array<string, DashboardWidgetItems>, array{}>
* @throws OCSNotFoundException Team not found
* @throws OCSBadRequestException Empty team ID
*
* 200: Widget items returned
*/
#[NoAdminRequired]
#[NoCSRFRequired]
#[ApiRoute(verb: 'GET', url: '/api/v2/widget-items')]
public function getWidgetItemsV2(array $sinceIds = [], int $limit = 7, array $widgets = []): DataResponse {
public function getWidgetItemsV2(array $sinceIds = [], int $limit = 7, array $widgets = [], ?string $teamId = null): DataResponse {
$teamId = $this->resolveTeam($teamId);
$items = [];
if ($teamId !== null) {
foreach ($this->getTeamWidgets($teamId, $widgets) as $id => $widget) {
try {
$items[$id] = $widget->getTeamItems($teamId, $this->userId, $sinceIds[$id] ?? null, $limit)->jsonSerialize();
} catch (\Throwable $e) {
$this->logger->warning('Failed to get dashboard widget items for team', [
'widget' => $id,
'team' => $teamId,
'exception' => $e,
]);
}
}
return new DataResponse($items);
}

$widgets = $this->getShownWidgets($widgets);
foreach ($widgets as $widget) {
if ($widget instanceof IAPIWidgetV2) {
Expand All @@ -128,55 +192,80 @@ public function getWidgetItemsV2(array $sinceIds = [], int $limit = 7, array $wi
/**
* Get the widgets
*
* @param ?string $teamId Team to show widgets for; omit for the personal dashboard
* @return DataResponse<Http::STATUS_OK, array<string, DashboardWidget>, array{}>
* @throws OCSNotFoundException Team not found
* @throws OCSBadRequestException Empty team ID
*
* 200: Widgets returned
*/
#[NoAdminRequired]
#[NoCSRFRequired]
#[ApiRoute(verb: 'GET', url: '/api/v1/widgets')]
public function getWidgets(): DataResponse {
$widgets = $this->dashboardManager->getWidgets();

$items = array_map(function (IWidget $widget) {
$options = ($widget instanceof IOptionWidget) ? $widget->getWidgetOptions() : WidgetOptions::getDefault();
$data = [
'id' => $widget->getId(),
'title' => $widget->getTitle(),
'order' => $widget->getOrder(),
'icon_class' => $widget->getIconClass(),
'icon_url' => ($widget instanceof IIconWidget) ? $widget->getIconUrl() : '',
'widget_url' => $widget->getUrl(),
'item_icons_round' => $options->withRoundItemIcons(),
'item_api_versions' => [],
'reload_interval' => 0,
];
if ($widget instanceof IButtonWidget) {
$data += [
'buttons' => array_map(function (WidgetButton $button) {
return [
'type' => $button->getType(),
'text' => $button->getText(),
'link' => $button->getLink(),
];
}, $widget->getWidgetButtons($this->userId)),
];
public function getWidgets(?string $teamId = null): DataResponse {
$teamId = $this->resolveTeam($teamId);
if ($teamId !== null) {
$items = [];
foreach ($this->getTeamWidgets($teamId, []) as $id => $widget) {
try {
$items[$id] = $this->serializeWidget($widget, $widget->getTeamUrl($teamId, $this->userId) ?? $widget->getUrl());
} catch (\Throwable $e) {
$this->logger->warning('Failed to get dashboard widget metadata for team', [
'widget' => $id,
'team' => $teamId,
'exception' => $e,
]);
}
}
if ($widget instanceof IReloadableWidget) {
$data['reload_interval'] = $widget->getReloadInterval();
}
if ($widget instanceof IAPIWidget) {
$data['item_api_versions'][] = 1;
}
if ($widget instanceof IAPIWidgetV2) {
$data['item_api_versions'][] = 2;
}
return $data;
}, $widgets);
} else {
$items = array_map(
fn (IWidget $widget) => $this->serializeWidget($widget, $widget->getUrl()),
$this->dashboardManager->getWidgets(),
);
}

return new DataResponse($items);
}

/**
* @return DashboardWidget
*/
private function serializeWidget(IWidget $widget, ?string $url): array {
$options = ($widget instanceof IOptionWidget) ? $widget->getWidgetOptions() : WidgetOptions::getDefault();
$data = [
'id' => $widget->getId(),
'title' => $widget->getTitle(),
'order' => $widget->getOrder(),
'icon_class' => $widget->getIconClass(),
'icon_url' => ($widget instanceof IIconWidget) ? $widget->getIconUrl() : '',
'widget_url' => $url,
'item_icons_round' => $options->withRoundItemIcons(),
'item_api_versions' => [],
'reload_interval' => 0,
];
if ($widget instanceof IButtonWidget) {
$data += [
'buttons' => array_map(function (WidgetButton $button) {
return [
'type' => $button->getType(),
'text' => $button->getText(),
'link' => $button->getLink(),
];
}, $widget->getWidgetButtons($this->userId)),
];
}
if ($widget instanceof IReloadableWidget) {
$data['reload_interval'] = $widget->getReloadInterval();
}
if ($widget instanceof IAPIWidget) {
$data['item_api_versions'][] = 1;
}
if ($widget instanceof IAPIWidgetV2) {
$data['item_api_versions'][] = 2;
}
return $data;
}

/**
* Get the layout
*
Expand Down
132 changes: 132 additions & 0 deletions apps/dashboard/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,16 @@
}
}
},
{
"name": "teamId",
"in": "query",
"description": "Team to show widgets for; omit for the personal dashboard",
"schema": {
"type": "string",
"nullable": true,
"default": null
}
},
{
"name": "OCS-APIRequest",
"in": "header",
Expand Down Expand Up @@ -392,6 +402,62 @@
}
}
},
"404": {
"description": "Team not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
},
"400": {
"description": "Empty team ID",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
},
"401": {
"description": "Current user is not logged in",
"content": {
Expand Down Expand Up @@ -439,6 +505,16 @@
}
],
"parameters": [
{
"name": "teamId",
"in": "query",
"description": "Team to show widgets for; omit for the personal dashboard",
"schema": {
"type": "string",
"nullable": true,
"default": null
}
},
{
"name": "OCS-APIRequest",
"in": "header",
Expand Down Expand Up @@ -484,6 +560,62 @@
}
}
},
"404": {
"description": "Team not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
},
"400": {
"description": "Empty team ID",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {}
}
}
}
}
}
}
},
"401": {
"description": "Current user is not logged in",
"content": {
Expand Down
Loading
Loading