Skip to content

[TA-4743]: auth0 & custom backend integration pages#31

Merged
AdriaCarrera merged 3 commits intomainfrom
docs/feat/integration-pages
Aug 5, 2025
Merged

[TA-4743]: auth0 & custom backend integration pages#31
AdriaCarrera merged 3 commits intomainfrom
docs/feat/integration-pages

Conversation

@GuillemGarciaDev
Copy link
Collaborator

@GuillemGarciaDev GuillemGarciaDev commented Aug 5, 2025

[TA-4743]: add auth0 & custom backend integration pages

Changes 🛠️

docs

  • Add auth0 integration page
  • Add custom-backend integration page

examples/spa

  • Fix vite-plugin-node-polyfills dependency version

Summary by CodeRabbit

  • Documentation

    • Expanded and restructured the Auth0 integration guide with detailed setup, configuration, security recommendations, and troubleshooting instructions.
    • Rewrote the custom backend integration guide, providing comprehensive steps for JWT claims, guard contract customization, deployment, registration, SDK usage, and provider implementation.
    • Updated sidebar navigation by removing specific guide and integration entries.
  • Chores

    • Updated package dependencies in example projects, moving and upgrading a polyfill plugin.
    • Removed the package manager version specification from the project configuration.
    • Updated GitHub Actions workflows to use the latest version of the pnpm setup action.

@notion-workspace
Copy link

[docs] integrations page

@coderabbitai
Copy link

coderabbitai bot commented Aug 5, 2025

📝 Walkthrough

Walkthrough

The documentation for Auth0 and custom backend integrations was completely rewritten, transforming placeholder notes into comprehensive step-by-step guides. The sidebar configuration was updated by commenting out and removing certain entries. Minor dependency and configuration changes were made in example and root package.json files.

Changes

Cohort / File(s) Change Summary
Auth0 Integration Documentation
docs/docs/integrations/auth0.md
Replaced placeholder with a detailed guide covering Auth0 integration, setup, configuration, security, and troubleshooting for FastAuth.
Custom Backend Integration Documentation
docs/docs/integrations/custom-backend.md
Replaced placeholder with a comprehensive manual on integrating FastAuth with custom backends, JWT requirements, guard contract customization, registration, SDK usage, and provider interface. Introduces new TypeScript and Rust interface/struct documentation.
Sidebar Configuration
docs/sidebars.ts
Commented out the "Guides" section and browser SDK integration entry; removed "integrations/jwt-rs256-guard" from the integrations sidebar.
Example SPA Dependency Update
examples/spa/package.json
Moved "vite-plugin-node-polyfills" from dependencies to devDependencies and updated its version.
Root Package Manager Configuration
package.json
Removed the specification of the package manager version (pnpm@9.14.2).
GitHub Actions Workflow Updates
.github/workflows/deploy-docs.yaml, .github/workflows/deploy-docs-test.yaml
Updated pnpm/action-setup action version from 8 to 9 in both documentation deployment workflows.

Sequence Diagram(s)

No sequence diagrams generated, as changes are limited to documentation and configuration.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested reviewers

  • AdriaCarrera

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a44d069 and fdda4ad.

