Remove option to configure libvendor dir

vmcj · Michael Vasseur · commit cf455d5025ce · 2024-06-23T17:23:05.000+02:00
Default it would be put in the root (see also the commit message about those lines in composer.json) and it makes the most sense to have those relative to the source. @nickygerritsen suggested another place which would also be fine, we should discuss this before merging. Also create a new cache as the old one should be quite out of date and as we now move the vendor somewhere else this is the right time to update the naming. Added script for when we want to change this to another directory Move composer files into webapp to simplify all overrides Try to fix the install Work from the correct directory Fxup Get composer.json from webapp location in unit tests Ignore the contrast of the filter button Run the composer install from the right targets I wonder if inplace-conf is the right place to do this or if this is part of the install but there is argumentation for both. Next step is to do the same for the dev dependencies. Install the dev dependecies in webapp We already traverse so keep this close in the directory Fixup Show what is the determined dir
diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
@@ -21,6 +21,7 @@ jobs:
           configuration: phpstan.dist.neon
           path: webapp/src webapp/tests
           php_extensions: gd intl mysqli pcntl zip
+          autoload_file: webapp/vendor/autoload.php
       - uses: actions/upload-artifact@v4
         if: always()
         with:
diff --git a/Makefile b/Makefile
@@ -5,7 +5,8 @@
 export TOPDIR = $(shell pwd)
 
 REC_TARGETS=build domserver install-domserver judgehost install-judgehost \
-            docs install-docs inplace-install inplace-uninstall maintainer-conf
+            docs install-docs inplace-install inplace-uninstall maintainer-conf \
+            composer-dump-autoload composer-dump-autoload-dev
 
 # Global Makefile definitions
 include $(TOPDIR)/Makefile.global
@@ -50,7 +51,7 @@ docs: paths.mk config
 install-domserver: domserver composer-dump-autoload domserver-create-dirs
 install-judgehost: judgehost judgehost-create-dirs
 install-docs: docs-create-dirs
-dist: configure composer-dependencies
+dist: configure
 
 domserver-configure:
 ifneq "$(DOMSERVER_BUILD_ENABLED)" "yes"
@@ -64,27 +65,6 @@ ifneq "$(JUDGEHOST_BUILD_ENABLED)" "yes"
 	@exit 1
 endif
 
-# Install PHP dependencies
-composer-dependencies:
-ifeq (, $(shell command -v composer 2> /dev/null))
-	$(error "'composer' command not found in $(PATH), install it via your package manager or https://getcomposer.org/download/")
-endif
-# We use --no-scripts here because at this point the autoload.php file is
-# 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
-
-composer-dependencies-dev:
-	composer $(subst 1,-q,$(QUIET)) install --prefer-dist --no-scripts --no-plugins
-
-# Dump autoload dependencies (including plugins)
-# This is needed since symfony/runtime is a Composer plugin that runs while dumping
-# the autoload file
-composer-dump-autoload:
-	composer $(subst 1,-q,$(QUIET)) dump-autoload -o -a
-
-composer-dump-autoload-dev:
-	composer $(subst 1,-q,$(QUIET)) dump-autoload
-
 # Generate documentation for distribution. Remove this dependency from
 # dist above for quicker building from git sources.
 distdocs:
@@ -108,12 +88,16 @@ install-judgehost:          SUBDIRS=etc     lib     judge misc-tools
 docs:                       SUBDIRS=    doc
 install-docs:               SUBDIRS=    doc
 maintainer-conf:            SUBDIRS=                                 webapp
+inplace-conf:               SUBDIRS=                                 webapp
 inplace-install:            SUBDIRS=    doc               misc-tools
 inplace-uninstall:          SUBDIRS=    doc               misc-tools
-dist:                       SUBDIRS=        lib sql       misc-tools
+dist:                       SUBDIRS=        lib sql       misc-tools webapp
 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-clean:             SUBDIRS=                                 webapp
+composer-dump-autoload:     SUBDIRS=                                 webapp
+composer-dump-autoload-dev: SUBDIRS=                                 webapp
 
 domserver-create-dirs:
 	$(INSTALL_DIR) $(addprefix $(DESTDIR),$(domserver_dirs))
@@ -194,8 +178,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
+inplace-conf: inplace-conf-common
 inplace-conf-common: dist
 	./configure $(subst 1,-q,$(QUIET)) --prefix=$(CURDIR) \
 	            --with-domserver_root=$(CURDIR) \
@@ -216,7 +200,7 @@ inplace-conf-common: dist
 # symlinks where necessary to let it work from the source tree.
 # This stuff is a hack!
 maintainer-install: inplace-install composer-dump-autoload-dev
