Merge pull request #22514 from dannon/feature/prebuilt-client-wheel

dannon · web-flow · commit bcd136657b4a · 2026-04-17T18:18:16.000-04:00
Drop npm/pnpm from the prebuilt client install; use galaxy-web-client wheel
diff --git a/.github/workflows/build_client.yaml b/.github/workflows/build_client.yaml
@@ -24,7 +24,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v5
         with:
-          package_json_file: 'galaxy root/package.json'
+          package_json_file: 'galaxy root/client/package.json'
       - name: get client commit
         id: client-commit
         shell: bash
diff --git a/.github/workflows/client-api-test.yaml b/.github/workflows/client-api-test.yaml
@@ -29,6 +29,8 @@ jobs:
           node-version: ${{ steps.node-version.outputs.version }}
       - name: Setup pnpm
         uses: pnpm/action-setup@v5
+        with:
+          package_json_file: client/package.json
       - name: Install client dependencies
         run: pnpm install --frozen-lockfile
         working-directory: client
diff --git a/.github/workflows/client-unit.yaml b/.github/workflows/client-unit.yaml
@@ -27,6 +27,8 @@ jobs:
           node-version: ${{ steps.node-version.outputs.version }}
       - name: Setup pnpm
         uses: pnpm/action-setup@v5
+        with:
+          package_json_file: client/package.json
       - run: pnpm install --frozen-lockfile
         working-directory: client
       - name: Pre-build (icons and plugins)
diff --git a/.github/workflows/js_lint.yaml b/.github/workflows/js_lint.yaml
@@ -27,6 +27,8 @@ jobs:
           node-version: ${{ steps.node-version.outputs.version }}
       - name: Setup pnpm
         uses: pnpm/action-setup@v5
+        with:
+          package_json_file: client/package.json
       - run: pnpm install --frozen-lockfile
         working-directory: client
       - name: Run ESLint
diff --git a/.github/workflows/lint_openapi_schema.yml b/.github/workflows/lint_openapi_schema.yml
@@ -37,7 +37,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v5
         with:
-          package_json_file: 'galaxy root/package.json'
+          package_json_file: 'galaxy root/client/package.json'
       - uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
diff --git a/.github/workflows/publish_artifacts.yaml b/.github/workflows/publish_artifacts.yaml
@@ -107,6 +107,12 @@ jobs:
           registry-url: 'https://registry.npmjs.org'
       - name: Setup pnpm
         uses: pnpm/action-setup@v5
+      # TODO(post-26.1): the @galaxyproject/galaxy-client npm publish is now
+      # redundant with the galaxy-web-client PyPI wheel used by
+      # scripts/common_startup.sh and the install-client make target.  Keep
+      # publishing for at least one release cycle in case external consumers
+      # depend on it; once verified unused, drop the build+publish steps
+      # below (leave the client-api publish intact).
       - name: build client
         run: pnpm install && pnpm build-production
         working-directory: 'client'
diff --git a/Makefile b/Makefile
@@ -178,12 +178,6 @@ update-cwl-conformance-tests: ## update CWL conformance tests
 skip-client: ## Run only the server, skipping the client build.
 	GALAXY_SKIP_CLIENT_BUILD=1 sh run.sh
 
-node-deps: ## Install NodeJS dependencies.
-ifndef PNPM
-	corepack enable pnpm;
-endif
-	$(IN_VENV) pnpm install $(PNPM_INSTALL_OPTS)
-
 client-node-deps: ## Install NodeJS dependencies for the client.
 ifndef PNPM
 	corepack enable pnpm;
@@ -217,8 +211,8 @@ lint-api-schema: build-api-schema
 update-navigation-schema: client-node-deps
 	$(IN_VENV) cd client && node navigation_to_schema.mjs
 
-install-client: node-deps ## Install prebuilt client as defined in root package.json
-	$(IN_VENV) pnpm install && pnpm run stage
+install-client: ## Install prebuilt client wheel from PyPI matching the current Galaxy version
+	$(IN_VENV) pip install "galaxy-web-client==$$(PYTHONPATH=lib python -c 'from galaxy.version import VERSION; print(VERSION)')"
 
 client: client-node-deps ## Rebuild client-side artifacts for local development.
 	$(IN_VENV) cd client && $(NODE_ENV) pnpm run build
diff --git a/client/package.json b/client/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@galaxyproject/galaxy-client",
   "version": "26.1.dev0",
