Gateway should skip inactive APIs. Resolves #1151

TykTechnologies · Sep 29, 2017 · 3910825 · 3910825
1 parent 6ee678c
commit 3910825
Show file tree

Hide file tree

Showing 12 changed files with 42 additions and 17 deletions.
diff --git a/api_definition_test.go b/api_definition_test.go
@@ -38,7 +38,8 @@ const sampleDefiniton = `{
 	"proxy": {
 		"listen_path": "/v1",
 		"target_url": "` + testHttpAny + `"
-	}
+	},
+	"active": true
 }`
 
 const nonExpiringDef = `{
@@ -64,7 +65,8 @@ const nonExpiringDef = `{
 	"proxy": {
 		"listen_path": "/v1",
 		"target_url": "` + testHttpAny + `"
-	}
+	},
+	"active": true
 }`
 
 const nonExpiringMultiDef = `{
@@ -98,7 +100,8 @@ const nonExpiringMultiDef = `{
 	"proxy": {
 		"listen_path": "/v1",
 		"target_url": "` + testHttpAny + `"
-	}
+	},
+	"active": true
 }`
 
 func createDefinitionFromString(defStr string) *APISpec {
@@ -378,7 +381,7 @@ func TestGetAPISpecsDashboardSuccess(t *testing.T) {
 	// Mock Dashboard
 	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		if r.URL.Path == "/system/apis" {
-			w.Write([]byte(`{"Status": "OK", "Nonce": "1", "Message": [{"api_definition": {}}]}`))
+			w.Write([]byte(`{"Status": "OK", "Nonce": "1", "Message": [{"api_definition": {"active": true}}]}`))
 		} else {
 			t.Fatal("Unknown dashboard API request", r)
 		}

diff --git a/api_loader.go b/api_loader.go
@@ -39,7 +39,17 @@ func prepareStorage() (*RedisClusterStorageManager, *RedisClusterStorageManager,
 	return &redisStore, &redisOrgStore, healthStore, &rpcAuthStore, &rpcOrgStore
 }
 
-func skipSpecBecauseInvalid(spec *APISpec) bool {
+func skipSpec(spec *APISpec) bool {
+
+	// Remove inactive APIs from the specs
+	if !spec.Active {
+		log.WithFields(logrus.Fields{
+			"prefix":   "main",
+			"api_name": spec.Name,
+			"domain":   spec.Domain,
+		}).Info("Skipping Inactive.")
+		return true
+	}
 
 	if spec.Proxy.ListenPath == "" {
 		log.WithFields(logrus.Fields{
@@ -109,7 +119,7 @@ func processSpec(spec *APISpec, apisByListen map[string]int,
 		"api_name": spec.Name,
 	}).Info("Loading API")
 
-	if skipSpecBecauseInvalid(spec) {
+	if skipSpec(spec) {
 		log.WithFields(logrus.Fields{
 			"prefix":   "main",
 			"api_name": spec.Name,
@@ -555,6 +565,7 @@ func loadApps(specs []*APISpec, muxer *mux.Router) {
 	loadList := make([]*ChainObject, len(specs))
 	apisByListen := countApisByListenHash(specs)
 	for i, spec := range specs {
+
 		go func(spec *APISpec, i int) {
 			subrouter := muxer
 			// Handle custom domains

diff --git a/api_test.go b/api_test.go
@@ -33,7 +33,8 @@ const apiTestDef = `{
 	"proxy": {
 		"listen_path": "/v1",
 		"target_url": "` + testHttpAny + `"
-	}
+	},
+	"active": true
 }`
 
 func loadSampleAPI(t *testing.T, def string) {

diff --git a/apps/app_sample.json b/apps/app_sample.json
@@ -29,5 +29,6 @@
         "target_url": "http://httpbin.org",
         "strip_listen_path": true
     },
-    "enable_batch_request_support": true
+    "enable_batch_request_support": true,
+    "active": true
 }
diff --git a/apps/coprocess_app_sample.json b/apps/coprocess_app_sample.json
@@ -45,5 +45,6 @@
       ],
       "driver": "python"
     },
-    "enable_batch_request_support": true
+    "enable_batch_request_support": true,
+    "active": true
 }
diff --git a/apps/coprocess_app_sample_protected.json b/apps/coprocess_app_sample_protected.json
@@ -37,5 +37,6 @@
       },
       "driver": "python"
     },
-    "enable_batch_request_support": true
+    "enable_batch_request_support": true,
+    "active": true
 }
diff --git a/apps/coprocess_grpc_app_sample.json b/apps/coprocess_grpc_app_sample.json
@@ -58,5 +58,6 @@
         ]
       }
     },
-    "enable_batch_request_support": true
+    "enable_batch_request_support": true,
+    "active": true
 }
diff --git a/apps/coprocess_grpc_app_sample_protected.json b/apps/coprocess_grpc_app_sample_protected.json
@@ -61,5 +61,6 @@
       "session_lifetime": 35
     },
     "custom_middleware_bundle": "test-bundle",
-    "enable_batch_request_support": true
+    "enable_batch_request_support": true,
+    "active": true
 }
diff --git a/apps/coprocess_lua_app_sample.json b/apps/coprocess_lua_app_sample.json
@@ -39,5 +39,6 @@
       ],
       "driver": "lua"
     },
-    "enable_batch_request_support": true
+    "enable_batch_request_support": true,
+    "active": true
 }
diff --git a/apps/quickstart.json b/apps/quickstart.json
@@ -30,5 +30,6 @@
         "target_url": "http://httpbin.org/",
         "strip_listen_path": true
     },
-    "do_not_track": true
+    "do_not_track": true,
+    "active": true
 }
diff --git a/gateway_test.go b/gateway_test.go
@@ -889,7 +889,8 @@ const sampleAPI = `{
 	"proxy": {
 		"listen_path": "/sample",
 		"target_url": "` + testHttpAny + `"
-	}
+	},
+	"active": true
 }`
 
 func TestListener(t *testing.T) {
@@ -982,7 +983,8 @@ const apiWithTykListenPathPrefix = `{
 	"proxy": {
 		"listen_path": "/tyk-foo/",
 		"target_url": "` + testHttpAny + `"
-	}
+	},
+	"active": true
 }`
 
 func TestListenPathTykPrefix(t *testing.T) {

diff --git a/oauth_manager_test.go b/oauth_manager_test.go
@@ -65,7 +65,8 @@ const oauthDefinition = `{
 	"proxy": {
 		"listen_path": "/APIID/",
 		"target_url": "` + testHttpAny + `"
-	}
+	},
+	"active": true
 }`
 
 func getOAuthChain(spec *APISpec, muxer *mux.Router) {