Improve uploadOrUpdate returned data.

[mircea-pavel-anton]

Fixes #9

What is the current behavior?

Currently, the uploadOrUpdate function (so automatically the upload and update functions as well), only returns a Key: value pair that represents the file path prefixed by the bucket id.

This path cannot be then passed to the download method as the download doesn't need the bucket id prefix.

What is the new behavior?

By simply adding 2 more Key: value pairs to the returned data object, we can provide more useful information in the returned object:

{
  Key: the old path, for backwards compatibility
  downloadPath: the path not prefixed by the bucket ID
  bucketId: the id of the bucket
}

By also providing the bucket ID in the returned data, we give users the full set on information required to be able to call download, as I assume that the data returned from upload will then immediately be stored in the database for later use.

By implementing these changes, we enable a workflow similar to this:

const { data, error } = await storageClient.from('bucket').upload('/folder/file.txt', fileBody)
// ...
const { data2, error2 } = await storageClient.from(data.bucketId).download(data.downloadPath)

[alaister]

Thanks again @mirceanton!

What do you think about calling downloadPath just path? A nit, I know, but I think it's a little cleaner :)

Also, if you fancy adding a test or two for file upload & update, that would be greatly appreciated!

[alaister]

Should be data.Key

[mircea-pavel-anton]

nice catch 👍🏻

[mircea-pavel-anton]

Yep, i think simply calling it "path" is good. I will look into tests, sure.

[mircea-pavel-anton]

@alaister sorry I've been inactive for such a long time on this one. I've been rather busy lately. I fixed the mentioned issues, but I don't think I will get around to making some proper tests until this summer (around July perhaps). I've my bachelor degree taking up all of my spare time till then. 😅

[mircea-pavel-anton]

As a side note, something that I noticed is that running npm build fails on the build::umd task with the following output on my machine:

mike@workstation:~/workspace/supabase/storage-js$ npm run build

> @supabase/storage-js@0.0.0 build
> genversion src/lib/version.ts --es6 && run-s clean format build:*


> @supabase/storage-js@0.0.0 clean
> rimraf dist docs


> @supabase/storage-js@0.0.0 format
> prettier --write "{src,test}/**/*.ts"

src/index.ts 153ms
src/lib/constants.ts 10ms
src/lib/fetch.ts 53ms
src/lib/helpers.ts 10ms
src/lib/index.ts 4ms
src/lib/StorageBucketApi.ts 44ms
src/lib/StorageFileApi.ts 92ms
src/lib/types.ts 14ms
src/lib/version.ts 6ms
src/StorageClient.ts 6ms
test/storageApi.test.ts 12ms
test/storageFileApi.test.ts 5ms

> @supabase/storage-js@0.0.0 build:main
> tsc -p tsconfig.json


> @supabase/storage-js@0.0.0 build:module
> tsc -p tsconfig.module.json


> @supabase/storage-js@0.0.0 build:umd
> webpack

/home/mike/workspace/supabase/storage-js/node_modules/loader-runner/lib/LoaderRunner.js:146
                if(isError) throw e;
                            ^

Error: error:0308010C:digital envelope routines::unsupported
    at new Hash (node:internal/crypto/hash:67:19)
    at Object.createHash (node:crypto:135:10)
    at BulkUpdateDecorator.hashFactory (/home/mike/workspace/supabase/storage-js/node_modules/webpack/lib/util/createHash.js:144:18)
    at BulkUpdateDecorator.update (/home/mike/workspace/supabase/storage-js/node_modules/webpack/lib/util/createHash.js:46:50)
    at RawSource.updateHash (/home/mike/workspace/supabase/storage-js/node_modules/webpack-sources/lib/RawSource.js:64:8)
    at NormalModule._initBuildHash (/home/mike/workspace/supabase/storage-js/node_modules/webpack/lib/NormalModule.js:839:17)
    at handleParseResult (/home/mike/workspace/supabase/storage-js/node_modules/webpack/lib/NormalModule.js:904:10)
    at /home/mike/workspace/supabase/storage-js/node_modules/webpack/lib/NormalModule.js:995:4
    at processResult (/home/mike/workspace/supabase/storage-js/node_modules/webpack/lib/NormalModule.js:718:11)
    at /home/mike/workspace/supabase/storage-js/node_modules/webpack/lib/NormalModule.js:778:5 {
  opensslErrorStack: [ 'error:03000086:digital envelope routines::initialization error' ],
  library: 'digital envelope routines',
  reason: 'unsupported',
  code: 'ERR_OSSL_EVP_UNSUPPORTED'
}

Node.js v17.8.0
ERROR: "build:umd" exited with 1.
mike@workstation:~/workspace/supabase/storage-js$ 

I get this both on this branch and the main branch.

[alaister]

Thanks for the fixes @mirceanton. No worries at all, we've been busy too!

We're aiming to get all these PRs released by the end of this month, so I'll merge this in soon.

If you do find some time in the summer to write some tests, contributions are always welcome! (not a problem if not, though 🙂)

Thanks for the report on the umd build too, I'll check it out.

[alaister]

Hey @mirceanton,
Just circling back around to this now.

I've updated this to go into the next branch, would you mind fixing the merge conflicts and updating the return types to match how we're doing returns now?

Let me know if you run into anything or don't have the bandwidth to make these changes at the moment.

Thanks!

[mircea-pavel-anton]

Hey @alaister ! I will look into fixing things up by the end of this week, no worries!

[mircea-pavel-anton]

Hmm, I updated my branch and then did a rebase on the next branch and it seems there are a few commits now that are outside the scope of this PR. Should I drop them? @alaister

[mircea-pavel-anton]

@alaister is this what you meant by " updating the return types to match how we're doing returns now"?

[alaister]

Yes perfect 👌

[alaister]

Thanks @mirceanton! Looks great!

Don't worry about the commits outside the scope of this PR, they needed to go into next anyway so they're fine here.

[kiwicopple]

🎉 This PR is included in version 1.8.0-next.1 🎉

The release is available on:

• GitHub release
• npm package (@next dist-tag)

Your semantic-release bot 📦🚀

[kiwicopple]

🎉 This PR is included in version 2.0.0-rc.1 🎉

The release is available on:

• GitHub release
• npm package (@rc dist-tag)

Your semantic-release bot 📦🚀