fix: introducing auto-download .so and makefile by Pengzna · Pull Request #339 · apache/incubator-hugegraph-computer

Pengzna · 2025-11-08T10:31:51Z

New files added:

scripts/download_binaries.sh - Scripts for automatically downloading supervisord and protoc
Makefile - Provides build commands such as make init and make build

Modified files:

build.sh - Added steps for automatically downloading and generating assets
README.md - Updated build instructions
README.zh-CN.md - Updated Chinese build instructions

Ethereal-O

LGTM. Thanks for fixing this bug.

Ethereal-O

There are some issues. I am working on these.

Ethereal-O · 2025-11-09T17:22:45Z

vermeer/scripts/download_binaries.sh

+TOOLS_DIR="$PROJECT_ROOT/tools"
+
+# Versions
+SUPERVISORD_VERSION="4.2.5"


version is 0.6.9

Ethereal-O · 2025-11-09T17:24:06Z

vermeer/scripts/download_binaries.sh

+
+    # Download supervisord for different platforms
+    # MD5 checksums for supervisord v4.2.5
+    download_supervisord "linux_amd64" "x86_64" "" # Add MD5 if available


correct arch is 64-bit

Ethereal-O · 2025-11-09T17:24:23Z

vermeer/scripts/download_binaries.sh

+    # Download supervisord for different platforms
+    # MD5 checksums for supervisord v4.2.5
+    download_supervisord "linux_amd64" "x86_64" "" # Add MD5 if available
+    download_supervisord "linux_arm64" "aarch64" "" # Add MD5 if available


correct arch is ARM64

Ethereal-O · 2025-11-09T17:25:28Z

vermeer/scripts/download_binaries.sh

+    # MD5 checksums for protoc v21.12
+    download_protoc "linux64" "linux-x86_64" "" # Add MD5 if available
+    download_protoc "osxm1" "osx-aarch_64" "" # Add MD5 if available
+    download_protoc "win64" "win64" "" # Add MD5 if available


this will be fail because the file downloaded is named 'proto.exe'

may be no need

Ethereal-O · 2025-11-09T17:26:46Z

vermeer/asset/assets_vfsdata.go

This file can not be generated automatically. I am working on this.

imbajin · 2025-11-12T07:48:22Z

vermeer/Makefile

+
+# Generate assets (vfsdata.go for web UI)
+generate-assets:
+	@echo "Generating assets..."


‼️ Critical - 缺少错误处理

Makefile 中的多个目标没有进行错误检查。建议在关键步骤后添加错误处理，特别是 download-binaries 和 generate-assets 命令。

建议改进：

Suggested change

@echo "Generating assets..."

download-binaries:

@echo "Downloading binary dependencies..."

@./scripts/download_binaries.sh || (echo "Failed to download binaries" && exit 1)

generate-assets:

@echo "Generating assets..."

@cd asset && go generate || (echo "Failed to generate assets" && exit 1)

@echo "Assets generated successfully!"

imbajin · 2025-11-12T07:48:51Z

vermeer/.gitignore

+
+# Downloaded binaries (should be downloaded via scripts/download_binaries.sh) #
+######################
+tools/supervisord/*/supervisord


⚠️ 建议补充 .gitignore 模式

当前的 .gitignore 只忽略了特定架构的文件。建议添加通配符模式以支持更多平台：

Suggested change

tools/supervisord/*/supervisord

# Downloaded binaries (should be downloaded via scripts/download_binaries.sh) #

######################

tools/supervisord/*/supervisord*

tools/protoc/*/protoc*

tools/protoc/*/bin/

tools/protoc/*/include/

这样可以覆盖 Windows 下的 .exe 文件以及其他平台变体。

imbajin · 2025-11-12T07:49:16Z

vermeer/Makefile

+	@echo "  make clean             - Remove generated files and binaries"
+	@echo "  make clean-all         - Remove everything including downloaded tools"
+	@echo "  make all               - Generate assets and build (default)"
+	@echo "  make help              - Show this help message"


🧹 文档完善建议

help 目标中的描述可以更详细一些，建议添加使用场景说明：

Suggested change

@echo " make help - Show this help message"

help:

@echo "Vermeer Build System"

@echo ""

@echo "Usage:"

@echo " make init - First time setup (download binaries + go mod download)"

@echo " make download-binaries - Download supervisord and protoc binaries for your platform"

@echo " make generate-assets - Generate assets_vfsdata.go from web UI (required before build)"

@echo " make build - Build vermeer for current platform (default: local architecture)"

@echo " make build-linux-amd64 - Build for Linux AMD64 (for deployment)"

@echo " make build-linux-arm64 - Build for Linux ARM64 (for ARM servers)"

@echo " make clean - Remove generated files and binaries (keep downloaded tools)"

@echo " make clean-all - Remove everything including downloaded tools"

@echo " make all - Generate assets and build (default target)"

@echo " make help - Show this help message"

imbajin · 2025-11-12T07:49:26Z

vermeer/README.md

+## Build from Source

-### Install dependencies
+### Requirements


⚠️ 跨平台兼容性说明不足

README 中提到需要 curl 和 unzip 工具，但没有说明不同操作系统（Linux、macOS、Windows）的具体要求和差异。

建议补充：

### Requirements * Go 1.23 or later * `curl` and `unzip` utilities (for downloading dependencies) - Linux: Usually pre-installed, or install via package manager - macOS: Pre-installed - Windows: Install via WSL, Git Bash, or use native alternatives * Internet connection (for first-time setup)

imbajin · 2025-11-12T07:49:36Z

