Let file sources choose a path for uploaded files

The method `write_from()` of `SingleFileSource` and `BaseFilesSource` reads a local file from `native_path` and saves it to `target_path` on a file source.

This commit allows the service backing the file source to choose which will be the path of the saved file, meaning that `target_path` and the actual path where the file can be recovered later do not have to match. The latter is the return value of `write_from()`.

Therefore, all usages of `write_from()` have also been refactored to consider the paths chosen by the file source's backing service. In addition, when exporting a history, the URI that the service backing the file source assigns to it will be saved to the history export result metadata object.

lib/galaxy/files/sources/__init__.py

@@ -220,7 +220,7 @@ def write_from(
         native_path: str,
         user_context: "OptionalUserContext" = None,
         opts: Optional[FilesSourceOptions] = None,
-    ):
+    ) -> str:
         """Write file at native path to target_path (relative to uri root).
 
         :param target_path: url of the target file to write to within the filesource. e.g. `gxfiles://myftp1/myfile.txt`
@@ -231,6 +231,9 @@ def write_from(
         :type user_context: _type_, optional
         :param opts: A set of options to exercise additional control over the write_from method. Filesource specific, defaults to None
         :type opts: Optional[FilesSourceOptions], optional
+        :return: Actual url of the written file, fixed by the service backing the FileSource. May differ from the target
+            path.
+        :rtype: str
         """
 
     @abc.abstractmethod
@@ -504,10 +507,10 @@ def write_from(
         native_path: str,
         user_context: "OptionalUserContext" = None,
         opts: Optional[FilesSourceOptions] = None,
-    ):
+    ) -> str:
         self._ensure_writeable()
         self._check_user_access(user_context)
-        self._write_from(target_path, native_path, user_context=user_context, opts=opts)
+        return self._write_from(target_path, native_path, user_context=user_context, opts=opts)
 
     @abc.abstractmethod
     def _write_from(
@@ -516,7 +519,7 @@ def _write_from(
         native_path: str,
         user_context: "OptionalUserContext" = None,
         opts: Optional[FilesSourceOptions] = None,
-    ):
+    ) -> str:
         pass
 
     def realize_to(

lib/galaxy/files/sources/_pyfilesystem2.py

@@ -116,13 +116,14 @@ def _write_from(
         native_path: str,
         user_context: OptionalUserContext = None,
         opts: Optional[FilesSourceOptions] = None,
-    ):
+    ) -> str:
         with open(native_path, "rb") as read_file:
             openfs = self._open_fs(user_context=user_context, opts=opts)
             dirname = fs.path.dirname(target_path)
             if not openfs.isdir(dirname):
                 openfs.makedirs(dirname)
             openfs.upload(target_path, read_file)
+        return target_path
 
     def _resource_info_to_dict(self, dir_path, resource_info) -> AnyRemoteEntry:
         name = resource_info.name

lib/galaxy/files/sources/base64.py

@@ -47,7 +47,7 @@ def _write_from(
         native_path: str,
         user_context: OptionalUserContext = None,
         opts: Optional[FilesSourceOptions] = None,
-    ):
+    ) -> str:
         raise NotImplementedError()
 
     def score_url_match(self, url: str):

lib/galaxy/files/sources/drs.py

@@ -73,7 +73,7 @@ def _write_from(
         native_path: str,
         user_context: OptionalUserContext = None,
         opts: Optional[FilesSourceOptions] = None,
-    ):
+    ) -> str:
         raise NotImplementedError()
 
     def score_url_match(self, url: str):

lib/galaxy/files/sources/ftp.py

@@ -60,7 +60,7 @@ def _write_from(
         native_path: str,
         user_context: OptionalUserContext = None,
         opts: Optional[FilesSourceOptions] = None,
-    ):
+    ) -> str:
         extra_props: FTPFilesSourceProperties
         if opts and opts.extra_props:
             extra_props = cast(FTPFilesSourceProperties, opts.extra_props)
