Skip to content
Next Next commit
created instance tables and notifications endpoints
  • Loading branch information
gustavobascope committed Jan 21, 2025
commit b6015c596b76a4a2f32b55a9db1e54540bbadb61
46 changes: 37 additions & 9 deletions ProcessMaker/Http/Controllers/Api/DevLinkController.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,20 @@
namespace ProcessMaker\Http\Controllers\Api;

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
{
Expand Down Expand Up @@ -154,12 +158,29 @@ 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)
{
$bundle = Bundle::find('remote_id', $bundleId);
$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();
Expand All @@ -168,15 +189,14 @@ public function deleteBundle(Bundle $bundle)
public function installRemoteBundle(Request $request, DevLink $devLink, $remoteBundleId)
{
$updateType = $request->input('updateType', DevLinkInstall::MODE_UPDATE);
// DevLinkInstall::dispatch(
// $request->user()->id,
// $devLink->id,
// Bundle::class,
// $remoteBundleId,
// $updateType,
// DevLinkInstall::TYPE_INSTALL_BUNDLE,
// );
$devLink->installRemoteBundle($remoteBundleId, $updateType);
DevLinkInstall::dispatch(
$request->user()->id,
$devLink->id,
Bundle::class,
$remoteBundleId,
$updateType,
DevLinkInstall::TYPE_INSTALL_BUNDLE,
);

return [
'status' => 'queued',
Expand All @@ -199,6 +219,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()];
Expand Down
19 changes: 19 additions & 0 deletions ProcessMaker/Models/Bundle.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -391,4 +392,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());
}
}
}
}
21 changes: 21 additions & 0 deletions ProcessMaker/Models/BundleInstance.php
Original file line number Diff line number Diff line change
@@ -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);
}
}
9 changes: 9 additions & 0 deletions ProcessMaker/Models/DevLink.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -160,6 +168,7 @@ public function installRemoteBundle($remoteBundleId, $updateType)
'name' => $bundleInfo['name'],
'published' => $bundleInfo['published'],
'version' => $bundleInfo['version'],
'webhook_token' => $token,
]
);

Expand Down
76 changes: 76 additions & 0 deletions ProcessMaker/Notifications/BundleUpdatedNotification.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<?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 toBroadcast($notifiable)
{
return new BroadcastMessage($this->toArray($notifiable));
}
}
Original file line number Diff line number Diff line change
@@ -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->integer('new_version_available')->nullable()->after('version');
});
}

/**
* Reverse the migrations.
*/
public function down(): void
{
Schema::table('bundles', function (Blueprint $table) {
$table->dropColumn('new_version_available');
});
}
};
Original file line number Diff line number Diff line change
@@ -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');
}
};
Original file line number Diff line number Diff line change
@@ -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');
});
}
};
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,4 @@ export default [
type: "public_files",
name: "Public Files",
},
{
type: "translations",
name: "Translations",
},
];
3 changes: 3 additions & 0 deletions routes/api.php
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,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');
Expand All @@ -416,3 +418,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');