fix: EncodePath (#264)

bnb-chain · Aug 25, 2023 · 7824130 · 7824130
1 parent b2fff6e
commit 7824130
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 9 deletions.
diff --git a/.changeset/long-suits-share.md b/.changeset/long-suits-share.md
@@ -0,0 +1,5 @@
+---
+'@bnb-chain/greenfield-js-sdk': patch
+---
+
+fix: EncodePath
diff --git a/packages/chain-sdk/src/api/objectt.ts b/packages/chain-sdk/src/api/objectt.ts
@@ -1,10 +1,11 @@
+import { encodePath } from '@/clients/spclient/auth';
 import { getGetObjectMetaInfo } from '@/clients/spclient/spApis/getObject';
 import { parseGetObjectMetaResponse } from '@/clients/spclient/spApis/getObjectMeta';
 import { parseListObjectsByBucketNameResponse } from '@/clients/spclient/spApis/listObjectsByBucket';
 import { getObjectApprovalMetaInfo } from '@/clients/spclient/spApis/objectApproval';
 import { parseError } from '@/clients/spclient/spApis/parseError';
 import { getPutObjectMetaInfo } from '@/clients/spclient/spApis/putObject';
-import { METHOD_GET, METHOD_PUT, NORMAL_ERROR_CODE } from '@/constants/http';
+import { METHOD_GET, NORMAL_ERROR_CODE } from '@/constants/http';
 import { MsgCancelCreateObjectSDKTypeEIP712 } from '@/messages/greenfield/storage/MsgCancelCreateObject';
 import { MsgCreateObjectSDKTypeEIP712 } from '@/messages/greenfield/storage/MsgCreateObject';
 import { MsgDeleteObjectSDKTypeEIP712 } from '@/messages/greenfield/storage/MsgDeleteObject';
@@ -60,7 +61,6 @@ import {
   TxResponse,
 } from '../types';
 import {
-  encodeObjectName,
   generateUrlByBucketName,
   isValidBucketName,
   isValidObjectName,
@@ -613,7 +613,7 @@ export class Objectt implements IObject {
     }
 
     const query = 'object-meta';
-    const path = encodeObjectName(objectName);
+    const path = encodePath(objectName);
     const url = `${generateUrlByBucketName(endpoint, bucketName)}/${path}?${query}`;
     const result = await this.spClient.callApi(url, {
       method: METHOD_GET,

diff --git a/packages/chain-sdk/src/clients/spclient/auth.ts b/packages/chain-sdk/src/clients/spclient/auth.ts
@@ -158,3 +158,44 @@ export const getMsgToSign = (unsignedBytes: Uint8Array): Uint8Array => {
   const res = keccak256(unsignedBytes);
   return res;
 };
+
+export const encodePath = (pathName: string) => {
+  const reservedNames = /^[a-zA-Z0-9-_.~/]+$/;
+  if (reservedNames.test(pathName)) {
+    return pathName;
+  }
+
+  let encodedPathName = '';
+  for (let i = 0; i < pathName.length; i++) {
+    const s = pathName[i];
+
+    // soft characters
+    if (('A' <= s && s <= 'Z') || ('a' <= s && s <= 'z') || ('0' <= s && s <= '9')) {
+      encodedPathName += s;
+      continue;
+    }
+
+    switch (s) {
+      // special characters are allowed
+      case '-':
+      case '_':
+      case '.':
+      case '~':
+      case '/':
+        encodedPathName += s;
+        continue;
+
+      // others characters need to be encoded
+      default:
+        const length = encodeURIComponent(s).length;
+        if (length < 0) {
+          // if encodeURIComponent cannot convert return the same string as is
+          return pathName;
+        }
+
+        const hexStr = s.charCodeAt(0).toString(16);
+        encodedPathName += '%' + hexStr.toUpperCase();
+    }
+  }
+  return encodedPathName;
+};
diff --git a/packages/chain-sdk/src/clients/spclient/spApis/putObject.ts b/packages/chain-sdk/src/clients/spclient/spApis/putObject.ts
@@ -1,6 +1,7 @@
 import { EMPTY_STRING_SHA256, METHOD_PUT } from '@/constants';
 import { ReqMeta } from '@/types';
 import { generateUrlByBucketName } from '@/utils/s3';
+import { encodePath } from '../auth';
 
 // https://docs.bnbchain.org/greenfield-docs/docs/api/storgae-provider-rest/put_object
 export const getPutObjectMetaInfo = async (
@@ -14,7 +15,8 @@ export const getPutObjectMetaInfo = async (
   },
 ) => {
   const { bucketName, objectName, txnHash, contentType, body } = params;
-  const path = `/${objectName}`;
+  const path = `/${encodePath(objectName)}`;
+
   const query = '';
   const url = `${generateUrlByBucketName(endpoint, bucketName)}${path}`;
 

diff --git a/packages/chain-sdk/src/utils/s3.ts b/packages/chain-sdk/src/utils/s3.ts
@@ -125,16 +125,11 @@ const generateUrlByBucketName = (endpoint = '', bucketName: string) => {
   return endpoint.replace(`${protocol}//`, `${protocol}//${bucketName}.`);
 };
 
-const encodeObjectName = (obj: string) => {
-  return obj.split('/').map(encodeURIComponent).join('/');
-};
-
 export {
   isValidBucketName,
   isValidObjectName,
   isValidAddress,
   trimString,
   isValidUrl,
   generateUrlByBucketName,
-  encodeObjectName,
 };