chore: add fallback for getuserAgentSuffix when package.json is unavailable (#1303)

* Initial plan

* Add fallback for getuserAgentSuffix when package.json is unavailable

Co-authored-by: manekinekko <[email protected]>

* Update jest config to exclude dist folder from test runs

Co-authored-by: manekinekko <[email protected]>

* Update lib/cosmos-db/cosmos-db.utils.ts

* Update lib/cosmos-db/cosmos-db.utils.spec.ts

* Apply suggestions from code review

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: manekinekko <[email protected]>
Co-authored-by: Wassim Chegham <[email protected]>

Author: Copilot

jest.config.js

@@ -1,5 +1,5 @@
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
-  testPathIgnorePatterns: ['<rootDir>/sample/'],
+  testPathIgnorePatterns: ['<rootDir>/sample/', '<rootDir>/dist/'],
 };

lib/cosmos-db/cosmos-db.utils.spec.ts

@@ -0,0 +1,62 @@
+import { getuserAgentSuffix } from './cosmos-db.utils';
+import { readFile } from 'fs/promises';
+import { join } from 'path';
+
+// Mock fs/promises
+jest.mock('fs/promises');
+const mockReadFile = readFile as jest.MockedFunction<typeof readFile>;
+
+describe('cosmos-db.utils', () => {
+  describe('getuserAgentSuffix', () => {
+    beforeEach(() => {
+      jest.clearAllMocks();
+    });
+
+    it('should return user agent with package info when package.json exists', async () => {
+      const mockPackageJson = {
+        name: '@nestjs/azure-database',
+        version: '4.0.0',
+      };
+
+      mockReadFile.mockResolvedValue(JSON.stringify(mockPackageJson));
+
+      const result = await getuserAgentSuffix();
+
+      expect(mockReadFile).toHaveBeenCalledWith(join(__dirname, '..', '..', 'package.json'), 'utf8');
+      expect(result).toBe(
+        `node.js/${process.version} (${process.platform}; ${process.arch}) ${mockPackageJson.name}/${mockPackageJson.version}`,
+      );
+    });
+
+    it('should return fallback user agent when package.json cannot be read', async () => {
+      mockReadFile.mockRejectedValue(new Error('ENOENT: no such file or directory'));
+
+      const result = await getuserAgentSuffix();
+
+      expect(mockReadFile).toHaveBeenCalledWith(join(__dirname, '..', '..', 'package.json'), 'utf8');
+      expect(result).toBe(`node.js/${process.version} (${process.platform}; ${process.arch}) @nestjs/azure-database/0.0.0`);
+    });
+
+    it('should return fallback user agent when package.json is invalid JSON', async () => {
+      mockReadFile.mockResolvedValue('invalid json content');
+
+      const result = await getuserAgentSuffix();
+
+      expect(mockReadFile).toHaveBeenCalledWith(join(__dirname, '..', '..', 'package.json'), 'utf8');
+      expect(result).toBe(`node.js/${process.version} (${process.platform}; ${process.arch}) @nestjs/azure-database/0.0.0`);
+    });
+
+    it('should return fallback user agent when package.json has missing properties', async () => {
+      const mockPackageJson = {
+        name: '@nestjs/azure-database',
+        // version is missing
+      };
+
+      mockReadFile.mockResolvedValue(JSON.stringify(mockPackageJson));
+
+      const result = await getuserAgentSuffix();
+
+      expect(result).toBe(`node.js/${process.version} (${process.platform}; ${process.arch}) @nestjs/azure-database/0.0.0`);
+    });
+  });
+});

lib/cosmos-db/cosmos-db.utils.ts

@@ -6,9 +6,16 @@ import { readFile } from 'fs/promises';
 import { join } from 'path';
 
 export async function getuserAgentSuffix(): Promise<string> {
-  const data = await readFile(join(__dirname, '..', '..', 'package.json'), 'utf8');
-  const json = await JSON.parse(data);
-  return `node.js/${process.version} (${process.platform}; ${process.arch}) ${json.name}/${json.version}`;
+  try {
+    const data = await readFile(join(__dirname, '..', '..', 'package.json'), 'utf8');
+    const json = await JSON.parse(data);
+    if (json.name && json.version) {
+      return `node.js/${process.version} (${process.platform}; ${process.arch}) ${json.name}/${json.version}`;
+    }
+    throw new Error('Missing required package.json properties');
+  } catch {
+    return `node.js/${process.version} (${process.platform}; ${process.arch}) @nestjs/azure-database/0.0.0`;
+  }
 }
 
 export function getModelToken(model: string) {