Files
simplex-chat/packages/simplex-chat-mcp/test/e2e/helpers.ts
T
Evgeny @ SimpleX Chat be668564df mcp server: files, /leave and library methods (#7962)
* bots, nodejs: document chat, connection, member contact and network commands, typed commands in library

* bots, nodejs: restore apiConnect, wrap domain once, test all connect responses

* nodejs: JSDoc for new methods

* docs: plan for bot API commands and typed Node library methods

* tests: channel prepared with a domain has a verified SimpleX name

* docs: apply review fixes to the plan for bot API commands

* docs: apply second review pass to the plan for bot API commands

* docs: refer the bot API plan to the rewritten test commit

* docs: record decisions in the plan for bot API commands

* docs: plan tests of the generated Python command strings

* python: test the generated strings of the documented commands

* docs: plan for files, /leave and library methods in the MCP server

* docs: wait at stop in the MCP plan

* docs: library methods and /leave mechanics in the MCP plan

* mcp: typed library methods for chat commands

* docs: plan the message information command for bots

* mcp: /leave CHAT owner command to leave a chat at once

* docs: file servers, GIF and video choices decided in the MCP plan

* docs: file mechanics in the MCP plan

* mcp: files of received messages

* bots, nodejs: message information with the file servers for bots

* docs: plan the relay approval option of receiving files in Node

* mcp: download of received files with owner approval

* docs: name the xftp-server test helper in the files plan

* nodejs: receive files without approving unknown relays

* docs: plan the user servers command for bots

* bots, nodejs: user servers and relays by operator for bots

* nodejs: document the message information method

* docs: plan the file upload progress event for bots

* mcp: send files with owner approval, refusing private keys

* bots: file upload progress event for bots

* mcp: /leave template in the agent control chat menu

* docs: sent copies are deleted for contacts too, at sndFileCompleteXFTP

* bots: drop the file upload progress event

* docs: drop the upload progress event plan

* nodejs: document user servers and relay approval of received files

* mcp: download cards name unknown file servers after the upload

* docs: record the wait for the file description in the files plan

* mcp: fixed wait at stop for cancelled cards, without /sql

* docs: record decision C4, a fixed wait at stop, in the files plan

* ci: test the MCP server package on pull requests

* ci: state when the MCP workflow can be dispatched

* ci: run the MCP server tests when its libraries change

* mcp: log the errors of image previews and resizing

* mcp: keep files in transfer in the data folder

* mcp: restrict sent files by the real paths of refused folders

* mcp: validate the file at the send by its inode and change time

* mcp: limit ffmpeg and ffprobe to local files and no input commands

* mcp: ask the owner for unknown file servers; read approvals at creation

* mcp: name downloaded files by their ID; return paths of downloads only

* mcp: end each download with a result for the agent and the card

* mcp: show files above their sender's size limit as failed

* mcp: refuse empty files, as without file and captions too long to send

* mcp: tell the owner about failed uploads and unposted received files

* mcp: delete resized copies left by the last run at start

* mcp: name downloads and leaving in the help and greeting, align docs

* mcp: compute the download path for received files only

* mcp: send a /receive file to the owner under its name

* mcp: keep files received without a download in the chat's folder

* mcp: keep a left chat's files and delete them with /delete CHAT files

* mcp: test that sent images are resized by the core

* mcp: wait 30 minutes for a download's progress before cancelling it

* mcp: end a download as deleted only when its message is not found

* mcp: delete the copy of a /receive file whose post fails

* mcp: count the quoted content in a message's length, as the core sends it

* mcp: name received bytes, unknown-server downloads and left chat files plainly

* mcp: test refused folders, file changes and download approvals

* docs: align MCP server docs with refused folders, leaves and download waits

* mcp: move received files only in full, delete partials only of downloads

* mcp: report a received file missing from its folder as failed

* mcp: move received files of a group's member chats into its folder

* mcp: read a video's preview and duration as an MP4 or QuickTime file

* mcp: 0.2.0 on simplex-chat 7.1.0-beta.10.1

* mcp: file folders by chat type, /delete cancels downloads, files reply

* docs: MCP server specs and plan for 0.2.0

* mcp: /receive gives the agent a file, /forward sends it to the owner

* docs: MCP server specs for /receive and /forward of download cards

* docs: MCP plan records the temp folder command as a library exception

* mcp: /delete cancels resumed downloads; /forward quote fits the limit

* docs: MCP specs and plans for /forward quotes and resumed downloads

* docs: MCP specs name the source commit they are checked against

* docs: MCP PLAN states the /forward quote and move rules

* mcp: a download moves its completed file whatever its size

* mcp: /receive N all covers its card and later files, not pending ones

* docs: MCP files approval scope, reply text and README server wording

* mcp: a download approves relays only for a card naming unknown servers

* mcp: files in member chats of a group are tracked as in the main chat

* docs: MCP relay approval of downloads and files in member chats

* mcp: a rejected file gets a card again under the files approval

* docs: MCP rejected files under the files approval, README scope

* mcp: an offered file without a description gets no card or action

* docs: MCP a file without a description is not downloaded

* mcp: 0.2.0 on simplex-chat 7.1.0-beta.10.2

* ci: test the MCP server as a scope of build-linux
2026-11-06 18:38:34 +00:00

117 lines
5.0 KiB
TypeScript

import {T} from "@simplex-chat/types"
import {api, bot} from "simplex-chat"
import {ServeOptions} from "../../src/serve"
export const timeout = 60_000
export function captureLog(): string[] {
const lines: string[] = []
const write = process.stdout.write.bind(process.stdout) as (chunk: string) => boolean
jest.spyOn(process.stdout, "write").mockImplementation(((chunk: string) => {
lines.push(...String(chunk).split("\n"))
return write(chunk)
}) as typeof process.stdout.write)
return lines
}
export async function profileWithServer(smpAddress: string, filePrefix: string, profile: T.Profile, xftpAddress?: string): Promise<void> {
const chat = await api.ChatApi.init({type: "sqlite", filePrefix})
await chat.apiCreateActiveUser(profile)
await chat.startChat()
expect(await chat.sendChatCmd(`/smp ${smpAddress}`)).toMatchObject({type: "cmdOk"})
if (xftpAddress !== undefined) expect(await chat.sendChatCmd(`/xftp ${xftpAddress}`)).toMatchObject({type: "cmdOk"})
await chat.close()
}
export async function person(smpAddress: string, filePrefix: string, displayName: string, xftpAddress?: string): Promise<{chat: api.ChatApi; user: T.User}> {
await profileWithServer(smpAddress, filePrefix, {displayName, fullName: ""}, xftpAddress)
const chat = await api.ChatApi.init({type: "sqlite", filePrefix})
const user = (await chat.apiGetActiveUser())!
await chat.startChat()
return {chat, user}
}
export interface Bot {
chat: api.ChatApi
user: T.User
link: string
}
export async function startBot(smpAddress: string, filePrefix: string, displayName: string, addressSettings: api.BotAddressSettings): Promise<Bot> {
await profileWithServer(smpAddress, filePrefix, {displayName, fullName: "", peerType: T.ChatPeerType.Bot})
const [chat, user, address] = await bot.run({
profile: {displayName, fullName: "", shortDescr: "Find groups and bots."},
dbOpts: {type: "sqlite", filePrefix},
options: {addressSettings, commands: [{type: "command", keyword: "help", label: "Help"}], logContacts: false},
onMessage: async (ci, content, botChat) => {
await botChat.apiSendTextReply(ci, `result 1: ${content.text}`)
await botChat.apiSendTextReply(ci, `result 2: ${content.text}`)
},
onCommands: {
help: async (ci, _command, botChat) => {
await botChat.apiSendTextReply(ci, "Send a search, for example: trail shoes")
},
},
})
return {chat, user, link: address!.connLinkContact.connShortLink ?? address!.connLinkContact.connFullLink}
}
export function serveOptions(data: string, port: number, extra: Partial<ServeOptions> = {}): ServeOptions {
return {name: "agent", data, dataGiven: true, approve: "requests", expireHours: 23, resetOwners: false, newToken: false, port, qrCode: "small", stopWait: 10, ...extra}
}
export function lastLink(lines: string[]): string {
return lines.filter(line => /^(https:\/\/|simplex:)/.test(line)).at(-1)!
}
export async function joinByLink({chat, user}: {chat: api.ChatApi; user: T.User}, link: string): Promise<number> {
const joined = chat.wait("userJoinedGroup", timeout)
const [, connLink] = await chat.apiConnectPlan(user.userId, link)
await chat.apiConnect(user.userId, false, connLink)
const event = await joined
if (event === undefined) throw new Error("not joined")
return event.groupInfo.groupId
}
export async function until(condition: () => boolean | Promise<boolean>, ms = timeout): Promise<void> {
const deadline = Date.now() + ms
while (!(await condition())) {
if (Date.now() > deadline) throw new Error("condition timed out")
await new Promise(resolve => setTimeout(resolve, 100))
}
}
export type ItemCheck = (ci: T.AChatItem) => boolean
export function received(chat: api.ChatApi, check: ItemCheck): Promise<T.AChatItem> {
return chat.wait("newChatItems", ({chatItems}) => chatItems.some(check), timeout).then(event => {
if (event === undefined) throw new Error("no matching item")
return event.chatItems.find(check)!
})
}
export function updated(chat: api.ChatApi, check: ItemCheck): Promise<T.AChatItem> {
return chat.wait("chatItemUpdated", ({chatItem}) => check(chatItem), timeout).then(event => {
if (event === undefined) throw new Error("no matching update")
return event.chatItem
})
}
export const textStarts = (prefix: string): ItemCheck => ci => ci.chatItem.meta.itemText.startsWith(prefix)
export function cardNumber(ci: T.AChatItem): number {
return Number(/\/'(?:approve|receive) (?:[#@]\d+ )?(\d+)'/.exec(ci.chatItem.meta.itemText)![1])
}
export function lines(ci: T.AChatItem): string[] {
return ci.chatItem.meta.itemText.split("\n")
}
export function isActive({memberStatus}: T.GroupMember): boolean {
return memberStatus === T.GroupMemberStatus.Connected || memberStatus === T.GroupMemberStatus.Complete
}
export async function controlGroupOf(chat: api.ChatApi, userId: number): Promise<T.GroupInfo> {
return (await chat.apiListGroups(userId)).find(({customData}) => (customData as {simplexMcp?: {control?: boolean}} | undefined)?.simplexMcp?.control === true)!
}