refactor: rename closures to use 'create' prefix for consistency

fonoster · Dec 28, 2024 · 442cc94 · 442cc94
1 parent a7acc57
commit 442cc94
Show file tree

Hide file tree

Showing 98 changed files with 602 additions and 531 deletions.
diff --git a/mods/apiserver/src/applications/createApplication.ts b/mods/apiserver/src/applications/createApplication.ts
@@ -16,8 +16,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { GrpcErrorMessage, withErrorHandling } from "@fonoster/common";
-import { getAccessKeyIdFromCall } from "@fonoster/identity";
+import {
+  getAccessKeyIdFromCall,
+  GrpcErrorMessage,
+  withErrorHandling
+} from "@fonoster/common";
 import { getLogger } from "@fonoster/logger";
 import { BaseApiObject, CreateApplicationRequest } from "@fonoster/types";
 import { ServerInterceptingCall } from "@grpc/grpc-js";

diff --git a/mods/apiserver/src/applications/listApplications.ts b/mods/apiserver/src/applications/listApplications.ts
@@ -19,9 +19,9 @@
 import {
   GrpcErrorMessage,
   Validators as V,
-  withErrorHandlingAndValidation
+  withErrorHandlingAndValidation,
+  getAccessKeyIdFromCall
 } from "@fonoster/common";