-inplace-install: build composer-dump-autoload domserver-create-dirs judgehost-create-dirs
+inplace-install: build composer-dump-autoload domserver-create-dirs judgehost-create-dirs composer-clean
 inplace-install-l:
 # Replace libjudgedir with symlink to prevent lots of symlinks:
 	-rmdir $(judgehost_libjudgedir)
@@ -234,7 +218,6 @@ inplace-install-l:
 	$(MKDIR_P) $(domserver_tmpdir)
 	chmod a+rwx $(domserver_tmpdir)
 # Make sure we're running from a clean state:
-	composer auto-scripts
 	@echo ""
 	@echo "========== Maintainer Install Completed =========="
 	@echo ""
@@ -334,6 +317,5 @@ 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 \
         composer-dump-autoload composer-dump-autoload-dev \
-        coverity-conf coverity-build
+        coverity-conf coverity-build composer-clean
diff --git a/README.md b/README.md
@@ -72,7 +72,7 @@ The M4 autoconf macros are licensed under all-permissive and GPL3+
 licences; see the respective files under m4/ for details.
 
 The DOMjudge tarball ships external library dependencies in the
-lib/vendor directory. These are covered by their individual licenses
+webapp/vendor directory. These are covered by their individual licenses
 as specified in the file composer.lock.
 
 Contact
diff --git a/configure.ac b/configure.ac
@@ -170,7 +170,6 @@ if test "x$FHS_ENABLED" = xyes ; then
 	AC_SUBST(domserver_webappdir,       $datadir/${PACKAGE_TARNAME}/webapp)
 	AC_SUBST(domserver_sqldir,          $datadir/${PACKAGE_TARNAME}/sql)
 	AC_SUBST(domserver_libdir,          $libdir/${PACKAGE_TARNAME})
-	AC_SUBST(domserver_libvendordir,    $libdir/${PACKAGE_TARNAME}/vendor)
 	AC_SUBST(domserver_logdir,          $localstatedir/log/${PACKAGE_TARNAME})
 	AC_SUBST(domserver_rundir,          $localstatedir/run/${PACKAGE_TARNAME})
 	AC_SUBST(domserver_tmpdir,          /tmp)
@@ -222,7 +221,6 @@ AX_PATH(domserver_etcdir,          [$domserver_root/etc])
 AX_PATH(domserver_webappdir,       [$domserver_root/webapp])
 AX_PATH(domserver_sqldir,          [$domserver_root/sql])
 AX_PATH(domserver_libdir,          [$domserver_root/lib])
-AX_PATH(domserver_libvendordir,    [$domserver_root/lib/vendor])
 AX_PATH(domserver_logdir,          [$domserver_root/log])
 AX_PATH(domserver_rundir,          [$domserver_root/run])
 AX_PATH(domserver_tmpdir,          [$domserver_root/tmp])
@@ -382,7 +380,6 @@ echo " * domserver...........: AX_VAR_EXPAND($domserver_root)"
 echo "    - bin..............: AX_VAR_EXPAND($domserver_bindir)"
 echo "    - etc..............: AX_VAR_EXPAND($domserver_etcdir)"
 echo "    - lib..............: AX_VAR_EXPAND($domserver_libdir)"
-echo "    - libvendor........: AX_VAR_EXPAND($domserver_libvendordir)"
 echo "    - log..............: AX_VAR_EXPAND($domserver_logdir)"
 echo "    - run..............: AX_VAR_EXPAND($domserver_rundir)"
 echo "    - sql..............: AX_VAR_EXPAND($domserver_sqldir)"
diff --git a/etc/domserver-static.php.in b/etc/domserver-static.php.in
@@ -12,7 +12,7 @@ define('ETCDIR',      '@domserver_etcdir@');
 define('WEBAPPDIR',   '@domserver_webappdir@');
 define('LIBDIR',      '@domserver_libdir@');
 define('SQLDIR',      '@domserver_sqldir@');
-define('LIBVENDORDIR','@domserver_libvendordir@');
+define('LIBVENDORDIR','@domserver_webappdir@/vendor');
 define('LOGDIR',      '@domserver_logdir@');
 define('RUNDIR',      '@domserver_rundir@');
 define('TMPDIR',      '@domserver_tmpdir@');
