Merge branch 'fix/ZSTAC-74748' into '5.5.6'

<fix>[search]: add PK tiebreaker for pagination

See merge request zstackio/zstack!9139

Author: gitlab

search/src/main/java/org/zstack/query/MysqlQueryBuilderImpl3.java

@@ -730,7 +730,15 @@ String toJpql(boolean isCount) {
                             throw new IllegalArgumentException(String.format("illegal sortBy[%s], entity[%s] doesn't have this field", msg.getSortBy(), info.entityClass.getName()));
                         }
 
-                        ret = String.format("%s order by %s.%s %s", ret, entityName, msg.getSortBy(), msg.getSortDirection().toUpperCase());
+                        String orderBy = String.format("order by %s.%s %s", entityName, msg.getSortBy(), msg.getSortDirection().toUpperCase());
+                        if (info.primaryKey != null && !msg.getSortBy().equals(info.primaryKey)) {
+                            orderBy += String.format(", %s.%s ASC", entityName, info.primaryKey);
+                        }
+                        ret = String.format("%s %s", ret, orderBy);
+                    } else if (msg.getStart() != null || msg.getLimit() != null) {
+                        if (info.primaryKey != null) {
+                            ret = String.format("%s order by %s.%s ASC", ret, entityName, info.primaryKey);
+                        }
                     }
 
                     if (msg.getGroupBy() != null) {

search/src/main/java/org/zstack/query/QueryFacadeImpl.java

@@ -30,6 +30,7 @@
 import org.zstack.utils.*;
 import org.zstack.utils.gson.JSONObjectUtil;
 import org.zstack.utils.logging.CLogger;
+import org.zstack.core.db.EntityMetadata;
 import org.zstack.zql.ZQL;
 import org.zstack.zql.ZQLContext;
 import org.zstack.zql.ZQLQueryReturn;
@@ -483,7 +484,17 @@ public ZQLQueryReturn queryUseZQL(APIQueryMessage msg, Class inventoryClass) {
         }
 
         if (msg.getSortBy() != null) {
-            sb.add(String.format("order by %s %s", msg.getSortBy(), msg.getSortDirection()));
+            String orderBy = String.format("order by %s %s", msg.getSortBy(), msg.getSortDirection());
+            String pkFieldName = getPrimaryKeyFieldNameSafely(targetInventoryClass);
+            if (pkFieldName != null && !msg.getSortBy().equals(pkFieldName)) {
+                orderBy += String.format(", %s asc", pkFieldName);
+            }
+            sb.add(orderBy);
+        } else if (!msg.isCount() && (msg.getLimit() != null || msg.getStart() != null)) {
+            String pkFieldName = getPrimaryKeyFieldNameSafely(targetInventoryClass);
+            if (pkFieldName != null) {
+                sb.add(String.format("order by %s asc", pkFieldName));
+            }
         }
 
         if (msg.getLimit() != null) {
@@ -515,6 +526,24 @@ public ZQLQueryReturn queryUseZQL(APIQueryMessage msg, Class inventoryClass) {
         return result;
     }
 
+    private String getPrimaryKeyFieldNameSafely(Class inventoryClass) {
+        try {
+            ZQLMetadata.InventoryMetadata meta = ZQLMetadata.findInventoryMetadata(
+                    ZQL.queryTargetNameFromInventoryClass(inventoryClass));
+            Class voClass = meta.inventoryAnnotation.mappingVOClass();
+            Field pkField = EntityMetadata.getPrimaryKeyField(voClass);
+            String pkName = pkField.getName();
+            if (!meta.selfInventoryFieldNames.contains(pkName)) {
+                return null;
+            }
+            return pkName;
+        } catch (Exception e) {
+            logger.trace(String.format("cannot resolve PK for %s, skip pagination tiebreaker: %s",
+                    inventoryClass.getSimpleName(), e.getMessage()));
+            return null;
+        }
+    }
+
     private QueryBelongFilter validateFilterNameAndGetExp(String filterName) {
         if (filterName.split(":").length < 2) {
             throw new OperationFailureException(argerr(ORG_ZSTACK_QUERY_10015, "filterName must be formatted as [filterType:condition(s)]"));