feat(inspect-api): return empty list of 'items' instead of 'null' (#3765

)

pkg/api-server/inspect_endpoints.go

@@ -83,11 +83,9 @@ func inspectDataplane(cfg *kuma_cp.Config, builder xds_context.MeshContextBuilde
 			return
 		}
 
-		entries := newDataplaneInspectResponse(matchedPolicies, dp)
-		result := &api_server_types.DataplaneInspectEntryList{
-			Items: entries,
-			Total: uint32(len(entries)),
-		}
+		result := api_server_types.NewDataplaneInspectEntryList()
+		result.Items = append(result.Items, newDataplaneInspectResponse(matchedPolicies, dp)...)
+		result.Total = uint32(len(result.Items))
 
 		if err := response.WriteAsJson(result); err != nil {
 			rest_errors.HandleError(response, err, "Could not write response")
@@ -111,7 +109,7 @@ func inspectPolicies(
 			return
 		}
 
-		result := &api_server_types.PolicyInspectEntryList{}
+		result := api_server_types.NewPolicyInspectEntryList()
 
 		for _, dp := range meshContext.Resources.Dataplanes().Items {
 			dpKey := core_model.MetaToResourceKey(dp.GetMeta())

pkg/api-server/inspect_endpoints_test.go

@@ -232,6 +232,21 @@ var _ = Describe("Inspect WS", func() {
 				},
 			},
 		}),
+		Entry("inspect dataplane, empty response", testCase{
+			path:       "/meshes/default/dataplanes/backend-1/policies",
+			goldenFile: "inspect_dataplane_empty-response.json",
+			resources: []core_model.Resource{
+				newMesh("default"),
+				newDataplane().
+					meta("backend-1", "default").
+					inbound("backend", "192.168.0.1", 80, 81).
+					outbound("redis", "192.168.0.2", 8080).
+					outbound("gateway", "192.168.0.3", 8080).
+					outbound("postgres", "192.168.0.4", 8080).
+					outbound("web", "192.168.0.2", 8080).
+					build(),
+			},
+		}),
 		Entry("inspect traffic permission", testCase{
 			path:       "/meshes/default/traffic-permissions/tp-1/dataplanes",
 			goldenFile: "inspect_traffic-permission.json",
@@ -561,6 +576,20 @@ var _ = Describe("Inspect WS", func() {
 					build(),
 			},
 		}),
+		Entry("inspect traffic trace, empty response", testCase{
+			path:       "/meshes/mesh-1/traffic-traces/tt-1/dataplanes",
+			goldenFile: "inspect_traffic-trace_empty-response.json",
+			resources: []core_model.Resource{
+				newMesh("mesh-1"),
+				&core_mesh.TrafficTraceResource{
+					Meta: &test_model.ResourceMeta{Name: "tt-1", Mesh: "mesh-1"},
+					Spec: &mesh_proto.TrafficTrace{
+						Selectors: anyService(),
+						Conf:      samples.TrafficTrace.Conf,
+					},
+				},
+			},
+		}),
 	)
 
 	It("should change response if state changed", func() {

pkg/api-server/testdata/inspect_dataplane_empty-response.json

@@ -0,0 +1,4 @@
+{
+ "total": 0,
+ "items": []
+}

pkg/api-server/testdata/inspect_traffic-trace_empty-response.json

@@ -0,0 +1,4 @@
+{
+ "total": 0,
+ "items": []
+}

pkg/api-server/types/inspect.go

@@ -30,6 +30,13 @@ type PolicyInspectEntryList struct {
 	Items []*PolicyInspectEntry `json:"items"`
 }
 
+func NewPolicyInspectEntryList() *PolicyInspectEntryList {
+	return &PolicyInspectEntryList{
+		Total: 0,
+		Items: []*PolicyInspectEntry{},
+	}
+}
+
 type DataplaneInspectEntry struct {
 	AttachmentEntry
 	MatchedPolicies map[core_model.ResourceType][]*rest.Resource `json:"matchedPolicies"`
@@ -40,6 +47,13 @@ type DataplaneInspectEntryList struct {
 	Items []*DataplaneInspectEntry `json:"items"`
 }
 
+func NewDataplaneInspectEntryList() *DataplaneInspectEntryList {
+	return &DataplaneInspectEntryList{
+		Total: 0,
+		Items: []*DataplaneInspectEntry{},
+	}
+}
+
 type DataplaneInspectEntryReceiver struct {
 	DataplaneInspectEntry
 	NewResource func(resourceType core_model.ResourceType) (core_model.Resource, error)