Skip to content

Fix editLink for products not accounting for orgName from repositories.json #74

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

Merged
merged 7 commits into from
Jun 11, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jun 11, 2025

The editLink generation for product pages was not correctly using the organization name from repositories.json, causing external repositories (like nixel2007/extends) to generate incorrect GitHub edit links pointing to autumn-library instead of their actual organization.

Issue

For the repository nixel2007/extends, the generated edit link was:

https://github.com/autumn-library/extends/edit/master/docs/product/...

Instead of the correct:

https://github.com/nixel2007/extends/edit/master/docs/product/...

Root Cause

Two issues were causing this problem:

  1. transformPageData was not cleaning repository names - it used the raw name with sorting prefix (e.g., 003-extends) to look up organization data, but repositories.json maps clean names (e.g., extends)

  2. editLink pattern was using pageData.filePath (rewritten path after URL rewrites) instead of pageData.relativePath (original path before rewrites) to extract repository names

Solution

  • Fixed transformPageData to clean repository names by removing the sorting prefix (\d+-) before looking up organization data
  • Updated editLink pattern to use pageData.relativePath for repository name extraction, ensuring consistency with transformPageData

Testing

Verified that:

  • nixel2007/extends now generates correct edit links with nixel2007 organization
  • Build process continues to work without errors
  • Other repositories remain unaffected

Fixes #73.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI and others added 2 commits June 11, 2025 11:58
…epositories.json

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>
Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] editLink для продуктов не учитывает orgName из repositories.json Fix editLink for products not accounting for orgName from repositories.json Jun 11, 2025
@Copilot Copilot AI requested a review from nixel2007 June 11, 2025 12:03
Copilot finished work on behalf of nixel2007 June 11, 2025 12:03
@nixel2007 nixel2007 marked this pull request as ready for review June 11, 2025 12:04
Copy link

coderabbitai bot commented Jun 11, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 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.
    • @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 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in 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.

@@ -20,7 +20,8 @@ export default defineConfig({
const repositoriesMap: Map<string, RepoData> = new Map(repositories.map((repoData: RepoData) => [repoData.repository, repoData]));

const repoName = pageData.relativePath.split('/')[1];
const repoData = repositoriesMap.get(repoName);
const cleanRepoName = repoName?.replace(/\d+-/g, '');
Copy link
Member

Choose a reason for hiding this comment

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

inline this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Inlined the variable as requested in commit a6453c2

const organization = pageData.params?.organization;

const [_, repoName, ...rest] = filePath.split('/')
// Use relativePath to get the original repository name (before rewrites)
const [_, repoName, ...rest] = relativePath.split('/')
Copy link
Member

Choose a reason for hiding this comment

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

что-то не сходится. раз это до рерайтов, значит, здесь имя репозитория будет с цифрами в начале. в filePath цифр уже быть не должно, а значит и replace строкой ниже уже не нужен.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You're right about the logic. I'm using relativePath (before rewrites) so the repo name has prefixes like 003-extends, which is why I need the replace(/\d+-/g, '') on line 164. This is consistent with transformPageData which also uses relativePath and cleans the name for organization lookup. Would you prefer I use filePath instead and remove the replace, or keep the current consistent approach?

Copy link
Member

Choose a reason for hiding this comment

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

Используй filePath

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed to use filePath instead of relativePath and removed the manual cleaning since filePath is already processed by URL rewrites. Commit 816719e

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>
Copilot finished work on behalf of nixel2007 June 11, 2025 12:26
Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>
Copilot finished work on behalf of nixel2007 June 11, 2025 12:32
return `https://github.com/${orgName}/${repoNamePath}/edit/master/docs/product/${restPath}`
}
return ''
// For products (after rewrites, products/ prefix is removed)
Copy link
Member

Choose a reason for hiding this comment

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

нене, вот здесь (и на 160 строке) как раз можно проверить relativePath. там же должно быть и /api и /product по идее.
ну и вырни обратно обший расчет repoName, orgName и restPathю они же одинаковые в таком случае

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed to use relativePath for path checks and restored common calculation of repoName, orgName and restPath as requested. Commit 718e717

Copy link
Member

Choose a reason for hiding this comment

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

Vitepress хостит не только /api и /product. Верни проверку на product обратно

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added back specific check for relativePath.startsWith('products/') instead of using catch-all. Now properly handles cases where VitePress hosts paths other than /api and /product by returning empty string for unmatched paths. Commit f9a40a6

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added back specific check for relativePath.startsWith('products/') instead of using catch-all. Now properly handles cases where VitePress hosts paths other than /api and /product by returning empty string for unmatched paths. Commit f9a40a6

…s requested

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>
Copilot finished work on behalf of nixel2007 June 11, 2025 12:37
@@ -20,7 +20,7 @@ export default defineConfig({
const repositoriesMap: Map<string, RepoData> = new Map(repositories.map((repoData: RepoData) => [repoData.repository, repoData]));

const repoName = pageData.relativePath.split('/')[1];
const repoData = repositoriesMap.get(repoName);
const repoData = repositoriesMap.get(repoName?.replace(/\d+-/g, ''));
Copy link
Member

Choose a reason for hiding this comment

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

Move replace to the line with repoName calculation

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved replace operation inline with repoName calculation in both transformPageData and editLink pattern. Now uses repoName?.replace(/\d+-/g, '') directly in the assignment. Commit f9a40a6

return `https://github.com/${orgName}/${repoNamePath}/edit/master/docs/product/${restPath}`
}
return ''
// For products (after rewrites, products/ prefix is removed)
Copy link
Member

Choose a reason for hiding this comment

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

Vitepress хостит не только /api и /product. Верни проверку на product обратно

Co-authored-by: nixel2007 <1132840+nixel2007@users.noreply.github.com>
Copilot finished work on behalf of nixel2007 June 11, 2025 15:07
@nixel2007 nixel2007 merged commit 8858133 into master Jun 11, 2025
2 checks passed
@nixel2007
Copy link
Member

@copilot после твоих правок edit link в разделе с описанием продуктов вообще не работает. Api работает.

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.

editLink для продуктов не учитывает orgName из repositories.json
2 participants