[GitHub] [apisix-ingress-controller] gxthrj commented on a change in pull request #398: feat: add tcp route data structures and cache

[GitBox <gi...@apache.org>]

gxthrj commented on a change in pull request #398:
URL: https://github.com/apache/apisix-ingress-controller/pull/398#discussion_r618006188



##########
File path: pkg/apisix/nonexistentclient.go
##########
@@ -132,15 +160,19 @@ type dummyCache struct{}
 
 var _ cache.Cache = &dummyCache{}
 
-func (c *dummyCache) InsertRoute(_ *v1.Route) error              { return nil }
-func (c *dummyCache) InsertSSL(_ *v1.Ssl) error                  { return nil }
-func (c *dummyCache) InsertUpstream(_ *v1.Upstream) error        { return nil }
-func (c *dummyCache) GetRoute(_ string) (*v1.Route, error)       { return nil, cache.ErrNotFound }
-func (c *dummyCache) GetSSL(_ string) (*v1.Ssl, error)           { return nil, cache.ErrNotFound }
-func (c *dummyCache) GetUpstream(_ string) (*v1.Upstream, error) { return nil, cache.ErrNotFound }
-func (c *dummyCache) ListRoutes() ([]*v1.Route, error)           { return nil, nil }
-func (c *dummyCache) ListSSL() ([]*v1.Ssl, error)                { return nil, nil }
-func (c *dummyCache) ListUpstreams() ([]*v1.Upstream, error)     { return nil, nil }
-func (c *dummyCache) DeleteRoute(_ *v1.Route) error              { return nil }
-func (c *dummyCache) DeleteSSL(_ *v1.Ssl) error                  { return nil }
-func (c *dummyCache) DeleteUpstream(_ *v1.Upstream) error        { return nil }
+func (c *dummyCache) InsertRoute(_ *v1.Route) error                    { return nil }
+func (c *dummyCache) InsertSSL(_ *v1.Ssl) error                        { return nil }
+func (c *dummyCache) InsertUpstream(_ *v1.Upstream) error              { return nil }
+func (c *dummyCache) InsertStreamRoute(_ *v1.StreamRoute) error        { return nil }
+func (c *dummyCache) GetRoute(_ string) (*v1.Route, error)             { return nil, cache.ErrNotFound }
+func (c *dummyCache) GetSSL(_ string) (*v1.Ssl, error)                 { return nil, cache.ErrNotFound }
+func (c *dummyCache) GetUpstream(_ string) (*v1.Upstream, error)       { return nil, cache.ErrNotFound }
+func (c *dummyCache) GetStreamRoute(_ string) (*v1.StreamRoute, error) { return nil, cache.ErrNotFound }
+func (c *dummyCache) ListRoutes() ([]*v1.Route, error)                 { return nil, nil }
+func (c *dummyCache) ListSSL() ([]*v1.Ssl, error)                      { return nil, nil }
+func (c *dummyCache) ListUpstreams() ([]*v1.Upstream, error)           { return nil, nil }
+func (c *dummyCache) ListStreamRoutes() ([]*v1.StreamRoute, error)     { return nil, nil }
+func (c *dummyCache) DeleteRoute(_ *v1.Route) error                    { return nil }
+func (c *dummyCache) DeleteSSL(_ *v1.Ssl) error                        { return nil }
+func (c *dummyCache) DeleteUpstream(_ *v1.Upstream) error              { return nil }
+func (c *dummyCache) DeleteStreamRoute(_ *v1.StreamRoute) error        { return nil }

Review comment:
       Can these methods be refactored to be together, 
   such as, dummyCache.Insert(), dummyCache.List()

