@mondaydotcomorg/monday-authorization 3.5.0-upgrade-observability-kit-2ebbd01 → 3.5.1-feat-shaime-support-entity-attributes-in-authorization-sdk-59162a3

package/src/authorization-attributes-service.ts

@@ -1,234 +0,0 @@
-import chunk from 'lodash/chunk.js';
-import { Api, FetcherConfig, HttpClient } from '@mondaydotcomorg/trident-backend-api';
-import { getTopicAttributes, sendToSns } from '@mondaydotcomorg/monday-sns';
-import { HttpFetcherError, RecursivePartial } from '@mondaydotcomorg/monday-fetch-api';
-import {
-  ResourceAttributeAssignment,
-  ResourceAttributeResponse,
-  ResourceAttributesOperation,
-} from './types/authorization-attributes-contracts';
-import { Resource } from './types/general';
-import { logger } from './authorization-internal-service';
-import { getAttributionsFromApi } from './attributions-service';
-import {
-  ASYNC_RESOURCE_ATTRIBUTES_MAX_OPERATIONS_PER_MESSAGE,
-  RESOURCE_ATTRIBUTES_SNS_UPDATE_OPERATION_MESSAGE_KIND,
-  SNS_ARN_ENV_VAR_NAME,
-  SNS_DEV_TEST_NAME,
-} from './constants/sns';
-import { APP_NAME, DEFAULT_FETCH_OPTIONS, ERROR_MESSAGES } from './constants';
-import type { TopicAttributesMap } from 'aws-sdk/clients/sns';
-
-export class AuthorizationAttributesService {
-  private static LOG_TAG = 'authorization_attributes';
-  private static API_PATHS = {
-    UPSERT_RESOURCE_ATTRIBUTES: '/attributes/{accountId}/resource',
-    DELETE_RESOURCE_ATTRIBUTES: '/attributes/{accountId}/resource/{resourceType}/{resourceId}',
-  } as const;
-  private httpClient: HttpClient;
-  private fetchOptions: RecursivePartial<FetcherConfig>;
-  private snsArn: string;
-
-  /**
-   * Public constructor to create the AuthorizationAttributesService instance.
-   * @param httpClient The HTTP client to use for API requests, if not provided, the default HTTP client from Api will be used.
-   * @param fetchOptions The fetch options to use for API requests, if not provided, the default fetch options will be used.
-   */
-  constructor(httpClient?: HttpClient, fetchOptions?: RecursivePartial<FetcherConfig>) {
-    if (!httpClient) {
-      httpClient = Api.getPart('httpClient');
-      if (!httpClient) {
-        throw new Error(ERROR_MESSAGES.HTTP_CLIENT_NOT_INITIALIZED);
-      }
-    }
-
-    if (!fetchOptions) {
-      fetchOptions = DEFAULT_FETCH_OPTIONS;
-    } else {
-      fetchOptions = {
-        ...DEFAULT_FETCH_OPTIONS,
-        ...fetchOptions,
-      };
-    }
-    this.httpClient = httpClient;
-    this.fetchOptions = fetchOptions;
-    this.snsArn = AuthorizationAttributesService.getSnsTopicArn();
-  }
-
-  /**
-   * Upsert resource attributes synchronously, performing http call to the authorization MS to assign the given attributes to the given resource.
-   * @param accountId
-   * @param resourceAttributeAssignments - Array of resource (resourceType, resourceId) and attribute (key, value) pairs to upsert in the authorization MS.
-   * e.g. [{ resourceType: 'board', resourceId: 123, key: 'board_kind', value: 'private' }]
-   * @returns ResourceAttributeResponse - The affected (created and updated_ resource attributes assignments in the `attributes` field.
-   */
-  async upsertResourceAttributes(
-    accountId: number,
-    resourceAttributeAssignments: ResourceAttributeAssignment[]
-  ): Promise<ResourceAttributeResponse> {
-    const attributionHeaders = getAttributionsFromApi();
-    try {
-      return await this.httpClient.fetch<ResourceAttributeResponse>(
-        {
-          url: {
-            appName: APP_NAME,
-            path: AuthorizationAttributesService.API_PATHS.UPSERT_RESOURCE_ATTRIBUTES.replace(
-              '{accountId}',
-              accountId.toString()
-            ),
-          },
-          method: 'POST',
-          headers: {
-            'Content-Type': 'application/json',
-            ...attributionHeaders,
-          },
-          body: JSON.stringify({ resourceAttributeAssignments }),
-        },
-        this.fetchOptions
-      );
-    } catch (err) {
-      if (err instanceof HttpFetcherError) {
-        throw new Error(ERROR_MESSAGES.REQUEST_FAILED('upsertResourceAttributes', err.status, err.message));
-      }
-      throw err;
-    }
-  }
-
-  /**
-   * Delete resource attributes assignments synchronously, performing http call to the authorization MS to delete the given attributes from the given singular resource.
-   * @param accountId
-   * @param resource - The resource (resourceType, resourceId) to delete the attributes for.
-   * @param attributeKeys - Array of attribute keys to delete for the resource.
-   * @returns ResourceAttributeResponse - The affected (deleted) resource attributes assignments in the `attributes` field.
-   */
-  async deleteResourceAttributes(
-    accountId: number,
-    resource: Resource,
-    attributeKeys: string[]
-  ): Promise<ResourceAttributeResponse> {
-    const attributionHeaders = getAttributionsFromApi();
-    if (!resource.id) {
-      throw new Error('Resource ID is required');
-    }
-    try {
-      return await this.httpClient.fetch<ResourceAttributeResponse>(
-        {
-          url: {
-            appName: APP_NAME,
-            path: AuthorizationAttributesService.API_PATHS.DELETE_RESOURCE_ATTRIBUTES.replace(
-              '{accountId}',
-              accountId.toString()
-            )
-              .replace('{resourceType}', resource.type)
-              .replace('{resourceId}', resource.id.toString()),
-          },
-          method: 'DELETE',
-          headers: {
-            'Content-Type': 'application/json',
-            ...attributionHeaders,
-          },
-          body: JSON.stringify({ keys: attributeKeys }),
-        },
-        this.fetchOptions
-      );
-    } catch (err) {
-      if (err instanceof HttpFetcherError) {
-        throw new Error(ERROR_MESSAGES.REQUEST_FAILED('deleteResourceAttributes', err.status, err.message));
-      }
-      throw err;
-    }
-  }
-
-  /**
-   *  Async function, this function only send the updates request to SNS and return before the change actually took place
-   * @param accountId
-   * @param appName - App name of the calling app
-   * @param callerActionIdentifier - action identifier
-   * @param resourceAttributeOperations - Array of operations to do on resource attributes.
-   * @return {Promise<ResourceAttributesOperation[]>} Array of sent operations
-   *  */
-  async updateResourceAttributesAsync(
-    accountId: number,
-    appName: string,
-    callerActionIdentifier: string,
-    resourceAttributeOperations: ResourceAttributesOperation[]
-  ): Promise<ResourceAttributesOperation[]> {
-    const topicArn: string = this.snsArn;
-    const sendToSnsPromises: Promise<ResourceAttributesOperation[]>[] = [];
-    const operationChucks = chunk(resourceAttributeOperations, ASYNC_RESOURCE_ATTRIBUTES_MAX_OPERATIONS_PER_MESSAGE);
-    for (const operationsChunk of operationChucks) {
-      sendToSnsPromises.push(
-        this.sendSingleSnsMessage(topicArn, accountId, appName, callerActionIdentifier, operationsChunk)
-      );
-    }
-    return (await Promise.all(sendToSnsPromises)).flat();
-  }
-
-  private async sendSingleSnsMessage(
-    topicArn: string,
-    accountId: number,
-    appName: string,
-    callerActionIdentifier: string,
-    operations: ResourceAttributesOperation[]
-  ): Promise<ResourceAttributesOperation[]> {
-    const payload = {
-      kind: RESOURCE_ATTRIBUTES_SNS_UPDATE_OPERATION_MESSAGE_KIND,
-      payload: {
-        accountId: accountId,
-        callerAppName: appName,
-        callerActionIdentifier: callerActionIdentifier,
-        operations: operations,
-      },
-    };
-    try {
-      await sendToSns(payload, topicArn);
-      return operations;
-    } catch (error) {
-      logger.error(
-        { error, tag: AuthorizationAttributesService.LOG_TAG },
-        'Authorization resource attributes async update: failed to send operations to SNS'
-      );
-      return [];
-    }
-  }
-
-  private static getSnsTopicArn(): string {
-    const arnFromEnv: string | undefined = process.env[SNS_ARN_ENV_VAR_NAME];
-    if (arnFromEnv) {
-      return arnFromEnv;
-    }
-    if (process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test') {
-      return SNS_DEV_TEST_NAME;
-    }
-    throw new Error('Unable to get sns topic arn from env variable');
-  }
-
-  /**
-   * Checks we can contact the required SNS topic that used to send attribute updates to Authorization MS.
-   * This function can be used as health check for services that updating resource attributes in async is crucial.
-   * Note this function only verify the POD can contact AWS SDK and the topic exists, but the user still might get
-   * errors when pushing for the SNS (e.g: in case the AWS role of the POD don't have permissions to push messages).
-   * However, this is the best we can do without actually push dummy messages to the SNS.
-   * @return {Promise<boolean>} - true if succeeded
-   */
-  async asyncResourceAttributesHealthCheck(): Promise<boolean> {
-    try {
-      const requestedTopicArn: string = this.snsArn;
-      const attributes: TopicAttributesMap = await getTopicAttributes(requestedTopicArn);
-      const isHealthy = !(!attributes || !('TopicArn' in attributes) || attributes.TopicArn !== requestedTopicArn);
-      if (!isHealthy) {
-        logger.error(
-          { requestedTopicArn, snsReturnedAttributes: attributes, tag: AuthorizationAttributesService.LOG_TAG },
-          'authorization-attributes-service failed in health check'
-        );
-      }
-      return isHealthy;
-    } catch (error) {
-      logger.error(
-        { error, tag: AuthorizationAttributesService.LOG_TAG },
-        'authorization-attributes-service got error during health check'
-      );
-      return false;
-    }
-  }
-}