100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
UI fix: Dashboards with gateway widgets are visible for users without asset access (#1942)
Martin Peetersac2295c9852a
diff --git a/manager/src/main/resources/org/openremote/manager/setup/database/V20250617_01__GatewayWidgetRefs.sql b/manager/src/main/resources/org/openremote/manager/setup/database/V20250617_01__GatewayWidgetRefs.sqlnew file mode 100644index 000000000..6fdc2561d--- /dev/null+++ b/manager/src/main/resources/org/openremote/manager/setup/database/V20250617_01__GatewayWidgetRefs.sql@@ -0,0 +1,29 @@+UPDATE dashboard+SET template = jsonb_set(+ template,+ '{widgets}',+ (SELECT jsonb_agg(+ CASE+ WHEN widget ->> 'widgetTypeId' = 'gateway' THEN+ jsonb_set(+ widget,+ '{widgetConfig,attributeRefs}',+ CASE+ WHEN widget -> 'widgetConfig' ->> 'gatewayId' != '' THEN+ jsonb_build_array(+ jsonb_build_object(+ 'id', widget -> 'widgetConfig' ->> 'gatewayId',+ 'name', NULL+ )+ )+ ELSE+ '[]'::jsonb -- Set to an empty array if gatewayId is empty+ END+ )+ ELSE+ widget -- Leave non-gateway widgets unchanged+ END+ )+ FROM jsonb_array_elements(template -> 'widgets') widget)+ )+WHERE template -> 'widgets' IS NOT NULL;diff --git a/ui/component/or-dashboard-builder/src/settings/gateway-settings.ts b/ui/component/or-dashboard-builder/src/settings/gateway-settings.tsindex 9b11c3b8d..773c0b603 100644--- a/ui/component/or-dashboard-builder/src/settings/gateway-settings.ts+++ b/ui/component/or-dashboard-builder/src/settings/gateway-settings.ts@@ -3,7 +3,7 @@ import {WidgetSettings} from "../util/widget-settings";import {TemplateResult, html} from "lit";import { InputType, OrInputChangedEvent } from "@openremote/or-mwc-components/or-mwc-input";import {i18next} from "@openremote/or-translate";-import {Asset, AssetQuery, GatewayTunnelInfoType} from "@openremote/model";+import {Asset, AssetQuery, AttributeRef, GatewayTunnelInfoType} from "@openremote/model";import {GatewayWidgetConfig} from "../widgets/gateway-widget";import {Task} from "@lit/task";import manager from "@openremote/core";@@ -82,6 +82,7 @@ export class GatewaySettings extends WidgetSettings {protected _onAssetSelect(ev: OrInputChangedEvent): void {this.widgetConfig.gatewayId = ev.detail.value;+ this.widgetConfig.attributeRefs = [{id: ev.detail.value, name: undefined} as AttributeRef]; // Add to attributeRefs object, so the backend is aware of asset permissionsthis.notifyConfigUpdate();}diff --git a/ui/component/or-dashboard-builder/src/util/widget-config.ts b/ui/component/or-dashboard-builder/src/util/widget-config.tsindex 0217f2127..de61082cc 100644--- a/ui/component/or-dashboard-builder/src/util/widget-config.ts+++ b/ui/component/or-dashboard-builder/src/util/widget-config.ts@@ -1,2 +1,17 @@+import {AttributeRef} from "@openremote/model";++/**+ * A {@link WidgetConfig} interface for widgets where assets are involved.+ * The backend will understand this object type, for example to determine asset permissions.+ * This interface is often extended upon with additional configuration fields like 'size' or 'decimals'.+ */+export interface AssetWidgetConfig extends WidgetConfig {+ attributeRefs: AttributeRef[];+}++/**+ * Default config interface for widgets to re-use+ * Often extended upon with additional configuration fields like 'size' or 'decimals'.+ */export interface WidgetConfig {}diff --git a/ui/component/or-dashboard-builder/src/widgets/attribute-input-widget.ts b/ui/component/or-dashboard-builder/src/widgets/attribute-input-widget.tsindex 7c7e658f8..add91e270 100644--- a/ui/component/or-dashboard-builder/src/widgets/attribute-input-widget.ts+++ b/ui/component/or-dashboard-builder/src/widgets/attribute-input-widget.ts@@ -1,6 +1,6 @@import {css, html, PropertyValues, TemplateResult } from "lit";import {OrAssetWidget} from "../util/or-asset-widget";-import {WidgetConfig} from "../util/widget-config";+import {AssetWidgetConfig} from "../util/widget-config";import {AttributeRef, WellknownMetaItems} from "@openremote/model";import {WidgetManifest} from "../util/or-widget";import {WidgetSettings} from "../util/widget-settings";@@ -11,8 +11,7 @@ import {throttle} from "lodash";import {Util} from "@openremote/core";import "@openremote/or-attribute-input";-export interface AttributeInputWidgetConfig extends WidgetConfig {- attributeRefs: AttributeRef[];+export interface AttributeInputWidgetConfig extends AssetWidgetConfig {readonly: boolean,showHelperText: boolean}@@ -68,13 +67,13 @@ export class AttributeInputWidget extends OrAssetWidget {return {displayName: "Attribute",displayIcon: "form-textbox",- getContentHtml(config: WidgetConfig): OrAssetWidget {+ getContentHtml(config: AttributeInputWidgetConfig): OrAssetWidget {return new AttributeInputWidget(config);},- getDefaultConfig(): WidgetConfig {+ getDefaultConfig(): AttributeInputWidgetConfig {return getDefaultWidgetConfig();},- getSettingsHtml(config: WidgetConfig): WidgetSettings {+ getSettingsHtml(config: AttributeInputWidgetConfig): WidgetSettings {return new AttributeInputSettings(config);}diff --git a/ui/component/or-dashboard-builder/src/widgets/chart-widget.ts b/ui/component/or-dashboard-builder/src/widgets/chart-widget.tsindex e7c617fd9..8e656ff4f 100644--- a/ui/component/or-dashboard-builder/src/widgets/chart-widget.ts+++ b/ui/component/or-dashboard-builder/src/widgets/chart-widget.ts@@ -5,14 +5,13 @@ import {TimePresetCallback} from "@openremote/or-chart";import moment from "moment";import {OrAssetWidget} from "../util/or-asset-widget";import { customElement, state } from "lit/decorators.js";-import {WidgetConfig} from "../util/widget-config";+import {AssetWidgetConfig} from "../util/widget-config";import {OrWidget, WidgetManifest} from "../util/or-widget";import {ChartSettings} from "../settings/chart-settings";import {WidgetSettings} from "../util/widget-settings";import "@openremote/or-chart";-export interface ChartWidgetConfig extends WidgetConfig {- attributeRefs: AttributeRef[];+export interface ChartWidgetConfig extends AssetWidgetConfig {rightAxisAttributes: AttributeRef[];datapointQuery: AssetDatapointQueryUnion;chartOptions?: any; // ChartConfiguration<"line", ScatterDataPoint[]>diff --git a/ui/component/or-dashboard-builder/src/widgets/gateway-widget.ts b/ui/component/or-dashboard-builder/src/widgets/gateway-widget.tsindex 3499cb925..976aa44fc 100644--- a/ui/component/or-dashboard-builder/src/widgets/gateway-widget.ts+++ b/ui/component/or-dashboard-builder/src/widgets/gateway-widget.ts@@ -2,7 +2,7 @@ import {customElement, state} from "lit/decorators.js";import {OrWidget, WidgetManifest} from "../util/or-widget";import {css, html, PropertyValues, TemplateResult} from "lit";import {WidgetSettings} from "../util/widget-settings";-import {WidgetConfig} from "../util/widget-config";+import {AssetWidgetConfig, WidgetConfig} from "../util/widget-config";import {GatewaySettings} from "../settings/gateway-settings";import {InputType, OrInputChangedEvent} from "@openremote/or-mwc-components/or-mwc-input";import {GatewayTunnelInfo, GatewayTunnelInfoType} from "@openremote/model";@@ -32,7 +32,7 @@ const styling = css`}`;-export interface GatewayWidgetConfig extends WidgetConfig {+export interface GatewayWidgetConfig extends AssetWidgetConfig {gatewayId?: string;type: GatewayTunnelInfoType;target: string;@@ -41,6 +41,7 @@ export interface GatewayWidgetConfig extends WidgetConfig {function getDefaultWidgetConfig(): GatewayWidgetConfig {return {+ attributeRefs: [],type: GatewayTunnelInfoType.HTTPS,target: "localhost",targetPort: 443@@ -322,13 +323,15 @@ export class GatewayWidget extends OrWidget {* Internal function that requests the Manager API for the gatewayStatus of the gatewayId asset in {@link GatewayTunnelInfo}.* Returns undefined if there is misalignment in the linked asset id or unexpected http code.*/- protected async _getGatewayStatus(info: GatewayTunnelInfo): Promise<string | undefined> {- const response = await manager.rest.api.AssetResource.get(info.gatewayId!)- if (response.status === 200 && response.data && response.data.attributes && response.data.attributes.gatewayStatus) {- return response.data.attributes.gatewayStatus.value- } else {- return undefined;- }+ protected async _getGatewayStatus(info: GatewayTunnelInfo): Promise<string | undefined> {+ if(info.gatewayId) {+ const promise = manager.rest.api.AssetResource.get(info.gatewayId);+ promise.catch(err => console.error(err));+ const response = await promise;+ if (response.status === 200) {+ return response.data.attributes?.gatewayStatus?.value;+ }+ }}/**@@ -339,7 +342,7 @@ export class GatewayWidget extends OrWidget {//Check if the gateway is actually in a status to accept connectionsthis._getGatewayStatus(tunnelInfo).then(status => {this._isReady = (status === "CONNECTED");- });+ });}/**diff --git a/ui/component/or-dashboard-builder/src/widgets/gauge-widget.ts b/ui/component/or-dashboard-builder/src/widgets/gauge-widget.tsindex fe0d3e1c1..4ba96f5ef 100644--- a/ui/component/or-dashboard-builder/src/widgets/gauge-widget.ts+++ b/ui/component/or-dashboard-builder/src/widgets/gauge-widget.ts@@ -1,7 +1,7 @@import {html, css, TemplateResult} from "lit";import {customElement, state} from "lit/decorators.js";import {OrAssetWidget} from "../util/or-asset-widget";-import {WidgetConfig} from "../util/widget-config";+import {AssetWidgetConfig} from "../util/widget-config";import {Attribute, AttributeRef} from "@openremote/model";import {OrWidget, WidgetManifest} from "../util/or-widget";import {WidgetSettings} from "../util/widget-settings";@@ -9,8 +9,7 @@ import {GaugeSettings} from "../settings/gauge-settings";import {when} from "lit/directives/when.js";import "@openremote/or-gauge";-export interface GaugeWidgetConfig extends WidgetConfig {- attributeRefs: AttributeRef[];+export interface GaugeWidgetConfig extends AssetWidgetConfig {thresholds: [number, string][];decimals: number;min: number;diff --git a/ui/component/or-dashboard-builder/src/widgets/image-widget.ts b/ui/component/or-dashboard-builder/src/widgets/image-widget.tsindex b6f4570b5..be1f9ae6c 100644--- a/ui/component/or-dashboard-builder/src/widgets/image-widget.ts+++ b/ui/component/or-dashboard-builder/src/widgets/image-widget.ts@@ -1,4 +1,4 @@-import {WidgetConfig} from "../util/widget-config";+import {AssetWidgetConfig} from "../util/widget-config";import {AssetModelUtil, Attribute, AttributeRef, WellknownValueTypes} from "@openremote/model";import {OrWidget, WidgetManifest} from "../util/or-widget";import { customElement } from "lit/decorators.js";@@ -53,8 +53,7 @@ export interface ImageAssetMarker {coordinates: [number, number]}-export interface ImageWidgetConfig extends WidgetConfig {- attributeRefs: AttributeRef[];+export interface ImageWidgetConfig extends AssetWidgetConfig {markers: ImageAssetMarker[];showTimestampControls: boolean;imagePath: string;diff --git a/ui/component/or-dashboard-builder/src/widgets/kpi-widget.ts b/ui/component/or-dashboard-builder/src/widgets/kpi-widget.tsindex 4be52f2db..6316f4423 100644--- a/ui/component/or-dashboard-builder/src/widgets/kpi-widget.ts+++ b/ui/component/or-dashboard-builder/src/widgets/kpi-widget.ts@@ -3,14 +3,13 @@ import { when } from "lit/directives/when.js";import {OrAssetWidget} from "../util/or-asset-widget";import {OrWidget, WidgetManifest} from "../util/or-widget";import {WidgetSettings} from "../util/widget-settings";-import {WidgetConfig} from "../util/widget-config";+import {AssetWidgetConfig} from "../util/widget-config";import {Attribute, AttributeRef} from "@openremote/model";import {html, TemplateResult } from "lit";import {KpiSettings} from "../settings/kpi-settings";import "@openremote/or-attribute-card";-export interface KpiWidgetConfig extends WidgetConfig {- attributeRefs: AttributeRef[];+export interface KpiWidgetConfig extends AssetWidgetConfig {period?: 'year' | 'month' | 'week' | 'day' | 'hour';decimals: number;deltaFormat: "absolute" | "percentage";diff --git a/ui/component/or-dashboard-builder/src/widgets/map-widget.ts b/ui/component/or-dashboard-builder/src/widgets/map-widget.tsindex 572734371..9d0b9d278 100644--- a/ui/component/or-dashboard-builder/src/widgets/map-widget.ts+++ b/ui/component/or-dashboard-builder/src/widgets/map-widget.ts@@ -4,8 +4,8 @@ import {OrAssetWidget} from "../util/or-asset-widget";import {OrWidget, WidgetManifest} from "../util/or-widget";import {WidgetSettings} from "../util/widget-settings";import {MapSettings} from "../settings/map-settings";-import {WidgetConfig} from "../util/widget-config";-import {Asset, AssetDescriptor, Attribute, AttributeRef, GeoJSONPoint, WellknownAttributes, WellknownMetaItems} from "@openremote/model";+import {AssetWidgetConfig} from "../util/widget-config";+import {Asset, AssetDescriptor, Attribute, GeoJSONPoint, WellknownAttributes, WellknownMetaItems} from "@openremote/model";import {LngLatLike,AttributeMarkerColours,@@ -18,9 +18,7 @@ import manager, {Util} from "@openremote/core";import { showSnackbar } from "@openremote/or-mwc-components/or-mwc-snackbar";import "@openremote/or-map";-export interface MapWidgetConfig extends WidgetConfig {- // General values- attributeRefs: AttributeRef[];+export interface MapWidgetConfig extends AssetWidgetConfig {// Map related valueszoom?: number,center?: LngLatLike,