@mondaydotcomorg/monday-authorization 3.6.0-feat-shaime-support-entity-attributes-1-f58d933 → 3.6.0-feat-shaime-support-entity-attributes-3-78dca48

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

@@ -0,0 +1,321 @@
+import chunk from 'lodash/chunk.js';
+import { getTopicAttributes, sendToSns } from '@mondaydotcomorg/monday-sns';
+import {
+  AttributeOperation,
+  ResourceAttributeUpsertOperation,
+  EntityAttributeUpsertOperation,
+  EntityAttributeDeleteOperation,
+  ResourceAttributeDeleteOperation,
+} from './types/authorization-attributes-contracts';
+import { Resource } from './types/general';
+import { logger } from './authorization-internal-service';
+import {
+  ASYNC_RESOURCE_ATTRIBUTES_MAX_OPERATIONS_PER_MESSAGE,
+  ASYNC_ENTITY_ATTRIBUTES_MAX_OPERATIONS_PER_MESSAGE,
+  RESOURCE_ATTRIBUTES_SNS_UPDATE_OPERATION_MESSAGE_KIND,
+  ENTITY_ATTRIBUTES_SNS_UPDATE_OPERATION_MESSAGE_KIND,
+  RESOURCE_SNS_ARN_ENV_VAR_NAME,
+  ENTITY_SNS_ARN_ENV_VAR_NAME,
+  RESOURCE_SNS_DEV_TEST_NAME,
+  ENTITY_SNS_DEV_TEST_NAME,
+  SnsTopicType,
+} from './constants/sns';
+import { AuthorizationAttributesService } from './types/authorization-attributes-service.interface';
+import { EntityType } from './entity-attributes-constants';
+import { ValidationUtils } from './utils/validation';
+import type { TopicAttributesMap } from 'aws-sdk/clients/sns';
+
+/**
+ * Service class for managing resource attributes asynchronously via SNS.
+ * Provides asynchronous operations to create/update and delete attributes on resources.
+ */
+export class AuthorizationAttributesSnsService implements AuthorizationAttributesService {
+  private static LOG_TAG = 'authorization_attributes';
+  private resourceSnsArn: string;
+  private entitySnsArn: string;
+
+  /**
+   * Public constructor to create the AuthorizationAttributesSnsService instance.
+   */
+  constructor() {
+    this.resourceSnsArn = AuthorizationAttributesSnsService.getSnsTopicArn(SnsTopicType.RESOURCE);
+    this.entitySnsArn = AuthorizationAttributesSnsService.getSnsTopicArn(SnsTopicType.ENTITY);
+  }
+
+  /**
+   * Async function to delete a resource attribute using SNS.
+   * Sends the delete request to SNS and returns before the change actually took place.
+   * @param accountId The account ID
+   * @param resource The resource (resourceType, resourceId)
+   * @param attributeKey Attribute key to delete
+   * @param appName App name of the calling app
+   * @param callerActionIdentifier Action identifier
+   * @return Promise with sent operation
+   */
+  async deleteResourceAttributes(
+    accountId: number,
+    resource: Resource,
+    attributeKey: string,
+    appName?: string,
+    callerActionIdentifier?: string
+  ): Promise<ResourceAttributeDeleteOperation> {
+    if (!appName || !callerActionIdentifier) {
+      throw new Error('appName and callerActionIdentifier are required for SNS service');
+    }
+    ValidationUtils.validatDeleteResourceAssignment({
+      resourceType: resource.type,
+      resourceId: resource.id,
+      key: attributeKey,
+    });
+    const operation: ResourceAttributeDeleteOperation = {
+      resourceType: resource.type,
+      resourceId: resource.id,
+      key: attributeKey,
+      operationType: AttributeOperation.DELETE,
+    };
+    const [result] = await this.sendOperationsToSns(
+      this.resourceSnsArn,
+      accountId,
+      appName,
+      callerActionIdentifier,
+      [operation],
+      ASYNC_RESOURCE_ATTRIBUTES_MAX_OPERATIONS_PER_MESSAGE,
+      RESOURCE_ATTRIBUTES_SNS_UPDATE_OPERATION_MESSAGE_KIND,
+      'Authorization resource attributes async delete: failed to send operations to SNS'
+    );
+    return result;
+  }
+
+  /**
+   * Async function to delete an entity attribute using SNS.
+   * Sends the delete request to SNS and returns before the change actually took place.
+   * @param accountId The account ID
+   * @param entityType The entity type
+   * @param entityId The entity ID
+   * @param attributeKey Attribute key to delete
+   * @param appName App name of the calling app
+   * @param callerActionIdentifier Action identifier
+   * @return Promise with sent operation
+   */
+  async deleteEntityAttributes(
+    accountId: number,
+    entityType: EntityType,
+    entityId: number,
+    attributeKey: string,
+    appName?: string,
+    callerActionIdentifier?: string
+  ): Promise<EntityAttributeDeleteOperation> {
+    if (!appName || !callerActionIdentifier) {
+      throw new Error('appName and callerActionIdentifier are required for SNS service');
+    }
+    ValidationUtils.validatDeleteEntityAssignment({ entityId, entityType, key: attributeKey });
+    const operation: EntityAttributeDeleteOperation = {
+      entityType: entityType,
+      entityId,
+      key: attributeKey,
+      operationType: AttributeOperation.DELETE,
+    };
+    const [result] = await this.sendOperationsToSns(
+      this.entitySnsArn,
+      accountId,
+      appName,
+      callerActionIdentifier,
+      [operation],
+      ASYNC_ENTITY_ATTRIBUTES_MAX_OPERATIONS_PER_MESSAGE,
+      ENTITY_ATTRIBUTES_SNS_UPDATE_OPERATION_MESSAGE_KIND,
+      'Authorization entity attributes async delete: failed to send operations to SNS'
+    );
+    return result;
+  }
+
+  /**
+   *  Async function, this function only send the update 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 resourceAttributeOperation - Operation to do on resource attribute.
+   * @return {Promise<ResourceAttributeUpsertOperation>} Sent operation
+   *  */
+  async updateResourceAttributes(
+    accountId: number,
+    appName: string,
+    callerActionIdentifier: string,
+    resourceAttributeOperation: ResourceAttributeUpsertOperation
+  ): Promise<ResourceAttributeUpsertOperation> {
+    ValidationUtils.validatUpsertResourceAssignment(resourceAttributeOperation);
+    const [result] = await this.sendOperationsToSns(
+      this.resourceSnsArn,
+      accountId,
+      appName,
+      callerActionIdentifier,
+      [resourceAttributeOperation],
+      ASYNC_RESOURCE_ATTRIBUTES_MAX_OPERATIONS_PER_MESSAGE,
+      RESOURCE_ATTRIBUTES_SNS_UPDATE_OPERATION_MESSAGE_KIND,
+      'Authorization resource attributes async update: failed to send operations to SNS'
+    );
+    return result;
+  }
+
+  /**
+   *  Async function, this function only send the update 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 entityAttributeOperation - Operation to do on entity attribute.
+   * @return {Promise<EntityAttributeUpsertOperation>} Sent operation
+   *  */
+  async updateEntityAttributes(
+    accountId: number,
+    appName: string,
+    callerActionIdentifier: string,
+    entityAttributeOperation: EntityAttributeUpsertOperation
+  ): Promise<EntityAttributeUpsertOperation> {
+    ValidationUtils.validatUpsertEntityAssignment(entityAttributeOperation);
+    const [result] = await this.sendOperationsToSns(
+      this.entitySnsArn,
+      accountId,
+      appName,
+      callerActionIdentifier,
+      [entityAttributeOperation],
+      ASYNC_ENTITY_ATTRIBUTES_MAX_OPERATIONS_PER_MESSAGE,
+      ENTITY_ATTRIBUTES_SNS_UPDATE_OPERATION_MESSAGE_KIND,
+      'Authorization entity attributes async update: failed to send operations to SNS'
+    );
+    return result;
+  }
+
+  /**
+   * Base function to send attribute operations to SNS.
+   * Chunks operations and sends them in parallel.
+   * @param topicArn The SNS topic ARN to send messages to
+   * @param accountId The account ID
+   * @param appName App name of the calling app
+   * @param callerActionIdentifier Action identifier
+   * @param operations Array of operations to send
+   * @param chunkSize Maximum number of operations per message
+   * @param messageKind The kind of message being sent
+   * @param errorLogMessage Error message to log if sending fails
+   * @return Promise with array of sent operations
+   */
+  private async sendOperationsToSns<
+    T extends
+      | ResourceAttributeUpsertOperation
+      | ResourceAttributeDeleteOperation
+      | EntityAttributeUpsertOperation
+      | EntityAttributeDeleteOperation
+  >(
+    topicArn: string,
+    accountId: number,
+    appName: string,
+    callerActionIdentifier: string,
+    operations: T[],
+    chunkSize: number,
+    messageKind: string,
+    errorLogMessage: string
+  ): Promise<T[]> {
+    const sendToSnsPromises: Promise<T[]>[] = [];
+    const operationChunks = chunk(operations, chunkSize);
+    for (const operationsChunk of operationChunks) {
+      sendToSnsPromises.push(
+        this.sendSingleSnsMessage(
+          topicArn,
+          accountId,
+          appName,
+          callerActionIdentifier,
+          operationsChunk,
+          messageKind,
+          errorLogMessage
+        )
+      );
+    }
+    return (await Promise.all(sendToSnsPromises)).flat();
+  }
+
+  private async sendSingleSnsMessage<
+    T extends
+      | ResourceAttributeUpsertOperation
+      | ResourceAttributeDeleteOperation
+      | EntityAttributeUpsertOperation
+      | EntityAttributeDeleteOperation
+  >(
+    topicArn: string,
+    accountId: number,
+    appName: string,
+    callerActionIdentifier: string,
+    operations: T[],
+    kind: string,
+    errorLogMessage: string
+  ): Promise<T[]> {
+    const payload = {
+      kind,
+      payload: {
+        accountId: accountId,
+        callerAppName: appName,
+        callerActionIdentifier: callerActionIdentifier,
+        operations: operations,
+      },
+    };
+    try {
+      await sendToSns(payload, topicArn);
+      return operations;
+    } catch (error) {
+      logger.error({ error, tag: AuthorizationAttributesSnsService.LOG_TAG }, errorLogMessage);
+      return [];
+    }
+  }
+
+  private static getSnsTopicArn(type: SnsTopicType): string {
+    let envVarName: string;
+    let devTestName: string;
+
+    switch (type) {
+      case SnsTopicType.ENTITY:
+        envVarName = ENTITY_SNS_ARN_ENV_VAR_NAME;
+        devTestName = ENTITY_SNS_DEV_TEST_NAME;
+        break;
+      default:
+        // Default to resource SNS constants
+        envVarName = RESOURCE_SNS_ARN_ENV_VAR_NAME;
+        devTestName = RESOURCE_SNS_DEV_TEST_NAME;
+        break;
+    }
+
+    const arnFromEnv: string | undefined = process.env[envVarName];
+    if (arnFromEnv) {
+      return arnFromEnv;
+    }
+    if (process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test') {
+      return devTestName;
+    }
+    throw new Error(`Unable to get ${type} 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.resourceSnsArn;
+      const attributes: TopicAttributesMap = await getTopicAttributes(requestedTopicArn);
+      const isHealthy = !(!attributes || !('TopicArn' in attributes) || attributes.TopicArn !== requestedTopicArn);
+      if (!isHealthy) {
+        logger.error(
+          { requestedTopicArn, snsReturnedAttributes: attributes, tag: AuthorizationAttributesSnsService.LOG_TAG },
+          'authorization-attributes-service failed in health check'
+        );
+      }
+      return isHealthy;
+    } catch (error) {
+      logger.error(
+        { error, tag: AuthorizationAttributesSnsService.LOG_TAG },
+        'authorization-attributes-service got error during health check'
+      );
+      return false;
+    }
+  }
+}

package/src/constants/sns.ts

@@ -1,5 +1,22 @@
-export const SNS_ARN_ENV_VAR_NAME = 'SHARED_AUTHORIZATION_SNS_ENDPOINT_RESOURCE_ATTRIBUTES';
-export const SNS_DEV_TEST_NAME =
+export enum SnsTopicType {
+  RESOURCE = 'resource',
+  ENTITY = 'entity',
+}
+
+// Resource SNS constants
+export const RESOURCE_SNS_ARN_ENV_VAR_NAME = 'SHARED_AUTHORIZATION_SNS_ENDPOINT_RESOURCE_ATTRIBUTES';
+export const RESOURCE_SNS_DEV_TEST_NAME =
   'arn:aws:sns:us-east-1:000000000000:monday-authorization-resource-attributes-sns-local';
+
+// Entity SNS constants
+export const ENTITY_SNS_ARN_ENV_VAR_NAME = 'SHARED_AUTHORIZATION_SNS_ENDPOINT_ENTITY_ATTRIBUTES';
+export const ENTITY_SNS_DEV_TEST_NAME =
+  'arn:aws:sns:us-east-1:000000000000:monday-authorization-entity-attributes-sns-local';
 export const RESOURCE_ATTRIBUTES_SNS_UPDATE_OPERATION_MESSAGE_KIND = 'resourceAttributeModification';
+export const ENTITY_ATTRIBUTES_SNS_UPDATE_OPERATION_MESSAGE_KIND = 'entityAttributeModification';
 export const ASYNC_RESOURCE_ATTRIBUTES_MAX_OPERATIONS_PER_MESSAGE = 100;
+export const ASYNC_ENTITY_ATTRIBUTES_MAX_OPERATIONS_PER_MESSAGE = 100;
+
+// Legacy exports for backward compatibility
+export const SNS_ARN_ENV_VAR_NAME = RESOURCE_SNS_ARN_ENV_VAR_NAME;
+export const SNS_DEV_TEST_NAME = RESOURCE_SNS_DEV_TEST_NAME;

package/src/entity-attribute-assignment.ts

@@ -1,14 +1,12 @@
 import { EntityType } from './entity-attributes-constants';
 import { BaseAttributeAssignment } from './base-attribute-assignment';
 import { EntityAttributeAssignment as EntityAttributeAssignmentContract } from './types/authorization-attributes-contracts';
-import { ValidationUtils } from './utils/validation';
 
 export class EntityAttributeAssignment extends BaseAttributeAssignment<EntityType, EntityAttributeAssignmentContract> {
   public readonly entityId: number;
   public readonly entityType: EntityType;
 
   constructor(entityId: number, entityType: EntityType, key: string, value: string) {
-    ValidationUtils.validateEntityAssignment({ entityId, entityType, key, value });
     super(entityId, entityType, key, value);
     this.entityId = entityId;
     this.entityType = entityType;

package/src/index.ts

@@ -58,6 +58,8 @@ export {
 } from './authorization-middleware';
 export { AuthorizationService, AuthorizeResponse } from './authorization-service';
 export { AuthorizationAttributesService } from './authorization-attributes-service';
+export * from 'resource-attributes-constants';
+export * from './entity-attributes-constants';
 export { RolesService } from './roles-service';
 export { MembershipsService } from './memberships';
 export { AuthorizationObject, Resource, BaseRequest, ResourceGetter, ContextGetter } from './types/general';

package/src/resource-attribute-assignment.ts

@@ -1,7 +1,6 @@
 import { ResourceType } from './resource-attributes-constants';
 import { BaseAttributeAssignment } from './base-attribute-assignment';
 import { ResourceAttributeAssignment as ResourceAttributeAssignmentContract } from './types/authorization-attributes-contracts';
-import { ValidationUtils } from './utils/validation';
 
 export class ResourceAttributeAssignment extends BaseAttributeAssignment<
   ResourceType,
@@ -11,7 +10,6 @@ export class ResourceAttributeAssignment extends BaseAttributeAssignment<
   public readonly resourceType: ResourceType;
 
   constructor(resourceId: number, resourceType: ResourceType, attributeKey: string, attributeValue: string) {
-    ValidationUtils.validateResourceAssignment({ resourceId, resourceType, key: attributeKey, value: attributeValue });
     super(resourceId, resourceType, attributeKey, attributeValue);
     this.resourceId = resourceId;
     this.resourceType = this.type;

package/src/resource-attributes-constants.ts

@@ -21,6 +21,7 @@ export enum ResourceType {
   Overview = 'overview',
   Document = 'document',
   Crm = 'crm',
+  Feature = 'feature',
 }
 
 // Define the array of strings and use 'as const' to make its contents literal types

package/src/types/authorization-attributes-contracts.ts

@@ -12,6 +12,7 @@ export interface ResourceAttributeAssignment extends AttributeAssignment {
   resourceId: number;
   resourceType: ResourceType;
 }
+export type ResourceAttributeDeleteAssignment = Omit<ResourceAttributeAssignment, 'value'>;
 
 // Entity Attribute Assignment - matching API contract
 // Note: For validation, use the EntityAttributeAssignment class from '../entity-attribute-assignment'
@@ -19,6 +20,7 @@ export interface EntityAttributeAssignment extends AttributeAssignment {
   entityId: number;
   entityType: EntityType;
 }
+export type EntityAttributeDeleteAssignment = Omit<EntityAttributeAssignment, 'value'>;
 
 // Legacy types for backward compatibility
 export interface ResourceAttributeDelete {

package/src/types/authorization-attributes-service.interface.ts

@@ -7,69 +7,57 @@ import {
 } from './authorization-attributes-contracts';
 import { Resource } from './general';
 
-/**
- * Resource type compatible with both MS and SNS services
- */
-export interface CompatibleResource {
-  resourceType?: string;
-  resourceId?: number;
-  type?: string;
-  id?: number;
-}
-
 /**
  * Interface for authorization attributes operations.
  * Both MS (direct) and SNS (async) services implement this interface.
  */
 export interface AuthorizationAttributesService {
   /**
-   * Deletes resource attributes.
-   * For MS service: returns Promise<void>
-   * For SNS service: requires appName and callerActionIdentifier, returns Promise<ResourceAttributesOperation[]>
+   * Deletes a resource attribute.
+   * Returns Promise<ResourceAttributeDeleteOperation>
    */
   deleteResourceAttributes(
     accountId: number,
-    resource: CompatibleResource | Resource,
-    attributeKeys: string[],
+    resource: Resource,
+    attributeKey: string,
     appName?: string,
     callerActionIdentifier?: string
-  ): Promise<void | ResourceAttributeDeleteOperation[]>;
+  ): Promise<ResourceAttributeDeleteOperation>;
 
   /**
-   * Deletes entity attributes.
-   * For MS service: returns Promise<void>
-   * For SNS service: requires appName and callerActionIdentifier, returns Promise<EntityAttributesOperation[]>
+   * Deletes an entity attribute.
+   * Returns Promise<EntityAttributeDeleteOperation>
    */
   deleteEntityAttributes(
     accountId: number,
     entityType: EntityType | string,
     entityId: number,
-    attributeKeys: string[],
+    attributeKey: string,
     appName?: string,
     callerActionIdentifier?: string
-  ): Promise<void | EntityAttributeDeleteOperation[]>;
+  ): Promise<EntityAttributeDeleteOperation>;
 
   /**
-   * Updates resource attributes (batch operations).
-   * For MS service: may throw error or delegate to upsert/delete
-   * For SNS service: returns Promise<ResourceAttributesOperation[]>
+   * Updates a resource attribute (single operation - upsert only).
+   * For MS service: performs upsert operation
+   * For SNS service: returns Promise<ResourceAttributeUpsertOperation>
    */
   updateResourceAttributes(
     accountId: number,
     appName: string,
     callerActionIdentifier: string,
-    resourceAttributeOperations: ResourceAttributeUpsertOperation[]
-  ): Promise<ResourceAttributeUpsertOperation[]>;
+    resourceAttributeOperation: ResourceAttributeUpsertOperation
+  ): Promise<ResourceAttributeUpsertOperation>;
 
   /**
-   * Updates entity attributes (batch operations).
-   * For MS service: may throw error or delegate to upsert/delete
-   * For SNS service: returns Promise<EntityAttributesOperation[]>
+   * Updates an entity attribute (single operation - upsert only).
+   * For MS service: performs upsert operation
+   * For SNS service: returns Promise<EntityAttributeUpsertOperation>
    */
   updateEntityAttributes(
     accountId: number,
     appName: string,
     callerActionIdentifier: string,
-    entityAttributeOperations: EntityAttributeUpsertOperation[]
-  ): Promise<EntityAttributeUpsertOperation[]>;
+    entityAttributeOperation: EntityAttributeUpsertOperation
+  ): Promise<EntityAttributeUpsertOperation>;
 }

package/src/types/general.ts

@@ -1,8 +1,9 @@
 import type { Request, Response } from 'express';
+import type { ResourceType } from '../resource-attributes-constants';
 
 export interface Resource {
-  id?: number;
-  type: string;
+  id: number;
+  type: ResourceType;
   wrapperData?: object;
 }
 export type Action = string;
@@ -12,7 +13,7 @@ export interface Context {
 }
 export interface AuthorizationObject {
   resource_id?: Resource['id'];
-  resource_type: Resource['type'];
+  resource_type: string;
   wrapper_data?: Resource['wrapperData'];
   action: Action;
 }

package/src/utils/assignment-schema.ts

@@ -0,0 +1,51 @@
+import Ajv from 'ajv';
+import { EntityType } from '../entity-attributes-constants';
+import { ResourceType } from '../resource-attributes-constants';
+
+const ajv = new Ajv({ allErrors: true });
+
+export const entityUpsertAssignmentSchema = ajv.compile({
+  type: 'object',
+  properties: {
+    entityId: { type: 'number', multipleOf: 1 },
+    entityType: { type: 'string', enum: Object.values(EntityType) },
+    key: { type: 'string', minLength: 1 },
+    value: { type: 'string', minLength: 1 },
+  },
+  required: ['entityId', 'entityType', 'key', 'value'],
+  additionalProperties: false,
+});
+
+export const entityDeleteAssignmentSchema = ajv.compile({
+  type: 'object',
+  properties: {
+    entityId: { type: 'number', multipleOf: 1 },
+    entityType: { type: 'string', enum: Object.values(EntityType) },
+    key: { type: 'string', minLength: 1 },
+  },
+  required: ['entityId', 'entityType', 'key'],
+  additionalProperties: false,
+});
+
+export const resourceDeleteAssignmentSchema = ajv.compile({
+  type: 'object',
+  properties: {
+    resourceId: { type: 'number', multipleOf: 1 },
+    resourceType: { type: 'string', enum: Object.values(ResourceType) },
+    key: { type: 'string', minLength: 1 },
+  },
+  required: ['id', 'type', 'key'],
+  additionalProperties: false,
+});
+
+export const resourceUpsertAssignmentSchema = ajv.compile({
+  type: 'object',
+  properties: {
+    resourceId: { type: 'number', multipleOf: 1 },
+    resourceType: { type: 'string', enum: Object.values(ResourceType) },
+    key: { type: 'string', minLength: 1 },
+    value: { type: 'string', minLength: 1 },
+  },
+  required: ['resourceId', 'resourceType', 'key', 'value'],
+  additionalProperties: false,
+});

package/src/utils/resource-schema.ts

@@ -0,0 +1,16 @@
+import Ajv from 'ajv';
+import { RESOURCE_TYPES } from '../resource-attributes-constants';
+
+const ajv = new Ajv({ allErrors: true });
+
+export const resourceSchema = ajv.compile({
+  type: 'object',
+  properties: {
+    id: { type: 'number', multipleOf: 1 },
+    type: { type: 'string', enum: RESOURCE_TYPES },
+    wrapperData: { type: 'object' },
+  },
+
+  required: ['id', 'type'],
+  additionalProperties: false,
+});