feature/FOUR-20548 Create new tables and endpoints to register the instances that had installed the bundles for notifications

ProcessMaker/Http/Controllers/Api/DevLinkController.php

@@ -2,17 +2,22 @@
 
 namespace ProcessMaker\Http\Controllers\Api;
 
+use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Notification;
 use Illuminate\Validation\Rule;
 use ProcessMaker\Exception\ValidationException;
 use ProcessMaker\Http\Controllers\Controller;
 use ProcessMaker\Http\Resources\ApiCollection;
 use ProcessMaker\Jobs\DevLinkInstall;
 use ProcessMaker\Models\Bundle;
 use ProcessMaker\Models\BundleAsset;
+use ProcessMaker\Models\BundleInstance;
 use ProcessMaker\Models\BundleSetting;
 use ProcessMaker\Models\DevLink;
 use ProcessMaker\Models\Setting;
+use ProcessMaker\Models\User;
+use ProcessMaker\Notifications\BundleUpdatedNotification;
 
 class DevLinkController extends Controller
 {
@@ -154,12 +159,34 @@ public function updateBundle(Request $request, Bundle $bundle)
 
     public function increaseBundleVersion(Bundle $bundle)
     {
+        $bundle->notifyBundleUpdated();
+
         $bundle->version = $bundle->version + 1;
         $bundle->saveOrFail();
 
         return $bundle;
     }
 
+    public function bundleUpdated($bundleId, $token)
+    {
+        try {
+            $bundle = Bundle::where('remote_id', $bundleId)->firstOrFail();
+        } catch (ModelNotFoundException $e) {
+            return response()->json(['error' => 'Bundle not found'], 403);
+        }
+
+        $storedToken = $bundle->webhook_token;
+
+        if ($token !== $storedToken) {
+            return response()->json(['error' => 'Invalid token'], 403);
+        }
+        $adminUsers = User::where('is_administrator', true)->get();
+
+        Notification::send($adminUsers, new BundleUpdatedNotification($bundle));
+
+        return $bundle;
+    }
+
     public function deleteBundle(Bundle $bundle)
     {
         $bundle->delete();
@@ -198,6 +225,14 @@ public function reinstallBundle(Request $request, Bundle $bundle)
         ];
     }
 
+    public function addBundleInstance(Request $request, Bundle $bundle)
+    {
+        BundleInstance::create([
+            'bundle_id' => $bundle->id,
+            'instance_url' => $request->input('instance_url'),
+        ]);
+    }
+
     public function exportLocalBundle(Bundle $bundle)
     {
         return ['payloads' => $bundle->export()];

ProcessMaker/Jobs/DevLinkInstall.php

@@ -48,6 +48,8 @@ public function __construct(
      */
     public function handle(): void
     {
+        //log
+        \Log::info('DevLinkInstall job started: ' . $this->devLinkId);
         $devLink = DevLink::findOrFail($this->devLinkId);
         $logger = new Logger($this->userId);
 

ProcessMaker/Models/Bundle.php

@@ -3,6 +3,7 @@
 namespace ProcessMaker\Models;
 
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Support\Facades\Http;
 use ProcessMaker\Exception\ExporterNotSupported;
 use ProcessMaker\Exception\ValidationException;
 use ProcessMaker\ImportExport\Importer;
@@ -400,4 +401,22 @@ public function reinstall(string $mode, Logger $logger = null)
 
         $logger?->setStatus('done');
     }
+
+    public function notifyBundleUpdated()
+    {
+        $bundleInstances = BundleInstance::where('bundle_id', $this->id)->get();
+        foreach ($bundleInstances as $bundleInstance) {
+            $url = $bundleInstance->instance_url;
+
+            try {
+                $response = Http::post($url);
+
+                if ($response->status() === 403) {
+                    \Log::error("Failed to notify bundle update for URL: $url " . $response);
+                }
+            } catch (\Exception $e) {
+                \Log::error('Error notifying bundle update: ' . $e->getMessage());
+            }
+        }
+    }
 }

ProcessMaker/Models/BundleInstance.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace ProcessMaker\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use ProcessMaker\Models\ProcessMakerModel;
+
+class BundleInstance extends ProcessMakerModel
+{
+    use HasFactory;
+
+    protected $fillable = [
+        'bundle_id',
+        'instance_url',
+    ];
+
+    public function bundle()
+    {
+        return $this->belongsTo(Bundle::class);
+    }
+}

ProcessMaker/Models/DevLink.php

@@ -138,6 +138,14 @@ public function installRemoteBundle($remoteBundleId, $updateType)
         $this->logger->status(__('Downloading bundle from remote instance'));
 
         $bundleInfo = $this->remoteBundle($remoteBundleId)->json();
+        $token = Str::random(60);
+
+        $addBundleInstance = $this->client()->post(
+            route('api.devlink.add-bundle-instance', ['bundle' => $remoteBundleId], false),
+            [
+                'instance_url' => env('APP_URL') . '/devlink/bundle-updated/' . $remoteBundleId . '/' . $token,
+            ]
+        );
 
         $bundleExport = $this->client()->get(
             route('api.devlink.export-local-bundle', ['bundle' => $remoteBundleId], false)
@@ -160,6 +168,7 @@ public function installRemoteBundle($remoteBundleId, $updateType)
                 'name' => $bundleInfo['name'],
                 'published' => $bundleInfo['published'],
                 'version' => $bundleInfo['version'],
+                'webhook_token' => $token,
             ]
         );
 

