[admin] add admin endpoints for usage

Author: svenefftinge

components/usage-api/go/v1/usage.pb.go

@@ -249,6 +249,16 @@ export interface ResetUsageRequest {
 export interface ResetUsageResponse {
 }
 
+export interface AddUsageCreditNoteRequest {
+  attributionId: string;
+  credits: number;
+  note: string;
+  userId: string;
+}
+
+export interface AddUsageCreditNoteResponse {
+}
+
 function createBaseReconcileUsageRequest(): ReconcileUsageRequest {
   return { from: undefined, to: undefined };
 }
@@ -1244,6 +1254,121 @@ export const ResetUsageResponse = {
   },
 };
 
+function createBaseAddUsageCreditNoteRequest(): AddUsageCreditNoteRequest {
+  return { attributionId: "", credits: 0, note: "", userId: "" };
+}
+
+export const AddUsageCreditNoteRequest = {
+  encode(message: AddUsageCreditNoteRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.attributionId !== "") {
+      writer.uint32(10).string(message.attributionId);
+    }
+    if (message.credits !== 0) {
+      writer.uint32(16).int32(message.credits);
+    }
+    if (message.note !== "") {
+      writer.uint32(26).string(message.note);
+    }
+    if (message.userId !== "") {
+      writer.uint32(34).string(message.userId);
+    }
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): AddUsageCreditNoteRequest {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseAddUsageCreditNoteRequest();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1:
+          message.attributionId = reader.string();
+          break;
+        case 2:
+          message.credits = reader.int32();
+          break;
+        case 3:
+          message.note = reader.string();
+          break;
+        case 4:
+          message.userId = reader.string();
+          break;
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+
+  fromJSON(object: any): AddUsageCreditNoteRequest {
+    return {
+      attributionId: isSet(object.attributionId) ? String(object.attributionId) : "",
+      credits: isSet(object.credits) ? Number(object.credits) : 0,
+      note: isSet(object.note) ? String(object.note) : "",
+      userId: isSet(object.userId) ? String(object.userId) : "",
+    };
+  },
+
+  toJSON(message: AddUsageCreditNoteRequest): unknown {
+    const obj: any = {};
+    message.attributionId !== undefined && (obj.attributionId = message.attributionId);
+    message.credits !== undefined && (obj.credits = Math.round(message.credits));
+    message.note !== undefined && (obj.note = message.note);
+    message.userId !== undefined && (obj.userId = message.userId);
+    return obj;
+  },
+
+  fromPartial(object: DeepPartial<AddUsageCreditNoteRequest>): AddUsageCreditNoteRequest {
+    const message = createBaseAddUsageCreditNoteRequest();
+    message.attributionId = object.attributionId ?? "";
+    message.credits = object.credits ?? 0;
+    message.note = object.note ?? "";
+    message.userId = object.userId ?? "";
+    return message;
+  },
+};
+
+function createBaseAddUsageCreditNoteResponse(): AddUsageCreditNoteResponse {
+  return {};
+}
+
+export const AddUsageCreditNoteResponse = {
+  encode(_: AddUsageCreditNoteResponse, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    return writer;
+  },
+
+  decode(input: _m0.Reader | Uint8Array, length?: number): AddUsageCreditNoteResponse {
+    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    let end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseAddUsageCreditNoteResponse();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        default:
+          reader.skipType(tag & 7);
+          break;
+      }
+    }
+    return message;
+  },
+
+  fromJSON(_: any): AddUsageCreditNoteResponse {
+    return {};
+  },
+
+  toJSON(_: AddUsageCreditNoteResponse): unknown {
+    const obj: any = {};
+    return obj;
+  },
+
+  fromPartial(_: DeepPartial<AddUsageCreditNoteResponse>): AddUsageCreditNoteResponse {
+    const message = createBaseAddUsageCreditNoteResponse();
+    return message;
+  },
+};
+
 export type UsageServiceDefinition = typeof UsageServiceDefinition;
 export const UsageServiceDefinition = {
   name: "UsageService",
@@ -1303,6 +1428,15 @@ export const UsageServiceDefinition = {
       responseStream: false,
       options: {},
     },
+    /** AddUsageCreditNote adds a usage credit note to the given cost center with the effective date of now */
+    addUsageCreditNote: {
+      name: "AddUsageCreditNote",
+      requestType: AddUsageCreditNoteRequest,
+      requestStream: false,
+      responseType: AddUsageCreditNoteResponse,
+      responseStream: false,
+      options: {},
+    },
   },
 } as const;
 
@@ -1334,6 +1468,11 @@ export interface UsageServiceServiceImplementation<CallContextExt = {}> {
     request: GetBalanceRequest,
     context: CallContext & CallContextExt,
   ): Promise<DeepPartial<GetBalanceResponse>>;