diff --git a/fix_location.sh b/fix_location.sh
@@ -0,0 +1,8 @@
+for i in ./webapp/public/webfonts ./webapp/public/css/fontawesome-all.min.css ./webapp/public/css/bootstrap.min.css.map ./webapp/public/css/select2.min.css ./webapp/public/css/nv.d3.min.css ./webapp/public/css/bootstrap.min.css ./webapp/public/css/select2-bootstrap-5-theme.min.css ./webapp/public/css/dataTables.bootstrap5.min.css ./webapp/public/css/nv.d3.min.css.map ./webapp/public/js/jquery.min.js ./webapp/public/js/nv.d3.min.js ./webapp/public/js/bootstrap.bundle.min.js ./webapp/public/js/d3.min.js ./webapp/public/js/nv.d3.min.js.map ./webapp/public/js/FileSaver.min.js.map ./webapp/public/js/FileSaver.min.js ./webapp/public/js/dataTables.bootstrap5.min.js ./webapp/public/js/bootstrap.bundle.min.js.map ./webapp/public/js/select2.min.js ./webapp/public/js/dataTables.min.js ./webapp/public/flags
+do
+	old=$(readlink $i)
+	new=$(readlink $i | sed 's/lib\/vendor/webapp\/vendor/')
+	echo "Changing $i from $old to $new"
+	rm $i
+	ln -s $new $i
+done
diff --git a/gitlab/base.sh b/gitlab/base.sh
@@ -48,7 +48,7 @@ parameters:
     domjudge.webappdir: /webapp
     domjudge.libdir: /lib
     domjudge.sqldir: /sql
-    domjudge.libvendordir: /lib/vendor
+    domjudge.libvendordir: /webapp/vendor
     domjudge.logdir: /output/log
     domjudge.rundir: /output/run
     domjudge.tmpdir: /output/tmp
@@ -59,7 +59,7 @@ EOF
 cd webapp
 # install check if the cache might be dirty
 set +e
-composer install --no-scripts || rm -rf lib/vendor
+composer install --no-scripts || rm -rf webapp/vendor
 set -e
 
 # install all php dependencies
diff --git a/lib/Makefile b/lib/Makefile
@@ -12,21 +12,9 @@ $(OBJECTS): %$(OBJEXT): %.c %.h
 clean-l:
 	rm -f $(OBJECTS)
 
-# Change baseDir in composer autogenerated files
-define fix_composer_paths
-	for file in autoload_psr4.php autoload_classmap.php autoload_files.php autoload_namespaces.php ; do \
-		sed -i "s#^\$$baseDir = .*#\$$baseDir = dirname('$(domserver_webappdir)');#" $(1)/composer/$$file ; \
-	done
-	sed -i "s#__DIR__ \. '/\.\./\.\./\.\.' \. '/webapp#'$(domserver_webappdir)#" $(1)/composer/autoload_static.php
-endef
-
 install-domserver:
 	$(INSTALL_DATA) -t $(DESTDIR)$(domserver_libdir)    *.php
 	$(INSTALL_PROG) -t $(DESTDIR)$(domserver_libdir)    alert
