Repository Public
1// Author: Simon-Pierre Boucher — contact@spboucher.ai2// File: Tests/LocalChatCoreTests/NetworkingTests.swift3// Description: SSE parsing, URL transport policy, OpenAI wire decoding of real-world payloads and Core conversions.4import Foundation5import LocalChatCore6import LocalChatNetworking7import Testing89@Suite("Networking")10struct NetworkingTests {11 // MARK: SSE1213 @Test func sseParsesEventsSplitAcrossArbitraryChunks() {14 let stream = "data: {\"a\":1}\n\ndata: second\n\ndata: [DONE]\n\n"15 for size in [1, 2, 3, 7, 64] {16 var parser = SSEParser(); var events: [SSEEvent] = []17 let bytes = [UInt8](stream.utf8)18 for start in stride(from: 0, to: bytes.count, by: size) { events += parser.feed(bytes: Array(bytes[start..<min(start + size, bytes.count)])) }19 #expect(events.map(\.data) == ["{\"a\":1}", "second", "[DONE]"])20 #expect(events.last?.isDone == true)21 #expect(events.first?.isDone == false)22 }23 }2425 @Test func sseHandlesCRLFCommentsMultilineAndFields() {26 var parser = SSEParser()27 var events = parser.feed(": keep-alive\r\n\r\nevent: delta\r\nid: 7\r\ndata: line one\r\ndata: line two\r\n\r\n")28 #expect(events.count == 1)29 #expect(events[0].event == "delta")30 #expect(events[0].id == "7")31 #expect(events[0].data == "line one\nline two")32 events = parser.feed("data:nospace\n\nretry: 10\n\ndata\n\n")33 #expect(events.map(\.data) == ["nospace", ""])34 // lone CR line ends, and a CRLF split between two feeds35 events = parser.feed("data: a\r") + parser.feed("\n\r\ndata: b\r\r")36 #expect(events.map(\.data) == ["a", "b"])37 }3839 @Test func sseKeepsMultibyteCharactersSplitAcrossFeeds() {40 var parser = SSEParser()41 let bytes = [UInt8]("data: café 🚀\n\n".utf8)42 var events: [SSEEvent] = []43 for b in bytes { events += parser.feed(bytes: [b]) }44 #expect(events.map(\.data) == ["café 🚀"])45 }4647 @Test func sseFinishFlushesUnterminatedEvent() {48 var parser = SSEParser()49 #expect(parser.feed("data: tail").isEmpty)50 #expect(parser.finish().map(\.data) == ["tail"])51 #expect(parser.finish().isEmpty)52 }5354 @Test func sseWriterRoundTrips() {55 var parser = SSEParser()56 let events = parser.feed(SSEWriter.event("a\nb", event: "x")) + parser.feed(SSEWriter.comment()) + parser.feed(SSEWriter.done)57 #expect(events.count == 2)58 #expect(events[0].data == "a\nb" && events[0].event == "x")59 #expect(events[1].isDone)60 }6162 // MARK: URL policy6364 @Test func urlPolicyAllowsHTTPOnlyOnOwnNetwork() {65 for ok in ["http://127.0.0.1:8765/v1", "http://localhost:1234", "http://10.0.0.5/v1", "http://172.16.4.4", "http://172.31.255.1", "http://192.168.2.103:8765/v1",66 "http://169.254.10.1", "http://studio.local:8765/v1", "http://[::1]:8765", "http://[fe80::1%25en0]:80", "http://[fd12:3456::1]", "http://100.125.225.117:8765",67 "http://macstudio:8765", "https://llm.spboucher.ai/v1", "https://example.com"] {68 #expect(URLPolicy.isAllowed(ok), "\(ok) should be allowed")69 }70 for bad in ["http://example.com/v1", "http://8.8.8.8", "http://172.32.0.1", "http://192.169.1.1", "http://100.128.0.1", "http://[2001:db8::1]", "ftp://10.0.0.1", "not a url", "http://"] {71 #expect(!URLPolicy.isAllowed(bad), "\(bad) should be refused")72 }73 #expect(URLPolicy.isAllowed("http://example.com/v1", allowInsecureHTTP: true))74 #expect(throws: URLPolicy.Violation.insecurePublicHost("example.com")) { try URLPolicy.validate("http://example.com") }75 #expect(URLPolicy.classify(host: "192.168.1.9") == .privateNetwork)76 #expect(URLPolicy.classify(host: "::ffff:10.0.0.1") == .privateNetwork)77 #expect(URLPolicy.classify(host: "1.2.3.4") == .publicHost)78 }7980 // MARK: Wire types8182 @Test func decodesChatRequestWithPartsToolsAndStopVariants() throws {83 let png = Data([0x89, 0x50, 0x4E, 0x47]).base64EncodedString()84 let json = """85 {"model":"m","stream":true,"stream_options":{"include_usage":true},"max_completion_tokens":77,"temperature":0.2,"top_p":0.5,"stop":"END","seed":42,86 "response_format":{"type":"json_schema","json_schema":{"name":"r","schema":{"type":"object"}}},"unknown_field":{"x":1},87 "messages":[{"role":"system","content":"sys"},{"role":"developer","content":"dev"},88 {"role":"user","content":[{"type":"text","text":"look"},{"type":"image_url","image_url":{"url":"data:image/png;base64,\(png)"}}]},89 {"role":"assistant","content":null,"tool_calls":[{"id":"c1","type":"function","function":{"name":"add","arguments":"{\\"a\\":1}"}}]},90 {"role":"tool","tool_call_id":"c1","content":"2"}],91 "tools":[{"type":"function","function":{"name":"add","description":"adds","parameters":{"type":"object","properties":{"a":{"type":"number"}}}}}]}92 """93 let wire = try JSONDecoder().decode(OpenAI.ChatRequest.self, from: Data(json.utf8))94 #expect(wire.stream == true && wire.streamOptions?.includeUsage == true)95 let request = try wire.generationRequest()96 #expect(request.messages.count == 4) // two system turns merged97 #expect(request.messages[0].role == .system && request.messages[0].content == "sys\n\ndev")98 #expect(request.messages[1].images.count == 1 && request.messages[1].images[0].mimeType == "image/png" && request.messages[1].content == "look")99 #expect(request.messages[2].toolCalls.first?.name == "add" && request.messages[2].toolCalls.first?.arguments["a"]?.intValue == 1)100 #expect(request.messages[3].role == .tool && request.messages[3].toolCallID == "c1")101 #expect(request.settings.maxTokens == 77 && request.settings.temperature == 0.2 && request.settings.topP == 0.5 && request.settings.seed == 42)102 #expect(request.stop == ["END"])103 #expect(request.tools.map(\.name) == ["add"])104 #expect(request.responseSchema == ["type": "object"])105 }106107 @Test func rejectsRemoteImageURLsAndEmptyMessages() throws {108 let remote = #"{"model":"m","messages":[{"role":"user","content":[{"type":"image_url","image_url":{"url":"https://example.com/a.png"}}]}]}"#109 let wire = try JSONDecoder().decode(OpenAI.ChatRequest.self, from: Data(remote.utf8))110 #expect(throws: WireError.self) { try wire.generationRequest() }111 let empty = try JSONDecoder().decode(OpenAI.ChatRequest.self, from: Data(#"{"model":"m","messages":[]}"#.utf8))112 #expect(throws: WireError.self) { try empty.generationRequest() }113 let onlySystem = try JSONDecoder().decode(OpenAI.ChatRequest.self, from: Data(#"{"model":"m","messages":[{"role":"system","content":"x"}]}"#.utf8))114 #expect(throws: WireError.self) { try onlySystem.generationRequest() }115 #expect(throws: (any Error).self) { try JSONDecoder().decode(OpenAI.ChatRequest.self, from: Data(#"{"messages":[]}"#.utf8)) }116 }117118 @Test func requestRoundTripsThroughTheWire() throws {119 var settings = GenerationSettings(temperature: 0.3, topP: 0.8, topK: 12, repetitionPenalty: 1.1, seed: 9, maxTokens: 321, reasoningEnabled: false)120 settings.minP = 0.05121 let tool = ToolDefinition(name: "clock", summary: "time", parameters: ["type": "object", "properties": [:]])122 let original = GenerationRequest(messages: [.system("s"), .user("hi", images: [ImageInput(data: Data([1, 2, 3]), mimeType: "image/jpeg")]),123 PromptMessage(role: .assistant, content: "", toolCalls: [ToolInvocation(id: "t1", name: "clock", arguments: ["tz": "UTC"])]),124 PromptMessage(role: .tool, content: "noon", toolCallID: "t1", toolName: "clock")],125 settings: settings, tools: [tool], stop: ["STOP", "END"])126 let data = try JSONEncoder().encode(OpenAI.ChatRequest(model: "m", request: original, stream: true))127 let decoded = try JSONDecoder().decode(OpenAI.ChatRequest.self, from: data).generationRequest()128 #expect(decoded.messages == original.messages)129 #expect(decoded.tools == original.tools)130 #expect(decoded.stop == original.stop)131 #expect(decoded.settings.temperature == 0.3 && decoded.settings.topK == 12 && decoded.settings.minP == 0.05 && decoded.settings.repetitionPenalty == 1.1)132 #expect(decoded.settings.seed == 9 && decoded.settings.maxTokens == 321 && decoded.settings.reasoningEnabled == false)133 }134135 @Test func decodesRealWorldStreamChunks() throws {136 // OpenAI: role chunk, content, finish, usage-only chunk137 let openai = [138 #"{"id":"chatcmpl-1","object":"chat.completion.chunk","created":1,"model":"gpt","system_fingerprint":"fp","choices":[{"index":0,"delta":{"role":"assistant","content":"","refusal":null},"logprobs":null,"finish_reason":null}]}"#,139 #"{"id":"chatcmpl-1","object":"chat.completion.chunk","created":1,"model":"gpt","choices":[{"index":0,"delta":{"content":"Hi"},"finish_reason":null}]}"#,140 #"{"id":"chatcmpl-1","object":"chat.completion.chunk","created":1,"model":"gpt","choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}"#,141 #"{"id":"chatcmpl-1","object":"chat.completion.chunk","created":1,"model":"gpt","choices":[],"usage":{"prompt_tokens":9,"completion_tokens":2,"total_tokens":11,"prompt_tokens_details":{"cached_tokens":4},"completion_tokens_details":{"reasoning_tokens":1}}}"#,142 ].map { try! JSONDecoder().decode(OpenAI.ChatChunk.self, from: Data($0.utf8)) }143 #expect(openai[1].choices[0].delta.content == "Hi")144 #expect(openai[2].choices[0].finishReason == "stop")145 #expect(openai[3].choices.isEmpty && openai[3].usage?.promptTokensDetails?.cachedTokens == 4)146 let metrics = GenerationMetrics(usage: openai[3].usage, server: nil, finishReason: "length")147 #expect(metrics.promptTokens == 9 && metrics.completionTokens == 2 && metrics.cachedPromptTokens == 4 && metrics.reasoningTokens == 1 && metrics.stopReason == .maxTokens)148 #expect(metrics.generationTime == nil && metrics.tokensPerSecond == nil) // nothing invented149150 // Ollama / OpenRouter use "reasoning"; llama.cpp / DeepSeek use "reasoning_content"151 let a = try JSONDecoder().decode(OpenAI.ChatChunk.self, from: Data(#"{"choices":[{"delta":{"reasoning":"hmm"}}]}"#.utf8))152 let b = try JSONDecoder().decode(OpenAI.ChatChunk.self, from: Data(#"{"choices":[{"index":0,"delta":{"reasoning_content":"hmm"}}]}"#.utf8))153 #expect(a.choices[0].delta.reasoningContent == "hmm" && b.choices[0].delta.reasoningContent == "hmm")154155 // error envelopes: object, bare string, numeric code156 #expect(try JSONDecoder().decode(OpenAI.ErrorEnvelope.self, from: Data(#"{"error":{"message":"bad","type":"x","code":429}}"#.utf8)).error.code == "429")157 #expect(try JSONDecoder().decode(OpenAI.ErrorEnvelope.self, from: Data(#"{"error":"plain"}"#.utf8)).error.message == "plain")158 #expect(HTTPClient.errorMessage(Data(#"{"error":{"message":"nope"}}"#.utf8)) == "nope")159 #expect(HTTPClient.errorMessage(Data("<html>".utf8)) == nil)160 }161162 @Test func accumulatesStreamedToolCallFragments() throws {163 let fragments = [164 #"[{"index":0,"id":"call_a","type":"function","function":{"name":"search","arguments":""}}]"#,165 #"[{"index":0,"function":{"arguments":"{\"q\":"}}]"#,166 #"[{"index":0,"function":{"arguments":"\"mlx\"}"}}]"#,167 #"[{"index":1,"id":"call_b","type":"function","function":{"name":"clock","arguments":"{}"}}]"#,168 ]169 var accumulator = ToolCallAccumulator()170 #expect(accumulator.isEmpty)171 for f in fragments { accumulator.add(try JSONDecoder().decode([OpenAI.ToolCall].self, from: Data(f.utf8))) }172 let calls = accumulator.finish()173 #expect(calls.map(\.name) == ["search", "clock"])174 #expect(calls[0].id == "call_a" && calls[0].arguments["q"]?.stringValue == "mlx")175 #expect(calls[1].arguments == .object([:]))176 // arguments sent as a JSON object instead of a string (some servers)177 let object = try JSONDecoder().decode([OpenAI.ToolCall].self, from: Data(#"[{"id":"x","function":{"name":"f","arguments":{"k":2}}}]"#.utf8))178 var second = ToolCallAccumulator(); second.add(object)179 #expect(second.finish().first?.arguments["k"]?.intValue == 2)180 }181182 @Test func decodesModelListsAndEmbeddingsFromOtherServers() throws {183 let ollama = #"{"object":"list","data":[{"id":"llama3.2:3b","object":"model","created":1,"owned_by":"library"}]}"#184 #expect(try JSONDecoder().decode(OpenAI.ModelList.self, from: Data(ollama.utf8)).data.first?.id == "llama3.2:3b")185 let bare = #"{"data":[{"id":"x"}]}"#186 #expect(try JSONDecoder().decode(OpenAI.ModelList.self, from: Data(bare.utf8)).data.first?.localChat == nil)187 let single = try JSONDecoder().decode(OpenAI.EmbeddingRequest.self, from: Data(#"{"model":"e","input":"one"}"#.utf8))188 let many = try JSONDecoder().decode(OpenAI.EmbeddingRequest.self, from: Data(#"{"model":"e","input":["a","b"]}"#.utf8))189 #expect(single.input.values == ["one"] && many.input.values == ["a", "b"])190 let response = try JSONDecoder().decode(OpenAI.EmbeddingResponse.self, from: Data(#"{"data":[{"embedding":[0.5,-1],"index":0}],"model":"e","usage":{"prompt_tokens":3,"total_tokens":3}}"#.utf8))191 #expect(response.data[0].embedding == [0.5, -1] && response.usage?.promptTokens == 3)192 }193194 @Test func dataURLRoundTripAndStopReasons() {195 let image = ImageInput(data: Data([9, 8, 7, 6]), mimeType: "image/webp")196 #expect(DataURL.decode(DataURL.encode(image)) == image)197 #expect(DataURL.decode("https://x/y.png") == nil)198 #expect(DataURL.decode("data:image/png,rawtext") == nil)199 #expect(StopReason.maxTokens.openAIFinishReason == "length" && StopReason.toolCall.openAIFinishReason == "tool_calls" && StopReason.endOfTurn.openAIFinishReason == "stop")200 #expect(StopReason(openAIFinishReason: "tool_calls") == .toolCall && StopReason(openAIFinishReason: nil) == .endOfTurn)201 }202}203