Expand filtering by created_ats and updated_ats

The following resources can now be filtered by these values:
* Buildpacks
* Deployments
* Domains
* Droplets
* ServiceUsageEvents
* Builds

We also moved the logic for `created_ats` and `updated_ats` into the
`ListMessage` and `BaseListFetcher` classes so as not to duplicate it in
every class that inherits from these.

Co-authored-by: Teal Stannard <tstannard@pivotal.io>
Co-authored-by: Renee Chu <rchu@pivotal.io>
Co-authored-by: Chris Selzo <cselzo@pivotal.io>
Co-authored-by: Mona Mohebbi <mmohebbi@pivotal.io>

Author: 5 people

app/controllers/v3/apps_controller.rb

@@ -226,7 +226,7 @@ def builds
     app, space, org = AppFetcher.new.fetch(hashed_params[:guid])
     app_not_found! unless app && permission_queryer.can_read_from_space?(space.guid, org.guid)
 
-    dataset = AppBuildsListFetcher.new(app.guid, message).fetch_all
+    dataset = AppBuildsListFetcher.fetch_all(app.guid, message)
     render status: :ok, json: Presenters::V3::PaginatedListPresenter.new(
       presenter: Presenters::V3::BuildPresenter,
       paginated_result: SequelPaginator.new.get_page(dataset, message.try(:pagination_options)),

app/controllers/v3/buildpacks_controller.rb

@@ -24,7 +24,7 @@ def index
         message: message
       )
     else
