[12.x] Dispatch framework events on composer pre-package-uninstall event (#57144)

* remove provider

* string equals string ignoring line endings

* style

* prePackageUninstall method

* rename event

* rename event

* hey this works

* formatting

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: cosmastech

src/Illuminate/Foundation/ComposerScripts.php

@@ -2,7 +2,9 @@
 
 namespace Illuminate\Foundation;
 
+use Composer\Installer\PackageEvent;
 use Composer\Script\Event;
+use Illuminate\Contracts\Console\Kernel;
 
 class ComposerScripts
 {
@@ -45,6 +47,36 @@ public static function postAutoloadDump(Event $event)
         static::clearCompiled();
     }
 
+    /**
+     * Handle the pre-package-uninstall Composer event.
+     *
+     * @param  \Composer\Installer\PackageEvent  $event
+     * @return void
+     */
+    public static function prePackageUninstall(PackageEvent $event)
+    {
+        $bootstrapFile = dirname($vendorDir = $event->getComposer()->getConfig()->get('vendor-dir')).'/bootstrap/app.php';
+
+        if (! file_exists($bootstrapFile)) {
+            return;
+        }
+
+        require_once $vendorDir.'/autoload.php';
+
+        define('LARAVEL_START', microtime(true));
+
+        /** @var Application $app */
+        $app = require_once $bootstrapFile;
+
+        $app->make(Kernel::class)->bootstrap();
+
+        /** @var \Composer\DependencyResolver\Operation\UninstallOperation $uninstallOperation */
+        $uninstallOperation = $event->getOperation()->getPackage();
+
+        $app['events']->dispatch('composer_package.'.$uninstallOperation->getName().':pre_uninstall');
+    }
+
+
     /**
      * Clear the cached Laravel bootstrapping files.
      *

src/Illuminate/Support/ServiceProvider.php

@@ -572,6 +572,51 @@ public static function addProviderToBootstrapFile(string $provider, ?string $pat
 
         $content = '<?php
 
+return [
+'.$providers.'
+];';
+
+        file_put_contents($path, $content.PHP_EOL);
+
+        return true;
+    }
+
+    /**
+     * Remove a provider from the application's provider bootstrap file.
+     *
+     * @param  string|array  $providersToRemove
+     * @param  string|null  $path
+     * @param  bool  $strict
+     * @return bool
+     */
+    public static function removeProviderFromBootstrapFile(string|array $providersToRemove, ?string $path = null, bool $strict = false)
+    {
+        $path ??= app()->getBootstrapProvidersPath();
+
+        if (! file_exists($path)) {
+            return false;
+        }
+
+        if (function_exists('opcache_invalidate')) {
+            opcache_invalidate($path, true);
+        }
+
+        $providersToRemove = Arr::wrap($providersToRemove);
+
+        $providers = (new Collection(require $path))
+            ->unique()
+            ->sort()
+            ->values()
+            ->when(
+                $strict,
+                static fn (Collection $providerCollection) => $providerCollection->reject(fn (string $p) => in_array($p, $providersToRemove, true)),
+                static fn (Collection $providerCollection) => $providerCollection->reject(fn (string $p) => Str::contains($p, $providersToRemove))
+            )
+            ->map(fn ($p) => '    '.$p.'::class,')
+            ->implode(PHP_EOL);
+
+        $content = '<?php
+
 return [
 '.$providers.'
 ];';

tests/Support/SupportServiceProviderTest.php

@@ -12,6 +12,7 @@
 class SupportServiceProviderTest extends TestCase
 {
     protected $app;
+    protected string $tempFile;
 
     protected function setUp(): void
     {
@@ -35,6 +36,9 @@ protected function setUp(): void
     protected function tearDown(): void
     {
         m::close();
+        if (isset($this->tempFile) && file_exists($this->tempFile)) {
+            @unlink($this->tempFile);
+        }
     }
 
     public function testPublishableServiceProviders()
@@ -191,6 +195,48 @@ public function testLoadTranslationsFromWithNamespace()
         $provider = new ServiceProviderForTestingOne($this->app);
         $provider->loadTranslationsFrom(__DIR__.'/translations', 'namespace');
     }
+
+    public function test_can_remove_provider()
+    {
+        $this->tempFile = __DIR__.'/providers.php';
+        file_put_contents($this->tempFile, $contents = <<< PHP
+<?php
+
+return [
+    App\Providers\AppServiceProvider::class,
+    App\Providers\TelescopeServiceProvider::class,
+];
+PHP
+        );
+        ServiceProvider::removeProviderFromBootstrapFile('TelescopeServiceProvider', $this->tempFile, true);
+
+        // Should have deleted nothing
+        $this->assertStringEqualsStringIgnoringLineEndings($contents, trim(file_get_contents($this->tempFile)));
+
+        // Should delete the telescope provider
+        ServiceProvider::removeProviderFromBootstrapFile('App\Providers\TelescopeServiceProvider', $this->tempFile, true);
+
+        $this->assertStringEqualsStringIgnoringLineEndings(<<< PHP
+<?php
+
+return [
+    App\Providers\AppServiceProvider::class,
+];
+PHP
+            , trim(file_get_contents($this->tempFile)));
+
+        // Should fuzzily delete the App\Providers\AppServiceProvider class
+        ServiceProvider::removeProviderFromBootstrapFile('AppServiceProvider', $this->tempFile);
+
+        $this->assertStringEqualsStringIgnoringLineEndings(<<< 'PHP'
+<?php
+
+return [
+
+];
+PHP
+            , trim(file_get_contents($this->tempFile)));
+    }
 }
 
 class ServiceProviderForTestingOne extends ServiceProvider