fix: handle api_version chaining and ensure backward compatibility

Author: sunil-lakshman

lib/entity.js

@@ -45,6 +45,12 @@ export const publishUnpublish = async (http, url, httpBody, headers, locale = nu
     const response = await http.post(url, httpBody, headers)
     if (response.data) {
       const data = response.data || {}
+      if (http?.httpClientParams?.headers?.api_version) {
+        delete http.httpClientParams.headers.api_version
+      }
+      if (headers?.api_version) {
+        delete headers.api_version
+      }
       if (headers) {
         data.stackHeaders = headers
       }

lib/stack/globalField/index.js

@@ -11,10 +11,8 @@ import { createReadStream } from 'fs'
 
 export function GlobalField (http, data = {}) {
   this.stackHeaders = data.stackHeaders
-  this.apiVersion = data.api_version || undefined
-
-  if (this.apiVersion) {
-    this.stackHeaders.api_version = this.apiVersion
+  if (data.api_version) {
+    this.apiVersion = data.api_version
   }
   this.urlPath = `/global_fields`
 
@@ -41,80 +39,31 @@ export function GlobalField (http, data = {}) {
      */
     this.update = async (config) => {
       try {
-        // Add `api_version` to headers if `this.apiVersion` is defined
         if (this.apiVersion) {
           this.stackHeaders.api_version = this.apiVersion
         }
         const headers = {
-          headers: {
-            ...cloneDeep(this.stackHeaders)
-          }
+          headers: { ...cloneDeep(this.stackHeaders) }
+        }
+        let payload = config
+        if (!config) {
+          const {
+            stackHeaders,
+            apiVersion,
+            update,
+            delete: deleteFn,
+            fetch,
+            ...globalFieldPayload
+          } = cloneDeep(this)
+
+          payload = { global_field: globalFieldPayload }
         }
-        const response = await http.put(`${this.urlPath}`, config, headers)
-        // Remove `api_version` from headers after fetching data
+        const response = await http.put(`${this.urlPath}`, payload, headers)
         if (this.apiVersion) {
           delete this.stackHeaders.api_version
         }
-        const data = response.data
-        if (data) {
-          if (this.stackHeaders) {
-            data.stackHeaders = this.stackHeaders
-          }
-          return data
-        } else {
-          throw error(response)
-        }
-      } catch (err) {
-        throw error(err)
-      }
-    }
-
-    /**
-     * @description The Update GlobalField call lets you update the name and description of an existing GlobalField.
-     * @memberof GlobalField
-     * @func update
-     * @returns {Promise<GlobalField.GlobalField>} Promise for GlobalField instance
-     * @example
-     * import * as contentstack from '@contentstack/management'
-     * const client = contentstack.client()
-     * const data = {
-     *    "global_field": {
-     *        "title": "Nested Global Field33",
-     *        "uid": "nested_global_field33",
-     *        "schema": [
-     *            {
-     *                "data_type": "text",
-     *                "display_name": "Single Line Textbox",
-     *                "uid": "single_line"
-     *            },
-     *            {
-     *                "data_type": "global_field",
-     *                "display_name": "Global",
-     *                "uid": "global_field",
-     *                "reference_to": "nested_global_field_123"
-     *            }
-     *        ]
-     *    }
-     *  }
-     * client.stack({ api_key: 'api_key'}).globalField('global_field_uid').updateNestedGlobalField(data, { headers: { api_version: '3.2' }})
-     * .then((globalField) => {
-          console.log(globalField)
-     * })
-     */
-    this.updateNestedGlobalField = async (config, headers = {}) => {
-      const apiVersion = { api_version: '3.2' }
-      this.stackHeaders = { ...this.stackHeaders, ...apiVersion, ...headers }
-      try {
-        const headers = {
-          headers: { ...cloneDeep(this.stackHeaders) }
-        }
-        const response = await http.put(`${this.urlPath}`, config, headers)
-        const data = response.data
-        if (data) {
-          if (this.stackHeaders) {
-            data.stackHeaders = this.stackHeaders
-          }
-          return data
+        if (response.data) {
+          return new this.constructor(http, parseData(response, this.stackHeaders))
         } else {
           throw error(response)
         }
@@ -138,7 +87,6 @@ export function GlobalField (http, data = {}) {
     this.delete = async () => {
       const param = {}
       try {
-        // Add `api_version` to headers if `this.apiVersion` is defined
         if (this.apiVersion) {
           this.stackHeaders.api_version = this.apiVersion
         }
@@ -154,12 +102,8 @@ export function GlobalField (http, data = {}) {
         if (this.apiVersion) {
           delete this.stackHeaders.api_version
         }
-        const data = response.data
-        if (data) {
-          if (this.stackHeaders) {
-            data.stackHeaders = this.stackHeaders
-          }
-          return data
+        if (response.data) {
+          return response.data
         } else {
           throw error(response)
         }
@@ -195,12 +139,11 @@ export function GlobalField (http, data = {}) {
           }
         }
         const response = await http.get(this.urlPath, headers)
-        const data = response.data
-        if (data) {
-          if (this.stackHeaders) {
-            data.stackHeaders = this.stackHeaders
-          }
-          return data
+        if (this.apiVersion) {
+          delete this.stackHeaders.api_version
+        }
+        if (response.data) {
+          return new this.constructor(http, parseData(response, this.stackHeaders))
         } else {
           throw error(response)
         }
@@ -241,12 +184,11 @@ export function GlobalField (http, data = {}) {
           }
         }
         const response = await http.post(`${this.urlPath}`, payload, headers)
-        const data = response.data
-        if (data) {
-          if (this.stackHeaders) {
-            data.stackHeaders = this.stackHeaders
-          }
-          return data
+        if (this.apiVersion) {
+          delete this.stackHeaders.api_version
+        }
+        if (response.data) {
+          return new this.constructor(http, parseData(response, this.stackHeaders))
         } else {
           throw error(response)
         }

test/sanity-check/api/globalfield-test.js

@@ -19,7 +19,6 @@ describe('Global Field api Test', () => {
     makeGlobalField()
       .create(createGlobalField)
       .then((globalField) => {
-        globalField = globalField.global_field
         expect(globalField.uid).to.be.equal(createGlobalField.global_field.uid)
         expect(globalField.title).to.be.equal(
           createGlobalField.global_field.title
@@ -42,7 +41,6 @@ describe('Global Field api Test', () => {
     makeGlobalField(createGlobalField.global_field.uid)
       .fetch()
       .then((globalField) => {
-        globalField = globalField.global_field
         expect(globalField.uid).to.be.equal(createGlobalField.global_field.uid)
         expect(globalField.title).to.be.equal(
           createGlobalField.global_field.title
@@ -65,7 +63,6 @@ describe('Global Field api Test', () => {
     makeGlobalField(createGlobalField.global_field.uid)
       .update(createGlobalField)
       .then((updateGlobal) => {
-        updateGlobal = updateGlobal.global_field
         expect(updateGlobal.uid).to.be.equal(
           createGlobalField.global_field.uid
         )