Merge pull request #21 from apilytics/send-os

Add platform name to sent Apilytics version info

Author: ruohola

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add platform name to sent Apilytics version info.
+
 ## [1.4.0] - 2022-02-15
 
 ### Added

packages/core/__tests__/index.test.ts

@@ -86,6 +86,7 @@ describe('sendApilyticsMetrics()', () => {
 
     expect(APILYTICS_VERSION).toBeTruthy();
     expect(process.versions.node).toBeTruthy();
+    expect(process.platform).toBeTruthy();
 
     expect(requestSpy).toHaveBeenLastCalledWith({
       hostname: 'www.apilytics.io',
@@ -96,7 +97,7 @@ describe('sendApilyticsMetrics()', () => {
         'Content-Type': 'application/json',
         'Content-Length': expect.any(Number),
         'X-API-Key': apiKey,
-        'Apilytics-Version': `apilytics-node-core/${APILYTICS_VERSION};node/${process.versions.node}`,
+        'Apilytics-Version': `apilytics-node-core/${APILYTICS_VERSION};node/${process.versions.node};;${process.platform}`,
       },
     });
 
@@ -137,7 +138,7 @@ describe('sendApilyticsMetrics()', () => {
         'Content-Type': 'application/json',
         'Content-Length': expect.any(Number),
         'X-API-Key': apiKey,
-        'Apilytics-Version': `dummy/${APILYTICS_VERSION};node/${process.versions.node};lib/1.2.3`,
+        'Apilytics-Version': `dummy/${APILYTICS_VERSION};node/${process.versions.node};lib/1.2.3;${process.platform}`,
       },
     });
   });

packages/core/src/index.ts

@@ -91,13 +91,12 @@ export const sendApilyticsMetrics = ({
         memoryTotal,
         timeMillis,
       });
-      let apilyticsVersion = `${
-        apilyticsIntegration ?? 'apilytics-node-core'
-      }/${APILYTICS_VERSION};node/${process.versions.node}`;
 
-      if (integratedLibrary) {
-        apilyticsVersion += `;${integratedLibrary}`;
-      }
+      const apilyticsVersion = `${
+        apilyticsIntegration ?? 'apilytics-node-core'
+      }/${APILYTICS_VERSION};node/${process.versions.node};${
+        integratedLibrary ?? ''
+      };${process.platform}`;
 
       const options = {
         hostname: 'www.apilytics.io',

packages/express/__tests__/index.test.ts

@@ -92,6 +92,7 @@ describe('apilyticsMiddleware()', () => {
     expect(APILYTICS_VERSION).toBeTruthy();
     expect(process.versions.node).toBeTruthy();
     expect(EXPRESS_VERSION).toBeTruthy();
+    expect(process.platform).toBeTruthy();
 
     expect(requestSpy).toHaveBeenLastCalledWith({
       hostname: 'www.apilytics.io',
@@ -102,7 +103,7 @@ describe('apilyticsMiddleware()', () => {
         'Content-Type': 'application/json',
         'Content-Length': expect.any(Number),
         'X-API-Key': apiKey,
-        'Apilytics-Version': `apilytics-node-express/${APILYTICS_VERSION};node/${process.versions.node};express/${EXPRESS_VERSION}`,
+        'Apilytics-Version': `apilytics-node-express/${APILYTICS_VERSION};node/${process.versions.node};express/${EXPRESS_VERSION};${process.platform}`,
       },
     });
 
@@ -142,7 +143,7 @@ describe('apilyticsMiddleware()', () => {
         'Content-Type': 'application/json',
         'Content-Length': expect.any(Number),
         'X-API-Key': apiKey,
-        'Apilytics-Version': `apilytics-node-express/${APILYTICS_VERSION};node/${process.versions.node};express/${EXPRESS_VERSION}`,
+        'Apilytics-Version': `apilytics-node-express/${APILYTICS_VERSION};node/${process.versions.node};express/${EXPRESS_VERSION};${process.platform}`,
       },
     });
 
@@ -275,7 +276,7 @@ describe('apilyticsMiddleware()', () => {
     expect(requestSpy).toHaveBeenLastCalledWith(
       expect.objectContaining({
         headers: expect.objectContaining({
-          'Apilytics-Version': `apilytics-node-express/${APILYTICS_VERSION};node/${process.versions.node}`,
+          'Apilytics-Version': `apilytics-node-express/${APILYTICS_VERSION};node/${process.versions.node};;${process.platform}`,
         }),
       }),
     );

packages/next/__tests__/index.test.ts

@@ -112,6 +112,7 @@ describe('withApilytics()', () => {
     expect(APILYTICS_VERSION).toBeTruthy();
     expect(process.versions.node).toBeTruthy();
     expect(NEXT_VERSION).toBeTruthy();
+    expect(process.platform).toBeTruthy();
 
     expect(requestSpy).toHaveBeenLastCalledWith({
       hostname: 'www.apilytics.io',
@@ -122,7 +123,7 @@ describe('withApilytics()', () => {
         'Content-Type': 'application/json',
         'Content-Length': expect.any(Number),
         'X-API-Key': apiKey,
-        'Apilytics-Version': `apilytics-node-next/${APILYTICS_VERSION};node/${process.versions.node};next/${NEXT_VERSION}`,
+        'Apilytics-Version': `apilytics-node-next/${APILYTICS_VERSION};node/${process.versions.node};next/${NEXT_VERSION};${process.platform}`,
       },
     });
 
@@ -162,7 +163,7 @@ describe('withApilytics()', () => {
         'Content-Type': 'application/json',
         'Content-Length': expect.any(Number),
         'X-API-Key': apiKey,
-        'Apilytics-Version': `apilytics-node-next/${APILYTICS_VERSION};node/${process.versions.node};next/${NEXT_VERSION}`,
+        'Apilytics-Version': `apilytics-node-next/${APILYTICS_VERSION};node/${process.versions.node};next/${NEXT_VERSION};${process.platform}`,
       },
     });
 
@@ -314,7 +315,7 @@ describe('withApilytics()', () => {
     expect(requestSpy).toHaveBeenLastCalledWith(
       expect.objectContaining({
         headers: expect.objectContaining({
-          'Apilytics-Version': `apilytics-node-next/${APILYTICS_VERSION};node/${process.versions.node}`,
+          'Apilytics-Version': `apilytics-node-next/${APILYTICS_VERSION};node/${process.versions.node};;${process.platform}`,
         }),
       }),
     );