improve path handling and fix event listener leak

[UlisesGascon]

Ref: #228 (comment)

• Replace process.cwd() with __dirname for reliable path resolution
• Fix HTTP server connection listener leak on multiple start/stop cycles
• Add default empty string for ref parameter in internalLinkBuilder
• Replace parseInt() with Number() for better type conversion
• Add implementation_status enum to indexData schema

Summary by CodeRabbit

• New Features

  • Added an implementation_status field to check objects, supporting values "pending", "in_progress", or "completed".

• Bug Fixes

  • Improved handling of project ID and numeric string conversions for greater reliability.

• Refactor

  • Updated file and directory path resolution to be relative to script locations rather than the working directory.
  • Centralized HTTP server connection tracking to prevent duplicate event listeners.
  • Set a default value for internal link references to avoid undefined values.

[coderabbitai]

Walkthrough

This set of changes primarily updates how file and directory paths are resolved throughout the codebase, shifting from using the process's current working directory (process.cwd()) to using the script/module's directory (__dirname). This affects scripts for exporting checklists and checks, as well as report template and asset resolution. Additionally, the HTTP server's connection tracking logic is centralized to avoid multiple event listener registrations. Numeric string parsing is standardized by replacing parseInt with Number. The reports module's internal link builder now defaults its ref parameter to an empty string. Finally, a new implementation_status property is added to the checks schema.

Changes

Files/Group	Change Summary
scripts/export-checklists.js, scripts/export-checks.js	Changed output file paths from being relative to process.cwd() to being relative to __dirname.
src/httpServer/index.js	Moved HTTP server connection tracking setup outside the start method to a one-time module-level registration.
src/reports/index.js	Updated all template, asset, and output paths to be relative to __dirname; defaulted ref param in internalLinkBuilder to ''.
src/httpServer/routers/website.js, src/utils/index.js	Replaced parseInt with Number for string-to-number conversions.
src/schemas/indexData.json	Added implementation_status property to checks object schema with enum values: "pending", "in_progress", "completed".

Sequence Diagram(s)

sequenceDiagram
    participant Script as Export Script
    participant FS as File System

    Script->>FS: Resolve output path using __dirname
    Script->>FS: Write JSON file to output directory

Loading

sequenceDiagram
    participant Module as HTTP Server Module
    participant Server as HTTP Server
    participant Conn as Connection

    Note over Module: On module load
    Module->>Server: Register 'connection' event listener (once)
    Server->>Conn: On new connection, add to Set
    Conn->>Server: On 'close', remove from Set
    Note over Module: start/stop methods unaffected

Loading

Possibly related PRs

• Dynamic reports #228: Related to modularizing report data collection, validation, and template rendering, overlapping with changes in src/reports/index.js.
• Improve server life cycle #226: Also modifies connection tracking and server lifecycle in src/httpServer/index.js, focusing on start/stop methods with enhanced error handling.

Poem

A hop and a skip through the code I go,
Paths now set where the scripts shall flow.
Connections counted, but just once, you see—
No more event listeners crowding the tree!
Statuses track progress, from pending to done,
And numbers are parsed, the old way now shunned.
With a twitch of my nose, these changes are spun! 🐇✨

---

📜 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 867bd7d and ba2aef8.

📒 Files selected for processing (7)

• scripts/export-checklists.js (1 hunks)
• scripts/export-checks.js (1 hunks)
• src/httpServer/index.js (1 hunks)
• src/httpServer/routers/website.js (1 hunks)
• src/reports/index.js (5 hunks)
• src/schemas/indexData.json (1 hunks)
• src/utils/index.js (2 hunks)

🧰 Additional context used

🧠 Learnings (1)

src/reports/index.js (1)

Learnt from: UlisesGascon
PR: OpenPathfinder/visionBoard#228
File: src/reports/index.js:111-123
Timestamp: 2025-05-02T17:20:36.798Z
Learning: The `internalLinkBuilder` function in `src/reports/index.js` is intentionally designed with simplified logic that doesn't preserve sub-paths when a project is specified, as it's not intended to scale beyond current requirements for now.

🔇 Additional comments (11)

scripts/export-checks.js (1)

37-37: Improved path resolution strategy!

Changing from relative paths using process.cwd() to absolute paths based on __dirname is a good practice. This ensures the file is always written to the correct location regardless of where the script is executed from.

src/httpServer/index.js (1)

50-54: Good fix for event listener leak!

Moving the connection tracking setup outside the start method prevents multiple event listeners from being registered during server restart cycles. This effectively fixes the connection listener leak mentioned in the PR objectives.

Before this change, every call to start() would register a new listener, potentially causing memory leaks and duplicate event handling. The fix ensures connection tracking is set up exactly once when the module is loaded.

src/schemas/indexData.json (1)

46-49: Well-defined enum for implementation status tracking!

Adding this enum enhances the schema validation and provides clear status tracking options for implementation progress.

The three states ("pending", "in_progress", "completed") provide a simple but effective way to track the status of each check. Consider whether this field should be marked as required in future updates if it becomes a core part of your workflow.

src/utils/index.js (2)

58-58: Consistent numeric conversion approach!

Replacing parseInt() with Number() aligns with the standardization effort mentioned in the PR objectives.

---

110-110: Standardized numeric parsing for policy values!

Using Number() consistently across the codebase improves maintainability and readability.

Be aware that Number() and parseInt() have subtle behavioral differences:

• Number() converts the entire string and returns NaN if any non-numeric characters are present
• parseInt() parses until it reaches a non-numeric character
• Number("") returns 0 while parseInt("") returns NaN

Since you're replacing the suffix first with replace(), these differences shouldn't affect your code, but it's good to keep in mind.

Also applies to: 113-113, 116-116

src/httpServer/routers/website.js (1)

24-24: Consistent numeric conversion for route parameters!

This change aligns with the standardization to Number() across the codebase.

The isNaN() check immediately after the conversion ensures invalid IDs are still properly handled, maintaining the same behavior as before.

scripts/export-checklists.js (1)

44-44: Good improvement to path resolution reliability!

Switching from process.cwd() to __dirname is a solid improvement. This ensures that the output path is always relative to the script's location rather than the current working directory, making the export functionality more reliable when the script is executed from different locations.

src/reports/index.js (4)

8-12: Good improvement to path resolution reliability!

Switching from process.cwd() to __dirname for all path resolutions makes the file operations more reliable, ensuring that assets, templates, and output files are always found and written relative to the module's location rather than where the process was started. This aligns well with Node.js best practices for path handling.

---

112-112: Nice defensive programming with default parameter value

Adding a default empty string value for the ref parameter prevents potential issues with undefined values in the internalLinkBuilder function. This is a good defensive programming practice and ensures the function will handle all cases gracefully.

---

201-201: Consistent path resolution for EJS views

These changes appropriately update the views directories for EJS rendering to use the same __dirname-based path resolution strategy. This consistency helps prevent path-related errors across different environments.

Also applies to: 222-222

---

212-213: Consistent file writing path resolution

The file writing operations now consistently use the updated path resolution strategy. This change ensures that the generated reports and data files will always be written to the expected location, regardless of how the application is started.

Also applies to: 226-226

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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.

Support

Need 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)

• @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 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.

[UlisesGascon]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.