Skip to content

Version control javascript libraries with NPM #3124

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 2 commits into from
Nov 4, 2025
Merged

Version control javascript libraries with NPM #3124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1357a11
Handle the case with missing file for symlink
vmcj Oct 26, 2025
5de30a5
Manage JS frontend libraries with yarn
vmcj Oct 26, 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
7 changes: 7 additions & 0 deletions .github/jobs/baseinstall.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ composer install --no-scripts |tee "$ARTIFACTS"/composer_out.txt
cd ..
section_end

section_start "Install JS frontend dependencies"
cd webapp
apt-get update; apt-get install -y yarnpkg
yarnpkg install
cd ..
section_end

section_start "Set simple admin password"
echo "password" > ./etc/initial_admin_password.secret
echo "default login admin password password" > ~/.netrc
Expand Down
6 changes: 6 additions & 0 deletions .github/workflows/codeql-analysis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ jobs:
cd webapp
composer install --no-scripts

- name: Install frontend dependencies
if: ${{ contains(env.COMPILED, matrix.language) }}
run: |
cd webapp
yarnpkg install

- name: Configure Makefile
if: ${{ contains(env.COMPILED, matrix.language) }}
run: |
Expand Down
15 changes: 7 additions & 8 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export TOPDIR = $(shell pwd)

REC_TARGETS=build domserver install-domserver judgehost install-judgehost \
docs install-docs inplace-install inplace-uninstall maintainer-conf \
maintainer-install composer-dependencies composer-dependencies-dev
maintainer-install dependencies dependencies-dev

# Global Makefile definitions
include $(TOPDIR)/Makefile.global
Expand Down Expand Up @@ -54,7 +54,7 @@ docs: paths.mk config
install-domserver: domserver domserver-create-dirs
install-judgehost: judgehost judgehost-create-dirs
install-docs: docs-create-dirs
dist: configure composer-dependencies
dist: configure dependencies

domserver-configure:
ifneq "$(DOMSERVER_BUILD_ENABLED)" "yes"
Expand Down Expand Up @@ -98,8 +98,8 @@ dist: SUBDIRS= lib sql misc-tools
clean: SUBDIRS=etc doc lib sql judge misc-tools webapp
distclean: SUBDIRS=etc doc lib sql judge misc-tools webapp
maintainer-clean: SUBDIRS=etc doc lib sql judge misc-tools webapp
composer-dependencies: SUBDIRS= webapp
composer-dependencies-dev: SUBDIRS= webapp
dependencies: SUBDIRS= webapp
dependencies-dev: SUBDIRS= webapp

domserver-create-dirs:
$(INSTALL_DIR) $(addprefix $(DESTDIR),$(domserver_dirs))
Expand Down Expand Up @@ -191,8 +191,8 @@ paths.mk:
@exit 1

# Configure for running in source tree, not meant for normal use:
maintainer-conf: inplace-conf-common composer-dependencies-dev
inplace-conf: inplace-conf-common composer-dependencies
maintainer-conf: inplace-conf-common dependencies-dev
inplace-conf: inplace-conf-common dependencies
inplace-conf-common: dist
./configure $(subst 1,-q,$(QUIET)) --prefix=$(CURDIR) \
--with-domserver_root=$(CURDIR) \
Expand Down Expand Up @@ -385,5 +385,4 @@ clean-autoconf:
.PHONY: $(addsuffix -create-dirs,domserver judgehost docs) check-root \
$(addprefix inplace-,conf conf-common install uninstall) \
$(addprefix maintainer-,conf install) clean-autoconf config distdocs \
composer-dependencies composer-dependencies-dev \
coverity-conf coverity-build
dependencies dependencies-dev coverity-conf coverity-build
Copy link
Member

@eldering eldering Nov 4, 2025

Choose a reason for hiding this comment

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

Adding the phony targets here is not strictly necessary, as recursive targets are already marked phony in https://github.com/DOMjudge/domjudge/blob/main/Makefile.global#L94, but this doesn't hurt.

4 changes: 2 additions & 2 deletions doc/manual/develop.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,12 @@ already listed under

sudo apt install autoconf automake bats \
python3-sphinx python3-sphinx-rtd-theme fontconfig python3-yaml \
latexmk texlive-latex-recommended texlive-latex-extra tex-gyre
latexmk yarnpkg texlive-latex-recommended texlive-latex-extra tex-gyre

For Fedora use::

sudo dnf install git autoconf automake bats \
sphinx-build python3-sphinx_rtd_theme latexmk texlive-cmap \
sphinx-build python3-sphinx_rtd_theme latexmk yarnpkg texlive-cmap \
texlive-metafont texlive-tex-gyre texlive-fncychap texlive-wrapfig \
texlive-capt-of texlive-framed texlive-upquote texlive-needspace \
texlive-tabulary texlive-parskip texlive-oberdiek texlive-makeindex \
Expand Down
21 changes: 11 additions & 10 deletions etc/domserver-static.php.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,15 @@
define('DOMJUDGE_VERSION', '@DOMJUDGE_VERSION@');
define('DOMJUDGE_INSTALL_METHOD', '@INSTALL_METHOD@');