ProcessMaker/Notifications/BundleUpdatedNotification.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace ProcessMaker\Notifications;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\BroadcastMessage;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+use ProcessMaker\Models\Bundle;
+
+class BundleUpdatedNotification extends Notification
+{
+    use Queueable;
+
+    private $bundleName;
+
+    private $bundleUid;
+
+    /**
+     * Create a new notification instance.
+     */
+    public function __construct(Bundle $bundle)
+    {
+        $this->bundleName = $bundle->name;
+        $this->bundleUid = $bundle->id;
+    }
+
+    /**
+     * Get the notification's delivery channels.
+     *
+     * @return array<int, string>
+     */
+    public function via(object $notifiable): array
+    {
+        return ['broadcast', NotificationChannel::class];
+    }
+
+    /**
+     * Get the mail representation of the notification.
+     */
+    public function toMail(object $notifiable): MailMessage
+    {
+        return (new MailMessage)
+                    ->line('The introduction to the notification.')
+                    ->action('Notification Action', url('/'))
+                    ->line('Thank you for using our application!');
+    }
+
+    /**
+     * Get the array representation of the notification.
+     *
+     * @return array<string, mixed>
+     */
+    public function toArray($notifiable)
+    {
+        $bundle = Bundle::find($this->bundleUid);
+
+        return [
+            'type' => 'BUNDLE_UPDATED',
+            'message' => sprintf('Bundle updated: %s', $this->bundleName),
+            'dateTime' => $bundle->updated_at->toIso8601String(),
+            'name' => $this->bundleName,
+            'bundleName' => $this->bundleName,
+            'url' => sprintf(
+                '/admin/devlink/local-bundles/%s/',
+                $this->bundleUid
+            ),
+        ];
+    }
+
+    public function toDatabase($notifiable)
+    {
+        return $this->toArray($notifiable);
+    }
+
+    public function toBroadcast($notifiable)
+    {
+        return new BroadcastMessage($this->toArray($notifiable));
+    }
+}

database/migrations/2025_01_16_202146_create_bundle_instances_table.php

@@ -0,0 +1,30 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('bundle_instances', function (Blueprint $table) {
+            $table->id();
+            $table->unsignedBigInteger('bundle_id');
+            $table->string('instance_url');
+            $table->timestamps();
+
+            $table->index(['bundle_id']);
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('bundle_instances');
+    }
+};

