[#50543] Failing GRAPH API call leads to rails exception

- https://community.openproject.org/work_packages/50543
- added new endpoints for opening storages
  - /api/v3/storages/:id/open
  - /api/v3/project_storages/:id/open
- amended queries
- amended storage representer
- added static links to open project storages from project menu
- removed open_link method from storage model

modules/storages/app/common/storages/peripherals/storage_interaction/nextcloud.rb

@@ -43,7 +43,8 @@ module Nextcloud
             register(:propfind, Internal::PropfindQuery)
             register(:group_users, GroupUsersQuery)
             register(:upload_link, UploadLinkQuery)
-            register(:open_link, OpenLinkQuery)
+            register(:open_file_link, OpenFileLinkQuery)
+            register(:open_storage, OpenStorageQuery)
           end
         end
 

modules/storages/app/common/storages/peripherals/storage_interaction/nextcloud/open_link_query.rb → modules/storages/app/common/storages/peripherals/storage_interaction/nextcloud/open_file_link_query.rb

@@ -32,7 +32,7 @@ module Storages
   module Peripherals
     module StorageInteraction
       module Nextcloud
-        class OpenLinkQuery
+        class OpenFileLinkQuery
           def initialize(storage)
             @uri = storage.uri
           end

modules/storages/app/common/storages/peripherals/storage_interaction/nextcloud/open_storage_query.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) 2012-2023 the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2013 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+
+module Storages
+  module Peripherals
+    module StorageInteraction
+      module Nextcloud
+        class OpenStorageQuery
+          def initialize(storage)
+            @uri = storage.uri
+          end
+
+          def self.call(storage:, user:)
+            new(storage).call(user:)
+          end
+
+          # rubocop:disable Lint/UnusedMethodArgument
+          def call(user:)
+            ServiceResult.success(result: File.join(@uri.to_s, 'index.php/apps/files'))
+          end
+
+          # rubocop:enable Lint/UnusedMethodArgument
+        end
+      end
+    end
+  end
+end

modules/storages/app/common/storages/peripherals/storage_interaction/one_drive.rb

@@ -38,8 +38,8 @@ module OneDrive
             register(:files, FilesQuery)
             register(:file_info, FileInfoQuery)
             register(:files_info, FilesInfoQuery)
-            register(:open_link, OpenLinkQuery)
-            register(:open_drive_link, OpenDriveLinkQuery)
+            register(:open_file_link, OpenFileLinkQuery)
+            register(:open_storage, OpenStorageQuery)
             register(:upload_link, UploadLinkQuery)
           end
         end

modules/storages/app/common/storages/peripherals/storage_interaction/one_drive/files_info_query.rb

@@ -33,8 +33,6 @@ module Peripherals
     module StorageInteraction
       module OneDrive
         class FilesInfoQuery
-          include StorageErrorHelper
-
           using ServiceResultRefinements
 
           def self.call(storage:, user:, file_ids: [])

modules/storages/app/common/storages/peripherals/storage_interaction/one_drive/open_link_query.rb → modules/storages/app/common/storages/peripherals/storage_interaction/one_drive/open_file_link_query.rb

@@ -32,7 +32,7 @@ module Storages
   module Peripherals
     module StorageInteraction
       module OneDrive
-        class OpenLinkQuery
+        class OpenFileLinkQuery
           using ::Storages::Peripherals::ServiceResultRefinements
 
           def self.call(storage:, user:, file_id:, open_location: false)

modules/storages/app/common/storages/peripherals/storage_interaction/one_drive/open_drive_link_query.rb → modules/storages/app/common/storages/peripherals/storage_interaction/one_drive/open_storage_query.rb

@@ -32,7 +32,7 @@ module Storages
   module Peripherals
     module StorageInteraction
       module OneDrive
-        class OpenDriveLinkQuery
+        class OpenStorageQuery
           def self.call(storage:, user:)
             new(storage).call(user:)
           end
@@ -44,13 +44,13 @@ def initialize(storage)
 
           def call(user:)
             Util.using_user_token(@storage, user) do |token|
