HTTP2TransportTests.swift 62 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878
  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 2.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(address: ipv4.host, port: ipv4.port)
  58. } else if let ipv6 = address.ipv6 {
  59. target = .ipv6(address: 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(address: 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 testCancellationIsPropagated() async throws {
  1339. for kind in [CancellationKind.awaitCancelled, .withCancellationHandler] {
  1340. try await self.forEachTransportPair { control, server, pair in
  1341. let request = ClientRequest(message: kind)
  1342. let signal = AsyncStream.makeStream(of: Void.self)
  1343. let task = Task {
  1344. try await control.waitForCancellation(request: request) { response in
  1345. // Signal that the task should be cancelled.
  1346. signal.continuation.finish()
  1347. // The RPC should complete without any error or response.
  1348. do {
  1349. _ = try await response.messages.reduce(into: []) { $0.append($1) }
  1350. XCTFail("Expected cancellation error")
  1351. } catch is CancellationError {
  1352. ()
  1353. }
  1354. }
  1355. }
  1356. // Wait for the signal to cancel.
  1357. for await _ in signal.stream {}
  1358. task.cancel()
  1359. try await task.value
  1360. }
  1361. }
  1362. }
  1363. func testUppercaseClientMetadataKey() async throws {
  1364. try await self.forEachTransportPair { control, _, _ in
  1365. let request = ClientRequest<ControlInput>(
  1366. message: .with {
  1367. $0.echoMetadataInHeaders = true
  1368. $0.numberOfMessages = 1
  1369. },
  1370. metadata: ["UPPERCASE-KEY": "value"]
  1371. )
  1372. try await control.unary(request: request) { response in
  1373. // Keys will be lowercase before being sent over the wire.
  1374. XCTAssertEqual(Array(response.metadata["echo-uppercase-key"]), ["value"])
  1375. }
  1376. }
  1377. }
  1378. func testUppercaseServerMetadataKey() async throws {
  1379. try await self.forEachTransportPair { control, _, _ in
  1380. let request = ClientRequest<ControlInput>(
  1381. message: .with {
  1382. $0.initialMetadataToAdd["UPPERCASE-KEY"] = "initial"
  1383. $0.trailingMetadataToAdd["UPPERCASE-KEY"] = "trailing"
  1384. $0.numberOfMessages = 1
  1385. }
  1386. )
  1387. try await control.unary(request: request) { response in
  1388. XCTAssertEqual(Array(response.metadata["uppercase-key"]), ["initial"])
  1389. XCTAssertEqual(Array(response.trailingMetadata["uppercase-key"]), ["trailing"])
  1390. }
  1391. }
  1392. }
  1393. private func checkAuthority(
  1394. client: GRPCClient<NIOClientTransport>,
  1395. expected: String
  1396. ) async throws {
  1397. let control = ControlClient(wrapping: client)
  1398. let input = ControlInput.with {
  1399. $0.echoMetadataInHeaders = true
  1400. $0.echoMetadataInTrailers = true
  1401. $0.numberOfMessages = 1
  1402. $0.payloadParameters = .with {
  1403. $0.content = 0
  1404. $0.size = 1024
  1405. }
  1406. }
  1407. try await control.unary(request: ClientRequest(message: input)) { response in
  1408. let initial = response.metadata
  1409. XCTAssertEqual(Array(initial["echo-authority"]), [.string(expected)])
  1410. }
  1411. }
  1412. private func testAuthority(
  1413. serverAddress: SocketAddress,
  1414. authorityOverride override: String? = nil,
  1415. clientTarget: (SocketAddress) -> any ResolvableTarget,
  1416. expectedAuthority: (SocketAddress) -> String
  1417. ) async throws {
  1418. try await withGRPCServer(
  1419. transport: .http2NIOPosix(
  1420. address: serverAddress,
  1421. transportSecurity: .plaintext
  1422. ),
  1423. services: [ControlService()]
  1424. ) { server in
  1425. guard let listeningAddress = try await server.listeningAddress else {
  1426. XCTFail("No listening address")
  1427. return
  1428. }
  1429. let target = clientTarget(listeningAddress)
  1430. try await withGRPCClient(
  1431. transport: NIOClientTransport(
  1432. .http2NIOPosix(
  1433. target: target,
  1434. transportSecurity: .plaintext,
  1435. config: .defaults {
  1436. $0.http2.authority = override
  1437. }
  1438. )
  1439. )
  1440. ) { client in
  1441. try await self.checkAuthority(client: client, expected: expectedAuthority(listeningAddress))
  1442. }
  1443. }
  1444. }
  1445. func testAuthorityDNS() async throws {
  1446. try await self.testAuthority(serverAddress: .ipv4(host: "127.0.0.1", port: 0)) { address in
  1447. return .dns(host: "localhost", port: address.ipv4!.port)
  1448. } expectedAuthority: { address in
  1449. return "localhost:\(address.ipv4!.port)"
  1450. }
  1451. }
  1452. func testOverrideAuthorityDNS() async throws {
  1453. try await self.testAuthority(
  1454. serverAddress: .ipv4(host: "127.0.0.1", port: 0),
  1455. authorityOverride: "respect-my-authority"
  1456. ) { address in
  1457. return .dns(host: "localhost", port: address.ipv4!.port)
  1458. } expectedAuthority: { _ in
  1459. return "respect-my-authority"
  1460. }
  1461. }
  1462. func testAuthorityIPv4() async throws {
  1463. try await self.testAuthority(serverAddress: .ipv4(host: "127.0.0.1", port: 0)) { address in
  1464. return .ipv4(address: "127.0.0.1", port: address.ipv4!.port)
  1465. } expectedAuthority: { address in
  1466. return "127.0.0.1:\(address.ipv4!.port)"
  1467. }
  1468. }
  1469. func testOverrideAuthorityIPv4() async throws {
  1470. try await self.testAuthority(
  1471. serverAddress: .ipv4(host: "127.0.0.1", port: 0),
  1472. authorityOverride: "respect-my-authority"
  1473. ) { address in
  1474. return .ipv4(address: "127.0.0.1", port: address.ipv4!.port)
  1475. } expectedAuthority: { _ in
  1476. return "respect-my-authority"
  1477. }
  1478. }
  1479. func testAuthorityIPv6() async throws {
  1480. try await self.testAuthority(serverAddress: .ipv6(host: "::1", port: 0)) { address in
  1481. return .ipv6(address: "::1", port: address.ipv6!.port)
  1482. } expectedAuthority: { address in
  1483. return "[::1]:\(address.ipv6!.port)"
  1484. }
  1485. }
  1486. func testOverrideAuthorityIPv6() async throws {
  1487. try await self.testAuthority(
  1488. serverAddress: .ipv6(host: "::1", port: 0),
  1489. authorityOverride: "respect-my-authority"
  1490. ) { address in
  1491. return .ipv6(address: "::1", port: address.ipv6!.port)
  1492. } expectedAuthority: { _ in
  1493. return "respect-my-authority"
  1494. }
  1495. }
  1496. func testAuthorityUDS() async throws {
  1497. let path = "test-authority-uds"
  1498. try await self.testAuthority(serverAddress: .unixDomainSocket(path: path)) { address in
  1499. return .unixDomainSocket(path: path)
  1500. } expectedAuthority: { _ in
  1501. return path
  1502. }
  1503. }
  1504. func testAuthorityLocalUDSOverride() async throws {
  1505. let path = "test-authority-local-uds-override"
  1506. try await self.testAuthority(serverAddress: .unixDomainSocket(path: path)) { address in
  1507. return .unixDomainSocket(path: path, authority: "respect-my-authority")
  1508. } expectedAuthority: { _ in
  1509. return "respect-my-authority"
  1510. }
  1511. }
  1512. func testOverrideAuthorityUDS() async throws {
  1513. let path = "test-override-authority-uds"
  1514. try await self.testAuthority(
  1515. serverAddress: .unixDomainSocket(path: path),
  1516. authorityOverride: "respect-my-authority"
  1517. ) { _ in
  1518. return .unixDomainSocket(path: path, authority: "should-be-ignored")
  1519. } expectedAuthority: { _ in
  1520. return "respect-my-authority"
  1521. }
  1522. }
  1523. func testPeerInfoIPv4() async throws {
  1524. try await self.forEachTransportPair(
  1525. serverAddress: .ipv4(host: "127.0.0.1", port: 0)
  1526. ) { control, _, _ in
  1527. let peerInfo = try await control.peerInfo()
  1528. let serverRemotePeerMatches = peerInfo.server.remote.wholeMatch(of: /ipv4:127\.0\.0\.1:(\d+)/)
  1529. let clientPort = try XCTUnwrap(serverRemotePeerMatches).1
  1530. let serverLocalPeerMatches = peerInfo.server.local.wholeMatch(of: /ipv4:127.0.0.1:(\d+)/)
  1531. let serverPort = try XCTUnwrap(serverLocalPeerMatches).1
  1532. let clientRemotePeerMatches = peerInfo.client.remote.wholeMatch(of: /ipv4:127.0.0.1:(\d+)/)
  1533. XCTAssertEqual(try XCTUnwrap(clientRemotePeerMatches).1, serverPort)
  1534. let clientLocalPeerMatches = peerInfo.client.local.wholeMatch(of: /ipv4:127\.0\.0\.1:(\d+)/)
  1535. XCTAssertEqual(try XCTUnwrap(clientLocalPeerMatches).1, clientPort)
  1536. }
  1537. }
  1538. func testPeerInfoIPv6() async throws {
  1539. try await self.forEachTransportPair(
  1540. serverAddress: .ipv6(host: "::1", port: 0)
  1541. ) { control, _, _ in
  1542. let peerInfo = try await control.peerInfo()
  1543. let serverRemotePeerMatches = peerInfo.server.remote.wholeMatch(of: /ipv6:\[::1\]:(\d+)/)
  1544. let clientPort = try XCTUnwrap(serverRemotePeerMatches).1
  1545. let serverLocalPeerMatches = peerInfo.server.local.wholeMatch(of: /ipv6:\[::1\]:(\d+)/)
  1546. let serverPort = try XCTUnwrap(serverLocalPeerMatches).1
  1547. let clientRemotePeerMatches = peerInfo.client.remote.wholeMatch(of: /ipv6:\[::1\]:(\d+)/)
  1548. XCTAssertEqual(try XCTUnwrap(clientRemotePeerMatches).1, serverPort)
  1549. let clientLocalPeerMatches = peerInfo.client.local.wholeMatch(of: /ipv6:\[::1\]:(\d+)/)
  1550. XCTAssertEqual(try XCTUnwrap(clientLocalPeerMatches).1, clientPort)
  1551. }
  1552. }
  1553. func testPeerInfoUDS() async throws {
  1554. let path = "peer-info-uds"
  1555. try await self.forEachTransportPair(
  1556. serverAddress: .unixDomainSocket(path: path)
  1557. ) { control, _, _ in
  1558. let peerInfo = try await control.peerInfo()
  1559. XCTAssertNotNil(peerInfo.server.remote.wholeMatch(of: /unix:peer-info-uds/))
  1560. XCTAssertNotNil(peerInfo.server.local.wholeMatch(of: /unix:peer-info-uds/))
  1561. XCTAssertNotNil(peerInfo.client.remote.wholeMatch(of: /unix:peer-info-uds/))
  1562. XCTAssertNotNil(peerInfo.client.local.wholeMatch(of: /unix:peer-info-uds/))
  1563. }
  1564. }
  1565. enum TestError: Error {
  1566. case someError
  1567. }
  1568. func testThrowingInClientStreamWriter() async throws {
  1569. try await forEachTransportPair { client, server, transport in
  1570. do {
  1571. _ = try await client.clientStream(
  1572. request: .init(producer: { writer in
  1573. throw TestError.someError
  1574. })
  1575. )
  1576. XCTFail("Test should have failed")
  1577. } catch let error as RPCError {
  1578. XCTAssertEqual(error.code, .unavailable)
  1579. XCTAssertEqual(error.message, "Stream unexpectedly closed with error.")
  1580. }
  1581. }
  1582. }
  1583. func testLargeResponse() async throws {
  1584. let sizeInMiB = 8
  1585. let sizeInBytes = sizeInMiB * 1024 * 1024
  1586. try await self.forEachTransportPair { control, _, pair in
  1587. let input = ControlInput.with {
  1588. $0.echoMetadataInHeaders = false
  1589. $0.echoMetadataInTrailers = false
  1590. $0.numberOfMessages = 1
  1591. $0.payloadParameters = .with {
  1592. $0.content = 0
  1593. $0.size = sizeInBytes
  1594. }
  1595. }
  1596. let metadata: Metadata = ["test-key": "test-value"]
  1597. let request = ClientRequest(message: input, metadata: metadata)
  1598. try await control.unary(request: request) { response in
  1599. let message = try response.message
  1600. XCTAssertEqual(message.payload, Data(repeating: 0, count: sizeInBytes), "\(pair)")
  1601. }
  1602. }
  1603. }
  1604. }
  1605. @available(gRPCSwiftNIOTransport 2.0, *)
  1606. extension [HTTP2TransportTests.Transport] {
  1607. static let supported: [HTTP2TransportTests.Transport] = TransportKind.servers.flatMap { server in
  1608. TransportKind.clients.map { client in
  1609. HTTP2TransportTests.Transport(server: server, client: client)
  1610. }
  1611. }
  1612. }
  1613. @available(gRPCSwiftNIOTransport 2.0, *)
  1614. extension ControlInput {
  1615. fileprivate static let echoMetadata = Self.with {
  1616. $0.echoMetadataInHeaders = true
  1617. }
  1618. fileprivate static let noOp = Self()
  1619. fileprivate static func messages(
  1620. _ numberOfMessages: Int,
  1621. repeating: UInt8,
  1622. count: Int
  1623. ) -> Self {
  1624. return Self.with {
  1625. $0.numberOfMessages = numberOfMessages
  1626. $0.payloadParameters = .with {
  1627. $0.content = repeating
  1628. $0.size = count
  1629. }
  1630. }
  1631. }
  1632. fileprivate static func status(
  1633. code: GRPCCore.Status.Code,
  1634. message: String,
  1635. echoMetadata: Bool
  1636. ) -> Self {
  1637. return Self.with {
  1638. $0.echoMetadataInTrailers = echoMetadata
  1639. $0.status = .with {
  1640. $0.code = code
  1641. $0.message = message
  1642. }
  1643. }
  1644. }
  1645. fileprivate static func trailersOnly(
  1646. code: GRPCCore.Status.Code,
  1647. message: String,
  1648. echoMetadata: Bool
  1649. ) -> Self {
  1650. return Self.with {
  1651. $0.echoMetadataInTrailers = echoMetadata
  1652. $0.isTrailersOnly = true
  1653. $0.status = .with {
  1654. $0.code = code
  1655. $0.message = message
  1656. }
  1657. }
  1658. }
  1659. }
  1660. @available(gRPCSwiftNIOTransport 2.0, *)
  1661. extension CompressionAlgorithm {
  1662. var name: String {
  1663. switch self {
  1664. case .deflate:
  1665. return "deflate"
  1666. case .gzip:
  1667. return "gzip"
  1668. case .none:
  1669. return "identity"
  1670. default:
  1671. return ""
  1672. }
  1673. }
  1674. }