Merge pull request #1119 from myConsciousness/1116-feature-request-re…

…name-streamservice-to-relayservice refactor: renamed to `relayService` (#1116)
myConsciousness · Dec 19, 2023 · c4380f4 · c4380f4
2 parents 5f0deb4 + f917a01
commit c4380f4
Show file tree

Hide file tree

Showing 19 changed files with 44 additions and 41 deletions.
diff --git a/packages/atproto/CHANGELOG.md b/packages/atproto/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 - Upgraded `atproto_core`. ([#1112](https://github.com/myConsciousness/atproto.dart/issues/1112))
 - Optimized internal process. ([#1114](https://github.com/myConsciousness/atproto.dart/issues/1114))
+- Removed `streamService` and added `relayService` instead. Defaults to `bsky.network`. ([#1116](https://github.com/myConsciousness/atproto.dart/issues/1116))
 
 ## v0.9.1
 

diff --git a/packages/atproto/example/example.dart b/packages/atproto/example/example.dart
@@ -22,7 +22,7 @@ Future<void> main() async {
       service: 'SERVICE_NAME',
 
       //! The default is `bsky.network`
-      streamService: 'STREAM_SERVICE_NAME',
+      relayService: 'STREAM_SERVICE_NAME',
 
       //! Automatic retry is available when server error or network error occurs
       //! when communicating with the API.

diff --git a/packages/atproto/lib/src/atproto.dart b/packages/atproto/lib/src/atproto.dart
@@ -20,7 +20,7 @@ sealed class ATProto {
     final core.Session session, {
     core.Protocol protocol = core.defaultProtocol,
     String service = core.defaultService,
-    String streamService = core.defaultStreamService,
+    String relayService = core.defaultRelayService,
     Duration timeout = core.defaultTimeout,
     core.RetryConfig? retryConfig,
     final core.GetClient? mockedGetClient,
@@ -30,7 +30,7 @@ sealed class ATProto {
         session: session,
         protocol: protocol,
         service: service,
-        streamService: streamService,
+        relayService: relayService,
         timeout: timeout,
         retryConfig: retryConfig,
         mockedGetClient: mockedGetClient,
@@ -41,7 +41,7 @@ sealed class ATProto {
   factory ATProto.anonymous({
     core.Protocol protocol = core.defaultProtocol,
     String service = core.defaultService,
-    String streamService = core.defaultStreamService,
+    String relayService = core.defaultRelayService,
     Duration timeout = core.defaultTimeout,
     core.RetryConfig? retryConfig,
     final core.GetClient? mockedGetClient,
@@ -50,7 +50,7 @@ sealed class ATProto {
       _ATProto(
         protocol: protocol,
         service: service,
-        streamService: streamService,
+        relayService: relayService,
         timeout: timeout,
         retryConfig: retryConfig,
         mockedGetClient: mockedGetClient,
@@ -88,7 +88,7 @@ final class _ATProto implements ATProto {
     this.session,
     required core.Protocol protocol,
     required String service,
-    required String streamService,
+    required String relayService,
     required Duration timeout,
     core.RetryConfig? retryConfig,
     final core.GetClient? mockedGetClient,
@@ -97,7 +97,7 @@ final class _ATProto implements ATProto {
           did: session?.did ?? '',
           protocol: protocol,
           service: service,
-          streamService: streamService,
+          relayService: relayService,
           context: core.ClientContext(
             accessJwt: session?.accessJwt ?? '',
             timeout: timeout,

diff --git a/packages/atproto/lib/src/services/base_service.dart b/packages/atproto/lib/src/services/base_service.dart
@@ -11,7 +11,7 @@ base class ATProtoBaseService extends core.BaseXRPCService {
     required this.did,
     required super.protocol,
     required super.service,
-    super.streamService,
+    super.relayService,
     required super.context,
     super.mockedGetClient,
     super.mockedPostClient,

diff --git a/packages/atproto/lib/src/services/labels_service.dart b/packages/atproto/lib/src/services/labels_service.dart
@@ -18,7 +18,7 @@ sealed class LabelsService {
     required String did,
     required core.Protocol protocol,
     required String service,
-    required String streamService,
+    required String relayService,
     required core.ClientContext context,
     final core.GetClient? mockedGetClient,
     final core.PostClient? mockedPostClient,
@@ -27,7 +27,7 @@ sealed class LabelsService {
         did: did,
         protocol: protocol,
         service: service,
-        streamService: streamService,
+        relayService: relayService,
         context: context,
         mockedGetClient: mockedGetClient,
         mockedPostClient: mockedPostClient,
@@ -88,7 +88,7 @@ final class _LabelsService extends ATProtoBaseService implements LabelsService {
     required super.did,
     required super.protocol,
     required super.service,
-    required super.streamService,
+    required super.relayService,
     required super.context,
     super.mockedGetClient,
     super.mockedPostClient,

diff --git a/packages/atproto/lib/src/services/services.dart b/packages/atproto/lib/src/services/services.dart
@@ -19,7 +19,7 @@ sealed class ATProtoService {
     required String did,
     required core.Protocol protocol,
     required String service,
-    required String streamService,
+    required String relayService,
     required core.ClientContext context,
     final core.GetClient? mockedGetClient,
     final core.PostClient? mockedPostClient,
@@ -28,7 +28,7 @@ sealed class ATProtoService {
         did: did,
         protocol: protocol,
         service: service,
-        streamService: streamService,
+        relayService: relayService,
         context: context,
         mockedGetClient: mockedGetClient,
         mockedPostClient: mockedPostClient,
@@ -59,7 +59,7 @@ final class _ATProtoService implements ATProtoService {
     required String did,
     required core.Protocol protocol,
     required String service,
-    required String streamService,
+    required String relayService,
     required core.ClientContext context,
     final core.GetClient? mockedGetClient,
     final core.PostClient? mockedPostClient,
@@ -99,7 +99,7 @@ final class _ATProtoService implements ATProtoService {
           did: did,
           protocol: protocol,
           service: service,
-          streamService: streamService,
+          relayService: relayService,
           context: context,
           mockedGetClient: mockedGetClient,
           mockedPostClient: mockedPostClient,
@@ -108,7 +108,7 @@ final class _ATProtoService implements ATProtoService {
           did: did,
           protocol: protocol,
           service: service,
-          streamService: streamService,
+          relayService: relayService,
           context: context,
           mockedGetClient: mockedGetClient,
           mockedPostClient: mockedPostClient,

diff --git a/packages/atproto/lib/src/services/sync_service.dart b/packages/atproto/lib/src/services/sync_service.dart
@@ -29,7 +29,7 @@ sealed class SyncService {
     required String did,
     required core.Protocol protocol,
     required String service,
-    required String streamService,
+    required String relayService,
     required core.ClientContext context,
     final core.GetClient? mockedGetClient,
     final core.PostClient? mockedPostClient,
@@ -38,7 +38,7 @@ sealed class SyncService {
         did: did,
         protocol: protocol,
         service: service,
-        streamService: streamService,
+        relayService: relayService,
         context: context,
         mockedGetClient: mockedGetClient,
         mockedPostClient: mockedPostClient,
@@ -313,7 +313,7 @@ final class _SyncService extends ATProtoBaseService implements SyncService {
     required super.did,
     required super.protocol,
     required super.service,
-    required super.streamService,
+    required super.relayService,
     required super.context,
     super.mockedGetClient,
     super.mockedPostClient,

diff --git a/packages/atproto/test/src/services/suite/service_suite.dart b/packages/atproto/test/src/services/suite/service_suite.dart
@@ -150,7 +150,7 @@ final class _ServiceRunner extends atp_test.ServiceRunner {
         did: did,
         protocol: core.Protocol.https,
         service: service,
-        streamService: streamService,
+        relayService: relayService,
         context: clientContext,
         mockedGetClient: mockedGetClient,
         mockedPostClient: mockedPostClient,
@@ -203,7 +203,7 @@ final class _ServiceRunner extends atp_test.ServiceRunner {
         did: did,
         protocol: core.Protocol.https,
         service: service,
-        streamService: streamService,
+        relayService: relayService,
         context: clientContext,
         mockedGetClient: mockedGetClient,
         mockedPostClient: mockedPostClient,

diff --git a/packages/atproto_core/CHANGELOG.md b/packages/atproto_core/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 - Upgraded `NSID`. ([#1112](https://github.com/myConsciousness/atproto.dart/issues/1112))
 - The following methods of `BaseXRPCService` now require an NSID argument. Immutable NSIDs are preferred. ([#1114](https://github.com/myConsciousness/atproto.dart/issues/1114))
+- Removed `streamService` and added `relayService` instead. Defaults to `bsky.network`. ([#1116](https://github.com/myConsciousness/atproto.dart/issues/1116))
 
 ## v0.7.0
 

diff --git a/packages/atproto_core/lib/src/base_xrpc_service.dart b/packages/atproto_core/lib/src/base_xrpc_service.dart
@@ -19,13 +19,13 @@ base class BaseXRPCService {
   BaseXRPCService({
     xrpc.Protocol? protocol,
     required String service,
-    String? streamService,
+    String? relayService,
     required ClientContext context,
     final xrpc.GetClient? mockedGetClient,
     final xrpc.PostClient? mockedPostClient,
   })  : _protocol = protocol,
         _service = service,
-        _streamService = streamService ?? defaultStreamService,
+        _relayService = relayService ?? defaultRelayService,
         _context = context,
         _mockedGetClient = mockedGetClient,
         _mockedPostClient = mockedPostClient;
@@ -35,7 +35,7 @@ base class BaseXRPCService {
 
   /// The base service.
   final String _service;
-  final String _streamService;
+  final String _relayService;
 
   /// The context for HTTP clients.
   final ClientContext _context;
@@ -117,7 +117,7 @@ base class BaseXRPCService {
   }) async =>
       await _context.stream(
         endpoint,
-        service: _streamService,
+        service: _relayService,
         parameters: parameters,
         to: to,
         adaptor: adaptor,

diff --git a/packages/atproto_core/lib/src/const.dart b/packages/atproto_core/lib/src/const.dart
@@ -18,7 +18,7 @@ const defaultTimeout = Duration(seconds: 30);
 const defaultService = 'bsky.social';
 
 /// `bsky.network`
-const defaultStreamService = 'bsky.network';
+const defaultRelayService = 'bsky.network';
 
 /// `cardyb.bsky.app`
 const defaultLinkPreviewService = 'cardyb.bsky.app';
diff --git a/packages/atproto_core/test/src/const_test.dart b/packages/atproto_core/test/src/const_test.dart
@@ -31,8 +31,8 @@ void main() {
   });
 
   test('defaultStreamService', () {
-    expect(defaultStreamService, isA<String>());
-    expect(defaultStreamService, 'bsky.network');
+    expect(defaultRelayService, isA<String>());
+    expect(defaultRelayService, 'bsky.network');
   });
 
   test('defaultLinkPreviewService', () {

diff --git a/packages/atproto_test/lib/src/service_runner.dart b/packages/atproto_test/lib/src/service_runner.dart
@@ -13,7 +13,7 @@ abstract class ServiceRunner {
   const ServiceRunner();
 
   String get service => 'bsky.social';
-  String get streamService => 'bsky.network';
+  String get relayService => 'bsky.network';
   String get did => 'did:web:shinyakato.dev';
 
   core.Session get session => const core.Session(

diff --git a/packages/bluesky/CHANGELOG.md b/packages/bluesky/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 - Upgraded `atproto_core`. ([#1112](https://github.com/myConsciousness/atproto.dart/issues/1112))
 - Optimized internal process. ([#1114](https://github.com/myConsciousness/atproto.dart/issues/1114))
+- Removed `streamService` and added `relayService` instead. Defaults to `bsky.network`. ([#1116](https://github.com/myConsciousness/atproto.dart/issues/1116))
 
 ## v0.13.2
 

diff --git a/packages/bluesky/example/example.dart b/packages/bluesky/example/example.dart
@@ -14,7 +14,7 @@ Future<void> main() async {
       service: 'SERVICE_NAME',
 
       //! The default is `bsky.network`
-      streamService: 'STREAM_SERVICE_NAME',
+      relayService: 'STREAM_SERVICE_NAME',
 
       //! Automatic retry is available when server error or network error occurs
       //! when communicating with the API.

diff --git a/packages/bluesky/lib/src/bluesky.dart b/packages/bluesky/lib/src/bluesky.dart
@@ -20,7 +20,7 @@ sealed class Bluesky {
     final atp.Session session, {
     core.Protocol protocol = core.defaultProtocol,
     String service = core.defaultService,
-    String streamService = core.defaultStreamService,
+    String relayService = core.defaultRelayService,
     Duration timeout = core.defaultTimeout,
     core.RetryConfig? retryConfig,
     final core.GetClient? mockedGetClient,
@@ -30,7 +30,7 @@ sealed class Bluesky {
         session: session,
         protocol: protocol,
         service: service,
-        streamService: streamService,
+        relayService: relayService,
         timeout: timeout,
         retryConfig: retryConfig,
         mockedGetClient: mockedGetClient,
@@ -41,7 +41,7 @@ sealed class Bluesky {
   factory Bluesky.anonymous({
     core.Protocol protocol = core.defaultProtocol,
     String service = core.defaultService,
-    String streamService = core.defaultStreamService,
+    String relayService = core.defaultRelayService,
     Duration timeout = core.defaultTimeout,
     core.RetryConfig? retryConfig,
     final core.GetClient? mockedGetClient,
@@ -50,7 +50,7 @@ sealed class Bluesky {
       _Bluesky(
         protocol: protocol,
         service: service,
-        streamService: streamService,
+        relayService: relayService,
         timeout: timeout,
         retryConfig: retryConfig,
         mockedGetClient: mockedGetClient,
@@ -103,7 +103,7 @@ final class _Bluesky implements Bluesky {
     this.session,
     required core.Protocol protocol,
     required String service,
-    required String streamService,
+    required String relayService,
     required Duration timeout,
     core.RetryConfig? retryConfig,
     final core.GetClient? mockedGetClient,
@@ -113,7 +113,7 @@ final class _Bluesky implements Bluesky {
               ? atp.ATProto.anonymous(
                   protocol: protocol,
                   service: service,
-                  streamService: streamService,
+                  relayService: relayService,
                   timeout: timeout,
                   retryConfig: retryConfig,
                   mockedGetClient: mockedGetClient,
@@ -123,7 +123,7 @@ final class _Bluesky implements Bluesky {
                   session,
                   protocol: protocol,
                   service: service,
-                  streamService: streamService,
+                  relayService: relayService,
                   timeout: timeout,
                   retryConfig: retryConfig,
                   mockedGetClient: mockedGetClient,

diff --git a/packages/xrpc/lib/src/const.dart b/packages/xrpc/lib/src/const.dart
@@ -5,5 +5,5 @@
 /// The default service to communicate.
 const defaultService = 'bsky.social';
 
-/// The default service to streamed communicate.
-const defaultStreamService = 'bsky.network';
+/// The default relay service to communicate.
+const defaultRelayService = 'bsky.network';
diff --git a/packages/xrpc/lib/src/xrpc/xrpc.dart b/packages/xrpc/lib/src/xrpc/xrpc.dart
@@ -440,7 +440,7 @@ Uri _buildWsUri(
 ) {
   final buffer = StringBuffer()
     ..write('wss://')
-    ..write(service ?? defaultStreamService)
+    ..write(service ?? defaultRelayService)
     ..write('/xrpc/')
     ..write(methodId.toString());
 

diff --git a/packages/xrpc/test/src/const_test.dart b/packages/xrpc/test/src/const_test.dart
@@ -11,6 +11,6 @@ import 'package:xrpc/src/const.dart';
 void main() {
   test('default service', () {
     expect(defaultService, 'bsky.social');
-    expect(defaultStreamService, 'bsky.network');
+    expect(defaultRelayService, 'bsky.network');
   });
 }