[ECO-4995] Fix base64 url encoding/decoding #43

sacOO7 · 2024-09-24T11:38:16Z

Fixed Fix base64 decode ably/laravel-broadcaster#51
Server sends base64 url encoded JWT, parser needs to use base64 url decoding, instead of normal base64 decoding.
https://gist.github.com/tatsuyasusukida/ce71456081748242a0bd4cbfcfe44eb7

Summary by CodeRabbit

New Features
- Introduced new helper functions for base64 URL encoding and decoding.
Bug Fixes
- Updated the socketId method to return a base64 URL encoded JSON string for improved consistency.
Documentation
- Revised documentation for the socketId method to reflect the change to base64 URL encoding.

coderabbitai · 2024-09-24T11:38:26Z

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve updates to the JWT parsing and encoding functions in the src/channel/ably/utils.ts file, introducing new helper functions for base64 URL encoding and decoding. The socketId method in src/connector/ably-connector.ts has been modified to utilize the new encoding method, while the documentation in src/echo.ts has been updated to reflect these changes. Overall, the modifications ensure consistent handling of base64 URL encoding across the codebase.

Changes

File	Change Summary
src/channel/ably/utils.ts	Updated JWT parsing and encoding functions; added `fromBase64UrlEncoded` and `toBase64UrlEncoded` helper functions.
src/connector/ably-connector.ts	Modified `socketId` method to return a base64 URL encoded JSON string instead of standard base64.
src/echo.ts	Updated documentation comment for `socketId` method to reflect base64 URL encoding.

Assessment against linked issues

Objective	Addressed	Explanation
Fix base64 decode ( laravel#51 )	✅

🐇 In the meadow, I hop with glee,
Base64 URL, as sweet as can be!
Functions updated, all in a row,
Encoding and decoding, watch them flow!
With each little change, our code's a delight,
Hooray for the updates, all shining and bright! 🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

src/channel/ably/utils.ts

…ded strings

sacOO7 · 2024-09-24T11:59:54Z

src/channel/ably/utils.ts

 export const toText = (base64: string) => {
+    const base64Encoded = base64.replace(/-/g, '+').replace(/_/g, '/');
+    const padding = base64.length % 4 === 0 ? '' : '='.repeat(4 - (base64.length % 4));


Not sure if we really need to add padding as per
https://gist.github.com/tatsuyasusukida/ce71456081748242a0bd4cbfcfe44eb7

I believe padding it's not necessary, message will be decoded without padding, but I think it's better to keep it, since padding is a part of base64 spec

thanks, this is helpful

src/channel/ably/utils.ts

ttypic · 2024-09-24T13:15:02Z

src/channel/ably/utils.ts

 export const toText = (base64: string) => {
+    const base64Encoded = base64.replace(/-/g, '+').replace(/_/g, '/');
+    const padding = base64.length % 4 === 0 ? '' : '='.repeat(4 - (base64.length % 4));


I believe padding it's not necessary, message will be decoded without padding, but I think it's better to keep it, since padding is a part of base64 spec

…r review comment

github-advanced-security bot found potential problems Sep 24, 2024

View reviewed changes

src/channel/ably/utils.ts Dismissed Show dismissed Hide dismissed

sacOO7 requested review from AndyTWF, VeskeR, owenpearson and lmars September 24, 2024 11:49

sacOO7 changed the title ~~Fix base64 url encoding~~ Fix base64 url encoding/decoding Sep 24, 2024

Modified toText and toBase64 helper methods to handle base64 url enco…

adfc1b7

…ded strings

sacOO7 force-pushed the fix/base64-url-encoding branch from 3e22022 to adfc1b7 Compare September 24, 2024 11:51

sacOO7 requested a review from ttypic September 24, 2024 11:53

sacOO7 commented Sep 24, 2024

View reviewed changes

sacOO7 marked this pull request as ready for review September 24, 2024 12:07

sacOO7 changed the title ~~Fix base64 url encoding/decoding~~ [ECO-4995] Fix base64 url encoding/decoding Sep 24, 2024

ttypic reviewed Sep 24, 2024

View reviewed changes

Refactored helper methods with names containing base64UrlEncode as pe…

3076d16

…r review comment

sacOO7 merged commit 0cfd258 into fix/broadcast-to-others Sep 25, 2024
1 of 4 checks passed

coderabbitai bot mentioned this pull request Sep 25, 2024

[ECO-4977] Fix broadcast to others #42

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ECO-4995] Fix base64 url encoding/decoding #43

[ECO-4995] Fix base64 url encoding/decoding #43

sacOO7 commented Sep 24, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 24, 2024 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

sacOO7 Sep 24, 2024

ttypic Sep 24, 2024

sacOO7 Sep 25, 2024

ttypic Sep 24, 2024

[ECO-4995] Fix base64 url encoding/decoding #43

[ECO-4995] Fix base64 url encoding/decoding #43

Conversation

sacOO7 commented Sep 24, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Sep 24, 2024 • edited Loading

Review failed

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

sacOO7 Sep 24, 2024

Choose a reason for hiding this comment

ttypic Sep 24, 2024

Choose a reason for hiding this comment

sacOO7 Sep 25, 2024

Choose a reason for hiding this comment

ttypic Sep 24, 2024

Choose a reason for hiding this comment

sacOO7 commented Sep 24, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 24, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)