Merge pull request #42 from FireTail-io/allow-undefined-routes

Allow undefined routes

Author: TheTeaCat

middlewares/http/middleware.go

@@ -116,7 +116,10 @@ func GetMiddleware(options *Options) (func(next http.Handler) http.Handler, erro
 			var pathParams map[string]string
 			if router != nil && (options.EnableRequestValidation || options.EnableResponseValidation) {
 				route, pathParams, err = router.FindRoute(r)
-				if err == routers.ErrMethodNotAllowed {
+				if options.AllowUndefinedRoutes && err == routers.ErrPathNotFound {
+					// If the router couldn't find the path & undefined routes are allowed, fallback to using the request path as the resource
+					logEntry.Request.Resource = r.URL.Path
+				} else if err == routers.ErrMethodNotAllowed {
 					options.ErrCallback(ErrorUnsupportedMethod{r.URL.Path, r.Method}, localResponseWriter, r)
 					return
 				} else if err == routers.ErrPathNotFound {
@@ -125,9 +128,10 @@ func GetMiddleware(options *Options) (func(next http.Handler) http.Handler, erro
 				} else if err != nil {
 					options.ErrCallback(ErrorAtRequestUnspecified{err}, localResponseWriter, r)
 					return
+				} else {
+					// We now know the resource that was requested, so we can fill it into our log entry
+					logEntry.Request.Resource = route.Path
 				}
-				// We now know the resource that was requested, so we can fill it into our log entry
-				logEntry.Request.Resource = route.Path
 			}
 
 			// If it has been enabled, and we were able to determine the route and path params, validate the request against the openapi spec

middlewares/http/middleware_test.go

@@ -182,6 +182,32 @@ func TestRequestToInvalidRoute(t *testing.T) {
 	assert.Equal(t, "{\"code\":404,\"title\":\"the resource \\\"/not-implemented\\\" could not be found\",\"detail\":\"a path for \\\"/not-implemented\\\" could not be found in your appspec\"}", string(respBody))
 }
 
+func TestRequestToInvalidRouteWithAllowUndefinedRoutesEnabled(t *testing.T) {
+	middleware, err := GetMiddleware(&Options{
+		OpenapiSpecPath:         "./test-spec.yaml",
+		DebugErrs:               true,
+		EnableRequestValidation: true,
+		AllowUndefinedRoutes:    true,
+	})
+	require.Nil(t, err)
+	handler := middleware(healthHandler)
+	responseRecorder := httptest.NewRecorder()
+
+	request := httptest.NewRequest("GET", "/not-implemented", nil)
+	handler.ServeHTTP(responseRecorder, request)
+
+	assert.Equal(t, 200, responseRecorder.Code)
+
+	require.Contains(t, responseRecorder.HeaderMap, "Content-Type")
+	require.GreaterOrEqual(t, len(responseRecorder.HeaderMap["Content-Type"]), 1)
+	assert.Len(t, responseRecorder.HeaderMap["Content-Type"], 1)
+	assert.Equal(t, "application/json", responseRecorder.HeaderMap["Content-Type"][0])
+
+	respBody, err := io.ReadAll(responseRecorder.Body)
+	require.Nil(t, err)
+	assert.Equal(t, "{\"description\":\"test description\"}", string(respBody))
+}
+
 func TestDebugErrsDisabled(t *testing.T) {
 	middleware, err := GetMiddleware(&Options{
 		OpenapiSpecPath:         "./test-spec.yaml",

middlewares/http/options.go

@@ -64,6 +64,11 @@ type Options struct {
 	// if no openapi spec is provided, then no validation will be performed
 	EnableResponseValidation bool
 
+	// AllowUndefinedRoutes is an optional flag which, if set to true, allows requests to routes which are not defined in the openapi spec
+	// to pass through the middleware without validation. If set to false (default), requests to undefined routes will be rejected and a
+	// 404 response will be returned
+	AllowUndefinedRoutes bool
+
 	// CustomBodyDecoders is a map of Content-Type header values to openapi3 decoders - if the kin-openapi module does not support your
 	// Content-Type by default, you will need to add a custom decoder here
 	CustomBodyDecoders map[string]openapi3filter.BodyDecoder