fix(chat): encode portable link ids

Author: j15z

apps/sim/app/workspace/[workspaceId]/files/components/file-viewer/rich-markdown-editor/mention/mention-node.test.ts

@@ -44,6 +44,14 @@ describe('mention node round-trip', () => {
     expect(serializeMarkdownBody(input).trim()).toBe(input)
   })
 
+  it('round-trips a file reference containing whitespace and a closing parenthesis', () => {
+    const input = '[Q1 plan](sim:file/files/Q1%20plan%29.md)'
+    const doc = parseMarkdownToDoc(input)
+    const mention = findMention(doc)
+    expect(mention?.attrs).toEqual({ kind: 'file', id: 'files/Q1 plan).md', label: 'Q1 plan' })
+    expect(serializeMarkdownBody(input).trim()).toBe(input)
+  })
+
   it('leaves a normal http link as a link, not a mention', () => {
     const doc = parseMarkdownToDoc('[Sim](https://sim.ai)')
     expect(findMention(doc)).toBeNull()

apps/sim/app/workspace/[workspaceId]/files/components/file-viewer/rich-markdown-editor/mention/mention-node.ts

@@ -1,6 +1,6 @@
 import type { JSONContent, MarkdownToken } from '@tiptap/core'
 import { InputRule, Node } from '@tiptap/core'
-import { fromSimMarkdownLabel, toSimMarkdownLink } from './sim-link'
+import { fromSimHrefId, fromSimMarkdownLabel, toSimMarkdownLink } from './sim-link'
 import type { MentionKind } from './types'
 
 export interface MentionAttrs {
@@ -81,7 +81,11 @@ export const MarkdownMention = Node.create({
     const { kind, id, label } = token as MentionTokenFields
     return {
       type: 'mention',
-      attrs: { kind: kind ?? '', id: id ?? '', label: fromSimMarkdownLabel(label ?? '') },
+      attrs: {
+        kind: kind ?? '',
+        id: fromSimHrefId(id ?? ''),
+        label: fromSimMarkdownLabel(label ?? ''),
+      },
     }
   },
   renderMarkdown: (node: JSONContent): string => {
@@ -113,7 +117,11 @@ export const MarkdownMention = Node.create({
           state.tr.replaceWith(
             range.from,
             range.to,
-            type.create({ kind, id, label: fromSimMarkdownLabel(rawLabel ?? '') })
+            type.create({
+              kind,
+              id: fromSimHrefId(id),
+              label: fromSimMarkdownLabel(rawLabel ?? ''),
+            })
           )
         },
       }),

apps/sim/app/workspace/[workspaceId]/files/components/file-viewer/rich-markdown-editor/mention/sim-link.test.ts

@@ -1,5 +1,19 @@
 import { describe, expect, it } from 'vitest'
-import { simLinkPath } from './sim-link'
+import { fromSimHrefId, simLinkPath, toSimHref } from './sim-link'
+
+describe('sim link id codec', () => {
+  it('round-trips identifiers containing link delimiters', () => {
+    const id = 'files/Q1 plan).md'
+    const href = toSimHref('file', id)
+
+    expect(href).toBe('sim:file/files/Q1%20plan%29.md')
+    expect(fromSimHrefId(href.slice('sim:file/'.length))).toBe(id)
+  })
+
+  it('leaves malformed percent encoding intact', () => {
+    expect(fromSimHrefId('file%2')).toBe('file%2')
+  })
+})
 
 describe('simLinkPath', () => {
   const ws = 'ws1'

apps/sim/app/workspace/[workspaceId]/files/components/file-viewer/rich-markdown-editor/mention/sim-link.ts

@@ -6,7 +6,10 @@ export const SIM_LINK_SCHEME = 'sim'
 
 /** Builds the link target for a mention of `kind`/`id`. */
 export function toSimHref(kind: string, id: string): string {
-  return `${SIM_LINK_SCHEME}:${kind}/${id}`
+  const encodedId = encodeURIComponent(id)
+    .replace(/[!'()*]/g, (character) => `%${character.charCodeAt(0).toString(16).toUpperCase()}`)
+    .replace(/%2F/gi, '/')
+  return `${SIM_LINK_SCHEME}:${kind}/${encodedId}`
 }
 
 /** Builds portable mention Markdown while escaping characters that can break its label. */
@@ -20,6 +23,15 @@ export function fromSimMarkdownLabel(label: string): string {
   return label.replace(/\\([\\[\]])/g, '$1')
 }
 
+/** Restores an identifier serialized into a `sim:` link without throwing on malformed input. */
+export function fromSimHrefId(id: string): string {
+  try {
+    return decodeURIComponent(id)
+  } catch {
+    return id
+  }
+}
+
 /**
  * Resolves the in-app route for a clicked `sim:` mention, or `null` when the kind has no navigable
  * destination. Each path matches the entity's real route: files open the file detail view,

apps/sim/app/workspace/[workspaceId]/home/components/mothership-chat/copyable-markdown.test.ts

@@ -127,15 +127,15 @@ describe('toCopyableMarkdown', () => {
     expect(content).not.toBeTypeOf('string')
     if (typeof content === 'string') throw new Error('Expected deferred clipboard content')
     expect(content.fallback).toBe(
-      'Read [The Bell at Low Tide.md](sim:file/files/The%20Bell%20at%20Low%20Tide.md).'
+      'Read [The Bell at Low Tide.md](sim:file/files/The%2520Bell%2520at%2520Low%2520Tide.md).'
     )
     expect(parseChipLinks(content.fallback)).toEqual([
       {
         kind: 'file',
         id: 'files/The%20Bell%20at%20Low%20Tide.md',
         label: 'The Bell at Low Tide.md',
         start: 5,
-        end: 78,
+        end: 86,
       },
     ])
     await expect(content.prepare()).resolves.toBe(
@@ -144,6 +144,24 @@ describe('toCopyableMarkdown', () => {
     expect(refreshWorkspaceFiles).toHaveBeenCalledOnce()
   })
 
+  it('escapes unsafe characters in unresolved file references', () => {
+    const message =
+      'Read <workspace_resource>{"type":"file","path":"files/Q1 plan).md","title":"Q1 plan).md"}</workspace_resource>.'
+
+    const { markdown } = serializeCopyableMarkdown(message)
+
+    expect(markdown).toBe('Read [Q1 plan).md](sim:file/files/Q1%20plan%29.md).')
+    expect(parseChipLinks(markdown)).toEqual([
+      {
+        kind: 'file',
+        id: 'files/Q1 plan).md',
+        label: 'Q1 plan).md',
+        start: 5,
+        end: 50,
+      },
+    ])
+  })
+
   it('does not refresh metadata when all workspace resources already resolve', () => {
     const message =
       'Read <workspace_resource>{"type":"file","path":"files/The%20Bell%20at%20Low%20Tide.md","title":"The Bell at Low Tide.md"}</workspace_resource>.'

apps/sim/app/workspace/[workspaceId]/home/components/user-input/components/chip-clipboard-codec.ts

@@ -1,4 +1,5 @@
 import {
+  fromSimHrefId,
   fromSimMarkdownLabel,
   SIM_LINK_SCHEME,
   toSimMarkdownLink,
@@ -205,7 +206,7 @@ export function parseChipLinks(text: string): ParsedChipLink[] {
     if (!isPortableKind(kind)) continue
     links.push({
       kind,
-      id,
+      id: fromSimHrefId(id),
       label: fromSimMarkdownLabel(label),
       start: match.index,
       end: match.index + full.length,