##########
File path: pkg/apisix/stream_route.go
##########
@@ -0,0 +1,223 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements.  See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License.  You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package apisix
+
+import (
+	"bytes"
+	"context"
+	"encoding/json"
+
+	"go.uber.org/zap"
+
+	"github.com/apache/apisix-ingress-controller/pkg/apisix/cache"
+	"github.com/apache/apisix-ingress-controller/pkg/id"
+	"github.com/apache/apisix-ingress-controller/pkg/log"
+	v1 "github.com/apache/apisix-ingress-controller/pkg/types/apisix/v1"
+)
+
+type streamRouteClient struct {
+	url     string
+	cluster *cluster
+}
+
+func newStreamRouteClient(c *cluster) StreamRoute {
+	return &streamRouteClient{
+		url:     c.baseURL + "/stream_routes",
+		cluster: c,
+	}
+}
+
+// Get returns the StreamRoute.
+// FIXME, currently if caller pass a non-existent resource, the Get always passes
+// through cache.
+func (r *streamRouteClient) Get(ctx context.Context, name string) (*v1.StreamRoute, error) {
+	log.Debugw("try to look up stream_route",
+		zap.String("name", name),
+		zap.String("url", r.url),
+		zap.String("cluster", "default"),
+	)
+	rid := id.GenID(name)
+	streamRoute, err := r.cluster.cache.GetStreamRoute(rid)
+	if err == nil {
+		return streamRoute, nil
+	}
+	if err != cache.ErrNotFound {
+		log.Errorw("failed to find stream_route in cache, will try to lookup from APISIX",
+			zap.String("name", name),
+			zap.Error(err),
+		)
+	} else {
+		log.Debugw("failed to find stream_route in cache, will try to lookup from APISIX",
+			zap.String("name", name),
+			zap.Error(err),
+		)
+	}
+
+	// TODO Add mutex here to avoid dog-pile effection.
+	url := r.url + "/" + rid
+	resp, err := r.cluster.getResource(ctx, url)
+	if err != nil {
+		if err == cache.ErrNotFound {
+			log.Warnw("stream_route not found",
+				zap.String("name", name),
+				zap.String("url", url),
+				zap.String("cluster", "default"),
+			)
+		} else {
+			log.Errorw("failed to get stream_route from APISIX",
+				zap.String("name", name),
+				zap.String("url", url),
+				zap.String("cluster", "default"),
+				zap.Error(err),
+			)
+		}
+		return nil, err
+	}
+
+	streamRoute, err = resp.Item.streamRoute()
+	if err != nil {
+		log.Errorw("failed to convert stream_route item",
+			zap.String("url", r.url),
+			zap.String("stream_route_key", resp.Item.Key),
+			zap.String("stream_route_value", string(resp.Item.Value)),
+			zap.Error(err),
+		)
+		return nil, err
+	}
+
+	if err := r.cluster.cache.InsertStreamRoute(streamRoute); err != nil {
+		log.Errorf("failed to reflect route create to cache: %s", err)
+		return nil, err
+	}
+	return streamRoute, nil
+}
+
+// List is only used in cache warming up. So here just pass through
+// to APISIX.
+func (r *streamRouteClient) List(ctx context.Context) ([]*v1.StreamRoute, error) {
+	log.Debugw("try to list stream_routes in APISIX",
+		zap.String("cluster", "default"),
+		zap.String("url", r.url),
+	)
+	streamRouteItems, err := r.cluster.listResource(ctx, r.url)
+	if err != nil {
+		log.Errorf("failed to list stream_routes: %s", err)
+		return nil, err
+	}
+
+	var items []*v1.StreamRoute
+	for i, item := range streamRouteItems.Node.Items {
+		streamRoute, err := item.streamRoute()
+		if err != nil {
+			log.Errorw("failed to convert stream_route item",
+				zap.String("url", r.url),
+				zap.String("stream_route_key", item.Key),
+				zap.String("stream_route_value", string(item.Value)),
+				zap.Error(err),
+			)
+			return nil, err
+		}
+
+		items = append(items, streamRoute)
+		log.Debugf("list stream_route #%d, body: %s", i, string(item.Value))
+	}
+	return items, nil
+}
+
+func (r *streamRouteClient) Create(ctx context.Context, obj *v1.StreamRoute) (*v1.StreamRoute, error) {
+	log.Debugw("try to create stream_route",
+		zap.String("id", obj.ID),
+		zap.Int32("server_port", obj.ServerPort),
+		zap.String("cluster", "default"),
+		zap.String("url", r.url),
+	)
+
+	if err := r.cluster.HasSynced(ctx); err != nil {
+		return nil, err
+	}
+	data, err := json.Marshal(obj)
+	if err != nil {
+		return nil, err
+	}
+
+	url := r.url + "/" + obj.ID
+	log.Debugw("creating stream_route", zap.ByteString("body", data), zap.String("url", url))
+	resp, err := r.cluster.createResource(ctx, url, bytes.NewReader(data))
+	if err != nil {
+		log.Errorf("failed to create stream_route: %s", err)
+		return nil, err
+	}
+
+	streamRoute, err := resp.Item.streamRoute()
+	if err != nil {
+		return nil, err
+	}
+	if err := r.cluster.cache.InsertStreamRoute(streamRoute); err != nil {
+		log.Errorf("failed to reflect stream_route create to cache: %s", err)
+		return nil, err
+	}
+	return streamRoute, nil
+}
+
+func (r *streamRouteClient) Delete(ctx context.Context, obj *v1.StreamRoute) error {
+	log.Debugw("try to delete stream_route",
+		zap.String("id", obj.ID),
+		zap.String("cluster", "default"),
+		zap.String("url", r.url),
+	)
+	if err := r.cluster.HasSynced(ctx); err != nil {
+		return err
+	}
+	url := r.url + "/" + obj.ID
+	if err := r.cluster.deleteResource(ctx, url); err != nil {
+		return err
+	}
+	if err := r.cluster.cache.DeleteStreamRoute(obj); err != nil {
+		log.Errorf("failed to reflect stream_route delete to cache: %s", err)
+		return err
+	}
+	return nil
+}
+
+func (r *streamRouteClient) Update(ctx context.Context, obj *v1.StreamRoute) (*v1.StreamRoute, error) {
+	log.Debugw("try to update stream_route",
+		zap.String("id", obj.ID),
+		zap.String("cluster", "default"),
+		zap.String("url", r.url),
+	)
+	if err := r.cluster.HasSynced(ctx); err != nil {
+		return nil, err
+	}
+	// FIXME use unified v1.Route, removing routeReqBody.

Review comment:
       Confusing comments.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org