From 17e2d46760cf19e9b10a9e470452cd6632fb6bb0 Mon Sep 17 00:00:00 2001 From: afeefuddin Date: Sat, 15 Jun 2024 15:27:13 +0530 Subject: [PATCH] message_store: Rewrite RawMessage type using Zod. This commit rework RawMessage and it's related type to use Zod for parsing the data received from the server. --- tools/test-js-with-node | 1 - web/src/message_store.ts | 157 +++++++++++++++++++++++---------------- web/src/submessage.ts | 8 +- web/src/types.ts | 12 ++- 4 files changed, 101 insertions(+), 77 deletions(-) diff --git a/tools/test-js-with-node b/tools/test-js-with-node index a5ef32e58c..a9597ae4fc 100755 --- a/tools/test-js-with-node +++ b/tools/test-js-with-node @@ -259,7 +259,6 @@ EXEMPT_FILES = make_set( "web/src/topic_list.ts", "web/src/topic_popover.js", "web/src/tutorial.js", - "web/src/types.ts", "web/src/typing.ts", "web/src/typing_events.ts", "web/src/ui_init.js", diff --git a/web/src/message_store.ts b/web/src/message_store.ts index 1369457476..d4523bda16 100644 --- a/web/src/message_store.ts +++ b/web/src/message_store.ts @@ -1,82 +1,109 @@ import _ from "lodash"; +import {z} from "zod"; import * as blueslip from "./blueslip"; import * as people from "./people"; -import type {Submessage} from "./submessage"; -import type {TopicLink} from "./types"; +import {topic_link_schema} from "./types"; import type {UserStatusEmojiInfo} from "./user_status"; const stored_messages = new Map(); -export type MatchedMessage = { - match_content?: string | undefined; - match_subject?: string | undefined; -}; +const matched_message_schema = z.object({ + match_content: z.optional(z.string()), + match_subject: z.optional(z.string()), +}); -export type MessageReactionType = "unicode_emoji" | "realm_emoji" | "zulip_extra_emoji"; +export type MatchedMessage = z.infer; -export type DisplayRecipientUser = { - email: string; - full_name: string; - id: number; -}; +const message_reaction_type_schema = z.enum(["unicode_emoji", "realm_emoji", "zulip_extra_emoji"]); -export type DisplayRecipient = string | DisplayRecipientUser[]; +export type MessageReactionType = z.infer; -export type MessageEditHistoryEntry = { - user_id: number | null; - timestamp: number; - prev_content?: string; - prev_rendered_content?: string; - prev_rendered_content_version?: number; - prev_stream?: number; - prev_topic?: string; - stream?: number; - topic?: string; -}; +const display_recipient_user_schema = z.object({ + email: z.string(), + full_name: z.string(), + id: z.number(), +}); -export type MessageReaction = { - emoji_name: string; - emoji_code: string; - reaction_type: MessageReactionType; - user_id: number; -}; +export type DisplayRecipientUser = z.infer; -export type RawMessage = { - avatar_url: string | null; - client: string; - content: string; - content_type: "text/html"; - display_recipient: DisplayRecipient; - edit_history?: MessageEditHistoryEntry[]; - id: number; - is_me_message: boolean; - last_edit_timestamp?: number; - reactions: MessageReaction[]; - recipient_id: number; - sender_email: string; - sender_full_name: string; - sender_id: number; - sender_realm_str: string; - submessages: Submessage[]; - timestamp: number; - flags: string[]; -} & ( - | { - type: "private"; - topic_links?: undefined; - } - | { - type: "stream"; - stream_id: number; - // Messages that come from the server use `subject`. - // Messages that come from `send_message` use `topic`. - subject?: string; - topic?: string; - topic_links: TopicLink[]; - } -) & - MatchedMessage; +const display_recipient_schema = z.union([z.string(), z.array(display_recipient_user_schema)]); + +export type DisplayRecipient = z.infer; + +const message_edit_history_entry_schema = z.object({ + user_id: z.nullable(z.number()), + timestamp: z.number(), + prev_content: z.optional(z.string()), + prev_rendered_content: z.optional(z.string()), + prev_rendered_content_version: z.optional(z.number()), + prev_stream: z.optional(z.number()), + prev_topic: z.optional(z.string()), + stream: z.optional(z.number()), + topic: z.optional(z.string()), +}); + +export type MessageEditHistoryEntry = z.infer; + +const message_reaction_schema = z.object({ + emoji_name: z.string(), + emoji_code: z.string(), + reaction_type: message_reaction_type_schema, + user_id: z.number(), +}); + +export type MessageReaction = z.infer; + +export const submessage_schema = z.object({ + id: z.number(), + sender_id: z.number(), + message_id: z.number(), + content: z.string(), + msg_type: z.string(), +}); + +export const raw_message_schema = z.intersection( + z.intersection( + z.object({ + avatar_url: z.nullable(z.string()), + client: z.string(), + content: z.string(), + content_type: z.literal("text/html"), + display_recipient: display_recipient_schema, + edit_history: z.optional(z.array(message_edit_history_entry_schema)), + id: z.number(), + is_me_message: z.boolean(), + last_edit_timestamp: z.optional(z.number()), + reactions: z.array(message_reaction_schema), + recipient_id: z.number(), + sender_email: z.string(), + sender_full_name: z.string(), + sender_id: z.number(), + sender_realm_str: z.string(), + submessages: z.array(submessage_schema), + timestamp: z.number(), + flags: z.array(z.string()), + }), + z.discriminatedUnion("type", [ + z.object({ + type: z.literal("private"), + topic_links: z.optional(z.array(z.undefined())), + }), + z.object({ + type: z.literal("stream"), + stream_id: z.number(), + // Messages that come from the server use `subject`. + // Messages that come from `send_message` use `topic`. + subject: z.optional(z.string()), + topic: z.optional(z.string()), + topic_links: z.array(topic_link_schema), + }), + ]), + ), + matched_message_schema, +); + +export type RawMessage = z.infer; // We add these boolean properties to Raw message in // `message_store.convert_raw_message_to_message_with_booleans` method. diff --git a/web/src/submessage.ts b/web/src/submessage.ts index 10dcf5b169..d62a15b0f5 100644 --- a/web/src/submessage.ts +++ b/web/src/submessage.ts @@ -10,13 +10,7 @@ import {todo_widget_extra_data_schema} from "./todo_widget"; import type {TodoWidgetOutboundData} from "./todo_widget"; import * as widgetize from "./widgetize"; -export type Submessage = { - id: number; - sender_id: number; - message_id: number; - content: string; - msg_type: string; -}; +export type Submessage = z.infer; export const zform_widget_extra_data_schema = z .object({ diff --git a/web/src/types.ts b/web/src/types.ts index 3510f879a5..e4ddcf88c7 100644 --- a/web/src/types.ts +++ b/web/src/types.ts @@ -1,8 +1,12 @@ +import {z} from "zod"; + // TODO/typescript: Move this to server_events -export type TopicLink = { - text: string; - url: string; -}; +export const topic_link_schema = z.object({ + text: z.string(), + url: z.string(), +}); + +export type TopicLink = z.infer; // TODO/typescript: Move this to server_events_dispatch export type UserGroupUpdateEvent = {