Skip to content

fix: Update code to infer Vercel URL for WorkOS redirect#3061

Merged
perkinsjr merged 7 commits intomainfrom
fix-base-url
Mar 31, 2025
Merged

fix: Update code to infer Vercel URL for WorkOS redirect#3061
perkinsjr merged 7 commits intomainfrom
fix-base-url

Conversation

@mcstepp
Copy link
Collaborator

@mcstepp mcstepp commented Mar 31, 2025

What does this PR do?

Fixes linear ENG-1694

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • Manual testing of trpc routes
  • Manual testing on local and vercel staging environments

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features

    • Added a shared utility to determine the application’s base URL reliably in different environments.
  • Refactor

    • Updated authentication flows to use the centralized base URL utility, simplifying redirection handling.
    • Streamlined OAuth options by removing redundant parameters.
  • Style

    • Improved formatting of authentication methods for enhanced readability.

@changeset-bot
Copy link

changeset-bot bot commented Mar 31, 2025

⚠️ No Changeset found

Latest commit: 1cc3bce

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@vercel
Copy link

vercel bot commented Mar 31, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 31, 2025 6:21pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 31, 2025 6:21pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 31, 2025 6:21pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 31, 2025 6:21pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 31, 2025

📝 Walkthrough

Walkthrough

This pull request refactors how the application derives its base URL by extracting the logic into a dedicated getBaseUrl function in the utilities module. The change replaces inline URL parsing in the SSO callback and TRPC server with calls to this new function. Additionally, it adjusts the WorkOS OAuth sign‐in flow to utilize the centralized function for constructing redirect URLs, removes an optional property from an OAuth options interface, and cleans up minor formatting inconsistencies.

Changes

Files Change Summary
apps/dashboard/app/auth/sso-callback/[[...sso-callback]]/route.ts,
apps/dashboard/lib/trpc/server.ts,
apps/dashboard/lib/utils.ts
Base URL Refactoring: Replaces inline derivation of the base URL with calls to getBaseUrl(). Removes the local getBaseUrl function from the TRPC server and adds a new implementation in the utilities module.
apps/dashboard/app/auth/sign-in/oauth-signin.tsx Removes an unnecessary blank line within the oauthSignIn function.
apps/dashboard/lib/auth/types.ts Removes the optional redirectUrl property from the SignInViaOAuthOptions interface.
apps/dashboard/lib/auth/workos.ts Reformats method signatures for improved readability and updates the signInViaOAuth method to use getBaseUrl() for constructing the redirect URL instead of inline logic.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant SSO_Route as SSO Callback Route
    participant Utils
    Client ->> SSO_Route: GET request
    SSO_Route ->> Utils: getBaseUrl()
    Utils -->> SSO_Route: base URL
    SSO_Route ->> Client: Respond with base URL-based data
Loading
sequenceDiagram
    participant Client
    participant WorkOS as WorkOSAuthProvider
    participant Utils
    Client ->> WorkOS: Initiate signInViaOAuth()
    WorkOS ->> Utils: getBaseUrl()
    Utils -->> WorkOS: base URL
    WorkOS ->> Client: Redirect with URL built using base URL
Loading

Possibly related PRs

Suggested labels

Bug, 🕹️ oss.gg, :joystick: 150 points

Suggested reviewers

  • mcstepp
  • chronark
  • ogzhanolguncu

📜 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 215e1b2 and 84b6094.