@@ -69,6 +69,7 @@ def _write_from(
             extra_props = {}
         path, opts.extra_props = self._get_props_and_rel_path(extra_props, target_path)
         super()._write_from(path, native_path, user_context=user_context, opts=opts)
+        return target_path
 
     def _get_props_and_rel_path(
         self, extra_props: FTPFilesSourceProperties, url: str

lib/galaxy/files/sources/http.py

@@ -83,7 +83,7 @@ def _write_from(
         native_path: str,
         user_context: OptionalUserContext = None,
         opts: Optional[FilesSourceOptions] = None,
-    ):
+    ) -> str:
         raise NotImplementedError()
 
     def _serialization_props(self, user_context: OptionalUserContext = None) -> HTTPFilesSourceProperties:

lib/galaxy/files/sources/invenio.py

@@ -201,9 +201,10 @@ def _write_from(
         native_path: str,
         user_context: OptionalUserContext = None,
         opts: Optional[FilesSourceOptions] = None,
-    ):
+    ) -> str:
         record_id, filename = self.parse_path(target_path)
         self.repository.upload_file_to_draft_record(record_id, filename, native_path, user_context=user_context)
+        return target_path
 
 
 class InvenioRepositoryInteractor(RDMRepositoryInteractor):

lib/galaxy/files/sources/posix.py

@@ -114,7 +114,7 @@ def _write_from(
         native_path: str,
         user_context: OptionalUserContext = None,
         opts: Optional[FilesSourceOptions] = None,
-    ):
+    ) -> str:
         effective_root = self._effective_root(user_context)
         target_native_path = self._to_native_path(target_path, user_context=user_context)
         if self.enforce_symlink_security:
@@ -136,6 +136,7 @@ def _write_from(
         target_native_path_part = os.path.join(target_native_path_parent, f"_{target_native_path_name}.part")
         shutil.copyfile(native_path, target_native_path_part)
         os.rename(target_native_path_part, target_native_path)
+        return target_path
 
     def _to_native_path(self, source_path: str, user_context: OptionalUserContext = None):
         source_path = os.path.normpath(source_path)

lib/galaxy/files/sources/s3fs.py

@@ -104,12 +104,13 @@ def _write_from(
         native_path,
         user_context: OptionalUserContext = None,
         opts: Optional[FilesSourceOptions] = None,
-    ):
+    ) -> str:
         _props = self._serialization_props(user_context)
         _bucket_name = _props.pop("bucket", "")
         fs = self._open_fs(props=_props, opts=opts)
         bucket_path = self._bucket_path(_bucket_name, target_path)
         fs.upload(native_path, bucket_path)
+        return target_path
 
     def _bucket_path(self, bucket_name: str, path: str):
         if path.startswith("s3://"):

lib/galaxy/managers/model_stores.py

@@ -214,21 +214,29 @@ def write_history_to(self, request: WriteHistoryTo):
         export_files = "symlink" if request.include_files else None
         target_uri = request.target_uri
         user_context = self._build_user_context(request.user.user_id)
-        export_metadata = self.set_history_export_request_metadata(request)
+
+        exception_exporting_history: Optional[Exception] = None
         try:
-            with model.store.get_export_store_factory(
+            export_store = model.store.get_export_store_factory(
                 self._app, model_store_format, export_files=export_files, user_context=user_context
-            )(target_uri) as export_store:
+            )(target_uri)
+            with export_store:
                 history = self._history_manager.by_id(request.history_id)
                 export_store.export_history(
                     history, include_hidden=request.include_hidden, include_deleted=request.include_deleted
                 )
-                self.set_history_export_result_metadata(request.export_association_id, export_metadata, success=True)
+            request.target_uri = str(export_store.file_source_uri) or request.target_uri
         except Exception as e:
+            exception_exporting_history = e
+            raise
+        finally:
+            export_metadata = self.set_history_export_request_metadata(request)
             self.set_history_export_result_metadata(
-                request.export_association_id, export_metadata, success=False, error=str(e)
+                request.export_association_id,
+                export_metadata,
+                success=not bool(exception_exporting_history),
+                error=str(exception_exporting_history) if exception_exporting_history else None,
             )
