Skip to content

feat(webui): Migrate to npm workspace; Update taskfile and the package scripts accordingly. #1119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 57 commits into from
Sep 3, 2025
Merged

feat(webui): Migrate to npm workspace; Update taskfile and the package scripts accordingly. #1119

Show file tree
Hide file tree
Changes from 49 commits
Commits
Show all changes
57 commits
Select commit Hold shift + click to select a range
9ca2d54
latest
Jul 15, 2025
b501260
latest
Jul 16, 2025
e27d62e
fix lint
Jul 17, 2025
99095de
Merge branch 'main' into sqlbox
davemarco Jul 17, 2025
bdfe59d
latest
Jul 18, 2025
bf9fae1
latest
Jul 18, 2025
f4757af
latest
Jul 18, 2025
7106e72
saving
Jul 18, 2025
b3db4a8
latest
Jul 18, 2025
1b50904
latest
Jul 18, 2025
487376a
latest
Jul 21, 2025
4b4834d
latest
Jul 21, 2025
37687cc
latest
Jul 21, 2025
01ef445
latest
Jul 21, 2025
85c557c
latest
Jul 21, 2025
50b9efc
latest
Jul 30, 2025
f29b93c
latest
Jul 31, 2025
b31bebc
latest
Aug 4, 2025
dbcf7ff
latest
Aug 4, 2025
71aab74
latest
Aug 11, 2025
b502c30
latest
Aug 11, 2025
9d0b7bb
latest
Aug 11, 2025
7b5a8f1
latest
Aug 11, 2025
d786687
tsconfig changes
Aug 14, 2025
6533417
Update components/webui/common/tsconfig.json
davemarco Aug 19, 2025
3b9a852
Update components/webui/server/tsconfig.json
davemarco Aug 19, 2025
b97cd7c
Update components/webui/server/package.json
davemarco Aug 19, 2025
be9ebee
Update components/webui/client/package.json
davemarco Aug 19, 2025
d8cb843
Update components/webui/client/package.json
davemarco Aug 19, 2025
f28b6f7
Update components/webui/server/package.json
davemarco Aug 19, 2025
8945f8a
latest
Aug 19, 2025
6da8f5e
Merge branch 'workspace' of https://github.com/davemarco/clp into wor…
Aug 19, 2025
a476023
Update components/webui/client/package.json
davemarco Aug 21, 2025
2550522
Update components/webui/client/package.json
davemarco Aug 21, 2025
21041bb
Update components/webui/common/package.json
davemarco Aug 21, 2025
be60997
latest
Aug 21, 2025
e5b2888
latest
Aug 21, 2025
73e87be
latest
Aug 21, 2025
0ab3bdb
latest
Aug 26, 2025
902f198
latest
Aug 26, 2025
a3e36f4
latest
Aug 26, 2025
51ccf03
latest
Aug 26, 2025
0ca50ed
fix lint
Aug 26, 2025
9741b66
latest
Aug 27, 2025
97de7ea
Update components/webui/client/package.json
davemarco Aug 28, 2025
817aab5
Update components/webui/client/tsconfig/tsconfig.app.json
davemarco Aug 28, 2025
44451b7
Update components/webui/package.json
davemarco Aug 28, 2025
9e81337
latest
Aug 28, 2025
4026fe9
Merge branch 'workspace' of https://github.com/davemarco/clp into wor…
Aug 28, 2025
bb868d9
latest
Aug 28, 2025
5873146
latest
Aug 28, 2025
3fee734
latest
Aug 28, 2025
171089d
merge main
Aug 28, 2025
fb79e16
lint
Aug 28, 2025
3039ab1
Merge branch 'main' into workspace
junhaoliao Sep 2, 2025
5e148d1
Merge branch 'main' into workspace
davemarco Sep 3, 2025
68880a7
Merge branch 'main' into workspace
davemarco Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions components/clp-package-utils/clp_package_utils/scripts/start_clp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -842,7 +842,7 @@ def start_webui(
get_clp_home() / "var" / "www" / "webui" / "client" / "settings.json"
)
server_settings_json_path = (
get_clp_home() / "var" / "www" / "webui" / "server" / "dist" / "server" / "settings.json"
get_clp_home() / "var" / "www" / "webui" / "server" / "dist" / "settings.json"
)
Comment on lines +846 to 847
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Path correction to server settings.json looks right; verify dist packaging includes it

You removed the redundant "server" segment and now target .../webui/server/dist/settings.json. This aligns with the workspace/dist reshuffle. Please double‑check the server build produces and packages settings.json at dist root so this path won’t 404 at runtime.

Run:

