Skip to content

Send new presence state to the SharedWorker and fix newer access token override #473

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 9, 2025
Merged

Send new presence state to the SharedWorker and fix newer access token override #473

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae7500a
fix(shared-worker): fix newer access token override
parfeon Sep 8, 2025
b67b995
refactor(import): import from proper type file
parfeon Sep 8, 2025
728dbbe
PubNub SDK v9.10.0 release.
pubnub-release-bot Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions .pubnub.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
---
changelog:
- date: 2025-09-09
version: v9.10.0
changes:
- type: feature
text: "Send new presence `state` to the `SharedWorker` as soon as it has been set with `setState` to avoid race conditions between regular heartbeats and `backup` heartbeats."
- type: bug
text: "Fix issue because of which requests aggregated from other clients were able to override previously explicitly set newer access token."
- type: improvement
text: "Remove presence `state` from long-poll subscribe requests as part of the transition to explicit heartbeat."
- date: 2025-08-25
version: v9.9.0
changes:
Expand Down Expand Up @@ -1326,7 +1335,7 @@ supported-platforms:
- 'Ubuntu 14.04 and up'
- 'Windows 7 and up'
version: 'Pubnub Javascript for Node'
version: '9.9.0'
version: '9.10.0'
sdks:
- full-name: PubNub Javascript SDK
short-name: Javascript
Expand All @@ -1342,7 +1351,7 @@ sdks:
- distribution-type: source
distribution-repository: GitHub release
package-name: pubnub.js
location: https://github.com/pubnub/javascript/archive/refs/tags/v9.9.0.zip
location: https://github.com/pubnub/javascript/archive/refs/tags/v9.10.0.zip
requires:
- name: 'agentkeepalive'
min-version: '3.5.2'
Expand Down Expand Up @@ -2013,7 +2022,7 @@ sdks:
- distribution-type: library
distribution-repository: GitHub release
package-name: pubnub.js
location: https://github.com/pubnub/javascript/releases/download/v9.9.0/pubnub.9.9.0.js
location: https://github.com/pubnub/javascript/releases/download/v9.10.0/pubnub.9.10.0.js
requires:
- name: 'agentkeepalive'
min-version: '3.5.2'
Expand Down
12 changes: 12 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
## v9.10.0
September 09 2025

#### Added
- Send new presence `state` to the `SharedWorker` as soon as it has been set with `setState` to avoid race conditions between regular heartbeats and `backup` heartbeats.

#### Fixed
- Fix issue because of which requests aggregated from other clients were able to override previously explicitly set newer access token.

#### Modified
- Remove presence `state` from long-poll subscribe requests as part of the transition to explicit heartbeat.

