You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hugegraph.apache.org by ji...@apache.org on 2026/10/08 15:34:54 UTC
(hugegraph) 04/15: feat(server): enable explicit Topling launches
This is an automated email from the ASF dual-hosted git repository.
imbajin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hugegraph.git
commit 374e71670236d977384c94d3f1dc1be9067bc1a9
Author: imbajin <ji...@apache.org>
AuthorDate: Thu Oct 8 20:31:39 2026 +0800
feat(server): enable explicit Topling launches
- select one runtime for Server, init and dump commands
- keep inherited configuration scoped to the selected component
- cover launcher selection and upgrade contracts
---
.../src/assembly/static/bin/dump-store.sh | 3 +-
.../src/assembly/static/bin/hugegraph-server.sh | 7 +-
.../src/assembly/static/bin/init-store.sh | 2 +
.../travis/test-java17-upgrade-contracts.sh | 5 +-
.../src/assembly/travis/test-topling-selection.sh | 128 +++++++++++++++++++++
5 files changed, 139 insertions(+), 6 deletions(-)
diff --git a/hugegraph-server/hugegraph-dist/src/assembly/static/bin/dump-store.sh b/hugegraph-server/hugegraph-dist/src/assembly/static/bin/dump-store.sh
index 14b6ac1f7..f612557e8 100755
--- a/hugegraph-server/hugegraph-dist/src/assembly/static/bin/dump-store.sh
+++ b/hugegraph-server/hugegraph-dist/src/assembly/static/bin/dump-store.sh
@@ -51,5 +51,6 @@ echo "Dumping HugeGraph Store($conf)..."
dump_store_ext_jar_path=$LIB/hugegraph-dist-*.jar
for i in $LIB/*.jar; do dump_store_ext_jar_path=$dump_store_ext_jar_path:$i; export dump_store_ext_jar_path; done
-exec "$JAVA" -cp "$dump_store_ext_jar_path" \
+source "$BIN/preload-topling.sh" || exit 1
+exec "$JAVA" -cp "${TOPLING_RUNTIME_CLASSPATH:+$TOPLING_RUNTIME_CLASSPATH:}$dump_store_ext_jar_path" \
org.apache.hugegraph.cmd.StoreDumper "$@"
diff --git a/hugegraph-server/hugegraph-dist/src/assembly/static/bin/hugegraph-server.sh b/hugegraph-server/hugegraph-dist/src/assembly/static/bin/hugegraph-server.sh
index 2c93aa085..b0ffaa1f4 100644
--- a/hugegraph-server/hugegraph-dist/src/assembly/static/bin/hugegraph-server.sh
+++ b/hugegraph-server/hugegraph-dist/src/assembly/static/bin/hugegraph-server.sh
@@ -86,7 +86,8 @@ CP="$CP":$(find -L $PLUGINS -name '*.jar' | sort | tr '\n' ':')
# (Cygwin only) Use ; classpath separator and reformat paths for Windows ("C:\foo")
[[ $(uname) = CYGWIN* ]] && CP="$(cygpath -p -w "$CP")"
-export CLASSPATH="${CLASSPATH:-}:$CP"
+source "$BIN/preload-topling.sh" || exit 1
+export CLASSPATH="${TOPLING_RUNTIME_CLASSPATH:+$TOPLING_RUNTIME_CLASSPATH:}${CLASSPATH:-}:$CP"
# Change to $BIN's parent
cd "${TOP}" || exit 1
@@ -259,12 +260,12 @@ fi
# Turn on security check
if [[ "${STDOUT_MODE:-false}" == "true" ]]; then
exec ${JAVA} @"${JVM_MODULE_OPTIONS}" -Dname="HugeGraphServer" ${JVM_OPTIONS} ${JAVA_OPTIONS} \
- ${SECURITY_MANAGER_OPTION} -cp ${CLASSPATH}: \
+ ${SECURITY_MANAGER_OPTION} -cp "${CLASSPATH}:" \
org.apache.hugegraph.bootstrap.HugeGraphServerBootstrap \
${OPEN_SECURITY_CHECK} ${GREMLIN_SERVER_CONF} ${REST_SERVER_CONF}
else
exec ${JAVA} @"${JVM_MODULE_OPTIONS}" -Dname="HugeGraphServer" ${JVM_OPTIONS} ${JAVA_OPTIONS} \
- ${SECURITY_MANAGER_OPTION} -cp ${CLASSPATH}: \
+ ${SECURITY_MANAGER_OPTION} -cp "${CLASSPATH}:" \
org.apache.hugegraph.bootstrap.HugeGraphServerBootstrap \
${OPEN_SECURITY_CHECK} ${GREMLIN_SERVER_CONF} ${REST_SERVER_CONF} \
>> ${LOGS}/hugegraph-server-stdout.log 2>&1
diff --git a/hugegraph-server/hugegraph-dist/src/assembly/static/bin/init-store.sh b/hugegraph-server/hugegraph-dist/src/assembly/static/bin/init-store.sh
index d934192fa..b1eb3438f 100755
--- a/hugegraph-server/hugegraph-dist/src/assembly/static/bin/init-store.sh
+++ b/hugegraph-server/hugegraph-dist/src/assembly/static/bin/init-store.sh
@@ -56,6 +56,8 @@ echo "Initializing HugeGraph Store..."
CP=$(find -L "${LIB}" -name 'hugegraph*.jar' | sort | tr '\n' ':')
CP="$CP":$(find -L "${LIB}" -name '*.jar' \! -name 'hugegraph*' | sort | tr '\n' ':')
CP="$CP":$(find -L "${PLUGINS}" -name '*.jar' | sort | tr '\n' ':')
+source "$BIN/preload-topling.sh" || exit 1
+CP="${TOPLING_RUNTIME_CLASSPATH:+$TOPLING_RUNTIME_CLASSPATH:}$CP"
"${JAVA}" @"${JVM_MODULE_OPTIONS}" -cp "$CP" \
org.apache.hugegraph.cmd.InitStore "${CONF}"/rest-server.properties
INIT_STORE_STATUS=$?
diff --git a/hugegraph-server/hugegraph-dist/src/assembly/travis/test-java17-upgrade-contracts.sh b/hugegraph-server/hugegraph-dist/src/assembly/travis/test-java17-upgrade-contracts.sh
index b37100371..926a96de2 100755
--- a/hugegraph-server/hugegraph-dist/src/assembly/travis/test-java17-upgrade-contracts.sh
+++ b/hugegraph-server/hugegraph-dist/src/assembly/travis/test-java17-upgrade-contracts.sh
@@ -166,10 +166,11 @@ MODULE_OPTIONS="${SERVER_ROOT}/bin/jvm-module.options"
SERVER_SCRIPT="${SERVER_ROOT}/bin/hugegraph-server.sh"
INIT_STORE_SCRIPT="${SERVER_ROOT}/bin/init-store.sh"
UTIL_SCRIPT="${SERVER_ROOT}/bin/util.sh"
+PRELOAD_SCRIPT="${SERVER_ROOT}/bin/preload-topling.sh"
CONF_SOURCE="${SERVER_ROOT}/conf"
for source_file in "$MODULE_OPTIONS" "$SERVER_SCRIPT" \
- "$INIT_STORE_SCRIPT" "$UTIL_SCRIPT"; do
+ "$INIT_STORE_SCRIPT" "$UTIL_SCRIPT" "$PRELOAD_SCRIPT"; do
[[ -f "$source_file" ]] || fail "runtime asset is missing: $source_file"
done
[[ -d "$CONF_SOURCE" ]] || fail "server conf is missing: $CONF_SOURCE"
@@ -182,7 +183,7 @@ MOCK_JAVA_HOME="${TEMP_DIR}/mock-java-home"
mkdir -p "${DIST_ROOT}"/{bin,conf,ext,lib,logs,plugins} \
"${MOCK_JAVA_HOME}/bin"
cp "$MODULE_OPTIONS" "$SERVER_SCRIPT" "$INIT_STORE_SCRIPT" "$UTIL_SCRIPT" \
- "${DIST_ROOT}/bin/"
+ "$PRELOAD_SCRIPT" "${DIST_ROOT}/bin/"
cp -R "${CONF_SOURCE}/." "${DIST_ROOT}/conf/"
# Model a full pre-Phase-2 conf/ directory: it has no module argfile. Both
diff --git a/hugegraph-server/hugegraph-dist/src/assembly/travis/test-topling-selection.sh b/hugegraph-server/hugegraph-dist/src/assembly/travis/test-topling-selection.sh
new file mode 100755
index 000000000..de9624cf1
--- /dev/null
+++ b/hugegraph-server/hugegraph-dist/src/assembly/travis/test-topling-selection.sh
@@ -0,0 +1,128 @@
+#!/bin/bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Selection-only fixtures; real JNI preparation and live services are separate gates.
+set -Eeuo pipefail
+SOURCE_BIN="$(cd "$(dirname "${BASH_SOURCE[0]}")/../static/bin" && pwd)"
+TEST_ROOT=$(mktemp -d)
+trap 'rm -rf "$TEST_ROOT"' EXIT
+mkdir -p "$TEST_ROOT/fake-bin"
+printf '%s\n' '#!/bin/sh' 'case "$1" in -s) echo Linux ;; -m) echo x86_64 ;; esac' > "$TEST_ROOT/fake-bin/uname"
+chmod +x "$TEST_ROOT/fake-bin/uname"
+for component in server pd store; do
+ mkdir -p "$TEST_ROOT/$component/bin" "$TEST_ROOT/$component/conf"
+ cp "$SOURCE_BIN/preload-topling.sh" "$TEST_ROOT/$component/bin/"
+ # Default startup works without prepared assets and never selects optional JNI.
+ env -u TOPLINGDB_ROCKSDB_PROVIDER -u LD_PRELOAD -u TOPLING_ACTIVE_NATIVE \
+ -u TOPLING_RUNTIME_CLASSPATH bash -euc 'source "$1"; test -z "${TOPLING_RUNTIME_CLASSPATH:-}"' \
+ _ "$TEST_ROOT/$component/bin/preload-topling.sh"
+ mkdir "$TEST_ROOT/$component/topling"
+ touch "$TEST_ROOT/$component/topling/rocksdbjni.jar" "$TEST_ROOT/$component/topling/librocksdbjni-linux64.so"
+ (cd "$TEST_ROOT/$component/topling" && sha256sum rocksdbjni.jar librocksdbjni-linux64.so > easy-migrate.sha256)
+ printf '%s\n' 'http: {auto_start_http: false}' > "$TEST_ROOT/$component/conf/toplingdb.yaml"
+done
+for order in 'pd store' 'store pd' 'server pd'; do
+ read -r first second <<< "$order"
+ PATH="$TEST_ROOT/fake-bin:$PATH" bash -ec '
+ export TOPLINGDB_ROCKSDB_PROVIDER=topling
+ unset TOPLINGDB_EASY_MIGRATE_CONF TOPLING_AUTO_MIGRATE_CONF
+ export LD_LIBRARY_PATH=/unrelated CLASSPATH=unrelated.jar
+ source "$1/$2/bin/preload-topling.sh"
+ bash -ec '"'"'source "$1/$2/bin/preload-topling.sh"
+ test "$TOPLINGDB_EASY_MIGRATE_CONF" = "$1/$2/conf/toplingdb.yaml"
+ '"'"' _ "$1" "$3"
+ # Reproduce the Server launcher exporting its selected JAR to children.
+ export CLASSPATH="$TOPLING_RUNTIME_CLASSPATH::unrelated.jar::"
+ TOPLINGDB_ROCKSDB_PROVIDER=rocksdb bash -ec '"'"'source "$1/$2/bin/preload-topling.sh"
+ test "$CLASSPATH" = :unrelated.jar::
+ test -z "${TOPLING_RUNTIME_CLASSPATH:-}"
+ '"'"' _ "$1" "$3"
+ source "$1/$3/bin/preload-topling.sh"
+ test "$CLASSPATH" = :unrelated.jar::
+ test "$TOPLING_RUNTIME_CLASSPATH" = "$1/$3/topling/rocksdbjni.jar"
+ test "$TOPLINGDB_EASY_MIGRATE_CONF" = "$1/$3/conf/toplingdb.yaml"
+ export TOPLINGDB_EASY_MIGRATE_CONF="$1/$2/conf/toplingdb.yaml"
+ source "$1/$3/bin/preload-topling.sh"
+ test "$TOPLINGDB_EASY_MIGRATE_CONF" = "$1/$2/conf/toplingdb.yaml"
+ export CLASSPATH="$TOPLING_RUNTIME_CLASSPATH:$CLASSPATH"
+ export TOPLINGDB_ROCKSDB_PROVIDER=rocksdb
+ source "$1/$2/bin/preload-topling.sh"
+ test -z "${TOPLING_RUNTIME_CLASSPATH:-}"
+ test "$TOPLINGDB_EASY_MIGRATE_CONF" = "$1/$2/conf/toplingdb.yaml"
+ test "$LD_LIBRARY_PATH" = /unrelated
+ test "$CLASSPATH" = :unrelated.jar::
+ ' _ "$TEST_ROOT" "$first" "$second"
+done
+# LD_PRELOAD accepts colon and space separators. Keep caller entries after our JNI.
+for inherited in '/unrelated/liballoc.so:/unrelated/libtrace.so' \
+ '/unrelated/liballoc.so /unrelated/libtrace.so'; do
+ PATH="$TEST_ROOT/fake-bin:$PATH" bash -ec '
+ unset TOPLING_ACTIVE_NATIVE TOPLING_RUNTIME_CLASSPATH
+ export TOPLINGDB_ROCKSDB_PROVIDER=topling LD_PRELOAD="$2"
+ source "$1/server/bin/preload-topling.sh"
+ test "$LD_PRELOAD" = "$1/server/topling/librocksdbjni-linux64.so:$2"
+ # Switching components must replace only the runtime we previously selected.
+ source "$1/pd/bin/preload-topling.sh"
+ test "$LD_PRELOAD" = "$1/pd/topling/librocksdbjni-linux64.so:$2"
+ export TOPLINGDB_ROCKSDB_PROVIDER=rocksdb
+ source "$1/store/bin/preload-topling.sh"
+ test "$LD_PRELOAD" = "$2"
+ ' _ "$TEST_ROOT" "$inherited"
+done
+# Reject competing JNI before adding the selected runtime; unrelated entries survive.
+for provider in unset rocksdb topling; do
+ for inherited in '/other/librocksdbjni.so:/unrelated/libtrace.so' \
+ '/unrelated/libtrace.so /other/librocksdbjni-linux64.so' \
+ '/other/libfrocksdbjni.so' "$TEST_ROOT/server/topling/librocksdbjni-linux64.so"; do
+ if [ "$provider" = topling ] && [ "$inherited" = "$TEST_ROOT/server/topling/librocksdbjni-linux64.so" ]; then
+ continue
+ fi
+ if PATH="$TEST_ROOT/fake-bin:$PATH" bash -ec '
+ unset TOPLING_ACTIVE_NATIVE TOPLING_RUNTIME_CLASSPATH
+ export LD_PRELOAD="$2"
+ if [ "$3" = unset ]; then
+ unset TOPLINGDB_ROCKSDB_PROVIDER
+ else
+ export TOPLINGDB_ROCKSDB_PROVIDER="$3"
+ fi
+ source "$1/server/bin/preload-topling.sh"
+ ' _ "$TEST_ROOT" "$inherited" "$provider" > "$TEST_ROOT/error" 2>&1; then
+ echo "FAIL: competing RocksDB JNI was accepted in $provider mode" >&2; exit 1
+ fi
+ grep -q 'competing RocksDB JNI in LD_PRELOAD' "$TEST_ROOT/error"
+ done
+done
+# Older or modified preparations must be verified again before launch.
+for state in missing stale; do
+ receipt="$TEST_ROOT/server/topling/easy-migrate.sha256"
+ if [ "$state" = missing ]; then
+ mv "$receipt" "$receipt.saved"
+ else
+ printf 'changed' >> "$TEST_ROOT/server/topling/rocksdbjni.jar"
+ fi
+ if PATH="$TEST_ROOT/fake-bin:$PATH" TOPLINGDB_ROCKSDB_PROVIDER=topling \
+ bash -ec 'source "$1"' _ "$TEST_ROOT/server/bin/preload-topling.sh" > "$TEST_ROOT/error" 2>&1; then
+ echo 'FAIL: unverified preparation was accepted' >&2; exit 1
+ fi
+ grep -q 'unverified EasyMigrate runtime' "$TEST_ROOT/error"
+ [ "$state" != missing ] || mv "$receipt.saved" "$receipt"
+done
+if TOPLINGDB_ROCKSDB_PROVIDER=invalid bash -ec 'source "$1"' _ \
+ "$TEST_ROOT/server/bin/preload-topling.sh" > "$TEST_ROOT/error" 2>&1; then
+ echo 'FAIL: invalid provider was accepted' >&2; exit 1
+fi
+echo 'PASS: standard default, explicit selection, component and inherited configuration isolation'