🏁 Script executed:

#!/bin/bash
# Verify references to the new dist paths exist in the server sources/config.
rg -nC2 -e 'dist/settings\.json' -e 'dist/src/main\.js' components/webui/server || true

# Optionally, confirm the server package metadata aligns (main/exports/scripts) if present:
if [ -f components/webui/server/package.json ]; then
  cat components/webui/server/package.json
fi

Length of output: 2569

Ensure server build includes settings.json in dist

It looks like the server’s package.json defines the build step as just running tsc, with no provision to copy non-TS assets. Since TypeScript compilation alone won’t emit JSON files, settings.json won’t end up under dist/, causing a 404 at runtime when start_clp.py points to …/server/dist/settings.json.

Please address this by:

  • Updating the server’s build script (in components/webui/server/package.json) to copy settings.json into dist/.
    Example: 
     "scripts": {
  • "build": "tsc",
  • "build": "tsc && cp src/settings.json dist/settings.json",
    …
    }
- Alternatively, configure your build pipeline (or `tsconfig.json`) to include JSON assets so they’re emitted into `dist/`.
- After making this change, confirm that `components/webui/server/dist/settings.json` exists and that your CLP start-up script no longer 404s.



> Committable suggestion skipped: line range outside the PR's diff.

<details>
<summary>🤖 Prompt for AI Agents</summary>

In components/clp-package-utils/clp_package_utils/scripts/start_clp.py around
lines 845-846, the script expects server/dist/settings.json but the server build
only runs tsc and doesn't emit non-TS assets; update
components/webui/server/package.json build script to copy settings.json into
dist (or add a postbuild step or use a build tool to include JSON assets), or
configure tsconfig/build pipeline to include JSON files in the emitted output,
then run the build and verify components/webui/server/dist/settings.json exists
so start_clp.py will not 404.


</details>

<!-- fingerprinting:phantom:poseidon:chinchilla -->

<!-- This is an auto-generated comment by CodeRabbit -->


validate_webui_config(clp_config, client_settings_json_path, server_settings_json_path)
Expand Down Expand Up @@ -962,7 +962,7 @@ def start_webui(

node_cmd = [
str(CONTAINER_CLP_HOME / "bin" / "node-22"),
str(container_webui_dir / "server" / "dist" / "server" / "src" / "main.js"),
str(container_webui_dir / "server" / "dist" / "src" / "main.js"),
]
Comment on lines 965 to 968
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Entrypoint path updated to dist/src/main.js; confirm server build emits this file

Pointing node to server/dist/src/main.js matches the ESM layout change. Please ensure the server’s tsconfig/build scripts emit main.js under dist/src and that any Docker image or packaging step copies it (and its sourcemap if needed).

If you have a local build, quickly sanity‑check:

🏁 Script executed:

#!/bin/bash
# After building the server locally, confirm the entrypoint exists:
test -f components/webui/server/dist/src/main.js && echo "OK: main.js exists" || (echo "Missing dist/src/main.js"; exit 1)

Length of output: 118

Server entrypoint missing: critical fix required

The verification script indicates that components/webui/server/dist/src/main.js does not exist after building the server. Without this file, the CLP startup will fail at runtime.

Please address the issue by either:

  • Updating the server’s build configuration (e.g. tsconfig.json, build scripts) so that main.js is emitted under dist/src/.
  • Or, if the file is output elsewhere, adjusting the entrypoint path in components/clp-package-utils/clp_package_utils/scripts/start_clp.py to match the actual location.

Next steps:

  • Inspect components/webui/server/tsconfig.json and build scripts to confirm the "outDir" and entry file settings.
  • Re-run the build locally and verify with: 
    test -f components/webui/server/dist/src/main.js \
  && echo "OK: main.js exists" \
  || (echo "Missing dist/src/main.js"; exit 1)
  • Update start_clp.py once the correct path is determined.
🤖 Prompt for AI Agents 
In components/clp-package-utils/clp_package_utils/scripts/start_clp.py around
lines 963-966, the node_cmd entrypoint points to
components/webui/server/dist/src/main.js which the build does not produce;
inspect components/webui/server/tsconfig.json and the server build scripts to
confirm the configured outDir and emitted entry file (or run a local build),
then either update the build config so main.js is emitted to dist/src/ or change
the node_cmd path to the actual built file location (e.g., dist/main.js or
dist/server/main.js as determined); after adjusting, rebuild and verify
existence with the provided test command before committing the path change.

cmd = container_cmd + node_cmd
subprocess.run(cmd, stdout=subprocess.DEVNULL, check=True)
Expand Down
Loading