profoundjs-swagger-stats 2.0.3 → 2.1.0

package/lib/swsHapi.js

@@ -9,6 +9,7 @@ const debug = require('debug')('sws:hapi');
 const url = require('url');
 const qs = require('qs');
 const send = require('send');
+const mime = require('mime-types');
 
 /* HAPI Plugin */
 class SwsHapi {
@@ -117,7 +118,7 @@ class SwsHapi {
                     dotfiles: 'deny'
                     // TODO Caching
                 };
-                request.raw.res.setHeader('Content-Type', send.mime.lookup(path.basename(fileName)));
+                request.raw.res.setHeader('Content-Type', mime.lookup(path.basename(fileName)) || 'application/octet-stream');
                 send(request.raw.req, fileName, options).pipe(request.raw.res);
                 return h.abandon;
             },

package/lib/swsInterface.js

@@ -15,6 +15,7 @@ const swsProcessor = require('./swsProcessor');
 const swsEgress = require('./swsegress');
 const swsAuth = require('./swsAuth');
 const send = require('send');
+const mime = require('mime-types');
 const qs = require('qs');
 const swsHapi = require('./swsHapi');
 
@@ -101,7 +102,7 @@ function processGetUX(req,res){
         dotfiles: 'deny'
         // TODO Caching
     };
-    res.setHeader('Content-Type', send.mime.lookup(path.basename(fileName)));
+    res.setHeader('Content-Type', mime.lookup(path.basename(fileName)) || 'application/octet-stream');
     send(req, fileName, options).pipe(res);
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "profoundjs-swagger-stats",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "description": "API Telemetry and APM. Trace API calls and Monitor API performance, health and usage statistics in Node.js Microservices, based on express routes and Swagger (Open API) specification",
   "main": "lib/index.js",
   "scripts": {
@@ -9,10 +9,9 @@
     "start": "node examples/testapp/testapp.js",
     "hapitestapp": "cross-env SWS_AUTHTEST_MAXAGE=2 nyc --reporter=lcov --reporter=html --reporter=json --reporter=text --report-dir=coverage/hapitestapp node examples/hapijstest/hapijstest.js",
     "fastifytestapp": "cross-env SWS_AUTHTEST_MAXAGE=2 nyc --reporter=lcov --reporter=html --reporter=json --reporter=text --report-dir=coverage/fastifytestapp node examples/fastify/fasifytest.js",
-    "restifytestapp": "cross-env SWS_AUTHTEST_MAXAGE=2 nyc --reporter=lcov --reporter=html --reporter=json --reporter=text --report-dir=coverage/restifytestapp node examples/restify/restifytest.js",
     "testappstop": "mocha --delay --exit test/stoptestapp.js",
     "delay1s": "mocha --delay --exit test/delay.js",
-    "test": "npm run testExpress && npm run testHapi && npm run testFastify && npm run testRestify && npm run coverage-report",
+    "test": "npm run testExpress && npm run testHapi && npm run testFastify && npm run coverage-report",
     "testExpress": "npm run cov000 && npm run cov010 && npm run cov100 && npm run cov200 && npm run cov300 && npm run cov400 && npm run cov500",
     "cov000": "nyc --reporter=lcov --reporter=html --reporter=json --reporter=text --report-dir=coverage/000 mocha --delay --exit test/000_baseline.js",
     "cov010": "nyc --reporter=lcov --reporter=html --reporter=json --reporter=text --report-dir=coverage/010 mocha --delay --exit test/010_swsapistats.js",
@@ -37,13 +36,6 @@
     "cov300f": "nyc --reporter=lcov --reporter=html --reporter=json --reporter=text --report-dir=coverage/300f mocha --delay --exit test/300_timeline.js",
     "cov400f": "nyc --reporter=lcov --reporter=html --reporter=json --reporter=text --report-dir=coverage/400f mocha --delay --exit test/400_auth.js",
     "cov500f": "nyc --reporter=lcov --reporter=html --reporter=json --reporter=text --report-dir=coverage/500f mocha --delay --exit test/500_elastic.js",
-    "testRestify": "concurrently -k --success first \"npm run restifytestapp\" \"npm run covRestify\"",
-    "covRestify": "npm run delay1s && npm run cov000r && npm run cov100r && npm run cov200r && npm run cov300r && npm run cov400r && npm run testappstop",
-    "cov000r": "nyc --reporter=lcov --reporter=html --reporter=json --reporter=text --report-dir=coverage/000f mocha --delay --exit test/000_baseline.js",
-    "cov100r": "nyc --reporter=lcov --reporter=html --reporter=json --reporter=text --report-dir=coverage/100f mocha --delay --exit test/100_method.js",
-    "cov200r": "nyc --reporter=lcov --reporter=html --reporter=json --reporter=text --report-dir=coverage/200f mocha --delay --exit test/200_apicore.js",
-    "cov300r": "nyc --reporter=lcov --reporter=html --reporter=json --reporter=text --report-dir=coverage/300f mocha --delay --exit test/300_timeline.js",
-    "cov400r": "nyc --reporter=lcov --reporter=html --reporter=json --reporter=text --report-dir=coverage/400f mocha --delay --exit test/400_auth.js",
     "coverage-report": "node_modules/.bin/istanbul report --root ./coverage --dir ./coverage-report lcov",
     "specstest": "mocha test/specstest/swaggerspecstest.js"
   },
