Improve support to install extensions from source.

[shivammathur]

After work done by @alcaeus in #399, extensions on GitHub can be installed from source.

- name: Setup PHP and remove shared extension
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.4'  
    extensions: mongodb-mongodb/mongo-php-driver@v1.9

I would like to propose the following improvements.

Support any git repository

This should also work

- name: Setup PHP and remove shared extension
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.4'  
    extensions: mongodb-https://github.com/mongodb/mongo-php-driver@v1.9

add_extension_from_github can be renamed to add_extension_from_source.

Add support for extensions in subdirectory

- name: Setup PHP and remove shared extension
  uses: shivammathur/setup-php@v2
  with:
    php-version: '7.4'  
    extensions: protobuf-protocolbuffers/protobuf@v3.15.2
  env:
    PROTOBUF_PATH: php/ext/google/protobuf

<EXTENSION>__PATH can be used to specify subdirectory.

Regex to check extension can be (https://regex101.com/r/vgIAmG/1)
Group 2 will be optional, and contain the URL.
Parsing this can be moved to a new function in utils.ts.

Add a check to ensure that the repo contains a PHP extension

• The repo should have a config.m4 file which contains the call to PHP_NEW_EXTENSION macro.

add_extension_from_source() {
...
  if ! [[ -e ./config.m4 && grep 'PHP_NEW_EXTENSION' ./config.m4 ]]; then
    add_log "$cross" "$extension" "Provided repository does not contain a PHP extension"
  fi
...
}

Add support to specify configure arguments

• Adding this in extensions input would complicate it. Instead environment variables should be used.

• Call to configure script can have the following structure.

CONFIGURE_PREFIX_OPTS ./configure CONFIGURE_SUFFIX_OPTS

So, support for these 3 arguments can be added.

• <EXTENSION>_CONFIGURE_PREFIX_OPTS. For example MONGODB_CONFIGURE_PREFIX_OPTS
• <EXTENSION>_CONFIGURE_SUFFIX_OPTS
• <EXTENSION>_CONFIGURE_OPTS (Alias of <EXTENSION>_CONFIGURE_SUFFIX_OPTS)

- name: Setup PHP and remove shared extension
  uses: shivammathur/setup-php@v2
  with:
    php-version: '8.0'  
    extensions: http-m6w6/ext-http@v4.0.0
  env:
    HTTP_CONFIGURE_PREFIX_OPTS: "CFLAGS=-Wno-implicit-function-declaration"
    HTTP_CONFIGURE_OPTS: "--with-http" # or  HTTP_CONFIGURE_SUFFIX_OPTS: "--with-http"

add_extension_from_source() {
  ...
  prefix_opts_var="${extension}_CONFIGURE_PREFIX_OPTS"
  suffix_opts_var="${extension}_CONFIGURE_SUFFIX_OPTS"
  opts_var="${extension}_CONFIGURE_OPTS"
  IFS=' ' read -r -a prefix_opts <<< "${!prefix_opts_var}"
  IFS=' ' read -r -a suffix_opts <<< "${!suffix_opts_var}"
  IFS=' ' read -r -a opts <<< "${!opts_var}"
  phpize
  "${prefix_opts[@]}" ./configure "${suffix_opts[@]}" "${opts[@]}"
  ...
}

Add support for libraries required by extension

add_libs() {
  libs=("$@")
  if [ $(uname -s) = "Linux" ]; then
    install_packages "${libs[@]}"
  else
    brew install "${libs[@]}"
  fi
}

add_extension_from_source() {
  ...
  libs_var="${extension}_LIBS"
  IFS=' ' read -r -a libs <<< "${!libs_var}"
  add_libs "${libs[@]}"
  ...
}

[shivammathur]

//cc @alcaeus

[alcaeus]

Thanks for writing up a list!

Most of these look relatively easy to implement. I'll most likely start with arguments for the configure command and adding support for required libs as that's something we need to test for with the MongoDB extension anyways (people can build with bundled libmongoc or use a system-installed libmongoc).

I'll take a look at the rest as I have the time to do so.

[alcaeus]

@shivammathur I finally got around to starting to work on this. I noticed that the develop branch already allows installing from any repository. Which of the items above have you already implemented, and which one are you looking for help with?

[shivammathur]

Sorry for not updating the above list.
I ended up implementing all of these while refactoring internal code to use the add_extension_from_source function.

In addition to the above changes, I also did the following

• Logs of the extension build should now be visible for debugging and grouped.
• submodules should be now be fetched in parallel.
• Abstracted the add_extension_from_source call from extensions.ts to utils.ts in parseExtensionSource.

Please have a look at the changes and let me know if you think any improvements can be made or have any questions.

Next work I think would be adding caching.

[alcaeus]

I'll check out the changes and work on caching. I've got time this week so it's best to get to it before I get busy with other work again.

Thanks for making all these changes! 💚

[TheLevti]

Related feature request for configuring extensions: #419

[shivammathur]

Released 2.11.0 with these changes