Add accounting for memodel creation (#79)

* Add integration for me-model creation and accounting

* Start adding session class

* Create a OneShot class to simplify accounging usage

* Fix types, other lint issues

* Remove basePath from accounting API calls

* Correctly provide jobId when cancelling a reservation

* Make accounting base URL available in the client

* Disable accounting integration in local dev

* Add authz to the make reservation endpoint

* Revert type fix for getOrgFromSelfUrl and getProjFromSelfUrl methods

* Do not await while sending usage to accounting service

* Remove unnecessary comments

Author: pgetta

.deployment-envs/.env.production

@@ -1,3 +1,4 @@
+NEXT_PUBLIC_ACCOUNTING_BASE_URL=https://www.openbraininstitute.org/api/accounting
 NEXT_PUBLIC_NEXUS_URL=https://openbluebrain.com/api/nexus/v1
 NEXT_PUBLIC_BLUE_NAAS_URL=https://www.openbraininstitute.org/api/bluenaas
 NEXT_PUBLIC_CELL_SVC_BASE_URL=https://www.openbraininstitute.org/api/circuit

.deployment-envs/.env.staging

@@ -1,3 +1,4 @@
+NEXT_PUBLIC_ACCOUNTING_BASE_URL=https://staging.openbraininstitute.org/api/accounting
 NEXT_PUBLIC_NEXUS_URL=https://staging.openbraininstitute.org/api/nexus/v1
 NEXT_PUBLIC_BLUE_NAAS_URL=https://staging.openbraininstitute.org/api/bluenaas
 NEXT_PUBLIC_CELL_SVC_BASE_URL=https://staging.openbraininstitute.org/api/circuit

src/app/api/accounting/reservation/oneshot/[reservationId]/route.ts

@@ -0,0 +1,39 @@
+import { convertObjectKeystoCamelCase } from '@/util/object-keys-format';
+import { auth } from '@/auth';
+import { accountingBaseUrl } from '@/config';
+import authFetch from '@/authFetch';
+import { assertApiResponse } from '@/util/utils';
+
+export const DELETE = async (
+  request: Request,
+  { params }: { params: { reservationId: string } }
+) => {
+  const session = await auth();
+
+  if (!session) {
+    return new Response('Unauthorized', {
+      status: 401,
+      statusText: 'The supplied authentication is not authorized for this action',
+    });
+  }
+
+  const { reservationId } = params;
+
+  try {
+    const res = await authFetch(`${accountingBaseUrl}/reservation/oneshot/${reservationId}`, {
+      method: 'DELETE',
+      headers: { 'Content-Type': 'application/json' },
+    });
+
+    const resObj = assertApiResponse(res);
+
+    return Response.json(convertObjectKeystoCamelCase(resObj));
+  } catch (error: unknown) {
+    const errorMessage = error instanceof Error ? error.message : 'An unknown error occurred';
+
+    return new Response('Failed to cancel oneshot reservation', {
+      status: 502,
+      statusText: errorMessage,
+    });
+  }
+};

src/app/api/accounting/reservation/oneshot/route.ts

@@ -0,0 +1,58 @@
+import { OneshotReservation, ServiceType } from '@/types/accounting';
+import {
+  convertObjectKeystoCamelCase,
+  convertObjectKeysToSnakeCase,
+} from '@/util/object-keys-format';
+import { auth } from '@/auth';
+import { accountingBaseUrl } from '@/config';
+import authFetch from '@/authFetch';
+import { assertApiResponse } from '@/util/utils';
+import { getVirtualLabProjectUsers } from '@/services/virtual-lab/projects';
+
+export const POST = async (request: Request) => {
+  const reservationRequest = (await request.json()) as Omit<OneshotReservation, 'type' | 'userId'>;
+  const session = await auth();
+
+  if (!session) {
+    return new Response('Unauthorized', {
+      status: 401,
+      statusText: 'The supplied authentication is not authorized for this action',
+    });
+  }
+
+  const { virtualLabId, projectId } = reservationRequest;
+
+  const projectUsers = await getVirtualLabProjectUsers(virtualLabId, projectId);
+  const projectUser = projectUsers.data.users.find((user) => user.id === session.user.id);
+  if (!projectUser) {
+    return new Response('Unauthorized', {
+      status: 401,
+      statusText: 'The supplied authentication is not authorized for this action',
+    });
+  }
+
+  try {
+    const res = await authFetch(`${accountingBaseUrl}/reservation/oneshot`, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify(
+        convertObjectKeysToSnakeCase({
+          ...reservationRequest,
+          userId: session.user.id,
+          type: ServiceType.Oneshot,
+        })
+      ),
+    });
+
+    const resObj = assertApiResponse(res);
+
+    return Response.json(convertObjectKeystoCamelCase(resObj));
+  } catch (error: unknown) {
+    const errorMessage = error instanceof Error ? error.message : 'An unknown error occurred';
+
+    return new Response('Failed to create oneshot reservation', {
+      status: 502,
+      statusText: errorMessage,
+    });
+  }
+};

