Merge pull request #2555 from contentstack/chore/DX-6926

Chore/dx 6926

Author: cs-raj

packages/contentstack-utilities/package.json

@@ -53,6 +53,7 @@
     "traverse": "^0.6.11",
     "tty-table": "^4.2.3",
     "unique-string": "^2.0.0",
+    "short-uuid": "^6.0.0",
     "uuid": "^14.0.0",
     "winston": "^3.19.0",
     "xdg-basedir": "^4.0.0"

packages/contentstack-utilities/src/helpers.ts

@@ -1,5 +1,7 @@
 import { checkSync } from 'recheck';
 import traverse from 'traverse';
+import { v4 as uuidV4 } from 'uuid';
+import { generate as shortUuidGenerate } from 'short-uuid';
 import authHandler from './auth-handler';
 import { ContentstackClient, HttpClient, cliux, configHandler } from '.';
 import { hasProxy, getProxyUrl } from './proxy-helper';
@@ -278,6 +280,14 @@ export function getAuthenticationMethod(): string {
  * @param authenticationMethod - Optional authentication method
  * @returns Context object with all session-level metadata
  */
+export function generateUid(): string {
+  return uuidV4();
+}
+
+export function generateShortUid(): string {
+  return shortUuidGenerate();
+}
+
 export function createLogContext(
   commandId: string,
   apiKey: string,

packages/contentstack-utilities/test/unit/helper.test.ts

@@ -1,4 +1,4 @@
-import { cliux, validatePath, getBranchFromAlias } from '../../lib';
+import { cliux, validatePath, getBranchFromAlias, generateUid, generateShortUid } from '../../lib';
 import { expect } from 'chai';
 import { fancy } from 'fancy-test';
 
@@ -246,3 +246,32 @@ describe('Testing the getBranchFromAlias function', () => {
     });
   });
 });
+
+describe('generateUid', () => {
+  it('should return a string', () => {
+    expect(generateUid()).to.be.a('string');
+  });
+
+  it('should return a valid UUID v4 format', () => {
+    const uuidV4Regex = /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
+    expect(generateUid()).to.match(uuidV4Regex);
+  });
+
+  it('should return a unique value on each call', () => {
+    expect(generateUid()).to.not.equal(generateUid());
+  });
+});
+
+describe('generateShortUid', () => {
+  it('should return a string', () => {
+    expect(generateShortUid()).to.be.a('string');
+  });
+
+  it('should return a non-empty string', () => {
+    expect(generateShortUid().length).to.be.greaterThan(0);
+  });
+
+  it('should return a unique value on each call', () => {
+    expect(generateShortUid()).to.not.equal(generateShortUid());
+  });
+});

packages/contentstack/package.json

@@ -43,8 +43,7 @@
     "@oclif/plugin-plugins": "^5.4.54",
     "figlet": "1.8.1",
     "node-machine-id": "^1.1.12",
-    "semver": "^7.7.2",
-    "short-uuid": "^6.0.0"
+    "semver": "^7.7.2"
   },
   "overrides": {
     "@oclif/core": {

packages/contentstack/src/utils/context-handler.ts

@@ -1,6 +1,5 @@
-import * as shortUUID from 'short-uuid';
 import * as path from 'path';
-import { configHandler, pathValidator, sanitizePath } from '@contentstack/cli-utilities';
+import { configHandler, pathValidator, sanitizePath, generateShortUid } from '@contentstack/cli-utilities';
 import { machineIdSync } from 'node-machine-id';
 
 export default class CsdxContext {
@@ -33,7 +32,7 @@ export default class CsdxContext {
       configHandler.set('clientId', this.clientId);
     }
     analyticsInfo.push(this.clientId);
-    const sessionId = shortUUID.generate();
+    const sessionId = generateShortUid();
     configHandler.set('sessionId', sessionId);
     this.sessionId = sessionId;
     analyticsInfo.push(this.sessionId);