-              make_request(token).map(&web_url)
+              request_drive(token).map(&web_url)
             end
           end
 
           private
 
-          def make_request(token)
+          def request_drive(token)
             response_data = Net::HTTP.start(@uri.host, @uri.port, use_ssl: true) do |http|
               http.get(drive_uri_path, { 'Authorization' => "Bearer #{token.access_token}" })
             end
@@ -60,22 +60,23 @@ def make_request(token)
 
           def handle_responses(response)
             json = MultiJson.load(response.body, symbolize_keys: true)
+            error_data = ::Storages::StorageErrorData.new(source: self, payload: json)
 
             case response
             when Net::HTTPSuccess
               ServiceResult.success(result: json)
             when Net::HTTPNotFound
               ServiceResult.failure(result: :not_found,
-                                    errors: ::Storages::StorageError.new(code: :not_found, data: json))
+                                    errors: ::Storages::StorageError.new(code: :not_found, data: error_data))
             when Net::HTTPForbidden
               ServiceResult.failure(result: :forbidden,
-                                    errors: ::Storages::StorageError.new(code: :forbidden, data: json))
+                                    errors: ::Storages::StorageError.new(code: :forbidden, data: error_data))
             when Net::HTTPUnauthorized
               ServiceResult.failure(result: :unauthorized,
-                                    errors: ::Storages::StorageError.new(code: :unauthorized, data: json))
+                                    errors: ::Storages::StorageError.new(code: :unauthorized, data: error_data))
             else
               ServiceResult.failure(result: :error,
-                                    errors: ::Storages::StorageError.new(code: :error, data: json))
+                                    errors: ::Storages::StorageError.new(code: :error, data: error_data))
             end
           end
 

modules/storages/app/models/storages/nextcloud_storage.rb

@@ -60,10 +60,6 @@ def oauth_configuration
       Peripherals::OAuthConfigurations::NextcloudConfiguration.new(self)
     end
 
-    def open_link
-      File.join(uri.to_s, 'index.php/apps/files')
-    end
-
     def automatic_management_unspecified?
       automatically_managed.nil?
     end

modules/storages/app/models/storages/one_drive_storage.rb

