Skip to content

[raft/scd] Extract get and query subscription #1644

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

Merged
mickmis merged 1 commit into from
Aug 31, 2026
+113 −78
Merged

[raft/scd] Extract get and query subscription #1644

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
109 changes: 109 additions & 0 deletions pkg/scd/actions/subscription.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
scdmodels "github.com/interuss/dss/pkg/scd/models"
"github.com/interuss/dss/pkg/scd/repos"
dssstore "github.com/interuss/dss/pkg/store"
"github.com/interuss/dss/pkg/timestamp"
"github.com/interuss/stacktrace"
)

Expand All @@ -18,6 +19,18 @@ func init() {
Decode: dssstore.DecodeJSON[*restapi.DeleteSubscriptionRequest],
Execute: ExecuteDeleteSubscription,
}
Registry[restapi.GetSubscriptionOperationID] = dssstore.OperationHandler[repos.Repository]{
Encode: dssstore.EncodeJSON,
Decode: dssstore.DecodeJSON[*restapi.GetSubscriptionRequest],
Execute: ExecuteGetSubscription,
IsReadOnly: true,
}
Registry[restapi.QuerySubscriptionsOperationID] = dssstore.OperationHandler[repos.Repository]{
Encode: dssstore.EncodeJSON,
Decode: dssstore.DecodeJSON[*restapi.QuerySubscriptionsRequest],
Execute: ExecuteQuerySubscriptions,
IsReadOnly: true,
}
}

