Internalizing the message framing system

ChimeHQ · Nov 30, 2023 · af169ca · af169ca
1 parent 3bef8f4
commit af169ca
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -40,8 +40,7 @@ For the most part, this library strives to be a straightforward version of the s
 - `Server`: a protocol that describes the essential server functionality
 - `Snippet`: makes it easier to interpret the contents of completion results
 - `TokenRepresentation`: maintains the state of a document's semantic tokens
-- `AsyncMessageFramingSequence`: parsers an input AsyncSequence with LSP's HTTP header-based message framing (see also `MessageFraming`)
-- `AsyncByteSequence`: transforms a sequence of Data into a sequence of bytes
+- `DataChannel.withMessageFraming`: wraps an existing JSONRPC DataChannel up with HTTP header-based message framing 
 
 ## Supported Features
 

diff --git a/...rotocol/Additions/AsyncByteSequence.swift → ...rProtocol/Framing/AsyncByteSequence.swift b/...rotocol/Additions/AsyncByteSequence.swift → ...rProtocol/Framing/AsyncByteSequence.swift
@@ -1,7 +1,7 @@
 import Foundation
 
 /// Converts a sequence of Data objects into a sequence of bytes.
-public struct AsyncByteSequence<Base> : AsyncSequence where Base : AsyncSequence, Base.Element == Data {
+struct AsyncByteSequence<Base> : AsyncSequence where Base : AsyncSequence, Base.Element == Data {
 	public typealias Element = UInt8
 
 	public struct AsyncIterator : AsyncIteratorProtocol {

diff --git a/...ditions/AsyncMessageFramingSequence.swift → ...Framing/AsyncMessageFramingSequence.swift b/...ditions/AsyncMessageFramingSequence.swift → ...Framing/AsyncMessageFramingSequence.swift
@@ -1,7 +1,7 @@
 import Foundation
 
 /// Sequence that reads data framed by the LSP base protocol specification.
-public struct AsyncMessageFramingSequence<Base> : AsyncSequence where Base : AsyncSequence, Base.Element == UInt8 {
+struct AsyncMessageFramingSequence<Base> : AsyncSequence where Base : AsyncSequence, Base.Element == UInt8 {
 	public typealias Element = Data
 
 	public struct AsyncIterator : AsyncIteratorProtocol {

diff --git a/...dditions/DataChannel+MessageFraming.swift → .../Framing/DataChannel+MessageFraming.swift b/...dditions/DataChannel+MessageFraming.swift → .../Framing/DataChannel+MessageFraming.swift
diff --git a/...erProtocol/Additions/MessageFraming.swift → ...rverProtocol/Framing/MessageFraming.swift b/...erProtocol/Additions/MessageFraming.swift → ...rverProtocol/Framing/MessageFraming.swift
@@ -7,7 +7,7 @@ enum MessageFramingError: Error {
 	case contentLengthMissing
 }
 
-public struct MessageFraming {
+struct MessageFraming {
 	public static func frame(_ data: Data) -> Data {
 		let length = data.count
 
@@ -24,8 +24,4 @@ public struct MessageFraming {
 
 		return (name, value)
 	}
-
-	public static func dataChannel(stdin: FileHandle, stdout: FileHandle, stderr: FileHandle, object: AnyObject?) -> DataChannel {
-		DataChannel(writeHandler: { _ in }, dataSequence: AsyncStream<Data>(unfolding: { nil }))
-	}
 }
diff --git a/Tests/LanguageServerProtocolTests/AsyncMessageFramingSequenceTests.swift b/Tests/LanguageServerProtocolTests/AsyncMessageFramingSequenceTests.swift
@@ -1,7 +1,7 @@
 import XCTest
-import LanguageServerProtocol
+@testable import LanguageServerProtocol
 
-struct AsyncByteSequence : AsyncSequence {
+struct AsyncDataSequence : AsyncSequence {
 	typealias Element = UInt8
 
 	struct AsyncIterator : AsyncIteratorProtocol {
@@ -44,7 +44,7 @@ final class AsyncMessageFramingSequenceTests: XCTestCase {
 	func testBasicMessageDecode() async throws {
 		let content = "{\"jsonrpc\":\"2.0\",\"params\":\"Something\"}"
 		let message = "Content-Length: \(content.utf8.count)\r\n\r\n\(content)"
-		let sequence = AsyncByteSequence(data: Data(message.utf8))
+		let sequence = AsyncDataSequence(data: Data(message.utf8))
 
 		let contentSequence = AsyncMessageFramingSequence(base: sequence)
 		var iterator = contentSequence.makeAsyncIterator()
@@ -64,7 +64,7 @@ final class AsyncMessageFramingSequenceTests: XCTestCase {
 		let header2 = "Another-Header: Something\r\n"
 		let header3 = "And-Another: third\r\n"
 		let message = header1 + header2 + header3 + "\r\n" + content
-		let sequence = AsyncByteSequence(data: Data(message.utf8))
+		let sequence = AsyncDataSequence(data: Data(message.utf8))
 
 		let contentSequence = AsyncMessageFramingSequence(base: sequence)
 		var iterator = contentSequence.makeAsyncIterator()