Merge pull request #172 from movio/171-enablingdisabling-schema-intro…

…spection

Allow disabling of introspection via config

config.go

@@ -25,6 +25,7 @@ type PluginConfig struct {
 type Config struct {
 	IdFieldName            string    `json:"id-field-name"`
 	GatewayListenAddress   string    `json:"gateway-address"`
+	DisableIntrospection   bool      `json:"disable-introspection"`
 	MetricsListenAddress   string    `json:"metrics-address"`
 	PrivateListenAddress   string    `json:"private-address"`
 	GatewayPort            int       `json:"gateway-port"`

config.json.example

@@ -7,6 +7,7 @@
   "poll-interval": "5s",
   "max-requests-per-query": 50,
   "max-client-response-size": 1048576,
+  "disable-introspection": false,
   "plugins": [
     {
       "name": "admin-ui"

executable_schema.go

@@ -207,14 +207,16 @@ func (s *ExecutableSchema) ExecuteQuery(ctx context.Context) *graphql.Response {
 		errs = append(errs, result.Errors...)
 	}
 
-	introspectionData := resolveIntrospectionFields(ctx, operation.SelectionSet, filteredSchema)
-	if len(introspectionData) > 0 {
-		results = append([]executionResult{
-			{
-				ServiceURL: internalServiceName,
-				Data:       introspectionData,
-			},
-		}, results...)
+	if !operationCtx.DisableIntrospection {
+		introspectionData := resolveIntrospectionFields(ctx, operation.SelectionSet, filteredSchema)
+		if len(introspectionData) > 0 {
+			results = append([]executionResult{
+				{
+					ServiceURL: internalServiceName,
+					Data:       introspectionData,
+				},
+			}, results...)
+		}
 	}
 
 	timings["execution"] = time.Since(executionStart).Round(time.Millisecond).String()

gateway.go

@@ -36,7 +36,7 @@ func (g *Gateway) UpdateSchemas(interval time.Duration) {
 }
 
 // Router returns the public http handler
-func (g *Gateway) Router() http.Handler {
+func (g *Gateway) Router(cfg *Config) http.Handler {
 	mux := http.NewServeMux()
 
 	// Duplicated from `handler.NewDefaultServer` minus
@@ -46,7 +46,9 @@ func (g *Gateway) Router() http.Handler {
 	gatewayHandler.AddTransport(transport.GET{})
 	gatewayHandler.AddTransport(transport.POST{})
 	gatewayHandler.AddTransport(transport.MultipartForm{})
-	gatewayHandler.Use(extension.Introspection{})
+	if !cfg.DisableIntrospection {
+		gatewayHandler.Use(extension.Introspection{})
+	}
 
 	mux.Handle("/query",
 		applyMiddleware(

gateway_test.go

@@ -65,7 +65,7 @@ func TestGatewayQuery(t *testing.T) {
 	req.Header.Set("Content-Type", "application/json; charset=utf-8")
 	req.Header.Set("Accept", "application/json; charset=utf-8")
 
-	gtw.Router().ServeHTTP(rec, req)
+	gtw.Router(&Config{}).ServeHTTP(rec, req)
 	assert.Equal(t, http.StatusOK, rec.Code)
 	assert.JSONEq(t, `{"data": { "test": "Hello" }}`, rec.Body.String())
 }
@@ -74,7 +74,7 @@ func TestRequestJSONBodyLogging(t *testing.T) {
 	logrusLock.Lock()
 	defer logrusLock.Unlock()
 
-	server := NewGateway(NewExecutableSchema(nil, 50, nil), nil).Router()
+	server := NewGateway(NewExecutableSchema(nil, 50, nil), nil).Router(&Config{})
 
 	body := map[string]interface{}{
 		"foo": "bar",
@@ -106,7 +106,7 @@ func TestRequestInvalidJSONBodyLogging(t *testing.T) {
 	logrusLock.Lock()
 	defer logrusLock.Unlock()
 
-	server := NewGateway(nil, nil).Router()
+	server := NewGateway(nil, nil).Router(&Config{})
 
 	body := `{ "invalid": "json`
 	jr, jw := io.Pipe()
@@ -135,7 +135,7 @@ func TestRequestTextBodyLogging(t *testing.T) {
 	logrusLock.Lock()
 	defer logrusLock.Unlock()
 
-	server := NewGateway(nil, nil).Router()
+	server := NewGateway(nil, nil).Router(&Config{})
 
 	body := `the request body`
 	jr, jw := io.Pipe()

main.go

@@ -48,7 +48,7 @@ func Main() {
 
 	go runHandler(ctx, &wg, "metrics", cfg.MetricAddress(), NewMetricsHandler())
 	go runHandler(ctx, &wg, "private", cfg.PrivateAddress(), gtw.PrivateRouter())
-	go runHandler(ctx, &wg, "public", cfg.GatewayAddress(), gtw.Router())
+	go runHandler(ctx, &wg, "public", cfg.GatewayAddress(), gtw.Router(cfg))
 
 	wg.Wait()
 }