feat: custom-metadata, exists, info methods

[fenos]

What kind of change does this PR introduce?

Feature

What is the new behavior?

Custom Metadata

Adds support for custom metadata on objects:

const res = await storage.from(bucketName).upload(uploadPath, file, {
        metadata: {
          custom: 'metadata',
          second: 'second',
          third: 'third',
        },
})

Exists / Info

added 2 new methods, exists and info

Info
fetches the information about this object

const {data: obj} = await storage.from(bucketName).info(uploadPath)

obj.id
obj.metadata

Exists
Check if a file exists

const {data: exists} = await storage.from(bucketName).exists(uploadPath)

console.log(exists) // true / false

Relates to supabase/storage#439

[y4my4my4m]

Is this merge waiting a certain release cycle?

For what it's worth, the code looks fine to me.
Cheers

[danvoyce]

Hey folks, super eager to start using this.

Is this merge waiting a certain release cycle?

For what it's work, the code looks fine to me. Cheers

+1

Desperately need this feature 🙏

[bombillazo]

Hey, yeah, we're also waiting on this feature for a while.

[adamski]

Is there an estimated timescale for merging of this PR and subsequent release?

[logemann]

+1 for merging. This one is more important to me than a lot of stuff which got released in last launch weeks. Sometimes supabase team loses sight of the basic requirements still missing like this one...

[fenos]

Apologies for the delay guys, i'm aiming to have this merged this week.
The rollout has already started

[kiwicopple]

🎉 This issue has been resolved in version 2.7.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[jan-tennert]

@fenos I'm confused about the implementation of the info method. The method uses the object/info/{bucketName}/{wildcard} route

storage-js/src/packages/StorageFileApi.ts

Lines 566 to 568 in dbd5883

	const data = await get(this.fetch, `${this.url}/object/info/${_path}`, {
	headers: this.headers,
	})

which seems to be deprecated in the API docs and upon testing this release I get

StorageApiError: Object not found

errors.
The /object/info/public/{bucketName}/{wildcard} and object/info/authenticated/{bucketName}/{wildcard} routes seem to be working 🤔

[fenos]

Hey @danvoyce do you have RLS for selecting the object?

The route is probably marked as deprecated mistakingly, thanks for point that out

[jan-tennert]

@fenos, well the bucket is public and I'm using the service key. exists returns true for both public & private bucket files I tried. Currently trying to implement this for supabase-kt, but storage-js gives me the same error as shown above. This is the JS code I used:

import { StorageClient } from '@supabase/storage-js'

const STORAGE_URL = 'url'
const SERVICE_KEY = 'service key' //! service key, not anon key

const storageClient = new StorageClient(STORAGE_URL, {
  apikey: SERVICE_KEY,
  Authorization: `Bearer ${SERVICE_KEY}`,
})

const data = await storageClient.from("test").info("test.txt") //test is a public bucket
console.log(data.error) //StorageApiError: Object not found
console.log(data.data)
const exists = await storageClient.from("test").exists("test.txt")
console.log(exists.data) // true

[cipriancaba]

Is there a rollout plan for this in the main supabase-js package @kiwicopple ?

[fenos]

@cipriancaba yes, here is the PR

[danvoyce]

Hey @fenos you know when it's likely to be merged? I see it's been approved already 🤓

[danvoyce]

@fenos it's currently not possible to add new RLS policies to the objects table. Is there a way to allow users to modify the metadata somehow?

[jppty]

Is there documentation on how to add metadata through TUS uploads?

The PR here indicates TUS is supported: supabase/storage#518

[khera]

🎉 This issue has been resolved in version 2.7.0 🎉

This is awesome, but neither the Guide nor the Javascript reference documentation mention this capability. Please, please, update the documentation when new features are added.

Thanks!

[icopp]

Any documentation available for this yet?

[naimRahman08]

I am also facing the same issue as @jan-tennert. For me its showing

StorageApiError: Bucket not found

although file is uploading correctly but info throws the above error

Also documentation would be great

[IstoraMandiri]

Is there documentation on how to add metadata through TUS uploads?

See https://github.com/supabase/storage/blob/689d255c82df0bde49c3786f5938c4a0d1933cf2/src/test/tus.test.ts#L98-L100

Or, using Uppy:

    new Uppy({
      // ...
      onBeforeFileAdded(file) {
        file.meta = {
          ...file.meta,
          bucketName: BUCKET,
          objectName: file.name,
          contentType: file.type,
          metadata: JSON.stringify({ test: "hello" }),
        };
        return file;
      },
    })
      .use(Tus, {
        // ...
        allowedMetaFields: ["bucketName", "objectName", "contentType", "cacheControl", "metadata"],
        // ...
      }),
  );

[jppty]

I am also facing the same issue as @jan-tennert. For me its showing

StorageApiError: Bucket not found

although file is uploading correctly but info throws the above error

Also documentation would be great

Same issue on my end. I can fetch the file and download it, and I can call the exists method on it and it returns true. If I call the .info method, it returns StorageApiError: Bucket not found.

It works if I append either authenticated/ or public/ to the bucket name, e.g.:

let { data: info } = await supabase.storage
    .from("public/my-bucket")
    .info("my_photo.png");