Mc/here now with limit #374

marcin-cebo · 2025-10-06T15:55:02Z

No description provided.

parfeon

I had a feeling that in some places a user is forced to specify limit which I believe shouldn't be true, and we internally set the maximum limit if it is missing.

I approve it so far, but we still have a discussion about this nextOffset.

parfeon · 2025-10-07T14:17:19Z

pubnub-gson/pubnub-gson-docs/src/main/java/com/pubnub/docs/presence/HereNowApp.java

+                        // Check if more results are available
+                        if (res.getNextOffset() != null) {
+                            System.out.println("\nMore results available. Fetching next page...\n");
+
+                            // Fetch next page using the offset from previous response
+                            pubnub.hereNow()
+                                    .channels(Arrays.asList("coolChannel", "coolChannel2"))
+                                    .includeUUIDs(true)
+                                    .limit(100)
+                                    .offset(res.getNextOffset())
+                                    .async(result2 -> {
+                                        result2.onSuccess((PNHereNowResult res2) -> {
+                                            printHereNowResult(res2);
+
+                                            // Continue pagination if needed by checking res2.getNextOffset()
+                                        }).onFailure((PubNubException exception) -> {
+                                            System.out.println("Error retrieving hereNow data: " + exception.getMessage());
+                                        });
+                                    });


Will it make sense / possible to create local closure which will be called from initial and nested hereNow calls, but in addition to result will pass offset for example and inside if it is not nil, make another hereNow calls - it will give user better idea because novice may think that it is ok to nest hereNow calls as long as possible.

Good point. I will modify this code.

...tlin/pubnub-kotlin-api/src/appleMain/kotlin/com/pubnub/api/endpoints/presence/HereNow.ios.kt

pubnub-kotlin/pubnub-kotlin-api/src/appleMain/kotlin/com/pubnub/api/PubNubImpl.kt

pubnub-kotlin/pubnub-kotlin-api/src/jsMain/kotlin/com/pubnub/api/PubNubImpl.kt

pubnub-kotlin/pubnub-kotlin-api/src/jvmMain/kotlin/com/pubnub/api/endpoints/presence/HereNow.kt

pubnub-kotlin/pubnub-kotlin-api/src/jvmMain/kotlin/com/pubnub/api/PubNub.kt

parfeon · 2025-10-07T14:25:29Z

pubnub-kotlin/pubnub-kotlin-core-api/src/commonMain/kotlin/com/pubnub/api/PubNubError.kt

+
+    HERE_NOW_OFFSET_OUT_OF_RANGE(
+        182,
+        "HereNow offset is out of range. Valid range is 0 to infinity.",


Currently we know that up to the 1000. There definitely will be an upper limit, but it can't be infinity.

Good catch. I will fix this message. But I guess offset can be higher than 1000 so I would go with
"HereNow offset cannot be negative"

What do you think?

Makes sense!

parfeon · 2025-10-07T14:26:39Z

pubnub-kotlin/pubnub-kotlin-docs/src/main/kotlin/com/pubnub/docs/presence/HereNowMain.kt

+                pubnub.hereNow(
+                    channels = listOf(channel),
+                    limit = 100,
+                    offset = response.nextOffset
+                ).async { nextResult ->
+                    nextResult.onSuccess { nextResponse ->
+                        println("\nNext Page Results:")
+                        printChannelData(channel, nextResponse)
+
+                        // Continue pagination if needed by checking nextResponse.nextOffset
+                    }.onFailure { exception ->
+                        println("ERROR: Failed to get next page of presence information")
+                        println("Error details: ${exception.message}")
+                    }


There is another code for docs where I've left a question about closure reuse.

Good point. I will improve paging.

pubnub-kotlin/pubnub-kotlin-api/src/nonJvm/kotlin/com/pubnub/api/PubNub.nonJvm.kt

parfeon · 2025-10-07T14:30:10Z

...pubnub-kotlin-impl/src/main/kotlin/com/pubnub/internal/endpoints/presence/HereNowEndpoint.kt

+    override val offset: Int? = null,
 ) : EndpointCore<Envelope<JsonElement>, PNHereNowResult>(pubnub), HereNow {
    private val log: PNLogger = LoggerManager.instance.getLogger(pubnub.logConfig, this::class.java)
+    private val effectiveLimit: Int = if (limit in 1..MAX_CHANNEL_OCCUPANTS_LIMIT) {


We say that it could be between 0 and infinity (so far as specified in the current codebase), but here we limit it with 1 as the lower limit. We shouldn't let users specify smaller than 0 and larger than the upper limit.

If it is between 1 and 1000 then we accept it. If is out of this range then we set it to 1000.
FYI
"HereNow offset is out of range. Valid range is 0 to infinity.", refers to offset not limit.

What do you think?

But we should accept 0 as limit. The current condition won't let us do it, right?

Yes, current condition won't let 0 as limit.
Do we want to allow this?
What is a use case for limit set to 0?

With 0 it will give us only occupancy count:

{ "message": "OK", "payload": { "channels": { "test-channel-353": { "occupancy": 1 }, "test-channel-792": { "occupancy": 4 }, "test-channel-836": { "occupancy": 7 } }, "total_channels": 3, "total_occupancy": 12 }, "service": "Presence", "status": 200 }

Which is something that user also may want to have (just to show how many people are present on the channel).

ok, makes sense. I will allow 0 as limit.

…make behaviour consistent with multi-channel calls.

marcin-cebo requested review from jakub-grzesiowski, jguz-pubnub, kleewho and parfeon as code owners October 6, 2025 15:55

marcin-cebo added 10 commits October 6, 2025 17:56

Test

53b8ffd

Test

f5d4c6a

Initial changes

82bd6e6

Added integration tests

da02d30

Renamed nextStartFrom to nextOffset

ba34ae8

Renamed startFrom to offset

49864fc

Updated snippets

0baebf7

Added log statement for case when limit is out of allowed range.

dc78bd8

Added test for Global HereNow

49c6b3d

Added integration tests for java

e3d916d

marcin-cebo force-pushed the mc/hereNow_with_limit branch from 3ec20ee to e3d916d Compare October 6, 2025 15:56

marcin-cebo added 3 commits October 6, 2025 18:15

Rename variables

4994a7e

Fix lint

99a1f77

Fix JS

38a97a4

parfeon approved these changes Oct 7, 2025

View reviewed changes

marcin-cebo added 6 commits October 7, 2025 20:30

Improved paging in snippets.

83a5dc3

Allowed limit to be 0

eb4d1b7

Channel data are returned for one channel when includeUUIDs=false to …

00be4a9

…make behaviour consistent with multi-channel calls.

Removed nextOffset

4454939

Updated kDoc

8d3c6c3

Fix

9d33842

marcin-cebo merged commit e77f620 into master Oct 20, 2025
7 checks passed

marcin-cebo deleted the mc/hereNow_with_limit branch October 20, 2025 12:58

Mc/here now with limit #374

Mc/here now with limit #374

Uh oh!

Conversation

marcin-cebo commented Oct 6, 2025

Uh oh!

parfeon left a comment

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!

Uh oh!

Uh oh!

Uh oh!

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!

Choose a reason for hiding this comment

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!

parfeon Oct 8, 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!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

parfeon Oct 8, 2025 •

edited

Loading