Standardize url building using urlbuilders utility

[sheriffjimoh]

Summary by Sourcery

Enhancements:

• Use the urlBuilders utility to construct URLs for user profiles and threads.

Summary by CodeRabbit

• New Features

  • Improved URL generation for user profiles and chatbots.
  • Enhanced URL slug creation for more consistent routing.

• Refactor

  • Updated URL construction logic across multiple components.
  • Centralized URL generation using urlBuilders utility.
  • Enhanced flexibility of the Providers component with new configuration options.

• Chores

  • Improved code readability and maintainability.
  • Standardized URL formatting across the application.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request standardizes URL building by using the urlBuilders utility. It replaces hardcoded URL paths with calls to the urlBuilders utility functions. This improves code maintainability and reduces the risk of URL errors.

Sequence diagram for URL building with urlBuilders utility

sequenceDiagram
    participant Component
    participant urlBuilders
    participant Router

    Component->>urlBuilders: userProfileUrl({ userSlug })
    urlBuilders-->>Component: /u/{userSlug}/t
    Component->>Router: Navigate to URL

Loading

Class diagram for URL building components

classDiagram
    class urlBuilders {
        +userProfileUrl(params: object)
        +chatbotUrl(slug: string, category: string, chatbot: string)
    }

    class UserMenu {
        +user: Session['user']
        +getUserInitials(name: string)
        +truncateUsername(username: string, maxLength: number)
    }

    class ProfileSidebar {
        +user: Session['user']
        +handleNavigation()
    }

    UserMenu ..> urlBuilders : uses
    ProfileSidebar ..> urlBuilders : uses

Loading

File-Level Changes

Change	Details	Files
Replaced hardcoded profile URLs with calls to urlBuilders.userProfileUrl. This change affects multiple components related to user profiles.	Replaced the hardcoded profile URL in the UserMenu component. Replaced the hardcoded profile URL in the ProfileSidebar component. Replaced the hardcoded profile URL in the ProfilePageSidebar component.	apps/masterbots.ai/components/layout/header/user-menu.tsx apps/masterbots.ai/components/layout/sidebar/profile-sidebar.tsx apps/masterbots.ai/components/layout/profile/profile-page-sidebar.tsx
Updated the urlBuilders.threadDetailsUrl function to use toSlug for chatbot parameter. This ensures consistency in URL formatting.	Modified the threadDetailsUrl function to apply toSlug to the chatbot parameter before including it in the URL.	apps/masterbots.ai/lib/url.ts
Imported the urlBuilders utility into components and services that use it.	Added an import statement for urlBuilders in the specified files.	apps/masterbots.ai/components/layout/header/user-menu.tsx apps/masterbots.ai/components/layout/sidebar/profile-sidebar.tsx apps/masterbots.ai/components/layout/profile/profile-page-sidebar.tsx apps/masterbots.ai/lib/threads.ts

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
masterbots	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 17, 2025 1:19am

[coderabbitai]

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/masterbots.ai/components/layout/providers.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/apps/masterbots.ai/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The pull request introduces modifications to several files in the Masterbots.ai application, focusing on centralizing URL generation logic. The changes primarily involve importing and utilizing a new urlBuilders utility from the @/lib/url module across multiple components. The most significant updates are in how user profile and chatbot URLs are constructed, replacing direct string interpolation with a more modular approach using the urlBuilders.userProfileUrl and toSlug functions. Additionally, the Providers component has been enhanced to accept new properties for better theming options.

Changes

File	Change Summary
apps/masterbots.ai/components/layout/header/user-menu.tsx	Added urlBuilders import, updated href to use urlBuilders.userProfileUrl
apps/masterbots.ai/components/layout/profile/profile-page-sidebar.tsx	Added urlBuilders import, introduced userSlug constant, modified Link component's href
apps/masterbots.ai/components/layout/sidebar/profile-sidebar.tsx	Added urlBuilders import, updated goToProfile callback to use urlBuilders.userProfileUrl
apps/masterbots.ai/lib/threads.ts	Added urlBuilders import (no functional changes)
apps/masterbots.ai/lib/url.ts	Modified userChatbotUrl to use toSlug instead of toLowerCase() for chatbot URL generation
apps/masterbots.ai/components/layout/providers.tsx	Added ProvidersProps type, updated Providers function signature to use new props

Possibly related issues

• Standardize URL Building Using urlBuilders Utility #327: This PR addresses URL construction inconsistencies across the codebase by standardizing the use of the urlBuilders utility.

Possibly related PRs