define('BINDIR', '@domserver_bindir@');
define('ETCDIR', '@domserver_etcdir@');
define('WEBAPPDIR', '@domserver_webappdir@');
define('LIBDIR', '@domserver_libdir@');
define('SQLDIR', '@domserver_sqldir@');
define('VENDORDIR', '@domserver_webappdir@/vendor');
define('LOGDIR', '@domserver_logdir@');
define('RUNDIR', '@domserver_rundir@');
define('TMPDIR', '@domserver_tmpdir@');
define('BINDIR', '@domserver_bindir@');
define('ETCDIR', '@domserver_etcdir@');
define('WEBAPPDIR', '@domserver_webappdir@');
define('LIBDIR', '@domserver_libdir@');
define('SQLDIR', '@domserver_sqldir@');
define('VENDORDIR', '@domserver_webappdir@/vendor');
define('NODEMODULESDIR', '@domserver_webappdir@/node_modules');
define('LOGDIR', '@domserver_logdir@');
define('RUNDIR', '@domserver_rundir@');
define('TMPDIR', '@domserver_tmpdir@');

define('BASEURL', '@BASEURL@');
define('BASEURL', '@BASEURL@');
1 change: 1 addition & 0 deletions webapp/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
/var/log/*
!var/log/.gitkeep
/vendor/
/node_modules/

###> phpunit/phpunit ###
/phpunit.xml
Expand Down
17 changes: 14 additions & 3 deletions webapp/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ SUBDIRS = config

domserver: composer-dump-autoload

dependencies: composer-dependencies node-dependencies
Copy link
Member

@eldering eldering Nov 2, 2025

Choose a reason for hiding this comment

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

These should (all, also composer-dependencies-dev below) be added as phony dependencies under .PHONY to make it clear that no actual target with this name gets created.

Copy link
Member

@eldering eldering Nov 2, 2025

Choose a reason for hiding this comment

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

Hmmm, I see that composer-dependencies{,-dev} are actually recursive targets from the root Makefile, so that should then be renamed there too.

Copy link
Member Author

@vmcj vmcj Nov 3, 2025

Choose a reason for hiding this comment

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

I think I already renamed the composer-dependencies{,-dev} to dependencies{,-dev} in all files (so also the root one). I've now added the .PHONY targets in the webapp/Makefile. I think that's what you meant?


# Install PHP dependencies
composer-dependencies:
ifeq (, $(shell command -v composer 2> /dev/null))
Expand All @@ -20,6 +22,8 @@ endif
# not generated yet, which is needed to run the post-install scripts.
composer $(subst 1,-q,$(QUIET)) install --prefer-dist -o -a --no-scripts --no-plugins

dependencies-dev: composer-dependencies-dev node-dependencies

composer-dependencies-dev:
composer $(subst 1,-q,$(QUIET)) install --prefer-dist --no-scripts --no-plugins

Expand All @@ -36,6 +40,13 @@ vendor/autoload_runtime.php:
composer-dump-autoload-dev:
composer $(subst 1,-q,$(QUIET)) dump-autoload

node-dependencies:
ifeq (, $(shell command -v yarn || command -v yarnpkg 2> /dev/null))
$(error "neither 'yarnpkg' nor 'yarn' command found in $(PATH), install it via your package manager or https://yarnpkg.com/cli/node")
endif
@YARN_CMD=$(shell command -v yarn || command -v yarnpkg); \
$$YARN_CMD install

# Run Symfony in dev mode (for maintainer-mode):
.env.local:
@echo "Creating file '$@'..."
Expand All @@ -58,7 +69,7 @@ install-domserver:
# This must be done first to install with the rest.
$(MAKE) copy-bundle-assets
$(INSTALL_DIR) $(DESTDIR)$(domserver_webappdir);
for d in bin config migrations public resources src templates tests vendor; do \
for d in bin config migrations public resources src templates tests vendor node_modules; do \
$(call install_tree,$(DESTDIR)$(domserver_webappdir),$$d) ; \
done
# Add Symlink to Symfony console that is in the standard path
Expand All @@ -78,5 +89,5 @@ maintainer-clean-l:
done ; \
done

.PHONY: composer-dump-autoload composer-dump-autoload-dev \
copy-bundle-assets
.PHONY: composer-dump-autoload composer-dump-autoload-dev copy-bundle-assets \
composer-dependencies composer-dependencies-dev node-dependencies
4 changes: 0 additions & 4 deletions webapp/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,24 +63,20 @@
"doctrine/doctrine-fixtures-bundle": "^4.0",
"doctrine/doctrine-migrations-bundle": "^3.2",
"doctrine/orm": "^2.14",
"eligrey/filesaver": "2.*",
"enshrined/svg-sanitize": "^0.22.0",
"fortawesome/font-awesome": "6.*",
"friendsofsymfony/rest-bundle": "^3.5",
"ircmaxell/password-compat": "*",
"jms/serializer-bundle": "^5.2",
"knplabs/knp-paginator-bundle": "^6.6",
"league/commonmark": "^2.3",
"mbostock/d3": "^3.5",
"nelmio/api-doc-bundle": "^5.0",
"nelmio/cors-bundle": "^2.4",
"novus/nvd3": "^1.8",
"phpdocumentor/reflection-docblock": "^5.3",
"phpstan/phpdoc-parser": "^2.0",
"promphp/prometheus_client_php": "^2.6",
"ramsey/uuid": "^4.2",
"riverline/multipart-parser": "^2.1",
"select2/select2": "4.*",
"sentry/sentry-symfony": "^5.0",
"symfony/asset": "6.4.*",
"symfony/browser-kit": "6.4.*",
Expand Down
149 changes: 1 addition & 148 deletions webapp/composer.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions webapp/config/static.yaml.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ parameters:
domjudge.libdir: @domserver_libdir@
domjudge.sqldir: @domserver_sqldir@
domjudge.vendordir: @domserver_webappdir@/vendor
domjudge.nodemodulesdir: @domserver_webappdir@/node_modules
domjudge.logdir: @domserver_logdir@
domjudge.rundir: @domserver_rundir@
domjudge.tmpdir: @domserver_tmpdir@
Expand Down
Loading
Loading