@@ -94,15 +86,16 @@
   },
   "license": "MIT",
   "dependencies": {
+    "axios": "^1.4.0",
     "basic-auth": "^2.0.1",
-    "cookies": "^0.8.0",
+    "cookies": "^0.9.1",
     "debug": "^4.3.4",
+    "mime-types": "^3.0.2",
     "moment": "^2.29.4",
     "path-to-regexp": "^6.2.1",
     "qs": "^6.11.2",
-    "send": "^0.18.0",
-    "uuid": "^9.0.0",
-    "axios": "^1.4.0"
+    "send": "^1.2.0",
+    "uuid": "^9.0.0"
   },
   "peerDependencies": {
     "prom-client": ">= 10 <= 14"
@@ -124,15 +117,14 @@
     "mocha": "^10.2.0",
     "ncp": "^2.0.0",
     "nyc": "^15.1.0",
+    "profoundjs-swagger-stats-ux": "^1.0.0",
     "prom-client": "^14.2.0",
     "q": "^1.5.1",
-    "restify": "^11.1.0",
+    "request": "^2.88.2",
     "serve-favicon": "^2.5.0",
     "serve-static": "^1.15.0",
     "should": "^13.2.3",
     "supertest": "^6.3.3",
-    "swagger-parser": "^10.0.3",
-    "profoundjs-swagger-stats-ux": "^1.0.0",
-    "request": "^2.88.2"
+    "swagger-parser": "^10.0.3"
   }
 }

package/examples/restify/restifytest.js

