Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow slashes in promise name #160

Merged
merged 1 commit into from
Dec 21, 2023
Merged

Allow slashes in promise name #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions internal/app/subsystems/api/http/http.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ func New(api api.API, config *Config) api.Subsystem {
// Promises API
r.POST("/promises", s.createPromise)
r.GET("/promises", s.searchPromises)
r.GET("/promises/:id", s.readPromise)
r.PATCH("/promises/:id", s.completePromise)
r.GET("/promises/*id", s.readPromise)
r.PATCH("/promises/*id", s.completePromise)

// Schedules API
r.POST("/schedules", s.createSchedule)
r.GET("/schedules/:id", s.readSchedule)
r.DELETE("/schedules/:id", s.deleteSchedule)
r.GET("/schedules/*id", s.readSchedule)
r.DELETE("/schedules/*id", s.deleteSchedule)

return &Http{
config: config,
Expand Down
46 changes: 34 additions & 12 deletions internal/app/subsystems/api/http/http_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,28 @@ func TestHttpServer(t *testing.T) {
},
status: 200,
},
{
name: "ReadPromiseWithSlash",
path: "promises/foo/bar",
method: "GET",
req: &t_api.Request{
Kind: t_api.ReadPromise,
ReadPromise: &t_api.ReadPromiseRequest{
Id: "foo/bar",
},
},
res: &t_api.Response{
Kind: t_api.ReadPromise,
ReadPromise: &t_api.ReadPromiseResponse{
Status: t_api.StatusOK,
Promise: &promise.Promise{
Id: "foo/bar",
State: promise.Pending,
},
},
},
status: 200,
},
{
name: "ReadPromiseNotFound",
path: "promises/bar",
Expand Down Expand Up @@ -302,7 +324,7 @@ func TestHttpServer(t *testing.T) {
"Strict": "true",
},
body: []byte(`{
"id": "foo",
"id": "foo/bar",
"param": {
"headers": {"a":"a","b":"b","c":"c"},
"data": "cGVuZGluZw=="
Expand All @@ -312,7 +334,7 @@ func TestHttpServer(t *testing.T) {
req: &t_api.Request{
Kind: t_api.CreatePromise,
CreatePromise: &t_api.CreatePromiseRequest{
Id: "foo",
Id: "foo/bar",
IdempotencyKey: test.IdempotencyKeyToPointer("bar"),
Strict: true,
Param: promise.Value{
Expand All @@ -327,7 +349,7 @@ func TestHttpServer(t *testing.T) {
CreatePromise: &t_api.CreatePromiseResponse{
Status: t_api.StatusCreated,
Promise: &promise.Promise{
Id: "foo",
Id: "foo/bar",
State: promise.Pending,
},
},
Expand Down Expand Up @@ -369,7 +391,7 @@ func TestHttpServer(t *testing.T) {
},
{
name: "CancelPromise",
path: "promises/foo",
path: "promises/foo/bar",
method: "PATCH",
headers: map[string]string{
"Idempotency-Key": "bar",
Expand All @@ -385,7 +407,7 @@ func TestHttpServer(t *testing.T) {
req: &t_api.Request{
Kind: t_api.CancelPromise,
CancelPromise: &t_api.CancelPromiseRequest{
Id: "foo",
Id: "foo/bar",
IdempotencyKey: test.IdempotencyKeyToPointer("bar"),
Strict: true,
Value: promise.Value{
Expand All @@ -399,7 +421,7 @@ func TestHttpServer(t *testing.T) {
CancelPromise: &t_api.CompletePromiseResponse{
Status: t_api.StatusCreated,
Promise: &promise.Promise{
Id: "foo",
Id: "foo/bar",
State: promise.Canceled,
},
},
Expand Down Expand Up @@ -439,7 +461,7 @@ func TestHttpServer(t *testing.T) {
},
{
name: "ResolvePromise",
path: "promises/foo",
path: "promises/foo/bar",
method: "PATCH",
headers: map[string]string{
"Idempotency-Key": "bar",
Expand All @@ -455,7 +477,7 @@ func TestHttpServer(t *testing.T) {
req: &t_api.Request{
Kind: t_api.ResolvePromise,
ResolvePromise: &t_api.ResolvePromiseRequest{
Id: "foo",
Id: "foo/bar",
IdempotencyKey: test.IdempotencyKeyToPointer("bar"),
Strict: true,
Value: promise.Value{
Expand All @@ -469,7 +491,7 @@ func TestHttpServer(t *testing.T) {
ResolvePromise: &t_api.CompletePromiseResponse{
Status: t_api.StatusCreated,
Promise: &promise.Promise{
Id: "foo",
Id: "foo/bar",
State: promise.Resolved,
},
},
Expand Down Expand Up @@ -509,7 +531,7 @@ func TestHttpServer(t *testing.T) {
},
{
name: "RejectPromise",
path: "promises/foo",
path: "promises/foo/bar",
method: "PATCH",
headers: map[string]string{
"Idempotency-Key": "bar",
Expand All @@ -525,7 +547,7 @@ func TestHttpServer(t *testing.T) {
req: &t_api.Request{
Kind: t_api.RejectPromise,
RejectPromise: &t_api.RejectPromiseRequest{
Id: "foo",
Id: "foo/bar",
IdempotencyKey: test.IdempotencyKeyToPointer("bar"),
Strict: true,
Value: promise.Value{
Expand All @@ -539,7 +561,7 @@ func TestHttpServer(t *testing.T) {
RejectPromise: &t_api.CompletePromiseResponse{
Status: t_api.StatusCreated,
Promise: &promise.Promise{
Id: "foo",
Id: "foo/bar",
State: promise.Rejected,
},
},
Expand Down
8 changes: 5 additions & 3 deletions internal/app/subsystems/api/http/promise.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,15 @@ import (
// Read Promise

func (s *server) readPromise(c *gin.Context) {
id := ExtractId(c.Param("id"))

var header service.Header
if err := c.ShouldBindHeader(&header); err != nil {
c.JSON(http.StatusBadRequest, api.HandleValidationError(err))
return
}

resp, err := s.service.ReadPromise(c.Param("id"), &header)
resp, err := s.service.ReadPromise(id, &header)
if err != nil {
var apiErr *api.APIErrorResponse
if errors.As(err, &apiErr) {
Expand Down Expand Up @@ -97,6 +99,8 @@ func (s *server) createPromise(c *gin.Context) {
// Complete Promise

func (s *server) completePromise(c *gin.Context) {
id := ExtractId(c.Param("id"))

var header service.CompletePromiseHeader
if err := c.ShouldBindHeader(&header); err != nil {
c.JSON(http.StatusBadRequest, api.HandleValidationError(err))
Expand All @@ -109,8 +113,6 @@ func (s *server) completePromise(c *gin.Context) {
return
}

id := c.Param("id")

var (
resp *t_api.CompletePromiseResponse
err error
Expand Down
8 changes: 6 additions & 2 deletions internal/app/subsystems/api/http/schedule.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ func (s *server) createSchedule(c *gin.Context) {
// READ

func (s *server) readSchedule(c *gin.Context) {
res, err := s.service.ReadSchedule(c.Param("id"))
id := ExtractId(c.Param("id"))

res, err := s.service.ReadSchedule(id)
if err != nil {
var apiErr *api.APIErrorResponse
if errors.As(err, &apiErr) {
Expand All @@ -60,7 +62,9 @@ func (s *server) readSchedule(c *gin.Context) {
// DELETE

func (s *server) deleteSchedule(c *gin.Context) {
res, err := s.service.DeleteSchedule(c.Param("id"))
id := ExtractId(c.Param("id"))

res, err := s.service.DeleteSchedule(id)
if err != nil {
var apiErr *api.APIErrorResponse
if errors.As(err, &apiErr) {
Expand Down
8 changes: 8 additions & 0 deletions internal/app/subsystems/api/http/util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
package http

import "github.com/resonatehq/resonate/internal/util"

func ExtractId(id string) string {
util.Assert(len(id) > 0 && id[0] == '/', "invalid id, gin trailing ids should start with '/'")
return id[1:]
}