Merge pull request #21427 from opf/implementation/69506-create-a-sharepoint-upload-file-command-on-openproject

[69506] Create a sharepoint upload file command on OpenProject

Author: mereghost

modules/storages/app/common/storages/adapters/providers/sharepoint/commands/upload_file_command.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) 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 Adapters
+    module Providers
+      module Sharepoint
+        module Commands
+          class UploadFileCommand < Base
+            def call(auth_strategy:, input_data:)
+              with_tagged_logger do
+                drive_id, location = get_location(input_data.parent_location)
+                info "Uploading file #{input_data.file_name} to parent location #{input_data.parent_location}"
+                file_content = input_data.io.read
+
+                Authentication[auth_strategy].call(storage: @storage) do |http|
+                  upload_file(http, auth_strategy, drive_id, location, input_data.file_name, file_content)
+                end
+              end
+            end
+
+            private
+
+            def get_location(parent_location)
+              split_identifier(parent_location) => { drive_id:, location: }
+              [drive_id, location]
+            end
+
+            def upload_file(http, auth_strategy, drive_id, location, file_name, file_content)
+              create_upload_session(auth_strategy, drive_id, location, file_name).bind do |upload_url|
+                upload_file_content(http, upload_url, file_content).bind do |upload_response|
+                  info "File successfully uploaded, fetching its file info back..."
+                  fetch_file_info(http, drive_id, upload_response)
+                end
+              end
+            end
+
+            def create_upload_session(auth_strategy, drive_id, location, file_name)
+              upload_link_input = Input::UploadLink.build(
+                folder_id: composite_folder_id(drive_id, location),
+                file_name:
+              ).value_or { |error| return Failure(error) }
+
+              upload_link_query.call(auth_strategy:, input_data: upload_link_input).fmap(&:destination)
+            end
+
+            def upload_file_content(http, upload_url, file_content)
+              file_size = file_content.bytesize
+              content_range_header = file_size.zero? ? "bytes 0-0/0" : "bytes 0-#{file_size - 1}/#{file_size}"
+
+              handle_response(
+                http.put(upload_url, body: file_content, headers: { "Content-Range" => content_range_header })
+              )
+            end
+
+            def fetch_file_info(http, drive_id, upload_response)
+              file_id = upload_response[:id]
+
+              return Failure(Results::Error.new(source: self.class, payload: upload_response, code: :error)) if file_id.blank?
+
+              item_id = Peripherals::ParentFolder.new(file_id)
+              drive_item_query.call(http:, drive_id:, item_id:, fields: Queries::FileInfoQuery::FIELDS)
+                .bind { |json| storage_file_transformer.transform(json) }
+            end
+
+            def composite_folder_id(drive_id, location)
+              item_id = location.root? ? nil : location
+              "#{drive_id}#{SharepointStorage::IDENTIFIER_SEPARATOR}#{item_id}"
+            end
+
+            def handle_response(response)
+              error = Results::Error.new(source: self.class, payload: response)
+
+              case response
+              in { status: 200..299 }
+                Success(response.json(symbolize_keys: true))
+              in { status: 401 }
+                Failure(error.with(code: :unauthorized))
+              in { status: 403 }
+                Failure(error.with(code: :forbidden))
+              in { status: 404 }
+                Failure(error.with(code: :not_found))
+              in { status: 409 }
+                Failure(error.with(code: :conflict))
+              else
+                Failure(error.with(code: :error))
+              end
+            end
+
+            def upload_link_query
+              @upload_link_query ||= Queries::UploadLinkQuery.new(@storage)
+            end
+
+            def drive_item_query
+              @drive_item_query ||= Queries::Internal::DriveItemQuery.new(@storage)
+            end
+
+            def storage_file_transformer
+              @storage_file_transformer ||= StorageFileTransformer.new(site_name)
+            end
+          end
+        end
+      end
+    end
+  end
+end

modules/storages/app/common/storages/adapters/providers/sharepoint/sharepoint_registry.rb

@@ -45,6 +45,7 @@ module Sharepoint
             register(:create_list, Commands::CreateListCommand)
             register(:set_permissions, Commands::SetPermissionsCommand)
             register(:copy_template_folder, Commands::CopyTemplateFolderCommand)
+            register(:upload_file, Commands::UploadFileCommand)
           end
 
           namespace("components") do

modules/storages/spec/common/storages/adapters/providers/sharepoint/commands/create_folder_command_spec.rb

