Skip to content

docs(rokt): session management guidance for the kit - #821

Open
nickolas-dimitrakas wants to merge 1 commit into
rokt/kit-clear-session-on-identity-changefrom
rokt/kit-session-docs
Open

docs(rokt): session management guidance for the kit#821
nickolas-dimitrakas wants to merge 1 commit into
rokt/kit-clear-session-on-identity-changefrom
rokt/kit-session-docs

Conversation

@nickolas-dimitrakas

Copy link
Copy Markdown
Contributor

What

Kit README section documenting session management — the mParticle-side counterpart of the SDK docs in ROKT/rokt-sdk-ios#299:

  • the automatic identity-driven behaviour introduced in feat(rokt): forward MPRokt.clearSession to the Rokt SDK #819, as a transition table (anonymous→known keeps the session; a different known user or a logout ends it)
  • the recommended self-service-terminal pattern: log out (or identify the next customer) between transactions
  • the manual MPRokt.clearSession() escape hatch from feat(rokt): add MPRokt clearSession passthrough #818, when the new session begins, no-op/idempotency notes, and the collision-safety of combining manual + automatic
  • the caching recommendation for shared terminals

Docs only. Stacked on #819 — its base is that branch; retargets to the default branch cleanly once #819 lands.

🤖 Generated with Claude Code

@nickolas-dimitrakas
nickolas-dimitrakas requested a review from a team as a code owner August 20, 2026 19:24
@cursor

cursor Bot commented Aug 20, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation-only change to the Rokt kit README; no runtime or security behavior is modified.

Overview
Documents how the Rokt kit handles sessions: automatic identity-driven resets, the kiosk/shared-device pattern, and the optional clearSession() API.

Adds a Session management section to the kit README. It explains that anonymous→identified keeps the session, while a different user or logout ends it; recommends logging out or identifying the next customer between kiosk transactions; and notes that clearSession is a no-op without an active session, starts a new session only on the next selectPlacements, and should not be combined with experience caching on shared devices.

Reviewed by Cursor Bugbot for commit d97c61c. Bugbot is set up for automated code reviews on this repo. Configure here.

@github-actions

github-actions Bot commented Aug 20, 2026

Copy link
Copy Markdown

📦 SDK Size Impact Report

Measures how much the SDK adds to an app's size (with-SDK minus without-SDK).

Metric Target Branch This PR Change
App Bundle Impact 1.81 MB 1.81 MB +N/A
Executable Impact 848 bytes 848 bytes +N/A
XCFramework Size 6.51 MB 6.51 MB +N/A

➡️ SDK size impact change is minimal.

Raw measurements

Target branch (main):

{"baseline_app_size_kb":84,"baseline_executable_size_bytes":75464,"with_sdk_app_size_kb":1936,"with_sdk_executable_size_bytes":76312,"sdk_impact_kb":1852,"sdk_executable_impact_bytes":848,"xcframework_size_kb":6664}

This PR:

{"baseline_app_size_kb":84,"baseline_executable_size_bytes":75464,"with_sdk_app_size_kb":1936,"with_sdk_executable_size_bytes":76312,"sdk_impact_kb":1852,"sdk_executable_impact_bytes":848,"xcframework_size_kb":6664}

Documents the automatic identity-driven session behaviour (typed
transitions), the recommended kiosk pattern (logout between customers),
the manual MPRokt.clearSession escape hatch, and when the new session
begins.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants