refactor: optimize directory traversal in check-edit-links script #4126
Conversation
NalinDalal
requested review from
derberg,
akshatnema,
anshgoyalevil,
sambhavgupta0705,
Mayaleeeee and
asyncapi-bot-eve
as code owners
WalkthroughThe pull request updates the ordering of CSS utility classes in several React components and refactors the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant check-edit-links.ts
participant FileSystem
User->>check-edit-links.ts: Run script
check-edit-links.ts->>FileSystem: walkDirectory (async generator)
loop For each markdown file
FileSystem-->>check-edit-links.ts: Yield file path
check-edit-links.ts->>check-edit-links.ts: processBatch (check links)
end
check-edit-links.ts-->>User: Output results
Assessment against linked issues
Assessment against linked issues: Out-of-scope changesNo out-of-scope changes detected. Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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
npm warn EBADENGINE Unsupported engine { 📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page 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)
Other keywords and placeholders
Documentation and Community
|
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
NalinDalal
changed the title
NalinDalal
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
scripts/markdown/check-edit-links.ts (1)
117-121: Simplify error handling in async function.Since this is an async function, you can throw the error directly instead of using
Promise.reject.Apply this diff to simplify the error handling:
- } catch (error) { - return Promise.reject( - new Error(`Error checking ${editLink}: ${error}`), - ); + } catch (error) { + throw new Error(`Error checking ${editLink}: ${error}`);
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
components/CaseStudyCard.tsx(1 hunks)components/campaigns/AnnouncementHero.tsx(1 hunks)pages/tools/generator.tsx(1 hunks)scripts/markdown/check-edit-links.ts(6 hunks)
🧰 Additional context used
🧠 Learnings (1)
scripts/markdown/check-edit-links.ts (1)
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: scripts/markdown/check-editlinks.js:80-93
Timestamp: 2025-01-14T09:23:32.728Z
Learning: In the AsyncAPI website's edit link generation system, the `editOptions` array in `edit-page-config.json` includes a fallback entry with an empty string value (`''`) that matches any URL path, ensuring that `determineEditLink()` function always finds a target and never returns null.
🪛 GitHub Actions: PR testing - if Node project
scripts/markdown/check-edit-links.ts
[error] 84-84: Error walking directory /home/runner/work/website/website/markdown/docs: TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received undefined
⏰ Context from checks skipped due to timeout of 180000ms (4)
- GitHub Check: Redirect rules - asyncapi-website
- GitHub Check: Header rules - asyncapi-website
- GitHub Check: Pages changed - asyncapi-website
- GitHub Check: Lighthouse CI
🔇 Additional comments (5)
components/campaigns/AnnouncementHero.tsx (1)
63-63: CSS class reordering looks fine, but inconsistent with PR objectives.The Tailwind CSS class reordering doesn't affect functionality since CSS class order doesn't impact the styling output. However, there's a significant inconsistency between the PR objectives (optimizing directory traversal in check-edit-links script) and the actual changes (CSS class reordering in React components).
Likely an incorrect or invalid review comment.
components/CaseStudyCard.tsx (1)
22-22: CSS class reordering is functionally safe.The reordering of
justify-centerandgap-3classes maintains the same visual output since Tailwind CSS class order doesn't affect their application. This change continues the pattern of cosmetic class reordering across components.pages/tools/generator.tsx (1)
56-56:✅ Verification successful
CSS reordering is safe, but main PR objective missing.
The class reordering from
'mx-auto h-auto lg:w-1/2 object-cover'to'mx-auto h-auto object-cover lg:w-1/2'doesn't impact functionality. However, the primary focus of this PR was supposed to be optimizing directory traversal inscripts/markdown/check-edit-links.ts, which is not included in the files for review.
🏁 Script executed:
#!/bin/bash # Description: Search for the check-edit-links script that should be the main focus of this PR # Expected: Find the script file and verify it contains the directory traversal optimizations mentioned in PR objectives # Search for check-edit-links script file fd check-edit-links # Search for any TypeScript files that might contain edit link checking logic fd -e ts | xargs rg -l "edit.*link|editLink" | head -10 # Search for directory traversal or async generator patterns in TypeScript files rg -A 5 "async.*generator|for await.*of.*readdir" --type tsLength of output: 1829
🏁 Script executed:
#!/bin/bash # Inspect directory traversal implementation in the check-edit-links script rg -n "readdir" scripts/markdown/check-edit-links.ts || true rg -n "async" scripts/markdown/check-edit-links.ts || true rg -n "for await" scripts/markdown/check-edit-links.ts || trueLength of output: 605
🏁 Script executed:
#!/bin/bash # Compare the check-edit-links script in this PR branch against main to verify if it's been updated set -e # Ensure we have the main branch to compare against git fetch origin main echo "---- Diff for scripts/markdown/check-edit-links.ts (origin/main → PR branch) ----" git diff origin/main -- scripts/markdown/check-edit-links.ts || echo "[No changes detected]"Length of output: 69
#!/bin/bash # Determine the remote default branch and diff the check-edit-links script against it set -e # Fetch all remote refs git fetch origin # Identify the default branch remote_head=$(git symbolic-ref refs/remotes/origin/HEAD) default_branch=${remote_head#refs/remotes/origin/} echo "Default branch: $default_branch" # Show diff for the check-edit-links script echo "---- Diff for scripts/markdown/check-edit-links.ts (origin/$default_branch → PR branch) ----" git diff origin/"$default_branch" -- scripts/markdown/check-edit-links.ts || echo "[No changes detected]"
All PR objectives met—no missing script and CSS reordering is safe
- The file
scripts/markdown/check-edit-links.tsis present in this branch.- It implements directory traversal optimizations using an async generator (
walkDirectory) withfs.readdirandfor await…of, covering the PR’s stated goals.- The CSS class reorder in
pages/tools/generator.tsxremains purely cosmetic and has no functional impact.No further action required.
scripts/markdown/check-edit-links.ts (2)
36-57: Great use of async generators for memory-efficient directory traversal!The refactoring from recursive
Promise.allto async generators is a significant improvement. This approach:
- Reduces memory usage by processing files one at a time
- Improves error handling granularity
- Makes the code more maintainable and easier to understand
Also applies to: 67-80
41-56:❌ Incorrect review comment
Add validation to prevent undefined path errors.
The pipeline error suggests that a path argument is undefined. This could happen if
entry.nameis undefined in certain edge cases.Add defensive checks to prevent undefined values:
async function* walkDirectory( dir: string, relativePath = '', ): AsyncGenerator<{ filePath: string; relativeFilePath: string }> { const entries = await fs.readdir(dir, { withFileTypes: true }); for (const entry of entries) { + if (!entry || !entry.name) { + console.warn(`Skipping invalid entry in directory: ${dir}`); + continue; + } const absPath = path.join(dir, entry.name); const relPath = path.join(relativePath, entry.name);Let me verify if there are any edge cases in the directory structure:
🏁 Script executed:
#!/bin/bash # Description: Check for any unusual files or directories that might cause issues # Check if the docs directory exists if [ -d "markdown/docs" ]; then echo "Checking markdown/docs directory structure..." # Look for symbolic links echo "Symbolic links:" find markdown/docs -type l -ls 2>/dev/null | head -20 # Look for files with unusual names echo -e "\nFiles with special characters or spaces:" find markdown/docs -name "*[[:space:]]*" -o -name "*[^[:alnum:]._/-]*" 2>/dev/null | head -20 # Check for empty directories echo -e "\nEmpty directories:" find markdown/docs -type d -empty 2>/dev/null | head -20 else echo "markdown/docs directory not found" fiLength of output: 493
Ignore entry.name validation —
Dirent.nameis always definedOur directory‐structure check found no symlinks, special‐character filenames, or empty directories under
markdown/docs, and Node’sDirentobjects always include a non-emptynamestring. Adding a guard forentry.nameisn’t necessary and won’t address the pipeline error.• Instead, review where
walkDirectoryis first invoked and ensure thedirargument (or any upstream path) can’t beundefined.
• Check any dynamic or recursive calls to confirm they pass a valid string.
• Consider adding a validation or assertion at the very start ofwalkDirectoryto catch unexpected inputs early:async function* walkDirectory(dir: string, relativePath = '') { if (typeof dir !== 'string' || !dir) { throw new Error(`Invalid directory argument passed to walkDirectory: ${dir}`); } // …rest of implementation… }Likely an incorrect or invalid review comment.
| } catch (err) { | ||
| throw new Error(`Error walking directory ${folderPath}: ${err}`); | ||
| } |
There was a problem hiding this comment.
Improve error handling to preserve original error details.
The current error handling masks the original error details. The pipeline failure indicates a TypeError about an undefined path argument, but this information is lost when using string interpolation with ${err}.
Apply this diff to properly handle and display error details:
- } catch (err) {
- throw new Error(`Error walking directory ${folderPath}: ${err}`);
+ } catch (err) {
+ const errorMessage = err instanceof Error ? err.message : String(err);
+ const errorStack = err instanceof Error ? err.stack : '';
+ throw new Error(`Error walking directory ${folderPath}: ${errorMessage}\n${errorStack}`);This will help identify the root cause of the "path argument must be of type string. Received undefined" error.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| } catch (err) { | |
| throw new Error(`Error walking directory ${folderPath}: ${err}`); | |
| } | |
| } catch (err) { | |
| const errorMessage = err instanceof Error ? err.message : String(err); | |
| const errorStack = err instanceof Error ? err.stack : ''; | |
| throw new Error(`Error walking directory ${folderPath}: ${errorMessage}\n${errorStack}`); | |
| } |
🧰 Tools
🪛 GitHub Actions: PR testing - if Node project
[error] 84-84: Error walking directory /home/runner/work/website/website/markdown/docs: TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received undefined
🤖 Prompt for AI Agents
In scripts/markdown/check-edit-links.ts around lines 83 to 85, the error
handling currently converts the caught error to a string using template
literals, which masks the original error details. To fix this, modify the catch
block to rethrow the original error or include the original error object
directly in the new Error, preserving its stack trace and message. This will
ensure the full error details, including the TypeError about the undefined path
argument, are visible for debugging.
There was a problem hiding this comment.
Hi @NalinDalal please follow relevant comments convention and address the coderabbit's comments please. Thank you
|
@CodeRabbit can you check again the code, I have added the code comments and documented it as asked by @TRohit20 |
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain@NalinDalal, I'll check the updated code to review the documentation and comments you've added. 🏁 Script executed: Length of output: 9043 @NalinDalal Great work on the documentation! I've reviewed the updated code and the documentation improvements are excellent. Here's what I noticed: 🎉 Excellent Documentation QualityComprehensive JSDoc Coverage:
Outstanding Design Documentation:
Professional Code Comments:
Key Strengths:
The code is now well-documented, maintainable, and follows best practices. This addresses @TRohit20's feedback perfectly! The documentation quality is professional-grade and will help future contributors understand both the implementation and the reasoning behind design decisions. |
Description
I needed to validate edit links for a directory of markdown documentation files.
Each .md file should have a corresponding "Edit on GitHub"-style URL. The goal is to:
Related issue(s)
Fixes #3586, orSee #3586Linted the code and built the application to check for any type error and linting issues, atlast the app was built successfully.
update the file:
scripts/markdown/check-edit-links.tsfor respective issueIf anything comes up, maybe some issue, wrong code or anything please let me know
Summary by CodeRabbit