@testring/api - npm Package Compare versions

Comparing version 0.2.3 to 0.2.4

README.md

+# `@testring/api`
+
+
+
+## Install
+Using npm:
+
+```
+npm install --save-dev @testring/api
+```
+
+or using yarn:
+
+```
+yarn add @testring/api --dev
+```

dist/run.js

@@ -11,10 +11,17 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const bytes = require("bytes");
 const logger_1 = require("@testring/logger");
 const test_context_1 = require("./test-context");
 const test_api_controller_1 = require("./test-api-controller");
+const getMemoryUsage = () => {
+    const memoryAfter = process.memoryUsage();
+    return bytes.format(memoryAfter.heapUsed);
+};
 exports.run = (...tests) => __awaiter(this, void 0, void 0, function* () {
     const testID = test_api_controller_1.testAPIController.getTestID();
     const bus = test_api_controller_1.testAPIController.getBus();
-    bus.emit("test/started" /* started */);
     try {
+        bus.emit("test/started" /* started */);
+        logger_1.loggerClient.startStep(testID);
+        logger_1.loggerClient.debug('Memory usage before run:', getMemoryUsage());
         for (let test of tests) {
@@ -24,3 +31,2 @@ const api = new test_context_1.TestContext();
             try {
-                logger_1.loggerClient.startStep(testID);
                 yield test.call(api, api);
@@ -32,8 +38,2 @@ }
             finally {
-                if (caughtError) {
-                    logger_1.loggerClient.endStep(testID, 'Test failed', caughtError);
-                }
-                else {
-                    logger_1.loggerClient.endStep(testID, 'Test passed');
-                }
                 yield api.end();
@@ -45,7 +45,11 @@ }
         }
+        logger_1.loggerClient.debug('Memory usage after run:', getMemoryUsage());
+        logger_1.loggerClient.endStep(testID, 'Test passed');
         bus.emit("test/finished" /* finished */);
     }
     catch (error) {
+        logger_1.loggerClient.debug('Memory usage after run:', getMemoryUsage());
+        logger_1.loggerClient.endStep(testID, 'Test failed', error);
         bus.emit("test/failed" /* failed */, error);
     }
 });

package.json

 {
   "name": "@testring/api",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "main": "./dist/index.js",
@@ -13,7 +13,9 @@ "types": "./src/index.ts",
   "dependencies": {
-    "@testring/logger": "^0.2.3",
-    "@testring/transport": "^0.2.3",
-    "@testring/types": "^0.2.3",
-    "@testring/web-application": "^0.2.3"
+    "@testring/logger": "^0.2.4",
+    "@testring/transport": "^0.2.4",
+    "@testring/types": "^0.2.4",
+    "@testring/web-application": "^0.2.4",
+    "@types/bytes": "^3.0.0",
+    "bytes": "^3.0.0"
   }
 }

src/run.ts

@@ -0,1 +1,2 @@
+import * as bytes from 'bytes';
 import { loggerClient } from '@testring/logger';
@@ -8,2 +9,8 @@ import { TestEvents } from '@testring/types';
 
+const getMemoryUsage = () => {
+    const memoryAfter = process.memoryUsage();
+
+    return bytes.format(memoryAfter.heapUsed);
+};
+
 export const run = async (...tests: Array<TestFunction>) => {
@@ -13,5 +20,8 @@ const testID = testAPIController.getTestID();
 
-    bus.emit(TestEvents.started);
+    try {
+        bus.emit(TestEvents.started);
 
-    try {
+        loggerClient.startStep(testID);
+        loggerClient.debug('Memory usage before run:', getMemoryUsage());
+
         for (let test of tests) {
@@ -23,4 +33,2 @@ const api = new TestContext();
             try {
-                loggerClient.startStep(testID);
-
                 await test.call(api, api);
@@ -30,8 +38,2 @@ } catch (error) {
             } finally {
-                if (caughtError) {
-                    loggerClient.endStep(testID, 'Test failed', caughtError);
-                } else {
-                    loggerClient.endStep(testID, 'Test passed');
-                }
-
                 await api.end();
@@ -45,6 +47,12 @@ }
 
+        loggerClient.debug('Memory usage after run:', getMemoryUsage());
+        loggerClient.endStep(testID, 'Test passed');
+
         bus.emit(TestEvents.finished);
     } catch (error) {
+        loggerClient.debug('Memory usage after run:', getMemoryUsage());
+        loggerClient.endStep(testID, 'Test failed', error);
+
         bus.emit(TestEvents.failed, error);
     }
 };

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10939

7.31%

Number of package files

10

11.11%

Lines of code

262

3.56%

Number of medium quality alerts

1

-50%

Number of lines in readme file

16

Infinity%

Worsened metrics

Dependency count

6

50%

Dependency changes

• + Added

  @types/bytes@^3.0.0

• + Added

  bytes@^3.0.0

• Updated

  @testring/logger@^0.2.4

• Updated

  @testring/transport@^0.2.4

• Updated

  @testring/types@^0.2.4

• Updated

  @testring/web-application@^0.2.4