📒 Files selected for processing (1)
  • apps/dashboard/lib/auth/workos.ts (6 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/dashboard/lib/auth/workos.ts

🪧 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 31, 2025

Thank you for following the naming conventions for pull request titles! 🙏

Copy link
Member

@perkinsjr perkinsjr left a comment

Choose a reason for hiding this comment

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

Changes needed here I am pushing them up

Copy link
Contributor

@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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 714454e and 215e1b2.

📒 Files selected for processing (4)
  • apps/dashboard/app/auth/sign-in/oauth-signin.tsx (0 hunks)
  • apps/dashboard/app/auth/sign-up/oauth-signup.tsx (2 hunks)
  • apps/dashboard/lib/auth/types.ts (0 hunks)
  • apps/dashboard/lib/auth/workos.ts (6 hunks)
💤 Files with no reviewable changes (2)
  • apps/dashboard/lib/auth/types.ts
  • apps/dashboard/app/auth/sign-in/oauth-signin.tsx
🧰 Additional context used
🧬 Code Definitions (1)
apps/dashboard/lib/auth/workos.ts (1)
apps/dashboard/lib/auth/types.ts (1)
  • VerificationResult (78-81)
🪛 Biome (1.9.4)
apps/dashboard/app/auth/sign-up/oauth-signup.tsx

[error] 16-16: This variable is unused.

Unused variables usually are result of incomplete refactoring, typos and other source of bugs.
Unsafe fix: If this is intentional, prepend baseUrl with an underscore.

(lint/correctness/noUnusedVariables)

🪛 GitHub Actions: autofix.ci
apps/dashboard/app/auth/sign-up/oauth-signup.tsx

[warning] 16-16: lint/correctness/noUnusedVariables: This variable is unused. Unsafe fix: If this is intentional, prepend baseUrl with an underscore.

⏰ Context from checks skipped due to timeout of 90000ms (14)
  • GitHub Check: Test Go API Local / Test (Shard 5/8)
  • GitHub Check: Test Go API Local / Test (Shard 2/8)
  • GitHub Check: Test Go API Local / Test (Shard 6/8)
  • GitHub Check: Test Go API Local / Test (Shard 7/8)
  • GitHub Check: Test Packages / Test ./packages/nextjs
  • GitHub Check: Test Packages / Test ./packages/cache
  • GitHub Check: Test Go API Local / Test (Shard 4/8)
  • GitHub Check: Test Packages / Test ./packages/hono
  • GitHub Check: Test Packages / Test ./packages/api
  • GitHub Check: Test Packages / Test ./internal/encryption
  • GitHub Check: Build / Build
  • GitHub Check: Test API / API Test Local
  • GitHub Check: Test Agent Local / test_agent_local
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (3)
apps/dashboard/lib/auth/workos.ts (3)

7-7: Good implementation of dynamic base URL detection

The code now dynamically infers the base URL using the centralized getBaseUrl() function instead of relying on hardcoded values or environment variables, which makes the code more robust across different environments (local, Vercel, etc.).

Also applies to: 784-785, 788-788


196-199: Improved code formatting for method signatures

You've improved the formatting of several method signatures to make them more readable with consistent line breaks and indentation, which is a good practice.

Also applies to: 227-229, 462-465, 655-658


782-782:

Details

❓ Verification inconclusive

Parameter removed from destructuring without changing interface

You've removed redirectUrl from the destructuring of options, but it might still be part of the SignInViaOAuthOptions interface. If this parameter is no longer needed, consider updating the interface definition as well to avoid confusion.


🏁 Script executed:

#!/bin/bash
# Check if redirectUrl is still part of SignInViaOAuthOptions interface
rg -A 10 "type SignInViaOAuthOptions" --type=typescript

Length of output: 92


Below is an updated review comment. It now asks for verification using a corrected shell command with the proper file type filter for TypeScript.


Action: Verify if redirectUrl still appears in the SignInViaOAuthOptions interface

It looks like the earlier command didn’t work because of the incorrect file type flag. Please run the following command to double-check whether redirectUrl is still included in the interface. If it is present and no longer needed, remember to update the interface accordingly.

#!/bin/bash
# Check if redirectUrl is still part of SignInViaOAuthOptions interface using the correct file type filter for TypeScript
rg -A 10 "interface SignInViaOAuthOptions" --type ts

I don't trust Vercel
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