Fix some naming

Author: sjberman

internal/controller/nginx/agent/command.go

@@ -203,7 +203,7 @@ func (cs *commandService) Subscribe(in pb.CommandService_SubscribeServer) error
 			// Only broadcast operations should signal ResponseCh for coordination.
 			pendingBroadcastRequest = &msg
 		case err = <-msgr.Errors():
-			cs.logger.Error(err, "connection error", "deployment", conn.ParentName, "uuid", gi.UUID)
+			cs.logger.Error(err, "connection error", conn.ParentType, conn.ParentName, "uuid", gi.UUID)
 			deployment.SetPodErrorStatus(gi.UUID, err)
 			select {
 			case channels.ResponseCh <- struct{}{}:
@@ -248,7 +248,7 @@ func (cs *commandService) Subscribe(in pb.CommandService_SubscribeServer) error
 
 func (cs *commandService) waitForConnection(
 	ctx context.Context,
-	gi grpcContext.GrpcInfo,
+	grpcInfo grpcContext.GrpcInfo,
 ) (*agentgrpc.Connection, *Deployment, error) {
 	ticker := time.NewTicker(time.Second)
 	defer ticker.Stop()
@@ -267,7 +267,7 @@ func (cs *commandService) waitForConnection(
 		case <-timer.C:
 			return nil, nil, err
 		case <-ticker.C:
-			if conn := cs.connTracker.GetConnection(gi.UUID); conn.Ready() {
+			if conn := cs.connTracker.GetConnection(grpcInfo.UUID); conn.Ready() {
 				// connection has been established, now ensure that the deployment exists in the store
 				if deployment := cs.nginxDeployments.Get(conn.ParentName); deployment != nil {
 					return &conn, deployment, nil
@@ -283,7 +283,7 @@ func (cs *commandService) waitForConnection(
 // setInitialConfig gets the initial configuration for this connection and applies it.
 func (cs *commandService) setInitialConfig(
 	ctx context.Context,
-	gi *grpcContext.GrpcInfo,
+	grpcInfo *grpcContext.GrpcInfo,
 	deployment *Deployment,
 	conn *agentgrpc.Connection,
 	msgr messenger.Messenger,
@@ -292,7 +292,7 @@ func (cs *commandService) setInitialConfig(
 	defer deployment.FileLock.Unlock()
 
 	if err := cs.validatePodImageVersion(conn.ParentName, conn.ParentType, deployment.imageVersion); err != nil {
-		cs.logAndSendErrorStatus(gi, deployment, conn, err)
+		cs.logAndSendErrorStatus(grpcInfo, deployment, conn, err)
 		return grpcStatus.Errorf(codes.FailedPrecondition, "nginx image version validation failed: %s", err.Error())
 	}
 
@@ -301,12 +301,12 @@ func (cs *commandService) setInitialConfig(
 	cs.logger.Info(
 		"Sending initial configuration to agent",
 		conn.ParentType, conn.ParentName,
-		"uuid", gi.UUID,
+		"uuid", grpcInfo.UUID,
 		"configVersion", configVersion,
 	)
 
 	if err := msgr.Send(ctx, buildRequest(fileOverviews, conn.InstanceID, configVersion)); err != nil {
-		cs.logAndSendErrorStatus(gi, deployment, conn, err)
+		cs.logAndSendErrorStatus(grpcInfo, deployment, conn, err)
 
 		return grpcStatus.Error(codes.Internal, err.Error())
 	}
@@ -330,7 +330,7 @@ func (cs *commandService) setInitialConfig(
 			true, // poll immediately
 			func(ctx context.Context) (bool, error) {
 				if err := msgr.Send(ctx, buildPlusAPIRequest(action, conn.InstanceID)); err != nil {
-					cs.logAndSendErrorStatus(gi, deployment, conn, err)
+					cs.logAndSendErrorStatus(grpcInfo, deployment, conn, err)
 
 					return false, grpcStatus.Error(codes.Internal, err.Error())
 				}
@@ -359,7 +359,7 @@ func (cs *commandService) setInitialConfig(
 		cancel()
 	}
 	// send the status (error or nil) to the status queue
-	cs.logAndSendErrorStatus(gi, deployment, conn, errors.Join(errs...))
+	cs.logAndSendErrorStatus(grpcInfo, deployment, conn, errors.Join(errs...))
 
 	return nil
 }
@@ -403,7 +403,7 @@ func (cs *commandService) waitForInitialConfigApply(
 // exist on the Deployment are not overwritten.
 // If the error is nil, then we just enqueue the nil value and don't log it, which indicates success.
 func (cs *commandService) logAndSendErrorStatus(
-	gi *grpcContext.GrpcInfo,
+	grpcInfo *grpcContext.GrpcInfo,
 	deployment *Deployment,
 	conn *agentgrpc.Connection,
 	err error,
@@ -414,10 +414,10 @@ func (cs *commandService) logAndSendErrorStatus(
 		cs.logger.Info(
 			"Successfully configured nginx for new subscription",
 			conn.ParentType, conn.ParentName,
-			"uuid", gi.UUID,
+			"uuid", grpcInfo.UUID,
 		)
 	}
-	deployment.SetPodErrorStatus(gi.UUID, err)
+	deployment.SetPodErrorStatus(grpcInfo.UUID, err)
 
 	queueObj := &status.QueueObject{
 		Deployment: conn.ParentName,

internal/controller/nginx/agent/grpc/interceptor/interceptor.go

@@ -114,11 +114,11 @@ func getGrpcInfo(ctx context.Context) (*grpcContext.GrpcInfo, error) {
 	}, nil
 }
 
-func (c ContextSetter) validateToken(ctx context.Context, gi *grpcContext.GrpcInfo) (context.Context, error) {
+func (c ContextSetter) validateToken(ctx context.Context, grpcInfo *grpcContext.GrpcInfo) (context.Context, error) {
 	tokenReview := &authv1.TokenReview{
 		Spec: authv1.TokenReviewSpec{
 			Audiences: []string{c.audience},
-			Token:     gi.Token,
+			Token:     grpcInfo.Token,
 		},
 	}
 
@@ -169,5 +169,5 @@ func (c ContextSetter) validateToken(ctx context.Context, gi *grpcContext.GrpcIn
 		return nil, status.Error(codes.Unauthenticated, msg)
 	}
 
-	return grpcContext.NewGrpcContext(ctx, *gi), nil
+	return grpcContext.NewGrpcContext(ctx, *grpcInfo), nil
 }

internal/controller/nginx/agent/grpc/interceptor/interceptor_test.go

@@ -253,7 +253,7 @@ func TestValidateToken_PodListOptions(t *testing.T) {
 
 	testCases := []struct {
 		pod       *corev1.Pod
-		gi        *grpcContext.GrpcInfo
+		grpcInfo  *grpcContext.GrpcInfo
 		name      string
 		shouldErr bool
 	}{
@@ -269,7 +269,7 @@ func TestValidateToken_PodListOptions(t *testing.T) {
 				},
 				Status: corev1.PodStatus{Phase: corev1.PodRunning},
 			},
-			gi:        &grpcContext.GrpcInfo{Token: "dummy-token"},
+			grpcInfo:  &grpcContext.GrpcInfo{Token: "dummy-token"},
 			shouldErr: false,
 		},
 		{
@@ -284,7 +284,7 @@ func TestValidateToken_PodListOptions(t *testing.T) {
 				},
 				Status: corev1.PodStatus{Phase: corev1.PodRunning},
 			},
-			gi:        &grpcContext.GrpcInfo{Token: "dummy-token"},
+			grpcInfo:  &grpcContext.GrpcInfo{Token: "dummy-token"},
 			shouldErr: true,
 		},
 		{
@@ -299,7 +299,7 @@ func TestValidateToken_PodListOptions(t *testing.T) {
 				},
 				Status: corev1.PodStatus{Phase: corev1.PodRunning},
 			},
-			gi:        &grpcContext.GrpcInfo{Token: "dummy-token"},
+			grpcInfo:  &grpcContext.GrpcInfo{Token: "dummy-token"},
 			shouldErr: true,
 		},
 		{
@@ -312,7 +312,7 @@ func TestValidateToken_PodListOptions(t *testing.T) {
 				},
 				Status: corev1.PodStatus{Phase: corev1.PodRunning},
 			},
-			gi:        &grpcContext.GrpcInfo{Token: "dummy-token"},
+			grpcInfo:  &grpcContext.GrpcInfo{Token: "dummy-token"},
 			shouldErr: true,
 		},
 		{
@@ -327,7 +327,7 @@ func TestValidateToken_PodListOptions(t *testing.T) {
 				},
 				Status: corev1.PodStatus{Phase: corev1.PodPending},
 			},
-			gi:        &grpcContext.GrpcInfo{Token: "dummy-token"},
+			grpcInfo:  &grpcContext.GrpcInfo{Token: "dummy-token"},
 			shouldErr: true,
 		},
 	}
@@ -352,7 +352,7 @@ func TestValidateToken_PodListOptions(t *testing.T) {
 			patchedClient := &patchClient{fakeClient}
 			csPatched := NewContextSetter(patchedClient, "ngf-audience")
 
-			resultCtx, err := csPatched.validateToken(t.Context(), tc.gi)
+			resultCtx, err := csPatched.validateToken(t.Context(), tc.grpcInfo)
 			if tc.shouldErr {
 				g.Expect(err).To(HaveOccurred())
 				g.Expect(err.Error()).To(ContainSubstring("no running pods"))