[CSK-873] lock messages from being edited (#191)

* feat(lib): lock messages from being edited * feat(lib): rm * feat(lib): rm * PubNub SDK v0.8.4 release. --------- Co-authored-by: PubNub Release Bot <[email protected]>
pubnub · Nov 26, 2024 · 3db52af · 3db52af
1 parent 7539ab6
commit 3db52af
Show file tree

Hide file tree

Showing 10 changed files with 148 additions and 15 deletions.
diff --git a/.pubnub.yml b/.pubnub.yml
@@ -1,11 +1,18 @@
 ---
 name: pubnub-js-chat
-version: v0.8.3
+version: v0.8.4
 scm: github.com/pubnub/js-chat
 schema: 1
 files:
   - lib/dist/index.js
 changelog:
+  - date: 2024-11-26
+    version: v0.8.4
+    changes:
+      - type: feature
+        text: "Lock messages from being edited."
+      - type: feature
+        text: "Remove reactions list if everyone removed them."
   - date: 2024-11-15
     version: v0.8.3
     changes:

diff --git a/lib/package.json b/lib/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@pubnub/chat",
-  "version": "0.8.3",
+  "version": "0.8.4",
   "description": "PubNub JavaScript Chat SDK",
   "author": "PubNub <[email protected]>",
   "license": "SEE LICENSE IN LICENSE",

diff --git a/lib/src/constants.ts b/lib/src/constants.ts
@@ -2,3 +2,7 @@ export const MESSAGE_THREAD_ID_PREFIX = "PUBNUB_INTERNAL_THREAD"
 export const INTERNAL_MODERATION_PREFIX = "PUBNUB_INTERNAL_MODERATION_"
 export const INTERNAL_ADMIN_CHANNEL = "PUBNUB_INTERNAL_ADMIN_CHANNEL"
 export const ERROR_LOGGER_KEY_PREFIX = "PUBNUB_INTERNAL_ERROR_LOGGER"
+export const INTERNAL_MODERATOR_DATA = {
+  id: "PUBNUB_INTERNAL_MODERATOR",
+  type: "internal",
+}
diff --git a/lib/src/entities/message.ts b/lib/src/entities/message.ts
@@ -210,6 +210,10 @@ export class Message {
   async editText(newText: string) {
     const type = this.chat.editMessageActionName
     try {
+      if (this.meta?.PUBNUB_INTERNAL_AUTOMODERATED && !this.chat.currentUser.isInternalModerator) {
+        throw "The automoderated message can no longer be edited"
+      }
+
       const { data } = await this.chat.sdk.addMessageAction({
         channel: this.channelId,
         messageTimetoken: this.timetoken,

diff --git a/lib/src/entities/user.ts b/lib/src/entities/user.ts
@@ -3,7 +3,11 @@ import { Chat } from "./chat"
 import { DeleteParameters, OptionalAllBut } from "../types"
 import { Channel } from "./channel"
 import { Membership } from "./membership"
-import { INTERNAL_ADMIN_CHANNEL, INTERNAL_MODERATION_PREFIX } from "../constants"
+import {
+  INTERNAL_ADMIN_CHANNEL,
+  INTERNAL_MODERATION_PREFIX,
+  INTERNAL_MODERATOR_DATA,
+} from "../constants"
 import { getErrorProxiedEntity } from "../error-logging"
 
 export type UserFields = Pick<
@@ -56,6 +60,11 @@ export class User {
     return getErrorProxiedEntity(new User(chat, data), chat.errorLogger)
   }
 
+  /** @internal */
+  get isInternalModerator() {
+    return this.id === INTERNAL_MODERATOR_DATA.id && this.type === INTERNAL_MODERATOR_DATA.type
+  }
+
   get active() {
     return !!(
       this.lastActiveTimestamp &&

diff --git a/samples/react-native-group-chat/components/actions-menu/ActionsMenu.tsx b/samples/react-native-group-chat/components/actions-menu/ActionsMenu.tsx
@@ -19,6 +19,7 @@ type UseActionsMenuParams = {
   onQuote: (message: Message) => void
   removeThreadReply?: boolean
   onPinMessage: (message: Message | ThreadMessage) => void
+  onEditMessage: (message: Message | ThreadMessage) => void
   onToggleEmoji: (message: Message) => void
   onDeleteMessage: (message: Message) => void
 }
@@ -29,6 +30,7 @@ export function useActionsMenu({
   onPinMessage,
   onToggleEmoji,
   onDeleteMessage,
+  onEditMessage,
 }: UseActionsMenuParams) {
   const bottomSheetModalRef = useRef<BottomSheetModal>(null)
   const navigation = useNavigation<HomeStackNavigation>()
@@ -38,7 +40,7 @@ export function useActionsMenu({
   )
 
   // variables
-  const snapPoints = useMemo(() => ["25%", "50%"], [])
+  const snapPoints = useMemo(() => ["25%", "50%", "75%"], [])
 
   // callbacks
   const handlePresentModalPress = useCallback(({ message }: { message: EnhancedIMessage }) => {
@@ -63,7 +65,7 @@ export function useActionsMenu({
   const ActionsMenuComponent = () => (
     <BottomSheetModal
       ref={bottomSheetModalRef}
-      index={1}
+      index={2}
       snapPoints={snapPoints}
       onChange={handleSheetChanges}
       style={styles.container}
@@ -161,6 +163,26 @@ export function useActionsMenu({
             Pin message
           </Button>
           <Gap value={16} />
+          {currentlyFocusedMessage?.originalPnMessage.userId === chat?.currentUser.id && (
+            <>
+              <Button
+                size="md"
+                align="left"
+                icon="edit"
+                variant="outlined"
+                onPress={() => {
+                  if (currentlyFocusedMessage) {
+                    onEditMessage(currentlyFocusedMessage.originalPnMessage)
+                    setCurrentlyFocusedMessage(null)
+                    bottomSheetModalRef.current?.dismiss()
+                  }
+                }}
+              >
+                Edit message
+              </Button>
+              <Gap value={16} />
+            </>
+          )}
         </>
       ) : null}
       {currentlyFocusedMessage?.originalPnMessage.userId === chat?.currentUser.id ? (

diff --git a/samples/react-native-group-chat/package.json b/samples/react-native-group-chat/package.json
@@ -19,6 +19,7 @@
     "@react-navigation/stack": "^6.3.17",
     "expo": "^51.0.38",
     "expo-clipboard": "~6.0.3",
+    "expo-crypto": "^14.0.1",
     "expo-font": "~12.0.10",
     "expo-status-bar": "~1.12.1",
     "nanoid": "4.0.2",
@@ -53,5 +54,8 @@
     "react-native-svg-transformer": "^1.1.0",
     "typescript": "~5.3.3"
   },
+  "browser": {
+    "crypto": false
+  },
   "private": true
 }
diff --git a/samples/react-native-group-chat/screens/ordinary/chat/Chat.tsx b/samples/react-native-group-chat/screens/ordinary/chat/Chat.tsx
@@ -11,7 +11,7 @@ import {
 } from "react-native"
 import { GiftedChat, Bubble } from "react-native-gifted-chat"
 import { StackScreenProps } from "@react-navigation/stack"
-import { User, MessageDraft, Message, Channel } from "@pubnub/chat"
+import { User, MessageDraft, Message, Channel, ThreadMessage } from "@pubnub/chat"
 
 import { EnhancedIMessage, mapPNMessageToGChatMessage } from "../../../utils"
 import { ChatContext } from "../../../context"
@@ -107,11 +107,37 @@ export function ChatScreen({}: StackScreenProps<HomeStackParamList, "Chat">) {
     }
   }, [])
 
+  const handleEditMessage = useCallback(
+    async (message: Message) => {
+      if (!currentChannel) {
+        return
+      }
+      const newMessageDraft = currentChannel.createMessageDraft({
+        userSuggestionSource: "global",
+        isTypingIndicatorTriggered: currentChannel.type !== "public",
+      })
+      newMessageDraft.value = message.text
+      setText(newMessageDraft.value)
+      setGiftedChatMappedMessages((curr) =>
+        curr.map((m) => {
+          return {
+            ...m,
+            isBeingEdited: m.originalPnMessage.timetoken === message.timetoken,
+          }
+        })
+      )
+
+      setMessageDraft(newMessageDraft)
+    },
+    [currentChannel]
+  )
+
   const { ActionsMenuComponent, handlePresentModalPress } = useActionsMenu({
     onQuote: handleQuote,
     onPinMessage: handlePin,
     onToggleEmoji: handleEmoji,
     onDeleteMessage: handleDeleteMessage,
+    onEditMessage: handleEditMessage,
   })
 
   useEffect(() => {
@@ -245,6 +271,17 @@ export function ChatScreen({}: StackScreenProps<HomeStackParamList, "Chat">) {
     }
   }, [currentChannel, currentChannelMembership])
 
+  function resetMessageBeingEdited() {
+    setGiftedChatMappedMessages((curr) =>
+      curr.map((m) => {
+        return {
+          ...m,
+          isBeingEdited: false,
+        }
+      })
+    )
+  }
+
   const resetInput = () => {
     if (!messageDraft) {
       return
@@ -254,6 +291,11 @@ export function ChatScreen({}: StackScreenProps<HomeStackParamList, "Chat">) {
     messageDraft.files = undefined
     setText("")
     setImage("")
+    resetMessageBeingEdited()
+  }
+
+  function getMessageBeingEdited() {
+    return giftedChatMappedMessages.find((m) => m.isBeingEdited)?.originalPnMessage
   }
 
   const onSend = async () => {
@@ -262,17 +304,29 @@ export function ChatScreen({}: StackScreenProps<HomeStackParamList, "Chat">) {
     }
 
     try {
-      await messageDraft.send()
+      const messageBeingEdited = getMessageBeingEdited()
+      if (messageBeingEdited) {
+        await messageBeingEdited.editText(messageDraft.value)
+      } else {
+        await messageDraft.send()
+      }
     } catch (error) {
+      let alertFn = (_: string) => null
+      if (Platform.OS === "web") {
+        alertFn = alert
+      } else {
+        alertFn = Alert.alert
+      }
+
+      if (typeof error === "string") {
+        alertFn(error)
+        resetMessageBeingEdited()
+      }
       const e = error as { status: { errorData: { status: number } } }
       if (e?.status?.errorData?.status !== 403) {
         return
       }
-      if (Platform.OS === "web") {
-        alert(`You cannot send messages to this channel: ${currentChannel?.id}`)
-      } else {
-        Alert.alert("You cannot send messages to this channel:", currentChannel?.id)
-      }
+      alertFn(`You cannot send messages to this channel: ${currentChannel?.id}`)
     }
     resetInput()
   }
@@ -311,13 +365,25 @@ export function ChatScreen({}: StackScreenProps<HomeStackParamList, "Chat">) {
   }
 
   const renderBubble = (props: Bubble<EnhancedIMessage>["props"]) => {
+    const isBeingEditedStyles = props.currentMessage.isBeingEdited
+      ? {
+          borderWidth: 1,
+          borderColor: colors.teal700,
+        }
+      : {}
+
     return (
       <View>
         <Bubble
           {...props}
           wrapperStyle={{
             left: { padding: 12, backgroundColor: colors.neutral50 },
-            right: { marginLeft: 0, padding: 12, backgroundColor: colors.teal100 },
+            right: {
+              marginLeft: 0,
+              padding: 12,
+              backgroundColor: colors.teal100,
+              ...isBeingEditedStyles,
+            },
           }}
         />
         {props.currentMessage?.originalPnMessage.hasThread ? (
@@ -384,7 +450,7 @@ export function ChatScreen({}: StackScreenProps<HomeStackParamList, "Chat">) {
     <SafeAreaView style={styles.content}>
       <GiftedChat
         messages={giftedChatMappedMessages}
-        onSend={(messages) => onSend(messages)}
+        onSend={onSend}
         onInputTextChanged={handleInputChange}
         renderMessageText={renderMessageText}
         renderFooter={renderFooter}

diff --git a/samples/react-native-group-chat/webpack.config.js b/samples/react-native-group-chat/webpack.config.js
@@ -65,6 +65,11 @@ module.exports = async function (env, argv) {
     }
   })
 
+  config.resolve.fallback = {
+    ...config.resolve.fallback,
+    crypto: require.resolve("expo-crypto"),
+  }
+
   // Finally return the new config for the CLI to use.
   return config
 }
diff --git a/yarn.lock b/yarn.lock
@@ -6494,7 +6494,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"base64-js@npm:^1.0.2, base64-js@npm:^1.2.3, base64-js@npm:^1.3.1, base64-js@npm:^1.5.1":
+"base64-js@npm:^1.0.2, base64-js@npm:^1.2.3, base64-js@npm:^1.3.0, base64-js@npm:^1.3.1, base64-js@npm:^1.5.1":
   version: 1.5.1
   resolution: "base64-js@npm:1.5.1"
   checksum: 10c0/f23823513b63173a001030fae4f2dabe283b99a9d324ade3ad3d148e218134676f1ee8568c877cd79ec1c53158dcf2d2ba527a97c606618928ba99dd930102bf
@@ -9334,6 +9334,17 @@ __metadata:
   languageName: node
   linkType: hard
 
+"expo-crypto@npm:^14.0.1":
+  version: 14.0.1
+  resolution: "expo-crypto@npm:14.0.1"
+  dependencies:
+    base64-js: "npm:^1.3.0"
+  peerDependencies:
+    expo: "*"
+  checksum: 10c0/3a240c83c4e4282d6c23267efdb25276fba73c9848c98eca019e8b48326941662eeb131babab04fec5913cae02a62c7e5b8f161d1657fa2e59048fa429253a5a
+  languageName: node
+  linkType: hard
+
 "expo-file-system@npm:~17.0.1":
   version: 17.0.1
   resolution: "expo-file-system@npm:17.0.1"
@@ -15518,6 +15529,7 @@ __metadata:
     babel-plugin-transform-inline-environment-variables: "npm:^0.4.4"
     expo: "npm:^51.0.38"
     expo-clipboard: "npm:~6.0.3"
+    expo-crypto: "npm:^14.0.1"
     expo-font: "npm:~12.0.10"
     expo-status-bar: "npm:~1.12.1"
     nanoid: "npm:4.0.2"