Fix Route Guide tutorial compilation errors and implementation issues (#32)

mtfum · web-flow · commit e7e951575a4c · 2025-11-17T08:23:06.000Z
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec04-step04-unary.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec04-step04-unary.swift
@@ -22,8 +22,8 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {
     context: ServerContext
   ) async throws -> Routeguide_Feature {
     let feature = self.findFeature(
-      latitude: request.message.latitude,
-      longitude: request.message.longitude
+      latitude: request.latitude,
+      longitude: request.longitude
     )
   }
 
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec04-step05-unary.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec04-step05-unary.swift
@@ -22,8 +22,8 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {
     context: ServerContext
   ) async throws -> Routeguide_Feature {
     let feature = self.findFeature(
-      latitude: request.message.latitude,
-      longitude: request.message.longitude
+      latitude: request.latitude,
+      longitude: request.longitude
     )
 
     if let feature {
@@ -33,8 +33,8 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {
       let unknownFeature = Routeguide_Feature.with {
         $0.name = ""
         $0.location = .with {
-          $0.latitude = request.message.latitude
-          $0.longitude = request.message.longitude
+          $0.latitude = request.latitude
+          $0.longitude = request.longitude
         }
       }
       return unknownFeature
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec04-step06-server-streaming.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec04-step06-server-streaming.swift
@@ -22,8 +22,8 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {
     context: ServerContext
   ) async throws -> Routeguide_Feature {
     let feature = self.findFeature(
-      latitude: request.message.latitude,
-      longitude: request.message.longitude
+      latitude: request.latitude,
+      longitude: request.longitude
     )
 
     if let feature {
@@ -33,8 +33,8 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {
       let unknownFeature = Routeguide_Feature.with {
         $0.name = ""
         $0.location = .with {
-          $0.latitude = request.message.latitude
-          $0.longitude = request.message.longitude
+          $0.latitude = request.latitude
+          $0.longitude = request.longitude
         }
       }
       return unknownFeature
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec04-step07-client-streaming.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec04-step07-client-streaming.swift
@@ -23,8 +23,8 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {
     context: ServerContext
   ) async throws -> Routeguide_Feature {
     let feature = self.findFeature(
-      latitude: request.message.latitude,
-      longitude: request.message.longitude
+      latitude: request.latitude,
+      longitude: request.longitude
     )
 
     if let feature {
@@ -34,8 +34,8 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {
       let unknownFeature = Routeguide_Feature.with {
         $0.name = ""
         $0.location = .with {
-          $0.latitude = request.message.latitude
-          $0.longitude = request.message.longitude
+          $0.latitude = request.latitude
+          $0.longitude = request.longitude
         }
       }
       return unknownFeature
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec04-step08-bidi-streaming.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec04-step08-bidi-streaming.swift
@@ -24,8 +24,8 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {
     context: ServerContext
   ) async throws -> Routeguide_Feature {
     let feature = self.findFeature(
-      latitude: request.message.latitude,
-      longitude: request.message.longitude
+      latitude: request.latitude,
+      longitude: request.longitude
     )
 
     if let feature {
@@ -35,8 +35,8 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {
       let unknownFeature = Routeguide_Feature.with {
         $0.name = ""
         $0.location = .with {
-          $0.latitude = request.message.latitude
-          $0.longitude = request.message.longitude
+          $0.latitude = request.latitude
+          $0.longitude = request.longitude
         }
       }
       return unknownFeature
@@ -95,10 +95,6 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {
     response: RPCWriter<Routeguide_RouteNote>,
     context: ServerContext
   ) async throws {
-    for try await note in request {
-      let notes = self.receivedNotes.recordNote(note)
-      try await response.write(contentsOf: notes)
-    }
   }
 }
 
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec04-step09-bidi-streaming.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec04-step09-bidi-streaming.swift
@@ -6,10 +6,40 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {
   /// Known features.
   private let features: [Routeguide_Feature]
 
+  /// Notes recorded by clients.
+  private let receivedNotes: Notes
+
+  /// A thread-safe store for notes sent by clients.
+  private final class Notes: Sendable {
+    private let notes: Mutex<[Routeguide_RouteNote]>
+
+    init() {
+      self.notes = Mutex([])
+    }
+
+    /// Records a note and returns all other notes recorded at the same location.
+    ///
+    /// - Parameter receivedNote: A note to record.
+    /// - Returns: Other notes recorded at the same location.
+    func recordNote(_ receivedNote: Routeguide_RouteNote) -> [Routeguide_RouteNote] {
+      return self.notes.withLock { notes in
+        var notesFromSameLocation: [Routeguide_RouteNote] = []
+        for note in notes {
+          if note.location == receivedNote.location {
+            notesFromSameLocation.append(note)
+          }
+        }
+        notes.append(receivedNote)
+        return notesFromSameLocation
+      }
+    }
+  }
+
   /// Creates a new route guide service.
   /// - Parameter features: Known features.
   init(features: [Routeguide_Feature]) {
     self.features = features
+    self.receivedNotes = Notes()
   }
 
   /// Returns the first feature found at the given location, if one exists.
@@ -24,8 +54,8 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {
     context: ServerContext
   ) async throws -> Routeguide_Feature {
     let feature = self.findFeature(
-      latitude: request.message.latitude,
-      longitude: request.message.longitude
+      latitude: request.latitude,
+      longitude: request.longitude
     )
 
     if let feature {
@@ -35,8 +65,8 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {
       let unknownFeature = Routeguide_Feature.with {
         $0.name = ""
         $0.location = .with {
-          $0.latitude = request.message.latitude
-          $0.longitude = request.message.longitude
+          $0.latitude = request.latitude
+          $0.longitude = request.longitude
         }
       }
       return unknownFeature
@@ -95,6 +125,10 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {
     response: RPCWriter<Routeguide_RouteNote>,
     context: ServerContext
   ) async throws {
+    for try await note in request {
+      let notes = self.receivedNotes.recordNote(note)
+      try await response.write(contentsOf: notes)
+    }
   }
 }
 
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec05-step04-load-features.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec05-step04-load-features.swift
@@ -12,7 +12,7 @@ struct RouteGuide: AsyncParsableCommand {
     }
   }
 
-  private static func loadFeatures() throws -> [Routeguide_Feature] {
+  func loadFeatures() throws -> [Routeguide_Feature] {
     guard let url = Bundle.module.url(forResource: "route_guide_db", withExtension: "json") else {
       throw ExitCode.failure
     }
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec06-step06-get-feature.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec06-step06-get-feature.swift
@@ -14,7 +14,9 @@ extension RouteGuide {
     }
   }
 
-  private func getFeature(using routeGuide: Routeguide_RouteGuide.Client) async throws {
+  private func getFeature(
+    using routeGuide: Routeguide_RouteGuide.Client<some ClientTransport>
+  ) async throws {
     print("→ Calling 'GetFeature'")
 
     let point = Routeguide_Point.with {
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec06-step07-list-features.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec06-step07-list-features.swift
@@ -15,7 +15,9 @@ extension RouteGuide {
     }
   }
 
-  private func getFeature(using routeGuide: Routeguide_RouteGuide.Client) async throws {
+  private func getFeature(
+    using routeGuide: Routeguide_RouteGuide.Client<some ClientTransport>
+  ) async throws {
     print("→ Calling 'GetFeature'")
 
     let point = Routeguide_Point.with {
@@ -27,7 +29,9 @@ extension RouteGuide {
     print("Got feature '\(feature.name)'")
   }
 
-  private func listFeatures(using routeGuide: Routeguide_RouteGuide.Client) async throws {
+  private func listFeatures(
+    using routeGuide: Routeguide_RouteGuide.Client<some ClientTransport>
+  ) async throws {
     print("→ Calling 'ListFeatures'")
 
     let boundingRectangle = Routeguide_Rectangle.with {
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec06-step08-record-route.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec06-step08-record-route.swift
@@ -16,7 +16,9 @@ extension RouteGuide {
     }
   }
 
-  private func getFeature(using routeGuide: Routeguide_RouteGuide.Client) async throws {
+  private func getFeature(
+    using routeGuide: Routeguide_RouteGuide.Client<some ClientTransport>
+  ) async throws {
     print("→ Calling 'GetFeature'")
 
     let point = Routeguide_Point.with {
@@ -28,7 +30,9 @@ extension RouteGuide {
     print("Got feature '\(feature.name)'")
   }
 
-  private func listFeatures(using routeGuide: Routeguide_RouteGuide.Client) async throws {
+  private func listFeatures(
+    using routeGuide: Routeguide_RouteGuide.Client<some ClientTransport>
+  ) async throws {
     print("→ Calling 'ListFeatures'")
 
     let boundingRectangle = Routeguide_Rectangle.with {
@@ -51,7 +55,9 @@ extension RouteGuide {
     }
   }
 
-  private func recordRoute(using routeGuide: Routeguide_RouteGuide.Client) async throws {
+  private func recordRoute(
+    using routeGuide: Routeguide_RouteGuide.Client<some ClientTransport>
+  ) async throws {
     print("→ Calling 'RecordRoute'")
 
     let features = try self.loadFeatures()
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec06-step09-route-chat.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec06-step09-route-chat.swift
@@ -17,7 +17,9 @@ extension RouteGuide {
     }
   }
 
-  private func getFeature(using routeGuide: Routeguide_RouteGuide.Client) async throws {
+  private func getFeature(
+    using routeGuide: Routeguide_RouteGuide.Client<some ClientTransport>
+  ) async throws {
     print("→ Calling 'GetFeature'")
 
     let point = Routeguide_Point.with {
@@ -29,7 +31,9 @@ extension RouteGuide {
     print("Got feature '\(feature.name)'")
   }
 
-  private func listFeatures(using routeGuide: Routeguide_RouteGuide.Client) async throws {
+  private func listFeatures(
+    using routeGuide: Routeguide_RouteGuide.Client<some ClientTransport>
+  ) async throws {
     print("→ Calling 'ListFeatures'")
 
     let boundingRectangle = Routeguide_Rectangle.with {
@@ -52,7 +56,9 @@ extension RouteGuide {
     }
   }
 
-  private func recordRoute(using routeGuide: Routeguide_RouteGuide.Client) async throws {
+  private func recordRoute(
+    using routeGuide: Routeguide_RouteGuide.Client<some ClientTransport>
+  ) async throws {
     print("→ Calling 'RecordRoute'")
 
     let features = try self.loadFeatures()
@@ -74,7 +80,9 @@ extension RouteGuide {
     )
   }
 
-  private func routeChat(using routeGuide: Routeguide_RouteGuide.Client) async throws {
+  private func routeChat(
+    using routeGuide: Routeguide_RouteGuide.Client<some ClientTransport>
+  ) async throws {
     print("→ Calling 'RouteChat'")
 
     try await routeGuide.routeChat { writer in
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Route-Guide.tutorial b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Route-Guide.tutorial
@@ -291,7 +291,7 @@
         After the *client* has finished sending points we populate a `Routeguide_RouteSummary` which
         we return in the response.
 
-        @Code(name: "Sources/RouteGuideService.swift", file: "route-guide-sec04-step08-client-streaming.swift")
+        @Code(name: "Sources/RouteGuideService.swift", file: "route-guide-sec04-step07-client-streaming.swift")
       }
 
       @Step {
@@ -300,15 +300,15 @@
         also need to modify the state of our service to store notes sent by the client. We'll do
         this with a helper class to store the notes.
 
-        @Code(name: "Sources/RouteGuideService.swift", file: "route-guide-sec04-step09-bidi-streaming.swift")
+        @Code(name: "Sources/RouteGuideService.swift", file: "route-guide-sec04-step08-bidi-streaming.swift")
       }
 
       @Step {
         To implement the RPC we iterate the request notes, call our helper class to record each
         note and get all other notes recorded in the same location. We then write each of those
         notes back to the client.
 
-        @Code(name: "Sources/RouteGuideService.swift", file: "route-guide-sec04-step10-bidi-streaming.swift")
+        @Code(name: "Sources/RouteGuideService.swift", file: "route-guide-sec04-step09-bidi-streaming.swift")
       }
     }
   }

Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,8 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {`
`22`	`22`	`context: ServerContext`
`23`	`23`	`) async throws -> Routeguide_Feature {`
`24`	`24`	`let feature = self.findFeature(`
`25`		`- latitude: request.message.latitude,`
`26`		`- longitude: request.message.longitude`
	`25`	`+ latitude: request.latitude,`
	`26`	`+ longitude: request.longitude`
`27`	`27`	`)`
`28`	`28`	`}`
`29`	`29`
Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,8 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {`
`24`	`24`	`context: ServerContext`
`25`	`25`	`) async throws -> Routeguide_Feature {`
`26`	`26`	`let feature = self.findFeature(`
`27`		`- latitude: request.message.latitude,`
`28`		`- longitude: request.message.longitude`
	`27`	`+ latitude: request.latitude,`
	`28`	`+ longitude: request.longitude`
`29`	`29`	`)`
`30`	`30`
`31`	`31`	`if let feature {`
`@@ -35,8 +35,8 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {`
`35`	`35`	`let unknownFeature = Routeguide_Feature.with {`
`36`	`36`	`$0.name = ""`
`37`	`37`	`$0.location = .with {`
`38`		`- $0.latitude = request.message.latitude`
`39`		`- $0.longitude = request.message.longitude`
	`38`	`+ $0.latitude = request.latitude`
	`39`	`+ $0.longitude = request.longitude`
`40`	`40`	`}`
`41`	`41`	`}`
`42`	`42`	`return unknownFeature`
`@@ -95,10 +95,6 @@ struct RouteGuideService: Routeguide_RouteGuide.SimpleServiceProtocol {`
`95`	`95`	`response: RPCWriter<Routeguide_RouteNote>,`
`96`	`96`	`context: ServerContext`
`97`	`97`	`) async throws {`
`98`		`- for try await note in request {`
`99`		`- let notes = self.receivedNotes.recordNote(note)`
`100`		`- try await response.write(contentsOf: notes)`
`101`		`- }`
`102`	`98`	`}`
`103`	`99`	`}`
`104`	`100`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ struct RouteGuide: AsyncParsableCommand {`
`12`	`12`	`}`
`13`	`13`	`}`
`14`	`14`
`15`		`- private static func loadFeatures() throws -> [Routeguide_Feature] {`
	`15`	`+ func loadFeatures() throws -> [Routeguide_Feature] {`
`16`	`16`	`guard let url = Bundle.module.url(forResource: "route_guide_db", withExtension: "json") else {`
`17`	`17`	`throw ExitCode.failure`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,9 @@ extension RouteGuide {`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`
`17`		`- private func getFeature(using routeGuide: Routeguide_RouteGuide.Client) async throws {`
	`17`	`+ private func getFeature(`
	`18`	`+ using routeGuide: Routeguide_RouteGuide.Client<some ClientTransport>`
	`19`	`+ ) async throws {`
`18`	`20`	`print("→ Calling 'GetFeature'")`
`19`	`21`
`20`	`22`	`let point = Routeguide_Point.with {`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,9 @@ extension RouteGuide {`
`15`	`15`	`}`
`16`	`16`	`}`
`17`	`17`
`18`		`- private func getFeature(using routeGuide: Routeguide_RouteGuide.Client) async throws {`
	`18`	`+ private func getFeature(`
	`19`	`+ using routeGuide: Routeguide_RouteGuide.Client<some ClientTransport>`
	`20`	`+ ) async throws {`
`19`	`21`	`print("→ Calling 'GetFeature'")`
`20`	`22`
`21`	`23`	`let point = Routeguide_Point.with {`
`@@ -27,7 +29,9 @@ extension RouteGuide {`
`27`	`29`	`print("Got feature '\(feature.name)'")`
`28`	`30`	`}`
`29`	`31`
`30`		`- private func listFeatures(using routeGuide: Routeguide_RouteGuide.Client) async throws {`
	`32`	`+ private func listFeatures(`
	`33`	`+ using routeGuide: Routeguide_RouteGuide.Client<some ClientTransport>`
	`34`	`+ ) async throws {`
`31`	`35`	`print("→ Calling 'ListFeatures'")`
`32`	`36`
`33`	`37`	`let boundingRectangle = Routeguide_Rectangle.with {`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,9 @@ extension RouteGuide {`
`16`	`16`	`}`
`17`	`17`	`}`
`18`	`18`
`19`		`- private func getFeature(using routeGuide: Routeguide_RouteGuide.Client) async throws {`
	`19`	`+ private func getFeature(`
	`20`	`+ using routeGuide: Routeguide_RouteGuide.Client<some ClientTransport>`
	`21`	`+ ) async throws {`
`20`	`22`	`print("→ Calling 'GetFeature'")`
`21`	`23`
`22`	`24`	`let point = Routeguide_Point.with {`
`@@ -28,7 +30,9 @@ extension RouteGuide {`
`28`	`30`	`print("Got feature '\(feature.name)'")`
`29`	`31`	`}`
`30`	`32`
`31`		`- private func listFeatures(using routeGuide: Routeguide_RouteGuide.Client) async throws {`
	`33`	`+ private func listFeatures(`
	`34`	`+ using routeGuide: Routeguide_RouteGuide.Client<some ClientTransport>`
	`35`	`+ ) async throws {`
`32`	`36`	`print("→ Calling 'ListFeatures'")`
`33`	`37`
`34`	`38`	`let boundingRectangle = Routeguide_Rectangle.with {`
`@@ -51,7 +55,9 @@ extension RouteGuide {`
`51`	`55`	`}`
`52`	`56`	`}`
`53`	`57`
`54`		`- private func recordRoute(using routeGuide: Routeguide_RouteGuide.Client) async throws {`
	`58`	`+ private func recordRoute(`
	`59`	`+ using routeGuide: Routeguide_RouteGuide.Client<some ClientTransport>`
	`60`	`+ ) async throws {`
`55`	`61`	`print("→ Calling 'RecordRoute'")`
`56`	`62`
`57`	`63`	`let features = try self.loadFeatures()`