Merge branch 'feature/gb/paginated-environments-api' into 'master'

Expose paginated environments list API endpoint

See merge request !8928

2 files changed, 59 insertions, 28 deletions

diff --git a/app/serializers/environment_serializer.rb b/app/serializers/environment_serializer.rb
index 91955542f25..fe16a3784c4 100644
--- a/app/serializers/environment_serializer.rb
+++ b/app/serializers/environment_serializer.rb
@@ -1,3 +1,50 @@
 class EnvironmentSerializer < BaseSerializer
+  Item = Struct.new(:name, :size, :latest)
+
   entity EnvironmentEntity
+
+  def within_folders
+    tap { @itemize = true }
+  end
+
+  def with_pagination(request, response)
+    tap { @paginator = Gitlab::Serializer::Pagination.new(request, response) }
+  end
+
+  def itemized?
+    @itemize
+  end
+
+  def paginated?
+    @paginator.present?
+  end
+
+  def represent(resource, opts = {})
+    resource = @paginator.paginate(resource) if paginated?
+
+    if itemized?
+      itemize(resource).map do |item|
+        { name: item.name,
+          size: item.size,
+          latest: super(item.latest, opts) }
+      end
+    else
+      super(resource, opts)
+    end
+  end
+
+  private
+
+  def itemize(resource)
+    items = resource.group(:item_name).order('item_name ASC')
+      .pluck('COALESCE(environment_type, name) AS item_name',
+             'COUNT(*) AS environments_count',
+             'MAX(id) AS last_environment_id')
+
+    environments = resource.where(id: items.map(&:last)).index_by(&:id)
+
+    items.map do |name, size, id|
+      Item.new(name, size, environments[id])
+    end
+  end
 end
diff --git a/app/serializers/pipeline_serializer.rb b/app/serializers/pipeline_serializer.rb
index b2de6c5832e..2bc6cf3266e 100644
--- a/app/serializers/pipeline_serializer.rb
+++ b/app/serializers/pipeline_serializer.rb
@@ -1,41 +1,25 @@
 class PipelineSerializer < BaseSerializer
   class InvalidResourceError < StandardError; end
-  include API::Helpers::Pagination
-  Struct.new('Pagination', :request, :response)
 
   entity PipelineEntity
 
-  def represent(resource, opts = {})
-    if paginated?
-      raise InvalidResourceError unless resource.respond_to?(:page)
-
-      super(paginate(resource.includes(project: :namespace)), opts)
-    else
-      super(resource, opts)
-    end
-  end
-
-  def paginated?
-    defined?(@pagination)
-  end
-
   def with_pagination(request, response)
-    tap { @pagination = Struct::Pagination.new(request, response) }
+    tap { @paginator = Gitlab::Serializer::Pagination.new(request, response) }
   end
 
-  private
-
-  # Methods needed by `API::Helpers::Pagination`
-  #
-  def params
-    @pagination.request.query_parameters
+  def paginated?
+    @paginator.present?
   end
 
-  def request
-    @pagination.request
-  end
+  def represent(resource, opts = {})
+    if resource.is_a?(ActiveRecord::Relation)
+      resource = resource.includes(project: :namespace)
+    end
 
-  def header(header, value)
-    @pagination.response.headers[header] = value
+    if paginated?
+      super(@paginator.paginate(resource), opts)
+    else
+      super(resource, opts)
+    end
   end
 end