Phar doesn't work after 3.3.1 #3562

hermzz · 2023-08-17T14:24:13Z

Running the phpDocumentor phar worked fine for me up to 3.3.1 but it stopped working for 3.4.0. This cropped up initially in a gitlab pipeline, it had worked fine on Aug 15 but it stopped working Aug 16. Nothing in the pipeline environment changed between runs. I was also able to replicate the issue on my personal machine.

Expected behavior

Running the phpDocumentor phar file should work.

$ curl -L https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.3.1/phpDocumentor.phar > phpdoc
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
100 22.0M  100 22.0M    0     0  19.2M      0  0:00:01  0:00:01 --:--:-- 23.8M
$ chmod +x phpdoc
$ ./phpdoc
phpDocumentor v3.3.1

Parsing files
 129/129 [============================] 100%
Applying transformations (can take a while)
 4/4 [============================] 100%
All done in 1 seconds!

Actual behavior

The phpDocumentor phar complains about Failed to open stream: phar error: no directory in "phar:///[redacted]/phpdoc/bin/phpdoc"

$ curl -L https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.4.0/phpDocumentor.phar > phpdoc
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
100 14.4M  100 14.4M    0     0  9093k      0  0:00:01  0:00:01 --:--:-- 13.5M
$ chmod +x phpdoc
$ ./phpdoc
PHP Warning:  require(phar:///[redacted]/phpdoc/bin/phpdoc): Failed to open stream: phar error: no directory in "phar:///[redacted]/phpdoc/bin/phpdoc", must have at least phar:///[redacted]/phpdoc/bin/phpdoc/ for root directory (always use full p
ath to a new phar) in /[redacted]/phpdoc on line 10
PHP Fatal error:  Uncaught Error: Failed opening required 'phar:///[redacted]/phpdoc/bin/phpdoc' (include_path='.:') in [redacted]/phpdoc:10
Stack trace:
#0 {main}
  thrown in /[redacted]/phpdoc on line 10

Steps to reproduce the problem

Download phar
Set executable flag
Run the phar file

Your environment

Version used: 3.4.0
Install method: phar
PHP version: 8.2.9 and 8.1.14
Operating system and version: Arch Linux and Ubuntu 20.04.5 LTS

The text was updated successfully, but these errors were encountered:

jaapio · 2023-08-17T19:24:37Z

I think the problem you are facing is caused by the fact the new release is a zipped phar file to reduce the size of the package. When I download the file using your curl command I get the same error however when I use the original file file it still works.

Making a symlink does work, that might help you to solve your issue with to much impact.

It's unclear to me right now why this happens, I will investigate this.

hermzz · 2023-08-17T19:56:53Z

Interesting! Symlink or renaming to phpDoc.zip works.

seems like there is an issue with 3.4 for now phpDocumentor/phpDocumentor#3562

Moonomo · 2023-08-21T18:41:56Z

Making a symlink does work, that might help you to solve your issue with to much impact.

It isn't working on my end. 🤦🏼

My environment:

Version used: 3.4.0
Install method: phar
PHP version: 7.4.0
Operating system and version: MacOS Ventura 13.4.1
Device: Apple MackBook Air with M1 chip

Version 3.3.1 works just fine.

jaapio · 2023-08-21T18:43:25Z

php 7.4 is not supported anymore.

Moonomo · 2023-08-22T14:45:02Z

@jaapio right, it's failing because of the PHP 7.4. Thanks for the confirmation.

PhpDocumentor requires PHP 7.4 or higher to run

Looks like docs need to be updated accordingly.

jakzal · 2023-08-22T18:50:27Z

phive installation is broken in the same way.

jaapio · 2023-08-22T19:25:33Z

Looks like docs need to be updated accordingly.

Thanks I will update them.

phive installation is broken in the same way.

That's sad... I still haven't found an solution for this.

jrfnl · 2023-08-25T04:00:20Z

Another report here - this breaks automated workflows using setup-php to install the PHAR file (using PHP 8.1).

      - name: Install PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: '8.1'
          ini-values: display_errors=On
          coverage: none
          tools: phpdoc
        env:
          fail-fast: true

      - name: Generate the phpDoc documentation
        run: phpDocumentor

