Remove '@_exported import GRPCCore' (#2109)

glbrntt · web-flow · commit 55e39fa96be3 · 2024-11-08T11:31:57.000Z
Motivation:

We added '@_exported import GRPCCore' to transport modules to make it
easier for users as it saves them from adding an import. On reflection
we've our position on this has changed and the implicit dependency will
likely make things less clear.

Modifications:

- Remove exported import from in-proc transport
- Update tutorials/examples to have explicit 'GRPCCore' imports

Result:

More explicit dependencies
diff --git a/Examples/echo/Package.swift b/Examples/echo/Package.swift
@@ -21,6 +21,7 @@ let package = Package(
   name: "echo",
   platforms: [.macOS("15.0")],
   dependencies: [
+    .package(url: "https://github.com/grpc/grpc-swift", exact: "2.0.0-alpha.1"),
     .package(url: "https://github.com/grpc/grpc-swift-protobuf", exact: "1.0.0-alpha.1"),
     .package(url: "https://github.com/grpc/grpc-swift-nio-transport", branch: "1.0.0-alpha.1"),
     .package(url: "https://github.com/apple/swift-argument-parser", from: "1.5.0"),
@@ -29,6 +30,7 @@ let package = Package(
     .executableTarget(
       name: "echo",
       dependencies: [
+        .product(name: "GRPCCore", package: "grpc-swift"),
         .product(name: "GRPCNIOTransportHTTP2", package: "grpc-swift-nio-transport"),
         .product(name: "GRPCProtobuf", package: "grpc-swift-protobuf"),
         .product(name: "ArgumentParser", package: "swift-argument-parser"),
diff --git a/Examples/hello-world/Package.swift b/Examples/hello-world/Package.swift
@@ -21,6 +21,7 @@ let package = Package(
   name: "hello-world",
   platforms: [.macOS("15.0")],
   dependencies: [
+    .package(url: "https://github.com/grpc/grpc-swift", exact: "2.0.0-alpha.1"),
     .package(url: "https://github.com/grpc/grpc-swift-protobuf", exact: "1.0.0-alpha.1"),
     .package(url: "https://github.com/grpc/grpc-swift-nio-transport", exact: "1.0.0-alpha.1"),
     .package(url: "https://github.com/apple/swift-argument-parser", from: "1.5.0"),
@@ -29,6 +30,7 @@ let package = Package(
     .executableTarget(
       name: "hello-world",
       dependencies: [
+        .product(name: "GRPCCore", package: "grpc-swift"),
         .product(name: "GRPCNIOTransportHTTP2", package: "grpc-swift-nio-transport"),
         .product(name: "GRPCProtobuf", package: "grpc-swift-protobuf"),
         .product(name: "ArgumentParser", package: "swift-argument-parser"),
diff --git a/Examples/hello-world/Sources/Subcommands/Greet.swift b/Examples/hello-world/Sources/Subcommands/Greet.swift
@@ -15,6 +15,7 @@
  */
 
 import ArgumentParser
+import GRPCCore
 import GRPCNIOTransportHTTP2
 import GRPCProtobuf
 
diff --git a/Examples/hello-world/Sources/Subcommands/Serve.swift b/Examples/hello-world/Sources/Subcommands/Serve.swift
@@ -15,6 +15,7 @@
  */
 
 import ArgumentParser
+import GRPCCore
 import GRPCNIOTransportHTTP2
 import GRPCProtobuf
 
diff --git a/Examples/route-guide/Package.swift b/Examples/route-guide/Package.swift
@@ -21,6 +21,7 @@ let package = Package(
   name: "route-guide",
   platforms: [.macOS("15.0")],
   dependencies: [
+    .package(url: "https://github.com/grpc/grpc-swift", exact: "2.0.0-alpha.1"),
     .package(url: "https://github.com/grpc/grpc-swift-protobuf", exact: "1.0.0-alpha.1"),
     .package(url: "https://github.com/grpc/grpc-swift-nio-transport", exact: "1.0.0-alpha.1"),
     .package(url: "https://github.com/apple/swift-argument-parser", from: "1.5.0"),
@@ -29,6 +30,7 @@ let package = Package(
     .executableTarget(
       name: "route-guide",
       dependencies: [
+        .product(name: "GRPCCore", package: "grpc-swift"),
         .product(name: "GRPCNIOTransportHTTP2", package: "grpc-swift-nio-transport"),
         .product(name: "GRPCProtobuf", package: "grpc-swift-protobuf"),
         .product(name: "ArgumentParser", package: "swift-argument-parser"),
diff --git a/Examples/route-guide/Sources/Subcommands/GetFeature.swift b/Examples/route-guide/Sources/Subcommands/GetFeature.swift
@@ -15,6 +15,7 @@
  */
 
 import ArgumentParser
+import GRPCCore
 import GRPCNIOTransportHTTP2
 
 struct GetFeature: AsyncParsableCommand {
diff --git a/Examples/route-guide/Sources/Subcommands/ListFeatures.swift b/Examples/route-guide/Sources/Subcommands/ListFeatures.swift
@@ -15,6 +15,7 @@
  */
 
 import ArgumentParser
+import GRPCCore
 import GRPCNIOTransportHTTP2
 
 struct ListFeatures: AsyncParsableCommand {
diff --git a/Examples/route-guide/Sources/Subcommands/RecordRoute.swift b/Examples/route-guide/Sources/Subcommands/RecordRoute.swift
@@ -15,6 +15,7 @@
  */
 
 import ArgumentParser
+import GRPCCore
 import GRPCNIOTransportHTTP2
 
 struct RecordRoute: AsyncParsableCommand {
diff --git a/Examples/route-guide/Sources/Subcommands/RouteChat.swift b/Examples/route-guide/Sources/Subcommands/RouteChat.swift
@@ -15,6 +15,7 @@
  */
 
 import ArgumentParser
+import GRPCCore
 import GRPCNIOTransportHTTP2
 
 struct RouteChat: AsyncParsableCommand {
diff --git a/Examples/route-guide/Sources/Subcommands/Serve.swift b/Examples/route-guide/Sources/Subcommands/Serve.swift
@@ -16,6 +16,7 @@
 
 import ArgumentParser
 import Foundation
+import GRPCCore
 import GRPCNIOTransportHTTP2
 import GRPCProtobuf
 import Synchronization
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ about gRPC on the [gRPC project's website][grpcio].
   - [`grpc-swift-nio-transport`][grpc-swift-nio-transport] contains high-performance HTTP/2 client and server transport implementations for gRPC Swift built on top of SwiftNIO.
   - [`grpc-swift-protobuf`][grpc-swift-protobuf] contains integrations with SwiftProtobuf for gRPC Swift.
   - [`grpc-swift-extras`][grpc-swift-extras] contains optional extras for gRPC Swift.
- 
+
 
 ## Quick Start
 
@@ -32,13 +32,15 @@ let package = Package(
     name: "foo-package",
     platforms: [.macOS("15.0")],
     dependencies: [
+        .package(url: "https://github.com/grpc/grpc-swift.git", from: "2.0.0-alpha.1"),
         .package(url: "https://github.com/grpc/grpc-swift-nio-transport.git", from: "1.0.0-alpha.1"),
         .package(url: "https://github.com/grpc/grpc-swift-protobuf.git", from: "1.0.0-alpha.1"),
     ],
     targets: [
         .executableTarget(
             name: "bar-target",
             dependencies: [
+                .product(name: "GRPCCore", package: "grpc-swift"),
                 .product(name: "GRPCNIOTransportHTTP2", package: "grpc-swift-nio-transport"),
                 .product(name: "GRPCProtobuf", package: "grpc-swift-protobuf"),
             ]
@@ -52,4 +54,4 @@ let package = Package(
 [spi-grpc-swift]: https://swiftpackageindex.com/grpc/grpc-swift/documentation
 [grpc-swift-nio-transport]: https://github.com/grpc/grpc-swift-nio-transport
 [grpc-swift-protobuf]: https://github.com/grpc/grpc-swift-protobuf
-[grpc-swift-extras]: https://github.com/grpc/grpc-swift-extras 
+[grpc-swift-extras]: https://github.com/grpc/grpc-swift-extras
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec01-step08-description.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec01-step08-description.swift
@@ -12,6 +12,7 @@ let package = Package(
     .executableTarget(
       name: "RouteGuide",
       dependencies: [
+        .product(name: "GRPCCore", package: "grpc-swift"),
         .product(name: "GRPCNIOTransportHTTP2", package: "grpc-swift-nio-transport"),
         .product(name: "GRPCProtobuf", package: "grpc-swift-protobuf"),
       ]
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec05-step00-package.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec05-step00-package.swift
@@ -12,6 +12,7 @@ let package = Package(
     .executableTarget(
       name: "RouteGuide",
       dependencies: [
+        .product(name: "GRPCCore", package: "grpc-swift"),
         .product(name: "GRPCNIOTransportHTTP2", package: "grpc-swift-nio-transport"),
         .product(name: "GRPCProtobuf", package: "grpc-swift-protobuf"),
       ]
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec05-step01-package.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec05-step01-package.swift
@@ -12,6 +12,7 @@ let package = Package(
     .executableTarget(
       name: "RouteGuide",
       dependencies: [
+        .product(name: "GRPCCore", package: "grpc-swift"),
         .product(name: "GRPCNIOTransportHTTP2", package: "grpc-swift-nio-transport"),
         .product(name: "GRPCProtobuf", package: "grpc-swift-protobuf"),
       ],
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec05-step02-package.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec05-step02-package.swift
@@ -13,6 +13,7 @@ let package = Package(
     .executableTarget(
       name: "RouteGuide",
       dependencies: [
+        .product(name: "GRPCCore", package: "grpc-swift"),
         .product(name: "GRPCNIOTransportHTTP2", package: "grpc-swift-nio-transport"),
         .product(name: "GRPCProtobuf", package: "grpc-swift-protobuf"),
         .product(name: "ArgumentParser", package: "swift-argument-parser"),
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec05-step07-server.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec05-step07-server.swift
@@ -1,3 +1,4 @@
+import GRPCCore
 import GRPCNIOTransportHTTP2
 
 extension RouteGuide {
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec05-step08-run.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec05-step08-run.swift
@@ -1,3 +1,4 @@
+import GRPCCore
 import GRPCNIOTransportHTTP2
 
 extension RouteGuide {
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec06-step02-add-run-client.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec06-step02-add-run-client.swift
@@ -1,5 +1,3 @@
-import GRPCNIOTransportHTTP2
-
 extension RouteGuide {
   func runClient() async throws {
   }
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec06-step03-create-client.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec06-step03-create-client.swift
@@ -1,3 +1,4 @@
+import GRPCCore
 import GRPCNIOTransportHTTP2
 
 extension RouteGuide {
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec06-step04-run-client.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec06-step04-run-client.swift
@@ -1,3 +1,4 @@
+import GRPCCore
 import GRPCNIOTransportHTTP2
 
 extension RouteGuide {
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec06-step05-stub.swift b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Resources/route-guide-sec06-step05-stub.swift
@@ -1,3 +1,4 @@
+import GRPCCore
 import GRPCNIOTransportHTTP2
 
 extension RouteGuide {
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
@@ -1,3 +1,4 @@
+import GRPCCore
 import GRPCNIOTransportHTTP2
 
 extension RouteGuide {
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
@@ -1,3 +1,4 @@
+import GRPCCore
 import GRPCNIOTransportHTTP2
 
 extension RouteGuide {
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
@@ -1,3 +1,4 @@
+import GRPCCore
 import GRPCNIOTransportHTTP2
 
 extension RouteGuide {
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
@@ -1,3 +1,4 @@
+import GRPCCore
 import GRPCNIOTransportHTTP2
 
 extension RouteGuide {
diff --git a/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Route-Guide.tutorial b/Sources/GRPCCore/Documentation.docc/Tutorials/Route-Guide/Route-Guide.tutorial
@@ -77,8 +77,9 @@
         Next we can add a target. In this tutorial we'll create a single executable target which
         can act as both a client and a server.
 
-        We require two gRPC dependencies: `GRPCNIOTransportHTTP2"` provides an implementation of an HTTP/2
-        client and server, while `GRPCProtobuf` provides the necessary components to serialize
+        We require three gRPC dependencies: `GRPCCore` provides core abstractions and runtime
+        components, `GRPCNIOTransportHTTP2` provides an implementation of an HTTP/2
+        client and server, and `GRPCProtobuf` provides the necessary components to serialize
         and deserialize `SwiftProtobuf` messages.
 
         @Code(name: "Package.swift", file: "route-guide-sec01-step08-description.swift")
diff --git a/Sources/GRPCInProcessTransport/Exports.swift b/Sources/GRPCInProcessTransport/Exports.swift

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ let package = Package(`
`12`	`12`	`.executableTarget(`
`13`	`13`	`name: "RouteGuide",`
`14`	`14`	`dependencies: [`
	`15`	`+ .product(name: "GRPCCore", package: "grpc-swift"),`
`15`	`16`	`.product(name: "GRPCNIOTransportHTTP2", package: "grpc-swift-nio-transport"),`
`16`	`17`	`.product(name: "GRPCProtobuf", package: "grpc-swift-protobuf"),`
`17`	`18`	`]`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import GRPCCore`
`1`	`2`	`import GRPCNIOTransportHTTP2`
`2`	`3`
`3`	`4`	`extension RouteGuide {`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-import GRPCNIOTransportHTTP2`
`2`		`-`
`3`	`1`	`extension RouteGuide {`
`4`	`2`	`func runClient() async throws {`
`5`	`3`	`}`