SDK doesn't update filename in Content-Disposition metadata on File Rename

[abhis3]

Environment: NextJS 12.3.0 + React 18.2.0 Web Application (arbritrary for the sake of this issue) Emulator Version: 11.5.0

Describe the problem

Steps to reproduce:

• Upload a file through the Firebase Storage console
• Rename the file (code sample below)
• Code Sample:

import * as firebase from 'firebase-admin'
const credential = firebase.credential.cert({
privateKey: process.env.FIREBASE_SERVER_PRIVATE_KEY.replace(/\n/g, '\n'),
clientEmail: process.env.FIREBASE_SERVER_CLIENT_EMAIL,
projectId: process.env.NEXT_PUBLIC_FIREBASE_PROJECT_ID,
})
firebase.apps.length === 0 && firebase.initializeApp({ credential })
export default async function handler(req, res) {
try {
const storage = firebase.storage().bucket('gs://fureyterminal-dev.appspot.com')
const filePath = 'public/demo_temp/SampleExcelFile.xlsx'
const newPath = 'public/demo_temp/RENAMEDExcelFile.xlsx'
const file = storage.file(filePath)
await file.rename(newPath)
res.status(200).send()
} catch (error) {
console.error(error)
res.status(500).send(error)
}
}

• Attempting to download this newly renamed file will display the old name.

+++

Also occurs via gcloud storage mv gs://BUCKET_NAME/OLD_OBJECT_NAME gs://BUCKET_NAME/NEW_OBJECT_NAME"

or renaming the file via the GCP console ===> Cloud Storage ===> Buckets

What Happened?

The culprit is that the Content-Disposition filename field is not updated when calling rename. You can see in the screenshot here (https://imgur.com/a/tyouzeS) that the filename is the old name of tree.jpg. Updating this value manually yields a downloaded file that has the correct name.

This issue was submitted on behalf of a Firebase Storage user

[google-oss-bot]

I found a few problems with this issue:

• I couldn't figure out how to label this issue, so I've labeled it for a human to triage. Hang tight.
• This issue does not seem to follow the issue template. Make sure you provide all the required information.

[abhis3]

I talked it over with the team, we might take this up as part of a larger body of work to support more GCS operations on the Firebase Storage side. For now leaving this issue open to track how many users are running into this issue so it can be prioritized accordingly.

If we were to do this on the SDK side this would constitute a breaking change and we would likely need a new API which is not as ideal.

[abhis3]

As far as immediate resolutions, Content-Disposition is a settable field (https://cloud.google.com/storage/docs/gsutil/addlhelp/WorkingWithObjectMetadata#settable-fields;-field-values) so one might have luck in updating the value themselves while the team works on a fix.

[lahirumaramba]

Hey @abhis3 , storage support in firebase-admin is provided through @google-cloud/storage. I think this issue would be better addressed in the https://github.com/googleapis/nodejs-storage repo.

[Ronso007]

For anyone coming across this issue I will add my solution to this problem (thanks to @abhis3 for the idea)

let metadata = {
        // Here predefined key/value
        contentDisposition: "inline; filename=yourfilename.txt",

        metadata: {
          // Not here! custom key/value
        },
      };

to see the full predefined metadata properties: https://firebase.google.com/docs/storage/web/file-metadata