BUG & FIX: Windows path bugfix for "Error: ... contains invalid WIN32 path characters."

[philippdonabauer]

To bugfix "invalid WIN32 path characters" insert following code.

This error message is produced if you use the Amplify private storage put command to upload on s3erver on windows. The identity id contains an ":" so the path for the private upload is "private/region:identity_id/file" and windows does not allow special characters like ":", "<"...

At:

s3rver/lib/models/s3-object.js

Lines 6 to 9 in 9d8e6ca

	constructor(bucket, key, content, metadata) {
	this.bucket = bucket;
	this.key = key;
	this.content = content;

after this.key= key; insert following code:

if(process.platform === "win32") {
      this.key = this.key.replace(/[<>:"|?*]/g, function (match, capture) {
        return  "%" + Buffer.from(match, 'utf8').toString("hex");
      });
    }

[philippdonabauer]

If you wan't i can create an pull request?

Also some changes in the Filesystem are required to work:

  copyObject(
    srcBucket,
    srcKey,
    destBucket,
    destKey,
    replacementMetadata,
    done
  ) {

    if(process.platform === "win32") {
      srcKey = srcKey.replace(/[<>:"|?*]/g, function (match, capture) {
        return  "%" + Buffer.from(match, 'utf8').toString("hex");
      });
      destKey = destKey.replace(/[<>:"|?*]/g, function (match, capture) {
        return  "%" + Buffer.from(match, 'utf8').toString("hex");
      });
    }

   getObject(bucket, key, options, done) {
    if (typeof options === "function") {
      done = options;
      options = undefined;
    }

    if(process.platform === "win32") {
      key = key.replace(/[<>:"|?*]/g, function (match, capture) {
        return  "%" + Buffer.from(match, 'utf8').toString("hex");
      });
    }

  existsObject(bucket, key, done) {
    if(process.platform === "win32") {
      key = key.replace(/[<>:"|?*]/g, function (match, capture) {
        return  "%" + Buffer.from(match, 'utf8').toString("hex");
      });
    }

storeMetadata(bucket, key, metadata, md5, done) {
    if (typeof md5 === "function") {
      done = md5;
      md5 = null;
    }
    
    if(process.platform === "win32") {
      key = key.replace(/[<>:"|?*]/g, function (match, capture) {
        return  "%" + Buffer.from(match, 'utf8').toString("hex");
      });
    }

    deleteObject(bucket, key, done) {
    key = key.replace(/[<>:"|?*]/g, function (match, capture) {
      return  "%" + Buffer.from(match, 'utf8').toString("hex");
    });

  putObjectMultipart(bucket, key, uploadId, parts, metadata, done) {

    key = key.replace(/[<>:"|?*]/g, function (match, capture) {
      return  "%" + Buffer.from(match, 'utf8').toString("hex");
    });

[leontastic]

@philippdonabauer We'd be happy to have your PR. Can you write a test in https://github.com/jamhall/s3rver/blob/master/test/test.js with your use case that fails on Windows, then PR your test code and post your output?

[philippdonabauer]

@leontastic yes i can do. Next weekend i will write a test and make a pull request with the depending changes. Thank you.

[SimonLegg]

Still getting this error --version 4.5.0

await Strorage.vault.put(fileName, file);

develop\private\eu-west-1:676aefb9-b94e-4a93-ba85-ad e35ef2d202 contains invalid WIN32 path characters.

It might be that the test created in relation to #420 with commit cf29c53 doesn't consider region or amplify mock (just guesses as don't have time to look into currently)

Workaround: use public (not vault or level: private)

Note: potentially region was not in path before, region is not in public as yet

[rehanbabertkxel]

@SimonLegg , yes. I am facing the same issue. But I need to use protected or private. Any workaround for it?

[SimonLegg]

@rehanbabertkxel - I'm just in development at the moment so I'm sticking with public until i need to properly deploy then I'll just switch to private. I might use project environment variables or build environment to still allow amplify mock to be used for local development.

Regards