Skip to content

Calling .leave request when unsubscribing #180

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
Jun 18, 2024
Merged

Calling .leave request when unsubscribing #180

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
a50ca7b
Calling .leave request after unsubscribing
jguz-pubnub Jun 17, 2024
fdcfd3c
Codacy warning
jguz-pubnub Jun 17, 2024
4ba7413
PubNub SDK 7.3.1 release.
pubnub-release-bot Jun 18, 2024
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
9 changes: 7 additions & 2 deletions .pubnub.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
---
name: swift
scm: github.com/pubnub/swift
version: "7.3.0"
version: "7.3.1"
schema: 1
changelog:
- date: 2024-06-18
version: 7.3.1
changes:
- type: bug
text: "Calling .leave request in missing cases."
- date: 2024-06-12
version: 7.3.0
changes:
Expand Down Expand Up @@ -554,7 +559,7 @@ sdks:
- distribution-type: source
distribution-repository: GitHub release
package-name: PubNub
location: https://github.com/pubnub/swift/archive/refs/tags/7.3.0.zip
location: https://github.com/pubnub/swift/archive/refs/tags/7.3.1.zip
supported-platforms:
supported-operating-systems:
macOS:
Expand Down
16 changes: 8 additions & 8 deletions PubNub.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3847,7 +3847,7 @@
"@loader_path/Frameworks",
);
MACOSX_DEPLOYMENT_TARGET = 10.15;
MARKETING_VERSION = 7.3.0;
MARKETING_VERSION = 7.3.1;
MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu11 gnu++17";
MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE;
MTL_FAST_MATH = YES;
Expand Down Expand Up @@ -3898,7 +3898,7 @@
"@loader_path/Frameworks",
);
MACOSX_DEPLOYMENT_TARGET = 10.15;
MARKETING_VERSION = 7.3.0;
MARKETING_VERSION = 7.3.1;
MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu11 gnu++17";
MTL_ENABLE_DEBUG_INFO = NO;
MTL_FAST_MATH = YES;
Expand Down Expand Up @@ -4006,7 +4006,7 @@
"@loader_path/Frameworks",
);
MACOSX_DEPLOYMENT_TARGET = 10.15;
MARKETING_VERSION = 7.3.0;
MARKETING_VERSION = 7.3.1;
MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu11 gnu++17";
MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE;
MTL_FAST_MATH = YES;
Expand Down Expand Up @@ -4059,7 +4059,7 @@
"@loader_path/Frameworks",
);
MACOSX_DEPLOYMENT_TARGET = 10.15;
MARKETING_VERSION = 7.3.0;
MARKETING_VERSION = 7.3.1;
MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu11 gnu++17";
MTL_ENABLE_DEBUG_INFO = NO;
MTL_FAST_MATH = YES;
Expand Down Expand Up @@ -4180,7 +4180,7 @@
"@loader_path/Frameworks",
);
MACOSX_DEPLOYMENT_TARGET = 10.15;
MARKETING_VERSION = 7.3.0;
MARKETING_VERSION = 7.3.1;
MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu11 gnu++17";
MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE;
MTL_FAST_MATH = YES;
Expand Down Expand Up @@ -4232,7 +4232,7 @@
"@loader_path/Frameworks",
);
MACOSX_DEPLOYMENT_TARGET = 10.15;
MARKETING_VERSION = 7.3.0;
MARKETING_VERSION = 7.3.1;
MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu11 gnu++17";
MTL_ENABLE_DEBUG_INFO = NO;
MTL_FAST_MATH = YES;
Expand Down Expand Up @@ -4712,7 +4712,7 @@
"$(TOOLCHAIN_DIR)/usr/lib/swift/macosx",
);
MACOSX_DEPLOYMENT_TARGET = 10.15;
MARKETING_VERSION = 7.3.0;
MARKETING_VERSION = 7.3.1;
MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu17 gnu++14";
OTHER_CFLAGS = "$(inherited)";
OTHER_LDFLAGS = "$(inherited)";
Expand Down Expand Up @@ -4754,7 +4754,7 @@
"$(TOOLCHAIN_DIR)/usr/lib/swift/macosx",
);
MACOSX_DEPLOYMENT_TARGET = 10.15;
MARKETING_VERSION = 7.3.0;
MARKETING_VERSION = 7.3.1;
MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu17 gnu++14";
OTHER_CFLAGS = "$(inherited)";
OTHER_LDFLAGS = "$(inherited)";
Expand Down
2 changes: 1 addition & 1 deletion PubNubSwift.podspec
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'PubNubSwift'
s.version = '7.3.0'
s.version = '7.3.1'
s.homepage = 'https://github.com/pubnub/swift'
s.documentation_url = 'https://www.pubnub.com/docs/swift-native/pubnub-swift-sdk'
s.authors = { 'PubNub, Inc.' => 'support@pubnub.com' }
Expand Down
19 changes: 11 additions & 8 deletions Sources/PubNub/EventEngine/Presence/PresenceTransition.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ class PresenceTransition: TransitionProtocol {
case .joined:
return configuration.heartbeatInterval > 0
case .left:
return !(state is Presence.HeartbeatInactive)
return true
case .heartbeatSuccess:
return state is Presence.Heartbeating
case .heartbeatFailed:
return state is Presence.Heartbeating
case .timesUp:
return state is Presence.HeartbeatCooldown
case .leftAll:
return !(state is Presence.HeartbeatInactive)
return true
Copy link
Contributor

@parfeon parfeon Jun 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, we want to transit even if heartbeat loop is not active?

Copy link
Contributor Author

@jguz-pubnub jguz-pubnub Jun 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. You're right, the heartbeat loop is inactive if the user subscribes to some channel without Presence. However, we still have to trigger .leave invocation as a part of the unsubscribe cleanup

case .disconnect:
return !(state is Presence.HeartbeatInactive)
case .reconnect:
Expand Down Expand Up @@ -120,19 +120,22 @@ fileprivate extension PresenceTransition {
channels: leaving.channels,
groups: leaving.groups
)
let invocations = configuration.supressLeaveEvents ? [] : [
EffectInvocation.regular(Presence.Invocation.leave(
channels: leaving.channels,
groups: leaving.groups
))
]

if state is Presence.HeartbeatStopped {
return TransitionResult(
state: Presence.HeartbeatStopped(input: newInput),
invocations: []
invocations: invocations
)
} else {
let leaveInvocation = EffectInvocation.regular(Presence.Invocation.leave(
channels: leaving.channels,
groups: leaving.groups
))
return TransitionResult(
state: newInput.isEmpty ? Presence.HeartbeatInactive() : Presence.Heartbeating(input: newInput),
invocations: configuration.supressLeaveEvents ? [] : [leaveInvocation]
invocations: invocations
)
}
}
Expand Down
2 changes: 1 addition & 1 deletion Sources/PubNub/Helpers/Constants.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public enum Constant {

static let pubnubSwiftSDKName: String = "PubNubSwift"

static let pubnubSwiftSDKVersion: String = "7.3.0"
static let pubnubSwiftSDKVersion: String = "7.3.1"

static let appBundleId: String = {
if let info = Bundle.main.infoDictionary,
Expand Down
22 changes: 21 additions & 1 deletion Tests/PubNubTests/EventEngine/Presence/PresenceTransitionTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,9 +200,12 @@ class PresenceTransitionTests: XCTestCase {
let expectedState = Presence.HeartbeatStopped(
input: PresenceInput(channels: ["c1", "c2"], groups: ["g1", "g2"])
)
let expectedInvocations: [EffectInvocation<Presence.Invocation>] = [
.regular(.leave(channels: ["c3"], groups: ["g3"])),
]

XCTAssertTrue(results.state.isEqual(to: expectedState))
XCTAssertTrue(results.invocations.isEmpty)
XCTAssertTrue(results.invocations.elementsEqual(expectedInvocations))
}

func testPresence_LeftEventForCooldownState() {
Expand Down Expand Up @@ -294,6 +297,23 @@ class PresenceTransitionTests: XCTestCase {
XCTAssertTrue(results.invocations.elementsEqual(expectedInvocations))
}

func testPresence_LeftAllForHeartbeatStoppedState() {
let input = PresenceInput(
channels: ["c1", "c2"],
groups: ["g1", "g2"]
)
let results = transition.transition(
from: Presence.HeartbeatStopped(input: input),
event: .leftAll
)
let expectedInvocations: [EffectInvocation<Presence.Invocation>] = [
.regular(.leave(channels: ["c1", "c2"], groups: ["g1", "g2"]))
]

XCTAssertTrue(results.state.isEqual(to: Presence.HeartbeatInactive()))
XCTAssertTrue(results.invocations.elementsEqual(expectedInvocations))
}

func testPresence_LeftAllForCooldownState() {
let input = PresenceInput(
channels: ["c1", "c2"],
Expand Down