@@ -1,174 +0,0 @@
-const path = require('path');
-const restify = require('restify');
-const debug = require('debug')('sws:restify');
-
-const swStats = require('../../lib');    // require('swagger-stats');
-
-const specLocation = path.join(__dirname, '..', 'spectest','petstore3.json');
-debug('Loading Swagger Spec from ' + specLocation );
-const swaggerSpec = require( specLocation );
-
-const server = restify.createServer();
-
-server.use(restify.plugins.queryParser());
-
-// Use swagger-stats middleware
-server.pre(swStats.getMiddleware({
-    name: 'restifytest',
-    version: '0.99.7',
-    hostname: "hostname",
-    ip: "127.0.0.1",
-    timelineBucketDuration:1000,
-    swaggerSpec:swaggerSpec,
-    swaggerOnly: false,
-    uriPath: '/swagger-stats',
-    durationBuckets: [10, 25, 50, 100, 200],
-    requestSizeBuckets: [10, 25, 50, 100, 200],
-    responseSizeBuckets: [10, 25, 50, 100, 200],
-    apdexThreshold: 100,
-    elasticsearch: 'http://127.0.0.1:9200',
-    elasticsearchIndexPrefix: 'swaggerstats-',
-    onResponseFinish: function(req,res,rrr){
-        debug('onResponseFinish: %s', JSON.stringify(rrr));
-    },
-    authentication: true,
-    sessionMaxAge: process.env.SWS_AUTHTEST_MAXAGE || 900,
-    onAuthenticate: function(req,username,password){
-        // simple check for username and password
-        if(username==='swagger-stats') {
-            return ((username === 'swagger-stats') && (password === 'swagger-stats'));
-        } else if(username==='swagger-promise'){
-            return new Promise(function(resolve) {
-                setTimeout(function(){
-                    resolve((username === 'swagger-promise') && (password === 'swagger-promise'));
-                }, 1000);
-            });
-        }
-        return false;
-    }
-}));
-
-// Mock API
-server.pre(mockApiImplementation);
-
-// Tester API
-server.get('/v2/paramstest/:code/and/:value', testerImpl);
-
-// Stats
-server.get('/stats', function(req,res,next){
-    res.status(200);
-    res.send(swStats.getCoreStats());
-    next();
-});
-
-
-
-server.listen(3040, function() {
-    console.log('%s listening at %s', server.name, server.url);
-});
-
-// Mock implementation of any API request
-// Supports the following parameters in x-sws-res header:
-// x-sws-res={ code:<response code>,
-//             message:<message to provide in response>,
-//             delay:<delay to respond>,
-//             payloadsize:<size of payload JSON to generate>
-//           }
-function mockApiImplementation(req,res,next){
-
-    var code = 500;
-    var message = "MOCK API RESPONSE";
-    var delay = 0;
-    var payloadsize = 0;
-
-    if(req.url.startsWith('/v2/paramstest') || req.url.startsWith('/stats')) {
-        next();
-        return;
-    }
-
-    if(req.url.startsWith('/v2/success')) {
-        res.sendRaw(200, 'OK');
-        next();
-        return;
-    }
-    if(req.url.startsWith('/v2/redirect')) {
-        res.redirect('/v2/success',next);
-        return;
-    }
-    if(req.url.startsWith('/v2/client_error')) {
-        res.sendRaw(404, 'Not found');
-        next();
-        return;
-    }
-    if(req.url.startsWith('/v2/server_error')) {
-        res.sendRaw(500, 'Server Error');
-        next();
-        return;
-    }
-
-    // get header
-    var hdrSwsRes = req.header('x-sws-res');
-
-    if(typeof hdrSwsRes !== 'undefined'){
-        var swsRes = JSON.parse(hdrSwsRes);
-        if( 'code' in swsRes ) code = swsRes.code;
-        if( 'message' in swsRes ) message = swsRes.message;
-        if( 'delay' in swsRes ) delay = swsRes.delay;
-        if( 'payloadsize' in swsRes ) payloadsize = swsRes.payloadsize;
-    }
-
-    if( delay > 0 ){
-        setTimeout(function(){
-            mockApiSendResponse(res,code,message,payloadsize);
-            next();
-        },delay);
-    }else{
-        mockApiSendResponse(res,code,message,payloadsize);
-        next();
-    }
-}
-
-function mockApiSendResponse(res,code,message,payloadsize){
-    if(payloadsize<=0){
-        res.status(parseInt(code));
-        res.send(message);
-    }else{
-        // generate dummy payload of approximate size
-        var dummyPayload = [];
-        var adjSize = payloadsize-4;
-        if(adjSize<=0) adjSize = 1;
-        var str = '';
-        for(var i=0;i<adjSize;i++) str += 'a';
-        dummyPayload.push(str);
-        res.contentType = 'json';
-        res.status(parseInt(code));
-        res.send(dummyPayload);
-    }
-}
-
-
-function testerImpl(req, res, next) {
-    var code = 500;
-    var message = "ERROR: Wrong parameters";
-    if(('params' in req) && 'code' in req.params ){
-        code = parseInt(req.params.code);
-        message = "Request Method:" + req.method.toUpperCase() +', params.code: ' + req.params.code;
-    }
-
-    let delay = 0;
-    if(('query' in req) && ('delay' in req.query)){
-        delay = parseInt(req.query.delay);
-    }
-
-    if( delay > 0 ){
-        setTimeout(function(){
-            res.status(code);
-            res.send({code: code, message: message});
-            next();
-        },delay);
-    }else{
-        res.status(code);
-        res.send({code: code, message: message});
-        next();
-    }
-}