Fixed migration rte issue in CLI

sunil-lakshman · sunil-lakshman · commit 90e0d12f88b9 · 2025-04-11T13:55:59.000+05:30
diff --git a/lib/entity.js b/lib/entity.js
@@ -265,6 +265,9 @@ export const fetchAll = (http, wrapperCollection, params = {}) => {
 
 export function parseData (response, stackHeaders, contentTypeUID, taxonomyUid, http) {
   const data = response.data || {}
+  if (stackHeaders && 'api_version' in stackHeaders) {
+    delete stackHeaders.api_version
+  }
   if (stackHeaders) {
     data.stackHeaders = stackHeaders
   }
diff --git a/lib/stack/globalField/index.js b/lib/stack/globalField/index.js
@@ -1,5 +1,5 @@
 import cloneDeep from 'lodash/cloneDeep'
-import { query, upload, parseData } from '../../entity'
+import { create, update, deleteEntity, fetch, query, upload, parseData } from '../../entity'
 import error from '../../core/contentstackError'
 import FormData from 'form-data'
 import { createReadStream } from 'fs'
@@ -12,7 +12,7 @@ import { createReadStream } from 'fs'
 export function GlobalField (http, data = {}) {
   this.stackHeaders = data.stackHeaders
   if (data.api_version) {
-    this.apiVersion = data.api_version
+    this.stackHeaders.api_version = data.apiVersion
   }
   this.urlPath = `/global_fields`
 
@@ -37,40 +37,7 @@ export function GlobalField (http, data = {}) {
      * .then((globalField) => console.log(globalField))
      *
      */
-    this.update = async (config) => {
-      try {
-        if (this.apiVersion) {
-          this.stackHeaders.api_version = this.apiVersion
-        }
-        const headers = {
-          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}`, payload, headers)
-        if (this.apiVersion) {
-          delete this.stackHeaders.api_version
-        }
-        if (response.data) {
-          return new this.constructor(http, parseData(response, this.stackHeaders))
-        } else {
-          throw error(response)
-        }
-      } catch (err) {
-        throw error(err)
-      }
-    }
+    this.update = update(http, 'global_field')
 
     /**
      * @description The Delete GlobalField call is used to delete an existing GlobalField permanently from your Stack.
@@ -84,33 +51,7 @@ export function GlobalField (http, data = {}) {
      * client.stack({ api_key: 'api_key'}).globalField('global_field_uid').delete()
      * .then((response) => console.log(response.notice))
      */
-    this.delete = async () => {
-      const param = {}
-      try {
-        if (this.apiVersion) {
-          this.stackHeaders.api_version = this.apiVersion
-        }
-        const headers = {
-          headers: {
-            ...cloneDeep(this.stackHeaders)
-          },
-          params: {
-            ...cloneDeep(param)
-          }
-        }
-        const response = await http.delete(this.urlPath, headers)
-        if (this.apiVersion) {
-          delete this.stackHeaders.api_version
-        }
-        if (response.data) {
-          return response.data
-        } else {
-          throw error(response)
-        }
-      } catch (err) {
-        throw error(err)
-      }
-    }
+    this.delete = deleteEntity(http)
 
     /**
      * @description The fetch GlobalField call fetches GlobalField details.
@@ -125,32 +66,7 @@ export function GlobalField (http, data = {}) {
      * .then((globalField) => console.log(globalField))
      *
      */
-    this.fetch = async function (param = {}) {
-      try {
-        if (this.apiVersion) {
-          this.stackHeaders.api_version = this.apiVersion
-        }
-        const headers = {
-          headers: {
-            ...cloneDeep(this.stackHeaders)
-          },
-          params: {
-            ...cloneDeep(param)
-          }
-        }
-        const response = await http.get(this.urlPath, headers)
-        if (this.apiVersion) {
-          delete this.stackHeaders.api_version
-        }
-        if (response.data) {
-          return new this.constructor(http, parseData(response, this.stackHeaders))
-        } else {
-          throw error(response)
-        }
-      } catch (err) {
-        throw error(err)
-      }
-    }
+    this.fetch = fetch(http, 'global_field')
   } else {
     /**
      * @description The Create a GlobalField call creates a new globalField in a particular stack of your Contentstack account.
@@ -173,29 +89,7 @@ export function GlobalField (http, data = {}) {
      * client.stack().globalField().create({ global_field })
      * .then((globalField) => console.log(globalField))
      */
-    this.create = async (payload) => {
-      try {
-        if (this.apiVersion) {
-          this.stackHeaders.api_version = this.apiVersion
-        }
-        const headers = {
-          headers: {
-            ...cloneDeep(this.stackHeaders)
-          }
-        }
-        const response = await http.post(`${this.urlPath}`, payload, headers)
-        if (this.apiVersion) {
-          delete this.stackHeaders.api_version
-        }
-        if (response.data) {
-          return new this.constructor(http, parseData(response, this.stackHeaders))
-        } else {
-          throw error(response)
-        }
-      } catch (err) {
-        return error(err)
-      }
-    }
+    this.create = create({ http: http })
 
     /**
      * @description The Query on GlobalField will allow to fetch details of all or specific GlobalField
@@ -210,7 +104,7 @@ export function GlobalField (http, data = {}) {
      * client.stack().globalField().query({ query: { name: 'Global Field Name' } }).find()
      * .then((globalFields) => console.log(globalFields))
      */
-    this.query = query({ http: http, wrapperCollection: GlobalFieldCollection, apiVersion: this.apiVersion })
+    this.query = query({ http: http, wrapperCollection: GlobalFieldCollection, apiVersion: this.apiVersion  })
 
     /**
    * @description The Import a global field call imports a global field into a stack.
@@ -266,4 +160,4 @@ export function createFormData (data) {
     formData.append('global_field', uploadStream)
     return formData
   }
-}
+}
diff --git a/lib/stack/index.js b/lib/stack/index.js
@@ -164,25 +164,14 @@ export function Stack (http, data) {
      * .then((globalField) => console.log(globalField))
      *
      */
-    this.globalField = (globalFieldUidOrOptions = null, options = {}) => {
-      const data = {
-        stackHeaders: this.stackHeaders
+    this.globalField = (globalFieldUid = null, api_version = '3.0') => {
+      const data = { 
+        stackHeaders: this.stackHeaders, 
+        api_version: api_version 
       }
-      if (typeof globalFieldUidOrOptions === 'object' && globalFieldUidOrOptions !== null) {
-        options = globalFieldUidOrOptions
-      } else if (globalFieldUidOrOptions) {
-        data.global_field = { uid: globalFieldUidOrOptions }
+      if (globalFieldUid) {
+        data.global_field = { uid: globalFieldUid }
       }
-
-      // Safely handle `options` and check for `api_version`
-      options = options || {} // Ensure `options` is always an object
-      if (options && typeof options === 'object' && options.api_version) {
-        data.api_version = options.api_version
-        if (options.api_version === '3.2') {
-          data.nested_global_fields = true
-        }
-      }
-
       return new GlobalField(http, data)
     }
 
diff --git a/test/sanity-check/api/globalfield-test.js b/test/sanity-check/api/globalfield-test.js
@@ -1,8 +1,9 @@
 import path from 'path'
 import { expect } from 'chai'
+import { cloneDeep } from 'lodash'
 import { describe, it, setup } from 'mocha'
 import { jsonReader } from '../utility/fileOperations/readwrite'
-import { createGlobalField } from '../mock/globalfield'
+import { createGlobalField, createNestedGlobalField, createNestedGlobalFieldForReference } from '../mock/globalfield'
 import { contentstackClient } from '../utility/ContentstackClient.js'
 import dotenv from 'dotenv'
 
@@ -59,25 +60,16 @@ describe('Global Field api Test', () => {
       .catch(done)
   })
 
-  it('should update global Field', (done) => {
-    makeGlobalField(createGlobalField.global_field.uid)
-      .update(createGlobalField)
+  it('should update global Field', done => {
+    const globalField = makeGlobalField(createGlobalField.global_field.uid)
+    Object.assign(globalField, cloneDeep(createGlobalField.global_field))
+    globalField.update()
       .then((updateGlobal) => {
-        expect(updateGlobal.uid).to.be.equal(
-          createGlobalField.global_field.uid
-        )
-        expect(updateGlobal.title).to.be.equal(
-          createGlobalField.global_field.title
-        )
-        expect(updateGlobal.schema[0].uid).to.be.equal(
-          createGlobalField.global_field.schema[0].uid
-        )
-        expect(updateGlobal.schema[0].data_type).to.be.equal(
-          createGlobalField.global_field.schema[0].data_type
-        )
-        expect(updateGlobal.schema[0].display_name).to.be.equal(
-          createGlobalField.global_field.schema[0].display_name
-        )
+        expect(updateGlobal.uid).to.be.equal(createGlobalField.global_field.uid)
+        expect(updateGlobal.title).to.be.equal(createGlobalField.global_field.title)
+        expect(updateGlobal.schema[0].uid).to.be.equal(createGlobalField.global_field.schema[0].uid)
+        expect(updateGlobal.schema[0].data_type).to.be.equal(createGlobalField.global_field.schema[0].data_type)
+        expect(updateGlobal.schema[0].display_name).to.be.equal(createGlobalField.global_field.schema[0].display_name)
         done()
       })
       .catch(done)
@@ -142,7 +134,7 @@ describe('Global Field api Test', () => {
   // it('should create nested global field for reference', done => {
   //   makeGlobalField({ api_version: '3.2' }).create(createNestedGlobalFieldForReference)
   //       .then(globalField => {
-  //           expect(globalField.global_field.uid).to.be.equal(createNestedGlobalFieldForReference.global_field.uid);
+  //           expect(globalField.uid).to.be.equal(createNestedGlobalFieldForReference.global_field.uid);
   //           done();
   //       })
   //       .catch(err => {
@@ -154,7 +146,7 @@ describe('Global Field api Test', () => {
   // it('should create nested global field', done => {
   //   makeGlobalField({ api_version: '3.2' }).create(createNestedGlobalField)
   //       .then(globalField => {
-  //           expect(globalField.global_field.uid).to.be.equal(createNestedGlobalField.global_field.uid);
+  //           expect(globalField.uid).to.be.equal(createNestedGlobalField.global_field.uid);
   //           done();
   //       })
   //       .catch(err => {
@@ -166,7 +158,7 @@ describe('Global Field api Test', () => {
   // it('should fetch nested global field', done => {
   //   makeGlobalField(createNestedGlobalField.global_field.uid, { api_version: '3.2' }).fetch()
   //       .then(globalField => {
-  //           expect(globalField.global_field.uid).to.be.equal(createNestedGlobalField.global_field.uid);
+  //           expect(globalField.uid).to.be.equal(createNestedGlobalField.global_field.uid);
   //           done();
   //       })
   //       .catch(err => {
@@ -175,16 +167,39 @@ describe('Global Field api Test', () => {
   //       });
   // });
 
-  // it('should update nested global fields without fetch', done => {
-  //   makeGlobalField(createNestedGlobalField.global_field.uid, { api_version: '3.2' })
-  //     .update(createNestedGlobalField)
+  // it('should fetch and update nested global Field', done => {
+  //   makeGlobalField(createGlobalField.global_field.uid, { api_version: '3.2' }).fetch()
   //     .then((globalField) => {
-  //       expect(globalField.global_field.schema.length).to.be.equal(2)
+  //       globalField.title = 'Update title'
+  //       return globalField.update()
+  //     })
+  //     .then((updateGlobal) => {
+  //       expect(updateGlobal.uid).to.be.equal(createGlobalField.global_field.uid)
+  //       expect(updateGlobal.title).to.be.equal('Update title')
+  //       expect(updateGlobal.schema[0].uid).to.be.equal(createGlobalField.global_field.schema[0].uid)
+  //       expect(updateGlobal.schema[0].data_type).to.be.equal(createGlobalField.global_field.schema[0].data_type)
+  //       expect(updateGlobal.schema[0].display_name).to.be.equal(createGlobalField.global_field.schema[0].display_name)
   //       done()
   //     })
   //     .catch(done)
   // })
 
+  // it('should update nested global Field', done => {
+  //   const globalField = makeGlobalField(createGlobalField.global_field.uid, { api_version: '3.2' })
+  //   Object.assign(globalField, cloneDeep(createGlobalField.global_field))
+  //   globalField.update()
+  //     .then((updateGlobal) => {
+  //       expect(updateGlobal.uid).to.be.equal(createGlobalField.global_field.uid)
+  //       expect(updateGlobal.title).to.be.equal(createGlobalField.global_field.title)
+  //       expect(updateGlobal.schema[0].uid).to.be.equal(createGlobalField.global_field.schema[0].uid)
+  //       expect(updateGlobal.schema[0].data_type).to.be.equal(createGlobalField.global_field.schema[0].data_type)
+  //       expect(updateGlobal.schema[0].display_name).to.be.equal(createGlobalField.global_field.schema[0].display_name)
+  //       done()
+  //     })
+  //     .catch(done)
+  // })
+
+
   // it("should delete nested global field", (done) => {
   //   makeGlobalField(createNestedGlobalField.global_field.uid, { api_version: '3.2' })
   //     .delete()

Original file line number	Diff line number	Diff line change
`@@ -265,6 +265,9 @@ export const fetchAll = (http, wrapperCollection, params = {}) => {`
`265`	`265`
`266`	`266`	`export function parseData (response, stackHeaders, contentTypeUID, taxonomyUid, http) {`
`267`	`267`	`const data = response.data \|\| {}`
	`268`	`+ if (stackHeaders && 'api_version' in stackHeaders) {`
	`269`	`+ delete stackHeaders.api_version`
	`270`	`+ }`
`268`	`271`	`if (stackHeaders) {`
`269`	`272`	`data.stackHeaders = stackHeaders`
`270`	`273`	`}`