+  /** AddUsageCreditNote adds a usage credit note to the given cost center with the effective date of now */
+  addUsageCreditNote(
+    request: AddUsageCreditNoteRequest,
+    context: CallContext & CallContextExt,
+  ): Promise<DeepPartial<AddUsageCreditNoteResponse>>;
 }
 
 export interface UsageServiceClient<CallOptionsExt = {}> {
@@ -1364,6 +1503,11 @@ export interface UsageServiceClient<CallOptionsExt = {}> {
     request: DeepPartial<GetBalanceRequest>,
     options?: CallOptions & CallOptionsExt,
   ): Promise<GetBalanceResponse>;
+  /** AddUsageCreditNote adds a usage credit note to the given cost center with the effective date of now */
+  addUsageCreditNote(
+    request: DeepPartial<AddUsageCreditNoteRequest>,
+    options?: CallOptions & CallOptionsExt,
+  ): Promise<AddUsageCreditNoteResponse>;
 }
 
 export interface DataLoaderOptions {

components/usage-api/go/v1/usage_grpc.pb.go

@@ -25,6 +25,9 @@ service UsageService {
 
     // GetBalance returns the current credits balance for the given attributionId
     rpc GetBalance(GetBalanceRequest) returns (GetBalanceResponse) {}
+
+    // AddUsageCreditNote adds a usage credit note to the given cost center with the effective date of now
+    rpc AddUsageCreditNote(AddUsageCreditNoteRequest) returns (AddUsageCreditNoteResponse) {}
 }
 
 message ReconcileUsageRequest {
@@ -135,3 +138,15 @@ message CostCenter {
 message ResetUsageRequest {}
 
 message ResetUsageResponse {}
+
+message AddUsageCreditNoteRequest {
+    string attribution_id = 1;
+    // the amount of credits to add to the given account
+    int32 credits = 2;
+    // a human readable note for the reason this credit note exists
+    string note = 3;
+    // the id of the user (admin) who created the note
+    string user_id = 4;
+}
+
+message AddUsageCreditNoteResponse {}

components/usage-api/typescript/src/usage/v1/usage.pb.ts

@@ -8,6 +8,7 @@ import (
 	"context"
 	"fmt"
 	"math"
+	"strings"
 	"time"
 
 	"github.com/google/uuid"
@@ -453,3 +454,48 @@ func NewUsageService(conn *gorm.DB, pricer *WorkspacePricer, costCenterManager *
 		pricer: pricer,
 	}
 }
+
+func (s *UsageService) AddUsageCreditNote(ctx context.Context, req *v1.AddUsageCreditNoteRequest) (*v1.AddUsageCreditNoteResponse, error) {
+	log.Log.
+		WithField("attribution_id", req.AttributionId).
+		WithField("credits", req.Credits).
+		WithField("user", req.UserId).
+		WithField("note", req.Note).
+		Info("Adding usage credit note.")
+
+	attributionId, err := db.ParseAttributionID(req.AttributionId)
+	if err != nil {
+		return nil, status.Errorf(codes.InvalidArgument, "AttributionID '%s' couldn't be parsed (error: %s).", req.AttributionId, err)
+	}
+
+	note := strings.TrimSpace(req.Note)
+	if note == "" {
+		return nil, status.Error(codes.InvalidArgument, "The note must not be empty.")
+	}
+
+	userId, err := uuid.Parse(req.UserId)
+	if err != nil {
+		return nil, fmt.Errorf("The user id is not a valid UUID. %w", err)
+	}
+
+	usage := db.Usage{
+		ID:            uuid.New(),
+		AttributionID: attributionId,
+		Description:   note,
+		CreditCents:   db.NewCreditCents(float64(req.Credits * -1)),
+		EffectiveTime: common_db.NewVarCharTime(time.Now()),
+		Kind:          db.CreditNoteKind,
+		Draft:         false,
+	}
+
+	err = usage.SetCreditNoteMetaData(db.CreditNoteMetaData{UserId: userId.String()})
+	if err != nil {
+		return nil, err
+	}
+
+	err = db.InsertUsage(ctx, s.conn, usage)
+	if err != nil {
+		return nil, err
+	}
+	return &v1.AddUsageCreditNoteResponse{}, nil
+}

components/usage-api/usage/v1/usage.proto

@@ -341,3 +341,45 @@ func TestListUsage(t *testing.T) {
 	}
 
 }
+
+func TestAddUSageCreditNote(t *testing.T) {
+	conn := dbtest.ConnectForTests(t)
+
+	attributionID := db.NewTeamAttributionID(uuid.New().String())
+
+	usageService := newUsageService(t, conn)
+
+	tests := []struct {
+		credits int32
+		userId  string
+		note    string
+		// expectations
+		expectedError bool
+	}{
+		{300, uuid.New().String(), "Something", false},
+		{300, "bad-userid", "Something", true},
+		{300, uuid.New().String(), "    " /* no note */, true},
+		{-300, uuid.New().String(), "Negative Balance", false},
+	}
+
+	for i, test := range tests {
+		t.Run(fmt.Sprintf("Running test no %d", i+1), func(t *testing.T) {
+			_, err := usageService.AddUsageCreditNote(context.Background(), &v1.AddUsageCreditNoteRequest{
+				AttributionId: string(attributionID),
+				Credits:       test.credits,
+				Note:          test.note,
+				UserId:        test.userId,
+			})
+			if test.expectedError {
+				require.Error(t, err)
+			} else {
+				require.NoError(t, err)
+				balance, err := db.GetBalance(context.Background(), conn, attributionID)
+				require.NoError(t, err)
+				require.Equal(t, int32(balance.ToCredits()), test.credits*-1)
+			}
+			require.NoError(t, conn.Where("attributionId = ?", attributionID).Delete(&db.Usage{}).Error)
+		})
+	}
+
+}