• Impr: improve current features v2 #274: The changes in this PR involve modifications to the improveMessage function, which is relevant to the main PR's updates to the user-menu.tsx file where the urlBuilders.userProfileUrl function is utilized. Both PRs involve enhancements to user-related functionalities.
• fix:sideBar updating URL #286: This PR focuses on updating the SidebarLink component, which includes changes to navigation logic that may relate to the UserMenu component's URL handling in the main PR. Both PRs involve navigation and user profile interactions.
• Shallow routing for category & chatbots for chat & profile page  #313: The changes in this PR enhance the ProfileSidebar component, which is directly related to the user-menu.tsx modifications in the main PR, as both involve user profile management and navigation.

Suggested labels

enhancement, feature

Suggested reviewers

• AndlerRL

Poem

🐰 A rabbit's tale of URLs so bright,
Refactoring paths with modular might
From strings to builders, our code takes flight
Slugs transform, URLs now clean and tight
Masterbots rejoice in this coding delight! 🚀

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Beta)
• @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.

[sourcery-ai]

Hey @sheriffjimoh - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[coderabbitai]

Actionable comments posted: 0

🔭 Outside diff range comments (1)

apps/masterbots.ai/components/layout/profile/profile-page-sidebar.tsx (1)

Line range hint 124-157: Standardize URL generation across all profile links.

For consistency, update the Preferences and Subscriptions links to use the urlBuilders utility as well.

  <Link
-   href={`/u/${slug}/s/pref`}
+   href={urlBuilders.userProfileUrl({ userSlug, section: 'pref' })}
    className={cn(
      "flex items-center space-x-2 px-4 py-3",
      "hover:bg-gray-200 dark:hover:bg-mirage transition-colors duration-200",
      location.pathname?.includes('/s/pref') ? 'bg-gray-200 dark:bg-mirage' : ''
    )}
  >
    <Settings className="w-5 h-5" />
    <span>Preferences</span>
  </Link>

  <Link
-   href={`/u/${slug}/s/subs`}
+   href={urlBuilders.userProfileUrl({ userSlug, section: 'subs' })}
    className={cn(
      "flex items-center space-x-2 px-4 py-3",
      "hover:bg-gray-200 dark:hover:bg-mirage transition-colors duration-200",
      location.pathname?.includes('/s/subs') ? 'bg-gray-200 dark:bg-mirage' : ''
    )}
  >
    <ReceiptIcon className="w-5 h-5" />
    <span>Subscriptions</span>
  </Link>

🧰 Tools

🪛 Biome (1.9.4)

[error] 17-17: Unexpected any. Specify a different type.

any disables many type checking rules. Its use should be avoided.

(lint/suspicious/noExplicitAny)

🧹 Nitpick comments (3)

apps/masterbots.ai/components/layout/header/user-menu.tsx (1)

30-33: Add ellipsis to truncated usernames for better UX.

The truncation logic removes characters but doesn't indicate that the text has been cut off.

-    ? `${username.slice(0, maxLength - 4)}`
+    ? `${username.slice(0, maxLength - 4)}...`

apps/masterbots.ai/components/layout/sidebar/profile-sidebar.tsx (1)

Line range hint 35-43: Consider using router.push for error handling in logout.

Based on the retrieved learning from PR #313, prefer using Next.js router methods over direct window manipulation.

  } catch (error) {
    console.error('Logout error:', error)
-   window.location.href = '/'
+   router.push('/')
  }

apps/masterbots.ai/lib/url.ts (1)

Line range hint 31-39: Consider enhancing error handling strategy.

Currently, all URL building errors result in returning '/' which might silently hide issues in production. Consider:

1. Throwing errors to let consumers handle them appropriately
2. Adding error types/codes to help consumers distinguish between different failure cases
3. Logging additional context about the failed operation

Example implementation:

class UrlBuilderError extends Error {
  constructor(
    message: string,
    public readonly code: 'MISSING_PARAMS' | 'INVALID_FORMAT',
    public readonly params?: Record<string, unknown>
  ) {
    super(message);
  }
}

// Usage in the functions:
if (!slug || !category || !chatbot) {
  const missing = Object.entries(params)
    .filter(([_, value]) => !value)
    .map(([key]) => key);
  throw new UrlBuilderError(
    `Missing required parameters: ${missing.join(', ')}`,
    'MISSING_PARAMS',
    { missing, provided: params }
  );
}

Also applies to: 77-81

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d72a578 and a56e227.

📒 Files selected for processing (5)

• apps/masterbots.ai/components/layout/header/user-menu.tsx (5 hunks)
• apps/masterbots.ai/components/layout/profile/profile-page-sidebar.tsx (3 hunks)
• apps/masterbots.ai/components/layout/sidebar/profile-sidebar.tsx (2 hunks)
• apps/masterbots.ai/lib/threads.ts (1 hunks)
• apps/masterbots.ai/lib/url.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• apps/masterbots.ai/lib/threads.ts

🧰 Additional context used

📓 Learnings (1)

