@mondaydotcomorg/monday-authorization 3.5.1 → 3.5.2-feat-shaime-support-entity-attributes-4-ddec1d3

package/src/authorization-attributes-ms-service.ts

@@ -0,0 +1,438 @@
+import { Api, HttpClient } from '@mondaydotcomorg/trident-backend-api';
+import { signAuthorizationHeader } from '@mondaydotcomorg/monday-jwt';
+import { ResourceAttributeAssignment } from './resource-attribute-assignment';
+import { EntityAttributeAssignment } from './entity-attribute-assignment';
+import {
+  AttributeOperation,
+  ResourceAttributeOperation,
+  EntityAttributeOperation,
+} from './types/authorization-attributes-contracts';
+import { EntityType } from './entity-attributes-constants';
+import { ArgumentError } from './errors/argument-error';
+import { AuthorizationInternalService, logger } from './authorization-internal-service';
+import { getAttributionsFromApi } from './attributions-service';
+import { APP_NAME } from './constants';
+import { ValidationUtils } from './utils/validation';
+import { AuthorizationAttributesService } from './types/authorization-attributes-service.interface';
+import { Resource } from './types/general';
+import { StringNullableChain } from 'lodash';
+const INTERNAL_APP_NAME = 'internal_ms';
+const UPSERT_RESOURCE_ATTRIBUTES_PATH = '/attributes/{accountId}/resource';
+const DELETE_RESOURCE_ATTRIBUTES_PATH = '/attributes/{accountId}/resource/{resourceType}/{resourceId}';
+const UPSERT_ENTITY_ATTRIBUTES_PATH = '/attributes/{accountId}/entity';
+const DELETE_ENTITY_ATTRIBUTES_PATH = '/attributes/{accountId}/entity/{entityType}/{entityId}';
+
+interface DeleteRequestBody {
+  keys: string[];
+}
+
+/**
+ * Service class for managing resource attributes in the authorization microservice.
+ * Provides synchronous HTTP operations to create/update and delete attributes on resources.
+ */
+export class AuthorizationAttributesMsService implements AuthorizationAttributesService {
+  private static LOG_TAG = 'authorization_attributes_ms';
+  private static httpClient: HttpClient | null = Api.getPart('httpClient') ?? null;
+
+  public static destroyHttpClient(): void {
+    AuthorizationAttributesMsService.httpClient = null;
+  }
+
+  /**
+   * Creates or updates resource attributes synchronously.
+   * @param accountId The account ID
+   * @param resourceAttributeAssignments Array of ResourceAttributeAssignment objects
+   * @returns Promise<void>
+   */
+  async upsertResourceAttributes(
+    accountId: number,
+    resourceAttributeAssignments: ResourceAttributeAssignment[],
+    _appName?: string,
+    _callerActionIdentifier?: string
+  ): Promise<void> {
+    return AuthorizationAttributesMsService.executeUpsertRequest(
+      accountId,
+      resourceAttributeAssignments,
+      UPSERT_RESOURCE_ATTRIBUTES_PATH,
+      'resourceAttributeAssignments',
+      ResourceAttributeAssignment,
+      'resource',
+      'upsertResourceAttributes'
+    );
+  }
+
+  /**
+   * Deletes specific attributes from a resource synchronously.
+   * @param accountId The account ID
+   * @param resource Object with resourceType (string) and resourceId (number)
+   * @param attributeKeys Array of attribute key strings to delete
+   * @returns Promise<void>
+   */
+  async deleteResourceAttributes(
+    accountId: number,
+    resource: Resource,
+    attributeKeys: string[],
+    _appName?: string,
+    _callerActionIdentifier?: string
+  ): Promise<void> {
+    ValidationUtils.validateResource(resource);
+    ValidationUtils.validateStringArray(attributeKeys);
+    return AuthorizationAttributesMsService.executeDeleteRequest(
+      accountId,
+      DELETE_RESOURCE_ATTRIBUTES_PATH,
+      {
+        resourceType: resource.type,
+        resourceId: resource.id as number,
+      },
+      attributeKeys,
+      'resource',
+      'deleteResourceAttributesSync',
+      { resource }
+    );
+  }
+
+  /**
+   * Creates or updates entity attributes synchronously.
+   * @param accountId The account ID
+   * @param entityAttributeAssignments Array of EntityAttributeAssignment objects
+   * @returns Promise<void>
+   */
+  async upsertEntityAttributes(
+    accountId: number,
+    entityAttributeAssignments: EntityAttributeAssignment[],
+    _appName?: string,
+    _callerActionIdentifier?: string
+  ): Promise<void> {
+    return AuthorizationAttributesMsService.executeUpsertRequest(
+      accountId,
+      entityAttributeAssignments,
+      UPSERT_ENTITY_ATTRIBUTES_PATH,
+      'entityAttributeAssignments',
+      EntityAttributeAssignment,
+      'entity',
+      'upsertEntityAttributesSync'
+    );
+  }
+
+  /**
+   * Deletes specific attributes from an entity synchronously.
+   * @param accountId The account ID
+   * @param entityType The entity type
+   * @param entityId The entity ID
+   * @param attributeKeys Array of attribute key strings to delete
+   * @returns Promise<void>
+   */
+  async deleteEntityAttributes(
+    accountId: number,
+    entityType: EntityType,
+    entityId: number,
+    attributeKeys: string[],
+    _appName?: string,
+    _callerActionIdentifier?: string
+  ): Promise<void> {
+    if (!entityType || typeof entityType !== 'string' || entityType.trim() === '') {
+      throw new ArgumentError(`entityType must be a non-empty string, got: ${entityType}`);
+    }
+    ValidationUtils.validateInteger(entityId);
+
+    return AuthorizationAttributesMsService.executeDeleteRequest(
+      accountId,
+      DELETE_ENTITY_ATTRIBUTES_PATH,
+      {
+        entityType,
+        entityId,
+      },
+      attributeKeys,
+      'entity',
+      'deleteEntityAttributesSync',
+      { entityType, entityId }
+    );
+  }
+
+  /**
+   * Updates resource attributes (batch operations).
+   * Note: MS service does not support batch operations directly.
+   * This method processes operations sequentially using upsert/delete methods.
+   * @param accountId The account ID
+   * @param appName App name (required for interface compatibility, but not used in MS service)
+   * @param callerActionIdentifier Action identifier (required for interface compatibility, but not used in MS service)
+   * @param resourceAttributeOperations Array of operations to perform
+   * @returns Promise<ResourceAttributesOperation[]> Array of processed operations
+   */
+  async updateResourceAttributes(
+    accountId: number,
+    _appName: string,
+    _callerActionIdentifier: string,
+    resourceAttributeOperations: ResourceAttributeOperation[]
+  ): Promise<ResourceAttributeOperation[]> {
+    const processedOperations: ResourceAttributeOperation[] = [];
+
+    for (const operation of resourceAttributeOperations) {
+      if (operation.operationType === AttributeOperation.UPSERT) {
+        if (!operation.resourceId) {
+          throw new ArgumentError('resourceId is required for upsert operation');
+        }
+        await this.upsertResourceAttributes(accountId, [
+          new ResourceAttributeAssignment(
+            operation.resourceId,
+            operation.resourceType,
+            operation.key,
+            operation.value || ''
+          ),
+        ]);
+        processedOperations.push(operation);
+      } else if (operation.operationType === AttributeOperation.DELETE) {
+        if (!operation.resourceId) {
+          throw new ArgumentError('resourceId is required for delete operation');
+        }
+        await this.deleteResourceAttributes(
+          accountId,
+          {
+            type: operation.resourceType,
+            id: operation.resourceId,
+          },
+          [operation.key]
+        );
+        processedOperations.push(operation);
+      }
+    }
+
+    return processedOperations;
+  }
+
+  /**
+   * Updates entity attributes (batch operations).
+   * Note: MS service does not support batch operations directly.
+   * This method processes operations sequentially using upsert/delete methods.
+   * @param accountId The account ID
+   * @param appName App name (required for interface compatibility, but not used in MS service)
+   * @param callerActionIdentifier Action identifier (required for interface compatibility, but not used in MS service)
+   * @param entityAttributeOperations Array of operations to perform
+   * @returns Promise<EntityAttributesOperation[]> Array of processed operations
+   */
+  async updateEntityAttributes(
+    accountId: number,
+    _appName: string,
+    _callerActionIdentifier: string,
+    entityAttributeOperations: EntityAttributeOperation[]
+  ): Promise<EntityAttributeOperation[]> {
+    const processedOperations: EntityAttributeOperation[] = [];
+    for (const operation of entityAttributeOperations) {
+      if (operation.operationType === 'upsert') {
+        await this.upsertEntityAttributes(accountId, [
+          new EntityAttributeAssignment(operation.entityId, operation.entityType, operation.key, operation.value || ''),
+        ]);
+        processedOperations.push(operation);
+      } else if (operation.operationType === 'delete') {
+        await this.deleteEntityAttributes(accountId, operation.entityType, operation.entityId, [operation.key]);
+        processedOperations.push(operation);
+      }
+    }
+
+    return processedOperations;
+  }
+
+  /**
+   * Replaces path template parameters with actual values
+   * @param template Path template with placeholders like {accountId}
+   * @param params Object with parameter names and values
+   * @returns Path with all placeholders replaced
+   */
+  private static replacePathParams(template: string, params: Record<string, string | number>): string {
+    let path = template;
+    for (const [key, value] of Object.entries(params)) {
+      path = path.replace(`{${key}}`, String(value));
+    }
+    return path;
+  }
+
+  /**
+   * Generic helper for executing delete requests
+   */
+  private static async executeDeleteRequest(
+    accountId: number,
+    pathTemplate: string,
+    pathParams: Record<string, string | number>,
+    keys: string[],
+    logPrefix: string,
+    methodName: string,
+    context: Record<string, any> = {}
+  ): Promise<void> {
+    // Validate inputs
+    ValidationUtils.validateInteger(accountId);
+    ValidationUtils.validateStringArray(keys);
+
+    if (!keys.length) {
+      logger.warn({ tag: this.LOG_TAG, accountId, ...pathParams }, `${methodName} called with empty keys array`);
+      return;
+    }
+    const requestBody: DeleteRequestBody = { keys };
+
+    if (!AuthorizationAttributesMsService.httpClient) {
+      throw new Error('AuthorizationAttributesMsService: HTTP client is not initialized');
+    }
+    const path = AuthorizationAttributesMsService.replacePathParams(pathTemplate, { accountId, ...pathParams });
+    const headers = AuthorizationAttributesMsService.getRequestHeaders(accountId);
+
+    try {
+      logger.info(
+        { tag: AuthorizationAttributesMsService.LOG_TAG, accountId, ...pathParams, keys },
+        `Deleting ${logPrefix} attributes`
+      );
+
+      await AuthorizationAttributesMsService.httpClient.fetch(
+        {
+          url: {
+            appName: APP_NAME,
+            path,
+          },
+          method: 'DELETE',
+          headers,
+          body: JSON.stringify(requestBody),
+        },
+        {
+          timeout: AuthorizationInternalService.getRequestTimeout(),
+          retryPolicy: AuthorizationInternalService.getRetriesPolicy(),
+        }
+      );
+
+      logger.debug(
+        { tag: AuthorizationAttributesMsService.LOG_TAG, accountId, ...pathParams, keys },
+        `Successfully deleted ${logPrefix} attributes`
+      );
+    } catch (err) {
+      logger.error(
+        {
+          tag: AuthorizationAttributesMsService.LOG_TAG,
+          method: methodName,
+          accountId,
+          ...pathParams,
+          ...context,
+          error: err instanceof Error ? err.message : String(err),
+        },
+        `Failed in ${methodName}`
+      );
+      throw err;
+    }
+  }
+
+  /**
+   * Gets request headers including Authorization, Content-Type, and optional attribution headers
+   */
+  private static getRequestHeaders(accountId: number, userId?: number): Record<string, string> {
+    const headers: Record<string, string> = {
+      'Content-Type': 'application/json',
+    };
+
+    // Generate Authorization token
+    const authToken = signAuthorizationHeader({
+      appName: INTERNAL_APP_NAME,
+      accountId,
+      userId,
+    });
+    headers.Authorization = authToken;
+
+    // Add attribution headers if available
+    const attributionHeaders = getAttributionsFromApi();
+    for (const key in attributionHeaders) {
+      if (Object.prototype.hasOwnProperty.call(attributionHeaders, key)) {
+        headers[key] = attributionHeaders[key];
+      }
+    }
+
+    // Add X-REQUEST-ID if available from context
+    try {
+      const tridentContext = Api.getPart('context');
+      if (tridentContext?.runtimeAttributions) {
+        const outgoingHeaders = tridentContext.runtimeAttributions.buildOutgoingHeaders('HTTP_INTERNAL');
+        if (outgoingHeaders) {
+          const attributionHeadersMap: Record<string, string> = {};
+          for (const [key, value] of outgoingHeaders) {
+            attributionHeadersMap[key] = value;
+          }
+          if (attributionHeadersMap['x-request-id']) {
+            headers['X-REQUEST-ID'] = attributionHeadersMap['x-request-id'];
+          }
+        }
+      }
+    } catch (error) {
+      // Silently fail if context is not available
+      logger.debug({ tag: AuthorizationAttributesMsService.LOG_TAG, error }, 'Failed to get request ID from context');
+    }
+
+    // Add X-REQUEST-START timestamp
+    headers['X-REQUEST-START'] = Math.floor(Date.now() / 1000).toString();
+
+    return headers;
+  }
+
+  /**
+   * Generic helper for executing upsert requests
+   */
+  private static async executeUpsertRequest<T extends ResourceAttributeAssignment | EntityAttributeAssignment>(
+    accountId: number,
+    assignments: T[],
+    pathTemplate: string,
+    requestBodyKey: 'resourceAttributeAssignments' | 'entityAttributeAssignments',
+    assignmentClass: abstract new (...args: any[]) => T,
+    logPrefix: string,
+    methodName: string
+  ): Promise<void> {
+    ValidationUtils.validateInteger(accountId);
+    ValidationUtils.validateArrayTypeOf(assignments, assignmentClass);
+    if (!assignments.length) {
+      return;
+    }
+    const assignmentDto = assignments.map(assignment => assignment.toDataTransferObject());
+
+    const requestBody =
+      requestBodyKey === 'resourceAttributeAssignments'
+        ? { resourceAttributeAssignments: assignmentDto }
+        : { entityAttributeAssignments: assignmentDto };
+
+    if (!AuthorizationAttributesMsService.httpClient) {
+      throw new Error('AuthorizationAttributesMsService: HTTP client is not initialized');
+    }
+    const path = AuthorizationAttributesMsService.replacePathParams(pathTemplate, { accountId });
+    const headers = AuthorizationAttributesMsService.getRequestHeaders(accountId);
+
+    try {
+      logger.info(
+        { tag: AuthorizationAttributesMsService.LOG_TAG, accountId, count: assignments.length },
+        `Upserting ${logPrefix} attributes`
+      );
+
+      await AuthorizationAttributesMsService.httpClient.fetch(
+        {
+          url: {
+            appName: APP_NAME,
+            path,
+          },
+          method: 'POST',
+          headers,
+          body: JSON.stringify(requestBody),
+        },
+        {
+          timeout: AuthorizationInternalService.getRequestTimeout(),
+          retryPolicy: AuthorizationInternalService.getRetriesPolicy(),
+        }
+      );
+
+      logger.debug(
+        { tag: AuthorizationAttributesMsService.LOG_TAG, accountId, count: assignments.length },
+        `Successfully upserted ${logPrefix} attributes`
+      );
+    } catch (err) {
+      logger.error(
+        {
+          tag: AuthorizationAttributesMsService.LOG_TAG,
+          method: methodName,
+          accountId,
+          error: err instanceof Error ? err.message : String(err),
+        },
+        `Failed in ${methodName}`
+      );
+      throw err;
+    }
+  }
+}