From e001f663b3c24df97c545aabc4faad72775069ad Mon Sep 17 00:00:00 2001 From: Ingo Oppermann Date: Thu, 14 Mar 2024 11:21:07 +0100 Subject: [PATCH] Rename RestreamHandler to ProcessHandler --- http/handler/api/playout.go | 14 +++++----- http/handler/api/process.go | 48 ++++++++++++++++---------------- http/handler/api/process_test.go | 4 +-- http/server.go | 4 +-- 4 files changed, 35 insertions(+), 35 deletions(-) diff --git a/http/handler/api/playout.go b/http/handler/api/playout.go index b4b9e382..86ad3ea5 100644 --- a/http/handler/api/playout.go +++ b/http/handler/api/playout.go @@ -29,7 +29,7 @@ import ( // @Failure 500 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/{id}/playout/{inputid}/status [get] -func (h *RestreamHandler) PlayoutStatus(c echo.Context) error { +func (h *ProcessHandler) PlayoutStatus(c echo.Context) error { id := util.PathParam(c, "id") inputid := util.PathParam(c, "inputid") user := util.DefaultContext(c, "user", "") @@ -97,7 +97,7 @@ func (h *RestreamHandler) PlayoutStatus(c echo.Context) error { // @Failure 500 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/{id}/playout/{inputid}/keyframe/{name} [get] -func (h *RestreamHandler) PlayoutKeyframe(c echo.Context) error { +func (h *ProcessHandler) PlayoutKeyframe(c echo.Context) error { id := util.PathParam(c, "id") inputid := util.PathParam(c, "inputid") name := util.PathWildcardParam(c) @@ -156,7 +156,7 @@ func (h *RestreamHandler) PlayoutKeyframe(c echo.Context) error { // @Failure 500 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/{id}/playout/{inputid}/errorframe/encode [get] -func (h *RestreamHandler) PlayoutEncodeErrorframe(c echo.Context) error { +func (h *ProcessHandler) PlayoutEncodeErrorframe(c echo.Context) error { id := util.PathParam(c, "id") inputid := util.PathParam(c, "inputid") user := util.DefaultContext(c, "user", "") @@ -211,7 +211,7 @@ func (h *RestreamHandler) PlayoutEncodeErrorframe(c echo.Context) error { // @Failure 500 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/{id}/playout/{inputid}/errorframe/{name} [post] -func (h *RestreamHandler) PlayoutSetErrorframe(c echo.Context) error { +func (h *ProcessHandler) PlayoutSetErrorframe(c echo.Context) error { id := util.PathParam(c, "id") inputid := util.PathParam(c, "inputid") user := util.DefaultContext(c, "user", "") @@ -267,7 +267,7 @@ func (h *RestreamHandler) PlayoutSetErrorframe(c echo.Context) error { // @Failure 500 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/{id}/playout/{inputid}/reopen [get] -func (h *RestreamHandler) PlayoutReopenInput(c echo.Context) error { +func (h *ProcessHandler) PlayoutReopenInput(c echo.Context) error { id := util.PathParam(c, "id") inputid := util.PathParam(c, "inputid") user := util.DefaultContext(c, "user", "") @@ -321,7 +321,7 @@ func (h *RestreamHandler) PlayoutReopenInput(c echo.Context) error { // @Failure 500 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/{id}/playout/{inputid}/stream [put] -func (h *RestreamHandler) PlayoutSetStream(c echo.Context) error { +func (h *ProcessHandler) PlayoutSetStream(c echo.Context) error { id := util.PathParam(c, "id") inputid := util.PathParam(c, "inputid") user := util.DefaultContext(c, "user", "") @@ -364,7 +364,7 @@ func (h *RestreamHandler) PlayoutSetStream(c echo.Context) error { return c.Blob(response.StatusCode, response.Header.Get("content-type"), data) } -func (h *RestreamHandler) request(method, addr, path, contentType string, data []byte) (*http.Response, error) { +func (h *ProcessHandler) request(method, addr, path, contentType string, data []byte) (*http.Response, error) { endpoint := "http://" + addr + path body := bytes.NewBuffer(data) diff --git a/http/handler/api/process.go b/http/handler/api/process.go index a988ec95..df0d886e 100644 --- a/http/handler/api/process.go +++ b/http/handler/api/process.go @@ -17,15 +17,15 @@ import ( "github.com/lithammer/shortuuid/v4" ) -// The RestreamHandler type provides functions to interact with a Restreamer instance -type RestreamHandler struct { +// The ProcessHandler type provides functions to interact with a Restreamer instance +type ProcessHandler struct { restream restream.Restreamer iam iam.Enforcer } -// NewRestream return a new Restream type. You have to provide a valid Restreamer instance. -func NewRestream(restream restream.Restreamer, iam iam.IAM) *RestreamHandler { - return &RestreamHandler{ +// NewProcess return a new Restream type. You have to provide a valid Restreamer instance. +func NewProcess(restream restream.Restreamer, iam iam.IAM) *ProcessHandler { + return &ProcessHandler{ restream: restream, iam: iam, } @@ -44,7 +44,7 @@ func NewRestream(restream restream.Restreamer, iam iam.IAM) *RestreamHandler { // @Failure 403 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process [post] -func (h *RestreamHandler) Add(c echo.Context) error { +func (h *ProcessHandler) Add(c echo.Context) error { ctxuser := util.DefaultContext(c, "user", "") superuser := util.DefaultContext(c, "superuser", false) @@ -114,7 +114,7 @@ func (h *RestreamHandler) Add(c echo.Context) error { // @Success 200 {array} api.Process // @Security ApiKeyAuth // @Router /api/v3/process [get] -func (h *RestreamHandler) GetAll(c echo.Context) error { +func (h *ProcessHandler) GetAll(c echo.Context) error { ctxuser := util.DefaultContext(c, "user", "") filter := newFilter(util.DefaultQuery(c, "filter", "")) reference := util.DefaultQuery(c, "reference", "") @@ -178,7 +178,7 @@ func (h *RestreamHandler) GetAll(c echo.Context) error { // @Failure 404 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/{id} [get] -func (h *RestreamHandler) Get(c echo.Context) error { +func (h *ProcessHandler) Get(c echo.Context) error { ctxuser := util.DefaultContext(c, "user", "") id := util.PathParam(c, "id") filter := util.DefaultQuery(c, "filter", "") @@ -214,7 +214,7 @@ func (h *RestreamHandler) Get(c echo.Context) error { // @Failure 404 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/{id} [delete] -func (h *RestreamHandler) Delete(c echo.Context) error { +func (h *ProcessHandler) Delete(c echo.Context) error { ctxuser := util.DefaultContext(c, "user", "") superuser := util.DefaultContext(c, "superuser", false) id := util.PathParam(c, "id") @@ -258,7 +258,7 @@ func (h *RestreamHandler) Delete(c echo.Context) error { // @Failure 404 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/{id} [put] -func (h *RestreamHandler) Update(c echo.Context) error { +func (h *ProcessHandler) Update(c echo.Context) error { ctxuser := util.DefaultContext(c, "user", "") superuser := util.DefaultContext(c, "superuser", false) domain := util.DefaultQuery(c, "domain", "") @@ -347,7 +347,7 @@ func (h *RestreamHandler) Update(c echo.Context) error { // @Failure 404 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/{id}/command [put] -func (h *RestreamHandler) Command(c echo.Context) error { +func (h *ProcessHandler) Command(c echo.Context) error { id := util.PathParam(c, "id") ctxuser := util.DefaultContext(c, "user", "") domain := util.DefaultQuery(c, "domain", "") @@ -401,7 +401,7 @@ func (h *RestreamHandler) Command(c echo.Context) error { // @Failure 404 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/{id}/config [get] -func (h *RestreamHandler) GetConfig(c echo.Context) error { +func (h *ProcessHandler) GetConfig(c echo.Context) error { id := util.PathParam(c, "id") ctxuser := util.DefaultContext(c, "user", "") domain := util.DefaultQuery(c, "domain", "") @@ -440,7 +440,7 @@ func (h *RestreamHandler) GetConfig(c echo.Context) error { // @Failure 404 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/{id}/state [get] -func (h *RestreamHandler) GetState(c echo.Context) error { +func (h *ProcessHandler) GetState(c echo.Context) error { id := util.PathParam(c, "id") ctxuser := util.DefaultContext(c, "user", "") domain := util.DefaultQuery(c, "domain", "") @@ -481,7 +481,7 @@ func (h *RestreamHandler) GetState(c echo.Context) error { // @Failure 404 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/{id}/report [get] -func (h *RestreamHandler) GetReport(c echo.Context) error { +func (h *ProcessHandler) GetReport(c echo.Context) error { ctxuser := util.DefaultContext(c, "user", "") domain := util.DefaultQuery(c, "domain", "") id := util.PathParam(c, "id") @@ -592,7 +592,7 @@ func (h *RestreamHandler) GetReport(c echo.Context) error { // @Failure 400 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/report/process [get] -func (h *RestreamHandler) SearchReportHistory(c echo.Context) error { +func (h *ProcessHandler) SearchReportHistory(c echo.Context) error { idpattern := util.DefaultQuery(c, "idpattern", "") refpattern := util.DefaultQuery(c, "refpattern", "") state := util.DefaultQuery(c, "state", "") @@ -646,7 +646,7 @@ func (h *RestreamHandler) SearchReportHistory(c echo.Context) error { // @Failure 404 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/{id}/probe [get] -func (h *RestreamHandler) Probe(c echo.Context) error { +func (h *ProcessHandler) Probe(c echo.Context) error { id := util.PathParam(c, "id") ctxuser := util.DefaultContext(c, "user", "") domain := util.DefaultQuery(c, "domain", "") @@ -686,7 +686,7 @@ func (h *RestreamHandler) Probe(c echo.Context) error { // @Failure 403 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/probe [post] -func (h *RestreamHandler) ProbeConfig(c echo.Context) error { +func (h *ProcessHandler) ProbeConfig(c echo.Context) error { ctxuser := util.DefaultContext(c, "user", "") process := api.ProcessConfig{ @@ -729,7 +729,7 @@ func (h *RestreamHandler) ProbeConfig(c echo.Context) error { // @Success 200 {object} api.Skills // @Security ApiKeyAuth // @Router /api/v3/skills [get] -func (h *RestreamHandler) Skills(c echo.Context) error { +func (h *ProcessHandler) Skills(c echo.Context) error { skills := h.restream.Skills() apiskills := api.Skills{} @@ -747,7 +747,7 @@ func (h *RestreamHandler) Skills(c echo.Context) error { // @Success 200 {object} api.Skills // @Security ApiKeyAuth // @Router /api/v3/skills/reload [get] -func (h *RestreamHandler) ReloadSkills(c echo.Context) error { +func (h *ProcessHandler) ReloadSkills(c echo.Context) error { h.restream.ReloadSkills() skills := h.restream.Skills() @@ -772,7 +772,7 @@ func (h *RestreamHandler) ReloadSkills(c echo.Context) error { // @Failure 404 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/{id}/metadata/{key} [get] -func (h *RestreamHandler) GetProcessMetadata(c echo.Context) error { +func (h *ProcessHandler) GetProcessMetadata(c echo.Context) error { id := util.PathParam(c, "id") key := util.PathParam(c, "key") ctxuser := util.DefaultContext(c, "user", "") @@ -815,7 +815,7 @@ func (h *RestreamHandler) GetProcessMetadata(c echo.Context) error { // @Failure 404 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/process/{id}/metadata/{key} [put] -func (h *RestreamHandler) SetProcessMetadata(c echo.Context) error { +func (h *ProcessHandler) SetProcessMetadata(c echo.Context) error { id := util.PathParam(c, "id") key := util.PathParam(c, "key") ctxuser := util.DefaultContext(c, "user", "") @@ -859,7 +859,7 @@ func (h *RestreamHandler) SetProcessMetadata(c echo.Context) error { // @Failure 400 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/metadata/{key} [get] -func (h *RestreamHandler) GetMetadata(c echo.Context) error { +func (h *ProcessHandler) GetMetadata(c echo.Context) error { key := util.PathParam(c, "key") data, err := h.restream.GetMetadata(key) @@ -882,7 +882,7 @@ func (h *RestreamHandler) GetMetadata(c echo.Context) error { // @Failure 400 {object} api.Error // @Security ApiKeyAuth // @Router /api/v3/metadata/{key} [put] -func (h *RestreamHandler) SetMetadata(c echo.Context) error { +func (h *ProcessHandler) SetMetadata(c echo.Context) error { key := util.PathParam(c, "key") if len(key) == 0 { @@ -969,7 +969,7 @@ func (f filter) String() string { return strings.Join(f.Slice(), ",") } -func (h *RestreamHandler) getProcess(id app.ProcessID, filter filter) (api.Process, error) { +func (h *ProcessHandler) getProcess(id app.ProcessID, filter filter) (api.Process, error) { process, err := h.restream.GetProcess(id) if err != nil { return api.Process{}, err diff --git a/http/handler/api/process_test.go b/http/handler/api/process_test.go index 59f1ee0f..cf360c85 100644 --- a/http/handler/api/process_test.go +++ b/http/handler/api/process_test.go @@ -26,7 +26,7 @@ type Response struct { Data interface{} } -func getDummyRestreamHandler() (*RestreamHandler, error) { +func getDummyRestreamHandler() (*ProcessHandler, error) { rs, err := mock.DummyRestreamer("../../mock") if err != nil { return nil, err @@ -65,7 +65,7 @@ func getDummyRestreamHandler() (*RestreamHandler, error) { iam.AddPolicy("$anon", "$none", []string{"fs"}, "/**", []string{"ANY"}) iam.AddPolicy("$anon", "$none", []string{"process"}, "**", []string{"ANY"}) - handler := NewRestream(rs, iam) + handler := NewProcess(rs, iam) return handler, nil } diff --git a/http/server.go b/http/server.go index 629a7a2f..39ec35a9 100644 --- a/http/server.go +++ b/http/server.go @@ -121,7 +121,7 @@ type server struct { v3handler struct { log *api.LogHandler events *api.EventsHandler - restream *api.RestreamHandler + restream *api.ProcessHandler rtmp *api.RTMPHandler srt *api.SRTHandler config *api.ConfigHandler @@ -267,7 +267,7 @@ func NewServer(config Config) (serverhandler.Server, error) { ) if config.Restream != nil { - s.v3handler.restream = api.NewRestream( + s.v3handler.restream = api.NewProcess( config.Restream, config.IAM, )