@@ -46,31 +46,35 @@ module Commands
 
             context "when creating a folder in the root", vcr: "sharepoint/create_folder_root" do
               let(:folder_name) { "Földer CreatedBy Çommand" }
-              let(:parent_location) { composite_identifier(nil) }
+              let(:parent_location) { SharepointSpecHelper.composite_identifier(base_drive, nil) }
               let(:path) { "/Marcello%20VCR/F%C3%B6lder%20CreatedBy%20%C3%87ommand" }
 
               it_behaves_like "adapter create_folder_command: successful folder creation"
             end
 
             context "when creating a folder in a parent folder", vcr: "sharepoint/create_folder_parent" do
               let(:folder_name) { "Földer CreatedBy Çommand" }
-              let(:parent_location) { composite_identifier("01ANJ53W7TITEF4WCHRBDKR7VMNUWZ33WD") }
+              let(:parent_location) do
+                SharepointSpecHelper.composite_identifier(base_drive, "01ANJ53W7TITEF4WCHRBDKR7VMNUWZ33WD")
+              end
               let(:path) { "/Marcello%20VCR/Folder%20with%20spaces/F%C3%B6lder%20CreatedBy%20%C3%87ommand" }
 
               it_behaves_like "adapter create_folder_command: successful folder creation"
             end
 
             context "when creating a folder in a non-existing parent folder", vcr: "sharepoint/create_folder_parent_not_found" do
               let(:folder_name) { "Földer CreatedBy Çommand" }
-              let(:parent_location) { composite_identifier("01AZJL5PKU2WV3U3RKKFF4A7ZCWVBXRTEU") }
+              let(:parent_location) do
+                SharepointSpecHelper.composite_identifier(base_drive, "01AZJL5PKU2WV3U3RKKFF4A7ZCWVBXRTEU")
+              end
               let(:error_source) { described_class }
 
               it_behaves_like "storage adapter: error response", :not_found
             end
 
             context "when folder already exists", vcr: "sharepoint/create_folder_already_exists" do
               let(:folder_name) { "data" }
-              let(:parent_location) { composite_identifier(nil) }
+              let(:parent_location) { SharepointSpecHelper.composite_identifier(base_drive, nil) }
               let(:error_source) { described_class }
 
               it_behaves_like "storage adapter: error response", :conflict
@@ -94,8 +98,6 @@ module Commands
 
             private
 
-            def composite_identifier(item_id) = "#{base_drive}#{SharepointStorage::IDENTIFIER_SEPARATOR}#{item_id}"
-
             def delete_created_folder(folder)
               Input::DeleteFolder.build(location: folder.id).bind do |input_data|
                 Registry.resolve("sharepoint.commands.delete_folder").call(storage:, auth_strategy:, input_data:)

modules/storages/spec/common/storages/adapters/providers/sharepoint/commands/delete_folder_command_spec.rb

@@ -53,9 +53,10 @@ module Commands
             end
 
             it "deletes a folder", vcr: "sharepoint/delete_folder" do
-              create_result = Input::CreateFolder
-                                .build(folder_name: "To Be Deleted Soon", parent_location: composite_identifier(nil))
-                                .bind do |input_data|
+              create_result = Input::CreateFolder.build(
+                folder_name: "To Be Deleted Soon",
+                parent_location: SharepointSpecHelper.composite_identifier(base_drive, nil)
+              ).bind do |input_data|
                 Registry.resolve("sharepoint.commands.create_folder").call(storage:, auth_strategy:, input_data:)
               end
 
@@ -67,17 +68,15 @@ module Commands
             end
 
             it "when the folder is not found, returns a failure", vcr: "sharepoint/delete_folder_not_found" do
-              result = Input::DeleteFolder.build(location: composite_identifier("NOT_HERE")).bind do |input_data|
+              result = Input::DeleteFolder.build(
+                location: SharepointSpecHelper.composite_identifier(base_drive, "NOT_HERE")
+              ).bind do |input_data|
                 described_class.call(storage:, auth_strategy:, input_data:)
               end
 
               expect(result).to be_failure
               expect(result.failure.code).to eq(:not_found)
             end
-
-            private
-
-            def composite_identifier(item_id) = "#{base_drive}#{SharepointStorage::IDENTIFIER_SEPARATOR}#{item_id}"
           end
         end
       end

