refactor(backend): refactor context part

[Sma1lboy]

• how we get input data

Summary by CodeRabbit

Release Notes

• New Features

  • Enhanced error handling and logging mechanisms across various handlers.
  • Introduction of new utility functions for file operations.
  • Simplified method signatures for several handlers, improving data retrieval processes.

• Bug Fixes

  • Corrected import paths and method calls in test files to ensure accurate functionality.

• Documentation

  • Updated comments and documentation for clarity in methods and error handling.

• Refactor

  • Streamlined the structure and logic of multiple handlers and context management.

• Style

  • Improved code consistency and clarity through refined comments and naming conventions.

[coderabbitai]

Caution

Review failed

The pull request is closed.

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.

backend/src/build-system/__tests__/test-file-create.spec.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-prettier".

(The package "eslint-plugin-prettier" was not found when loaded as a Node module from the directory "/backend".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-prettier@latest --save-dev

The plugin "eslint-plugin-prettier" was referenced from the config file in "backend/.eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

This pull request introduces a comprehensive refactoring of the build system's architecture, focusing on enhancing type safety, improving context management, and streamlining handler implementations. The changes span multiple files across the build system, with key modifications including simplifying node identifiers, updating method signatures to remove variadic arguments, and introducing more explicit context data retrieval methods. The refactoring aims to create a more consistent and type-safe approach to handling build sequences, with a particular emphasis on how data is passed between different stages of the build process.

Changes

File Path	Change Summary
backend/src/build-system/__tests__/	Updated import statements for various handlers, modified test utilities, and adjusted test case data retrieval methods
backend/src/build-system/context.ts	Significant restructuring of context management, introducing globalContext, nodeData, and updating method signatures
backend/src/build-system/executor.ts	Enhanced execution logic with improved state checking and error handling
backend/src/build-system/handlers/	Widespread changes to handler implementations, including simplified node IDs, updated method signatures, and context data retrieval
backend/src/build-system/types.ts	Added new interfaces, made BuildResult and BuildHandler generic, introduced NodeOutputMap

Sequence Diagram

sequenceDiagram
    participant Context as BuilderContext
    participant Executor as BuildSequenceExecutor
    participant Handler as BuildHandler

    Context->>Context: Initialize globalContext
    Context->>Context: Set global/node data
    Executor->>Context: Request node execution
    Context->>Handler: Run handler
    Handler->>Context: Store result in nodeData
    Executor-->>Context: Update execution state

Loading

Possibly related PRs

• feat(backend):ux sitemap generation #50: Changes to FileGeneratorHandler import paths
• Feat(backend)file generate function specific place #71: New test suite for file generation functionality

Poem

🐰 Refactoring Rabbit's Rhyme 🔧

In build system's grand design,
We've cleaned up each method's line
Context flows with type-safe grace
Handlers dance in their new space
Code now sings a clearer chime!

- Hoppy the Refactoring Rabbit 🚀

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 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 418a3a8 and 6357e0e.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (21)

• backend/src/build-system/__tests__/test-file-create.spec.ts (1 hunks)
• backend/src/build-system/__tests__/test-generate-doc.spec.ts (8 hunks)
• backend/src/build-system/__tests__/test.backend-code-generator.spec.ts (7 hunks)
• backend/src/build-system/__tests__/test.file-arch.spec.ts (2 hunks)
• backend/src/build-system/__tests__/testVirtualDir.spec.ts (1 hunks)
• backend/src/build-system/__tests__/utils.ts (1 hunks)
• backend/src/build-system/context.ts (3 hunks)
• backend/src/build-system/executor.ts (6 hunks)
• backend/src/build-system/handlers/backend/code-generate/index.ts (2 hunks)
• backend/src/build-system/handlers/backend/requirements-document/index.ts (1 hunks)
• backend/src/build-system/handlers/database/requirements-document/index.ts (1 hunks)
• backend/src/build-system/handlers/database/schemas/schemas.ts (1 hunks)
• backend/src/build-system/handlers/file-manager/file-arch/index.ts (3 hunks)
• backend/src/build-system/handlers/file-manager/file-generate/index.ts (5 hunks)
• backend/src/build-system/handlers/file-manager/file-structure/index.ts (3 hunks)
• backend/src/build-system/handlers/product-manager/product-requirements-document/prd.ts (1 hunks)
• backend/src/build-system/handlers/project-init.ts (1 hunks)
• backend/src/build-system/handlers/ux/datamap/index.ts (2 hunks)
• backend/src/build-system/handlers/ux/sitemap-document/uxsmd.ts (2 hunks)
• backend/src/build-system/handlers/ux/sitemap-structure/index.ts (2 hunks)
• backend/src/build-system/types.ts (6 hunks)

---

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.