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

chore: move model proxy to separate pkg #1521

Merged
merged 4 commits into from
Jan 15, 2025
Merged

chore: move model proxy to separate pkg #1521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6d1fe9c
chore: move model proxy to separate pkg
kian99 Jan 13, 2025
c778fc6
chore: remove unused isRequest func
kian99 Jan 14, 2025
ccbf15b
Merge branch 'v3' into intercept-ssh-commands-followup-1
kian99 Jan 14, 2025
95ec98a
Merge branch 'v3' into intercept-ssh-commands-followup-1
kian99 Jan 15, 2025
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
4 changes: 2 additions & 2 deletions internal/jujuapi/streamproxy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import (
"github.com/canonical/jimm/v3/internal/errors"
"github.com/canonical/jimm/v3/internal/jimmhttp"
"github.com/canonical/jimm/v3/internal/openfga"
jimmRPC "github.com/canonical/jimm/v3/internal/rpc"
"github.com/canonical/jimm/v3/internal/streamproxy"
)

// A streamProxier serves the the /log endpoint by proxying
Expand Down Expand Up @@ -103,7 +103,7 @@ func (s streamProxier) ServeWS(ctx context.Context, clientConn *websocket.Conn)
return
}

jimmRPC.ProxyStreams(ctx, clientConn, controllerStream)
streamproxy.ProxyStreams(ctx, clientConn, controllerStream)
}

func checkPermission(ctx context.Context, path string, u *openfga.User, mt names.ModelTag) (bool, error) {
Expand Down
17 changes: 9 additions & 8 deletions internal/jujuapi/websocket.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (
"github.com/canonical/jimm/v3/internal/jimm/jujuauth"
"github.com/canonical/jimm/v3/internal/jimmhttp"
jimmRPC "github.com/canonical/jimm/v3/internal/rpc"
"github.com/canonical/jimm/v3/internal/rpcproxy"
)

const (
Expand Down Expand Up @@ -177,30 +178,30 @@ func (s apiProxier) ServeWS(ctx context.Context, clientConn *websocket.Conn) {
connectionFunc := controllerConnectionFunc(s, &jwtGenerator)
zapctx.Debug(ctx, "Starting proxier")
auditLogger := s.jimm.AuditLogManager().AddAuditLogEntry
proxyHelpers := jimmRPC.ProxyHelpers{
proxyHelpers := rpcproxy.ProxyHelpers{
ConnClient: clientConn,
TokenGen: &jwtGenerator,
ConnectController: connectionFunc,
AuditLog: auditLogger,
LoginService: s.jimm.LoginManager(),
AuthenticatedIdentityID: auth.SessionIdentityFromContext(ctx),
}
if err := jimmRPC.ProxySockets(ctx, proxyHelpers); err != nil {
if err := rpcproxy.ProxySockets(ctx, proxyHelpers); err != nil {
zapctx.Error(ctx, "failed to start jimm model proxy", zap.Error(err))
}
}

// controllerConnectionFunc returns a function that will be used to
// connect to a controller when a client makes a request.
func controllerConnectionFunc(s apiProxier, jwtGenerator *jujuauth.TokenGenerator) func(context.Context) (jimmRPC.WebsocketConnectionWithMetadata, error) {
return func(ctx context.Context) (jimmRPC.WebsocketConnectionWithMetadata, error) {
func controllerConnectionFunc(s apiProxier, jwtGenerator *jujuauth.TokenGenerator) func(context.Context) (rpcproxy.WebsocketConnectionWithMetadata, error) {
return func(ctx context.Context) (rpcproxy.WebsocketConnectionWithMetadata, error) {
const op = errors.Op("proxy.controllerConnectionFunc")
path := jimmhttp.PathElementFromContext(ctx, "path")
zapctx.Debug(ctx, "grabbing model info from path", zap.String("path", path))
uuid, finalPath, err := modelInfoFromPath(path)
if err != nil {
zapctx.Error(ctx, "error parsing path", zap.Error(err))
return jimmRPC.WebsocketConnectionWithMetadata{}, errors.E(op, err)
return rpcproxy.WebsocketConnectionWithMetadata{}, errors.E(op, err)
}
m := dbmodel.Model{
UUID: sql.NullString{
Expand All @@ -210,18 +211,18 @@ func controllerConnectionFunc(s apiProxier, jwtGenerator *jujuauth.TokenGenerato
}
if err := s.jimm.Database.GetModel(context.Background(), &m); err != nil {
zapctx.Error(ctx, "failed to find model", zap.String("uuid", uuid), zap.Error(err))
return jimmRPC.WebsocketConnectionWithMetadata{}, errors.E(err, errors.CodeNotFound)
return rpcproxy.WebsocketConnectionWithMetadata{}, errors.E(err, errors.CodeNotFound)
}
jwtGenerator.SetTags(m.ResourceTag(), m.Controller.ResourceTag())
mt := m.ResourceTag()
zapctx.Debug(ctx, "Dialing Controller", zap.String("path", path))
controllerConn, err := jimmRPC.Dial(ctx, &m.Controller, mt, finalPath, nil)
if err != nil {
zapctx.Error(ctx, "cannot dial controller", zap.String("controller", m.Controller.Name), zap.Error(err))
return jimmRPC.WebsocketConnectionWithMetadata{}, err
return rpcproxy.WebsocketConnectionWithMetadata{}, err
}
fullModelName := m.Controller.Name + "/" + m.Name
return jimmRPC.WebsocketConnectionWithMetadata{
return rpcproxy.WebsocketConnectionWithMetadata{
Conn: controllerConn,
ControllerUUID: m.Controller.UUID,
ModelName: fullModelName,
Expand Down
12 changes: 1 addition & 11 deletions internal/rpc/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2024 Canonical.
// Copyright 2025 Canonical.

package rpc

Expand Down Expand Up @@ -203,16 +203,6 @@ func (c *Client) Call(ctx context.Context, facade string, version int, id, metho

select {
case <-ch:
permissionsRequired, err := checkPermissionsRequired(ctx, *respMsg)
if err != nil {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rpc package was using checkPermissionsRequired which now lives in rpcproxy.go. I've removed this as there is no need to check for the permissionsRequired error here.

return err
}
if permissionsRequired != nil {
return &Error{
Code: PermissionCheckRequiredErrorCode,
Info: permissionsRequired,
}
}
if (*respMsg).Error != "" {
return &Error{
Message: (*respMsg).Error,
Expand Down
Loading
Loading