database/migrations/2025_01_20_163338_add_webhook_token_to_bundles_table.php

@@ -0,0 +1,27 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::table('bundles', function (Blueprint $table) {
+            $table->string('webhook_token')->nullable();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::table('bundles', function (Blueprint $table) {
+            $table->dropColumn('webhook_token');
+        });
+    }
+};

resources/js/admin/devlink/components/platformConfigurations.js

@@ -31,8 +31,4 @@ export default [
     type: "public_files",
     name: "Public Files",
   },
-  {
-    type: "translations",
-    name: "Translations",
-  },
 ];

resources/js/notifications/components/notification-message.vue

@@ -36,6 +36,7 @@ const messages = {
   TASK_OVERDUE: "Task {{- subject }} is overdue. Originally due on {{- due }}",
   PROCESS_CREATED: "{{- user}} started the process {{- subject }}",
   PROCESS_COMPLETED: "{{- subject }} completed",
+  BUNDLE_UPDATED: "The bundle {{- subject }} has a new version. Click to check it",
   ERROR_EXECUTION: "{{- subject }} caused an error",
   COMMENT: "{{- user}} commented on {{- subject}}",
   "ProcessMaker\\Notifications\\ImportReady": "Imported {{- subject }}",

routes/api.php

@@ -397,6 +397,8 @@
         Route::post('devlink/local-bundles', [DevLinkController::class, 'createBundle'])->name('devlink.create-bundle');
         Route::put('devlink/local-bundles/{bundle}', [DevLinkController::class, 'updateBundle'])->name('devlink.update-bundle');
         Route::post('devlink/local-bundles/{bundle}/increase-version', [DevLinkController::class, 'increaseBundleVersion'])->name('devlink.increase-bundle-version');
+        Route::post('devlink/local-bundles/{bundle}/add-bundle-instance', [DevLinkController::class, 'addBundleInstance'])->name('devlink.add-bundle-instance');
+        Route::post('devlink/bundle-updated/{bundle}', [DevLinkController::class, 'bundleUpdated'])->name('devlink.bundle-updated');
         Route::post('devlink/local-bundles/{bundle}/add-assets', [DevLinkController::class, 'addAsset'])->name('devlink.add-asset');
         Route::post('devlink/local-bundles/{bundle}/add-settings', [DevLinkController::class, 'addSettings'])->name('devlink.add-settings');
         Route::post('devlink/local-bundles/add-asset-to-bundles', [DevLinkController::class, 'addAssetToBundles'])->name('devlink.add-asset-to-bundles');
@@ -417,3 +419,4 @@
         Route::get('devlink/{devLink}', [DevLinkController::class, 'show'])->name('devlink.show');
     });
 });
+Route::post('devlink/bundle-updated/{bundle}/{token}', [DevLinkController::class, 'bundleUpdated'])->name('devlink.bundle-updated');

tests/Model/DevLinkTest.php

@@ -93,6 +93,7 @@ public function testInstallRemoteBundle()
             'http://remote-instance.test/api/1.0/devlink/export-local-bundle/123/settings-payloads' => Http::response([
                 'payloads' => $exportsSettingsPayloads,
             ]),
+            'http://remote-instance.test/api/1.0/devlink/local-bundles/123/add-bundle-instance' => Http::response([], 200),
         ]);
 
         $devLink = DevLink::factory()->create([
@@ -237,6 +238,7 @@ public function testUpdateBundle()
             'http://remote-instance.test/api/1.0/devlink/export-local-bundle/123/settings-payloads' => Http::response([
                 'payloads' => $exportsSettingsPayloads,
             ]),
+            'http://remote-instance.test/api/1.0/devlink/local-bundles/123/add-bundle-instance' => Http::response([], 200),
         ]);
 
         $devLink->installRemoteBundle(123, 'update');