Qase jest v1.3.0 alpha.3 (qase-tms#110)

* [qase-jest] Added ability to pass AnalyticsHeaders into API client

* [qase-jest] Updated example

* [qase-jest] Added os, npm, arch information to headers

* [qase-jest] Added function to get packages version from package.json instead the package-lock.json

* [qase-jest] Removed logging from the getPackageVersion

Author: nl-kaidzen

qase-jest/examples/package.json

@@ -9,7 +9,9 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "jest": "^27.0.4",
+    "jest": "^27.0.4"
+  },
+  "dependencies": {
     "jest-qase-reporter": "../"
   }
 }

qase-jest/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-qase-reporter",
-  "version": "v1.3.0-alpha.2",
+  "version": "v1.3.0-alpha.3",
   "description": "Qase TMS Jest Reporter",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -30,7 +30,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "qaseio": "^2.0.0-alpha.2"
+    "qaseio": "^2.0.0-alpha.4"
   },
   "devDependencies": {
     "@hutson/npm-deploy-git-tag": "^6.0.0",

qase-jest/package.json

@@ -8,6 +8,8 @@ import {
 import { Reporter, Test, TestResult } from '@jest/reporters';
 import { QaseApi } from 'qaseio';
 import chalk from 'chalk';
+import { execSync } from 'child_process';
+import { readFileSync } from 'fs';
 
 enum Envs {
     report = 'QASE_REPORT',
@@ -70,6 +72,7 @@ class QaseReporter implements Reporter {
         this.api = new QaseApi(
             this.getEnv(Envs.apiToken) || this.options.apiToken || '',
             this.getEnv(Envs.basePath) || this.options.basePath,
+            this.createHeaders(),
         );
 
         this.log(chalk`{yellow Current PID: ${process.pid}}`);
@@ -119,7 +122,7 @@ class QaseReporter implements Reporter {
                         (created) => {
                             if (created) {
                                 this.runId = created.result?.id;
-                                process.env.QASE_RUN_ID = this.runId!.toString();
+                                process.env.QASE_RUN_ID = String(this?.runId);
                                 this.log(chalk`{green Using run ${this.runId} to publish test results}`);
                             } else {
                                 this.log(chalk`{red Could not create run in project ${this.options.projectCode}}`);
@@ -342,6 +345,43 @@ class QaseReporter implements Reporter {
             return caseObject;
         });
     }
+
+    private createHeaders() {
+        const { version: nodeVersion, platform: os, arch } = process;
+        const npmVersion = execSync('npm -v', { encoding: 'utf8' }).replace(/['"\n]+/g, '');
+        const qaseapiVersion = this.getPackageVersion('qaseio');
+        const jestVersion = this.getPackageVersion('jest');
+        const jestCaseReporterVersion = this.getPackageVersion('jest-qase-reporter');
+        const xPlatformHeader = `node=${nodeVersion}; npm=${npmVersion}; os=${os}; arch=${arch}`;
+        // eslint-disable-next-line max-len
+        const xClientHeader = `jest=${jestVersion as string}; qase-jest=${jestCaseReporterVersion as string}; qaseapi=${qaseapiVersion as string}`;
+
+        return {
+            'X-Client': xClientHeader,
+            'X-Platform': xPlatformHeader,
+        };
+    }
+
+    private getPackageVersion(name: string) {
+        const UNDEFINED = 'undefined';
+        try {
+            const pathToPackageJson = require.resolve(`${name}/package.json`, { paths: [process.cwd()] });
+            if (pathToPackageJson) {
+                try {
+                    const packageString = readFileSync(pathToPackageJson, { encoding: 'utf8' });
+                    if (packageString) {
+                        const packageObject = JSON.parse(packageString) as { version: string };
+                        return packageObject.version;
+                    }
+                    return UNDEFINED;
+                } catch (error) {
+                    return UNDEFINED;
+                }
+            }
+        } catch (error) {
+            return UNDEFINED;
+        }
+    }
 }
 
 export = QaseReporter;

qase-jest/src/index.ts

@@ -12,7 +12,8 @@
     "strict": true,                           /* Enable all strict type-checking options. */
     "noImplicitAny": false,                    /* Raise error on expressions and declarations with an implied 'any' type. */
     "esModuleInterop": true,                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    "types": ["node", "jest"]
+    "types": ["node", "jest"],
+    "resolveJsonModule": true
   },
   "exclude": [
     "node_modules",