-import { getAccessKeyIdFromCall } from "@fonoster/identity";
 import { getLogger } from "@fonoster/logger";
 import {
   ListApplicationsRequest,

diff --git a/mods/apiserver/src/applications/updateApplication.ts b/mods/apiserver/src/applications/updateApplication.ts
@@ -16,15 +16,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { withErrorHandling } from "@fonoster/common";
-import { getAccessKeyIdFromCall, withAccess } from "@fonoster/identity";
+import { getAccessKeyIdFromCall, withErrorHandling } from "@fonoster/common";
 import { getLogger } from "@fonoster/logger";
 import { UpdateApplicationRequest } from "@fonoster/types";
 import { ServerInterceptingCall } from "@grpc/grpc-js";
 import { createGetFnUtil } from "./createGetFnUtil";
 import { convertToApplicationData } from "./utils/convertToApplicationData";
 import { validOrThrow } from "./utils/validOrThrow";
 import { Prisma } from "../core/db";
+import { withAccess } from "@fonoster/identity";
 
 const logger = getLogger({ service: "apiserver", filePath: __filename });
 

diff --git a/mods/apiserver/src/calls/createCall.ts b/mods/apiserver/src/calls/createCall.ts
@@ -19,9 +19,9 @@
 import {
   GrpcErrorMessage,
   Validators as V,
-  withErrorHandlingAndValidation
+  withErrorHandlingAndValidation,
+  getAccessKeyIdFromCall
 } from "@fonoster/common";
-import { getAccessKeyIdFromCall } from "@fonoster/identity";
 import { getLogger } from "@fonoster/logger";
 import { BaseApiObject, CreateCallRequest } from "@fonoster/types";
 import { ServerInterceptingCall } from "@grpc/grpc-js";

diff --git a/mods/apiserver/src/calls/getCall.ts b/mods/apiserver/src/calls/getCall.ts
@@ -20,9 +20,9 @@ import {
   GrpcErrorMessage,
   Validators as V,
   withErrorHandlingAndValidation,
-  InfluxDBClient
+  InfluxDBClient,
+  getAccessKeyIdFromCall
 } from "@fonoster/common";
-import { getAccessKeyIdFromCall } from "@fonoster/identity";
 import { getLogger } from "@fonoster/logger";
 import { ServerInterceptingCall } from "@grpc/grpc-js";
 import { createFetchSingleCall } from "./createFetchSingleCall";

diff --git a/mods/apiserver/src/calls/listCalls.ts b/mods/apiserver/src/calls/listCalls.ts
@@ -20,9 +20,9 @@ import {
   GrpcErrorMessage,
   Validators as V,
   withErrorHandlingAndValidation,
-  InfluxDBClient
+  InfluxDBClient,
+  getAccessKeyIdFromCall
 } from "@fonoster/common";
-import { getAccessKeyIdFromCall } from "@fonoster/identity";
 import { getLogger } from "@fonoster/logger";
 import { ServerInterceptingCall } from "@grpc/grpc-js";
 import { createFetchCalls } from "./createFetchCalls";

diff --git a/mods/apiserver/src/core/httpBridge.ts b/mods/apiserver/src/core/httpBridge.ts
@@ -17,7 +17,7 @@
  * limitations under the License.
  */
 import { Readable } from "stream";
-import { updateMembershipStatus } from "@fonoster/identity";
+import { createUpdateMembershipStatus } from "@fonoster/identity";
 import { getLogger } from "@fonoster/logger";
 import express, { Request, Response } from "express";
 import { identityConfig } from "./identityConfig";
@@ -63,7 +63,9 @@ function httpBridge(params: { port: number }) {
     "/api/identity/accept-invite",
     async (req: Request, res: Response) => {
       try {
-        await updateMembershipStatus(identityConfig)(req.query.token as string);
+        await createUpdateMembershipStatus(identityConfig)(
+          req.query.token as string
+        );
         res.redirect(APP_URL);
       } catch (error) {
         logger.verbose("error updating membership status", error);

diff --git a/mods/apiserver/src/core/runServices.ts b/mods/apiserver/src/core/runServices.ts
@@ -19,9 +19,9 @@
 import {
   GRPC_SERVING_STATUS,
   getServerCredentials,
-  statusMap
+  statusMap,
+  createAuthInterceptor
 } from "@fonoster/common";
-import { createAuthInterceptor } from "@fonoster/identity";
 import { getLogger } from "@fonoster/logger";
 import * as grpc from "@grpc/grpc-js";
 import { HealthImplementation } from "grpc-health-check";

diff --git a/mods/apiserver/src/secrets/createGetFnUtil.ts b/mods/apiserver/src/secrets/createGetFnUtil.ts
@@ -21,7 +21,7 @@ import { Prisma } from "../core/db";
 import { notFoundError } from "../core/notFoundError";
 
 function createGetFnUtil(prisma: Prisma) {
-  return async (ref: string) => {
+  return async function getFnUtil(ref: string) {
     const response = await prisma.secret.findUnique({
       where: { ref }
     });

diff --git a/mods/apiserver/src/secrets/createSecret.ts b/mods/apiserver/src/secrets/createSecret.ts
@@ -19,9 +19,9 @@
 import {
   GrpcErrorMessage,
   Validators as V,
-  withErrorHandlingAndValidation
+  withErrorHandlingAndValidation,
+  getAccessKeyIdFromCall
 } from "@fonoster/common";
-import { getAccessKeyIdFromCall } from "@fonoster/identity";
 import { getLogger } from "@fonoster/logger";
 import { BaseApiObject, CreateSecretRequest } from "@fonoster/types";
 import { ServerInterceptingCall } from "@grpc/grpc-js";

diff --git a/mods/apiserver/src/secrets/listSecrets.ts b/mods/apiserver/src/secrets/listSecrets.ts
@@ -20,9 +20,10 @@ import {
   GrpcErrorMessage,
   Validators as V,
   datesMapper,
-  withErrorHandlingAndValidation
+  withErrorHandlingAndValidation,
+  getAccessKeyIdFromCall
 } from "@fonoster/common";
-import { getAccessKeyIdFromCall } from "@fonoster/identity";
+import {} from "@fonoster/identity";
 import { getLogger } from "@fonoster/logger";
 import { ListSecretsRequest, ListSecretsResponse } from "@fonoster/types";
 import { ServerInterceptingCall } from "@grpc/grpc-js";

diff --git a/mods/apiserver/src/secrets/updateSecret.ts b/mods/apiserver/src/secrets/updateSecret.ts
@@ -16,8 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Validators as V } from "@fonoster/common";
-import { getAccessKeyIdFromCall } from "@fonoster/identity";
+import { Validators as V, getAccessKeyIdFromCall } from "@fonoster/common";
 import { getLogger } from "@fonoster/logger";
 import { UpdateSecretRequest } from "@fonoster/types";
 import { ServerInterceptingCall } from "@grpc/grpc-js";

diff --git a/mods/apiserver/src/voice/createCreateVoiceClient.ts b/mods/apiserver/src/voice/createCreateVoiceClient.ts
@@ -16,7 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { createCallAccessToken } from "@fonoster/identity";
+import { createGenerateCallAccessToken } from "@fonoster/identity";
 import { getLogger } from "@fonoster/logger";
 import { Channel, Client, StasisStart } from "ari-client";
 import { CreateContainer } from "./integrations/types";
@@ -28,7 +28,7 @@ import { mapCallDirectionToEnum } from "../events/mapCallDirectionToEnum";
 
 const logger = getLogger({ service: "apiserver", filePath: __filename });
 
-const createToken = createCallAccessToken(identityConfig);
+const generateCallAccessToken = createGenerateCallAccessToken(identityConfig);
 
 // Note: By the time the call arrives here the owner of the app MUST be authenticated
 function createCreateVoiceClient(
@@ -55,7 +55,7 @@ function createCreateVoiceClient(
 
     const { accessKeyId, endpoint, tts, stt } = await createContainer(appRef);
 
-    const sessionToken = await createToken({ accessKeyId, appRef });
+    const sessionToken = await generateCallAccessToken({ accessKeyId, appRef });
 
     const metadataStr = (await getChannelVar(ChannelVar.METADATA))?.value;
 

diff --git a/mods/authz/src/createCheckMethodAuthorized.ts b/mods/authz/src/createCheckMethodAuthorized.ts
@@ -16,12 +16,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { createInterceptingCall } from "@fonoster/common";
+import {
+  getAccessKeyIdFromCall,
+  createInterceptingCall
+} from "@fonoster/common";
 import { getLogger } from "@fonoster/logger";
 import { ServerInterceptingCall, status } from "@grpc/grpc-js";
 import { AuthzClient } from "./client/AuthzClient";
 import { CheckMethodAuthorizedRequest } from "./types";
-import { getAccessKeyIdFromCall } from "@fonoster/identity";
 
 const logger = getLogger({ service: "authz", filePath: __filename });
 

diff --git a/mods/identity/src/createAuthInterceptor.ts → ...mon/src/identity/createAuthInterceptor.ts b/mods/identity/src/createAuthInterceptor.ts → ...mon/src/identity/createAuthInterceptor.ts
@@ -18,17 +18,15 @@
  */
 import { getLogger } from "@fonoster/logger";
 import { ServerInterceptingCall } from "@grpc/grpc-js";
-import { permissionDeniedError, unauthenticatedError } from "./errors";
-import { Access, TokenUseEnum } from "./exchanges";
 import { workspaceAccess } from "./roles";
-import {
-  decodeToken,
-  getAccessKeyIdFromCall,
-  getTokenFromCall,
-  hasAccess,
-  isValidToken,
-  tokenHasAccessKeyId
-} from "./utils";
+import { getAccessKeyIdFromCall } from "./getAccessKeyIdFromCall";
+import { getTokenFromCall } from "./getTokenFromCall";
+import { isValidToken } from "./isValidToken";
+import { decodeToken } from "./decodeToken";
+import { hasAccess } from "./hasAccess";
+import { Access, TokenUseEnum } from "./types";
+import { tokenHasAccessKeyId } from "./tokenHasAccessKeyId";
+import { permissionDeniedError, unauthenticatedError } from "./errors";
 
 const logger = getLogger({ service: "identity", filePath: __filename });
 

diff --git a/mods/identity/src/utils/decodeToken.ts → mods/common/src/identity/decodeToken.ts b/mods/identity/src/utils/decodeToken.ts → mods/common/src/identity/decodeToken.ts
@@ -17,8 +17,7 @@
  * limitations under the License.
  */
 import { jwtDecode } from "jwt-decode";
-import { TokenUseEnum } from "../exchanges/TokenUseEnum";
-import { DecodedToken } from "../exchanges/types";
+import { TokenUseEnum, DecodedToken } from "./types";
 
 function decodeToken<T extends TokenUseEnum>(token: string): DecodedToken<T> {
   return jwtDecode(token);

diff --git a/mods/identity/src/errors.ts → mods/common/src/identity/errors.ts b/mods/identity/src/errors.ts → mods/common/src/identity/errors.ts
@@ -16,8 +16,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { createInterceptingCall } from "@fonoster/common";
 import { ServerInterceptingCall, status } from "@grpc/grpc-js";
+import { createInterceptingCall } from "../utils";
 
 const unauthenticatedError = (call: ServerInterceptingCall) =>
   createInterceptingCall({

diff --git a/...ntity/src/utils/getAccessKeyIdFromCall.ts → ...on/src/identity/getAccessKeyIdFromCall.ts b/...ntity/src/utils/getAccessKeyIdFromCall.ts → ...on/src/identity/getAccessKeyIdFromCall.ts
diff --git a/mods/identity/src/getPublicKeyClient.ts → mods/common/src/identity/getPublicKey.ts b/mods/identity/src/getPublicKeyClient.ts → mods/common/src/identity/getPublicKey.ts
@@ -16,21 +16,25 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { createServiceDefinition } from "@fonoster/common";
 import * as grpc from "@grpc/grpc-js";
-import { serviceDefinitionParams } from "./service";
+import { createServiceDefinition } from "../utils";
 
 type GetPublicKeyResponse = {
   publicKey: string;
 };
 
 const IdentityServiceClient = grpc.makeGenericClientConstructor(
-  createServiceDefinition(serviceDefinitionParams),
+  createServiceDefinition({
+    serviceName: "Identity",
+    pckg: "identity",
+    proto: "identity.proto",
+    version: "v1beta2"
+  }),
   "",
   {}
 );
 
-function getPublicKeyClient(endpoint: string) {
+function getPublicKey(endpoint: string) {
   return new Promise<GetPublicKeyResponse>((resolve, reject) => {
     const client = new IdentityServiceClient(
       endpoint,
@@ -50,4 +54,4 @@ function getPublicKeyClient(endpoint: string) {
   });
 }
 
-export { getPublicKeyClient };
+export { getPublicKey };
diff --git a/mods/identity/src/utils/getTokenFromCall.ts → mods/common/src/identity/getTokenFromCall.ts b/mods/identity/src/utils/getTokenFromCall.ts → mods/common/src/identity/getTokenFromCall.ts
diff --git a/mods/identity/src/utils/hasAccess.ts → mods/common/src/identity/hasAccess.ts b/mods/identity/src/utils/hasAccess.ts → mods/common/src/identity/hasAccess.ts
@@ -16,17 +16,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Access, Role } from "../exchanges";
-import { roles } from "../roles";
+import { Access, Role } from "./types";
+import { roles } from "./roles";
 
-// This method only checks if the role has access to the path
-function hasAccess(access: Access[], grpcPath: string) {
+// This function only checks if the role has access to the grpc method
+function hasAccess(access: Access[], method: string) {
   const roleList = access.map((a: Access) => a.role);
 
   return roleList.some((r: string) =>
-    roles.find(
-      (role: Role) => role.name === r && role.access.includes(grpcPath)
-    )
+    roles.find((role: Role) => role.name === r && role.access.includes(method))
   );
 }
 

diff --git a/mods/identity/src/JsonWebErrorEnum.ts → mods/common/src/identity/index.ts b/mods/identity/src/JsonWebErrorEnum.ts → mods/common/src/identity/index.ts
@@ -16,9 +16,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-enum JsonWebErrorEnum {
-  JsonWebTokenError = "JsonWebTokenError",
-  TokenExpiredError = "TokenExpiredError"
-}
-
-export { JsonWebErrorEnum };
+export * from "./createAuthInterceptor";
+export * from "./decodeToken";
+export * from "./getPublicKey";
+export * from "./getAccessKeyIdFromCall";
+export * from "./getTokenFromCall";
+export * from "./hasAccess";
+export * from "./isValidToken";
+export * from "./types";
+export * from "./roles";
diff --git a/mods/identity/src/utils/isValidToken.ts → mods/common/src/identity/isValidToken.ts b/mods/identity/src/utils/isValidToken.ts → mods/common/src/identity/isValidToken.ts
@@ -18,7 +18,7 @@
  */
 import { getLogger } from "@fonoster/logger";
 import jwt from "jsonwebtoken";
-import { JsonWebErrorEnum } from "../JsonWebErrorEnum";
+import { JsonWebErrorEnum } from "./types";
 
 const logger = getLogger({ service: "identity", filePath: __filename });
 

diff --git a/mods/identity/src/roles.ts → mods/common/src/identity/roles.ts b/mods/identity/src/roles.ts → mods/common/src/identity/roles.ts
@@ -18,7 +18,7 @@
  * limitations under the License.
  */
 import { ApiRoleEnum, WorkspaceRoleEnum } from "@fonoster/types";
-import { Role } from "./exchanges/types";
+import { Role } from "./types";
 
 const VOICE_SERVICE_ROLE = "VOICE_SERVICE";
 

diff --git a/...identity/src/utils/tokenHasAccessKeyId.ts → ...ommon/src/identity/tokenHasAccessKeyId.ts b/...identity/src/utils/tokenHasAccessKeyId.ts → ...ommon/src/identity/tokenHasAccessKeyId.ts
@@ -16,8 +16,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { decodeToken } from "./decodeToken";
-import { Access, TokenUseEnum } from "../exchanges";
+import { Access, decodeToken, TokenUseEnum } from ".";
 
 function tokenHasAccessKeyId(token: string, accessKeyId: string) {
   const decodedToken = decodeToken<TokenUseEnum.ACCESS>(token);