Run phpDocumentor -n
PHP Warning:  require(phar:///usr/local/bin/phpDocumentor/bin/phpdoc): Failed to open stream: phar error: no directory in "phar:///usr/local/bin/phpDocumentor/bin/phpdoc", must have at least phar:///usr/local/bin/phpDocumentor/bin/phpdoc/ for root directory (always use full path to a new phar) in /usr/local/bin/phpDocumentor on line 10

PHP Fatal error:  Uncaught Error: Failed opening required 'phar:///usr/local/bin/phpDocumentor/bin/phpdoc' (include_path='.:/usr/share/php') in /usr/local/bin/phpDocumentor:10
Stack trace:
Warning: require(phar:///usr/local/bin/phpDocumentor/bin/phpdoc): Failed to open stream: phar error: no directory in "phar:///usr/local/bin/phpDocumentor/bin/phpdoc", must have at least phar:///usr/local/bin/phpDocumentor/bin/phpdoc/ for root directory (always use full path to a new phar) in /usr/local/bin/phpDocumentor on line 10
#0 {main}

  thrown in /usr/local/bin/phpDocumentor on line 10
Fatal error: Uncaught Error: Failed opening required 'phar:///usr/local/bin/phpDocumentor/bin/phpdoc' (include_path='.:/usr/share/php') in /usr/local/bin/phpDocumentor:10
Stack trace:
#0 {main}
  thrown in /usr/local/bin/phpDocumentor on line 10

Source: https://github.com/PHPCSStandards/PHPCSUtils/actions/runs/5971668670/job/16201054407

jaapio · 2023-08-25T06:35:12Z

I finally found something... not yet the solution though... it seems to be related to the new stub file included in our phar.

jaapio · 2023-08-25T06:42:20Z

ok, it turns out that php's phar does not support all filenames, so I had to introduce an alias name to make sure the bootstrap works as expected. This alias is some kind of internal reference to the current phar.

phar://phpdocumentor.phar is a valid file path... while phar:://phpdoc isn't.

By using phar::mapPhar we allow the current phar to be renamed while files can still be loaded by it's orginal name. Fixes #3562

jaapio · 2023-08-25T06:48:59Z

v3.4.1 willl be available within minutes. This should fix your issue.

Thanks for all the reports!

jrfnl · 2023-08-25T06:57:33Z

@jaapio Thank you! I'll restart the workflows and will report back.

jrfnl · 2023-08-25T07:02:26Z

Doc generation build is passing again!

P.S.: you may want to update this sentence in the intro for the 3.4.0 release changelog to make it clear support for 8.0 has also been dropped (that's now hidden away further down in the changelog)

General changes

In this release we upgraded to Symfony 6 and PHP 7 support has been droppped completely. We added support for php 8.2.
Interally we have restructured the pipelines to prepare for multi version support in the future.

* add php codecoverage to cypress tests * escape double less than * fix phpdoc version seems like there is an issue with 3.4 for now phpDocumentor/phpDocumentor#3562 * add missing line end escape * create directory first * try to make test less flaky * try double quotes * fix sed command * use a bash script * fix phpcov path * exclude src/commands during codecoverage with cypress * merge coverage report also when running tests/run.sh * don't test experiments page over and over again after login * add more tests, cover edge case during schedule report creation * add test for HeartBeat.php, enable coverage * add cypress test for register.php * add missing declaration * fix some file path/names * oops, some more * update circleci config file * more cypress tests on search page * add input elemets * more make and search test stuff * add import test and fix csv import * use typescript for cypress, add more test, fix some php stuff * remove leftover js file * error => e * fix unit tests for getPage() of tags and teamgroups * lint cypress test files and upload merged coverage report to codecov * Update package.json * avoid log injection but this shoud not be a problem here at all * singlequote quotes * minor fixes --------- Co-authored-by: Nicolas CARPi <nico-git@deltablot.email>

jakzal · 2023-09-07T10:13:16Z

I'm still getting an error with phive on Docker:

Notice: require(): zlib: data error in /tools/.phive/phars/phpdocumentor-3.4.1.phar on line 11

Warning: require(phar://phpdocumentor.phar/bin/phpdoc): Failed to open stream: phar error: internal corruption of phar "/tools/.phive/phars/phpdocumentor-3.4.1.phar" (actual filesize mismatch on file "bin/phpdoc") in /tools/.phive/phars/phpdocumentor-3.4.1.phar on line 11

Fatal error: Uncaught Error: Failed opening required 'phar://phpdocumentor.phar/bin/phpdoc' (include_path='.:/usr/local/lib/php') in /tools/.phive/phars/phpdocumentor-3.4.1.phar:11
Stack trace:
#0 {main}
  thrown in /tools/.phive/phars/phpdocumentor-3.4.1.phar on line 11

Interestingly, phpDocumentor works when image is being built, but not when I run it on the built image. Perhaps a docker issue.

jaapio · 2023-09-07T10:39:12Z

Do you have the zip extension installed in php?

jakzal · 2023-09-07T10:57:21Z

Yes. I'm not expecting you to look into this btw.

Looking into the phar, most of PHP files are empty.

jakzal · 2023-09-16T20:44:47Z

I can reproduce the problem now.

Start a PHP Docker container

docker run -it --rm jakzal/phpqa:alpine sh

Install phpDocumentor with phar

phive --no-progress --home /tools/.phive install \
    --trust-gpg-keys 8AC0BAA79732DD42 phpDocumentor \
    -t /tools/.phive/tmp/f474e60df5620536af2224cbc21a1668 \
    && mv /tools/.phive/tmp/f474e60df5620536af2224cbc21a1668/* /tools/phpDocumentor

Run phpDocumentor (works fine)
```
/tools/phpDocumentor
```
Run phpDocumentor again (phar is now corrupted)
```
/tools/phpDocumentor
```

Other phar files on the image do not get corrupted.

dharmann · 2023-09-22T10:55:13Z

Hi@all, I'm facing a similar problem, but only the second time I run the phar.

My environment

Version used: 3.4.1
Install method: phar
PHP version: 8.1.2
Operating system and version: Ubuntu Linux 22.04.3 LTS
I've the zlib extension installed and working
I'm running the phar as normal user.

Steps to reproduce the problem:

FYI: I'm working into /tmp directory.

Download phar
$ wget https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.4.1/phpDocumentor.phar
Set executable flag
$ chmod +x phpDocumentor.phar
Run the phar file
$ ./phpDocumentor help (help command, for instance)

After these steps. from the second time I launch the phar onwards:
$ ./phpDocumentor help

I obtain the following result:

PHP Notice: require(): zlib: data error in /tmp/phpDocumentor.phar on line 11
PHP Warning: require(phar://phpdocumentor.phar/bin/phpdoc): Failed to open stream: phar error: internal corruption of phar "/tmp/phpDocumentor.phar" (actual filesize mismatch on file "bin/phpdoc") in /tmp/phpDocumentor.phar on line 11
PHP Fatal error: Uncaught Error: Failed opening required 'phar://phpdocumentor.phar/bin/phpdoc' (include_path='.:/usr/share/php') in /tmp/phpDocumentor.phar:11
Stack trace:
#0 {main}
thrown in /tmp/phpDocumentor.phar on line 11

Additionally I've extracted the phar before and after running it and seen that in the second extraction there are missing files. One for all phar://phpDocumentor.phar/bin/phpdoc

jaapio · 2023-09-22T11:59:59Z

I created a new issue, please continue there, as this issue was different.

phpdoc-bot added this to Needs triage in phpDoc issue triage board Aug 17, 2023

MarcelBolten added a commit to elabftw/elabftw that referenced this issue Aug 19, 2023

fix phpdoc version

4323030

seems like there is an issue with 3.4 for now phpDocumentor/phpDocumentor#3562

jakzal mentioned this issue Aug 22, 2023

Update toolbox 1.77.1 -> 1.78.0 jakzal/phpqa#413

Merged

jaapio self-assigned this Aug 22, 2023

jaapio closed this as completed in 42654d8 Aug 25, 2023

phpDoc issue triage board automation moved this from Needs triage to Closed Aug 25, 2023

jaapio added a commit that referenced this issue Aug 25, 2023

Fix: allow renaming of the phar release

6baf2f0

By using phar::mapPhar we allow the current phar to be renamed while files can still be loaded by it's orginal name. Fixes #3562

jaapio mentioned this issue Sep 22, 2023

Phar is modified on a run #3582

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Phar doesn't work after 3.3.1 #3562

Phar doesn't work after 3.3.1 #3562

hermzz commented Aug 17, 2023 •

edited

jaapio commented Aug 17, 2023 •

edited

hermzz commented Aug 17, 2023

Moonomo commented Aug 21, 2023 •

edited

jaapio commented Aug 21, 2023 •

edited

Moonomo commented Aug 22, 2023

jakzal commented Aug 22, 2023

jaapio commented Aug 22, 2023 •

edited

jrfnl commented Aug 25, 2023 •

edited

jaapio commented Aug 25, 2023

jaapio commented Aug 25, 2023

jaapio commented Aug 25, 2023

jrfnl commented Aug 25, 2023

jrfnl commented Aug 25, 2023

jakzal commented Sep 7, 2023

jaapio commented Sep 7, 2023

jakzal commented Sep 7, 2023

jakzal commented Sep 16, 2023 •

edited

dharmann commented Sep 22, 2023

jaapio commented Sep 22, 2023

Phar doesn't work after 3.3.1 #3562

Phar doesn't work after 3.3.1 #3562

Comments

hermzz commented Aug 17, 2023 • edited

Expected behavior

Actual behavior

Steps to reproduce the problem

Your environment

jaapio commented Aug 17, 2023 • edited

hermzz commented Aug 17, 2023

Moonomo commented Aug 21, 2023 • edited

jaapio commented Aug 21, 2023 • edited

Moonomo commented Aug 22, 2023

jakzal commented Aug 22, 2023

jaapio commented Aug 22, 2023 • edited

jrfnl commented Aug 25, 2023 • edited

jaapio commented Aug 25, 2023

jaapio commented Aug 25, 2023

jaapio commented Aug 25, 2023

jrfnl commented Aug 25, 2023

jrfnl commented Aug 25, 2023

jakzal commented Sep 7, 2023

jaapio commented Sep 7, 2023

jakzal commented Sep 7, 2023

jakzal commented Sep 16, 2023 • edited

dharmann commented Sep 22, 2023

My environment

Steps to reproduce the problem:

jaapio commented Sep 22, 2023

hermzz commented Aug 17, 2023 •

edited

jaapio commented Aug 17, 2023 •

edited

Moonomo commented Aug 21, 2023 •

edited

jaapio commented Aug 21, 2023 •

edited

jaapio commented Aug 22, 2023 •

edited

jrfnl commented Aug 25, 2023 •

edited

jakzal commented Sep 16, 2023 •

edited