Runtime: Support path filter in ListResources

proto/gen/rill/runtime/v1/runtime.swagger.yaml

@@ -2417,10 +2417,17 @@ paths:
             $ref: '#/definitions/rpcStatus'
       parameters:
         - name: instanceId
+          description: Instance to list resources from.
           in: path
           required: true
           type: string
         - name: kind
+          description: Filter by resource kind (optional).
+          in: query
+          required: false
+          type: string
+        - name: path
+          description: Filter by resource path (optional).
           in: query
           required: false
           type: string

proto/rill/runtime/v1/api.proto

@@ -615,8 +615,12 @@ message WatchLogsResponse {
 }
 
 message ListResourcesRequest {
+  // Instance to list resources from.
   string instance_id = 1;
+  // Filter by resource kind (optional).
   string kind = 2;
+  // Filter by resource path (optional).
+  string path = 3;
 }
 
 message ListResourcesResponse {

runtime/catalog_cache.go

@@ -154,59 +154,58 @@ func (c *catalogCache) get(n *runtimev1.ResourceName, withDeleted, clone bool) (
 }
 
 // list returns a list of resources in the catalog.
+// It optionally supports filtering by kind, path, and soft-deleted status.
 // The returned list is not sorted.
 // The returned list is always safe to manipulate (e.g. sort/filter), but the resource pointers must not be edited unless clone=true.
 // Unlike other catalog functions, it is safe to call list concurrently with calls to get and flush (i.e. under a read lock).
-func (c *catalogCache) list(kind string, withDeleted, clone bool) ([]*runtimev1.Resource, error) {
-	if kind != "" {
-		n := len(c.resources[kind])
-		res := make([]*runtimev1.Resource, 0, n)
-		if withDeleted {
-			for _, r := range c.resources[kind] {
-				if clone {
-					r = c.clone(r)
-				}
-				res = append(res, r)
-			}
-		} else {
-			for _, r := range c.resources[kind] {
-				if r.Meta.DeletedOn == nil {
-					if clone {
-						r = c.clone(r)
-					}
-					res = append(res, r)
-				}
-			}
-		}
-
-		return res, nil
-	}
-
+func (c *catalogCache) list(kind, path string, withDeleted, clone bool) ([]*runtimev1.Resource, error) {
+	// Estimate number of resources to list
 	n := 0
-	for _, rs := range c.resources {
-		n += len(rs)
+	if path != "" {
+		n = 1
+	} else if kind == "" {
+		for _, rs := range c.resources {
+			n += len(rs)
+		}
+	} else {
+		n = len(c.resources[kind])
 	}
 
+	// Alloc slice for resources
 	res := make([]*runtimev1.Resource, 0, n)
-	if withDeleted {
-		for _, rs := range c.resources {
-			for _, r := range rs {
-				if clone {
-					r = c.clone(r)
-				}
-				res = append(res, r)
-			}
+
+	// Find resources matching the filters and append to slice
+	for k, rs := range c.resources {
+		// Skip if doesn't match kind filter
+		if kind != "" && k != kind {
+			continue
 		}
-	} else {
-		for _, rs := range c.resources {
-			for _, r := range rs {
-				if r.Meta.DeletedOn == nil {
-					if clone {
-						r = c.clone(r)
+
+		for _, r := range rs {
+			// Skip if doesn't match withDeleted filter
+			if !withDeleted && r.Meta.DeletedOn != nil {
+				continue
+			}
+
+			// Skip if doesn't match path filter
+			if path != "" {
+				found := false
+				for _, p := range r.Meta.FilePaths {
+					if p == path {
+						found = true
+						break
 					}
-					res = append(res, r)
 				}
+				if !found {
+					continue
+				}
+			}
+
+			// Append to res
+			if clone {
+				r = c.clone(r)
 			}
+			res = append(res, r)
 		}
 	}
 

runtime/controller.go

@@ -393,7 +393,7 @@ func (c *Controller) Get(ctx context.Context, name *runtimev1.ResourceName, clon
 // List returns a list of resources of the specified kind.
 // If kind is empty, all resources are returned.
 // Soft-deleted resources (i.e. resources where DeletedOn != nil) are not returned.
-func (c *Controller) List(ctx context.Context, kind string, clone bool) ([]*runtimev1.Resource, error) {
+func (c *Controller) List(ctx context.Context, kind, path string, clone bool) ([]*runtimev1.Resource, error) {
 	ctx, span := tracer.Start(ctx, "Controller.List", trace.WithAttributes(attribute.String("instance_id", c.InstanceID), attribute.String("kind", kind)))
 	defer span.End()
 	if err := c.checkRunning(); err != nil {
@@ -404,7 +404,7 @@ func (c *Controller) List(ctx context.Context, kind string, clone bool) ([]*runt
 	}
 	c.lock(ctx, true)
 	defer c.unlock(ctx, true)
-	return c.catalog.list(kind, false, clone)
+	return c.catalog.list(kind, path, false, clone)
 }
 
 // SubscribeCallback is the callback type passed to Subscribe.

runtime/reconcilers/project_parser.go

@@ -87,7 +87,7 @@ func (r *ProjectParserReconciler) Reconcile(ctx context.Context, n *runtimev1.Re
 		r.C.Lock(ctx)
 		defer r.C.Unlock(ctx)
 
-		resources, err := r.C.List(ctx, "", false)
+		resources, err := r.C.List(ctx, "", "", false)
 		if err != nil {
 			return runtime.ReconcileResult{Err: err}
 		}
@@ -348,7 +348,7 @@ func (r *ProjectParserReconciler) reconcileResources(ctx context.Context, inst *
 	var deleteResources []*runtimev1.Resource
 
 	// Pass over all existing resources in the catalog.
-	resources, err := r.C.List(ctx, "", false)
+	resources, err := r.C.List(ctx, "", "", false)
 	if err != nil {
 		return err
 	}

runtime/reconcilers/refresh_trigger.go

@@ -71,7 +71,7 @@ func (r *RefreshTriggerReconciler) Reconcile(ctx context.Context, n *runtimev1.R
 	r.C.Lock(ctx)
 	defer r.C.Unlock(ctx)
 
-	resources, err := r.C.List(ctx, "", false)
+	resources, err := r.C.List(ctx, "", "", false)
 	if err != nil {
 		return runtime.ReconcileResult{Err: err}
 	}

runtime/server/catalog.go

@@ -297,7 +297,7 @@ func (s *Server) RefreshAndReconcile(ctx context.Context, req *runtimev1.Refresh
 		return nil, status.Error(codes.InvalidArgument, err.Error())
 	}
 
-	rs, err := ctrl.List(ctx, runtime.ResourceKindSource, false)
+	rs, err := ctrl.List(ctx, runtime.ResourceKindSource, "", false)
 	if err != nil {
 		return nil, status.Error(codes.InvalidArgument, err.Error())
 	}
@@ -528,7 +528,7 @@ func (s *Server) resourceToEntry(ctx context.Context, instanceID string, r *runt
 }
 
 func (s *Server) controllerToLegacyReconcileStatus(ctx context.Context, ctrl *runtime.Controller, since time.Time) (*runtimev1.ReconcileResponse, error) {
-	rs, err := ctrl.List(ctx, "", false)
+	rs, err := ctrl.List(ctx, "", "", false)
 	if err != nil {
 		return nil, err
 	}

runtime/server/controller.go

@@ -40,7 +40,7 @@ func (s *Server) ListResources(ctx context.Context, req *runtimev1.ListResources
 		return nil, status.Error(codes.InvalidArgument, err.Error())
 	}
 
-	rs, err := ctrl.List(ctx, req.Kind, false)
+	rs, err := ctrl.List(ctx, req.Kind, req.Path, false)
 	if err != nil {
 		return nil, status.Error(codes.InvalidArgument, err.Error())
 	}
@@ -95,7 +95,7 @@ func (s *Server) WatchResources(req *runtimev1.WatchResourcesRequest, ss runtime
 	}
 
 	if req.Replay {
-		rs, err := ctrl.List(ss.Context(), req.Kind, false)
+		rs, err := ctrl.List(ss.Context(), req.Kind, "", false)
 		if err != nil {
 			return status.Error(codes.InvalidArgument, err.Error())
 		}

runtime/testruntime/reconcile.go

@@ -95,7 +95,7 @@ func RequireReconcileState(t testing.TB, rt *runtime.Runtime, id string, lenReso
 	ctrl, err := rt.Controller(context.Background(), id)
 	require.NoError(t, err)
 
-	rs, err := ctrl.List(context.Background(), "", false)
+	rs, err := ctrl.List(context.Background(), "", "", false)
 	require.NoError(t, err)
 
 	var reconcileErrs, parseErrs []string
@@ -185,7 +185,7 @@ func DumpResources(t testing.TB, rt *runtime.Runtime, id string) {
 	ctrl, err := rt.Controller(context.Background(), id)
 	require.NoError(t, err)
 
-	rs, err := ctrl.List(context.Background(), "", false)
+	rs, err := ctrl.List(context.Background(), "", "", false)
 	require.NoError(t, err)
 
 	for _, r := range rs {

web-common/src/proto/gen/rill/runtime/v1/api_pb.ts

@@ -2400,15 +2400,26 @@ export class WatchLogsResponse extends Message<WatchLogsResponse> {
  */
 export class ListResourcesRequest extends Message<ListResourcesRequest> {
   /**
+   * Instance to list resources from.
+   *
    * @generated from field: string instance_id = 1;
    */
   instanceId = "";
 
   /**
+   * Filter by resource kind (optional).
+   *
    * @generated from field: string kind = 2;
    */
   kind = "";
 
+  /**
+   * Filter by resource path (optional).
+   *
+   * @generated from field: string path = 3;
+   */
+  path = "";
+
   constructor(data?: PartialMessage<ListResourcesRequest>) {
     super();
     proto3.util.initPartial(data, this);
@@ -2419,6 +2430,7 @@ export class ListResourcesRequest extends Message<ListResourcesRequest> {
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: "instance_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 2, name: "kind", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: "path", kind: "scalar", T: 9 /* ScalarType.STRING */ },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ListResourcesRequest {

web-common/src/proto/gen/rill/ui/v1/dashboard_pb.ts

@@ -159,7 +159,7 @@ export class DashboardState extends Message<DashboardState> {
   chartType?: string;
 
   /**
-   *
+   * *
    * Pivot related fields
    *
    * @generated from field: optional bool pivot_is_active = 22;
@@ -352,7 +352,7 @@ proto3.util.setEnumType(DashboardState_LeaderboardSortDirection, "rill.ui.v1.Das
 ]);
 
 /**
- *
+ * *
  * SortType is used to determine how to sort the leaderboard
  * and dimension detail table, as well as where to place the
  * sort arrow.

web-common/src/runtime-client/gen/index.schemas.ts

@@ -53,7 +53,10 @@ export type RuntimeServiceWatchResourcesParams = {
   level?: string;
 };
 
-export type RuntimeServiceListResourcesParams = { kind?: string };
+export type RuntimeServiceListResourcesParams = {
+  kind?: string;
+  path?: string;
+};
 
 export type RuntimeServiceGetResourceParams = {
   "name.kind"?: string;