Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
c58b005
Client layer: rebase advertised links, refuse redirects, add the call…
tilorspace Sep 21, 2026
2efa464
Add an offline mock of the RSpace ELN and Inventory APIs for the test…
tilorspace Sep 21, 2026
7e02998
Seed the fsspec implementation branch with the framework-neutral part…
tilorspace Oct 6, 2026
4ae9407
Spike: run inside a Galaxy 25.1 container alongside the shipped RSpac…
tilorspace Oct 6, 2026
f8b80d0
Spike: fall back to created for mtime so Galaxy shows a date for RSpa…
tilorspace Oct 6, 2026
1c156de
Design record: why the listing rules matter for Galaxy, and the glob …
tilorspace Oct 6, 2026
ef2dc3b
Build the unified RSpace filesystem on fsspec
tilorspace Oct 6, 2026
4ec7320
Review pass over rspace_client.fs: five fixes with regression tests
tilorspace Oct 7, 2026
e0dc2d9
put_file creates the directory fsspec hands it during a recursive put
tilorspace Oct 7, 2026
b3268b6
URL-derived paths lose host and query; a 500 with a server message is…
tilorspace Oct 7, 2026
5248b3e
Merge remote-tracking branch 'origin/main' into feature/fsspec-filesy…
tilorspace Oct 7, 2026
ccb9cad
Simplify the fsspec filesystem package after review
tilorspace Oct 7, 2026
138e0c8
Uploads accept file objects that only forward read; pin Galaxy's plug…
tilorspace Oct 9, 2026
640f079
Register rspace as an fsspec.specs entry point
tilorspace Oct 9, 2026
40af244
Design record describes the fsspec filesystem
tilorspace Oct 9, 2026
f53deb6
Merge main into fs-stack/1-client-layer
tilorspace Oct 9, 2026
7ca0d3f
Merge fs-stack/1-client-layer into fs-stack/2-mock-server
tilorspace Oct 9, 2026
9c0b9e0
Merge fs-stack/2-mock-server into feature/fsspec-filesystem
tilorspace Oct 9, 2026
1b6268f
Design record: drop the rspace_client.inv.fs shim it no longer describes
tilorspace Oct 9, 2026
40ae8ef
Rebase advertised links onto the configured base path, not just the host
tilorspace Oct 12, 2026
8223739
Unit tests for the client methods the filesystems added or changed
tilorspace Oct 12, 2026
638a685
Merge fs-stack/1-client-layer into fs-stack/2-mock-server
tilorspace Oct 12, 2026
cedaa5f
Merge fs-stack/2-mock-server into feature/fsspec-filesystem
tilorspace Oct 12, 2026
631051a
Add an offline mock of the RSpace ELN and Inventory APIs for the test…
tilorspace Sep 21, 2026
e3b6498
Merge fs-stack/2-mock-server into feature/fsspec-filesystem
tilorspace Oct 12, 2026
00cd7c5
Merge main into feature/fsspec-filesystem
tilorspace Oct 12, 2026
43b8bcf
Run the Link-field integration tests without an opt-in
tilorspace Oct 12, 2026
abf34b2
Give Galaxy a created date it can parse on Python 3.10
tilorspace Oct 12, 2026
adc40d5
Integration tests create the sample they attach files to
tilorspace Oct 12, 2026
bf6c231
Guard the fsspec listings against a mis-recognised Gallery root and b…
tilorspace Oct 28, 2026
3a97cdc
Accept a star at either end of a Galaxy search query
tilorspace Oct 28, 2026
3793ec7
Fix three fsspec bugs found by exploratory e2e testing
tilorspace Oct 28, 2026
691b534
Document that writes do not create missing folders
tilorspace Oct 28, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,46 @@ All notable changes to this project will be documented in this file

## 2.8.0 (unreleased)

