The key "xxxx" has unallowed characters

[abcfy2]

Hi there.

I always get this error:

> disk.getMetaData('公司合作协议.doc')
Uncaught:
Exception: The key "公司合作协议.doc" has unallowed characters
    at #validateCharacterSet (file:///home/fengyu/projects/DTeam-Top/tsw-team/node_modules/.pnpm/flydrive@1.1.0_@aws-sdk+client-s3@3.744.0_@aws-sdk+s3-request-presigner@3.744.0/node_modules/flydrive/build/chunk-V7XNXQTL.js:102:13)
    at _KeyNormalizer.normalize (file:///home/fengyu/projects/DTeam-Top/tsw-team/node_modules/.pnpm/flydrive@1.1.0_@aws-sdk+client-s3@3.744.0_@aws-sdk+s3-request-presigner@3.744.0/node_modules/flydrive/build/chunk-V7XNXQTL.js:130:31)
    at new DriveFile (file:///home/fengyu/projects/DTeam-Top/tsw-team/node_modules/.pnpm/flydrive@1.1.0_@aws-sdk+client-s3@3.744.0_@aws-sdk+s3-request-presigner@3.744.0/node_modules/flydrive/build/chunk-V7XNXQTL.js:172:33)
    at Disk.file (file:///home/fengyu/projects/DTeam-Top/tsw-team/node_modules/.pnpm/flydrive@1.1.0_@aws-sdk+client-s3@3.744.0_@aws-sdk+s3-request-presigner@3.744.0/node_modules/flydrive/build/index.js:34:12)
    at Disk.getMetaData (file:///home/fengyu/projects/DTeam-Top/tsw-team/node_modules/.pnpm/flydrive@1.1.0_@aws-sdk+client-s3@3.744.0_@aws-sdk+s3-request-presigner@3.744.0/node_modules/flydrive/build/index.js:84:17) {
  status: 500,
  code: 'E_UNALLOWED_CHARACTERS'
}

// convert to uri encode format
> disk.getMetaData('%E5%85%AC%E5%8F%B8%E5%90%88%E4%BD%9C%E5%8D%8F%E8%AE%AE.doc')
Uncaught:
Exception: The key "%E5%85%AC%E5%8F%B8%E5%90%88%E4%BD%9C%E5%8D%8F%E8%AE%AE.doc" has unallowed characters
    at #validateCharacterSet (file:///home/fengyu/projects/DTeam-Top/tsw-team/node_modules/.pnpm/flydrive@1.1.0_@aws-sdk+client-s3@3.744.0_@aws-sdk+s3-request-presigner@3.744.0/node_modules/flydrive/build/chunk-V7XNXQTL.js:102:13)
    at _KeyNormalizer.normalize (file:///home/fengyu/projects/DTeam-Top/tsw-team/node_modules/.pnpm/flydrive@1.1.0_@aws-sdk+client-s3@3.744.0_@aws-sdk+s3-request-presigner@3.744.0/node_modules/flydrive/build/chunk-V7XNXQTL.js:130:31)
    at new DriveFile (file:///home/fengyu/projects/DTeam-Top/tsw-team/node_modules/.pnpm/flydrive@1.1.0_@aws-sdk+client-s3@3.744.0_@aws-sdk+s3-request-presigner@3.744.0/node_modules/flydrive/build/chunk-V7XNXQTL.js:172:33)
    at Disk.file (file:///home/fengyu/projects/DTeam-Top/tsw-team/node_modules/.pnpm/flydrive@1.1.0_@aws-sdk+client-s3@3.744.0_@aws-sdk+s3-request-presigner@3.744.0/node_modules/flydrive/build/index.js:34:12)
    at Disk.getMetaData (file:///home/fengyu/projects/DTeam-Top/tsw-team/node_modules/.pnpm/flydrive@1.1.0_@aws-sdk+client-s3@3.744.0_@aws-sdk+s3-request-presigner@3.744.0/node_modules/flydrive/build/index.js:84:17) {
  status: 500,
  code: 'E_UNALLOWED_CHARACTERS'

And as you can see, I've tried to use uri encode format, also no use.

But this file exists, and R2 dashboard can display this file as well:

Please help. Thanks.

[tsulatsitamim]

same here, work fine on adonis 5, but got same error after migrating to adonis 6
Exception: The key "Semester Pendek 2024-2025 (3).pdf" has unallowed characters

[tsulatsitamim]

found simple solution
await drive.use('s3').driver.getSignedUrl(path, {
expiresIn: '7d',
})

[thetutlage]

@tsulatsitamim This is an intentional limitation documented here https://flydrive.dev/docs/key_concepts#validating-characters-set. We do not support opening and closing brackets in the key names.

[abcfy2]

Hi @thetutlage Why do you add this limitation? Amost all the characters are valid characters in S3 or R2. I thinks this limitation does not make sense.

[thetutlage]

@abcfy2 I agree, maybe we are a little too strict. But, S3 itself has limitations on allowed characters. https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines

Do you think we can adhere to the exact rules laid out by S3?

[abcfy2]

@thetutlage Yes. I think we can remove this limitation, let the storage backend check them.

If the file name is invalid, the storage backend will deny it and throws exception.

We don't need to do anything unnecessary.