Skip to content

PS-1280 [FIX] add Fliplet.encode and decode for query params#208

Merged
Arpanexe merged 4 commits intomasterfrom
fix/PS-1280
Oct 15, 2025
Merged

PS-1280 [FIX] add Fliplet.encode and decode for query params#208
Arpanexe merged 4 commits intomasterfrom
fix/PS-1280

Conversation

@farhantariq12b
Copy link
Copy Markdown
Contributor

@farhantariq12b farhantariq12b commented Oct 14, 2025

Product areas affected

Fliplet CLI

What does this PR do?

Added JS API's for helping Query params encoding and decoding.

JIRA ticket

PS-1280

Summary by CodeRabbit

  • Documentation
    • Added a new “Encoding URL” section covering double-encoding and double-decoding of URL query parameters.
    • Explains when to use encodeURI/decodeURI, with practical examples for building query strings, redirects and handling parameters.
    • Shows common inputs/outputs and edge cases to improve clarity and correct usage.
    • Confirms no functional or API surface changes.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Oct 14, 2025

Walkthrough

Added an "Encoding URL" section to docs/API/core/encode.md documenting double-encoding and double-decoding of URL query parameters using encodeURI and decodeURI, with examples. No functional code or public API changes.

Changes

Cohort / File(s) Summary
Docs: Encoding URL utilities
docs/API/core/encode.md
Added “Encoding URL” section detailing double-encoding and double-decoding of URL query parameters using encodeURI and decodeURI, with examples (e.g. my stringmy%2520string, decoding %2520/%20 to space).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title clearly summarises the primary change by stating the addition of Fliplet.encode and decode for query parameters, directly reflecting the new documentation and API functionality without being overly broad or including irrelevant details.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/PS-1280

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8b6e6ef and 76ee492.

📒 Files selected for processing (1)
  • docs/API/core/encode.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Codacy Static Code Analysis

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

@farhantariq12b farhantariq12b requested review from Arpanexe and removed request for debankurghosh2061 and veljko7 October 14, 2025 15:44
Comment thread docs/API/core/encode.md
Copy link
Copy Markdown

@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

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between acef1a9 and 87cd7aa.

📒 Files selected for processing (1)
  • docs/API/core/encode.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/API/core/encode.md

[uncategorized] ~12-~12: Possible missing article found.
Context: ...is used to doubly encode the url. So if browser is automatically parsing double encodin...

(AI_HYDRA_LEO_MISSING_THE)


[uncategorized] ~12-~12: Possible missing comma found.
Context: ...the url. So if browser is automatically parsing double encoding ensures that browser pa...

(AI_HYDRA_LEO_MISSING_COMMA)


[misspelling] ~12-~12: Did you mean “affect” (have an effect upon)?
Context: ...ng ensures that browser parsing doesn't effect the result. ```js var encodedUrl = Fli...

(AFFECT_EFFECT)


[misspelling] ~25-~25: Did you mean “affect” (have an effect upon)?
Context: ...ly decode the url. This method will not effect the decoded URL. Please see the example...

(AFFECT_EFFECT)

🪛 markdownlint-cli2 (0.18.1)
docs/API/core/encode.md

9-9: Trailing spaces
Expected: 0; Actual: 1

(MD009, no-trailing-spaces)


9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


10-10: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)


19-19: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)


24-24: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


32-32: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Codacy Static Code Analysis

Comment thread docs/API/core/encode.md Outdated
Comment thread docs/API/core/encode.md Outdated
Copy link
Copy Markdown

@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: 1

♻️ Duplicate comments (1)
docs/API/core/encode.md (1)

9-16: Fix heading spacing and grammar in the encode section.

Headings need blank lines, URL must be capitalised, and the copy should read clearly (“double-encodes”, “the browser”, “affect”). Please update this block accordingly.

Apply this diff:

-## Encoding URL 
-### Encode url query parameters
-
-This method is used to doubly encode the url. So if browser is automatically parsing double encoding ensures that browser parsing doesn't effect the result.
+## Encoding URL
+
+### Encode URL query parameters
+
+This method double-encodes the URL. If the browser automatically parses the query string, double encoding ensures that parsing does not affect the result.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 87cd7aa and 962049e.

📒 Files selected for processing (1)
  • docs/API/core/encode.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/API/core/encode.md

[uncategorized] ~12-~12: Possible missing article found.
Context: ...is used to doubly encode the url. So if browser is automatically parsing double encodin...

(AI_HYDRA_LEO_MISSING_THE)


[uncategorized] ~12-~12: Possible missing comma found.
Context: ...the url. So if browser is automatically parsing double encoding ensures that browser pa...

(AI_HYDRA_LEO_MISSING_COMMA)


[misspelling] ~12-~12: Did you mean “affect” (have an effect upon)?
Context: ...ng ensures that browser parsing doesn't effect the result. ```js var encodedUrl = Fli...

(AFFECT_EFFECT)


[misspelling] ~60-~60: Did you mean “affect” (have an effect upon)?
Context: ...ly decode the url. This method will not effect the decoded URL. Please see the example...

(AFFECT_EFFECT)

🪛 markdownlint-cli2 (0.18.1)
docs/API/core/encode.md

9-9: Trailing spaces
Expected: 0; Actual: 1

(MD009, no-trailing-spaces)


9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


10-10: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)


20-20: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


21-21: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)


31-31: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


32-32: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)


42-42: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


43-43: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)


59-59: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


66-66: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


67-67: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)


77-77: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


78-78: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)


92-92: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


93-93: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)


113-113: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


114-114: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Codacy Static Code Analysis

Comment thread docs/API/core/encode.md Outdated
Comment thread docs/API/core/encode.md Outdated
Copy link
Copy Markdown

@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

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 962049e and 8b6e6ef.

📒 Files selected for processing (1)
  • docs/API/core/encode.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/API/core/encode.md

[uncategorized] ~12-~12: Possible missing article found.
Context: ...is used to doubly encode the url. So if browser is automatically parsing double encodin...

(AI_HYDRA_LEO_MISSING_THE)


[uncategorized] ~12-~12: Possible missing comma found.
Context: ...the url. So if browser is automatically parsing double encoding ensures that browser pa...

(AI_HYDRA_LEO_MISSING_COMMA)


[misspelling] ~12-~12: Did you mean “affect” (have an effect upon)?
Context: ...ng ensures that browser parsing doesn't effect the result. ```js var encodedUrl = Fli...

(AFFECT_EFFECT)


[misspelling] ~60-~60: Did you mean “affect” (have an effect upon)?
Context: ...ly decode the url. This method will not effect the decoded URL. Please see the example...

(AFFECT_EFFECT)

🪛 markdownlint-cli2 (0.18.1)
docs/API/core/encode.md

9-9: Trailing spaces
Expected: 0; Actual: 1

(MD009, no-trailing-spaces)


9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


10-10: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above

(MD022, blanks-around-headings)


20-20: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


21-21: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)


31-31: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


32-32: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)


42-42: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


43-43: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)


59-59: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


66-66: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


67-67: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)


77-77: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


78-78: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)


92-92: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


93-93: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Codacy Static Code Analysis

Comment thread docs/API/core/encode.md Outdated
Comment thread docs/API/core/encode.md Outdated
Copy link
Copy Markdown
Contributor

@Arpanexe Arpanexe left a comment

Choose a reason for hiding this comment

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

LGTM

@Arpanexe Arpanexe merged commit b8cf4a6 into master Oct 15, 2025
2 of 3 checks passed
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