-	for i in vendor/* ; do \
-		$(call install_tree,$(DESTDIR)$(domserver_libvendordir),$$i) ; \
-	done
-	$(call fix_composer_paths,$(DESTDIR)$(domserver_libvendordir))
 
 install-judgehost:
 	$(INSTALL_DATA) -t $(DESTDIR)$(judgehost_libdir)    *.php *.sh
diff --git a/paths.mk.in b/paths.mk.in
@@ -86,7 +86,6 @@ domserver_etcdir          = @domserver_etcdir@
 domserver_webappdir       = @domserver_webappdir@
 domserver_sqldir          = @domserver_sqldir@
 domserver_libdir          = @domserver_libdir@
-domserver_libvendordir    = @domserver_libvendordir@
 domserver_logdir          = @domserver_logdir@
 domserver_rundir          = @domserver_rundir@
 domserver_tmpdir          = @domserver_tmpdir@
@@ -111,8 +110,7 @@ systemd_unitdir           = @systemd_unitdir@
 # The tmpdir's are not in these lists, since they would otherwise get
 # their permissions overwritten in FHS install mode.
 domserver_dirs = $(domserver_bindir) $(domserver_etcdir) \
-                 $(domserver_libdir) $(domserver_libvendordir) \
-                 $(domserver_logdir) $(domserver_rundir) \
+                 $(domserver_libdir) $(domserver_logdir) $(domserver_rundir) \
                  $(addprefix $(domserver_webappdir)/public/images/,affiliations countries teams) \
                  $(domserver_exampleprobdir) $(domserver_databasedumpdir)
 
@@ -137,7 +135,6 @@ define substconfigvars
 	-e 's,@domserver_webappdir[@],@domserver_webappdir@,g' \
 	-e 's,@domserver_sqldir[@],@domserver_sqldir@,g' \
 	-e 's,@domserver_libdir[@],@domserver_libdir@,g' \
-	-e 's,@domserver_libvendordir[@],@domserver_libvendordir@,g' \
 	-e 's,@domserver_logdir[@],@domserver_logdir@,g' \
 	-e 's,@domserver_rundir[@],@domserver_rundir@,g' \
 	-e 's,@domserver_tmpdir[@],@domserver_tmpdir@,g' \
diff --git a/phpstan.dist.neon b/phpstan.dist.neon
@@ -22,4 +22,4 @@ parameters:
             message: "#Method .* return type has no value type specified in iterable type array#"
             path: webapp/src/DataFixtures/Test
 includes:
-    - lib/vendor/phpstan/phpstan-doctrine/extension.neon
+    - webapp/vendor/phpstan/phpstan-doctrine/extension.neon
diff --git a/webapp/Makefile b/webapp/Makefile
@@ -9,7 +9,9 @@ include $(TOPDIR)/Makefile.global
 # Subdirectories to recurse into for REC_TARGETS
 SUBDIRS = config
 
-maintainer-conf: .env.local
+dist: composer-dependencies
+inplace-conf: composer-dependencies
+maintainer-conf: composer-dependencies-dev .env.local
 
 # Run Symfony in dev mode (for maintainer-mode):
 .env.local:
@@ -18,32 +20,62 @@ maintainer-conf: .env.local
 	@echo "# the DOMjudge Symfony application in developer mode. Adjust as needed." >> $@
 	@echo "APP_ENV=dev" >> $@
 
+# Install PHP dependencies
+composer-dependencies:
+ifeq (, $(shell command -v composer 2> /dev/null))
+	$(error "'composer' command not found in $(PATH), install it via your package manager or https://getcomposer.org/download/")
+endif
+# We use --no-scripts here because at this point the autoload.php file is
+# 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
+
+composer-dependencies-dev:
+	composer $(subst 1,-q,$(QUIET)) install --prefer-dist --no-scripts --no-plugins
+
+# Dump autoload dependencies (including plugins)
+# This is needed since symfony/runtime is a Composer plugin that runs while dumping
+# the autoload file
+composer-dump-autoload:
+	composer $(subst 1,-q,$(QUIET)) dump-autoload -o -a
+
+composer-dump-autoload-dev:
+	composer $(subst 1,-q,$(QUIET)) dump-autoload
+
 copy-bundle-assets:
 # We can not use bin/console here, as when using a fakeroot,
 # the include paths are broken. We just copy in the data we need
 	-rm -rf public/bundles/nelmioapidoc
 	mkdir -p public/bundles/nelmioapidoc
-	cp -R ../lib/vendor/nelmio/api-doc-bundle/Resources/public/* public/bundles/nelmioapidoc/
+	cp -R ../webapp/vendor/nelmio/api-doc-bundle/Resources/public/* public/bundles/nelmioapidoc/
 
 clean-l:
 	-rm -rf public/bundles/nelmioapidoc
 
+# Change baseDir in composer autogenerated files
+define fix_composer_paths
+	for file in autoload_psr4.php autoload_classmap.php autoload_files.php autoload_namespaces.php ; do \
+		sed -i "s#^\$$baseDir = .*#\$$baseDir = dirname('$(domserver_webappdir)');#" $(1)/composer/$$file ; \
+	done
+	sed -i "s#__DIR__ \. '/\.\./\.\./\.\.' \. '/webapp#'$(domserver_webappdir)#" $(1)/composer/autoload_static.php
+endef
+
 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 ; do \
+	for d in bin config migrations public resources src templates tests vendor; do \
 		$(call install_tree,$(DESTDIR)$(domserver_webappdir),$$d) ; \
 	done
+	$(call fix_composer_paths,$(DESTDIR)$(domserver_webappdir)/vendor)
 # Change webapp/public/doc symlink
 	rm $(DESTDIR)$(domserver_webappdir)/public/doc
 	ln -s $(domjudge_docdir) $(DESTDIR)$(domserver_webappdir)/public/doc
 # Now change all relative symlinks in webapp/public to their correct paths
 	for link in $$(find $(DESTDIR)$(domserver_webappdir)/public/$$dir -maxdepth 2 -type l); do \
 		target=$$(readlink $$link) ; \
-		if echo $${target} | grep -q '\.\./\.\./lib/vendor' ; then \
+		if echo $${target} | grep -q '\.\./\.\./webapp/vendor' ; then \
 			rm $$link ; \
-			realtarget=$(domserver_libvendordir)$$(echo $${target} | sed 's!^.*\.\./\.\./lib/vendor!!') ; \
+			realtarget=$(domserver_webappdir)/vendor$$(echo $${target} | sed 's!^.*\.\./\.\./webapp/vendor!!') ; \
 			ln -s $$realtarget $$link ; \
 		fi \
 	done
@@ -56,4 +88,7 @@ maintainer-clean-l:
 		done ; \
 	done
 
+composer-clean:
+	composer auto-scripts
+
 .PHONY: copy-bundle-assets
diff --git a/webapp/bin/console b/webapp/bin/console
@@ -4,11 +4,11 @@
 use App\Kernel;
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 
-if (!is_file(dirname(__DIR__, 2) . '/lib/vendor/autoload_runtime.php')) {
+if (!is_file(dirname(__DIR__, 2) . '/webapp/vendor/autoload_runtime.php')) {
     throw new LogicException('Symfony Runtime is missing. Try running "composer require symfony/runtime".');
 }
 
-require_once dirname(__DIR__, 2) . '/lib/vendor/autoload_runtime.php';
+require_once dirname(__DIR__, 2) . '/webapp/vendor/autoload_runtime.php';
 require_once dirname(__DIR__) . '/config/load_db_secrets.php';
 
 set_time_limit(0);
diff --git a/webapp/bin/phpunit b/webapp/bin/phpunit
@@ -5,20 +5,20 @@ if (!ini_get('date.timezone')) {
     ini_set('date.timezone', 'UTC');
 }
 
-if (is_file(dirname(__DIR__, 2) . '/lib/vendor/phpunit/phpunit/phpunit')) {
+if (is_file(dirname(__DIR__, 2) . '/webapp/vendor/phpunit/phpunit/phpunit')) {
     if (PHP_VERSION_ID >= 80000) {
-        require dirname(__DIR__, 2) . '/lib/vendor/phpunit/phpunit/phpunit';
+        require dirname(__DIR__, 2) . '/webapp/vendor/phpunit/phpunit/phpunit';
     } else {
-        define('PHPUNIT_COMPOSER_INSTALL', dirname(__DIR__, 2) . '/lib/vendor/autoload.php');
+        define('PHPUNIT_COMPOSER_INSTALL', dirname(__DIR__, 2) . '/webapp/vendor/autoload.php');
         require PHPUNIT_COMPOSER_INSTALL;
         PHPUnit\TextUI\Command::main();
     }
 } else {
     if (!is_file(dirname(__DIR__,
-            2) . '/lib/vendor/symfony/phpunit-bridge/bin/simple-phpunit.php')) {
+            2) . '/webapp/vendor/symfony/phpunit-bridge/bin/simple-phpunit.php')) {
         echo "Unable to find the `simple-phpunit.php` script in `vendor/symfony/phpunit-bridge/bin/`.\n";
         exit(1);
     }
 
-    require dirname(__DIR__, 2) . '/lib/vendor/symfony/phpunit-bridge/bin/simple-phpunit.php';
+    require dirname(__DIR__, 2) . '/webapp/vendor/symfony/phpunit-bridge/bin/simple-phpunit.php';
 }
diff --git a/webapp/composer.json b/webapp/composer.json
@@ -125,15 +125,15 @@
 	},
 	"autoload": {
 		"psr-4": {
-			"App\\": "webapp/src/"
+			"App\\": "src/"
 		},
 		"files": [
-			"webapp/resources/functions.php"
+			"resources/functions.php"
 		]
 	},
 	"autoload-dev": {
 		"psr-4": {
-			"App\\Tests\\": "webapp/tests/"
+			"App\\Tests\\": "tests/"
 		}
 	},
 	"config": {
@@ -144,8 +144,6 @@
 		"platform": {
 			"php": "8.1.0"
 		},
-		"vendor-dir": "lib/vendor",
-		"component-dir": "lib/vendor/components",
 		"allow-plugins": {
 			"composer/package-versions-deprecated": true,
 			"symfony/flex": true,
@@ -178,12 +176,8 @@
 	},
 	"extra": {
 		"symfony": {
-			"root-dir": "webapp/",
 			"allow-contrib": true,
 			"require": "6.4.*"
-		},
-		"runtime": {
-			"dotenv_path": "webapp/.env"
 		}
 	}
 }
diff --git a/webapp/composer.lock b/webapp/composer.lock
diff --git a/webapp/config/static.yaml.in b/webapp/config/static.yaml.in
diff --git a/webapp/public/index.php b/webapp/public/index.php
diff --git a/webapp/tests/bootstrap.php b/webapp/tests/bootstrap.php
