updated logs and settings services

CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.3.0
+
+- Renamed `LogRequestModel.ip` to `LogRequestModel.remoteIp`.
+- Added `LogRequestModel.userIp` (the "real" user ip when behind a reverse proxy).
+- Added `SettingsService.testS3()` to test the S3 storage connection.
+- Added `SettingsService.testEmail()` to send a test email.
+
+
 ## 0.2.0
 
 - Added `CollectionService.import()`.

README.md

@@ -352,6 +352,12 @@ final client = PocketBase("http://127.0.0.1:8090", authStore: CustomAuthStore())
 
 // Bulk updates app settings.
 🔐 client.settings.update({body, query, headers});
+
+// Performs a S3 storage connection test.
+🔐 client.settings.testS3({body, query, headers});
+
+// Sends a test email (verification, password-reset, email-change).
+🔐 client.settings.testEmail(toEmail, template, {body, query, headers});
 ```
 
 

lib/src/dtos/log_request_model.dart

@@ -16,7 +16,8 @@ class LogRequestModel implements Jsonable {
   String method;
   int status;
   String auth;
-  String ip;
+  String remoteIp;
+  String userIp;
   String referer;
   String userAgent;
   Map<String, dynamic> meta;
@@ -29,7 +30,8 @@ class LogRequestModel implements Jsonable {
     this.method = "",
     this.status = 0,
     this.auth = "",
-    this.ip = "",
+    this.remoteIp = "",
+    this.userIp = "",
     this.referer = "",
     this.userAgent = "",
     this.meta = const {},

lib/src/services/settings_service.dart

@@ -38,4 +38,45 @@ class SettingsService extends BaseService {
         )
         .then((data) => data as Map<String, dynamic>? ?? {});
   }
+
+  /// Performs a S3 storage connection test.
+  Future<void> testS3({
+    Map<String, dynamic> body = const {},
+    Map<String, dynamic> query = const {},
+    Map<String, String> headers = const {},
+  }) {
+    return client.send(
+      "/api/settings/test/s3",
+      method: "POST",
+      body: body,
+      query: query,
+      headers: headers,
+    );
+  }
+
+  /// Sends a test email.
+  ///
+  /// The possible `template` values are:
+  /// - verification
+  /// - password-reset
+  /// - email-change
+  Future<void> testEmail(
+    String toEmail,
+    String template, {
+    Map<String, dynamic> body = const {},
+    Map<String, dynamic> query = const {},
+    Map<String, String> headers = const {},
+  }) {
+    final enrichedBody = Map<String, dynamic>.of(body);
+    enrichedBody["email"] ??= toEmail;
+    enrichedBody["template"] ??= template;
+
+    return client.send(
+      "/api/settings/test/email",
+      method: "POST",
+      body: enrichedBody,
+      query: query,
+      headers: headers,
+    );
+  }
 }

pubspec.yaml

@@ -2,7 +2,7 @@ name: pocketbase
 description: Multi-platform Dart SDK for PocketBase, an open source realtime backend in 1 file.
 repository: https://github.com/pocketbase/dart-sdk
 
-version: 0.2.0
+version: 0.3.0
 
 environment:
   sdk: '>=2.14.0 <3.0.0'

test/dtos/log_request_model_test.dart

@@ -12,7 +12,8 @@ void main() {
         "method": "test_method",
         "status": 123,
         "auth": "test_auth",
-        "ip": "test_ip",
+        "remoteIp": "test_ip",
+        "userIp": "test_ip",
         "referer": "test_referer",
         "userAgent": "test_userAgent",
         "meta": {"a": 123},

test/services/settings_service_test.dart

@@ -76,5 +76,77 @@ void main() {
         equals({"a": 1, "b": false, "c": "test"}),
       );
     });
+
+    test("testS3()", () async {
+      final mock = MockClient((request) async {
+        expect(request.method, "POST");
+        expect(request.body, jsonEncode({"test_body": 123}));
+        expect(
+          request.url.toString(),
+          "/base/api/settings/test/s3?a=1&a=2&b=%40demo",
+        );
+        expect(request.headers["test"], "789");
+
+        return http.Response(
+          jsonEncode({"a": 1, "b": false, "c": "test"}),
+          200,
+        );
+      });
+
+      final client = PocketBase("/base", httpClientFactory: () => mock);
+
+      await client.settings.testS3(
+        query: {
+          "a": ["1", null, 2],
+          "b": "@demo",
+        },
+        body: {
+          "test_body": 123,
+        },
+        headers: {
+          "test": "789",
+        },
+      );
+    });
+
+    test("testEmail()", () async {
+      final mock = MockClient((request) async {
+        expect(request.method, "POST");
+        expect(
+            request.body,
+            jsonEncode({
+              "test_body": 123,
+              "email": "test@example.com",
+              "template": "test_template",
+            }));
+        expect(
+          request.url.toString(),
+          "/base/api/settings/test/email?a=1&a=2&b=%40demo",
+        );
+        expect(request.headers["test"], "789");
+
+        return http.Response(
+          jsonEncode({"a": 1, "b": false, "c": "test"}),
+          200,
+        );
+      });
+
+      final client = PocketBase("/base", httpClientFactory: () => mock);
+
+      await client.settings.testEmail(
+        "test@example.com",
+        "test_template",
+        query: {
+          "a": ["1", null, 2],
+          "b": "@demo",
+        },
+        body: {
+          "test_body": 123,
+        },
+        headers: {
+          "test": "789",
+        },
+      );
+    });
   });
 }