Fix pathMatcher to prioritize exact matches (#101)

Author: msmol

src/utils/schemaEndpointResolver.js

@@ -17,7 +17,7 @@ function getMethodSchemaInternal(schemas, path, method) {
     }
 }
 
-function pathMatcher(routes, path) {
+function _pathMatcherInternal(routes, path, exactMatch) {
     return Object
         .keys(routes)
         .find((route) => {
@@ -29,12 +29,18 @@ function pathMatcher(routes, path) {
             return routeArr.every((seg, idx) => {
                 if (seg === pathArr[idx]) return true;
 
-                // if current path segment is param
-                if (seg.startsWith(':') && pathArr[idx]) return true;
+                if (!exactMatch) {
+                    // if current path segment is param
+                    if (seg.startsWith(':') && pathArr[idx]) return true;
+                }
 
                 return false;
             });
         });
 }
 
+function pathMatcher(routes, path) {
+    return _pathMatcherInternal(routes, path, true) || _pathMatcherInternal(routes, path, false);
+}
+
 module.exports = SchemaEndpointResolver;

test/express/middleware-test.js

@@ -39,6 +39,33 @@ describe('input-validation middleware tests - Express', function () {
                     done();
                 });
         });
+        it('valid request - should validate using correct schema - path exact match', function (done) {
+            request(app)
+                .get('/pets/search')
+                .set('api-version', '1.0')
+                .set('request-id', '123456')
+                .query({ terms: 'foobar' })
+                .expect(200, function (err, res) {
+                    if (err) {
+                        throw err;
+                    }
+                    expect(res.body.result).to.equal('OK');
+                    done();
+                });
+        });
+        it('valid request - should validate using correct schema - path partial match', function (done) {
+            request(app)
+                .get('/pets/123')
+                .set('api-version', '1.0')
+                .set('request-id', '123456')
+                .expect(200, function (err, res) {
+                    if (err) {
+                        throw err;
+                    }
+                    expect(res.body.result).to.equal('OK');
+                    done();
+                });
+        });
         it('missing header - should fail', function (done) {
             request(app)
                 .get('/pets')

test/express/test-simple-server.js

@@ -15,6 +15,9 @@ module.exports = () => {
     app.post('/pets', inputValidation.validate, function (req, res, next) {
         res.json({ result: 'OK' });
     });
+    app.get('/pets/search', inputValidation.validate, function(req, res, next) {
+        res.json({ result: 'OK' });
+    });
     app.get('/pets/:petId', inputValidation.validate, function (req, res, next) {
         res.json({ result: 'OK' });
     });

test/pet-store-swagger.yaml

@@ -226,6 +226,29 @@ paths:
           description: unexpected error
           schema:
             $ref: '#/definitions/Error'
+  /pets/search:
+    get:
+      summary: Search for a pet
+      operationId: searchPets
+      tags:
+        - pets
+      parameters:
+        - $ref: '#/parameters/ApiVersion'
+        - $ref: '#/parameters/ApiRequestId'
+        - name: terms
+          in: query
+          required: true
+          description: The search term to match pets
+          type: string
+      responses:
+        "200":
+          description: Expected response to a valid request
+          schema:
+            $ref: '#/definitions/Pets'
+        default:
+          description: unexpected error
+          schema:
+            $ref: '#/definitions/Error'
   /heartbeat:
     get:
       summary: Info for current system status