- New `rspace_client.fs`: RSpace as an [fsspec](https://filesystem-spec.readthedocs.io)
filesystem. `RSpaceFilesystem` mounts `gallery/`, `inventory/` and `workspace/` (Gallery
folders and files; Inventory benches, containers, samples, subsamples, templates and
instruments as folders of their records and attachments, attachment fields as one-file
folders; ELN folders, notebooks and documents, a document as a folder of its text fields
and a field as a folder of its linked files). Paths are record names; duplicate names
and names that read as addresses carry their global ID (`data [GL112].csv`);
`path_style="labelled"` / `"id"` for stable paths. Read-only by default (`writable=True`,
`allow_delete=True`). Uploads into Inventory and the Workspace go through the Gallery and
link; `cp_file` from any Gallery-backed file links instead of copying bytes. Transactions
defer uploads. `rspace://host` URLs via `fsspec.open`, `fsspec.filesystem("rspace")` and
`UPath` (registered as an `fsspec.specs` entry point), key from `RSPACE_API_KEY` only. `glob("<dir>/*<text>*")` answers Galaxy's search
including bracketed names. New dependency `fsspec`. Listings recognise the Gallery root by its `GF`
id, and refuse a page without its records or a `next` link that loops. A search typed as `*.csv` or
`data*` works through Galaxy's search box instead of failing on the `**` it produces.
Linking or copying into an occupied Inventory attachment field is refused like an upload,
instead of replacing its file. Field edits in the Workspace take a per-document lock and are
read back and re-applied when another writer overwrote them, so concurrent uploads into one
field no longer drop links (writers in separate processes can still race; the API has no
atomic append). A file segment written as a global ID only resolves under the field, record or
Gallery folder that really holds it, and a missing one is `FileNotFoundError`.
- An error answered with RSpace's HTML error page is reported by the page's title instead of
the whole page.
- Deprecated `rspace_client.eln.fs.GalleryFilesystem` and
`rspace_client.inv.attachment_fs.InventoryAttachmentFilesystem` (PyFilesystem2, unmaintained
upstream). Unchanged in behaviour apart from the fixes below, now emit a `DeprecationWarning`; removal together with
the `fs` dependency in 3.0, after Galaxy's shipped plugin has moved to `rspace_client.fs`.
- Fix: uploads accept a file object that forwards `read` through `__getattr__`. requests 2.34
refuses such objects on Python 3.12+, which broke exports from Galaxy 26.1 (it pins requests
2.34.2) to RSpace through Galaxy's shipped `rspace` file source.
- Fix: `GalleryFilesystem` reports a file's `created` date as `+00:00` instead of RSpace's
trailing `Z` (the same UTC instant). Galaxy's shipped `rspace` file source parses it with
`datetime.fromisoformat`, which rejects `Z` before Python 3.11, so on Python 3.10 Galaxy
failed to list any Gallery folder holding files.
- `rspace_client/tests/galaxy_plugin_contract_test.py` pins what Galaxy's shipped plugin relies
on; a failure there is a release blocker.
- Tests: the Link-field integration tests always run instead of needing
`RSPACE_SUPPORTS_LINK_FIELDS=1`; current RSpace releases support Link fields.
- `tools/galaxy/rspace_fsspec_source.py`: the reference Galaxy file source for the new
filesystem, to be proposed upstream.
- Security: the client never follows an HTTP redirect, since `requests` would carry the
`apiKey` header to the new host.
- Client-level changes: `_links` URLs are rebased onto the configured base URL, path prefix
Expand Down
4 changes: 4 additions & 0 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ All top-level methods for use by client code should be unit-tested.

RSpace can be run on Docker on a developer machine, providing access to a sandbox environment.

#### Galaxy's RSpace file source

Galaxy ships an `rspace` file source built on this library's deprecated `rspace_client.eln.fs.GalleryFilesystem`, so changes here can break Galaxy. `rspace_client/tests/galaxy_plugin_contract_test.py` pins what it relies on and runs with the normal suite; a failure there is a release blocker. [tools/galaxy/README.md](tools/galaxy/README.md) shows how to drive Galaxy's real plugin without a Galaxy server, and how to try the fsspec file source proposed for Galaxy. Why the contract looks the way it does is in [docs/fsspec-filesystem-design.md](docs/fsspec-filesystem-design.md), section 8.


### Making a release

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Full REST API reference is served by your own RSpace instance at `https://<YOUR_
| Inventory: samples, subsamples, containers | Create and manage samples, split/duplicate subsamples, organise items into containers |
| Instruments & Instrument Templates *(new in 2.7.0, RSpace 2.24)* | Create, update, and manage Inventory instruments and instrument templates |
| Export | Async export of a user's or group's work (or specific documents/notebooks/folders) to HTML or XML, with progress polling |
| PyFilesystem access | `GalleryFilesystem` and `InventoryAttachmentFilesystem` implement the [PyFilesystem](https://docs.pyfilesystem.org/en/latest/index.html) API for Gallery files and Inventory attachments |
| Filesystem access (fsspec) | `rspace_client.fs.RSpaceFilesystem` presents the Gallery, Inventory and Workspace as one [fsspec](https://filesystem-spec.readthedocs.io) filesystem (`rspace://` URLs, `UPath`, Galaxy); the PyFilesystem `GalleryFilesystem` and `InventoryAttachmentFilesystem` are deprecated |
| Notebook / Jupyter / R interop (`notebook_sync`) | Helpers for round-tripping data between RSpace notebook entries and Jupyter or R workflows |
| Activity / audit trail | Query "who did what, when" for a record or across a date range |
| Forms | Create, publish, share, and list custom forms; create documents from them |
Expand Down
Loading
Loading