Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(landing): use content-collection again #2685

Merged
merged 3 commits into from
Nov 26, 2024

Conversation

p6l-richard
Copy link
Contributor

@p6l-richard p6l-richard commented Nov 26, 2024

CleanShot 2024-11-26 at 12 45 39

What does this PR do?

  • second attempt at using content-collection's generated code inside the sitemap() fn
  • Previously, it was undefined but it appears to work locally now

Fixes # (issue)

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?

  • Deploy to vercel's preview environment and visit /glossary/sitemap.xml to inspect the XML

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

    • Improved sitemap generation for glossary entries by utilizing a pre-processed content collection.
    • Enhanced URL and last modified date retrieval for each glossary entry.
  • Bug Fixes

    • Eliminated previous issues related to file system interactions for glossary entry processing.

Copy link

changeset-bot bot commented Nov 26, 2024

⚠️ No Changeset found

Latest commit: 6d06c18

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

Copy link

vercel bot commented Nov 26, 2024

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

Name Status Preview Comments Updated (UTC)
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 26, 2024 2:07pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 26, 2024 2:07pm

Copy link

vercel bot commented Nov 26, 2024

@p6l-richard is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Nov 26, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request modify the sitemap function in the apps/www/app/glossary/sitemap.ts file. The implementation now retrieves glossary entries by directly importing allGlossaries from a generated content collection instead of reading from the file system. This update constructs an array of objects for the sitemap, including URLs and last modified dates derived from the glossary entries, thereby streamlining the sitemap generation process.

Changes

File Path Change Summary
apps/www/app/glossary/sitemap.ts Modified the sitemap function to import allGlossaries and construct an array of URLs and last modified dates. Removed file system interactions.

Possibly related PRs

  • fix(www): remove description #2633: The changes in this PR involve the glossary section, specifically in the page.tsx file, which may relate to the overall structure and presentation of glossary entries that are affected by the modifications in the sitemap function.

Suggested reviewers

  • mcstepp
  • perkinsjr
  • MichaelUnkey
  • chronark

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.

Copy link
Contributor

github-actions bot commented Nov 26, 2024

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

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

🧹 Outside diff range and nitpick comments (1)
apps/www/app/glossary/sitemap.ts (1)

9-9: Consider implementing sitemap pagination

The comment about Google's 50,000 URL limit suggests future scalability concerns. While the current implementation is fine, consider adding a TODO to implement pagination if the glossary entries are expected to grow significantly.

Example implementation structure:

async function sitemap(): Promise<MetadataRoute.Sitemap> {
  const ENTRIES_PER_SITEMAP = 45000; // Buffer below Google's limit
  const totalEntries = allGlossaries.length;
  
  // If below threshold, current implementation is fine
  if (totalEntries <= ENTRIES_PER_SITEMAP) {
    return allGlossaries.map(entry => ({
      url: `${env().NEXT_PUBLIC_BASE_URL}/glossary/${entry.slug}`,
      lastModified: entry.updatedAt,
    }));
  }
  
  // Otherwise, implement sitemap index with multiple sitemaps
  // See: https://nextjs.org/docs/app/api-reference/functions/generate-sitemaps
}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between db66bbf and 9e195b4.

📒 Files selected for processing (1)
  • apps/www/app/glossary/sitemap.ts (1 hunks)
🔇 Additional comments (2)
apps/www/app/glossary/sitemap.ts (2)

1-6: LGTM: Imports and configuration are well structured

The configuration with dynamic and revalidate flags ensures the sitemap is always fresh, which is crucial for SEO.


10-13: Verify content collection data integrity

Please ensure:

  1. The updatedAt field from entries matches the required sitemap date format (W3C Datetime format)
  2. The content collection is properly generated and populated
✅ Verification successful

Based on the search results, I can now verify the content collection and data format. The code shows that:

  1. The updatedAt field is properly defined in the content collection schema (apps/www/content-collections.ts) as a string field.
  2. The field is correctly used in the sitemap generation (apps/www/app/glossary/sitemap.ts).
  3. The format appears to be consistent with W3C Datetime format requirements as it's being used directly in the sitemap's lastModified field.

No issues found with the sitemap implementation

The content collection appears to be properly configured and the updatedAt field is being used correctly for sitemap generation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify content collection structure and data format

# Check content collection structure
ast-grep --pattern 'export const allGlossaries = [
  {
    $$$
    updatedAt: $_,
    $$$
  }
]'

# Look for content collection generation config
fd -t f 'contentlayer.config' -x cat {}

Length of output: 140


Script:

#!/bin/bash
# Let's try a different approach to verify the content collection and data format

# First, let's find where allGlossaries is defined or imported
rg "allGlossaries" -A 3

# Look for contentlayer config with different possible extensions
fd "contentlayer.config" --extension ts --extension js --extension mjs -x cat {}

# Check for type definitions that might show the expected structure
rg -g "*.d.ts" "Glossary|allGlossaries" -A 5

# Look for content files to verify the actual data structure
fd . --extension mdx --extension md --extension json --type f -x head -n 20 {}

Length of output: 101030


Script:

#!/bin/bash
# Let's verify the content collection and data format in a different way

# Look for content collection type definitions or interfaces
rg -g "*.ts" -g "*.tsx" "type.*Glossary.*=|interface.*Glossary.*{" -A 5

# Check for content files in common content directories
fd -g "*.{md,mdx}" -t f -d 3

# Look for updatedAt field usage in the codebase
rg "updatedAt" -g "*.ts" -g "*.tsx" -A 2

Length of output: 18989

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