📒 Files selected for processing (2)
  • .github/workflows/deploy-docs-test.yaml (1 hunks)
  • .github/workflows/deploy-docs.yaml (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • .github/workflows/deploy-docs-test.yaml
  • .github/workflows/deploy-docs.yaml
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/feat/integration-pages

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
  • 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 explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this 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.

@GuillemGarciaDev GuillemGarciaDev changed the title [TA-4743]: add auth0 & custom backend integration pages [TA-4743]: auth0 & custom backend integration pages Aug 5, 2025
@socket-security
Copy link

socket-security bot commented Aug 5, 2025

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Updated@​types/​node@​24.1.0 ⏵ 24.2.0100 +110080 +196100

View full report

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

🧹 Nitpick comments (4)
docs/sidebars.ts (1)

52-57: Commented-out items linger; delete or document TODO

Dead code in configuration files tends to become stale and confuses new contributors. If the “Guides” section is intentionally dropped, remove the commented block or add a TODO with a ticket reference.

docs/docs/integrations/auth0.md (1)

33-50: Replace bold text used as section titles with proper headings (MD036)

Markdown-lint flags **Allowed Callback URLs:**, **Allowed Logout URLs:**, **Allowed Web Origins:**. Use heading syntax for accessibility and sidebar generation.

-**Allowed Callback URLs:**
+### Allowed Callback URLs-**Allowed Logout URLs:**
+### Allowed Logout URLs-**Allowed Web Origins:**
+### Allowed Web Origins
docs/docs/integrations/custom-backend.md (2)

46-52: Headings, not bold, for claim sections (MD036)

The same bold-as-heading pattern appears here; convert to ### to satisfy linters and improve navigation.


103-106: Use constant-time comparison for JWT payloads

if claims.fatxn != sign_payload { … } performs a byte-wise early-exit comparison susceptible to timing analysis. For cryptographic material, recommend subtle::ConstantTimeEq (or similar) to avoid leaking equality information.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c9bbb3a and a44d069.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (5)
  • docs/docs/integrations/auth0.md (1 hunks)
  • docs/docs/integrations/custom-backend.md (1 hunks)
  • docs/sidebars.ts (1 hunks)
  • examples/spa/package.json (2 hunks)
  • package.json (0 hunks)
💤 Files with no reviewable changes (1)
  • package.json
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: in the @frontend/price-service package, it's important to export the data-access layer modules (like...
Learnt from: JordiParraCrespo
PR: Peersyst/near-mobile#190
File: packages/frontend/price-service/package.json:18-25
Timestamp: 2025-04-17T02:49:42.537Z
Learning: In the @frontend/price-service package, it's important to export the data-access layer modules (like price-service and errors) in the package.json exports configuration to enable other packages to use them when needed.

Applied to files:

  • docs/sidebars.ts
🪛 markdownlint-cli2 (0.17.2)
docs/docs/integrations/custom-backend.md

68-68: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


92-92: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


120-120: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


136-136: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


141-141: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

⏰ 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: integration-packages / Build
🔇 Additional comments (3)
examples/spa/package.json (1)

24-25: Verify CI installs devDependencies before running the build

Vite plugins (including vite-plugin-node-polyfills) are applied at build time. If your CI invokes npm ci --production or omits devDependencies, those polyfills won’t be included in the production bundle and may cause runtime errors in the browser.

Please confirm your CI pipeline installs devDependencies prior to calling vite build. For example:

  • Check your .github/workflows/* (or other CI config files like .gitlab-ci.yml, Jenkinsfile, azure-pipelines.yml) for any npm ci, npm install, or npm run build steps.
  • Ensure they do not include --production or set NODE_ENV=production before installing.
  • Verify that the build step is executed after all dependencies (including devDependencies) are installed.
docs/docs/integrations/auth0.md (1)

15-18: Broken relative link risk

[FastAuth Browser SDK](../sdk/browser/getting-started.md) climbs only one level, resulting in docs/sdk/..., while the correct path from docs/integrations is ../sdk/browser/getting-started.md or ../../sdk/browser/getting-started.md depending on your Docusaurus docs root. Please verify the link renders.

docs/docs/integrations/custom-backend.md (1)

138-147: Confirm attached deposit value in registration example

--deposit 1.03 is unusually high for a router metadata call and may mislead users. Typical guard registration on testnet needs ≈ 1 NEAR plus gas. Verify the exact amount and update the snippet.

@Peersyst Peersyst deleted a comment from coderabbitai bot Aug 5, 2025
@AdriaCarrera AdriaCarrera merged commit bfdc7b3 into main Aug 5, 2025
5 of 6 checks passed
@AdriaCarrera AdriaCarrera deleted the docs/feat/integration-pages branch August 5, 2025 11:35
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

Comments