modules/storages/spec/common/storages/adapters/providers/sharepoint/commands/upload_file_command_spec.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) 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.
+#++
+
+require "spec_helper"
+require_module_spec_helper
+
+module Storages
+  module Adapters
+    module Providers
+      module Sharepoint
+        module Commands
+          RSpec.describe UploadFileCommand, :webmock do
+            let(:storage) { create(:sharepoint_storage, :sandbox) }
+            let(:auth_strategy) { Registry["sharepoint.authentication.userless"].call }
+            let(:base_drive) { "b!FeOZEMfQx0eGQKqVBLcP__BG8mq-4-9FuRqOyk3MXY9jo6leJDqrT7muzvmiWjFW" }
+            let(:input_data) { Input::UploadFile.build(parent_location:, file_name:, io:).value! }
+            let(:parent_location) { SharepointSpecHelper.composite_identifier(base_drive, nil) }
+            let(:file_name) { "test-file.txt" }
+            let(:io) { StringIO.new("This is the blueprints of the first Death Star.") }
+
+            it_behaves_like "storage adapter: command call signature", "upload_file"
+
+            context "when uploading a file to the root folder", vcr: "sharepoint/upload_file_root" do
+              it_behaves_like "adapter upload_file_command: successful file upload"
+            end
+
+            context "when uploading a file to a sub-folder", vcr: "sharepoint/upload_file_subfolder" do
+              let(:parent_location) do
+                SharepointSpecHelper.composite_identifier(base_drive, "01ANJ53W5P3SUY3ZCDTRA3KLXRGA5A2M3S")
+              end
+
+              it_behaves_like "adapter upload_file_command: successful file upload"
+            end
+
+            context "when uploading a file to a non-existing folder", vcr: "sharepoint/upload_file_not_found" do
+              let(:parent_location) do
+                SharepointSpecHelper.composite_identifier(base_drive, "01AZJL5PKU2WV3U3RKKFF4A7ZCWVBXRTEU")
+              end
+              let(:error_source) { Adapters::Providers::Sharepoint::Queries::UploadLinkQuery }
+
+              it_behaves_like "storage adapter: error response", :not_found
+            end
+
+            context "when uploading a file that has a filename with non-ASCII characters",
+                    vcr: "sharepoint/upload_file_unicode" do
+              let(:file_name) { "🍑 is not spelled Pfürsich.txt" }
+
+              it_behaves_like "adapter upload_file_command: successful file upload"
+            end
+
+            context "when upload session creation fails", vcr: "sharepoint/upload_file_session_failed" do
+              let(:parent_location) { SharepointSpecHelper.composite_identifier(base_drive, "INVALID_ID") }
+              let(:error_source) { Adapters::Providers::Sharepoint::Queries::UploadLinkQuery }
+
+              it_behaves_like "storage adapter: error response", :not_found
+            end
+
+            context "when file upload fails", vcr: "sharepoint/upload_file_root" do
+              let(:parent_location) { SharepointSpecHelper.composite_identifier(base_drive, nil) }
+              let(:error_source) { described_class }
+
+              before do
+                stub_request(:put, %r{https://.*\.sharepoint\.com/.*/uploadSession})
+                  .with(headers: { "Content-Range" => /bytes \d+-\d+\/\d+/ })
+                  .to_return(
+                    status: 403,
+                    body: { error: { code: "Forbidden", message: "Access denied" } }.to_json,
+                    headers: { "Content-Type" => "application/json" }
+                  )
+              end
+
+              it_behaves_like "storage adapter: error response", :forbidden
+            end
+          end
+        end
+      end
+    end
+  end
+end

modules/storages/spec/spec_helper.rb

@@ -46,6 +46,12 @@
   config.filter_sensitive_data("<ACCESS_TOKEN>") do
     ENV.fetch("NEXTCLOUD_LOCAL_OAUTH_CLIENT_ACCESS_TOKEN", "MISSING_NEXTCLOUD_LOCAL_OAUTH_CLIENT_ACCESS_TOKEN")
   end
+  config.filter_sensitive_data("<SHAREPOINT_CLIENT_SECRET>") do
+    ENV.fetch("SHAREPOINT_TEST_OAUTH_CLIENT_SECRET", "MISSING_SHARE_POINT_TEST_OAUTH_CLIENT_SECRET")
+  end
+  config.filter_sensitive_data("<SHAREPOINT_CLIENT_ID>") do
+    ENV.fetch("SHAREPOINT_TEST_OAUTH_CLIENT_ID", "MISSING_SHARE_POINT_TEST_OAUTH_CLIENT_ID")
+  end
 end
 
 def use_storages_vcr_cassette(name, options = {}, &)