Skip to content

armgit / core

Public Imported from GitHub
0

100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps

UI: disable asset tree pagination under 1000 assets (#2397)

Martin Peeters485c70ebbab6
diff --git a/manager/src/main/java/org/openremote/manager/asset/AssetResourceImpl.java b/manager/src/main/java/org/openremote/manager/asset/AssetResourceImpl.java
index 84e01498e..b4a6ef951 100644
--- a/manager/src/main/java/org/openremote/manager/asset/AssetResourceImpl.java
+++ b/manager/src/main/java/org/openremote/manager/asset/AssetResourceImpl.java
@@ -577,6 +577,19 @@ public class AssetResourceImpl extends ManagerWebResource implements AssetResour
return result;
}
+ @Override
+ public Integer queryCount(RequestParams requestParams, AssetQuery query) {
+ if (query == null) {
+ query = new AssetQuery();
+ }
+
+ if (!assetStorageService.authorizeAssetQuery(query, getAuthContext(), getRequestRealmName())) {
+ throw new ForbiddenException("User not authorized to execute specified query");
+ }
+
+ return assetStorageService.count(query);
+ }
+
protected AttributeWriteResult doAttributeWrite(AttributeEvent event) {
AttributeWriteFailure failure = null;
diff --git a/manager/src/main/java/org/openremote/manager/asset/AssetStorageService.java b/manager/src/main/java/org/openremote/manager/asset/AssetStorageService.java
index c28b48649..468fd18ea 100644
--- a/manager/src/main/java/org/openremote/manager/asset/AssetStorageService.java
+++ b/manager/src/main/java/org/openremote/manager/asset/AssetStorageService.java
@@ -530,6 +530,10 @@ public class AssetStorageService extends RouteBuilder implements ContainerServic
return persistenceService.doReturningTransaction(em -> findAll(em, query));
}
+ public Integer count(AssetQuery query) {
+ return persistenceService.doReturningTransaction(em -> count(em, query));
+ }
+
public List<String> findNames(String... ids) {
if (ids == null || ids.length == 0)
return new ArrayList<>();
@@ -1362,6 +1366,34 @@ public class AssetStorageService extends RouteBuilder implements ContainerServic
return assets;
}
+ @SuppressWarnings("unchecked")
+ protected Integer count(EntityManager em, AssetQuery query) {
+ if (query.access == null)
+ query.access = PRIVATE;
+
+ // Do some sanity checks on query values and return empty result set if empty query parameters
+ if (query.ids != null && query.ids.length == 0) {
+ return 0;
+ }
+ if (query.paths != null && query.paths.length == 0) {
+ return 0;
+ }
+ if (query.types != null && query.types.length == 0) {
+ return 0;
+ }
+ if (query.names != null && query.names.length == 0) {
+ return 0;
+ }
+ if (query.userIds != null && query.userIds.length == 0) {
+ return 0;
+ }
+
+ PreparedAssetQuery querySql = buildQuery(query, timerService::getCurrentTimeMillis, true).key;
+ Query countQuery = em.createNativeQuery(querySql.querySql).unwrap(org.hibernate.query.Query.class)
+ .setHint(AvailableHints.HINT_READ_ONLY, true); // Make query readonly so no dirty checks are performed
+ return ((Number) countQuery.getSingleResult()).intValue();
+ }
+
/**
* This does a low level JDBC update so hibernate event interceptor doesn't get called and we 'manually'
* generate the {@link AttributeEvent}
@@ -1524,11 +1556,19 @@ public class AssetStorageService extends RouteBuilder implements ContainerServic
protected static Pair<PreparedAssetQuery, Boolean> buildQuery(AssetQuery query, Supplier<Long> timeProvider) {
+ return buildQuery(query, timeProvider, false);
+ }
+
+ protected static Pair<PreparedAssetQuery, Boolean> buildQuery(AssetQuery query, Supplier<Long> timeProvider, boolean count) {
LOG.finest("Building: " + query);
StringBuilder sb = new StringBuilder();
boolean recursive = query.recursive;
List<ParameterBinder> binders = new ArrayList<>();
- sb.append(buildSelectString(query, 1, binders, timeProvider));
+ if (count) {
+ sb.append("select COUNT(*)");
+ } else {
+ sb.append(buildSelectString(query, 1, binders, timeProvider));
+ }
sb.append(buildFromString(query, 1));
boolean containsCalendarPredicate = appendWhereClause(sb, query, 1, binders, timeProvider);
@@ -1544,7 +1584,9 @@ public class AssetStorageService extends RouteBuilder implements ContainerServic
containsCalendarPredicate = !containsCalendarPredicate && appendWhereClause(sb, query, 3, binders, timeProvider);
}
- sb.append(buildOrderByString(query));
+ if (!count) {
+ sb.append(buildOrderByString(query));
+ }
sb.append(buildLimitString(query));
sb.append(buildOffsetString(query));
return new Pair<>(new PreparedAssetQuery(sb.toString(), binders), containsCalendarPredicate);
diff --git a/model/src/main/java/org/openremote/model/asset/AssetResource.java b/model/src/main/java/org/openremote/model/asset/AssetResource.java
index ac6da15d2..620e67a38 100644
--- a/model/src/main/java/org/openremote/model/asset/AssetResource.java
+++ b/model/src/main/java/org/openremote/model/asset/AssetResource.java
@@ -338,6 +338,16 @@ public interface AssetResource {
@Operation(operationId = "queryAssetTree", summary = "Retrieve part of the asset tree using a query, returns an optimized structure for tree display")
AssetTree queryAssetTree(@BeanParam RequestParams requestParams, AssetQuery query);
+ /**
+ * Retrieve the amount of assets using an {@link AssetQuery}.
+ */
+ @POST
+ @Path("count")
+ @Consumes(APPLICATION_JSON)
+ @Produces(APPLICATION_JSON)
+ @Operation(operationId = "queryCount", summary = "Counts the amount of assets using a query")
+ Integer queryCount(@BeanParam RequestParams requestParams, AssetQuery query);
+
/**
* Change parent for a set of asset
*/
diff --git a/ui/app/manager/test/assettree.test.ts b/ui/app/manager/test/assettree.test.ts
index c682ba5a7..1e556fd66 100644
--- a/ui/app/manager/test/assettree.test.ts
+++ b/ui/app/manager/test/assettree.test.ts
@@ -199,7 +199,10 @@ test(`Load more buttons are shown when there are a lot of assets`, async ({ page
await manager.goToRealmStartPage("smartcity");
await assetsPage.goto();
await expect(assetTree.getAssetNodes()).toHaveCount(5); // 2 battery assets + 2 electricity assets + 1 console group
- await page.locator('or-asset-tree').evaluate(tree => {(tree as OrAssetTree).setAttribute('queryLimit', '2')});
+ await page.locator('or-asset-tree').evaluate(tree => {
+ (tree as OrAssetTree).setAttribute('queryLimit', '2');
+ (tree as OrAssetTree).setAttribute('paginationThreshold', '1');
+ });
await expect(assetTree.getAssetNodes()).toHaveCount(2);
await page.getByRole('button', { name: "Load More" }).click();
await expect(assetTree.getAssetNodes()).toHaveCount(4);
@@ -228,7 +231,10 @@ test(`Load more buttons are shown properly without any unexpected scroll behavio
await expect(assetTree.getAssetNodes()).toHaveCount(3 + 25); // City 1, City 2, Consoles asset and 25 battery assets
// Limit the number of expanding nodes to 20, and check if the tree is still in tact
- await page.locator('or-asset-tree').evaluate(tree => {(tree as OrAssetTree).setAttribute('queryLimit', '20')});
+ await page.locator('or-asset-tree').evaluate(tree => {
+ (tree as OrAssetTree).setAttribute('queryLimit', '20');
+ (tree as OrAssetTree).setAttribute('paginationThreshold', '1');
+ });
await expect(assetTree.getAssetNodes()).toHaveCount(3); // City 1, City 2 and Consoles asset
cityAsset1 = assetTree.getAssetNodes().filter({ hasText: parentAssets[0].name });
await cityAsset1.locator('[data-expandable]').click();
@@ -292,7 +298,10 @@ test(`Load more buttons are shown properly when there is a complex tree`, async
// Navigate to the asset tree
await manager.goToRealmStartPage("smartcity");
await assetsPage.goto();
- await page.locator('or-asset-tree').evaluate(tree => {(tree as OrAssetTree).setAttribute('queryLimit', '2')});
+ await page.locator('or-asset-tree').evaluate(tree => {
+ (tree as OrAssetTree).setAttribute('queryLimit', '2');
+ (tree as OrAssetTree).setAttribute('paginationThreshold', '1')
+ });
await expect(assetTree.getAssetNodes()).toHaveCount(2); // 2 parent assets (the other console group is hidden because of queryLimit=2)
// Navigate to the 1st building within the first city
diff --git a/ui/component/or-asset-tree/src/index.ts b/ui/component/or-asset-tree/src/index.ts
index b86f6fb82..1ea2a2107 100644
--- a/ui/component/or-asset-tree/src/index.ts
+++ b/ui/component/or-asset-tree/src/index.ts
@@ -302,6 +302,9 @@ export class OrAssetTree extends subscribe(manager)(LitElement) {
@property({type: Number})
public readonly queryLimit = 100;
+ @property({type: Number})
+ public readonly paginationThreshold = 1000;
+
protected config?: AssetTreeConfig;
@state()
@@ -1788,6 +1791,20 @@ export class OrAssetTree extends subscribe(manager)(LitElement) {
query.ids = this.rootAssetIds;
query.recursive = true;
}
+
+ // We request the number of assets through the HTTP API, and disable pagination when there are less than 1000 assets.
+ try {
+ const threshold = this.paginationThreshold ?? 1000;
+ const countResponse = await manager.rest.api.AssetResource.queryCount({...query, limit: threshold});
+ if (countResponse.data < threshold) {
+ query.parents = undefined;
+ query.limit = threshold;
+ }
+ } catch (error) {
+ // If the count request fails, log the error and fall back to default pagination behavior.
+ console.warn("Failed to query asset count, falling back to default pagination.", error);
+ }
+
const eventPromise = this._sendEventWithReply({
eventType: "read-asset-tree",
assetQuery: query