refactored api module

forman · forman · commit b08cbad643ee · 2024-11-11T11:32:59.000+01:00
diff --git a/dashi/src/lib/actions/helpers/getInputValues.ts b/dashi/src/lib/actions/helpers/getInputValues.ts
@@ -1,9 +1,9 @@
 import type { Input } from "@/lib/types/model/channel";
 import type { ContributionState } from "@/lib/types/state/contribution";
 import type { ComponentState } from "@/lib/types/state/component";
-import { isSubscriptable } from "@/lib/utils/isSubscriptable";
 import { isContainerState } from "@/lib/actions/helpers/isContainerState";
 import { getValue } from "@/lib/utils/objPath";
+import { isObject } from "@/lib/utils/isObject";
 
 export function getInputValues<S extends object = object>(
   inputs: Input[],
@@ -67,10 +67,10 @@ export function getInputValueFromState(
   state: unknown,
 ): unknown | undefined {
   let inputValue: unknown = state;
-  if (input.id && isSubscriptable(inputValue)) {
+  if (input.id && isObject(inputValue)) {
     inputValue = inputValue[input.id];
   }
-  if (isSubscriptable(inputValue)) {
+  if (isObject(inputValue)) {
     inputValue = getValue(inputValue, input.property);
   }
   return inputValue;
diff --git a/dashi/src/lib/actions/helpers/invokeCallbacks.ts b/dashi/src/lib/actions/helpers/invokeCallbacks.ts
@@ -1,7 +1,6 @@
 import { store } from "@/lib/store";
 import type { CallbackRequest } from "@/lib/types/model/callback";
-import { fetchApiResult } from "@/lib/utils/fetchApiResult";
-import { fetchStateChangeRequests } from "@/lib/api/fetchStateChangeRequests";
+import { fetchCallback } from "@/lib/api/fetchCallback";
 import { applyStateChangeRequests } from "@/lib/actions/helpers/applyStateChangeRequests";
 
 export function invokeCallbacks(callbackRequests: CallbackRequest[]) {
@@ -13,28 +12,26 @@ export function invokeCallbacks(callbackRequests: CallbackRequest[]) {
   if (import.meta.env.DEV) {
     console.debug(`invokeCallbacks (${invocationId})-->`, callbackRequests);
   }
-  fetchApiResult(
-    fetchStateChangeRequests,
-    callbackRequests,
-    configuration.api,
-  ).then((changeRequestsResult) => {
-    if (changeRequestsResult.data) {
-      if (import.meta.env.DEV) {
-        console.debug(
-          `invokeCallbacks <--(${invocationId})`,
-          changeRequestsResult.data,
+  fetchCallback(callbackRequests, configuration.api).then(
+    (changeRequestsResult) => {
+      if (changeRequestsResult.data) {
+        if (import.meta.env.DEV) {
+          console.debug(
+            `invokeCallbacks <--(${invocationId})`,
+            changeRequestsResult.data,
+          );
+        }
+        applyStateChangeRequests(changeRequestsResult.data);
+      } else {
+        console.error(
+          "callback failed:",
+          changeRequestsResult.error,
+          "for call requests:",
+          callbackRequests,
         );
       }
-      applyStateChangeRequests(changeRequestsResult.data);
-    } else {
-      console.error(
-        "callback failed:",
-        changeRequestsResult.error,
-        "for call requests:",
-        callbackRequests,
-      );
-    }
-  });
+    },
+  );
 }
 
 let invocationCounter = 0;
diff --git a/dashi/src/lib/actions/initializeContributions.ts b/dashi/src/lib/actions/initializeContributions.ts
@@ -1,5 +1,5 @@
 import { store } from "@/lib/store";
-import { type ApiResult, fetchApiResult } from "@/lib/utils/fetchApiResult";
+import { type ApiResult } from "@/lib/api/types";
 import { fetchContributions } from "@/lib/api/fetchContributions";
 import { type Contribution } from "@/lib/types/model/contribution";
 import { type ContributionState } from "@/lib/types/state/contribution";
@@ -16,9 +16,7 @@ export function initializeContributions<S extends object = object>(
   }
   const { configuration } = store.getState();
   store.setState({ contributionsResult: { status: "pending" } });
-  fetchApiResult(fetchContributions, configuration.api).then(
-    initializeContributionsLater,
-  );
+  fetchContributions(configuration.api).then(initializeContributionsLater);
 }
 
 function initializeContributionsLater(
diff --git a/dashi/src/lib/actions/updateContributionContainer.ts b/dashi/src/lib/actions/updateContributionContainer.ts
@@ -1,6 +1,5 @@
 import { store } from "@/lib/store";
-import { fetchInitialComponentState } from "@/lib/api/fetchInitialComponentState";
-import { fetchApiResult } from "@/lib/utils/fetchApiResult";
+import { fetchLayout } from "@/lib/api/fetchLayout";
 import { getInputValues } from "@/lib/actions/helpers/getInputValues";
 import { updateArray } from "@/lib/utils/updateArray";
 import type { ContribPoint } from "@/lib/types/model/extension";
@@ -30,8 +29,7 @@ export function updateContributionContainer<S extends object = object>(
       componentResult: { status: "pending" },
     });
     const inputValues = getLayoutInputValues(contribPoint, contribIndex);
-    fetchApiResult(
-      fetchInitialComponentState,
+    fetchLayout(
       contribPoint,
       contribIndex,
       inputValues,
diff --git a/dashi/src/lib/api/common.ts b/dashi/src/lib/api/common.ts
diff --git a/dashi/src/lib/api/fetchCallback.ts b/dashi/src/lib/api/fetchCallback.ts
@@ -0,0 +1,23 @@
+import {
+  type CallbackRequest,
+  type StateChangeRequest,
+} from "@/lib/types/model/callback";
+import { makeUrl, callApi, fetchApiResult } from "./helpers";
+import type { ApiOptions, ApiResult } from "./types";
+
+export async function fetchCallback(
+  callbackRequests: CallbackRequest[],
+  options?: ApiOptions,
+): Promise<ApiResult<StateChangeRequest[]>> {
+  return fetchApiResult(_fetchCallback, callbackRequests, options);
+}
+
+async function _fetchCallback(
+  callbackRequests: CallbackRequest[],
+  options?: ApiOptions,
+): Promise<StateChangeRequest[]> {
+  return callApi(makeUrl("callback", options), {
+    body: JSON.stringify({ callbackRequests }),
+    method: "post",
+  });
+}
diff --git a/dashi/src/lib/api/fetchContributions.ts b/dashi/src/lib/api/fetchContributions.ts
@@ -1,15 +1,20 @@
 import { type Contributions } from "@/lib/types/model/extension";
 import { type Callback } from "@/lib/types/model/callback";
-import { callApi } from "@/lib/utils/fetchApiResult";
 import { toObjPath } from "@/lib/utils/objPath";
 import { mapObject } from "@/lib/utils/mapObject";
 import type { Contribution } from "@/lib/types/model/contribution";
 import type { Channel } from "@/lib/types/model/channel";
-import type { ApiOptions } from "@/lib/api/types";
-import { makeUrl } from "@/lib/api/common";
+import { makeUrl, callApi, fetchApiResult } from "./helpers";
+import type { ApiOptions, ApiResult } from "./types";
 
 export async function fetchContributions(
   options?: ApiOptions,
+): Promise<ApiResult<Contributions>> {
+  return fetchApiResult(_fetchContributions, options);
+}
+
+export async function _fetchContributions(
+  options?: ApiOptions,
 ): Promise<Contributions> {
   return callApi<Contributions>(
     makeUrl("contributions", options),
diff --git a/dashi/src/lib/api/fetchInitialComponentState.ts b/dashi/src/lib/api/fetchInitialComponentState.ts
diff --git a/dashi/src/lib/api/fetchLayout.ts b/dashi/src/lib/api/fetchLayout.ts
@@ -0,0 +1,31 @@
+import { type ComponentState } from "@/lib/types/state/component";
+import { type ContribPoint } from "@/lib/types/model/extension";
+import { makeUrl, callApi, fetchApiResult } from "./helpers";
+import type { ApiOptions, ApiResult } from "./types";
+
+export async function fetchLayout(
+  contribPoint: ContribPoint,
+  contribIndex: number,
+  inputValues: unknown[],
+  options?: ApiOptions,
+): Promise<ApiResult<ComponentState>> {
+  return fetchApiResult(
+    _fetchLayout,
+    contribPoint,
+    contribIndex,
+    inputValues,
+    options,
+  );
+}
+
+async function _fetchLayout(
+  contribPoint: ContribPoint,
+  contribIndex: number,
+  inputValues: unknown[],
+  options?: ApiOptions,
+): Promise<ComponentState> {
+  return callApi(makeUrl(`layout/${contribPoint}/${contribIndex}`, options), {
+    body: JSON.stringify({ inputValues }),
+    method: "post",
+  });
+}
diff --git a/dashi/src/lib/api/fetchStateChangeRequests.ts b/dashi/src/lib/api/fetchStateChangeRequests.ts
diff --git a/dashi/src/lib/api/helpers.ts b/dashi/src/lib/api/helpers.ts
@@ -1,25 +1,10 @@
-import { hasOwnProperty } from "./hasOwnProperty";
+import type { ApiOptions } from "@/lib/api/types";
 
-export interface ApiResult<T> {
-  status?: "pending" | "ok" | "failed";
-  data?: T;
-  error?: ApiError;
-}
-
-export type ApiError = {
-  message: string;
-  status?: number;
-  traceback?: string[];
-};
+const defaultServerUrl = "http://localhost:8888";
+const defaultEndpointName = "dashi";
 
-export class ApiException extends Error {
-  public readonly apiError: ApiError;
-
-  constructor(apiError: ApiError) {
-    super(apiError.message);
-    this.apiError = apiError;
-  }
-}
+import { hasOwnProperty } from "../utils/hasOwnProperty";
+import type { ApiError, ApiResult } from "./types";
 
 export async function fetchApiResult<T, P extends unknown[]>(
   callApi: (...args: P) => Promise<T>,
@@ -61,3 +46,18 @@ export async function callApi<T, T2 = T>(
   }
   throw new ApiException({ message: `unexpected response from ${url}` });
 }
+
+export class ApiException extends Error {
+  public readonly apiError: ApiError;
+
+  constructor(apiError: ApiError) {
+    super(apiError.message);
+    this.apiError = apiError;
+  }
+}
+
+export function makeUrl(path: string, options?: ApiOptions): string {
+  const serverUrl = options?.serverUrl || defaultServerUrl;
+  const endpointName = options?.endpointName || defaultEndpointName;
+  return `${serverUrl}/${endpointName}/${path}`;
+}
diff --git a/dashi/src/lib/api/types.ts b/dashi/src/lib/api/types.ts
@@ -2,3 +2,15 @@ export interface ApiOptions {
   serverUrl?: string;
   endpointName?: string;
 }
+
+export interface ApiResult<T> {
+  status?: "pending" | "ok" | "failed";
+  data?: T;
+  error?: ApiError;
+}
+
+export type ApiError = {
+  message: string;
+  status?: number;
+  traceback?: string[];
+};
diff --git a/dashi/src/lib/types/state/contribution.ts b/dashi/src/lib/types/state/contribution.ts
@@ -1,4 +1,4 @@
-import type { ApiResult } from "@/lib/utils/fetchApiResult";
+import type { ApiResult } from "@/lib/api/types";
 import type { Contribution } from "@/lib/types/model/contribution";
 import type { ComponentState } from "./component";
 
diff --git a/dashi/src/lib/types/state/store.ts b/dashi/src/lib/types/state/store.ts
@@ -1,13 +1,13 @@
+import type { StoreApi } from "zustand";
+
 import type {
   ContribPoint,
   Contributions,
   Extension,
 } from "@/lib/types/model/extension";
-import type { ApiResult } from "@/lib/utils/fetchApiResult";
 import type { ContributionState } from "@/lib/types/state/contribution";
-import type { ApiOptions } from "@/lib/api/types";
+import type { ApiOptions, ApiResult } from "@/lib/api/types";
 import type { LoggingOptions } from "@/lib/actions/helpers/configureLogging";
-import type { StoreApi } from "zustand";
 
 export interface FrameworkOptions<S extends object = object> {
   /** The host applications state management store. */
diff --git a/dashi/src/lib/utils/isSubscriptable.ts b/dashi/src/lib/utils/isSubscriptable.ts
