Merge pull request #234 from thirdweb-dev/07-02-return_data_or_aggregations_as_empty_array_if_no_results

return data or aggregations as empty array if no results

Author: iuwqyir

api/api.go

@@ -73,9 +73,9 @@ type QueryResponse struct {
 	// @Description Metadata for the query response
 	Meta Meta `json:"meta"`
 	// @Description Query result data
-	Data interface{} `json:"data,omitempty"`
+	Data *interface{} `json:"data,omitempty"`
 	// @Description Aggregation results
-	Aggregations []map[string]interface{} `json:"aggregations,omitempty"`
+	Aggregations *[]map[string]interface{} `json:"aggregations,omitempty"`
 }
 
 func writeError(w http.ResponseWriter, message string, code int) {

internal/handlers/blocks_handlers.go

@@ -88,7 +88,7 @@ func handleBlocksRequest(c *gin.Context) {
 			api.InternalErrorHandler(c)
 			return
 		}
-		queryResult.Aggregations = aggregatesResult.Aggregates
+		queryResult.Aggregations = &aggregatesResult.Aggregates
 		queryResult.Meta.TotalItems = len(aggregatesResult.Aggregates)
 	} else {
 		// Retrieve blocks data
@@ -100,7 +100,8 @@ func handleBlocksRequest(c *gin.Context) {
 			return
 		}
 
-		queryResult.Data = serializeBlocks(blocksResult.Data)
+		var data interface{} = serializeBlocks(blocksResult.Data)
+		queryResult.Data = &data
 		queryResult.Meta.TotalItems = len(blocksResult.Data)
 	}
 

internal/handlers/logs_handlers.go

@@ -168,7 +168,7 @@ func handleLogsRequest(c *gin.Context) {
 			api.InternalErrorHandler(c)
 			return
 		}
-		queryResult.Aggregations = aggregatesResult.Aggregates
+		queryResult.Aggregations = &aggregatesResult.Aggregates
 		queryResult.Meta.TotalItems = len(aggregatesResult.Aggregates)
 	} else {
 		// Retrieve logs data
@@ -180,12 +180,13 @@ func handleLogsRequest(c *gin.Context) {
 			return
 		}
 
+		var data interface{}
 		if decodedLogs := decodeLogsIfNeeded(chainId.String(), logsResult.Data, eventABI, config.Cfg.API.AbiDecodingEnabled && queryParams.Decode); decodedLogs != nil {
-			queryResult.Data = serializeDecodedLogs(decodedLogs)
+			data = serializeDecodedLogs(decodedLogs)
 		} else {
-			queryResult.Data = serializeLogs(logsResult.Data)
+			data = serializeLogs(logsResult.Data)
 		}
-
+		queryResult.Data = &data
 		queryResult.Meta.TotalItems = len(logsResult.Data)
 	}
 

internal/handlers/search_handlers.go

@@ -84,11 +84,12 @@ func Search(c *gin.Context) {
 		return
 	}
 
+	var data interface{} = result
 	sendJSONResponse(c, api.QueryResponse{
 		Meta: api.Meta{
 			ChainId: chainId.Uint64(),
 		},
-		Data: result,
+		Data: &data,
 	})
 }
 

internal/handlers/token_handlers.go

@@ -128,7 +128,8 @@ func GetTokenIdsByType(c *gin.Context) {
 		return
 	}
 
-	queryResult.Data = serializeTokenIds(balancesResult.Data)
+	var data interface{} = serializeTokenIds(balancesResult.Data)
+	queryResult.Data = &data
 	sendJSONResponse(c, queryResult)
 }
 
@@ -224,7 +225,8 @@ func GetTokenBalancesByType(c *gin.Context) {
 		api.InternalErrorHandler(c)
 		return
 	}
-	queryResult.Data = serializeBalances(balancesResult.Data)
+	var data interface{} = serializeBalances(balancesResult.Data)
+	queryResult.Data = &data
 	sendJSONResponse(c, queryResult)
 }
 
@@ -313,7 +315,8 @@ func GetTokenHoldersByType(c *gin.Context) {
 		api.InternalErrorHandler(c)
 		return
 	}
-	queryResult.Data = serializeHolders(balancesResult.Data)
+	var data interface{} = serializeHolders(balancesResult.Data)
+	queryResult.Data = &data
 	sendJSONResponse(c, queryResult)
 }
 

internal/handlers/transactions_handlers.go

@@ -187,7 +187,7 @@ func handleTransactionsRequest(c *gin.Context) {
 			api.InternalErrorHandler(c)
 			return
 		}
-		queryResult.Aggregations = aggregatesResult.Aggregates
+		queryResult.Aggregations = &aggregatesResult.Aggregates
 		queryResult.Meta.TotalItems = len(aggregatesResult.Aggregates)
 	} else {
 		// Retrieve logs data
@@ -199,11 +199,13 @@ func handleTransactionsRequest(c *gin.Context) {
 			return
 		}
 
+		var data interface{}
 		if decodedTxs := decodeTransactionsIfNeeded(chainId.String(), transactionsResult.Data, functionABI, config.Cfg.API.AbiDecodingEnabled && queryParams.Decode); decodedTxs != nil {
-			queryResult.Data = serializeDecodedTransactions(decodedTxs)
+			data = serializeDecodedTransactions(decodedTxs)
 		} else {
-			queryResult.Data = serializeTransactions(transactionsResult.Data)
+			data = serializeTransactions(transactionsResult.Data)
 		}
+		queryResult.Data = &data
 		queryResult.Meta.TotalItems = len(transactionsResult.Data)
 	}
 

internal/handlers/transfer_handlers.go

@@ -161,7 +161,8 @@ func GetTokenTransfers(c *gin.Context) {
 		return
 	}
 
-	queryResult.Data = serializeTransfers(transfersResult.Data)
+	var data interface{} = serializeTransfers(transfersResult.Data)
+	queryResult.Data = &data
 	sendJSONResponse(c, queryResult)
 }
 

internal/storage/clickhouse.go

@@ -535,8 +535,8 @@ func (c *ClickHouseConnector) GetAggregations(table string, qf QueryFilter) (Que
 	columnNames := rows.Columns()
 	columnTypes := rows.ColumnTypes()
 
-	// Collect results
-	var aggregates []map[string]interface{}
+	// Collect results - initialize as empty array to ensure we always return an array
+	aggregates := make([]map[string]interface{}, 0)
 	for rows.Next() {
 		values := make([]interface{}, len(columnNames))