vermeer/README.md

 ```
-go mod tidy
+
+**Alternative**: Use the build script:


‼️ build.sh 使用说明不完整

文档中提到可以使用 ./build.sh amd64 或 ./build.sh arm64，但是：

没有说明 build.sh 的完整参数列表

没有说明如果不传参数会发生什么（默认行为是什么？）

没有说明构建失败时如何排查

建议补充：

**Alternative**: Use the build script: ```bash # For AMD64 (default if no parameter provided) ./build.sh amd64 # For ARM64 ./build.sh arm64 # The script will: # - Auto-detect your OS and architecture if no parameter is provided # - Download required tools if not present # - Generate assets and build the binary # - Exit with error message if any step fails

imbajin · 2025-11-12T07:50:03Z

vermeer/Makefile

+# limitations under the License.
+#
+
+.PHONY: all init download-binaries generate-assets build clean help


🧹 Makefile 最佳实践

.PHONY 声明建议按功能分组，并添加注释说明每个目标的用途，提高可维护性：

Suggested change

.PHONY: all init download-binaries generate-assets build clean help

# Build targets

.PHONY: all init build build-linux-amd64 build-linux-arm64

# Setup and generation targets

.PHONY: download-binaries generate-assets

# Cleanup targets

.PHONY: clean clean-all

# Help target

.PHONY: help

imbajin · 2025-11-12T07:50:16Z

vermeer/README.md

+### Development Build
+
+For development with hot-reload of web UI:
+


⚠️ 开发构建说明不清晰

文档中提到 go build -tags=dev 用于开发环境的热重载，但是：

没有说明 dev tag 的具体作用机制

没有说明如何实现热重载（需要额外的工具吗？）

与 assets_vfsdata.go 的关系不明确

建议改进：

### Development Build For development with hot-reload of web UI: ```bash # Build with dev tag - serves UI files directly from disk instead of embedded assets go build -tags=dev # This allows you to modify UI files and see changes immediately without rebuilding # Note: assets_vfsdata.go is not used when dev tag is enabled

imbajin · 2025-11-12T07:50:59Z

vermeer/README.zh-CN.md

+### 环境要求
+* Go 1.23 或更高版本
+* `curl` 和 `unzip` 工具(用于下载依赖)
+* 互联网连接(首次构建时需要)


⚠️ 中文文档与英文文档一致性

中文文档和英文文档存在相同的问题：

跨平台兼容性说明不足

build.sh 使用说明不完整

开发构建（dev tag）的说明不够清晰

建议参考英文 README 的改进建议，在中文文档中也做相应补充。保持两个版本的文档同步更新。

imbajin · 2025-11-12T07:51:03Z

vermeer/.gitignore

+
+# Generated files (should be generated via go generate) #
+######################
+asset/assets_vfsdata.go


✅ 正确处理生成文件

删除 assets_vfsdata.go 并将其加入 .gitignore 是正确的做法。这个文件应该在构建时动态生成，而不应该提交到版本控制中。

这样可以：

减少代码库大小

避免每次 UI 更新时产生大量 diff

确保使用最新的 UI 资源构建

Pengzna · 2025-11-15T02:23:19Z

see #340

introducing auto-download .so and makefile

cc09382

dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. feature New feature labels Nov 8, 2025

remove >800k files

f6ece43

Ethereal-O approved these changes Nov 8, 2025

View reviewed changes

imbajin approved these changes Nov 9, 2025

View reviewed changes

dosubot bot added the lgtm This PR has been approved by a maintainer label Nov 9, 2025

Ethereal-O reviewed Nov 9, 2025

View reviewed changes

imbajin reviewed Nov 12, 2025

View reviewed changes

Pengzna closed this Nov 15, 2025

-	@echo "Generating assets..."
+download-binaries:
+	@echo "Downloading binary dependencies..."
+	@./scripts/download_binaries.sh || (echo "Failed to download binaries" && exit 1)
+generate-assets:
+	@echo "Generating assets..."
+	@cd asset && go generate || (echo "Failed to generate assets" && exit 1)
+	@echo "Assets generated successfully!"

-tools/supervisord/*/supervisord
+# Downloaded binaries (should be downloaded via scripts/download_binaries.sh) #
+######################
+tools/supervisord/*/supervisord*
+tools/protoc/*/protoc*
+tools/protoc/*/bin/
+tools/protoc/*/include/

-	@echo "  make help              - Show this help message"
+help:
+	@echo "Vermeer Build System"
+	@echo ""
+	@echo "Usage:"
+	@echo "  make init              - First time setup (download binaries + go mod download)"
+	@echo "  make download-binaries - Download supervisord and protoc binaries for your platform"
+	@echo "  make generate-assets   - Generate assets_vfsdata.go from web UI (required before build)"
+	@echo "  make build             - Build vermeer for current platform (default: local architecture)"
+	@echo "  make build-linux-amd64 - Build for Linux AMD64 (for deployment)"
+	@echo "  make build-linux-arm64 - Build for Linux ARM64 (for ARM servers)"
+	@echo "  make clean             - Remove generated files and binaries (keep downloaded tools)"
+	@echo "  make clean-all         - Remove everything including downloaded tools"
+	@echo "  make all               - Generate assets and build (default target)"
+	@echo "  make help              - Show this help message"

-.PHONY: all init download-binaries generate-assets build clean help
+# Build targets
+.PHONY: all init build build-linux-amd64 build-linux-arm64
+# Setup and generation targets
+.PHONY: download-binaries generate-assets
+# Cleanup targets
+.PHONY: clean clean-all
+# Help target
+.PHONY: help

		### Development Build

		For development with hot-reload of web UI:

Conversation

Pengzna commented Nov 8, 2025

Uh oh!

Ethereal-O left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Ethereal-O left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Pengzna commented Nov 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Ethereal-O left a comment •

edited

Loading