[Docs] Add CLion GDB Remote Debugging Support via Docker by YoungHypo · Pull Request #43 · bytedance/videx

YoungHypo · 2025-06-26T00:19:51Z

Pull Request Summary

This PR provides support for CLion GDB remote debugging VIDEX, using Docker containers to isolate the development environment and facilitate efficient debugging and development workflows.

Related Issues

Resolves: #34

Detailed Description

Add 3 new files

Docker Debug Environment (build/Dockerfile.debug_env)

SSH Service Support
Port Mapping: Pre-configured ports for MySQL (13308), Videx (5001), GDB (1234), and SSH (22)

Debugging Script (build/debug.sh)

Environment Setup: Starts the SSH service and copies the VIDEX storage engine
Directory Initialization

Debugging Guide (doc/debug_guide.md)

Setup Instructions: Step-by-step guide from Docker build to CLion configuration
Visual Assistance: Contains configuration screenshots to help developers follow

check the debug guide

Copilot

Pull request overview

This PR adds comprehensive support for CLion GDB remote debugging of VIDEX using Docker containers. It enables developers to set up an isolated debugging environment with proper tooling and SSH connectivity for remote debugging workflows.

Added Docker-based debug environment with GCC 9.3.0, Bison 3.4.2, GDB, and SSH server configuration
Created debug initialization script to set up the MySQL and VIDEX environment inside containers
Provided step-by-step documentation guide with configuration screenshots for CLion setup

Reviewed changes

Copilot reviewed 3 out of 13 changed files in this pull request and generated 8 comments.

File	Description
`build/Dockerfile.debug_env`	Multi-stage Docker build that creates debug environment with custom GCC/Bison builds, debugging tools (GDB, gdbserver), and SSH server for remote debugging
`build/debug.sh`	Initialization script that starts SSH service, copies VIDEX storage engine, creates necessary directories, and sets up MySQL configuration
`doc/debug_guide.md`	Complete debugging guide covering Docker setup, CLion configuration (SSH, toolchain, deployment, CMake), MySQL initialization, and GDB debugging workflow

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-25T02:25:13Z

build/Dockerfile.debug_env

+    && make install-strip DESTDIR=/gcc-install \
+    && cd /build && rm -rf *
+
+# build Bison 


Trailing whitespace: Line 31 has trailing whitespace after "Bison" that should be removed for consistency.

Suggested change

# build Bison

# build Bison

Copilot · 2025-11-25T02:25:14Z

build/Dockerfile.debug_env

+# configure SSH
+RUN mkdir -p /var/run/sshd && \
+    echo 'root:root' | chpasswd && \


Security concern: The root password is hardcoded as 'root' (line 113). While this is a debug environment, consider documenting this security consideration in the debug guide or suggesting that users change the password in production-like environments.

Suggested change

# configure SSH

RUN mkdir -p /var/run/sshd && \

echo 'root:root' | chpasswd && \

# SECURITY WARNING:

# The root password is set via the ROOT_PASSWORD build argument (default: 'root').

# DO NOT use the default password in production or internet-accessible environments.

# Always override ROOT_PASSWORD at build time for any non-debug use:

# docker build --build-arg ROOT_PASSWORD=your_strong_password -f Dockerfile.debug_env .

ARG ROOT_PASSWORD=root

RUN mkdir -p /var/run/sshd && \

echo "root:${ROOT_PASSWORD}" | chpasswd && \

Copilot · 2025-11-25T02:25:14Z

doc/debug_guide.md

