Self-hosting!

[lindesvard]

Enhance Self-Hosting Features and Add Ping Functionality

Overview

This pull request introduces a new ping endpoint for self-hosting capabilities, enhances database interactions, and includes a cron job for periodic pings. It also refines the Docker configuration and updates various dependencies for improved stability and performance.

Changes

• Key Changes:

  • Added a new ping endpoint in misc.controller.ts that logs domain pings to the database.
  • Integrated the ping functionality into the cron job system to trigger daily pings.
  • Updated the ClickHouse database schema to include a self_hosting table for storing ping data.
  • Modified the Dockerfile to include necessary patches for the self-hosting setup.

• New Features:

  • Introduced a POST /ping API endpoint that accepts a domain and a count, storing this information in the database.
  • Implemented a cron job that automatically pings the server daily, sending the count from the database.

• Refactoring:

  • Improved error handling in the ping function to log errors and return appropriate HTTP status codes.
  • Consolidated the cron job logic to include the new ping functionality, enhancing maintainability.
  • Updated the package.json file for worker dependencies to use fixed versions for better consistency.

# Optimize ClickHouse Configuration for Self-Hosting

Overview

This pull request aims to optimize the ClickHouse configuration for the self-hosting deployment of the OpenPanel application. The changes focus on reducing unnecessary logging, improving performance, and ensuring the ClickHouse server listens on the correct network interface.

Changes

Key Changes:

• Configured ClickHouse to listen on all IPv4 interfaces by setting <listen_host>0.0.0.0</listen_host> to avoid the "Address family for hostname not supported" warning.
• Disabled various unnecessary ClickHouse logs, including query_thread_log, query_log, text_log, trace_log, metric_log, asynchronous_metric_log, session_log, and part_log.
• Set the log_queries and log_query_threads parameters to 0 in the default user profile to further reduce logging.

New Features:

• None

Refactoring:

• Moved the ClickHouse configuration to separate XML files (clickhouse-config.xml and clickhouse-user-config.xml) for better organization and maintainability.

Update pnpm Lock File

Overview

This pull request updates the pnpm-lock.yaml file, which is used to manage the project's dependencies. The changes include adding new dependencies, updating existing ones, and ensuring consistent versions across the project.

Changes

Key Changes:

• Updated the pnpm-lock.yaml file with the following changes:
  • Added the @types/inquirer dependency, which provides type definitions for the inquirer library.
  • Added the @types/js-yaml dependency, which provides type definitions for the js-yaml library.
  • Updated the version of the inquirer library to 9.3.1.
  • Updated the version of the js-yaml library to 4.1.0.

New Features:

• None

Refactoring:

• No major refactoring changes were made in this pull request.

Self-Hosting Setup for OpenPanel

Overview

This pull request introduces a self-hosting setup script for the OpenPanel application. The script guides users through the process of setting up the necessary infrastructure, including database, caching, and proxy services, to run OpenPanel on their own infrastructure.

Changes

Key Changes:

• Implemented a comprehensive onboarding process using the Inquirer.js library to gather user input for domain name, dependencies, proxy setup, and Clerk.dev credentials.
• Integrated Clerk.dev authentication, simplifying the setup of the necessary credentials.
• Introduced functionality to generate a Caddyfile for the Caddy proxy server, including basic authentication.
• Updated the Docker Compose file based on the user's selected dependencies, removing unnecessary services and updating worker replicas.

New Features:

• Provided a self-hosting setup script that guides users through the entire deployment process, reducing the complexity of setting up OpenPanel on their own infrastructure.
• Implemented support for various database and caching options, allowing users to bring their own or use the provided services.
• Integrated Clerk.dev authentication, streamlining the setup of the required credentials.

Refactoring:

• Organized the code into modular functions, improving readability and maintainability.
• Utilized TypeScript to provide type safety and better tooling support.
• Implemented input validation and error handling to ensure a smooth onboarding experience.

✨ Generated with love by Kaizen ❤️

Original Description

[kaizen-bot[bot]]

🔍 Code Review Summary

❗ Attention Required: This push has potential issues. 🚨

📊 Stats

• Total Feedbacks: 5
• Critical: 1
• Suggested Refinements: 4
• Files Affected: 5

🏆 Code Quality

[█████████████████░░░] 85% (Good)

🚨 Critical Issues

Documentation (1 issues)

1. Changes made to sensitive file

---

📁 File: README.md:66 ⚖️ Severity: 10/10 🔍 Description: Changes were made to README.md, which needs review 💡 Solution: NA

---

🟠 Refinement Suggestions:

These are not critical issues, but addressing them could further improve the code:

Lack of error handling (4 issues)

