refactor(log): improved logging with instance level logging enable feature. by mohitpubnub · Pull Request #136 · pubnub/dart

mohitpubnub · 2025-08-01T12:01:07Z

feature: support for disabling retry.

Added support for RetryPolicy.none() to disable retry for subscription.

BREAKING CHANGES: The default retry policy has been changed from applying to all operations to now applying only to the subscription feature, with the exponential policy set by default.

refactor: improved logging in the library

Enhanced logging using standardized logging practices.

jguz-pubnub · 2025-08-04T09:45:15Z

+
+        // Log module information
+        messageString += '\n\tModules:';
+        messageString +=


I see that each module could override toString() method, which should make creating a final String representation of a PubNub object a bit easier:

messageString += pubnub.networking.toString() messageString += pubnub.parser.toString() messageString += pubnub.crypto.toString()

👍🏻
applied mentioned approach at 65e82a7

jguz-pubnub · 2025-08-04T09:45:53Z

+          for (var i = 0; i < allKeysets.length; i++) {
+            var keyset = allKeysets[i];
+            var name = keysetNames[i];
+            messageString += '\n\t  $name:';


Perhaps the same as mentioned above can be applied to custom Keyset type:

https://github.com/pubnub/dart/pull/136/files#r2250969267

same at 65e82a7

jguz-pubnub · 2025-08-04T09:56:01Z

+      } else if (detailsType == LogEventDetailsType.networkRequestInfo) {
+        var requestMap = details as Map<String, dynamic>;
+
+        for (var entry in requestMap.entries) {


It works, although I do think this may be challenging to maintain in the long-run. Do you have the ability to introduce and log more abstract types, let's say, NetworkRequest or NetworkResponse? They can have properties specific to request and response, respectively, and override toString() method. Then, you could always call .toString() to create your messageString regardless of the passed object.

👍🏻 updated at 65e82a7

jguz-pubnub · 2025-08-04T10:00:09Z

+  }
+
+  /// Set up global logging that will be available throughout the entire SDK
+  static void _setupGlobalLogging(


Let's leave it as it is now because of the scope of the change; however, it would be great to consider dependency injection tools like GetIt or even a custom one in the long-run

Agree! There is scope for enhancement. And this can be part of a dedicated task which can deal with it along with other impacted components.

@jguz-pubnub now with dff7080 change. We have a logging configuration injectable

Now the initialisation looks like:

var pubnub = PubNub( defaultKeyset: Keyset( subscribeKey: 'sub-key', publishKey: 'pub-key', userId: UserId('test-user')), logging: LoggingConfiguration( logLevel: Level.all, // Enable logging at all level // optional other configurations. loggerName: 'test-pubnub', logToConsole: false, ), );

jguz-pubnub · 2025-08-04T10:15:17Z

      bool includeMessageType = true,
      bool includeCustomMessageType = false,
      bool includeUUID = true}) async {
+    _logger.info('Fetch messages API call');


I assume any method like _logger object, like .info, or .fine produce a LogRecord you can listen to or print it to the console. Is this record's format compliant with the format we have in ADR? For example:

"${timestamp} PubNub-${instanceId} Debug ${callsite} Some message"

here 'Fetch messages API call' is just a part of a message.
The final log information in it's string format (in default format) looks like this:
2025-08-05 07:37:29.303300 info PubNub-49078.pubnub.dx.batch: Fetch messages API call

…dule and types information in readable fomat and cleanup the logging implementation to use toString() methods on those modules.

…isable retry for subscribe test(retry_policy): added tests for retry policy refactor: retry policy applicable to subscribe only

mohitpubnub · 2025-08-05T05:29:13Z

@jakub-grzesiowski there is missing support for disabling retry. So adbfbd5 contains changes to handle disabling retry scenario with RetryPolicy.none()

jguz-pubnub · 2025-08-05T13:19:05Z

+        if (details is Response) {
+          messageString += details.toString();
+        } else if (details is Map) {
+          var detailsMap = details as Map<String, dynamic>;


What happens if you call details.toString() regardless of the underlying object type? Why don't we want to print the whole Map object and select a few keys only to be printed out?

Agree!! The issue we have here in this specific case is:
We need to print request url along with response details and in networking module we are missing URL in case of dart:io 's HttpResponse..

However once we have more standard Networking, We can have more cleaner version here

jguz-pubnub · 2025-08-05T13:22:10Z


  late final ILogger __logger;
-  Fiber(this._core, {required this.action}) : id = _id++ {
+  Fiber(this._core, {required this.action, RequestType? requestType})


I see we could apply dart format to update our code to follow the Dart formatting guidelines and enable it to run on each save. You don't have to do it now, I'm thinking about creating a story for that to see what's the outcome

before committing I ran dart format. Strange that this isn't formatted! Looking into it

…guration for logging at instance level. Removed static methods from default file to have a clean approach.

mohitpubnub · 2025-08-06T07:20:36Z

@pubnub-release-bot release dart as v6.0.0

pubnub-release-bot · 2025-08-06T13:57:15Z

🛑 Build failed. Please check release build for details 🛑

Ali-Toosi · 2025-08-13T11:59:43Z

Just linking this issue to this PR: #137
Unless the SDK is planned to drop support for web, it appears dart:mirrors isn't available on web and v6.0.0 doesn't compile.

Mohit Tejani added 3 commits August 1, 2025 16:23

Added support for instance level log configuration,new logging approach

08a9615

dart analyse fix

7a9350f

formatting!

9d8ee4c

mohitpubnub requested a review from jguz-pubnub as a code owner August 1, 2025 12:01

mohitpubnub self-assigned this Aug 1, 2025

mohitpubnub added priority: medium This PR should be reviewed after all high priority PRs. type: refactor This PR contains refactored existing features. labels Aug 1, 2025

Merge branch 'master' into CLEN-2820

520505f

jguz-pubnub reviewed Aug 4, 2025

View reviewed changes

Mohit Tejani added 2 commits August 5, 2025 08:50

refactor(logging): implementation of toString() methods to log the mo…

65e82a7

…dule and types information in readable fomat and cleanup the logging implementation to use toString() methods on those modules.

support for disable retry policy RetryPolicy.none() to explicitly d…

adbfbd5

…isable retry for subscribe test(retry_policy): added tests for retry policy refactor: retry policy applicable to subscribe only

Mohit Tejani added 2 commits August 5, 2025 11:09

refactor(imports) make required types available for retry and networking

fe2f79a

format!

91aef8e

jguz-pubnub reviewed Aug 5, 2025

View reviewed changes

jguz-pubnub approved these changes Aug 5, 2025

View reviewed changes

refactor(LoggingConfiguration): LoggingConfiguration to provide confi…

dff7080

…guration for logging at instance level. Removed static methods from default file to have a clean approach.

jguz-pubnub approved these changes Aug 6, 2025

View reviewed changes

PubNub SDK v6.0.0 release.

82b2057

pubnub-release-bot requested review from kazydek and techwritermat as code owners August 6, 2025 07:20

amend change log

b444eec

mohitpubnub merged commit ffb5d5c into master Aug 6, 2025
6 checks passed

mohitpubnub deleted the CLEN-2820 branch August 6, 2025 10:54

Conversation

mohitpubnub commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jguz-pubnub Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jguz-pubnub Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jguz-pubnub Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mohitpubnub commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mohitpubnub commented Aug 6, 2025

Uh oh!

Uh oh!

pubnub-release-bot commented Aug 6, 2025

Uh oh!

Ali-Toosi commented Aug 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mohitpubnub commented Aug 1, 2025 •

edited

Loading

jguz-pubnub Aug 4, 2025 •

edited

Loading

jguz-pubnub Aug 4, 2025 •

edited

Loading

jguz-pubnub Aug 4, 2025 •

edited

Loading

mohitpubnub commented Aug 5, 2025 •

edited

Loading