-            raise
 
     def set_history_export_request_metadata(
         self, request: Union[WriteHistoryTo, GenerateHistoryDownload]

lib/galaxy/model/store/__init__.py

@@ -2601,6 +2601,8 @@ class BcoExportOptions:
 
 
 class BcoModelExportStore(WorkflowInvocationOnlyExportStore):
+    file_source_uri: Optional[StrPath] = None
+
     def __init__(self, uri, export_options: BcoExportOptions, **kwds):
         temp_output_dir = tempfile.mkdtemp()
         self.temp_output_dir = temp_output_dir
@@ -2623,7 +2625,9 @@ def _finalize(self):
             file_source_path = self.file_sources.get_file_source_path(self.file_source_uri)
             file_source = file_source_path.file_source
             assert os.path.exists(self.out_file)
-            file_source.write_from(file_source_path.path, self.out_file, user_context=self.user_context)
+            self.file_source_uri = file_source.write_from(
+                file_source_path.path, self.out_file, user_context=self.user_context
+            )
 
     def _core_biocompute_object_and_object_id(self) -> Tuple[BioComputeObjectCore, str]:
         assert self.app  # need app.security to do anything...
@@ -2814,7 +2818,7 @@ def _finalize(self) -> None:
 
 
 class ROCrateArchiveModelExportStore(DirectoryModelExportStore, WriteCrates):
-    file_source_uri: Optional[StrPath]
+    file_source_uri: Optional[StrPath] = None
     out_file: StrPath
 
     def __init__(self, uri: StrPath, **kwds) -> None:
@@ -2848,12 +2852,12 @@ def _finalize(self) -> None:
             file_source_path = self.file_sources.get_file_source_path(self.file_source_uri)
             file_source = file_source_path.file_source
             assert os.path.exists(rval), rval
-            file_source.write_from(file_source_path.path, rval, user_context=self.user_context)
+            self.file_source_uri = file_source.write_from(file_source_path.path, rval, user_context=self.user_context)
         shutil.rmtree(self.temp_output_dir)
 
 
 class TarModelExportStore(DirectoryModelExportStore):
-    file_source_uri: Optional[StrPath]
+    file_source_uri: Optional[StrPath] = None
     out_file: StrPath
 
     def __init__(self, uri: StrPath, gzip: bool = True, **kwds) -> None:
@@ -2879,7 +2883,9 @@ def _finalize(self) -> None:
             file_source_path = self.file_sources.get_file_source_path(self.file_source_uri)
             file_source = file_source_path.file_source
             assert os.path.exists(self.out_file)
-            file_source.write_from(file_source_path.path, self.out_file, user_context=self.user_context)
+            self.file_source_uri = file_source.write_from(
+                file_source_path.path, self.out_file, user_context=self.user_context
+            )
         shutil.rmtree(self.temp_output_dir)
 
 
@@ -2894,7 +2900,7 @@ def _finalize(self) -> None:
 
 
 class BagArchiveModelExportStore(BagDirectoryModelExportStore):
-    file_source_uri: Optional[StrPath]
+    file_source_uri: Optional[StrPath] = None
 
     def __init__(self, uri: StrPath, bag_archiver: str = "tgz", **kwds) -> None:
         # bag_archiver in tgz, zip, tar
@@ -2922,7 +2928,7 @@ def _finalize(self) -> None:
             file_source_path = self.file_sources.get_file_source_path(self.file_source_uri)
             file_source = file_source_path.file_source
             assert os.path.exists(rval)
-            file_source.write_from(file_source_path.path, rval, user_context=self.user_context)
+            self.file_source_uri = file_source.write_from(file_source_path.path, rval, user_context=self.user_context)
         shutil.rmtree(self.temp_output_dir)
 
 
@@ -2932,13 +2938,21 @@ def get_export_store_factory(
     export_files=None,
     bco_export_options: Optional[BcoExportOptions] = None,
     user_context=None,
-) -> Callable[[StrPath], ModelExportStore]:
-    export_store_class: Union[
-        Type[TarModelExportStore],
-        Type[BagArchiveModelExportStore],
-        Type[ROCrateArchiveModelExportStore],
-        Type[BcoModelExportStore],
-    ]
+) -> Callable[
+    [StrPath],
+    Union[
+        TarModelExportStore,
+        BagArchiveModelExportStore,
+        ROCrateArchiveModelExportStore,
+        BcoModelExportStore,
+    ],
+]:
+    export_store_class: Type[Union[
+        TarModelExportStore,
+        BagArchiveModelExportStore,
+        ROCrateArchiveModelExportStore,
+        BcoModelExportStore,
+    ]]
     export_store_class_kwds = {
         "app": app,
         "export_files": export_files,

lib/galaxy/tools/imp_exp/export_history.py

@@ -56,16 +56,18 @@ def main(argv=None):
     # Create archive.
     exit = create_archive(temp_directory, out_file, gzip=gzip)
     if destination_uri is not None and exit == 0:
-        _write_to_destination(options.file_sources, os.path.abspath(out_file), destination_uri)
+        actual_uri = _write_to_destination(options.file_sources, os.path.abspath(out_file), destination_uri)
+        if destination_uri != actual_uri:
+            print(f"Saved history archive to {actual_uri}.")
     return exit
 
 
-def _write_to_destination(file_sources_path: str, out_file: str, destination_uri: str):
+def _write_to_destination(file_sources_path: str, out_file: str, destination_uri: str) -> str:
     file_sources = get_file_sources(file_sources_path)
     file_source_path = file_sources.get_file_source_path(destination_uri)
     file_source = file_source_path.file_source
     assert os.path.exists(out_file)
-    file_source.write_from(file_source_path.path, out_file)
+    return file_source.write_from(file_source_path.path, out_file)
 
 
 def get_file_sources(file_sources_path: str) -> ConfiguredFileSources:

test/unit/app/managers/test_user_file_sources.py

@@ -215,9 +215,10 @@ def test_io(self, tmp_path):
 
         temp_file = tmp_path / "tmp_file"
         temp_file.write_text("Moo Cow", "utf-8")
-        file_source.write_from("/moo", str(temp_file))
+        actual_path = file_source.write_from("/moo", str(temp_file))
         target = tmp_path / "round_trip"
         file_source.realize_to("/moo", target)
+        assert "/moo" == actual_path
         assert target.read_text("utf-8") == "Moo Cow"
 
     def test_to_dict_filters_hidden(self, tmp_path):
@@ -271,7 +272,8 @@ def test_environment_injection(self, tmp_path):
 
         temp_file = tmp_path / "tmp_file"
         temp_file.write_text("Moo Cow", "utf-8")
-        file_source.write_from("/moo", str(temp_file))
+        actual_path = file_source.write_from("/moo", str(temp_file))
+        assert "/moo" == actual_path
         assert expected_target.exists()
         assert (expected_target / "moo").exists()
 
@@ -289,7 +291,8 @@ def test_environment_defaults(self, tmp_path):
 
         temp_file = tmp_path / "tmp_file"
         temp_file.write_text("Moo Cow", "utf-8")
-        file_source.write_from("/moo", str(temp_file))
+        actual_path = file_source.write_from("/moo", str(temp_file))
+        assert "/moo" == actual_path
         assert expected_target.exists()
         assert (expected_target / "moo").exists()
 

test/unit/files/_util.py

@@ -148,12 +148,12 @@ def write_from(
     uri: str,
     content: str,
     user_context: OptionalUserContext = None,
-):
+) -> str:
     file_source_path = file_sources.get_file_source_path(uri)
     with tempfile.NamedTemporaryFile(mode="w") as f:
         f.write(content)
         f.flush()
-        file_source_path.file_source.write_from(file_source_path.path, f.name, user_context=user_context)
+        return file_source_path.file_source.write_from(file_source_path.path, f.name, user_context=user_context)
 
 
 def configured_file_sources(conf_file):
@@ -172,14 +172,14 @@ def assert_can_write_and_read_to_conf(conf: dict):
     file_source_id = conf["id"]
     file_sources = configured_file_sources([conf])
     test_uri = f"gxfiles://{file_source_id}/{test_filename}"
-    write_from(
+    actual_uri = write_from(
         file_sources,
         test_uri,
         test_contents,
     )
     assert_realizes_contains(
         file_sources,
-        test_uri,
+        actual_uri,
         test_contents,
     )