Fix slack interactions by normalising emoji text (#1600)

Fixes OPS-2996.

## Additional Notes

Button text is being normalised by Slack in the response payload and
this lead to the conflict to resume the flow. Now we match the
normalised text response from slack with the normalised original action
text and then we return the original text in the updated message.

For multi select, we are already sending the userSelection.value which
slack doesn't normalise and need not be fixed.


## For future reference

- I've first added emoji: false prop to SlackText and although this
fixes the bug, Slack wouldn't render emojis in the UI when user uses
emoji in colon notation like ":emoji:"
- I've then tried normalisation in request action and then compare it
with original action in wait for interaction and then send the emojified
string back to the user.
- We've decided to send back the original text (either emoji or text
notation) to the user.
- So I've moved the normalisation to wait for interaction module and
return the original action to the user. For multi - select (Arrays), we
already return the value prop which slack doesn't normalise.
- As as alternate fix, I've tried
#1615, but this would
require user to add value prop for actions when using send message
action. So we ignore this method although it would've been the cleanest
approach.

Author: ravikiranvm

THIRD_PARTY_LICENSES.txt

@@ -8011,6 +8011,37 @@ This software is provided by the copyright holders and contributors “as is”
 
 -----------
 
+The following npm package may be included in this product:
+
+ - node-emoji@2.2.0
+
+This package contains the following license:
+
+# MIT License
+
+Copyright (c) 2014-2023 Daniel Bugl
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+-----------
+
 The following npm packages may be included in this product:
 
  - webidl-conversions@3.0.1
@@ -16716,6 +16747,7 @@ The following npm packages may be included in this product:
  - punycode@1.4.1
  - punycode@2.3.1
  - uc.micro@2.1.0
+ - unicode-emoji-modifier-base@1.0.0
 
 These packages each contain the following license:
 
@@ -25618,6 +25650,7 @@ SOFTWARE.
 
 The following npm packages may be included in this product:
 
+ - @sindresorhus/is@4.6.0
  - ansi-regex@6.0.1
  - ansi-styles@6.2.1
  - chalk@5.3.0
@@ -25757,6 +25790,7 @@ The following npm packages may be included in this product:
  - restore-cursor@3.1.0
  - screenfull@5.2.0
  - shebang-regex@3.0.0
+ - skin-tone@2.0.0
  - string-width@4.2.3
  - strip-ansi@6.0.1
  - supports-color@5.5.0
@@ -26044,6 +26078,36 @@ OTHER DEALINGS IN THE SOFTWARE.
 
 -----------
 
+The following npm package may be included in this product:
+
+ - char-regex@1.0.2
+
+This package contains the following license:
+
+MIT License
+
+Copyright (c) 2019 Richie Bendall
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+-----------
+
 The following npm packages may be included in this product:
 
  - @selderee/plugin-htmlparser2@0.11.0
@@ -28574,6 +28638,36 @@ SOFTWARE.
 
 -----------
 
+The following npm package may be included in this product:
+
+ - emojilib@2.4.0
+
+This package contains the following license:
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Mu-An Chiou
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+-----------
+
 The following npm package may be included in this product:
 
  - object-hash@3.0.0

package-lock.json

@@ -235,6 +235,7 @@
     "msgpackr": "1.11.5",
     "nanoid": "3.3.8",
     "node-cron": "3.0.3",
+    "node-emoji": "2.2.0",
     "nodemailer": "6.9.9",
     "npm": "10.8.2",
     "nx-cloud": "19.1.0",

package.json

@@ -6,6 +6,6 @@ export default {
   transform: {
     '^.+\\.ts$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
   },
-  moduleFileExtensions: ['ts', 'js', 'html'],
+  moduleFileExtensions: ['ts', 'js', 'html', 'json'],
   coverageDirectory: '../../../coverage/packages/blocks/slack',
 };

packages/blocks/slack/jest.config.ts

@@ -8,6 +8,7 @@ import {
 import { Property, WorkflowFile } from '@openops/blocks-framework';
 import { logger } from '@openops/server-shared';
 import { isEmpty } from '@openops/shared';
+import * as emoji from 'node-emoji';
 import { MessageInfo } from './message-result';
 
 export const slackSendMessage = async ({
@@ -450,3 +451,7 @@ export function createMessageBlocksWithActions(
     },
   ];
 }
+
+export function normalizeEmojiString(str: string): string {
+  return emoji.unemojify(str);
+}

packages/blocks/slack/src/lib/common/utils.ts

@@ -12,7 +12,7 @@ import {
   UserSelection,
 } from './message-interactions';
 import { MessageInfo } from './message-result';
-import { slackUpdateMessage } from './utils';
+import { normalizeEmojiString, slackUpdateMessage } from './utils';
 
 export interface WaitForInteractionResult {
   user: string;
@@ -77,9 +77,17 @@ export async function onReceivedInteraction(
 
   const userSelection = JSON.parse(resumePayload.actionClicked);
 
-  const isResumeForActionOnThisMessage =
-    actions.includes(resumePayload.actionType) ||
-    actions.includes((userSelection as UserSelection)?.value);
+  const targetValues = new Set(
+    [resumePayload.actionType, (userSelection as UserSelection)?.value].filter(
+      Boolean,
+    ),
+  );
+
+  const matchedOriginalAction = actions.find((original) =>
+    targetValues.has(normalizeEmojiString(original)),
+  );
+
+  const isResumeForActionOnThisMessage = Boolean(matchedOriginalAction);
 
   const isResumeForThisMessage =
     resumePayload.path === currentExecutionPath &&
@@ -119,7 +127,7 @@ export async function onReceivedInteraction(
     user: resumePayload.userName,
     action: Array.isArray(userSelection)
       ? userSelection.map((opt) => opt.value)
-      : userSelection.value,
+      : matchedOriginalAction || '',
     message: updatedMessage,
     userSelection,
     isExpired: false,

packages/blocks/slack/src/lib/common/wait-for-interaction.ts

@@ -1,10 +1,9 @@
 const pauseMock = jest.fn();
 const slackUpdateMessageMock = jest.fn();
-jest.mock('../src/lib/common/utils', () => {
-  return {
-    slackUpdateMessage: slackUpdateMessageMock,
-  };
-});
+jest.mock('../src/lib/common/utils', () => ({
+  ...jest.requireActual('../src/lib/common/utils'),
+  slackUpdateMessage: slackUpdateMessageMock,
+}));
 
 import { StoreScope } from '@openops/blocks-framework';
 import { ExecutionType } from '@openops/shared';