+  "packageManager": "pnpm@10.26.1",
   "description": "Galaxy client application build system",
   "keywords": [
     "galaxy"
diff --git a/package.json b/package.json
diff --git a/packages/web_client/Makefile b/packages/web_client/Makefile
@@ -56,13 +56,13 @@ _test:
 
 test: setup-venv _test
 
-_dist: galaxy/web_client/client_build_hash.txt
+_dist: src/galaxy/web_client/client_build_hash.txt
 	uv build -o $(DIST)
 	ls -l $(DIST)
 
 dist: clean _dist
 
-galaxy/web_client/client_build_hash.txt:
+src/galaxy/web_client/client_build_hash.txt:
 	# Use the main Galaxy virtualenv, since that's what `make client-production` uses
 	cd ../..; \
 		uv venv --allow-existing $(VENV); \
diff --git a/scripts/common_startup.sh b/scripts/common_startup.sh
@@ -216,8 +216,10 @@ if [ $FETCH_WHEELS -eq 1 ]; then
 fi
 
 # Check client build state.
-if [ $SKIP_CLIENT_BUILD -eq 0 ]; then
-    if [ -f static/client_build_hash.txt ]; then
+if [ "$SKIP_CLIENT_BUILD" -eq 0 ]; then
+    if [ "$INSTALL_PREBUILT_CLIENT" -ne 0 ]; then
+        echo "The Galaxy prebuilt client will be installed from PyPI."
+    elif [ -f static/client_build_hash.txt ]; then
         # If git is not used and static/client_build_hash.txt is present, next
         # client rebuilds must be done manually by the admin
         if [ "$GIT_BRANCH" = "0" ]; then
@@ -239,32 +241,49 @@ else
     echo "The Galaxy client build is being skipped due to the SKIP_CLIENT_BUILD environment variable."
 fi
 
-# Build client if necessary.
-if [ $SKIP_CLIENT_BUILD -eq 0 ]; then
-    # Ensure pnpm is installed
-    INSTALL_PNPM=0
-    if ! command -v pnpm >/dev/null; then
-        INSTALL_PNPM=1
-    fi
-    if [ $INSTALL_PNPM -eq 1 ]; then
-        if [ -n "$CONDA_DEFAULT_ENV" ] && [ -n "$CONDA_EXE" ]; then
-            echo "Installing pnpm into '$CONDA_DEFAULT_ENV' Conda environment with conda."
-            $CONDA_EXE install --yes --override-channels --channel conda-forge --name "$CONDA_DEFAULT_ENV" pnpm
-        elif [ -n "$VIRTUAL_ENV" ] && in_venv "$(command -v npm)"; then
-            echo "Installing pnpm into $VIRTUAL_ENV with corepack."
-            corepack enable pnpm
-        else
-            echo "Installing pnpm locally with npm."
-            npm install -g pnpm
+# Build or install client if necessary.
+if [ "$SKIP_CLIENT_BUILD" -eq 0 ]; then
+    if [ "$INSTALL_PREBUILT_CLIENT" -ne 0 ]; then
+        # Prebuilt install: pull the matching galaxy-web-client wheel from PyPI.
+        # webapp.py picks it up via `import galaxy.web_client` and serves its
+        # bundled dist/ directly -- no pnpm or staging required.
+        GALAXY_WEB_CLIENT_VERSION=$(PYTHONPATH=lib python -c "from galaxy.version import VERSION; print(VERSION)")
+        case "$GALAXY_WEB_CLIENT_VERSION" in
+            *dev*)
+                echo "ERROR: Galaxy is at development version ${GALAXY_WEB_CLIENT_VERSION}, for which no galaxy-web-client wheel is published to PyPI."
+                echo "The prebuilt client install path (GALAXY_INSTALL_PREBUILT_CLIENT=1) is only supported against tagged releases.  Unset GALAXY_INSTALL_PREBUILT_CLIENT to build the client from source instead."
+                exit 1
+                ;;
+        esac
+        # shellcheck disable=SC2086
+        if ! ${PIP_CMD} install "galaxy-web-client==${GALAXY_WEB_CLIENT_VERSION}"; then
+            echo "ERROR: Galaxy prebuilt client install failed.  See ./client/README.md for more information, including how to get help."
+            exit 1
         fi
-    fi
-    # We need GALAXY_CONFIG_FILE here, ensure it's set.
-    set_galaxy_config_file_var
-    # Set plugin path
-    GALAXY_PLUGIN_PATH=$(python scripts/config_parse.py --setting=plugin_path --config-file="$GALAXY_CONFIG_FILE")
+    else
+        # Dev build: use pnpm to build client from source.
+        # Ensure pnpm is installed.
+        INSTALL_PNPM=0
+        if ! command -v pnpm >/dev/null; then
+            INSTALL_PNPM=1
+        fi
+        if [ $INSTALL_PNPM -eq 1 ]; then
+            if [ -n "$CONDA_DEFAULT_ENV" ] && [ -n "$CONDA_EXE" ]; then
+                echo "Installing pnpm into '$CONDA_DEFAULT_ENV' Conda environment with conda."
+                $CONDA_EXE install --yes --override-channels --channel conda-forge --name "$CONDA_DEFAULT_ENV" pnpm
+            elif [ -n "$VIRTUAL_ENV" ] && in_venv "$(command -v npm)"; then
+                echo "Installing pnpm into $VIRTUAL_ENV with corepack."
+                corepack enable pnpm
+            else
+                echo "Installing pnpm locally with npm."
+                npm install -g pnpm
+            fi
+        fi
+        # We need GALAXY_CONFIG_FILE here, ensure it's set.
+        set_galaxy_config_file_var
+        # Set plugin path
+        GALAXY_PLUGIN_PATH=$(python scripts/config_parse.py --setting=plugin_path --config-file="$GALAXY_CONFIG_FILE")
 
-    if [ "${INSTALL_PREBUILT_CLIENT}" -eq 0 ]; then
-        # If we have not opted to use a prebuilt client, then build client.
         cd client
         # shellcheck disable=SC2086
         if pnpm install $PNPM_INSTALL_OPTS; then
@@ -277,19 +296,5 @@ if [ $SKIP_CLIENT_BUILD -eq 0 ]; then
             exit 1
         fi
         cd -
-    else
-        # Install prebuilt client
-        # shellcheck disable=SC2086
-        if pnpm install $PNPM_INSTALL_OPTS; then
-            if ! (pnpm run stage) then
-                echo "ERROR: Galaxy prebuilt client install failed. See ./client/README.md for more information, including how to get help."
-                exit 1
-            fi
-        else
-            echo "ERROR: Galaxy prebuilt client dependency installation failed. See ./client/README.md for more information, including how to get help."
-            exit 1
-        fi
-
     fi
-
 fi

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@galaxyproject/galaxy-client",`
`3`	`3`	`"version": "26.1.dev0",`
	`4`	`+ "packageManager": "pnpm@10.26.1",`
`4`	`5`	`"description": "Galaxy client application build system",`
`5`	`6`	`"keywords": [`
`6`	`7`	`"galaxy"`