src/app/api/accounting/usage/oneshot/route.ts

@@ -0,0 +1,40 @@
+import { OneshotUsage } from '@/types/accounting';
+import {
+  convertObjectKeystoCamelCase,
+  convertObjectKeysToSnakeCase,
+} from '@/util/object-keys-format';
+import { auth } from '@/auth';
+import { accountingBaseUrl } from '@/config';
+import authFetch from '@/authFetch';
+import { assertApiResponse } from '@/util/utils';
+
+export const POST = async (request: Request) => {
+  const usage = (await request.json()) as OneshotUsage;
+  const session = await auth();
+
+  if (!session) {
+    return new Response('Unauthorized', {
+      status: 401,
+      statusText: 'The supplied authentication is not authorized for this action',
+    });
+  }
+
+  try {
+    const res = await authFetch(`${accountingBaseUrl}/usage/oneshot`, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify(convertObjectKeysToSnakeCase(usage)),
+    });
+
+    const resObj = assertApiResponse(res);
+
+    return Response.json(convertObjectKeystoCamelCase(resObj));
+  } catch (error: unknown) {
+    const errorMessage = error instanceof Error ? error.message : 'An unknown error occurred';
+
+    return new Response('Failed to send oneshot usage', {
+      status: 502,
+      statusText: errorMessage,
+    });
+  }
+};

src/app/app/virtual-lab/lab/[virtualLabId]/project/[projectId]/(pages)/notebooks/member/UserNotebookPage.tsx

@@ -10,7 +10,7 @@ import { Notebook } from '@/util/virtual-lab/github';
 import fetchNotebooks from '@/util/virtual-lab/fetchNotebooks';
 import authFetch from '@/authFetch';
 import { notification } from '@/api/notifications';