apps/masterbots.ai/components/layout/sidebar/profile-sidebar.tsx (1)

Learnt from: AndlerRL
PR: bitcashorg/masterbots#313
File: apps/masterbots.ai/components/layout/profile/profile-page-sidebar.tsx:33-37
Timestamp: 2024-11-28T06:49:04.598Z
Learning: When updating the URL in Next.js, prefer using `router.push` or `router.replace` from the Next.js `useRouter` hook instead of directly manipulating `window.history` to maintain consistency and leverage Next.js features.

🔇 Additional comments (5)

apps/masterbots.ai/components/layout/header/user-menu.tsx (1)

63-68: LGTM! Clean URL generation implementation.

Good use of the urlBuilders utility with proper fallback handling when the slug is not available.

apps/masterbots.ai/components/layout/sidebar/profile-sidebar.tsx (1)

53-55: LGTM! Clean URL generation implementation.

Good use of the urlBuilders utility with proper router navigation.

apps/masterbots.ai/components/layout/profile/profile-page-sidebar.tsx (2)

32-32: LGTM! Good type casting.

Explicit type casting of the slug parameter improves type safety.

---

75-75: LGTM! Clean URL generation implementation.

Good use of the urlBuilders utility for the Threads section link.

apps/masterbots.ai/lib/url.ts (1)

76-76: LGTM! Good standardization of URL generation.

The change from toLowerCase() to toSlug(chatbot) aligns well with the PR objective of standardizing URL building and matches the pattern used in threadUrl.

Let's verify the impact of this URL format change on existing links:

✅ Verification successful

URL format change is safe and consistent with codebase patterns

The change to use toSlug(chatbot) aligns perfectly with the existing URL generation patterns across the codebase. The function is already used consistently for categories, chatbots, and user-related URLs in both generation and consumption code paths.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for direct usage of these URLs in the codebase
# to ensure all consumers are prepared for the new format

# Find components that might be constructing or consuming these URLs
rg -l "userChatbotUrl|/u/.+?/t/.+?/.+?" --type ts --type tsx

# Search for any hardcoded tests or fixtures using the old format
rg -l "toLowerCase\(\)" --type test

Length of output: 157

---

Script:

#!/bin/bash
# Search for userChatbotUrl function usage and URL patterns
rg -l "userChatbotUrl" --type ts --type js
rg -l "\/u\/[^\/]+\/t\/[^\/]+\/[^\/]+" --type ts --type js

# Find test files that might contain URL-related tests
fd -e test.ts -e test.js -e spec.ts -e spec.js | xargs rg -l "userChatbotUrl|\/u\/.*\/t\/"

# Look for toSlug usage to understand the transformation
rg "toSlug\(" --type ts --type js -C 2

Length of output: 13284

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

apps/masterbots.ai/components/layout/providers.tsx (2)

14-14: Use import type for type-only imports.

Since Attribute is only used as a type, it should be imported using the import type syntax for better code organization and compilation optimization.

-import { Attribute, ThemeProvider as NextThemesProvider } from 'next-themes'
+import type { Attribute } from 'next-themes'
+import { ThemeProvider as NextThemesProvider } from 'next-themes'

🧰 Tools

🪛 Biome (1.9.4)

[error] 14-14: Some named imports are only used as types.

This import is only used as a type.

Importing the types with import type ensures that they are removed by the compilers and avoids loading unnecessary modules.
Safe fix: Add inline type keywords.

(lint/style/useImportType)

---

23-23: Consider adding JSDoc documentation.

The component implementation looks good, but consider adding JSDoc documentation to describe the available theme configuration options for better developer experience.

+/**
+ * Application-wide provider component that sets up various contexts
+ * @param props.attribute - HTML attribute for applying color scheme
+ * @param props.defaultTheme - Default theme to use if none is set
+ * @param props.enableSystem - Enable system theme detection
+ * @param props.disableTransitionOnChange - Disable transitions when theme changes
+ */
 export function Providers({ children, ...props }: ProvidersProps) {

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a56e227 and 682b9a9.

📒 Files selected for processing (1)

• apps/masterbots.ai/components/layout/providers.tsx (1 hunks)

🧰 Additional context used

🪛 Biome (1.9.4)

apps/masterbots.ai/components/layout/providers.tsx

[error] 14-14: Some named imports are only used as types.

This import is only used as a type.

Importing the types with import type ensures that they are removed by the compilers and avoids loading unnecessary modules.
Safe fix: Add inline type keywords.

(lint/style/useImportType)

🔇 Additional comments (1)

apps/masterbots.ai/components/layout/providers.tsx (1)

16-22: LGTM! Well-structured type definition.

The ProvidersProps type is well-defined with appropriate optional flags for theme configuration options.

[AndlerRL]

LGTM! Thanks for handling this issue. Merging.

Closes #328