-      dataset = BuildpackListFetcher.new.fetch_all(message, eager_loaded_associations: Presenters::V3::BuildpackPresenter.associated_resources)
+      dataset = BuildpackListFetcher.fetch_all(message, eager_loaded_associations: Presenters::V3::BuildpackPresenter.associated_resources)
       render status: :ok, json: Presenters::V3::PaginatedListPresenter.new(
         presenter: Presenters::V3::BuildpackPresenter,
         paginated_result: SequelPaginator.new.get_page(dataset, message.try(:pagination_options)),

app/controllers/v3/builds_controller.rb

@@ -11,11 +11,10 @@ class BuildsController < ApplicationController
   def index
     message = BuildsListMessage.from_params(query_params)
     invalid_param!(message.errors.full_messages) unless message.valid?
-    build_list_fetcher = BuildListFetcher.new(message: message)
     dataset = if permission_queryer.can_read_globally?
-                build_list_fetcher.fetch_all(eager_loaded_associations: Presenters::V3::BuildPresenter.associated_resources)
+                BuildListFetcher.fetch_all(message, eager_loaded_associations: Presenters::V3::BuildPresenter.associated_resources)
               else
-                build_list_fetcher.fetch_for_spaces(space_guids: permission_queryer.readable_space_guids,
+                BuildListFetcher.fetch_for_spaces(message, space_guids: permission_queryer.readable_space_guids,
                   eager_loaded_associations: Presenters::V3::BuildPresenter.associated_resources)
               end
 

app/controllers/v3/deployments_controller.rb

@@ -12,11 +12,10 @@ class DeploymentsController < ApplicationController
   def index
     message = DeploymentsListMessage.from_params(query_params)
     invalid_param!(message.errors.full_messages) unless message.valid?
-    deployment_list_fetcher = DeploymentListFetcher.new(message: message)
     dataset = if permission_queryer.can_read_globally?
-                deployment_list_fetcher.fetch_all
+                DeploymentListFetcher.fetch_all(message)
               else
-                deployment_list_fetcher.fetch_for_spaces(space_guids: permission_queryer.readable_space_guids)
+                DeploymentListFetcher.fetch_for_spaces(message, space_guids: permission_queryer.readable_space_guids)
               end
 
     render status: :ok, json: Presenters::V3::PaginatedListPresenter.new(

app/controllers/v3/droplets_controller.rb

@@ -30,16 +30,16 @@ def index
     invalid_param!(message.errors.full_messages) unless message.valid?
 
     if app_nested?
-      app, dataset = DropletListFetcher.new(message: message).fetch_for_app
+      app, dataset = DropletListFetcher.fetch_for_app(message)
       app_not_found! unless app && permission_queryer.can_read_from_space?(app.space.guid, app.organization.guid)
     elsif package_nested?
-      package, dataset = DropletListFetcher.new(message: message).fetch_for_package
+      package, dataset = DropletListFetcher.fetch_for_package(message)
       package_not_found! unless package && permission_queryer.can_read_from_space?(package.space.guid, package.space.organization.guid)
     else
       dataset = if permission_queryer.can_read_globally?
-                  DropletListFetcher.new(message: message).fetch_all
+                  DropletListFetcher.fetch_all(message)
                 else
-                  DropletListFetcher.new(message: message).fetch_for_spaces(space_guids: permission_queryer.readable_space_guids)
+                  DropletListFetcher.fetch_for_spaces(message, permission_queryer.readable_space_guids)
                 end
     end
 

app/fetchers/app_builds_list_fetcher.rb

@@ -1,31 +1,33 @@
+require 'fetchers/base_list_fetcher'
+
 module VCAP::CloudController
-  class AppBuildsListFetcher
-    def initialize(app_guid, message)
-      @app_guid = app_guid
-      @message = message
-    end
+  class AppBuildsListFetcher < BaseListFetcher
+    class << self
+      def fetch_all(app_guid, message)
+        dataset = BuildModel.dataset.where(app_guid: app_guid)
+        filter(message, dataset)
+      end
 
-    def fetch_all
-      dataset = BuildModel.dataset.where(app_guid: app_guid)
+      private
 
-      if message.requested?(:label_selector)
-        dataset = LabelSelectorQueryGenerator.add_selector_queries(
-          label_klass: BuildLabelModel,
-          resource_dataset: dataset,
-          requirements: message.requirements,
-          resource_klass: BuildModel,
-        )
-      end
+      def filter(message, dataset)
+        if message.requested?(:label_selector)
+          dataset = LabelSelectorQueryGenerator.add_selector_queries(
+            label_klass: BuildLabelModel,
+            resource_dataset: dataset,
+            requirements: message.requirements,
+            resource_klass: BuildModel,
+              )
+        end
 
-      if message.requested? :states
-        dataset = dataset.where(state: message.states)
+        if message.requested? :states
+          dataset = dataset.where(state: message.states)
+        end
+
+        super(message, dataset, BuildModel)
       end
 
-      dataset
+      attr_reader :app_guid, :message
     end
-
-    private
-
-    attr_reader :app_guid, :message
   end
 end

app/fetchers/build_list_fetcher.rb

@@ -1,50 +1,47 @@
 module VCAP::CloudController
-  class BuildListFetcher
-    def initialize(message:)
-      @message = message
-    end
-
-    def fetch_all(eager_loaded_associations: [])
-      filter(AppModel.dataset, eager_loaded_associations: eager_loaded_associations)
-    end
+  class BuildListFetcher < BaseListFetcher
+    class << self
+      def fetch_all(message, eager_loaded_associations: [])
+        filter(message, AppModel.dataset, eager_loaded_associations: eager_loaded_associations)
+      end
 
-    def fetch_for_spaces(space_guids:, eager_loaded_associations: [])
-      app_dataset = AppModel.select(:id).where(space_guid: space_guids)
-      filter(app_dataset, eager_loaded_associations: eager_loaded_associations)
-    end
+      def fetch_for_spaces(message, space_guids:, eager_loaded_associations: [])
+        app_dataset = AppModel.select(:id).where(space_guid: space_guids)
+        filter(message, app_dataset, eager_loaded_associations: eager_loaded_associations)
+      end
 
-    private
+      private
 
-    attr_reader :message
+      def filter(message, app_dataset, eager_loaded_associations: [])
+        dataset = BuildModel.dataset
 
-    def filter(app_dataset, eager_loaded_associations: [])
-      dataset = BuildModel.dataset
+        if message.requested?(:label_selector)
+          dataset = LabelSelectorQueryGenerator.add_selector_queries(
+            label_klass: BuildLabelModel,
+            resource_dataset: dataset,
+            requirements: message.requirements,
+            resource_klass: BuildModel,
+          )
+        end
 
-      if message.requested?(:label_selector)
-        dataset = LabelSelectorQueryGenerator.add_selector_queries(
-          label_klass: BuildLabelModel,
-          resource_dataset: dataset,
-          requirements: message.requirements,
-          resource_klass: BuildModel,
-        )
-      end
+        if message.requested?(:states)
+          dataset = dataset.where(state: message.states)
+        end
 
-      if message.requested?(:states)
-        dataset = dataset.where(state: message.states)
-      end
+        if message.requested?(:package_guids)
+          dataset = dataset.where(package_guid: message.package_guids)
+        end
 
-      if message.requested?(:package_guids)
-        dataset = dataset.where(package_guid: message.package_guids)
+        dataset = dataset.where(app_guid: filter_app_dataset(message, app_dataset).select(:guid)).eager(eager_loaded_associations).qualify
+        super(message, dataset, BuildModel)
       end
 
-      dataset.where(app_guid: filter_app_dataset(app_dataset).select(:guid)).eager(eager_loaded_associations).qualify
-    end
-
-    def filter_app_dataset(app_dataset)
-      if message.requested? :app_guids
-        app_dataset = app_dataset.where(guid: message.app_guids)
+      def filter_app_dataset(message, app_dataset)
+        if message.requested? :app_guids
+          app_dataset = app_dataset.where(guid: message.app_guids)
+        end
+        app_dataset
       end
-      app_dataset
     end
   end
 end

app/fetchers/buildpack_list_fetcher.rb

@@ -1,36 +1,39 @@
 require 'cloud_controller/paging/sequel_paginator'
 require 'cloud_controller/paging/paginated_result'
 require 'fetchers/null_filter_query_generator'
+require 'fetchers/base_list_fetcher'
 
 module VCAP::CloudController
-  class BuildpackListFetcher
-    def fetch_all(message, eager_loaded_associations: [])
-      filter(message, buildpacks_dataset(eager_loaded_associations))
-    end
-
-    def buildpacks_dataset(eager_loaded_associations)
-      Buildpack.dataset.eager(eager_loaded_associations)
-    end
-
-    def filter(message, dataset)
-      if message.requested?(:names)
-        dataset = dataset.where(name: message.names)
+  class BuildpackListFetcher < BaseListFetcher
+    class << self
+      def fetch_all(message, eager_loaded_associations: [])
+        filter(message, buildpacks_dataset(eager_loaded_associations))
       end
 
-      if message.requested?(:stacks)
-        dataset = NullFilterQueryGenerator.add_filter(dataset, :stack, message.stacks)
+      def buildpacks_dataset(eager_loaded_associations)
+        Buildpack.dataset.eager(eager_loaded_associations)
       end
 
-      if message.requested?(:label_selector)
-        dataset = LabelSelectorQueryGenerator.add_selector_queries(
-          label_klass: BuildpackLabelModel,
-          resource_dataset: dataset,
-          requirements: message.requirements,
-          resource_klass: Buildpack,
-        )
-      end
+      def filter(message, dataset)
+        if message.requested?(:names)
+          dataset = dataset.where(name: message.names)
+        end
+
+        if message.requested?(:stacks)
+          dataset = NullFilterQueryGenerator.add_filter(dataset, :stack, message.stacks)
+        end
 
-      dataset
+        if message.requested?(:label_selector)
+          dataset = LabelSelectorQueryGenerator.add_selector_queries(
+            label_klass: BuildpackLabelModel,
+            resource_dataset: dataset,
+            requirements: message.requirements,
+            resource_klass: Buildpack,
+              )
+        end
+
+        super(message, dataset, Buildpack)
+      end
     end
   end
 end

app/fetchers/deployment_list_fetcher.rb

@@ -1,55 +1,55 @@
-module VCAP::CloudController
-  class DeploymentListFetcher
-    def initialize(message:)
-      @message = message
-    end
-
-    def fetch_all
-      filter(AppModel.select(:id))
-    end
-
-    def fetch_for_spaces(space_guids:)
-      app_dataset = AppModel.where(space_guid: space_guids)
-      filter(app_dataset)
-    end
-
-    private
-
-    attr_reader :message
+require 'fetchers/base_list_fetcher'
 
-    def filter(app_dataset)
-      dataset = filter_deployment_dataset(DeploymentModel.dataset)
+module VCAP::CloudController
+  class DeploymentListFetcher < BaseListFetcher
+    class << self
+      def fetch_all(message)
+        filter(message, AppModel.select(:id))
+      end
 
-      if message.requested? :app_guids
-        app_dataset = app_dataset.where(guid: message.app_guids)
+      def fetch_for_spaces(message, space_guids:)
+        app_dataset = AppModel.where(space_guid: space_guids)
+        filter(message, app_dataset)
       end
 
-      dataset.where(app: app_dataset)
-    end
+      private
 
-    def filter_deployment_dataset(dataset)
-      if message.requested? :states
-        dataset = dataset.where(state: message.states)
-      end
+      attr_reader :message
 
-      if message.requested? :status_reasons
-        dataset = NullFilterQueryGenerator.add_filter(dataset, :status_reason, message.status_reasons)
-      end
+      def filter(message, app_dataset)
+        dataset = filter_deployment_dataset(message, DeploymentModel.dataset)
 
-      if message.requested? :status_values
-        dataset = dataset.where(status_value: message.status_values)
-      end
+        if message.requested? :app_guids
+          app_dataset = app_dataset.where(guid: message.app_guids)
+        end
 
-      if message.requested?(:label_selector)
-        dataset = LabelSelectorQueryGenerator.add_selector_queries(
-          label_klass: DeploymentLabelModel,
-          resource_dataset: dataset,
-          requirements: message.requirements,
-          resource_klass: DeploymentModel,
-        )
+        dataset = dataset.where(app: app_dataset)
+        super(message, dataset, DeploymentModel)
       end
 
-      dataset
+      def filter_deployment_dataset(message, dataset)
+        if message.requested? :states
+          dataset = dataset.where(state: message.states)
+        end
+
+        if message.requested? :status_reasons
+          dataset = NullFilterQueryGenerator.add_filter(dataset, :status_reason, message.status_reasons)
+        end
+
+        if message.requested? :status_values
+          dataset = dataset.where(status_value: message.status_values)
+        end
+
+        if message.requested?(:label_selector)
+          dataset = LabelSelectorQueryGenerator.add_selector_queries(
+            label_klass: DeploymentLabelModel,
+            resource_dataset: dataset,
+            requirements: message.requirements,
+            resource_klass: DeploymentModel,
+          )
+        end
+        dataset
+      end
     end
   end
 end

app/fetchers/domain_fetcher.rb

@@ -1,5 +1,5 @@
 module VCAP::CloudController
-  class DomainFetcher
+  class DomainFetcher < BaseListFetcher
     class << self
       def fetch_all_for_orgs(readable_org_guids)
         # Q: The "Domain" in Domain.dataset is arbitrary -- just a way to get access to any database table.
@@ -53,7 +53,7 @@ def filter(message, dataset)
           )
         end
 
-        dataset
+        super(message, dataset, Domain)
       end
     end
   end