func ExecuteDeleteSubscription(ctx context.Context, repo repos.Repository, request dssstore.OperationRequest) (any, error) {
Expand Down Expand Up @@ -71,3 +84,99 @@ func ExecuteDeleteSubscription(ctx context.Context, repo repos.Repository, reque

return &restapi.DeleteSubscriptionResponse{Subscription: *p}, nil
}

func ExecuteGetSubscription(ctx context.Context, repo repos.Repository, request dssstore.OperationRequest) (any, error) {
req, ok := request.(*restapi.GetSubscriptionRequest)
if !ok {
return nil, stacktrace.NewError("unexpected request type %T for operation %q", request, restapi.GetSubscriptionOperationID)
}

// Retrieve Subscription ID
id, err := dssmodels.IDFromString(string(req.Subscriptionid))
if err != nil {
return nil, stacktrace.NewErrorWithCode(dsserr.BadRequest, "Invalid ID format: `%s`", req.Subscriptionid)
}

// Get Subscription from Store
sub, err := repo.GetSubscription(ctx, id)
if err != nil {
return nil, stacktrace.Propagate(err, "Could not get Subscription from repo")
}
if sub == nil {
return nil, stacktrace.NewErrorWithCode(dsserr.NotFound, "Subscription %s not found", id.String())
}

// Check if the client is authorized to view this Subscription
if dssmodels.Manager(*req.Auth.ClientID) != sub.Manager {
return nil, stacktrace.Propagate(
stacktrace.NewErrorWithCode(dsserr.PermissionDenied, "Subscription is owned by different client"),
"Subscription owned by %s, but %s attempted to view", sub.Manager, *req.Auth.ClientID)
}

// Get dependent Operations
dependentOps, err := repo.GetDependentOperationalIntents(ctx, id)
if err != nil {
return nil, stacktrace.Propagate(err, "Could not find dependent Operations")
}

// Convert Subscription to REST
p, err := sub.ToRest(dependentOps)
if err != nil {
return nil, stacktrace.Propagate(err, "Unable to convert Subscription to REST")
}

// Return response to client
return &restapi.GetSubscriptionResponse{Subscription: *p}, nil
}

func ExecuteQuerySubscriptions(ctx context.Context, repo repos.Repository, request dssstore.OperationRequest) (any, error) {
req, ok := request.(*restapi.QuerySubscriptionsRequest)
if !ok {
return nil, stacktrace.NewError("unexpected request type %T for operation %q", request, restapi.QuerySubscriptionsOperationID)
}

// Retrieve the area of interest parameter
aoi := req.Body.AreaOfInterest
if aoi == nil {
return nil, stacktrace.NewErrorWithCode(dsserr.BadRequest, "Missing area_of_interest")
}

// Parse area of interest to common Volume4D
vol4, err := scdmodels.Volume4DFromSCDRest(aoi)
if err != nil {
return nil, stacktrace.PropagateWithCode(err, dsserr.BadRequest, "Failed to convert to internal geometry model")
}

// Perform search query on Store
subs, err := repo.SearchSubscriptions(ctx, vol4)
if err != nil {
return nil, stacktrace.Propagate(err, "Error searching Subscriptions in repo")
}

nowMarker := timestamp.MustGetRequestTimestamp(ctx)

// Return response to client
response := &restapi.QuerySubscriptionsResponse{
Subscriptions: make([]restapi.Subscription, 0),
}
for _, sub := range subs {
// Do not return subscriptions which are expired.
// This implementation decision is described and motivated in https://github.com/interuss/tsc/pull/12.
isExpired := sub.EndTime.Before(nowMarker)
if !isExpired && sub.Manager == dssmodels.Manager(*req.Auth.ClientID) {
// Get dependent Operations
dependentOps, err := repo.GetDependentOperationalIntents(ctx, sub.ID)
if err != nil {
return nil, stacktrace.Propagate(err, "Could not find dependent Operations")
}

p, err := sub.ToRest(dependentOps)
if err != nil {
return nil, stacktrace.Propagate(err, "Error converting Subscription model to REST")
}
response.Subscriptions = append(response.Subscriptions, *p)
}
}

return response, nil
}
82 changes: 4 additions & 78 deletions pkg/scd/subscriptions_handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package scd

import (
"context"
"time"

"github.com/golang/geo/s2"
"github.com/interuss/dss/pkg/api"
Expand Down Expand Up @@ -290,7 +289,7 @@ func (a *Server) GetSubscription(ctx context.Context, req *restapi.GetSubscripti
) restapi.GetSubscriptionResponseSet {

// Retrieve Subscription ID
id, err := dssmodels.IDFromString(string(req.Subscriptionid))
_, err := dssmodels.IDFromString(string(req.Subscriptionid))
if err != nil {
return restapi.GetSubscriptionResponseSet{Response400: &restapi.ErrorResponse{
Message: dsserr.Handle(ctx, stacktrace.NewErrorWithCode(dsserr.BadRequest, "Invalid ID format: `%s`", req.Subscriptionid))}}
Expand All @@ -302,45 +301,7 @@ func (a *Server) GetSubscription(ctx context.Context, req *restapi.GetSubscripti
Message: dsserr.Handle(ctx, stacktrace.NewErrorWithCode(dsserr.PermissionDenied, "Missing owner"))}}
}

var response *restapi.GetSubscriptionResponse
action := func(ctx context.Context, r repos.Repository) (err error) {
// Get Subscription from Store
sub, err := r.GetSubscription(ctx, id)
if err != nil {
return stacktrace.Propagate(err, "Could not get Subscription from repo")
}
if sub == nil {
return stacktrace.NewErrorWithCode(dsserr.NotFound, "Subscription %s not found", id.String())
}

// Check if the client is authorized to view this Subscription
if dssmodels.Manager(*req.Auth.ClientID) != sub.Manager {
return stacktrace.Propagate(
stacktrace.NewErrorWithCode(dsserr.PermissionDenied, "Subscription is owned by different client"),
"Subscription owned by %s, but %s attempted to view", sub.Manager, *req.Auth.ClientID)
}

// Get dependent Operations
dependentOps, err := r.GetDependentOperationalIntents(ctx, id)
if err != nil {
return stacktrace.Propagate(err, "Could not find dependent Operations")
}

// Convert Subscription to REST
p, err := sub.ToRest(dependentOps)
if err != nil {
return stacktrace.Propagate(err, "Unable to convert Subscription to REST")
}

// Return response to client
response = &restapi.GetSubscriptionResponse{
Subscription: *p,
}

return nil
}

_, err = a.Store.Transact(ctx, dssstore.NewFuncOperation(action))
response, err := dssstore.TransactWithResult[repos.Repository, *restapi.GetSubscriptionResponse](ctx, a.Store, req)
if err != nil {
err = stacktrace.Propagate(err, "Could not get subscription")
errResp := &restapi.ErrorResponse{Message: dsserr.Handle(ctx, err)}
Expand All @@ -363,7 +324,6 @@ func (a *Server) GetSubscription(ctx context.Context, req *restapi.GetSubscripti
// QuerySubscriptions queries existing subscriptions in the given bounds.
func (a *Server) QuerySubscriptions(ctx context.Context, req *restapi.QuerySubscriptionsRequest,
) restapi.QuerySubscriptionsResponseSet {
nowMarker := time.Now()

if req.BodyParseError != nil {
return restapi.QuerySubscriptionsResponseSet{Response400: &restapi.ErrorResponse{
Expand All @@ -378,7 +338,7 @@ func (a *Server) QuerySubscriptions(ctx context.Context, req *restapi.QuerySubsc
}

// Parse area of interest to common Volume4D
vol4, err := scdmodels.Volume4DFromSCDRest(aoi)
_, err := scdmodels.Volume4DFromSCDRest(aoi)
if err != nil {
return restapi.QuerySubscriptionsResponseSet{Response400: &restapi.ErrorResponse{
Message: dsserr.Handle(ctx, stacktrace.PropagateWithCode(err, dsserr.BadRequest, "Failed to convert to internal geometry model"))}}
Expand All @@ -390,41 +350,7 @@ func (a *Server) QuerySubscriptions(ctx context.Context, req *restapi.QuerySubsc
Message: dsserr.Handle(ctx, stacktrace.NewErrorWithCode(dsserr.PermissionDenied, "Missing owner"))}}
}

var response *restapi.QuerySubscriptionsResponse
action := func(ctx context.Context, r repos.Repository) (err error) {
// Perform search query on Store
subs, err := r.SearchSubscriptions(ctx, vol4)
if err != nil {
return stacktrace.Propagate(err, "Error searching Subscriptions in repo")
}

// Return response to client
response = &restapi.QuerySubscriptionsResponse{
Subscriptions: make([]restapi.Subscription, 0),
}
for _, sub := range subs {
// Do not return subscriptions which are expired.
// This implementation decision is described and motivated in https://github.com/interuss/tsc/pull/12.
isExpired := sub.EndTime.Before(nowMarker)
if !isExpired && sub.Manager == dssmodels.Manager(*req.Auth.ClientID) {
// Get dependent Operations
dependentOps, err := r.GetDependentOperationalIntents(ctx, sub.ID)
if err != nil {
return stacktrace.Propagate(err, "Could not find dependent Operations")
}

p, err := sub.ToRest(dependentOps)
if err != nil {
return stacktrace.Propagate(err, "Error converting Subscription model to REST")
}
response.Subscriptions = append(response.Subscriptions, *p)
}
}

return nil
}

_, err = a.Store.Transact(ctx, dssstore.NewFuncOperation(action))
response, err := dssstore.TransactWithResult[repos.Repository, *restapi.QuerySubscriptionsResponse](ctx, a.Store, req)
if err != nil {

errResp := &restapi.ErrorResponse{Message: dsserr.Handle(ctx, err)}
Expand Down
Loading