fix tag parsing and type and update validation and tests (#1399)

Author: prakashsvmx

src/internal/client.ts

@@ -45,6 +45,7 @@ import {
   isEmpty,
   isNumber,
   isObject,
+  isPlainObject,
   isReadableStream,
   isString,
   isValidBucketName,
@@ -2239,7 +2240,7 @@ export class TypedClient {
     if (!isValidBucketName(bucketName)) {
       throw new errors.InvalidBucketNameError('Invalid bucket name: ' + bucketName)
     }
-    if (!isObject(tags)) {
+    if (!isPlainObject(tags)) {
       throw new errors.InvalidArgumentError('tags should be of type "object"')
     }
     if (Object.keys(tags).length > 10) {
@@ -2264,7 +2265,7 @@ export class TypedClient {
       throw new errors.InvalidBucketNameError('Invalid object name: ' + objectName)
     }
 
-    if (!isObject(tags)) {
+    if (!isPlainObject(tags)) {
       throw new errors.InvalidArgumentError('tags should be of type "object"')
     }
     if (Object.keys(tags).length > 10) {

src/internal/helper.ts

@@ -233,7 +233,12 @@ export function isString(arg: unknown): arg is string {
 export function isObject(arg: unknown): arg is object {
   return typeof arg === 'object' && arg !== null
 }
-
+/**
+ * check if typeof arg is plain object
+ */
+export function isPlainObject(arg: unknown): arg is Record<string, unknown> {
+  return Object.prototype.toString.call(arg) === '[object Object]'
+}
 /**
  * check if object is readable stream
  */

src/internal/xml-parser.ts

@@ -18,6 +18,7 @@ import type {
   ObjectLockInfo,
   ObjectRowEntry,
   ReplicationConfig,
+  Tag,
   Tags,
 } from './type.ts'
 import { RETENTION_VALIDITY_UNITS } from './type.ts'
@@ -299,14 +300,14 @@ export function parseObjectLegalHoldConfig(xml: string) {
 
 export function parseTagging(xml: string) {
   const xmlObj = parseXml(xml)
-  let result = []
+  let result: Tag[] = []
   if (xmlObj.Tagging && xmlObj.Tagging.TagSet && xmlObj.Tagging.TagSet.Tag) {
-    const tagResult = xmlObj.Tagging.TagSet.Tag
+    const tagResult: Tag = xmlObj.Tagging.TagSet.Tag
     // if it is a single tag convert into an array so that the return value is always an array.
-    if (isObject(tagResult)) {
-      result.push(tagResult)
+    if (Array.isArray(tagResult)) {
+      result = [...tagResult]
     } else {
-      result = tagResult
+      result.push(tagResult)
     }
   }
   return result

tests/functional/functional-tests.js

@@ -2459,7 +2459,11 @@ describe('functional tests', function () {
             return done(err)
           }
           if (Array.isArray(tagList)) {
-            done()
+            const hasNestedArray = tagList.length !== tagList.flat(Infinity).length
+            if (hasNestedArray) {
+              return done(new Error('TagList is not flat'))
+            }
+            return done()
           }
         })
       })
@@ -2519,8 +2523,78 @@ describe('functional tests', function () {
             return done(err)
           }
           if (Array.isArray(tagList)) {
+            const hasNestedArray = tagList.length !== tagList.flat(Infinity).length
+            if (hasNestedArray) {
+              return done(new Error('TagList is not flat'))
+            }
+            return done()
+          }
+          return done()
+        })
+      })
+
+      step(`removeObjectTagging on an object_bucketName:${tagsBucketName}, objectName:${tagObjName},`, (done) => {
+        client.removeObjectTagging(tagsBucketName, tagObjName, (err) => {
+          if (err && err.code === 'NotImplemented') {
+            return done()
+          }
+          if (err) {
+            return done(err)
+          }
+          done()
+        })
+      })
+      step(`removeObject object_bucketName:${tagsBucketName}, objectName:${tagObjName},`, (done) => {
+        client.removeObject(tagsBucketName, tagObjName, () => {
+          done()
+        })
+      })
+    })
+
+    describe('set, get and remove multiple Tags on an object', function () {
+      step(
+        `putObject(bucketName, objectName, stream)_bucketName:${tagsBucketName}, objectName:${tagObjName}, stream:100Kib_`,
+        (done) => {
+          client
+            .putObject(tagsBucketName, tagObjName, tagObject)
+            .then(() => done())
+            .catch(done)
+        },
+      )
+
+      step(`setObjectTagging  object_bucketName:${tagsBucketName}, objectName:${tagObjName},`, (done) => {
+        client.setObjectTagging(
+          tagsBucketName,
+          tagObjName,
+          { 'test-tag-key-obj': 'test-tag-value-obj', 'test-tag-key-obj1': 'test-tag-value-obj1' },
+          (err) => {
+            if (err && err.code === 'NotImplemented') {
+              return done()
+            }
+            if (err) {
+              return done(err)
+            }
             done()
+          },
+        )
+      })
+
+      step(`getObjectTagging  object_bucketName:${tagsBucketName}, objectName:${tagObjName},`, (done) => {
+        client.getObjectTagging(tagsBucketName, tagObjName, (err, tagList) => {
+          if (err && err.code === 'NotImplemented') {
+            return done()
+          }
+          if (err) {
+            return done(err)
           }
+          if (Array.isArray(tagList)) {
+            const hasNestedArray = tagList.length !== tagList.flat(Infinity).length
+            if (hasNestedArray) {
+              return done(new Error('TagList is not flat'))
+            }
+            return done()
+          }
+          return done()
         })
       })
 
@@ -2616,7 +2690,11 @@ describe('functional tests', function () {
               return done(err)
             }
             if (Array.isArray(tagList)) {
-              done()
+              const hasNestedArray = tagList.length !== tagList.flat(Infinity).length
+              if (hasNestedArray) {
+                return done(new Error('TagList is not flat'))
+              }
+              return done()
             }
           })
         } else {