ETT-634 Use composer rather than downloading phar files by moseshll · Pull Request #122 · hathitrust/catalog

moseshll · 2026-01-20T03:52:33Z

Remove PEAR from the Dockerfile
Install composer with other PHP dependencies
- composer.json and composer.lock (it's a big one!) are our Gemfile analogues.
Use standard autoload line in place of PEAR requires: require_once 'vendor/autoload.php'
Add Playwright tests to make sure some of the less commonly used API endpoints are not broken by the composer transition
Installation of dependencies to vendor/ (à la bundle install) should not need to be done manually since I have added a lightweight composer service as a dependency for vufind and phpunit in the docker compose. This should work inside the babel project without modification, I hope?
- There is weak evidence (a possibly hallucinatory Google AI summary) that composer install does not wipe-and-reinstall if vendor/ matches the data in composer.lock, making it a near-noop. If so then this approach should not be burdensome so long as it's reliable.
Remove apparently-unneeded PHP extensions installed by the Dockerfile.
Staged on dev-2 -- composer is now available
deploydeploy.sh script invoke composer and adds it to the git archive tarball it sends to production
TODO: test with beta-1
NOT TODO: we are using an old version of phpunit but it does not appear to be a zero-effort upgrade path, so out of scope.

Note: do not merge until we have composer available on the relevant VMs

…h need for messing around with the include path. - We should have most of PEAR taken care of. - `test/RecordUtilsTest.php` was having trouble with the `global $htstatus` that PHPUnit wants to set to null. - PHPUnit vendored (and slightly version bumped, although it is still a couple major versions old).

- Fix two warnings/errors in HTID.php exposed by playwright tests.

…ry to only invoke it when needed. - Will this get in the way by running too often?

moseshll · 2026-01-20T17:16:18Z

      header('Content-type: text/html; charset=UTF-8');
      echo "<h1>Not found</h1>";
-      echo "'$id' is not a valid record identifier.";
+      echo "'$htid' is not a valid record identifier.";


Bug exposed by playwright tests

moseshll · 2026-01-20T17:16:29Z



-    header("Location: /Record/$id", true, '301 Moved Permanently');
+    header("Location: /Record/$id", true, 301);


Bug exposed by playwright tests

moseshll · 2026-01-20T17:20:11Z


+require_once 'vendor/autoload.php';
 require_once 'sys/LoggingPager.php';
 require_once 'Pager/Pager.php';


Is Pager/Pager.php PEAR or a built-in? May be able to remove it.

It's PEAR plus our own subclass Pager_LoggingPager that is indeed used, but I don't know what it brings to the table vs the base PEAR class. It doesn't seem to actually do any logging.

moseshll · 2026-01-20T17:25:08Z



 $HT_COLLECTIONS =  eval(file_get_contents('__DIR__/../derived_data/ht_collections.php'));
+global $htstatus;


phpunit has a reputation for not playing nicely with globals. These tests apparently broke because we updated the version slightly with composer. This two-line declare/assign is needed to keep the variable from becoming null inside the individual tests.

moseshll · 2026-01-20T17:26:52Z

    profiles:
      - playwright

+  composer:


Run this before another of the PHP services (vufind, phpunit) to make sure the dependencies are there.

aelkiss

Haven't tried this out yet but just looking at what's here:

Doing the composer install in this way via docker compose looks pretty slick and could be an approach we take with the bundle install in ruby-land.
Generally with bundler in ruby we've used a separate volume in the docker compose rather than installing them in the working directory. There are pros and cons either way. If we add them in the working directory we need to make sure the vendor directory is ignored in .dockerignore.
As far as deployment, I would probably expect we'd do the composer install in test.catalog as part of staging, then deploy everything.

aelkiss · 2026-01-21T18:27:21Z

Another thought is that there are a bunch of Debian packages we're installing (php-curl, php-gd, etc) that might be better installed via composer, but so long as things work as expected like this, migrating those could be a second phase of work.

liseli

I've started the Catalog application locally, and all the features are working smoothly. I'll go ahead and approve it.

moseshll · 2026-01-27T19:27:06Z

I will see if composer is available on dev-2 and test there. I don't have any real familiarity with the deploy script so I want to study it.

aelkiss · 2026-01-27T21:29:39Z

@moseshll It should be. Let me know if you run into any issues.

moseshll · 2026-01-27T21:38:12Z

I've downgraded some of the dependencies for PHP 7. We can bump them back up after we're fully on board with PHP 8 everywhere. Still TODO: deploy script needs vendor added to the tarball that's being SSHed to the webservers.

…before sending to production servers. - I don't know if this will actually work -- i.e., I have not tested `deploy()` just the other parts

moseshll · 2026-01-27T22:19:37Z

@aelkiss I've downgraded some of the dependencies according to the environment on dev-2. The real question is whether we want to go with the modified deploy.sh I just pushed. I can't see any glaring flaws with it, but....

It does assume composer install has already been called, and that the vendor directory is there. I should probably add an explicit check for vendor/ as noted in the comments, and also call composer install even if it's a no-op.

aelkiss · 2026-01-27T22:46:39Z

@moseshll I'll take a look at the revised deploy script. The changes you're suggesting shouldn't hurt.

aelkiss

Changes in the deploy script look reasonable enough; as you said I think it doesn't hurt to run composer & to bail out if that fails and/or vendor doesn't exist. We should certainly test deploying to preview.catalog (which may have some other issues going on right now -- we may actually want to clear out beta-1.catalog and try deploying to that, for want of somewhere to test with) before deploying to production, though.

…ng deployment tarball.

moseshll · 2026-01-28T17:14:00Z

Deployed to beta-1. I'm going to pause to take a few breaths then plan to merge and deploy.

moseshll added 7 commits January 16, 2026 16:28

Initial checkin

3c9a605

Still messing around

17b92f5

- Playwright tests for some API-like endpoints.

a3440ba

- Fix two warnings/errors in HTID.php exposed by playwright tests.

Remove obsolete vufind-pear.txt

c08b3df

Use standard autoload require line

79c1c80

- Move composer invocation from Docker file to docker-compose and t…

7eceb4f

…ry to only invoke it when needed. - Will this get in the way by running too often?

moseshll commented Jan 20, 2026

View reviewed changes

Remove commented-out PEAR include

8b7163b

moseshll commented Jan 20, 2026

View reviewed changes

moseshll added 2 commits January 20, 2026 12:30

Use standard autoload require line

7ef22c7

Remove apparently unneeded Debian PHP extensions

0d0a4e0

moseshll marked this pull request as ready for review January 21, 2026 15:50

moseshll requested review from aelkiss, kron-spar and liseli January 21, 2026 15:52

aelkiss reviewed Jan 21, 2026

View reviewed changes

kron-spar approved these changes Jan 23, 2026

View reviewed changes

Add .dockerignore that excludes vendor and coverage, plus odds and ends

122bad6

liseli approved these changes Jan 26, 2026

View reviewed changes

Downgrade some composer dependencies for PHP 7.X compatibility.

cb4ec15

Modify deploy.sh to add vendor/ to the tar output of git archive …

974cb80

…before sending to production servers. - I don't know if this will actually work -- i.e., I have not tested `deploy()` just the other parts

aelkiss self-requested a review January 27, 2026 22:46

aelkiss approved these changes Jan 28, 2026

View reviewed changes

Run composer install and check for vendor directory before creati…

fb38a3a

…ng deployment tarball.

moseshll merged commit d04778d into main Jan 29, 2026
2 checks passed

moseshll deleted the ETT-634_composer branch January 29, 2026 18:05



		header("Location: /Record/$id", true, '301 Moved Permanently');
		header("Location: /Record/$id", true, 301);



		$HT_COLLECTIONS = eval(file_get_contents('__DIR__/../derived_data/ht_collections.php'));
		global $htstatus;

Conversation

moseshll commented Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

moseshll Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

moseshll Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

moseshll Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

moseshll Jan 21, 2026

Choose a reason for hiding this comment

Uh oh!

moseshll Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

moseshll Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

aelkiss left a comment

Choose a reason for hiding this comment

Uh oh!

aelkiss commented Jan 21, 2026

Uh oh!

liseli left a comment

Choose a reason for hiding this comment

Uh oh!

moseshll commented Jan 27, 2026

Uh oh!

aelkiss commented Jan 27, 2026

Uh oh!

moseshll commented Jan 27, 2026

Uh oh!

moseshll commented Jan 27, 2026

Uh oh!

aelkiss commented Jan 27, 2026

Uh oh!

aelkiss left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

moseshll commented Jan 28, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

moseshll commented Jan 20, 2026 •

edited

Loading

aelkiss left a comment •

edited

Loading