Skip to content

Conversation

@1egoman
Copy link
Contributor

@1egoman 1egoman commented Jan 27, 2026

Updates the setKey function docs to make it clear that HKDF isn't supported by other client sdk platforms.

Closes #1791

Summary by CodeRabbit

  • Documentation
    • Clarified encryption key-derivation guidance and recommended PBKDF2 for broad compatibility
    • Noted that HKDF may not be supported by all client SDKs
    • Added a patch-level documentation entry for the livekit-client package
    • Documentation-only update; no public API or runtime behavior changes

✏️ Tip: You can customize this high-level summary in your review settings.

@changeset-bot
Copy link

changeset-bot bot commented Jan 27, 2026

🦋 Changeset detected

Latest commit: ffb628d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
livekit-client Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai
Copy link

coderabbitai bot commented Jan 27, 2026

📝 Walkthrough

Walkthrough

Documentation-only changes: added a changeset for livekit-client and clarified JSDoc for ExternalE2EEKeyProvider.setKey() to note PBKDF2 usage for strings and that HKDF is not supported by all client SDKs. No runtime or public API changes.

Changes

Cohort / File(s) Summary
Changelog documentation
.changeset/slow-dingos-look.md
Added a patch-level changeset for livekit-client documenting the patch and noting HKDF support clarification.
Key derivation algorithm documentation
src/e2ee/KeyProvider.ts
Updated JSDoc for ExternalE2EEKeyProvider.setKey(): clarified PBKDF2 for string input, reworded HKDF description for ArrayBuffer input, and added a note that not all client SDKs support HKDF.

Sequence Diagram(s)

(Skipped — changes are documentation-only and do not introduce new multi-component control flow.)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped through lines of docs today,

PBKDF2 and HKDF in tidy array,
A tiny note, a clearer say,
I thump my feet and bound away,
Carrot crumbs and code hooray!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: updating documentation to clarify that HKDF isn't supported by other client SDKs.
Linked Issues check ✅ Passed The PR directly addresses issue #1791 by clarifying in documentation that HKDF is not supported by other client SDKs, answering the interoperability concern.
Out of Scope Changes check ✅ Passed All changes are in-scope: the changeset documents the patch and the KeyProvider.ts updates clarify HKDF support documentation as required.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 24394c7 and ffb628d.

📒 Files selected for processing (1)
  • src/e2ee/KeyProvider.ts

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 27, 2026

size-limit report 📦

Path Size
dist/livekit-client.esm.mjs 85.5 KB (0%)
dist/livekit-client.umd.js 94.3 KB (0%)

@1egoman 1egoman changed the title Update docs to clarify other client client HKDF support Update docs to clarify other client HKDF support Jan 27, 2026
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In @.changeset/slow-dingos-look.md:
- Line 5: Fix the typo in the changelog sentence that reads "client client HKDF
support" by removing the duplicated word so it reads "client HKDF support";
locate the phrase "client client HKDF support" in the
.changeset/slow-dingos-look.md content and update it to "client HKDF support".

In `@src/e2ee/KeyProvider.ts`:
- Around line 94-97: Update the JSDoc in KeyProvider.ts to fix minor text
consistency: change "Array buffer" to "ArrayBuffer" and "client sdks" to "client
SDKs" in the comment block above the relevant KeyProvider methods (look for the
comment mentioning PBKDF2 and HKDF within the KeyProvider class or functions
that accept string vs ArrayBuffer keys) so the terminology matches the
TypeScript types and standard acronym capitalization.
📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1744ee4 and c369723.

📒 Files selected for processing (2)
  • .changeset/slow-dingos-look.md
  • src/e2ee/KeyProvider.ts

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

Copy link
Contributor

@xianshijing-lk xianshijing-lk left a comment

Choose a reason for hiding this comment

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

two nits

@1egoman 1egoman merged commit 64ef4ce into main Jan 27, 2026
7 checks passed
@1egoman 1egoman deleted the rg/e2ee-docs branch January 27, 2026 19:59
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.

E2E Encryption nodejs and python sdk

4 participants