Adding a find endpoint route

Author: COMTOP1

controllers/v1/stream/stream.go

@@ -229,6 +229,38 @@ func (r *Repos) ListStreams(c echo.Context) error {
 	return c.JSON(http.StatusOK, utils.NonNil(endpoints))
 }
 
+// FindStream handles finding a stream
+// @Summary Finds stream
+// @Description finds existing stream
+// @ID find-stream
+// @Tags stream-endpoints
+// @Accept json
+// @Param endpoint body stream.FindEndpoint true "Find Endpoint object"
+// @Success 200 body stream.FindEndpoint
+// @Router /v1/internal/streams/find [get]
+func (r *Repos) FindStream(c echo.Context) error {
+	var findEndpoint stream.FindEndpoint
+
+	err := c.Bind(&findEndpoint)
+	if err != nil {
+		err = fmt.Errorf("failed to bind to request json: %w", err)
+		return echo.NewHTTPError(http.StatusBadRequest, err)
+	}
+
+	if findEndpoint.EndpointID == 0 && (len(findEndpoint.Application) == 0 || len(findEndpoint.Name) == 0) {
+		err = fmt.Errorf("failed to bind to request json: missing application, name or endpoint id")
+		return echo.NewHTTPError(http.StatusBadRequest, err)
+	}
+
+	_, err = r.stream.FindEndpoint(c.Request().Context(), &findEndpoint)
+	if err != nil {
+		err = fmt.Errorf("failed to find endpoint: %w", err)
+		return echo.NewHTTPError(http.StatusInternalServerError, err)
+	}
+
+	return c.JSON(http.StatusOK, utils.NonNil(findEndpoint))
+}
+
 // NewStream handles a creating a stream endpoint
 //
 // @Summary NewStream stream endpoint

router.go

@@ -305,6 +305,7 @@ func (r *Router) loadRoutes() {
 			streamsAuthed := internal.Group("/streams", r.access.ManageStreamAuthMiddleware)
 			{
 				streamsAuthed.GET("", r.stream.ListStreams)
+				streamsAuthed.GET("/find", r.stream.FindStream)
 				streamsAuthed.POST("", r.stream.NewStream)
 				streamAuthed := streamsAuthed.Group("/:endpointid")
 				{

services/stream/stream.go

@@ -15,6 +15,7 @@ type (
 	// Repo represents all stream endpoint interactions
 	Repo interface {
 		ListEndpoints(ctx context.Context) ([]EndpointDB, error)
+		FindEndpoint(ctx context.Context, findEndpoint FindEndpoint) (EndpointDB, error)
 		GetEndpointByID(ctx context.Context, endpointID int) (EndpointDB, error)
 		GetEndpointByApplicationNamePwd(ctx context.Context, application, name, pwd string) (EndpointDB, error)
 
@@ -63,6 +64,18 @@ type (
 		AutoRemove bool `json:"autoRemove,omitempty"`
 	}
 
+	// FindEndpoint used to find an endpoint
+	FindEndpoint struct {
+		// EndpointID is the unique database id of the stream
+		EndpointID int `json:"endpointId,omitempty"`
+		// Application defines which RTMP application this is valid for
+		Application string `json:"application,omitempty"`
+		// Name is the unique name given in an application
+		Name string `json:"name,omitempty"`
+		// Pwd defines an extra layer of security for authentication
+		Pwd string `json:"pwd,omitempty"`
+	}
+
 	// NewEditEndpoint encapsulates the creation of a stream endpoint
 	NewEditEndpoint struct {
 		// Application defines which RTMP application this is valid for
@@ -114,6 +127,37 @@ func (s *Store) ListEndpoints(ctx context.Context) ([]EndpointDB, error) {
 	return e, nil
 }
 
+func (s *Store) FindEndpoint(ctx context.Context, findEndpoint *FindEndpoint) (EndpointDB, error) {
+	var e EndpointDB
+
+	builder := utils.PSQL().Select("*").
+		From("web_api.stream_endpoints").
+		Where(sq.Or{
+			sq.Eq{"endpoint_id": findEndpoint.EndpointID},
+			sq.And{
+				sq.Eq{"application": findEndpoint.Application},
+				sq.Eq{"name": findEndpoint.Name},
+				sq.Eq{"pwd": findEndpoint.Pwd},
+			},
+		})
+
+	sql, args, err := builder.ToSql()
+	if err != nil {
+		panic(fmt.Errorf("failed to build sql for FindEndpoint: %w", err))
+	}
+
+	err = s.db.GetContext(ctx, &e, sql, args...)
+	if err != nil {
+		return EndpointDB{}, fmt.Errorf("failed to find endpoint: %w", err)
+	}
+
+	findEndpoint.EndpointID = e.EndpointID
+	findEndpoint.Application = e.Application
+	findEndpoint.Name = e.Name
+
+	return e, nil
+}
+
 func (s *Store) GetEndpointByID(ctx context.Context, endpointID int) (EndpointDB, error) {
 	var e EndpointDB
 

swagger/docs.go

@@ -2187,6 +2187,38 @@ const docTemplate = `{
                 }
             }
         },
+        "/v1/internal/streams/find": {
+            "get": {
+                "description": "finds existing stream",
+                "consumes": [
+                    "application/json"
+                ],
+                "tags": [
+                    "stream-endpoints"
+                ],
+                "summary": "Finds stream",
+                "operationId": "find-stream",
+                "parameters": [
+                    {
+                        "description": "Find Endpoint object",
+                        "name": "endpoint",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/stream.FindEndpoint"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "type": "body"
+                        }
+                    }
+                }
+            }
+        },
         "/v1/internal/streams/{endpointid}": {
             "put": {
                 "consumes": [
@@ -4027,6 +4059,27 @@ const docTemplate = `{
                 }
             }
         },
+        "stream.FindEndpoint": {
+            "type": "object",
+            "properties": {
+                "application": {
+                    "description": "Application defines which RTMP application this is valid for",
+                    "type": "string"
+                },
+                "endpointId": {
+                    "description": "EndpointID is the unique database id of the stream",
+                    "type": "integer"
+                },
+                "name": {
+                    "description": "Name is the unique name given in an application",
+                    "type": "string"
+                },
+                "pwd": {
+                    "description": "Pwd defines an extra layer of security for authentication",
+                    "type": "string"
+                }
+            }
+        },
         "stream.NewEditEndpoint": {
             "type": "object",
             "properties": {