@@ -50,14 +50,5 @@ def uri
     def connect_src
       %w[https://*.sharepoint.com https://*.up.1drv.com]
     end
-
-    def open_link
-      ::Storages::Peripherals::Registry.resolve("queries.one_drive.open_drive_link")
-                                       .call(storage: self, user: User.current)
-                                       .match(
-                                         on_success: ->(web_url) { web_url },
-                                         on_failure: ->(*) { '' }
-                                       )
-    end
   end
 end

modules/storages/app/models/storages/project_storage.rb

@@ -64,19 +64,6 @@ def file_inside_project_folder?(escaped_file_path)
     escaped_file_path.match?(%r|^/#{project_folder_path_escaped}|)
   end
 
-  def open_link
-    if project_folder_inactive?
-      storage.open_link
-    else
-      call = ::Storages::Peripherals::Registry.resolve("queries.#{storage.short_provider_type}.open_link")
-                                              .call(storage:, user: User.current, file_id: project_folder_id)
-      call.match(
-        on_success: ->(url) { url },
-        on_failure: ->(*) { storage.open_link }
-      )
-    end
-  end
-
   private
 
   def escape_path(path)

modules/storages/app/models/storages/storage.rb

@@ -116,10 +116,6 @@ def connect_src
       ["#{uri.scheme}://#{uri.host}"]
     end
 
-    def open_link
-      raise Errors::SubclassResponsibility
-    end
-
     def oauth_configuration
       raise Errors::SubclassResponsibility
     end

modules/storages/lib/api/v3/file_links/file_links_open_api.rb

@@ -27,12 +27,14 @@
 #++
 
 class API::V3::FileLinks::FileLinksOpenAPI < API::OpenProjectAPI
+  helpers Storages::Peripherals::StorageErrorHelper
+
   using Storages::Peripherals::ServiceResultRefinements
 
   resources :open do
     get do
       Storages::Peripherals::Registry
-        .resolve("queries.#{@file_link.storage.short_provider_type}.open_link")
+        .resolve("queries.#{@file_link.storage.short_provider_type}.open_file_link")
         .call(
           storage: @file_link.storage,
           user: current_user,

modules/storages/lib/api/v3/project_storages/project_storage_open_api.rb

@@ -0,0 +1,62 @@
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) 2012-2023 the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2013 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+
+class API::V3::ProjectStorages::ProjectStorageOpenAPI < API::OpenProjectAPI
+  helpers Storages::Peripherals::StorageErrorHelper
+
+  using Storages::Peripherals::ServiceResultRefinements
+
+  resources :open do
+    get do
+      query_result = if @project_storage.project_folder_inactive?
+                       Storages::Peripherals::Registry
+                         .resolve("queries.#{@project_storage.storage.short_provider_type}.open_storage")
+                         .call(
+                           storage: @project_storage.storage,
+                           user: current_user
+                         )
+                     else
+                       Storages::Peripherals::Registry
+                         .resolve("queries.#{@project_storage.storage.short_provider_type}.open_file_link")
+                         .call(
+                           storage: @project_storage.storage,
+                           user: current_user,
+                           file_id: @project_storage.project_folder_id
+                         )
+                     end
+
+      query_result.match(
+        on_success: ->(url) do
+          redirect url, body: "The requested resource can be viewed at #{url}"
+          status 303
+        end,
+        on_failure: ->(error) { raise_error(error) }
+      )
+    end
+  end
+end

modules/storages/lib/api/v3/project_storages/project_storage_representer.rb

@@ -46,6 +46,10 @@ class ProjectStorageRepresenter < ::API::Decorators::Single
       { href: api_v3_paths.storage_file(represented.storage.id, represented.project_folder_id) }
     end
 
+    link :open do
+      { href: api_v3_paths.project_storage_open(represented.id) }
+    end
+
     associated_resource :storage, skip_render: ->(*) { true }, skip_link: ->(*) { false }
     associated_resource :project, skip_render: ->(*) { true }, skip_link: ->(*) { false }
     associated_resource :creator,

modules/storages/lib/api/v3/project_storages/project_storages_api.rb

@@ -63,6 +63,8 @@ class ProjectStoragesAPI < API::OpenProjectAPI
         end
 
         get &API::V3::Utilities::Endpoints::Show.new(model: Storages::ProjectStorage).mount
+
+        mount API::V3::ProjectStorages::ProjectStorageOpenAPI
       end
     end
   end

modules/storages/lib/api/v3/storages/storage_open_api.rb

@@ -0,0 +1,48 @@
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) 2012-2023 the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2013 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+
+class API::V3::Storages::StorageOpenAPI < API::OpenProjectAPI
+  helpers Storages::Peripherals::StorageErrorHelper
+
+  using Storages::Peripherals::ServiceResultRefinements
+
+  resources :open do
+    get do
+      Storages::Peripherals::Registry
+        .resolve("queries.#{@storage.short_provider_type}.open_storage")
+        .call(storage: @storage, user: current_user, file_id: nil)
+        .match(
+          on_success: ->(url) do
+            redirect url, body: "The requested resource can be viewed at #{url}"
+            status 303
+          end,
+          on_failure: ->(error) { raise_error(error) }
+        )
+    end
+  end
+end

modules/storages/lib/api/v3/storages/storage_representer.rb

@@ -151,7 +151,7 @@ def initialize(model, current_user:, embed_links: nil)
     end
 
     link :open do
-      { href: represented.open_link }
+      { href: api_v3_paths.storage_open(represented.id) }
     end
 
     link :authorizationState do

modules/storages/lib/api/v3/storages/storages_api.rb

@@ -49,6 +49,7 @@ class API::V3::Storages::StoragesAPI < API::OpenProjectAPI
 
       mount API::V3::StorageFiles::StorageFilesAPI
       mount API::V3::OAuthClient::OAuthClientCredentialsAPI
+      mount API::V3::Storages::StorageOpenAPI
     end
   end
 end