snakemake / snakemake-storage-plugin-gcs

A Snakemake storage plugin for Google Cloud Storage
MIT License
4 stars 5 forks source link

fix!: expect correct google cloud storage abbreviation in query scheme (gcs://) #39

Closed johanneskoester closed 5 months ago

johanneskoester commented 5 months ago

I am sorry for the breaking change. This is unavoidable unfortunately, in order to have a consistent experience. GCS seems to be the official abbreviation of google cloud storage.

jairav commented 1 month ago

Just following up on this @johanneskoester - has this change been tested on a bucket? As far as I'm seeing this change breaks the plugin due to the gcs:// prefix not being correct. In all of Google's cloud storage documentation, the query string is gs:// example. I have left issue #18 open as I am unable to use the plugin unless I use my own fork of it (which uses gs://).

johanneskoester commented 1 month ago

We changed the scheme to gcs:// because that is consistent with the plugin name (snakemake-storage-plugin-gcs). At the time of naming, I had the impression that the abbreviation gcs is more commonly used than gs (and also more specific).

The plugin does not use gcs:// as a prefix for any query internally, it just takes that as a user input and infers bucket and key and from the url. Hence, I cannot see how the prefix change could cause problems. The only thing I can imagine is that it does not work to copy-pasted back an forth with google tools that eventually expect gs://? Or do you have a concrete example of what does not work for me?

johanneskoester commented 1 month ago

Thinking about it, it does not hurt to support both while internally normalizing to gs:// so that even passing on to google tools should always work as expected. Does that help? https://github.com/snakemake/snakemake-storage-plugin-gcs/pull/52

jairav commented 1 month ago

@johanneskoester This will be incredibly helpful, yes. Thank you!

johanneskoester commented 1 month ago

Ok, released! Thank you!