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

feat(frontend): Code Engine preview, support preview project right now #121

Merged
merged 10 commits into from
Feb 19, 2025

Conversation

NarwhalChen
Copy link
Collaborator

@NarwhalChen NarwhalChen commented Feb 15, 2025

Summary by CodeRabbit

  • New Features

    • Upgraded the preview experience: the static preview has been replaced with a live, interactive web view featuring refresh and full-screen controls.
    • Introduced on-demand project deployment that automatically builds and runs project previews for a more dynamic experience.
  • Chores

    • Updated deployment and development configurations to improve performance, reliability, and container management.

Copy link

coderabbitai bot commented Feb 15, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request makes several targeted updates across the codebase. In the backend, the Chat model is modified by removing the projectId field, while the Project model now uses TypeORM’s @RelationId decorator for better relation tracking. Infrastructure configuration changes include a new Dockerfile for a React TypeScript application, updates to Vite configuration, and the introduction of a Traefik-based reverse proxy via docker-compose. On the frontend, a new Next.js API route to build and run Docker containers is added, along with updates introducing a dynamic WebPreview component and adjustments to polling constants, plus corresponding changes to the GraphQL schema.

Changes

File(s) Change Summary
backend/src/chat/chat.model.ts
backend/src/project/project.model.ts
Removed the projectId field from the Chat model and updated the userId field in the Project model to use @RelationId for relation tracking.
backend/template/react-ts/Dockerfile
backend/template/react-ts/vite.config.ts
Added a new Dockerfile for the React TypeScript application and updated Vite config with build options (sourcemap, rollupOptions) and server settings (host, port, strictPort, polling).
docker-compose.yml Introduced a new docker-compose service for a Traefik reverse-proxy, exposing ports for HTTP and the web UI, and declared an external network.
frontend/src/app/api/runProject/route.ts Created a new Next.js API route to manage Docker container builds and runs, including functions to find an available port and handle container management.
frontend/src/components/code-engine/code-engine.tsx
frontend/src/components/code-engine/web-view.tsx
Replaced the static preview section with a new WebPreview component that fetches and displays a web preview based on project context.
frontend/src/components/code-engine/project-context.tsx Increased MAX_RETRIES (from 20 to 100) and adjusted the polling timeout duration (from 5000ms to 6000ms) for the chat project details polling mechanism.
frontend/src/graphql/schema.gql Updated the GraphQL schema by adding a user field to the Project type, a projects field to the User type, and renaming the getProjectDetails query to getProject.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant VP as WebPreview Component
    participant API as /api/runProject Route
    participant DR as Docker Runner

    U->>VP: Load page and initialize component
    VP->>API: Send GET request with projectPath
    API->>DR: Check existing container/build new image
    DR-->>API: Return project domain (or error)
    API->>VP: Respond with JSON { domain }
    VP->>VP: Update state (url) after delay
    VP->>VP: Refresh iframe src with new url
Loading

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

  • ZHallen122

Poem

I'm a rabbit, hopping through lines of code,
Leaving old fields behind on this winding road.
Docker dreams and GraphQL rhymes,
API calls and preview chimes.
With a twitch of my nose and a joyful leap,
I cherish these changes—my carrot to keep! 🥕

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.

frontend/src/app/api/runProject/route.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/frontend/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

frontend/src/components/code-engine/code-engine.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/frontend/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

frontend/src/components/code-engine/project-context.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/frontend/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

  • 4 others

📜 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 6a5c749 and 9405939.

⛔ Files ignored due to path filters (1)
  • backend/database.db is excluded by !**/*.db
📒 Files selected for processing (10)
  • backend/src/chat/chat.model.ts (0 hunks)
  • backend/src/project/project.model.ts (2 hunks)
  • backend/template/react-ts/Dockerfile (1 hunks)
  • backend/template/react-ts/vite.config.ts (1 hunks)
  • docker-compose.yml (1 hunks)
  • frontend/src/app/api/runProject/route.ts (1 hunks)
  • frontend/src/components/code-engine/code-engine.tsx (2 hunks)
  • frontend/src/components/code-engine/project-context.tsx (2 hunks)
  • frontend/src/components/code-engine/web-view.tsx (1 hunks)
  • frontend/src/graphql/schema.gql (3 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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

@NarwhalChen NarwhalChen reopened this Feb 17, 2025
@Sma1lboy Sma1lboy changed the title Feat frontend code preview feat(frontend): Code Engine preview, support preview project right now Feb 17, 2025
Copy link
Owner

Choose a reason for hiding this comment

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

why chinese here, also the docker compose not in correct filepath

@@ -173,7 +173,6 @@ export class ProjectService {
throw new InternalServerErrorException('Error creating the project.');
}
})();

Copy link
Owner

Choose a reason for hiding this comment

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

why remove line here


export default function WebPreview() {
const [url, setUrl] = useState(
'https://kzmgu6xz4h7tgnj3yzwq.lite.vusercontent.net/'
Copy link
Owner

Choose a reason for hiding this comment

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

why hardcode here

const getWebUrl = async () => {
// TODO: using dynamic loading project by useContext
const projectPath =
'2025-02-10T02-09-3-fc331808-0edf-44fb-9f34-9310b890ba71';
Copy link
Owner

Choose a reason for hiding this comment

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

ditto

@Sma1lboy Sma1lboy marked this pull request as ready for review February 19, 2025 03:39
@Sma1lboy Sma1lboy merged commit 9a65a54 into main Feb 19, 2025
2 of 3 checks passed
@Sma1lboy Sma1lboy deleted the feat-frontend-code-preview branch February 19, 2025 03:39
ZHallen122 pushed a commit that referenced this pull request Feb 23, 2025
#121)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
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