Return endpoint usage

Author: SketchingDev

src/tools/oauthClientUsage/oauthClientUsage.test.ts

@@ -18,6 +18,7 @@ describe("OAuth Client Usage", () => {
         postOauthClientUsageQuery: vi.fn(),
         getOauthClientUsageQueryResult: vi.fn(),
       },
+      cache: undefined,
     };
     const toolDefinition = oauthClientUsage(toolDeps);
     toolName = toolDefinition.schema.name;
@@ -141,8 +142,6 @@ describe("OAuth Client Usage", () => {
   test("OAuth Client usage returned for date range", async () => {
     const oauthClientId = randomUUID();
     const executionId = randomUUID();
-    const organisationOneId = randomUUID();
-    const organisationTwoId = randomUUID();
 
     toolDeps.oauthApi.postOauthClientUsageQuery.mockResolvedValue({
       executionId,
@@ -152,11 +151,13 @@ describe("OAuth Client Usage", () => {
     toolDeps.oauthApi.getOauthClientUsageQueryResult.mockResolvedValue({
       results: [
         {
-          organizationId: organisationOneId,
+          templateUri: "api/v2/authorization/divisions",
+          httpMethod: "GET",
           requests: 5,
         },
         {
-          organizationId: organisationTwoId,
+          templateUri: "api/v2/authorization/roles",
+          httpMethod: "GET",
           requests: 10,
         },
       ],
@@ -181,14 +182,14 @@ describe("OAuth Client Usage", () => {
           text: JSON.stringify({
             startDate,
             endDate,
-            totalRequest: 15,
-            requestsPerOrganisation: [
+            totalRequests: 15,
+            requestsPerEndpoint: [
               {
-                organisationId: organisationOneId,
+                endpoint: "GET api/v2/authorization/divisions",
                 requests: 5,
               },
               {
-                organisationId: organisationTwoId,
+                endpoint: "GET api/v2/authorization/roles",
                 requests: 10,
               },
             ],

src/tools/oauthClientUsage/oauthClientUsage.ts

@@ -12,9 +12,9 @@ const TOOL_CACHE_KEY = "oauthClientUsage";
 export interface OAuthClientUsageResponse {
   startDate: string;
   endDate: string;
-  totalRequest: number;
-  requestsPerOrganisation: {
-    organisationId?: string;
+  totalRequests: number;
+  requestsPerEndpoint: {
+    endpoint?: string;
     requests?: number;
   }[];
 }
@@ -91,7 +91,7 @@ export const oauthClientUsage: ToolFactory<
         result = await oauthApi.postOauthClientUsageQuery(oauthClientId, {
           interval: `${from.toISOString()}/${to.toISOString()}`,
           metrics: ["Requests"],
-          groupBy: ["OrganizationId"],
+          groupBy: ["TemplateUri", "HttpMethod"],
         });
       } catch (error: unknown) {
         const errorMessage = isUnauthorisedError(error)
@@ -147,13 +147,14 @@ export const oauthClientUsage: ToolFactory<
       const toolResult: OAuthClientUsageResponse = {
         startDate,
         endDate,
-        totalRequest: (apiUsageQueryResult?.results ?? []).reduce(
+        totalRequests: (apiUsageQueryResult?.results ?? []).reduce(
           (acc, curr) => acc + (curr.requests ?? 0),
           0,
         ),
-        requestsPerOrganisation: (apiUsageQueryResult?.results ?? []).map(
+        requestsPerEndpoint: (apiUsageQueryResult?.results ?? []).map(
           (result) => ({
-            organisationId: result.organizationId,
+            endpoint:
+              [result.httpMethod, result.templateUri].join(" ") || undefined,
             requests: result.requests,
           }),
         ),