sorting projects on the dashboard by title

Moving code to grab the list of projects to a service
This should keep the tests from randomly failing

Author: carolyncole

app/models/mediaflux/project_list_request.rb

@@ -1,22 +1,17 @@
 # frozen_string_literal: true
 module Mediaflux
   class ProjectListRequest < Request
-    attr_reader :aql_query, :collection, :action, :deep_search, :iterator, :size
+    attr_reader :aql_query, :action, :size
 
     # Constructor
     # @param session_token [String] the API token for the authenticated session
     # @param aql_query [String] Optional AQL query string
-    # @param collection [Integer] Optional collection id
     # @param action [String] Optional, by default it uses get-name but it could also be get-meta to get all
     #                        the fields for the assets or `get-values` to get a limited list of fields.
-    # @param deep_search [Bool] Optional, false by default. When true queries the collection and it subcollections.
-    # @param iterator [Bool] Optional, true by default. When true returns an iterator.  When false returns a list of results
-    def initialize(session_token:, aql_query: nil, action: "get-meta", deep_search: true)
+    def initialize(session_token:, aql_query: nil, action: "get-meta")
       super(session_token: session_token)
       @aql_query = aql_query
-      @collection = collection
       @action = action
-      @deep_search = deep_search
       # For now we hard-code the size to infinity since only Administrators will fetch a large
       # number of projects and they should get them all. At some point in the future we might
       # want to implement pagination for this list but not now..
@@ -56,6 +51,11 @@ def build_http_request_body(name:)
             xml.where aql_query if aql_query.present?
             xml.action action if action.present?
             xml.size size if size.present?
+            # I tried sorting by path and that slowed down the query to unusable
+            # We will need to be considerate of performance when sorting the results
+            xml.sort do
+              xml.key "name"
+            end
           end
         end
       end

app/models/mediaflux/query_request.rb

@@ -49,6 +49,14 @@ def build_http_request_body(name:)
             xml.action action if action.present?
             declare_get_values_fields(xml) if action == "get-values"
             xml.as "iterator" if iterator
+            # # TODO I believe this is the sort needed for the file list
+            # # I am thinking we should create a separate class, but I do not want to loose the syntax
+            # xml.sort do
+            #   xml.key "@collection" do
+            #     xml.parent.set_attribute("order", "desc")
+            #   end
+            #   xml.key "name"
+            # end
           end
         end
       end

app/models/project.rb

@@ -108,15 +108,7 @@ def self.users_projects(user)
 
   # Returns the projects that the current user has access in Mediaflux given their credentials
   def self.all_projects(user, aql_query = "xpath(tigerdata:project/ProjectID) has value")
-    request = Mediaflux::ProjectListRequest.new(session_token: user.mediaflux_session, aql_query:)
-    request.resolve
-    if request.error?
-      Rails.logger.error("Error fetching project list for user #{user&.uid}: #{request.response_error[:message]}")
-      Honeybadger.notify("Error fetching project list for user #{user&.uid}: #{request.response_error[:message]}")
-      []
-    else
-      request.results
-    end
+    ProjectList.new(user, aql_query).all_projects
   end
 
   def created_by_user

app/services/project_list.rb

@@ -0,0 +1,22 @@
+class ProjectList
+  attr_reader :user, :project, :aql_query
+
+  def initialize(user, aql_query = "xpath(tigerdata:project/ProjectID) has value")
+    @user = user
+    @aql_query = aql_query
+  end
+
+  def all_projects
+    @all_projects ||= begin
+                        request = Mediaflux::ProjectListRequest.new(session_token: user.mediaflux_session, aql_query:)
+                        request.resolve
+                        if request.error?
+                          Rails.logger.error("Error fetching project list for user #{user&.uid}: #{request.response_error[:message]}")
+                          Honeybadger.notify("Error fetching project list for user #{user&.uid}: #{request.response_error[:message]}")
+                          []
+                        else
+                          request.results.sort_by { |project| project[:title] }
+                        end
+                      end
+    end
+end

spec/models/mediaflux/project_list_request_spec.rb

@@ -11,5 +11,15 @@
       expect(results.count).to be 1
       expect(results[0][:project_directory]).to eq "tigerdata/RDSS/testing-project"
     end
+
+    it "orders the results by project name which is the last section of the path" do
+      request = described_class.new(session_token: user.mediaflux_session, aql_query: "namespace>='/princeton/tigerdataNS/RDSSNS' and xpath(tigerdata:project/ProjectID) has value")
+      results = request.results
+      expect(results.count).to eq(4)
+      expect(results.pluck(:project_directory)).to eq ["tigerdata/RDSS/Query/AProject",
+                                                       "tigerdata/RDSS/Query/BProject",
+                                                       "tigerdata/RDSS/Query/CProject",
+                                                       "tigerdata/RDSS/testing-project"]
+    end
   end
 end

spec/services/project_list_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require "rails_helper"
+
+RSpec.describe ProjectList do
+  let(:user) { FactoryBot.create(:user, mediaflux_session: SystemUser.mediaflux_session) }
+  let(:project_list) { described_class.new(user, "namespace>='/princeton/tigerdataNS/RDSSNS' and xpath(tigerdata:project/ProjectID) has value") }
+
+  describe "#all_projects" do
+    it "returns the projects that the user has access to in Mediaflux" do
+      projects = project_list.all_projects
+      expect(projects.count).to eq(4)
+      expect(projects.pluck(:title)).to eq(["Project A", "Project B", "Project C", "Test Project"])
+    end
+  end
+end