1. The `ping` function does not have proper error handling. If an exception occurs during the database insertion, the function will return a generic 500 error without any additional context.

---

📁 File: apps/api/src/controllers/misc.controller.ts:141 ⚖️ Severity: 7/10 🔍 Description: Proper error handling is crucial for providing meaningful feedback to the client and aiding in debugging. 💡 Solution: Add more detailed error handling, such as logging the error message and providing a more specific error response to the client.

Current Code:

Suggested Code:

try{
  // Database insertion logic
}catch (e){
  logger.error(e, 'Failed to insert ping');
  reply.status(500).send({
    error: 'Failed to insert ping',
});
}

2. The code in the `webhook.controller.ts` file is iterating over the `email_addresses` array to find the matching memberships. This approach may become inefficient as the number of email addresses increases.

---

📁 File: apps/api/src/controllers/webhook.controller.ts:63 ⚖️ Severity: 6/10 🔍 Description: Iterating over an array for each email address can lead to performance issues, especially if the array is large. 💡 Solution: Consider using a more efficient data structure, such as a Set or Map, to store the email addresses and perform lookups more quickly.

Current Code:

const memberships = await db.member.findMany({
  where:{
    email:{
      in: emails,
},
    userId: null,
},
});

Suggested Code:

const emailSet = new Set(emails);
const memberships = await db.member.findMany({
  where:{
    email:{
      in: Array.from(emailSet),
},
    userId: null,
},
});

3. No error handling for potential issues with external links.

---

📁 File: apps/docs/src/pages/docs/sdks/express.mdx:10 ⚖️ Severity: 6/10 🔍 Description: Links to external resources should be validated to ensure they are reachable and correct. 💡 Solution: Implement a mechanism to check the validity of external links before deployment.

4. Importing 'Link' from 'next/link' is repeated across multiple files.

---

📁 File: apps/docs/src/pages/docs/sdks/react.mdx:1 ⚖️ Severity: 6/10 🔍 Description: Redundant imports can lead to larger bundle sizes and decreased performance. 💡 Solution: Consider creating a shared component or utility function for the Link usage to avoid repetition.

Current Code:

import Link from 'next/link';

Suggested Code:

import Link from '../components/Link'; // Example of a shared component

---

---

✨ Generated with love by Kaizen ❤️

Useful Commands

• Feedback: Reply with !feedback [your message]
• Ask PR: Reply with !ask-pr [your question]
• Review: Reply with !review
• Explain: Reply with !explain [issue number] for more details on a specific issue
• Ignore: Reply with !ignore [issue number] to mark an issue as false positive
• Update Tests: Reply with !unittest to create a PR with test changes

[kaizen-bot[bot]]

1965 changes in code? Challenge accepted! Prepare for 5 minutes of turbo-charged review. May the best algorithm win! - by Kaizen-Bot

[kaizen-bot[bot]]

1984 changes? Now that's what I call a code buffet! Preparing my digital fork and knife for a 5-minute review feast. - by Kaizen-Bot

[kaizen-bot[bot]]

A grand of code approaches! Settling in for 5 minutes of review fun. Time to question all your life choices and variable names. - by Kaizen-Bot

[kaizen-bot[bot]]

1996 changes in code? Challenge accepted! Prepare for 5 minutes of turbo-charged review. May the best algorithm win! - by Kaizen-Bot

[kaizen-bot[bot]]

2121 changes in code? Challenge accepted! Prepare for 5 minutes of turbo-charged review. May the best algorithm win! - by Kaizen-Bot

[kaizen-bot[bot]]

2123 changes in code? Challenge accepted! Prepare for 5 minutes of turbo-charged review. May the best algorithm win! - by Kaizen-Bot

[kaizen-bot[bot]]

A grand of code approaches! Settling in for 5 minutes of review fun. Time to question all your life choices and variable names. - by Kaizen-Bot

[kaizen-bot[bot]]

Reviewing a kiloline of code. 5 minutes to ponder: To catch or to throw? To inherit or to compose? - by Kaizen-Bot

[kaizen-bot[bot]]

Reviewing a kiloline of code. 5 minutes to ponder: To catch or to throw? To inherit or to compose? - by Kaizen-Bot

[kaizen-bot[bot]]

Reviewing a kiloline of code. 5 minutes to ponder: To catch or to throw? To inherit or to compose? - by Kaizen-Bot

[kaizen-bot[bot]]

A grand of code approaches! Settling in for 5 minutes of review fun. Time to question all your life choices and variable names. - by Kaizen-Bot

[kaizen-bot[bot]]

Reviewing a kiloline of code. 5 minutes to ponder: To catch or to throw? To inherit or to compose? - by Kaizen-Bot