-import { assertErrorMessage, assertVLApiResponse } from '@/util/utils';
+import { assertErrorMessage, assertApiResponse } from '@/util/utils';
 import { virtualLabApi } from '@/config';
 
 function useDelayedLoading(initialValue = false, delay = 200) {
@@ -217,7 +217,7 @@ export default function UserNotebookPage({
                         }
                       );
 
-                      const newNotebook = await assertVLApiResponse(notebookRes);
+                      const newNotebook = await assertApiResponse(notebookRes);
 
                       const newValidatedNotebooks = NotebooksArraySchema.parse(newNotebook.data);
                       setNotebooks([

src/app/app/virtual-lab/lab/[virtualLabId]/project/[projectId]/(pages)/notebooks/member/page.tsx

@@ -3,7 +3,7 @@ import UserNotebookPage from './UserNotebookPage';
 import { ServerSideComponentProp } from '@/types/common';
 import { fetchNotebook, Notebook } from '@/util/virtual-lab/github';
 import { virtualLabApi } from '@/config';
-import { assertErrorMessage, assertVLApiResponse } from '@/util/utils';
+import { assertErrorMessage, assertApiResponse } from '@/util/utils';
 import authFetch from '@/authFetch';
 
 export default async function Notebooks({
@@ -18,7 +18,7 @@ export default async function Notebooks({
       `${virtualLabApi.url}/projects/${projectId}/notebooks/?page_size=100`
     );
 
-    const userNotebookData = await assertVLApiResponse(userNotebooksRes);
+    const userNotebookData = await assertApiResponse(userNotebooksRes);
 
     const notebooks = NotebooksArraySchema.parse(userNotebookData.data.results);
 

src/components/VirtualLab/projects/VirtualLabProjectAdmin/ProjectBalanceCard.tsx

@@ -3,7 +3,7 @@ import { useSetAtom } from 'jotai';
 
 import EditIcon from '@/components/icons/Edit';
 import useBalanceTransferModal from '@/hooks/virtual-labs/project';
-import { ProjectBalance } from '@/types/virtual-lab/accounting';
+import { ProjectBalance } from '@/types/accounting';
 import { Project } from '@/types/virtual-lab/projects';
 import {
   projectBalanceAtomFamily,

src/components/VirtualLab/projects/VirtualLabProjectAdmin/ProjectJobReportList.tsx

@@ -7,7 +7,7 @@ import {
   projectJobReportsAtomFamily,
   virtualLabProjectUsersAtomFamily,
 } from '@/state/virtual-lab/projects';
-import { JobReport, ServiceSubtype } from '@/types/virtual-lab/accounting';
+import { JobReport, ServiceSubtype } from '@/types/accounting';
 
 const { Column } = Table;
 
@@ -62,7 +62,9 @@ const tableTheme = {
 };
 
 const activityLabel: Record<ServiceSubtype, string> = {
+  [ServiceSubtype.SingleCellBuild]: 'Build',
   [ServiceSubtype.SingleCellSim]: 'Simulate',
+  [ServiceSubtype.SynaptomeBuild]: 'Build',
   [ServiceSubtype.SynaptomeSim]: 'Simulate',
   [ServiceSubtype.Storage]: 'Storage',
   // TODO: check if the following subtypes are still relevant and find better labels for them
@@ -76,7 +78,9 @@ function activityRenderFn(subtype: ServiceSubtype) {
 }
 
 const scaleLabel: Record<ServiceSubtype, string> = {
+  [ServiceSubtype.SingleCellBuild]: 'Single cell',
   [ServiceSubtype.SingleCellSim]: 'Single cell',
+  [ServiceSubtype.SynaptomeBuild]: 'Synaptome',
   [ServiceSubtype.SynaptomeSim]: 'Synaptome',
   [ServiceSubtype.Storage]: 'Storage',
   // TODO: check if the following subtypes are still relevant and find better labels for them

src/components/build-section/virtual-lab/synaptome/molecules/SynaptomeConfigurationForm.tsx

@@ -45,6 +45,8 @@ import { useSessionStorage } from '@/hooks/useSessionStorage';
 import { ExploreESHit, ExploreResource } from '@/types/explore-section/es';
 import { SIMULATION_COLORS } from '@/constants/simulate/single-neuron';
 import { validateFormula } from '@/api/bluenaas/validateSynapseGenerationFormula';
+import { OneshotSession } from '@/services/accounting';
+import { ServiceSubtype } from '@/types/accounting';
 
 const label = (text: string) => (
   <span className="text-base font-semibold text-primary-8">{text}</span>
@@ -263,12 +265,21 @@ export default function SynaptomeConfigurationForm({ org, project, resource }: P
         brainLocation: resource.brainLocation,
       };
 
-      const resp = await fetch(resourceUrl, {
-        method: 'POST',
-        headers: createHeaders(session.accessToken),
-        body: JSON.stringify(sanitizedResource),
+      const accountingSession = new OneshotSession({
+        projectId: project,
+        virtualLabId: org,
+        subtype: ServiceSubtype.SynaptomeBuild,
+        count: 1,
       });
 
+      const resp = await accountingSession.useWith<Response>(() =>
+        fetch(resourceUrl, {
+          method: 'POST',
+          headers: createHeaders(session.accessToken),
+          body: JSON.stringify(sanitizedResource),
+        })
+      );
+
       const newSynaptomeModel: Entity = await resp.json();
 
       refreshSynaptomeModels();