HTTP2TransportTests.swift 61 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847
  1. /*
  2. * Copyright 2024, gRPC Authors All rights reserved.
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. import GRPCCore
  17. import GRPCNIOTransportCore
  18. import GRPCNIOTransportHTTP2Posix
  19. import GRPCNIOTransportHTTP2TransportServices
  20. import NIOPosix
  21. import XCTest
  22. import protocol NIOCore.Channel
  23. @available(gRPCSwiftNIOTransport 1.0, *)
  24. final class HTTP2TransportTests: XCTestCase {
  25. // A combination of client and server transport kinds.
  26. struct Transport: Sendable, CustomStringConvertible {
  27. var server: TransportKind
  28. var client: TransportKind
  29. var description: String {
  30. "server=\(self.server) client=\(self.client)"
  31. }
  32. }
  33. func forEachTransportPair(
  34. _ transport: [Transport] = .supported,
  35. serverAddress: SocketAddress = .ipv4(host: "127.0.0.1", port: 0),
  36. enableControlService: Bool = true,
  37. clientCompression: CompressionAlgorithm = .none,
  38. clientEnabledCompression: CompressionAlgorithmSet = .none,
  39. serverCompression: CompressionAlgorithmSet = .none,
  40. _ execute: (
  41. ControlClient<NIOClientTransport>,
  42. GRPCServer<NIOServerTransport>,
  43. Transport
  44. ) async throws -> Void
  45. ) async throws {
  46. for pair in transport {
  47. try await withThrowingTaskGroup(of: Void.self) { group in
  48. let (server, address) = try await self.runServer(
  49. in: &group,
  50. address: serverAddress,
  51. kind: pair.server,
  52. enableControlService: enableControlService,
  53. compression: serverCompression
  54. )
  55. let target: any ResolvableTarget
  56. if let ipv4 = address.ipv4 {
  57. target = .ipv4(host: ipv4.host, port: ipv4.port)
  58. } else if let ipv6 = address.ipv6 {
  59. target = .ipv6(host: ipv6.host, port: ipv6.port)
  60. } else if let uds = address.unixDomainSocket {
  61. target = .unixDomainSocket(path: uds.path)
  62. } else {
  63. XCTFail("Unexpected address to connect to")
  64. return
  65. }
  66. let client = try self.makeClient(
  67. kind: pair.client,
  68. target: target,
  69. compression: clientCompression,
  70. enabledCompression: clientEnabledCompression
  71. )
  72. group.addTask {
  73. try await client.runConnections()
  74. }
  75. do {
  76. let control = ControlClient(wrapping: client)
  77. try await execute(control, server, pair)
  78. } catch {
  79. XCTFail("Unexpected error: '\(error)' (\(pair))")
  80. }
  81. server.beginGracefulShutdown()
  82. client.beginGracefulShutdown()
  83. }
  84. }
  85. }
  86. func forEachClientAndHTTPStatusCodeServer(
  87. _ kind: [TransportKind] = TransportKind.clients,
  88. _ execute: (ControlClient<NIOClientTransport>, TransportKind) async throws -> Void
  89. ) async throws {
  90. for clientKind in kind {
  91. try await withThrowingTaskGroup(of: Void.self) { group in
  92. let server = HTTP2StatusCodeServer()
  93. group.addTask {
  94. try await server.run()
  95. }
  96. let address = try await server.listeningAddress
  97. let client = try self.makeClient(
  98. kind: clientKind,
  99. target: .ipv4(host: address.host, port: address.port),
  100. compression: .none,
  101. enabledCompression: .none
  102. )
  103. group.addTask {
  104. try await client.runConnections()
  105. }
  106. do {
  107. let control = ControlClient(wrapping: client)
  108. try await execute(control, clientKind)
  109. } catch {
  110. XCTFail("Unexpected error: '\(error)' (\(clientKind))")
  111. }
  112. group.cancelAll()
  113. }
  114. }
  115. }
  116. private func runServer(
  117. in group: inout ThrowingTaskGroup<Void, any Error>,
  118. address: SocketAddress,
  119. kind: TransportKind,
  120. enableControlService: Bool,
  121. compression: CompressionAlgorithmSet
  122. ) async throws -> (GRPCServer<NIOServerTransport>, GRPCNIOTransportCore.SocketAddress) {
  123. let services = enableControlService ? [ControlService()] : []
  124. switch kind {
  125. case .posix:
  126. let server = GRPCServer(
  127. transport: NIOServerTransport(
  128. .http2NIOPosix(
  129. address: address,
  130. transportSecurity: .plaintext,
  131. config: .defaults {
  132. $0.compression.enabledAlgorithms = compression
  133. $0.rpc.maxRequestPayloadSize = .max
  134. }
  135. )
  136. ),
  137. services: services
  138. )
  139. group.addTask {
  140. try await server.serve()
  141. }
  142. let address = try await server.listeningAddress!
  143. return (server, address)
  144. #if canImport(Network)
  145. case .transportServices:
  146. let server = GRPCServer(
  147. transport: NIOServerTransport(
  148. .http2NIOTS(
  149. address: address,
  150. transportSecurity: .plaintext,
  151. config: .defaults {
  152. $0.compression.enabledAlgorithms = compression
  153. $0.rpc.maxRequestPayloadSize = .max
  154. }
  155. )
  156. ),
  157. services: services
  158. )
  159. group.addTask {
  160. try await server.serve()
  161. }
  162. let address = try await server.listeningAddress!
  163. return (server, address)
  164. #endif
  165. case .wrappedChannel:
  166. fatalError("Unsupported")
  167. }
  168. }
  169. private func makeClient(
  170. kind: TransportKind,
  171. target: any ResolvableTarget,
  172. compression: CompressionAlgorithm,
  173. enabledCompression: CompressionAlgorithmSet
  174. ) throws -> GRPCClient<NIOClientTransport> {
  175. let transport: NIOClientTransport
  176. var serviceConfig = ServiceConfig()
  177. serviceConfig.loadBalancingConfig = [.roundRobin]
  178. serviceConfig.methodConfig = [
  179. MethodConfig(
  180. // Applies to all RPCs
  181. names: [MethodConfig.Name(service: "", method: "")],
  182. maxRequestMessageBytes: .max,
  183. maxResponseMessageBytes: .max
  184. )
  185. ]
  186. switch kind {
  187. case .posix:
  188. let posix = try HTTP2ClientTransport.Posix(
  189. target: target,
  190. transportSecurity: .plaintext,
  191. config: .defaults {
  192. $0.compression.algorithm = compression
  193. $0.compression.enabledAlgorithms = enabledCompression
  194. },
  195. serviceConfig: serviceConfig
  196. )
  197. transport = NIOClientTransport(posix)
  198. #if canImport(Network)
  199. case .transportServices:
  200. let transportServices = try HTTP2ClientTransport.TransportServices(
  201. target: target,
  202. transportSecurity: .plaintext,
  203. config: .defaults {
  204. $0.compression.algorithm = compression
  205. $0.compression.enabledAlgorithms = enabledCompression
  206. },
  207. serviceConfig: serviceConfig
  208. )
  209. transport = NIOClientTransport(transportServices)
  210. #endif
  211. case .wrappedChannel:
  212. let bootstrap = ClientBootstrap(group: .singletonMultiThreadedEventLoopGroup)
  213. let channel: any Channel
  214. var config = HTTP2ClientTransport.WrappedChannel.Config.defaults
  215. config.compression.algorithm = compression
  216. config.compression.enabledAlgorithms = enabledCompression
  217. if let dns = target as? ResolvableTargets.DNS {
  218. channel = try bootstrap.connect(host: dns.host, port: dns.port ?? 443).wait()
  219. config.http2.authority = dns.host
  220. } else if let ipv4 = target as? ResolvableTargets.IPv4, let address = ipv4.addresses.first {
  221. channel = try bootstrap.connect(host: address.host, port: address.port).wait()
  222. config.http2.authority = address.host
  223. } else if let ipv6 = target as? ResolvableTargets.IPv6, let address = ipv6.addresses.first {
  224. channel = try bootstrap.connect(host: address.host, port: address.port).wait()
  225. config.http2.authority = address.host
  226. } else if let uds = target as? ResolvableTargets.UnixDomainSocket {
  227. channel = try bootstrap.connect(unixDomainSocketPath: uds.address.path).wait()
  228. config.http2.authority = uds.authority
  229. } else {
  230. throw RPCError(
  231. code: .invalidArgument,
  232. message: "Target '\(target)' isn't supported by the tunnel transport."
  233. )
  234. }
  235. let wrapped = HTTP2ClientTransport.WrappedChannel(
  236. takingOwnershipOf: channel,
  237. config: config,
  238. serviceConfig: serviceConfig
  239. )
  240. transport = NIOClientTransport(wrapped)
  241. }
  242. return GRPCClient(transport: transport, interceptors: [PeerInfoClientInterceptor()])
  243. }
  244. func testUnaryOK() async throws {
  245. // Client sends one message, server sends back metadata, a single message, and an ok status with
  246. // trailing metadata.
  247. try await self.forEachTransportPair { control, _, pair in
  248. let input = ControlInput.with {
  249. $0.echoMetadataInHeaders = true
  250. $0.echoMetadataInTrailers = true
  251. $0.numberOfMessages = 1
  252. $0.payloadParameters = .with {
  253. $0.content = 0
  254. $0.size = 1024
  255. }
  256. }
  257. let metadata: Metadata = ["test-key": "test-value"]
  258. let request = ClientRequest(message: input, metadata: metadata)
  259. try await control.unary(request: request) { response in
  260. let message = try response.message
  261. XCTAssertEqual(message.payload, Data(repeating: 0, count: 1024), "\(pair)")
  262. let initial = response.metadata
  263. XCTAssertEqual(Array(initial["echo-test-key"]), ["test-value"], "\(pair)")
  264. let trailing = response.trailingMetadata
  265. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  266. }
  267. }
  268. }
  269. func testUnaryNotOK() async throws {
  270. // Client sends one message, server sends back metadata, a single message, and a non-ok status
  271. // with trailing metadata.
  272. try await self.forEachTransportPair { control, _, pair in
  273. let input = ControlInput.with {
  274. $0.echoMetadataInTrailers = true
  275. $0.numberOfMessages = 1
  276. $0.payloadParameters = .with {
  277. $0.content = 0
  278. $0.size = 1024
  279. }
  280. $0.status = .with {
  281. $0.code = .aborted
  282. $0.message = "\(#function)"
  283. }
  284. }
  285. let metadata: Metadata = ["test-key": "test-value"]
  286. let request = ClientRequest(message: input, metadata: metadata)
  287. try await control.unary(request: request) { response in
  288. XCTAssertThrowsError(ofType: RPCError.self, try response.message) { error in
  289. XCTAssertEqual(error.code, .aborted)
  290. XCTAssertEqual(error.message, "\(#function)")
  291. let trailing = error.metadata
  292. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  293. }
  294. let trailing = response.trailingMetadata
  295. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  296. }
  297. }
  298. }
  299. func testUnaryRejected() async throws {
  300. // Client sends one message, server sends non-ok status with trailing metadata.
  301. try await self.forEachTransportPair { control, _, pair in
  302. let metadata: Metadata = ["test-key": "test-value"]
  303. let request = ClientRequest<ControlInput>(
  304. message: .trailersOnly(code: .aborted, message: "\(#function)", echoMetadata: true),
  305. metadata: metadata
  306. )
  307. try await control.unary(request: request) { response in
  308. XCTAssertThrowsError(ofType: RPCError.self, try response.message) { error in
  309. XCTAssertEqual(error.code, .aborted, "\(pair)")
  310. XCTAssertEqual(error.message, "\(#function)", "\(pair)")
  311. let trailing = error.metadata
  312. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  313. }
  314. // No initial metadata for trailers-only.
  315. XCTAssertEqual(response.metadata, [:])
  316. let trailing = response.trailingMetadata
  317. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  318. }
  319. }
  320. }
  321. func testClientStreamingOK() async throws {
  322. try await self.forEachTransportPair { control, _, pair in
  323. let metadata: Metadata = ["test-key": "test-value"]
  324. let request = StreamingClientRequest(
  325. of: ControlInput.self,
  326. metadata: metadata
  327. ) { writer in
  328. try await writer.write(.echoMetadata)
  329. // Send a few messages which are ignored.
  330. try await writer.write(.noOp)
  331. try await writer.write(.noOp)
  332. try await writer.write(.noOp)
  333. // Send a message.
  334. try await writer.write(.messages(1, repeating: 42, count: 1024))
  335. // ... and the final status.
  336. try await writer.write(.status(code: .ok, message: "", echoMetadata: true))
  337. }
  338. try await control.clientStream(request: request) { response in
  339. let message = try response.message
  340. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024), "\(pair)")
  341. let initial = response.metadata
  342. XCTAssertEqual(Array(initial["echo-test-key"]), ["test-value"], "\(pair)")
  343. let trailing = response.trailingMetadata
  344. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  345. }
  346. }
  347. }
  348. func testClientStreamingNotOK() async throws {
  349. try await self.forEachTransportPair { control, _, pair in
  350. let metadata: Metadata = ["test-key": "test-value"]
  351. let request = StreamingClientRequest(
  352. of: ControlInput.self,
  353. metadata: metadata
  354. ) { writer in
  355. try await writer.write(.echoMetadata)
  356. // Send a few messages which are ignored.
  357. try await writer.write(.noOp)
  358. try await writer.write(.noOp)
  359. try await writer.write(.noOp)
  360. // Send a message.
  361. try await writer.write(.messages(1, repeating: 42, count: 1024))
  362. // Send the final status.
  363. try await writer.write(.status(code: .aborted, message: "\(#function)", echoMetadata: true))
  364. }
  365. try await control.clientStream(request: request) { response in
  366. XCTAssertThrowsError(ofType: RPCError.self, try response.message) { error in
  367. XCTAssertEqual(error.code, .aborted, "\(pair)")
  368. XCTAssertEqual(error.message, "\(#function)", "\(pair)")
  369. let trailing = error.metadata
  370. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  371. }
  372. let initial = response.metadata
  373. XCTAssertEqual(Array(initial["echo-test-key"]), ["test-value"], "\(pair)")
  374. let trailing = response.trailingMetadata
  375. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  376. }
  377. }
  378. }
  379. func testClientStreamingRejected() async throws {
  380. // Client sends one message, server sends non-ok status with trailing metadata.
  381. try await self.forEachTransportPair { control, _, pair in
  382. let metadata: Metadata = ["test-key": "test-value"]
  383. let request = StreamingClientRequest(
  384. of: ControlInput.self,
  385. metadata: metadata
  386. ) { writer in
  387. let message: ControlInput = .trailersOnly(
  388. code: .aborted,
  389. message: "\(#function)",
  390. echoMetadata: true
  391. )
  392. try await writer.write(message)
  393. }
  394. try await control.clientStream(request: request) { response in
  395. XCTAssertThrowsError(ofType: RPCError.self, try response.message) { error in
  396. XCTAssertEqual(error.code, .aborted, "\(pair)")
  397. XCTAssertEqual(error.message, "\(#function)", "\(pair)")
  398. let trailing = error.metadata
  399. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  400. }
  401. // No initial metadata for trailers-only.
  402. XCTAssertEqual(response.metadata, [:])
  403. let trailing = response.trailingMetadata
  404. XCTAssertEqual(Array(trailing["echo-test-key"]), ["test-value"], "\(pair)")
  405. }
  406. }
  407. }
  408. func testServerStreamingOK() async throws {
  409. try await self.forEachTransportPair { control, _, pair in
  410. let metadata: Metadata = ["test-key": "test-value"]
  411. let input = ControlInput.with {
  412. $0.echoMetadataInHeaders = true
  413. $0.echoMetadataInTrailers = true
  414. $0.numberOfMessages = 5
  415. $0.payloadParameters = .with {
  416. $0.content = 42
  417. $0.size = 1024
  418. }
  419. }
  420. let request = ClientRequest(message: input, metadata: metadata)
  421. try await control.serverStream(request: request) { response in
  422. switch response.accepted {
  423. case .success(let contents):
  424. XCTAssertEqual(Array(contents.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  425. var messagesReceived = 0
  426. for try await part in contents.bodyParts {
  427. switch part {
  428. case .message(let message):
  429. messagesReceived += 1
  430. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024))
  431. case .trailingMetadata(let metadata):
  432. XCTAssertEqual(Array(metadata["echo-test-key"]), ["test-value"], "\(pair)")
  433. }
  434. }
  435. XCTAssertEqual(messagesReceived, 5)
  436. case .failure(let error):
  437. throw error
  438. }
  439. }
  440. }
  441. }
  442. func testServerStreamingEmptyOK() async throws {
  443. try await self.forEachTransportPair { control, _, pair in
  444. let metadata: Metadata = ["test-key": "test-value"]
  445. // Echo back metadata, but don't send any messages.
  446. let input = ControlInput.with {
  447. $0.echoMetadataInHeaders = true
  448. $0.echoMetadataInTrailers = true
  449. }
  450. let request = ClientRequest(message: input, metadata: metadata)
  451. try await control.serverStream(request: request) { response in
  452. switch response.accepted {
  453. case .success(let contents):
  454. XCTAssertEqual(Array(contents.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  455. for try await part in contents.bodyParts {
  456. switch part {
  457. case .message:
  458. XCTFail("Unexpected message")
  459. case .trailingMetadata(let metadata):
  460. XCTAssertEqual(Array(metadata["echo-test-key"]), ["test-value"], "\(pair)")
  461. }
  462. }
  463. case .failure(let error):
  464. throw error
  465. }
  466. }
  467. }
  468. }
  469. func testServerStreamingNotOK() async throws {
  470. try await self.forEachTransportPair { control, _, pair in
  471. let metadata: Metadata = ["test-key": "test-value"]
  472. let input = ControlInput.with {
  473. $0.echoMetadataInHeaders = true
  474. $0.echoMetadataInTrailers = true
  475. $0.numberOfMessages = 5
  476. $0.payloadParameters = .with {
  477. $0.content = 42
  478. $0.size = 1024
  479. }
  480. $0.status = .with {
  481. $0.code = .aborted
  482. $0.message = "\(#function)"
  483. }
  484. }
  485. let request = ClientRequest(message: input, metadata: metadata)
  486. try await control.serverStream(request: request) { response in
  487. switch response.accepted {
  488. case .success(let contents):
  489. XCTAssertEqual(Array(contents.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  490. var messagesReceived = 0
  491. do {
  492. for try await part in contents.bodyParts {
  493. switch part {
  494. case .message(let message):
  495. messagesReceived += 1
  496. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024))
  497. case .trailingMetadata:
  498. XCTFail("Unexpected trailing metadata, should be provided in RPCError")
  499. }
  500. }
  501. XCTFail("Expected error to be thrown")
  502. } catch let error as RPCError {
  503. XCTAssertEqual(error.code, .aborted)
  504. XCTAssertEqual(error.message, "\(#function)")
  505. XCTAssertEqual(Array(error.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  506. }
  507. XCTAssertEqual(messagesReceived, 5)
  508. case .failure(let error):
  509. throw error
  510. }
  511. }
  512. }
  513. }
  514. func testServerStreamingEmptyNotOK() async throws {
  515. try await self.forEachTransportPair { control, _, pair in
  516. let metadata: Metadata = ["test-key": "test-value"]
  517. let input = ControlInput.with {
  518. $0.echoMetadataInHeaders = true
  519. $0.echoMetadataInTrailers = true
  520. $0.status = .with {
  521. $0.code = .aborted
  522. $0.message = "\(#function)"
  523. }
  524. }
  525. let request = ClientRequest(message: input, metadata: metadata)
  526. try await control.serverStream(request: request) { response in
  527. switch response.accepted {
  528. case .success(let contents):
  529. XCTAssertEqual(Array(contents.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  530. do {
  531. for try await _ in contents.bodyParts {
  532. XCTFail("Unexpected message, \(pair)")
  533. }
  534. XCTFail("Expected error to be thrown")
  535. } catch let error as RPCError {
  536. XCTAssertEqual(error.code, .aborted)
  537. XCTAssertEqual(error.message, "\(#function)")
  538. XCTAssertEqual(Array(error.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  539. }
  540. case .failure(let error):
  541. throw error
  542. }
  543. }
  544. }
  545. }
  546. func testServerStreamingRejected() async throws {
  547. try await self.forEachTransportPair { control, _, pair in
  548. let metadata: Metadata = ["test-key": "test-value"]
  549. let request = ClientRequest<ControlInput>(
  550. message: .trailersOnly(code: .aborted, message: "\(#function)", echoMetadata: true),
  551. metadata: metadata
  552. )
  553. try await control.serverStream(request: request) { response in
  554. switch response.accepted {
  555. case .success:
  556. XCTFail("Expected RPC to be rejected \(pair)")
  557. case .failure(let error):
  558. XCTAssertEqual(error.code, .aborted, "\(pair)")
  559. XCTAssertEqual(error.message, "\(#function)", "\(pair)")
  560. XCTAssertEqual(Array(error.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  561. }
  562. }
  563. }
  564. }
  565. func testBidiStreamingOK() async throws {
  566. try await self.forEachTransportPair { control, _, pair in
  567. let metadata: Metadata = ["test-key": "test-value"]
  568. let request = StreamingClientRequest(
  569. of: ControlInput.self,
  570. metadata: metadata
  571. ) { writer in
  572. try await writer.write(.echoMetadata)
  573. // Send a few messages, each is echo'd back.
  574. try await writer.write(.messages(1, repeating: 42, count: 1024))
  575. try await writer.write(.messages(1, repeating: 42, count: 1024))
  576. try await writer.write(.messages(1, repeating: 42, count: 1024))
  577. // Send the final status.
  578. try await writer.write(.status(code: .ok, message: "", echoMetadata: true))
  579. }
  580. try await control.bidiStream(request: request) { response in
  581. switch response.accepted {
  582. case .success(let contents):
  583. XCTAssertEqual(Array(contents.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  584. var messagesReceived = 0
  585. for try await part in contents.bodyParts {
  586. switch part {
  587. case .message(let message):
  588. messagesReceived += 1
  589. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024))
  590. case .trailingMetadata(let metadata):
  591. XCTAssertEqual(Array(metadata["echo-test-key"]), ["test-value"], "\(pair)")
  592. }
  593. }
  594. XCTAssertEqual(messagesReceived, 3)
  595. case .failure(let error):
  596. throw error
  597. }
  598. }
  599. }
  600. }
  601. func testBidiStreamingEmptyOK() async throws {
  602. try await self.forEachTransportPair { control, _, pair in
  603. let request = StreamingClientRequest(of: ControlInput.self) { _ in }
  604. try await control.bidiStream(request: request) { response in
  605. switch response.accepted {
  606. case .success(let contents):
  607. var receivedTrailingMetadata = false
  608. for try await part in contents.bodyParts {
  609. switch part {
  610. case .message:
  611. XCTFail("Unexpected message \(pair)")
  612. case .trailingMetadata:
  613. XCTAssertFalse(receivedTrailingMetadata, "\(pair)")
  614. receivedTrailingMetadata = true
  615. }
  616. }
  617. case .failure(let error):
  618. throw error
  619. }
  620. }
  621. }
  622. }
  623. func testBidiStreamingNotOK() async throws {
  624. try await self.forEachTransportPair { control, _, pair in
  625. let metadata: Metadata = ["test-key": "test-value"]
  626. let request = StreamingClientRequest(
  627. of: ControlInput.self,
  628. metadata: metadata
  629. ) { writer in
  630. try await writer.write(.echoMetadata)
  631. // Send a few messages, each is echo'd back.
  632. try await writer.write(.messages(1, repeating: 42, count: 1024))
  633. try await writer.write(.messages(1, repeating: 42, count: 1024))
  634. try await writer.write(.messages(1, repeating: 42, count: 1024))
  635. // Send the final status.
  636. try await writer.write(.status(code: .aborted, message: "\(#function)", echoMetadata: true))
  637. }
  638. try await control.bidiStream(request: request) { response in
  639. switch response.accepted {
  640. case .success(let contents):
  641. XCTAssertEqual(Array(contents.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  642. var messagesReceived = 0
  643. do {
  644. for try await part in contents.bodyParts {
  645. switch part {
  646. case .message(let message):
  647. messagesReceived += 1
  648. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024))
  649. case .trailingMetadata:
  650. XCTFail("Trailing metadata should be provided by error")
  651. }
  652. }
  653. XCTFail("Should've thrown error \(pair)")
  654. } catch let error as RPCError {
  655. XCTAssertEqual(error.code, .aborted)
  656. XCTAssertEqual(error.message, "\(#function)")
  657. XCTAssertEqual(Array(error.metadata["echo-test-key"]), ["test-value"], "\(pair)")
  658. }
  659. XCTAssertEqual(messagesReceived, 3)
  660. case .failure(let error):
  661. throw error
  662. }
  663. }
  664. }
  665. }
  666. func testBidiStreamingRejected() async throws {
  667. try await self.forEachTransportPair { control, _, pair in
  668. let metadata: Metadata = ["test-key": "test-value"]
  669. let request = StreamingClientRequest(
  670. of: ControlInput.self,
  671. metadata: metadata
  672. ) { writer in
  673. try await writer.write(
  674. .trailersOnly(
  675. code: .aborted,
  676. message: "\(#function)",
  677. echoMetadata: true
  678. )
  679. )
  680. }
  681. try await control.bidiStream(request: request) { response in
  682. switch response.accepted {
  683. case .success:
  684. XCTFail("Expected RPC to fail \(pair)")
  685. case .failure(let error):
  686. XCTAssertEqual(error.code, .aborted)
  687. XCTAssertEqual(error.message, "\(#function)")
  688. XCTAssertEqual(Array(error.metadata["echo-test-key"]), ["test-value"])
  689. }
  690. }
  691. }
  692. }
  693. // MARK: - Not Implemented
  694. func testUnaryNotImplemented() async throws {
  695. try await self.forEachTransportPair(enableControlService: false) { control, _, pair in
  696. let request = ClientRequest(message: ControlInput())
  697. try await control.unary(request: request) { response in
  698. XCTAssertThrowsError(ofType: RPCError.self, try response.message) { error in
  699. XCTAssertEqual(error.code, .unimplemented)
  700. }
  701. }
  702. }
  703. }
  704. func testClientStreamingNotImplemented() async throws {
  705. try await self.forEachTransportPair(enableControlService: false) { control, _, pair in
  706. let request = StreamingClientRequest(of: ControlInput.self) { _ in }
  707. try await control.clientStream(request: request) { response in
  708. XCTAssertThrowsError(ofType: RPCError.self, try response.message) { error in
  709. XCTAssertEqual(error.code, .unimplemented)
  710. }
  711. }
  712. }
  713. }
  714. func testServerStreamingNotImplemented() async throws {
  715. try await self.forEachTransportPair(enableControlService: false) { control, _, pair in
  716. let request = ClientRequest(message: ControlInput())
  717. try await control.serverStream(request: request) { response in
  718. XCTAssertThrowsError(ofType: RPCError.self, try response.accepted.get()) { error in
  719. XCTAssertEqual(error.code, .unimplemented)
  720. }
  721. }
  722. }
  723. }
  724. func testBidiStreamingNotImplemented() async throws {
  725. try await self.forEachTransportPair(enableControlService: false) { control, _, pair in
  726. let request = StreamingClientRequest(of: ControlInput.self) { _ in }
  727. try await control.bidiStream(request: request) { response in
  728. XCTAssertThrowsError(ofType: RPCError.self, try response.accepted.get()) { error in
  729. XCTAssertEqual(error.code, .unimplemented)
  730. }
  731. }
  732. }
  733. }
  734. // MARK: - Compression tests
  735. private func testUnaryCompression(
  736. client: CompressionAlgorithm,
  737. server: CompressionAlgorithm,
  738. control: ControlClient<NIOClientTransport>,
  739. pair: Transport
  740. ) async throws {
  741. let message = ControlInput.with {
  742. $0.echoMetadataInHeaders = true
  743. $0.numberOfMessages = 1
  744. $0.payloadParameters = .with {
  745. $0.content = 42
  746. $0.size = 1024
  747. }
  748. }
  749. var options = CallOptions.defaults
  750. options.compression = client
  751. try await control.unary(
  752. request: ClientRequest(message: message),
  753. options: options
  754. ) { response in
  755. // Check the client algorithm.
  756. switch client {
  757. case .deflate, .gzip:
  758. // "echo-grpc-encoding" is the value of "grpc-encoding" sent from the client to the server.
  759. let encoding = Array(response.metadata["echo-grpc-encoding"])
  760. XCTAssertEqual(encoding, ["\(client.name)"], "\(pair)")
  761. case .none:
  762. ()
  763. default:
  764. XCTFail("Unhandled compression '\(client)'")
  765. }
  766. // Check the server algorithm.
  767. switch server {
  768. case .deflate, .gzip:
  769. let encoding = Array(response.metadata["grpc-encoding"])
  770. XCTAssertEqual(encoding, ["\(server.name)"], "\(pair)")
  771. case .none:
  772. ()
  773. default:
  774. XCTFail("Unhandled compression '\(client)'")
  775. }
  776. let message = try response.message
  777. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024), "\(pair)")
  778. }
  779. }
  780. private func testClientStreamingCompression(
  781. client: CompressionAlgorithm,
  782. server: CompressionAlgorithm,
  783. control: ControlClient<NIOClientTransport>,
  784. pair: Transport
  785. ) async throws {
  786. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  787. try await writer.write(.echoMetadata)
  788. try await writer.write(.noOp)
  789. try await writer.write(.noOp)
  790. try await writer.write(.messages(1, repeating: 42, count: 1024))
  791. }
  792. var options = CallOptions.defaults
  793. options.compression = client
  794. try await control.clientStream(request: request, options: options) { response in
  795. // Check the client algorithm.
  796. switch client {
  797. case .deflate, .gzip:
  798. // "echo-grpc-encoding" is the value of "grpc-encoding" sent from the client to the server.
  799. let encoding = Array(response.metadata["echo-grpc-encoding"])
  800. XCTAssertEqual(encoding, ["\(client.name)"], "\(pair)")
  801. case .none:
  802. ()
  803. default:
  804. XCTFail("Unhandled compression '\(client)'")
  805. }
  806. // Check the server algorithm.
  807. switch server {
  808. case .deflate, .gzip:
  809. let encoding = Array(response.metadata["grpc-encoding"])
  810. XCTAssertEqual(encoding, ["\(server.name)"], "\(pair)")
  811. case .none:
  812. ()
  813. default:
  814. XCTFail("Unhandled compression '\(client)'")
  815. }
  816. let message = try response.message
  817. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024), "\(pair)")
  818. }
  819. }
  820. private func testServerStreamingCompression(
  821. client: CompressionAlgorithm,
  822. server: CompressionAlgorithm,
  823. control: ControlClient<NIOClientTransport>,
  824. pair: Transport
  825. ) async throws {
  826. let message = ControlInput.with {
  827. $0.echoMetadataInHeaders = true
  828. $0.numberOfMessages = 5
  829. $0.payloadParameters = .with {
  830. $0.content = 42
  831. $0.size = 1024
  832. }
  833. }
  834. var options = CallOptions.defaults
  835. options.compression = client
  836. try await control.serverStream(
  837. request: ClientRequest(message: message),
  838. options: options
  839. ) { response in
  840. // Check the client algorithm.
  841. switch client {
  842. case .deflate, .gzip:
  843. // "echo-grpc-encoding" is the value of "grpc-encoding" sent from the client to the server.
  844. let encoding = Array(response.metadata["echo-grpc-encoding"])
  845. XCTAssertEqual(encoding, ["\(client.name)"], "\(pair)")
  846. case .none:
  847. ()
  848. default:
  849. XCTFail("Unhandled compression '\(client)'")
  850. }
  851. // Check the server algorithm.
  852. switch server {
  853. case .deflate, .gzip:
  854. let encoding = Array(response.metadata["grpc-encoding"])
  855. XCTAssertEqual(encoding, ["\(server.name)"], "\(pair)")
  856. case .none:
  857. ()
  858. default:
  859. XCTFail("Unhandled compression '\(client)'")
  860. }
  861. for try await message in response.messages {
  862. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024), "\(pair)")
  863. }
  864. }
  865. }
  866. private func testBidiStreamingCompression(
  867. client: CompressionAlgorithm,
  868. server: CompressionAlgorithm,
  869. control: ControlClient<NIOClientTransport>,
  870. pair: Transport
  871. ) async throws {
  872. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  873. try await writer.write(.echoMetadata)
  874. try await writer.write(.messages(1, repeating: 42, count: 1024))
  875. try await writer.write(.messages(1, repeating: 42, count: 1024))
  876. try await writer.write(.messages(1, repeating: 42, count: 1024))
  877. }
  878. var options = CallOptions.defaults
  879. options.compression = client
  880. try await control.bidiStream(request: request, options: options) { response in
  881. // Check the client algorithm.
  882. switch client {
  883. case .deflate, .gzip:
  884. // "echo-grpc-encoding" is the value of "grpc-encoding" sent from the client to the server.
  885. let encoding = Array(response.metadata["echo-grpc-encoding"])
  886. XCTAssertEqual(encoding, ["\(client.name)"], "\(pair)")
  887. case .none:
  888. ()
  889. default:
  890. XCTFail("Unhandled compression '\(client)'")
  891. }
  892. // Check the server algorithm.
  893. switch server {
  894. case .deflate, .gzip:
  895. let encoding = Array(response.metadata["grpc-encoding"])
  896. XCTAssertEqual(encoding, ["\(server.name)"], "\(pair)")
  897. case .none:
  898. ()
  899. default:
  900. XCTFail("Unhandled compression '\(client)'")
  901. }
  902. for try await message in response.messages {
  903. XCTAssertEqual(message.payload, Data(repeating: 42, count: 1024), "\(pair)")
  904. }
  905. }
  906. }
  907. func testUnaryDeflateCompression() async throws {
  908. try await self.forEachTransportPair(
  909. clientCompression: .deflate,
  910. clientEnabledCompression: .deflate,
  911. serverCompression: .deflate
  912. ) { control, _, pair in
  913. try await self.testUnaryCompression(
  914. client: .deflate,
  915. server: .deflate,
  916. control: control,
  917. pair: pair
  918. )
  919. }
  920. }
  921. func testUnaryGzipCompression() async throws {
  922. try await self.forEachTransportPair(
  923. clientCompression: .gzip,
  924. clientEnabledCompression: .gzip,
  925. serverCompression: .gzip
  926. ) { control, _, pair in
  927. try await self.testUnaryCompression(
  928. client: .gzip,
  929. server: .gzip,
  930. control: control,
  931. pair: pair
  932. )
  933. }
  934. }
  935. func testClientStreamingDeflateCompression() async throws {
  936. try await self.forEachTransportPair(
  937. clientCompression: .deflate,
  938. clientEnabledCompression: .deflate,
  939. serverCompression: .deflate
  940. ) { control, _, pair in
  941. try await self.testClientStreamingCompression(
  942. client: .deflate,
  943. server: .deflate,
  944. control: control,
  945. pair: pair
  946. )
  947. }
  948. }
  949. func testClientStreamingGzipCompression() async throws {
  950. try await self.forEachTransportPair(
  951. clientCompression: .gzip,
  952. clientEnabledCompression: .gzip,
  953. serverCompression: .gzip
  954. ) { control, _, pair in
  955. try await self.testClientStreamingCompression(
  956. client: .gzip,
  957. server: .gzip,
  958. control: control,
  959. pair: pair
  960. )
  961. }
  962. }
  963. func testServerStreamingDeflateCompression() async throws {
  964. try await self.forEachTransportPair(
  965. clientCompression: .deflate,
  966. clientEnabledCompression: .deflate,
  967. serverCompression: .deflate
  968. ) { control, _, pair in
  969. try await self.testServerStreamingCompression(
  970. client: .deflate,
  971. server: .deflate,
  972. control: control,
  973. pair: pair
  974. )
  975. }
  976. }
  977. func testServerStreamingGzipCompression() async throws {
  978. try await self.forEachTransportPair(
  979. clientCompression: .gzip,
  980. clientEnabledCompression: .gzip,
  981. serverCompression: .gzip
  982. ) { control, _, pair in
  983. try await self.testServerStreamingCompression(
  984. client: .gzip,
  985. server: .gzip,
  986. control: control,
  987. pair: pair
  988. )
  989. }
  990. }
  991. func testBidiStreamingDeflateCompression() async throws {
  992. try await self.forEachTransportPair(
  993. clientCompression: .deflate,
  994. clientEnabledCompression: .deflate,
  995. serverCompression: .deflate
  996. ) { control, _, pair in
  997. try await self.testBidiStreamingCompression(
  998. client: .deflate,
  999. server: .deflate,
  1000. control: control,
  1001. pair: pair
  1002. )
  1003. }
  1004. }
  1005. func testBidiStreamingGzipCompression() async throws {
  1006. try await self.forEachTransportPair(
  1007. clientCompression: .gzip,
  1008. clientEnabledCompression: .gzip,
  1009. serverCompression: .gzip
  1010. ) { control, _, pair in
  1011. try await self.testBidiStreamingCompression(
  1012. client: .gzip,
  1013. server: .gzip,
  1014. control: control,
  1015. pair: pair
  1016. )
  1017. }
  1018. }
  1019. func testUnaryUnsupportedCompression() async throws {
  1020. try await self.forEachTransportPair(
  1021. clientEnabledCompression: .all,
  1022. serverCompression: .gzip
  1023. ) { control, _, pair in
  1024. let message = ControlInput.with {
  1025. $0.numberOfMessages = 1
  1026. $0.payloadParameters = .with {
  1027. $0.content = 42
  1028. $0.size = 1024
  1029. }
  1030. }
  1031. let request = ClientRequest(message: message)
  1032. var options = CallOptions.defaults
  1033. options.compression = .deflate
  1034. try await control.unary(request: request, options: options) { response in
  1035. switch response.accepted {
  1036. case .success:
  1037. XCTFail("RPC should've been rejected")
  1038. case .failure(let error):
  1039. let acceptEncoding = Array(error.metadata["grpc-accept-encoding"])
  1040. // "identity" may or may not be included, so only test for values which must be present.
  1041. XCTAssertTrue(acceptEncoding.contains("gzip"))
  1042. XCTAssertFalse(acceptEncoding.contains("deflate"))
  1043. }
  1044. }
  1045. }
  1046. }
  1047. func testClientStreamingUnsupportedCompression() async throws {
  1048. try await self.forEachTransportPair(
  1049. clientEnabledCompression: .all,
  1050. serverCompression: .gzip
  1051. ) { control, _, pair in
  1052. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  1053. try await writer.write(.noOp)
  1054. }
  1055. var options = CallOptions.defaults
  1056. options.compression = .deflate
  1057. try await control.clientStream(request: request, options: options) { response in
  1058. switch response.accepted {
  1059. case .success:
  1060. XCTFail("RPC should've been rejected")
  1061. case .failure(let error):
  1062. let acceptEncoding = Array(error.metadata["grpc-accept-encoding"])
  1063. // "identity" may or may not be included, so only test for values which must be present.
  1064. XCTAssertTrue(acceptEncoding.contains("gzip"))
  1065. XCTAssertFalse(acceptEncoding.contains("deflate"))
  1066. }
  1067. }
  1068. }
  1069. }
  1070. func testServerStreamingUnsupportedCompression() async throws {
  1071. try await self.forEachTransportPair(
  1072. clientEnabledCompression: .all,
  1073. serverCompression: .gzip
  1074. ) { control, _, pair in
  1075. let message = ControlInput.with {
  1076. $0.numberOfMessages = 1
  1077. $0.payloadParameters = .with {
  1078. $0.content = 42
  1079. $0.size = 1024
  1080. }
  1081. }
  1082. let request = ClientRequest(message: message)
  1083. var options = CallOptions.defaults
  1084. options.compression = .deflate
  1085. try await control.serverStream(request: request, options: options) { response in
  1086. switch response.accepted {
  1087. case .success:
  1088. XCTFail("RPC should've been rejected")
  1089. case .failure(let error):
  1090. let acceptEncoding = Array(error.metadata["grpc-accept-encoding"])
  1091. // "identity" may or may not be included, so only test for values which must be present.
  1092. XCTAssertTrue(acceptEncoding.contains("gzip"))
  1093. XCTAssertFalse(acceptEncoding.contains("deflate"))
  1094. }
  1095. }
  1096. }
  1097. }
  1098. func testBidiStreamingUnsupportedCompression() async throws {
  1099. try await self.forEachTransportPair(
  1100. clientEnabledCompression: .all,
  1101. serverCompression: .gzip
  1102. ) { control, _, pair in
  1103. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  1104. try await writer.write(.noOp)
  1105. }
  1106. var options = CallOptions.defaults
  1107. options.compression = .deflate
  1108. try await control.bidiStream(request: request, options: options) { response in
  1109. switch response.accepted {
  1110. case .success:
  1111. XCTFail("RPC should've been rejected")
  1112. case .failure(let error):
  1113. let acceptEncoding = Array(error.metadata["grpc-accept-encoding"])
  1114. // "identity" may or may not be included, so only test for values which must be present.
  1115. XCTAssertTrue(acceptEncoding.contains("gzip"))
  1116. XCTAssertFalse(acceptEncoding.contains("deflate"))
  1117. }
  1118. }
  1119. }
  1120. }
  1121. func testUnaryTimeoutPropagatedToServer() async throws {
  1122. try await self.forEachTransportPair { control, _, pair in
  1123. let message = ControlInput.with {
  1124. $0.echoMetadataInHeaders = true
  1125. $0.numberOfMessages = 1
  1126. }
  1127. let request = ClientRequest(message: message)
  1128. var options = CallOptions.defaults
  1129. options.timeout = .seconds(10)
  1130. try await control.unary(request: request, options: options) { response in
  1131. let timeout = Array(response.metadata["echo-grpc-timeout"])
  1132. XCTAssertEqual(timeout.count, 1)
  1133. }
  1134. }
  1135. }
  1136. func testClientStreamingTimeoutPropagatedToServer() async throws {
  1137. try await self.forEachTransportPair { control, _, pair in
  1138. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  1139. let message = ControlInput.with {
  1140. $0.echoMetadataInHeaders = true
  1141. $0.numberOfMessages = 1
  1142. }
  1143. try await writer.write(message)
  1144. }
  1145. var options = CallOptions.defaults
  1146. options.timeout = .seconds(10)
  1147. try await control.clientStream(request: request, options: options) { response in
  1148. let timeout = Array(response.metadata["echo-grpc-timeout"])
  1149. XCTAssertEqual(timeout.count, 1)
  1150. }
  1151. }
  1152. }
  1153. func testServerStreamingTimeoutPropagatedToServer() async throws {
  1154. try await self.forEachTransportPair { control, _, pair in
  1155. let message = ControlInput.with {
  1156. $0.echoMetadataInHeaders = true
  1157. $0.numberOfMessages = 1
  1158. }
  1159. let request = ClientRequest(message: message)
  1160. var options = CallOptions.defaults
  1161. options.timeout = .seconds(10)
  1162. try await control.serverStream(request: request, options: options) { response in
  1163. let timeout = Array(response.metadata["echo-grpc-timeout"])
  1164. XCTAssertEqual(timeout.count, 1)
  1165. }
  1166. }
  1167. }
  1168. func testBidiStreamingTimeoutPropagatedToServer() async throws {
  1169. try await self.forEachTransportPair { control, _, pair in
  1170. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  1171. try await writer.write(.echoMetadata)
  1172. }
  1173. var options = CallOptions.defaults
  1174. options.timeout = .seconds(10)
  1175. try await control.bidiStream(request: request, options: options) { response in
  1176. let timeout = Array(response.metadata["echo-grpc-timeout"])
  1177. XCTAssertEqual(timeout.count, 1)
  1178. }
  1179. }
  1180. }
  1181. private static let httpToStatusCodePairs: [(Int, RPCError.Code)] = [
  1182. // See https://github.com/grpc/grpc/blob/7f664c69b2a636386fbf95c16bc78c559734ce0f/doc/http-grpc-status-mapping.md
  1183. (400, .internalError),
  1184. (401, .unauthenticated),
  1185. (403, .permissionDenied),
  1186. (404, .unimplemented),
  1187. (418, .unknown),
  1188. (429, .unavailable),
  1189. (502, .unavailable),
  1190. (503, .unavailable),
  1191. (504, .unavailable),
  1192. (504, .unavailable),
  1193. ]
  1194. func testUnaryAgainstNonGRPCServer() async throws {
  1195. try await self.forEachClientAndHTTPStatusCodeServer { control, kind in
  1196. for (httpCode, expectedStatus) in Self.httpToStatusCodePairs {
  1197. // Tell the server what to respond with.
  1198. let metadata: Metadata = ["response-status": "\(httpCode)"]
  1199. try await control.unary(
  1200. request: ClientRequest(message: .noOp, metadata: metadata)
  1201. ) { response in
  1202. switch response.accepted {
  1203. case .success:
  1204. XCTFail("RPC should have failed with '\(expectedStatus)'")
  1205. case .failure(let error):
  1206. XCTAssertEqual(error.code, expectedStatus)
  1207. }
  1208. }
  1209. }
  1210. }
  1211. }
  1212. func testClientStreamingAgainstNonGRPCServer() async throws {
  1213. try await self.forEachClientAndHTTPStatusCodeServer { control, kind in
  1214. for (httpCode, expectedStatus) in Self.httpToStatusCodePairs {
  1215. // Tell the server what to respond with.
  1216. let request = StreamingClientRequest(
  1217. of: ControlInput.self,
  1218. metadata: ["response-status": "\(httpCode)"]
  1219. ) { _ in
  1220. }
  1221. try await control.clientStream(request: request) { response in
  1222. switch response.accepted {
  1223. case .success:
  1224. XCTFail("RPC should have failed with '\(expectedStatus)'")
  1225. case .failure(let error):
  1226. XCTAssertEqual(error.code, expectedStatus)
  1227. }
  1228. }
  1229. }
  1230. }
  1231. }
  1232. func testServerStreamingAgainstNonGRPCServer() async throws {
  1233. try await self.forEachClientAndHTTPStatusCodeServer { control, kind in
  1234. for (httpCode, expectedStatus) in Self.httpToStatusCodePairs {
  1235. // Tell the server what to respond with.
  1236. let metadata: Metadata = ["response-status": "\(httpCode)"]
  1237. try await control.serverStream(
  1238. request: ClientRequest(message: .noOp, metadata: metadata)
  1239. ) { response in
  1240. switch response.accepted {
  1241. case .success:
  1242. XCTFail("RPC should have failed with '\(expectedStatus)'")
  1243. case .failure(let error):
  1244. XCTAssertEqual(error.code, expectedStatus)
  1245. }
  1246. }
  1247. }
  1248. }
  1249. }
  1250. func testBidiStreamingAgainstNonGRPCServer() async throws {
  1251. try await self.forEachClientAndHTTPStatusCodeServer { control, kind in
  1252. for (httpCode, expectedStatus) in Self.httpToStatusCodePairs {
  1253. // Tell the server what to respond with.
  1254. let request = StreamingClientRequest(
  1255. of: ControlInput.self,
  1256. metadata: ["response-status": "\(httpCode)"]
  1257. ) { _ in
  1258. }
  1259. try await control.bidiStream(request: request) { response in
  1260. switch response.accepted {
  1261. case .success:
  1262. XCTFail("RPC should have failed with '\(expectedStatus)'")
  1263. case .failure(let error):
  1264. XCTAssertEqual(error.code, expectedStatus)
  1265. }
  1266. }
  1267. }
  1268. }
  1269. }
  1270. func testUnaryScheme() async throws {
  1271. try await self.forEachTransportPair { control, _, pair in
  1272. let input = ControlInput.with {
  1273. $0.echoMetadataInHeaders = true
  1274. $0.numberOfMessages = 1
  1275. }
  1276. let request = ClientRequest(message: input)
  1277. try await control.unary(request: request) { response in
  1278. XCTAssertEqual(Array(response.metadata["echo-scheme"]), ["http"])
  1279. }
  1280. }
  1281. }
  1282. func testServerStreamingScheme() async throws {
  1283. try await self.forEachTransportPair { control, _, pair in
  1284. let input = ControlInput.with {
  1285. $0.echoMetadataInHeaders = true
  1286. $0.numberOfMessages = 1
  1287. }
  1288. let request = ClientRequest(message: input)
  1289. try await control.serverStream(request: request) { response in
  1290. XCTAssertEqual(Array(response.metadata["echo-scheme"]), ["http"])
  1291. }
  1292. }
  1293. }
  1294. func testClientStreamingScheme() async throws {
  1295. try await self.forEachTransportPair { control, _, pair in
  1296. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  1297. let input = ControlInput.with {
  1298. $0.echoMetadataInHeaders = true
  1299. $0.numberOfMessages = 1
  1300. }
  1301. try await writer.write(input)
  1302. }
  1303. try await control.clientStream(request: request) { response in
  1304. XCTAssertEqual(Array(response.metadata["echo-scheme"]), ["http"])
  1305. }
  1306. }
  1307. }
  1308. func testBidiStreamingScheme() async throws {
  1309. try await self.forEachTransportPair { control, _, pair in
  1310. let request = StreamingClientRequest(of: ControlInput.self) { writer in
  1311. let input = ControlInput.with {
  1312. $0.echoMetadataInHeaders = true
  1313. $0.numberOfMessages = 1
  1314. }
  1315. try await writer.write(input)
  1316. }
  1317. try await control.bidiStream(request: request) { response in
  1318. XCTAssertEqual(Array(response.metadata["echo-scheme"]), ["http"])
  1319. }
  1320. }
  1321. }
  1322. func testServerCancellation() async throws {
  1323. for kind in [CancellationKind.awaitCancelled, .withCancellationHandler] {
  1324. try await self.forEachTransportPair { control, server, pair in
  1325. let request = ClientRequest(message: kind)
  1326. try await control.waitForCancellation(request: request) { response in
  1327. // Shutdown the client so that it doesn't attempt to reconnect when the server closes.
  1328. control.client.beginGracefulShutdown()
  1329. // Shutdown the server to cancel the RPC.
  1330. server.beginGracefulShutdown()
  1331. // The RPC should complete without any error or response.
  1332. let responses = try await response.messages.reduce(into: []) { $0.append($1) }
  1333. XCTAssert(responses.isEmpty)
  1334. }
  1335. }
  1336. }
  1337. }
  1338. func testUppercaseClientMetadataKey() async throws {
  1339. try await self.forEachTransportPair { control, _, _ in
  1340. let request = ClientRequest<ControlInput>(
  1341. message: .with {
  1342. $0.echoMetadataInHeaders = true
  1343. $0.numberOfMessages = 1
  1344. },
  1345. metadata: ["UPPERCASE-KEY": "value"]
  1346. )
  1347. try await control.unary(request: request) { response in
  1348. // Keys will be lowercase before being sent over the wire.
  1349. XCTAssertEqual(Array(response.metadata["echo-uppercase-key"]), ["value"])
  1350. }
  1351. }
  1352. }
  1353. func testUppercaseServerMetadataKey() async throws {
  1354. try await self.forEachTransportPair { control, _, _ in
  1355. let request = ClientRequest<ControlInput>(
  1356. message: .with {
  1357. $0.initialMetadataToAdd["UPPERCASE-KEY"] = "initial"
  1358. $0.trailingMetadataToAdd["UPPERCASE-KEY"] = "trailing"
  1359. $0.numberOfMessages = 1
  1360. }
  1361. )
  1362. try await control.unary(request: request) { response in
  1363. XCTAssertEqual(Array(response.metadata["uppercase-key"]), ["initial"])
  1364. XCTAssertEqual(Array(response.trailingMetadata["uppercase-key"]), ["trailing"])
  1365. }
  1366. }
  1367. }
  1368. private func checkAuthority(
  1369. client: GRPCClient<NIOClientTransport>,
  1370. expected: String
  1371. ) async throws {
  1372. let control = ControlClient(wrapping: client)
  1373. let input = ControlInput.with {
  1374. $0.echoMetadataInHeaders = true
  1375. $0.echoMetadataInTrailers = true
  1376. $0.numberOfMessages = 1
  1377. $0.payloadParameters = .with {
  1378. $0.content = 0
  1379. $0.size = 1024
  1380. }
  1381. }
  1382. try await control.unary(request: ClientRequest(message: input)) { response in
  1383. let initial = response.metadata
  1384. XCTAssertEqual(Array(initial["echo-authority"]), [.string(expected)])
  1385. }
  1386. }
  1387. private func testAuthority(
  1388. serverAddress: SocketAddress,
  1389. authorityOverride override: String? = nil,
  1390. clientTarget: (SocketAddress) -> any ResolvableTarget,
  1391. expectedAuthority: (SocketAddress) -> String
  1392. ) async throws {
  1393. try await withGRPCServer(
  1394. transport: .http2NIOPosix(
  1395. address: serverAddress,
  1396. transportSecurity: .plaintext
  1397. ),
  1398. services: [ControlService()]
  1399. ) { server in
  1400. guard let listeningAddress = try await server.listeningAddress else {
  1401. XCTFail("No listening address")
  1402. return
  1403. }
  1404. let target = clientTarget(listeningAddress)
  1405. try await withGRPCClient(
  1406. transport: NIOClientTransport(
  1407. .http2NIOPosix(
  1408. target: target,
  1409. transportSecurity: .plaintext,
  1410. config: .defaults {
  1411. $0.http2.authority = override
  1412. }
  1413. )
  1414. )
  1415. ) { client in
  1416. try await self.checkAuthority(client: client, expected: expectedAuthority(listeningAddress))
  1417. }
  1418. }
  1419. }
  1420. func testAuthorityDNS() async throws {
  1421. try await self.testAuthority(serverAddress: .ipv4(host: "127.0.0.1", port: 0)) { address in
  1422. return .dns(host: "localhost", port: address.ipv4!.port)
  1423. } expectedAuthority: { address in
  1424. return "localhost:\(address.ipv4!.port)"
  1425. }
  1426. }
  1427. func testOverrideAuthorityDNS() async throws {
  1428. try await self.testAuthority(
  1429. serverAddress: .ipv4(host: "127.0.0.1", port: 0),
  1430. authorityOverride: "respect-my-authority"
  1431. ) { address in
  1432. return .dns(host: "localhost", port: address.ipv4!.port)
  1433. } expectedAuthority: { _ in
  1434. return "respect-my-authority"
  1435. }
  1436. }
  1437. func testAuthorityIPv4() async throws {
  1438. try await self.testAuthority(serverAddress: .ipv4(host: "127.0.0.1", port: 0)) { address in
  1439. return .ipv4(host: "127.0.0.1", port: address.ipv4!.port)
  1440. } expectedAuthority: { address in
  1441. return "127.0.0.1:\(address.ipv4!.port)"
  1442. }
  1443. }
  1444. func testOverrideAuthorityIPv4() async throws {
  1445. try await self.testAuthority(
  1446. serverAddress: .ipv4(host: "127.0.0.1", port: 0),
  1447. authorityOverride: "respect-my-authority"
  1448. ) { address in
  1449. return .ipv4(host: "127.0.0.1", port: address.ipv4!.port)
  1450. } expectedAuthority: { _ in
  1451. return "respect-my-authority"
  1452. }
  1453. }
  1454. func testAuthorityIPv6() async throws {
  1455. try await self.testAuthority(serverAddress: .ipv6(host: "::1", port: 0)) { address in
  1456. return .ipv6(host: "::1", port: address.ipv6!.port)
  1457. } expectedAuthority: { address in
  1458. return "[::1]:\(address.ipv6!.port)"
  1459. }
  1460. }
  1461. func testOverrideAuthorityIPv6() async throws {
  1462. try await self.testAuthority(
  1463. serverAddress: .ipv6(host: "::1", port: 0),
  1464. authorityOverride: "respect-my-authority"
  1465. ) { address in
  1466. return .ipv6(host: "::1", port: address.ipv6!.port)
  1467. } expectedAuthority: { _ in
  1468. return "respect-my-authority"
  1469. }
  1470. }
  1471. func testAuthorityUDS() async throws {
  1472. let path = "test-authority-uds"
  1473. try await self.testAuthority(serverAddress: .unixDomainSocket(path: path)) { address in
  1474. return .unixDomainSocket(path: path)
  1475. } expectedAuthority: { _ in
  1476. return path
  1477. }
  1478. }
  1479. func testAuthorityLocalUDSOverride() async throws {
  1480. let path = "test-authority-local-uds-override"
  1481. try await self.testAuthority(serverAddress: .unixDomainSocket(path: path)) { address in
  1482. return .unixDomainSocket(path: path, authority: "respect-my-authority")
  1483. } expectedAuthority: { _ in
  1484. return "respect-my-authority"
  1485. }
  1486. }
  1487. func testOverrideAuthorityUDS() async throws {
  1488. let path = "test-override-authority-uds"
  1489. try await self.testAuthority(
  1490. serverAddress: .unixDomainSocket(path: path),
  1491. authorityOverride: "respect-my-authority"
  1492. ) { _ in
  1493. return .unixDomainSocket(path: path, authority: "should-be-ignored")
  1494. } expectedAuthority: { _ in
  1495. return "respect-my-authority"
  1496. }
  1497. }
  1498. func testPeerInfoIPv4() async throws {
  1499. try await self.forEachTransportPair(
  1500. serverAddress: .ipv4(host: "127.0.0.1", port: 0)
  1501. ) { control, _, _ in
  1502. let peerInfo = try await control.peerInfo()
  1503. let serverRemotePeerMatches = peerInfo.server.remote.wholeMatch(of: /ipv4:127\.0\.0\.1:(\d+)/)
  1504. let clientPort = try XCTUnwrap(serverRemotePeerMatches).1
  1505. let serverLocalPeerMatches = peerInfo.server.local.wholeMatch(of: /ipv4:127.0.0.1:(\d+)/)
  1506. let serverPort = try XCTUnwrap(serverLocalPeerMatches).1
  1507. let clientRemotePeerMatches = peerInfo.client.remote.wholeMatch(of: /ipv4:127.0.0.1:(\d+)/)
  1508. XCTAssertEqual(try XCTUnwrap(clientRemotePeerMatches).1, serverPort)
  1509. let clientLocalPeerMatches = peerInfo.client.local.wholeMatch(of: /ipv4:127\.0\.0\.1:(\d+)/)
  1510. XCTAssertEqual(try XCTUnwrap(clientLocalPeerMatches).1, clientPort)
  1511. }
  1512. }
  1513. func testPeerInfoIPv6() async throws {
  1514. try await self.forEachTransportPair(
  1515. serverAddress: .ipv6(host: "::1", port: 0)
  1516. ) { control, _, _ in
  1517. let peerInfo = try await control.peerInfo()
  1518. let serverRemotePeerMatches = peerInfo.server.remote.wholeMatch(of: /ipv6:\[::1\]:(\d+)/)
  1519. let clientPort = try XCTUnwrap(serverRemotePeerMatches).1
  1520. let serverLocalPeerMatches = peerInfo.server.local.wholeMatch(of: /ipv6:\[::1\]:(\d+)/)
  1521. let serverPort = try XCTUnwrap(serverLocalPeerMatches).1
  1522. let clientRemotePeerMatches = peerInfo.client.remote.wholeMatch(of: /ipv6:\[::1\]:(\d+)/)
  1523. XCTAssertEqual(try XCTUnwrap(clientRemotePeerMatches).1, serverPort)
  1524. let clientLocalPeerMatches = peerInfo.client.local.wholeMatch(of: /ipv6:\[::1\]:(\d+)/)
  1525. XCTAssertEqual(try XCTUnwrap(clientLocalPeerMatches).1, clientPort)
  1526. }
  1527. }
  1528. func testPeerInfoUDS() async throws {
  1529. let path = "peer-info-uds"
  1530. try await self.forEachTransportPair(
  1531. serverAddress: .unixDomainSocket(path: path)
  1532. ) { control, _, _ in
  1533. let peerInfo = try await control.peerInfo()
  1534. XCTAssertNotNil(peerInfo.server.remote.wholeMatch(of: /unix:peer-info-uds/))
  1535. XCTAssertNotNil(peerInfo.server.local.wholeMatch(of: /unix:peer-info-uds/))
  1536. XCTAssertNotNil(peerInfo.client.remote.wholeMatch(of: /unix:peer-info-uds/))
  1537. XCTAssertNotNil(peerInfo.client.local.wholeMatch(of: /unix:peer-info-uds/))
  1538. }
  1539. }
  1540. enum TestError: Error {
  1541. case someError
  1542. }
  1543. func testThrowingInClientStreamWriter() async throws {
  1544. try await forEachTransportPair { client, server, transport in
  1545. do {
  1546. _ = try await client.clientStream(
  1547. request: .init(producer: { writer in
  1548. throw TestError.someError
  1549. })
  1550. )
  1551. XCTFail("Test should have failed")
  1552. } catch let error as RPCError {
  1553. XCTAssertEqual(error.code, .unavailable)
  1554. XCTAssertEqual(error.message, "Stream unexpectedly closed with error.")
  1555. }
  1556. }
  1557. }
  1558. func testLargeResponse() async throws {
  1559. let sizeInMiB = 8
  1560. let sizeInBytes = sizeInMiB * 1024 * 1024
  1561. try await self.forEachTransportPair { control, _, pair in
  1562. let input = ControlInput.with {
  1563. $0.echoMetadataInHeaders = false
  1564. $0.echoMetadataInTrailers = false
  1565. $0.numberOfMessages = 1
  1566. $0.payloadParameters = .with {
  1567. $0.content = 0
  1568. $0.size = sizeInBytes
  1569. }
  1570. }
  1571. let metadata: Metadata = ["test-key": "test-value"]
  1572. let request = ClientRequest(message: input, metadata: metadata)
  1573. try await control.unary(request: request) { response in
  1574. let message = try response.message
  1575. XCTAssertEqual(message.payload, Data(repeating: 0, count: sizeInBytes), "\(pair)")
  1576. }
  1577. }
  1578. }
  1579. }
  1580. @available(gRPCSwiftNIOTransport 1.0, *)
  1581. extension [HTTP2TransportTests.Transport] {
  1582. static let supported: [HTTP2TransportTests.Transport] = TransportKind.servers.flatMap { server in
  1583. TransportKind.clients.map { client in
  1584. HTTP2TransportTests.Transport(server: server, client: client)
  1585. }
  1586. }
  1587. }
  1588. @available(gRPCSwiftNIOTransport 1.0, *)
  1589. extension ControlInput {
  1590. fileprivate static let echoMetadata = Self.with {
  1591. $0.echoMetadataInHeaders = true
  1592. }
  1593. fileprivate static let noOp = Self()
  1594. fileprivate static func messages(
  1595. _ numberOfMessages: Int,
  1596. repeating: UInt8,
  1597. count: Int
  1598. ) -> Self {
  1599. return Self.with {
  1600. $0.numberOfMessages = numberOfMessages
  1601. $0.payloadParameters = .with {
  1602. $0.content = repeating
  1603. $0.size = count
  1604. }
  1605. }
  1606. }
  1607. fileprivate static func status(
  1608. code: GRPCCore.Status.Code,
  1609. message: String,
  1610. echoMetadata: Bool
  1611. ) -> Self {
  1612. return Self.with {
  1613. $0.echoMetadataInTrailers = echoMetadata
  1614. $0.status = .with {
  1615. $0.code = code
  1616. $0.message = message
  1617. }
  1618. }
  1619. }
  1620. fileprivate static func trailersOnly(
  1621. code: GRPCCore.Status.Code,
  1622. message: String,
  1623. echoMetadata: Bool
  1624. ) -> Self {
  1625. return Self.with {
  1626. $0.echoMetadataInTrailers = echoMetadata
  1627. $0.isTrailersOnly = true
  1628. $0.status = .with {
  1629. $0.code = code
  1630. $0.message = message
  1631. }
  1632. }
  1633. }
  1634. }
  1635. @available(gRPCSwiftNIOTransport 1.0, *)
  1636. extension CompressionAlgorithm {
  1637. var name: String {
  1638. switch self {
  1639. case .deflate:
  1640. return "deflate"
  1641. case .gzip:
  1642. return "gzip"
  1643. case .none:
  1644. return "identity"
  1645. default:
  1646. return ""
  1647. }
  1648. }
  1649. }