fix: process bucket prefix like official cli (#47)

.github/workflows/test.yml

@@ -31,5 +31,5 @@ jobs:
         run: npm ci
       - name: Build
         run: npm run build
-      - name: run test
+      - name: Run test
         run: npm run test

README.md

@@ -178,8 +178,8 @@ await sync('s3://my-source-bucket', 's3://my-target-bucket', {
 #### Relocate objects during sync
 
 ```javascript
-// sync s3://my-source-bucket/a/b/c.txt to s3://my-target-bucket/zzz/c.txt
-await sync('s3://my-source-bucket/a/b/c.txt', 's3://my-target-bucket', {
+// move objects from source folder a/b/ to target folder zzz/
+await sync('s3://my-source-bucket', 's3://my-target-bucket', {
     relocations: [ // multiple relocations can be applied
       (currentPath) =>
         currentPath.startsWith('a/b/')
@@ -188,12 +188,9 @@ await sync('s3://my-source-bucket/a/b/c.txt', 's3://my-target-bucket', {
     ],
 });
 
-// sync s3://mybucket/flowers/red/rose.png to /path/to/local/dir/rose.png
-await sync('s3://mybucket/flowers/red/rose.png', '/path/to/local/dir', {
-    relocations: [
-      (currentPath) => currentPath.replace('flowers/red/', '') // folder flowers/red will be flattened during sync
-    ],
-});
+// aws s3 sync s3://mybucket/flowers/red /path/to/local/dir
+// as in cli, folder flowers/red will be flattened during sync
+await sync('s3://mybucket/flowers/red', '/path/to/local/dir'); 
 ```
 
 Note: relocations are applied after every other options such as filters.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "s3-sync-client",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "description": "AWS CLI s3 sync for Node.js provides a modern client to perform S3 sync operations between file systems and S3 buckets in the spirit of the official AWS CLI command",
   "keywords": [
     "aws",

src/commands/SyncBucketWithBucketCommand.ts

@@ -80,6 +80,14 @@ export class SyncBucketWithBucketCommand {
         (currentPath) => `${targetPrefix}/${currentPath}`,
         ...this.relocations,
       ];
+    if (sourcePrefix !== '')
+      this.relocations = [
+        (currentPath) =>
+          currentPath.startsWith(`${sourcePrefix}/`)
+            ? currentPath.replace(`${sourcePrefix}/`, '')
+            : currentPath,
+        ...this.relocations,
+      ];
     sourceObjects.forEach((sourceObject) =>
       sourceObject.applyFilters(this.filters)
     );

src/commands/SyncLocalWithBucketCommand.ts

@@ -67,6 +67,14 @@ export class SyncLocalWithBucketCommand {
       new ListBucketObjectsCommand({ bucket, prefix }).execute(client),
       new ListLocalObjectsCommand({ directory: this.localDir }).execute(),
     ]);
+    if (prefix !== '')
+      this.relocations = [
+        (currentPath) =>
+          currentPath.startsWith(`${prefix}/`)
+            ? currentPath.replace(`${prefix}/`, '')
+            : currentPath,
+        ...this.relocations,
+      ];
     sourceObjects.forEach((sourceObject) =>
       sourceObject.applyFilters(this.filters)
     );

test/S3SyncClient.test.ts

@@ -135,7 +135,7 @@ test('s3 sync client', async (t) => {
       await syncClient.send(
         new SyncBucketWithBucketCommand({
           sourceBucketPrefix: `${BUCKET_2}/def/jkl`,
-          targetBucketPrefix: BUCKET,
+          targetBucketPrefix: `${BUCKET}/def/jkl`,
           maxConcurrentTransfers: 200,
           monitor,
         })
@@ -155,7 +155,7 @@ test('s3 sync client', async (t) => {
       await syncClient.send(
         new SyncBucketWithBucketCommand({
           sourceBucketPrefix: `${BUCKET_2}/def/jkl`,
-          targetBucketPrefix: BUCKET,
+          targetBucketPrefix: `${BUCKET}/def/jkl`,
           maxConcurrentTransfers: 200,
           relocations: [(currentPath) => `relocated/${currentPath}`],
         })
@@ -171,15 +171,19 @@ test('s3 sync client', async (t) => {
     });
 
     await b.test('syncs a single dir with folder relocation', async () => {
-      await syncClient.sync(`s3://${BUCKET_2}/def/jkl`, `s3://${BUCKET}`, {
-        maxConcurrentTransfers: 200,
-        relocations: [
-          (currentPath) =>
-            currentPath.startsWith('def/jkl')
-              ? currentPath.replace('def/jkl', 'relocated-bis/folder')
-              : currentPath,
-        ],
-      });
+      await syncClient.sync(
+        `s3://${BUCKET_2}/def/jkl`,
+        `s3://${BUCKET}/def/jkl`,
+        {
+          maxConcurrentTransfers: 200,
+          relocations: [
+            (currentPath) =>
+              currentPath.startsWith('def/jkl')
+                ? currentPath.replace('def/jkl', 'relocated-bis/folder')
+                : currentPath,
+          ],
+        }
+      );
       const objects = await syncClient.send(
         new ListBucketObjectsCommand({
           bucket: BUCKET,
@@ -209,6 +213,23 @@ test('s3 sync client', async (t) => {
         assert(objects.length === 5000);
       }
     );
+
+    // https://github.com/jeanbmar/s3-sync-client/issues/40
+    await b.test('processes prefix properly', async () => {
+      fs.rmSync(path.join(SYNC_DIR, 'issue40'), {
+        recursive: true,
+        force: true,
+      });
+      await syncClient.sync(`s3://${BUCKET_2}/def`, `s3://${BUCKET}/issue40`);
+      const objects = await syncClient.send(
+        new ListBucketObjectsCommand({
+          bucket: BUCKET,
+          prefix: 'issue40',
+        })
+      );
+      assert(hasObject(objects, 'issue40/def/jkl/xmoj') === false);
+      assert(hasObject(objects, 'issue40/jkl/xmoj') === true);
+    });
   });
 
   await t.test('syncs bucket with local', async (b) => {
@@ -395,7 +416,7 @@ test('s3 sync client', async (t) => {
     await l.test('syncs a single dir with a few files', async () => {
       await syncClient.send(
         new SyncLocalWithBucketCommand({
-          bucketPrefix: `${BUCKET_2}/def/jkl`,
+          bucketPrefix: `${BUCKET_2}/def`,
           localDir: SYNC_DIR,
         })
       );
@@ -404,7 +425,7 @@ test('s3 sync client', async (t) => {
           directory: SYNC_DIR,
         })
       );
-      assert(hasObject(objects, 'def/jkl/xmoj') === true);
+      assert(hasObject(objects, 'jkl/xmoj') === true);
     });
 
     await l.test(
@@ -415,12 +436,7 @@ test('s3 sync client', async (t) => {
           new SyncLocalWithBucketCommand({
             bucketPrefix: `${BUCKET_2}/def/jkl`,
             localDir: SYNC_DIR,
-            relocations: [
-              (currentPath) =>
-                currentPath.startsWith('def/jkl')
-                  ? currentPath.replace('def/jkl', 'issue9')
-                  : currentPath,
-            ],
+            relocations: [(currentPath) => `issue9/${currentPath}`],
           })
         );
         fs.writeFileSync(
@@ -432,12 +448,7 @@ test('s3 sync client', async (t) => {
           new SyncLocalWithBucketCommand({
             bucketPrefix: `${BUCKET_2}/def/jkl`,
             localDir: SYNC_DIR,
-            relocations: [
-              (currentPath) =>
-                currentPath.startsWith('def/jkl')
-                  ? currentPath.replace('def/jkl', 'issue9')
-                  : currentPath,
-            ],
+            relocations: [(currentPath) => `issue9/${currentPath}`],
             del: true,
           })
         );
@@ -554,6 +565,25 @@ test('s3 sync client', async (t) => {
       assert(atimeMs < now);
       assert(mtimeMs < now);
     });
+
+    // https://github.com/jeanbmar/s3-sync-client/issues/40
+    await l.test('processes prefix properly', async () => {
+      fs.rmSync(path.join(SYNC_DIR, 'issue40'), {
+        recursive: true,
+        force: true,
+      });
+      await syncClient.sync(
+        `s3://${BUCKET_2}/def`,
+        path.join(SYNC_DIR, 'issue40')
+      );
+      const objects = await syncClient.send(
+        new ListLocalObjectsCommand({
+          directory: path.join(SYNC_DIR, 'issue40'),
+        })
+      );
+      assert(hasObject(objects, 'def/jkl/xmoj') === false);
+      assert(hasObject(objects, 'jkl/xmoj') === true);
+    });
   });
 
   await t.test('diffs sync objects', async (d) => {