+
+## 1. Preparation
+
+Please following the instructions in **Section1 Preparation** in the [installation guide](https://github.com/bytedance/videx/blob/main/doc/installation.md).


Grammar error: "following" should be "follow". The sentence should read "Please follow the instructions..."

Suggested change

Please following the instructions in **Section1 Preparation** in the [installation guide](https://github.com/bytedance/videx/blob/main/doc/installation.md).

Please follow the instructions in **Section1 Preparation** in the [installation guide](https://github.com/bytedance/videx/blob/main/doc/installation.md).

Copilot · 2025-11-25T02:25:14Z

doc/debug_guide.md

+
+## 1. Preparation
+
+Please following the instructions in **Section1 Preparation** in the [installation guide](https://github.com/bytedance/videx/blob/main/doc/installation.md).


Formatting issue: "Section1" should have a space to read "Section 1" to match the actual section format in the installation guide (which uses "## 1. Preparation").

Suggested change

Please following the instructions in **Section1 Preparation** in the [installation guide](https://github.com/bytedance/videx/blob/main/doc/installation.md).

Please following the instructions in **Section 1 Preparation** in the [installation guide](https://github.com/bytedance/videx/blob/main/doc/installation.md).

Copilot · 2025-11-25T02:25:14Z

doc/debug_guide.md

+
+Open the local `mysql_server` project.
+
+### 4. Configure Remote Development Environment


Inconsistent section numbering: Section 3 is followed by section 4, but section 4 appears at the same heading level as section 3. Section 4 should be "## 4." instead of being nested under section 3.

Suggested change

### 4. Configure Remote Development Environment

## 4. Configure Remote Development Environment

Copilot · 2025-11-25T02:25:15Z

build/debug.sh

+    exit 1
+fi
+
+[ ! -d "$MYSQL_BUILD_DIR" ] && echo "MySQL build directory not found!" && exit 1


Logic error: This check on line 34 is unreachable. The script creates $MYSQL_BUILD_DIR on line 24, so this directory will always exist by the time line 34 is reached. If the intent is to verify the directory exists before creating subdirectories, this check should be moved before line 24.

Suggested change

[ ! -d "$MYSQL_BUILD_DIR" ] && echo "MySQL build directory not found!" && exit 1

Copilot · 2025-11-25T02:25:15Z

build/debug.sh

+[ ! -d "$MYSQL_BUILD_DIR" ] && echo "MySQL build directory not found!" && exit 1
+[ ! -f "$MYSQL_BUILD_DIR/etc/my.cnf" ] && echo "my.cnf not found!" && exit 1


Logic error: This check on line 35 is also unreachable. The script copies my.cnf to $MYSQL_BUILD_DIR/etc/my.cnf on line 28 and exits if the source file doesn't exist (line 31). By the time line 35 is reached, the file is guaranteed to exist. This check is redundant.

Suggested change

[ ! -d "$MYSQL_BUILD_DIR" ] && echo "MySQL build directory not found!" && exit 1

[ ! -f "$MYSQL_BUILD_DIR/etc/my.cnf" ] && echo "my.cnf not found!" && exit 1

[ ! -d "$MYSQL_BUILD_DIR" ] && echo "MySQL build directory not found!" && exit 1

Copilot · 2025-11-25T02:25:15Z

build/Dockerfile.debug_env

+
+# Application ports:
+# 13308 - MySQL service
+# 5001  - Videx service  


Trailing whitespace: Line 120 has trailing whitespace after "Videx service" that should be removed for consistency.

Suggested change

# 5001 - Videx service

# 5001 - Videx service

YoungHypo · 2025-11-26T01:59:15Z

I've made updates 20265a9 based on the copilot review. @kr11

YoungHypo added 7 commits June 25, 2025 16:45

add new dockerfile for debug mode and debug_guide.md

b6dc8e7

add imgs for debug_guide.md

cb86c0b

Update debug_guide.md

db1e9e6

add img for local terminal check

40e355d

Update debug_guide.md for adjusting the img size

3770f47

Merge branch 'main' into debug_guide

d47b5a6

update debug_guide.md for its intro

91e1eec

kr11 requested a review from Copilot November 25, 2025 02:21

kr11 added the developer-experience Improvements that make development easier (debug guides, setup configs, tooling, etc.) label Nov 25, 2025

Copilot started reviewing on behalf of kr11 November 25, 2025 02:22 View session

Copilot finished reviewing on behalf of kr11 November 25, 2025 02:24

Copilot AI reviewed Nov 25, 2025

View reviewed changes

fix review from copliot

20265a9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Docs] Add CLion GDB Remote Debugging Support via Docker#43

[Docs] Add CLion GDB Remote Debugging Support via Docker#43
YoungHypo wants to merge 8 commits intobytedance:mainfrom
YoungHypo:debug_guide

YoungHypo commented Jun 26, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Nov 25, 2025

Uh oh!

Copilot AI Nov 25, 2025

Uh oh!

Copilot AI Nov 25, 2025

Uh oh!

Copilot AI Nov 25, 2025

Uh oh!

Copilot AI Nov 25, 2025

Uh oh!

Copilot AI Nov 25, 2025

Uh oh!

Copilot AI Nov 25, 2025

Uh oh!

Copilot AI Nov 25, 2025

Uh oh!

YoungHypo commented Nov 26, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

-# configure SSH
-RUN mkdir -p /var/run/sshd && \
-    echo 'root:root' | chpasswd && \
+# SECURITY WARNING:
+# The root password is set via the ROOT_PASSWORD build argument (default: 'root').
+# DO NOT use the default password in production or internet-accessible environments.
+# Always override ROOT_PASSWORD at build time for any non-debug use:
+#   docker build --build-arg ROOT_PASSWORD=your_strong_password -f Dockerfile.debug_env .
+ARG ROOT_PASSWORD=root
+RUN mkdir -p /var/run/sshd && \
+    echo "root:${ROOT_PASSWORD}" | chpasswd && \


		## 1. Preparation

		Please following the instructions in Section1 Preparation in the [installation guide](https://github.com/bytedance/videx/blob/main/doc/installation.md).

	Please following the instructions in Section1 Preparation in the [installation guide](https://github.com/bytedance/videx/blob/main/doc/installation.md).
	Please follow the instructions in Section1 Preparation in the [installation guide](https://github.com/bytedance/videx/blob/main/doc/installation.md).


		Open the local `mysql_server` project.

		### 4. Configure Remote Development Environment

	### 4. Configure Remote Development Environment
	## 4. Configure Remote Development Environment

		[ ! -d "$MYSQL_BUILD_DIR" ] && echo "MySQL build directory not found!" && exit 1
		[ ! -f "$MYSQL_BUILD_DIR/etc/my.cnf" ] && echo "my.cnf not found!" && exit 1 No newline at end of file

Conversation

YoungHypo commented Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Summary

Related Issues

Detailed Description

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

YoungHypo commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

YoungHypo commented Jun 26, 2025 •

edited

Loading

YoungHypo commented Nov 26, 2025 •

edited

Loading