## v9.9.0
August 25 2025

Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ Watch [Getting Started with PubNub JS SDK](https://app.dashcam.io/replay/64ee0d2
npm install pubnub
```
* or download one of our builds from our CDN:
* https://cdn.pubnub.com/sdk/javascript/pubnub.9.9.0.js
* https://cdn.pubnub.com/sdk/javascript/pubnub.9.9.0.min.js
* https://cdn.pubnub.com/sdk/javascript/pubnub.9.10.0.js
* https://cdn.pubnub.com/sdk/javascript/pubnub.9.10.0.min.js

2. Configure your keys:

Expand Down
65 changes: 47 additions & 18 deletions dist/web/pubnub.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3595,6 +3595,21 @@
workerLogLevel: this.configuration.workerLogLevel,
});
}
/**
* Update presence state associated with `userId`.
*
* @param state - Key-value pair of payloads (states) that should be associated with channels / groups specified as
* keys.
*/
onPresenceStateChange(state) {
this.scheduleEventPost({
type: 'client-presence-state-update',
clientIdentifier: this.configuration.clientIdentifier,
subscriptionKey: this.configuration.subscriptionKey,
workerLogLevel: this.configuration.workerLogLevel,
state,
});
}
/**
* Update client's heartbeat interval change.
*
Expand Down Expand Up @@ -3897,7 +3912,7 @@
if (!token || !stringifiedToken)
return undefined;
return (this.accessTokensMap = {
[accessToken]: { token: stringifiedToken, expiration: token.timestamp * token.ttl * 60 },
[accessToken]: { token: stringifiedToken, expiration: token.timestamp + token.ttl * 60 },
})[accessToken];
});
});
Expand Down Expand Up @@ -5421,7 +5436,7 @@
return base.PubNubFile;
},
get version() {
return '9.9.0';
return '9.10.0';
},
getVersion() {
return this.version;
Expand Down Expand Up @@ -6519,52 +6534,61 @@
let { e: eventType } = envelope;
// Resolve missing event type.
eventType !== null && eventType !== void 0 ? eventType : (eventType = envelope.c.endsWith('-pnpres') ? PubNubEventType.Presence : PubNubEventType.Message);
const pn_mfp = messageFingerprint(envelope.d);
// Check whether payload is string (potentially encrypted data).
if (eventType != PubNubEventType.Signal && typeof envelope.d === 'string') {
if (eventType == PubNubEventType.Message) {
return {
type: PubNubEventType.Message,
data: this.messageFromEnvelope(envelope),
pn_mfp,
};
}
return {
type: PubNubEventType.Files,
data: this.fileFromEnvelope(envelope),
pn_mfp,
};
}
else if (eventType == PubNubEventType.Message) {
return {
type: PubNubEventType.Message,
data: this.messageFromEnvelope(envelope),
pn_mfp,
};
}
else if (eventType === PubNubEventType.Presence) {
return {
type: PubNubEventType.Presence,
data: this.presenceEventFromEnvelope(envelope),
pn_mfp,
};
}
else if (eventType == PubNubEventType.Signal) {
return {
type: PubNubEventType.Signal,
data: this.signalFromEnvelope(envelope),
pn_mfp,
};
}
else if (eventType === PubNubEventType.AppContext) {
return {
type: PubNubEventType.AppContext,
data: this.appContextFromEnvelope(envelope),
pn_mfp,
};
}
else if (eventType === PubNubEventType.MessageAction) {
return {
type: PubNubEventType.MessageAction,
data: this.messageActionFromEnvelope(envelope),
pn_mfp,
};
}
return {
type: PubNubEventType.Files,
data: this.fileFromEnvelope(envelope),
pn_mfp,
};
});
return {
Expand Down Expand Up @@ -7413,12 +7437,10 @@
region: this.region ? this.region : undefined,
};
this.configuration.logger().debug('SubscriptionManager', () => {
const hashedEvents = messages.map((event) => {
const pn_mfp = event.type === PubNubEventType.Message || event.type === PubNubEventType.Signal
? messageFingerprint(event.data.message)
: undefined;
return pn_mfp ? { type: event.type, data: Object.assign(Object.assign({}, event.data), { pn_mfp }) } : event;
});
const hashedEvents = messages.map((event) => ({
type: event.type,
data: Object.assign(Object.assign({}, event.data), { pn_mfp: event.pn_mfp }),
}));
return { messageType: 'object', message: hashedEvents, details: 'Received events:' };
});
messages.forEach((message) => {
Expand Down Expand Up @@ -13009,7 +13031,7 @@
const logResponse = (response) => {
if (!response)
return;
this.logger.info('PubNub', `List channel group channels success. Received ${response.channels.length} channels.`);
this.logger.debug('PubNub', `List channel group channels success. Received ${response.channels.length} channels.`);
};
if (callback)
return this.sendRequest(request, (status, response) => {
Expand Down Expand Up @@ -13038,7 +13060,7 @@
const logResponse = (response) => {
if (!response)
return;
this.logger.info('PubNub', `List all channel groups success. Received ${response.groups.length} groups.`);
this.logger.debug('PubNub', `List all channel groups success. Received ${response.groups.length} groups.`);
};
if (callback)
return this.sendRequest(request, (status, response) => {
Expand Down Expand Up @@ -13069,7 +13091,7 @@
}));
const request = new AddChannelGroupChannelsRequest(Object.assign(Object.assign({}, parameters), { keySet: this.keySet }));
const logResponse = () => {
this.logger.info('PubNub', `Add channels to the channel group success.`);
this.logger.debug('PubNub', `Add channels to the channel group success.`);
};
if (callback)
return this.sendRequest(request, (status) => {
Expand Down Expand Up @@ -13101,7 +13123,7 @@
}));
const request = new RemoveChannelGroupChannelsRequest(Object.assign(Object.assign({}, parameters), { keySet: this.keySet }));
const logResponse = () => {
this.logger.info('PubNub', `Remove channels from the channel group success.`);
this.logger.debug('PubNub', `Remove channels from the channel group success.`);
};
if (callback)
return this.sendRequest(request, (status) => {
Expand Down Expand Up @@ -13132,7 +13154,7 @@
}));
const request = new DeleteChannelGroupRequest(Object.assign(Object.assign({}, parameters), { keySet: this.keySet }));
const logResponse = () => {
this.logger.info('PubNub', `Remove a channel group success. Removed '${parameters.channelGroup}' channel group.'`);
this.logger.debug('PubNub', `Remove a channel group success. Removed '${parameters.channelGroup}' channel group.'`);
};
if (callback)
return this.sendRequest(request, (status) => {
Expand Down Expand Up @@ -14516,7 +14538,7 @@
const logResponse = (response) => {
if (!response)
return;
this.logger.debug('PubNub', `Set UUID metadata object success. Updated '${parameters.uuid}' UUID metadata object.'`);
this.logger.debug('PubNub', `Set UUID metadata object success. Updated '${parameters.uuid}' UUID metadata object.`);
};
if (callback)
return this.sendRequest(request, (status, response) => {
Expand Down Expand Up @@ -14673,7 +14695,7 @@
const logResponse = (response) => {
if (!response)
return;
this.logger.debug('PubNub', `Get Channel metadata object success. Received '${parameters.channel}' Channel metadata object.'`);
this.logger.debug('PubNub', `Get Channel metadata object success. Received '${parameters.channel}' Channel metadata object.`);
};
if (callback)
return this.sendRequest(request, (status, response) => {
Expand Down Expand Up @@ -16858,6 +16880,8 @@
if ('channelGroups' in parameters) {
(_b = parameters.channelGroups) === null || _b === void 0 ? void 0 : _b.forEach((group) => (presenceState[group] = parameters.state));
}
if (this.onPresenceStateChange)
this.onPresenceStateChange(this.presenceState);
}
// Check whether the state should be set with heartbeat or not.
if ('withHeartbeat' in parameters && parameters.withHeartbeat) {
Expand All @@ -16872,8 +16896,11 @@
this.logger.debug('PubNub', `Set presence state success.${request instanceof HeartbeatRequest ? ' Presence state has been set using heartbeat endpoint.' : ''}`);
};
// Update state used by subscription manager.
if (this.subscriptionManager)
if (this.subscriptionManager) {
this.subscriptionManager.setState(parameters);
if (this.onPresenceStateChange)
this.onPresenceStateChange(this.subscriptionManager.presenceState);
}
if (callback)
return this.sendRequest(request, (status, response) => {
logResponse(response);
Expand Down Expand Up @@ -16943,8 +16970,7 @@
return callback(responseStatus, {});
return Promise.resolve(responseStatus);
}
const request = new HeartbeatRequest(Object.assign(Object.assign({}, parameters), { channels,
channelGroups, keySet: this._configuration.keySet }));
const request = new HeartbeatRequest(Object.assign(Object.assign({}, parameters), { channels: [...new Set(channels)], channelGroups: [...new Set(channelGroups)], keySet: this._configuration.keySet }));
const logResponse = (response) => {
if (!response)
return;
Expand Down Expand Up @@ -18246,6 +18272,7 @@
}
// Settings change handlers
let heartbeatIntervalChangeHandler = () => { };
let presenceStateChangeHandler = () => { };
let authenticationChangeHandler = () => { };
let userIdChangeHandler = () => { };
let cryptography;
Expand All @@ -18272,6 +18299,7 @@
transport,
logger: clientConfiguration.logger(),
});
presenceStateChangeHandler = (state) => middleware.onPresenceStateChange(state);
heartbeatIntervalChangeHandler = (interval) => middleware.onHeartbeatIntervalChange(interval);
authenticationChangeHandler = (auth) => middleware.onTokenChange(auth);
userIdChangeHandler = (userId) => middleware.onUserIdChange(userId);
Expand Down Expand Up @@ -18310,6 +18338,7 @@
});
this.onHeartbeatIntervalChange = heartbeatIntervalChangeHandler;
this.onAuthenticationChange = authenticationChangeHandler;
this.onPresenceStateChange = presenceStateChangeHandler;
this.onUserIdChange = userIdChangeHandler;
{
if (transport instanceof SubscriptionWorkerMiddleware) {
Expand Down
4 changes: 2 additions & 2 deletions dist/web/pubnub.min.js
View file
Open in desktop

Large diffs are not rendered by default.

Loading
Loading