StaticPHP v3

[crazywhalecc]

Important notes

STATUS: dev -> alpha -> beta -> rc -> stable

Contribution notes:

• Before we released the first alpha version, any changes should be merged into v3-dev, not v3.
• After we released the first alpha version, any changes should be merged into v3 and we will deprecate v3-dev branch.
• The structure of StaticPHP v3 may be changed before beta version.
• Publishing new RFC is welcome.

RFCs

• [RFC] 3.0 Updates - Package And Artifact Changes #959
• [RFC] 3.0 Updates - Structure Changes #960
• [RFC] 3.0 Updates - Vendor Mode Support #961
• [RFC] 3.0 Updates - Zig Support #962
• [RFC] 3.0 Updates - Parallel Building and Downloading #963
• [RFC] 3.0 Updates - Friendly Console #964
• [RFC] 3.0 drop musl toolchain #985

Progress of refactoring

bin/ refactoring

• bin/spc for v3
• bin/spc-alpine-docker
• bin/spc-gnu-docker
• bin/docker-entrypoint.sh
• bin/setup-runtime

v3 new modules

• Registry module loading for all configs and packages (StaticPHP v3 #980)
• Vendor mode support
  • Separate a dedicated bootstrap file for initialization (StaticPHP v3 #980) (src/bootstrap.php)
  • Add init-registry command for vendor user

Commands refactoring

• ConsoleApplication dynamic generating commands for target type packages (StaticPHP v3 #980)

• Custom commands in external registry (StaticPHP v3 #980)

• DownloadCommand

  • shallow-clone by default (StaticPHP v3 #980)
  • clean action (StaticPHP v3 #980)
  • --from-zip, --all, --with-openssl11 have been removed (StaticPHP v3 #980)
  • New options: --without-suggests, --for-packages, --ignore-cache, --parallel, --no-shallow-clone (StaticPHP v3 #980)
  • Porting common options: --with-php, --clean, --custom-url, --custom-git, --no-alt, --with-php (StaticPHP v3 #980)
  • Porting v2 compatible options: --for-extensions, --for-libs, --without-suggestions, --ignore-cache-sources, --prefer-pre-built (StaticPHP v3 #980)

• BaseCommand

  • New verbosity (StaticPHP v3 #980)
  • Git version display (StaticPHP v3 #980)

• BuildLibsCommand

  • Base function of building libs (StaticPHP v3 #980)
  • clean action
  • Remove --all option for build:libs (StaticPHP v3 #980)

• BuildPHPCommand -> BuildTargetCommand with php package

  • Options
    • --with-libs: Keep for compatibility, add --with-packages option (StaticPHP v3 #980)
    • --build-shared
    • --build-all: Special parsing in v3 (StaticPHP v3 #980)
    • --no-strip, --disable-opcache-jit, --build-{sapi}, --with-config-file-path, --with-config-file-scan-dir, --with-hardcoded-ini, --with-micro-fake-cli, --with-added-patch (-P), --without-micro-ext-test, --with-upx-pack, --with-micro-logo, --enable-micro-win32, --with-frankenphp-app has been moved to php package definition (StaticPHP v3 #980)
    • Implementation status
      • no-strip
      • disable-opcache-jit
      • with-config-file-path
      • with-config-file-scan-dir
      • with-hardcoded-ini
      • with-micro-fake-cli
      • with-addeed-patch
      • without-micro-ext-test
      • with-upx-pack
      • with-micro-logo
      • enable-micro-win32
      • with-frankenphp-app
      • build-shared
      • with-packages (with-libs)
      • build-all
      • build-{sapi} except build-frankenphp (StaticPHP v3 #980)
      • build-frankenphp
      • with-suggests (with-suggested-libs, with-suggested-exts)
      • no-download (StaticPHP v3 #980)
      • Download options in build command (StaticPHP v3 #980)
      • with-clean
  • Build information printing: refactored to attribute #[StaticPHP\Attribute\Package\Info] (StaticPHP v3 #980)
  • Bind build extra info to ExceptionHandler
  • Validate packages before building and after extracting (StaticPHP v3 #980)
  • Patch static-php-cli version to PHP has been moved to php package build stage before (StaticPHP v3 #980)
  • Display build PHP result in terminal
  • Export licenses and build extensions and lib info after building

• CraftCommand

• DeleteDownloadCommand

• DoctorCommand (StaticPHP v3 #980) (Just command, not Doctor items)

• DumpExtensionsCommand

• DumpLicenseCommand

• ExtractCommand (Just command, not Extractor)

  • Extractor calling
  • Options
    • New for-extensions (StaticPHP v3 #980)
    • New for-libs (StaticPHP v3 #980)
    • New for-packages (StaticPHP v3 #980)
    • New without-suggests for for-* options (StaticPHP v3 #980)

• InstallPkgCommand ->InstallPackageCommand

  • PackageInstaller calling
  • Options
    • skip-extract

• MicroCombineCommand

• SPCConfigCommand

  • SPCConfigUtil calling
  • Options

• SwitchPhpVersionCommand

• Dev commands

  • AllExtCommand
  • EnvCommand
  • ExtVerCommand
  • GenerateExtDepDocsCommand
  • GenerateExtDocCommand
  • GenerateLibDepDocsCommand
  • LibVerCommand
  • PackLibCommand
  • PhpVerCommand
  • SortConfigCommand

Doctor module

• Core framework refactored (StaticPHP v3 #980)
  • Doctor main class
  • DoctorLoader for loading check items
  • CheckResult for storing check results
  • Attribute-based check system: #[CheckItem], #[OptionalCheck], #[FixItem]
• Doctor check items
  • OSCheck (migrated from v2's OSCheckList)
  • Re2cVersionCheck
  • PkgConfigCheck
  • MacOSToolCheck (migrated from v2's MacOSToolCheckList)
  • LinuxMuslCheck
  • LinuxToolCheck (v2 has LinuxToolCheckList)
  • BSDToolCheck (v2 has BSDToolCheckList)
  • WindowsToolCheck (v2 has WindowsToolCheckList)
  • ZigCheck (v2 has ZigCheck)

Legacy modules (v2 only - SPC namespace)

These modules exist in v2 but are refactored/merged into new v3 modules:

• store/ - Deprecated and refactored
  • Downloader → StaticPHP\Artifact\ArtifactDownloader
  • LockFile → StaticPHP\Artifact\ArtifactCache
  • CurlHook → Merged into StaticPHP\Artifact\ArtifactDownloader
  • FileSystem → StaticPHP\Util\FileSystem
  • DirDiff → StaticPHP\Util\DirDiff
  • SourcePatcher → StaticPHP\Util\SourcePatcher (partial)
  • PackageManager, SourceManager → Removed (functionality in new Package/Artifact systems)
  • pkg/ → Migrated to src/Package/
  • source/ → Migrated to Artifact system

[crazywhalecc]

We should chat about what features we no longer want to support and what we want to rework.

@henderkes There's no urgent things. Just when you return from your vacation, and if you have time, it would be best we could discuss what modifications are still needed for the current framework of v3. Please feel free to contact me if you'd like.

Currently I've finished the major part of framework according to RFC, but I haven't ported most of the implementation yet, mainly to prevent major changes to the framework structure from requiring massive modifications.

And for anyone: If you have any feedback on the framework design, please let me know.

[henderkes]

I haven't had much of a look yet and the changelist is quite massive, so it might be a good idea to chat about it one evening after I had a rough glance. I'll give everything (especially vendor mode) a play and rewrite the static-php/packages properly on top of the new branch.

Might have to add versioned packages to it first though, because that's the part still holding up apk and proper apt support.

[crazywhalecc]

For a quick reference for command mode, in the current branch, the available commands:

• bin/spc doctor on Windows, macOS, Linux (linux is not fully tested)
• bin/spc build:libs libedit on *nix
• bin/spc build:php-cli readline on *nix
• bin/spc build bcmath --build-cli --debug (--build-XXX and --debug has been marked as deprecated)
• bin/spc build:libs onig on Windows
• bin/spc download {some packages}
• bin/spc download --for-extensions={some extensions}
• bin/spc extract {some package}
• bin/spc install-pkg {some package}
• bin/spc spc-config {some extensions} (still using extension as argument)

The remaining commands and some of the option implementations may not have been tested.

[crazywhalecc]

Might have to add versioned packages to it first though

You mean the dependencies' version from artifacts?

[henderkes]

Might have to add versioned packages to it first though

You mean the dependencies' version from artifacts?

No, I mean versioned .deb packages like php-zts8.3-... Nothing on the spc side.

bin/spc build bcmath --build-cli --debug (--build-XXX and --debug has been marked as deprecated)

Why is --build-cli deprecated? What would be the new way to build multiple SAPIs at once?