Added ability to view the latest deployment log.

Author: itorgov

.env.example

@@ -52,3 +52,4 @@ TELEGRAM_BOT_API_KEY=
 TELEGRAM_BOT_USERNAME=
 TELEGRAM_BOT_WEBHOOK_TOKEN=
 TELEGRAM_BOT_DONATE_COMMAND=false
+TELEGRAM_INSTANT_VIEW_HASH=

README.md

@@ -14,9 +14,11 @@
 Several years ago I have started to use Laravel Forge for deploying my and my clients' projects.
 I found that Laravel Forge couldn't send deployment notifications to Telegram messager but for me, Telegram is the number one messenger.
 That time I just wrote a simple bot with hardcoded chat id and webhook URL.
+
 During my work, I realized that I need a more flexible solution and I designed and implemented the first version of this bot.
 The first version could only send deployment notifications.
 It just generated a webhook URL for you and then you had to add that URL manually to your Laravel Forge's site.
+
 After release, I have started to work with a new client.
 This client has had a project where I haven't could to enable "Quick deploy".
 Because of that I had to go to the Laravel Forge website and hit the button "Deploy Now" whenever I needed to update the production.
@@ -85,7 +87,9 @@ We use [SemVer](http://semver.org) for versioning. For the versions available, s
 
 ## Authors
 
-* [**Ivan Torgov**](https://itorgov.com) - *initial work*
+* [**Ivan Torgov**](https://itorgov.com)
+
+See also the list of [contributors](https://github.com/itorgov/laravel-forge-bot/contributors) who participated in this project.
 
 ## Thanks
 

app/Contracts/LaravelForgeContract.php

@@ -147,4 +147,14 @@ public function createWebhook(int $serverId, int $siteId, string $url): void;
      * @return void
      */
     public function deleteWebhook(int $serverId, int $siteId, int $webhookId): void;
+
+    /**
+     *  Get the last deployment log of the site.
+     *
+     * @param int $serverId
+     * @param int $siteId
+     *
+     * @return string
+     */
+    public function getDeploymentLog(int $serverId, int $siteId): string;
 }

app/DeploymentLog.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace App;
+
+use GoldSpecDigital\LaravelEloquentUUID\Database\Eloquent\Uuid;
+use Illuminate\Database\Eloquent\Model;
+
+class DeploymentLog extends Model
+{
+    use Uuid;
+
+    /**
+     * The "type" of the primary key ID.
+     *
+     * @var string
+     */
+    protected $keyType = 'string';
+
+    /**
+     * Indicates if the IDs are auto-incrementing.
+     *
+     * @var bool
+     */
+    public $incrementing = false;
+
+    /**
+     * The attributes that aren't mass assignable.
+     *
+     * @var array
+     */
+    protected $guarded = [];
+
+    /**
+     * Returns an URL to a page with this log using the Instant View feature of Telegram.
+     *
+     * @return string
+     */
+    public function getUrlAttribute(): string
+    {
+        $query = http_build_query([
+            'url' => route('deployment-logs.show', [$this]),
+            'rhash' => config('services.telegram.instant_view.hash'),
+        ]);
+
+        return "https://t.me/iv?{$query}";
+    }
+}

app/Http/Controllers/DeploymentLogsController.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use App\DeploymentLog;
+use Illuminate\Contracts\Support\Renderable;
+
+class DeploymentLogsController extends Controller
+{
+    /**
+     * Page with deployment log.
+     *
+     * @param DeploymentLog $deploymentLog
+     *
+     * @return Renderable
+     */
+    public function show(DeploymentLog $deploymentLog): Renderable
+    {
+        return view('deployment-logs.show', [
+            'deploymentLog' => $deploymentLog,
+        ]);
+    }
+}

app/Integrations/Laravel/Forge/ThemsaidLaravelForge.php

@@ -220,4 +220,16 @@ public function deleteWebhook(int $serverId, int $siteId, int $webhookId): void
             throw new LaravelForgeException($e->getMessage());
         }
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getDeploymentLog(int $serverId, int $siteId): string
+    {
+        try {
+            return $this->forge->siteDeploymentLog($serverId, $siteId);
+        } catch (Exception $e) {
+            throw new LaravelForgeException($e->getMessage());
+        }
+    }
 }

app/Integrations/Telegram/Menu/MenuManager.php

@@ -2,9 +2,11 @@
 
 namespace App\Integrations\Telegram\Menu;
 
+use App\DeploymentLog;
 use App\Facades\LaravelForge;
 use App\Integrations\Telegram\Dialogs\AskForChatIdDialog;
 use App\Integrations\Telegram\Entities\CallbackQueryAnswer;
+use App\Integrations\Telegram\Entities\OutboundMessage;
 use App\Integrations\Telegram\Menu\Screens\AddWebhookScreen;
 use App\Integrations\Telegram\Menu\Screens\ServerScreen;
 use App\Integrations\Telegram\Menu\Screens\ServersScreen;
@@ -259,6 +261,24 @@ private function siteScreenAction(string $callbackId, string $callbackData): voi
 
                 break;
 
+            case SiteScreen::ACTION_DEPLOYMENT_LOG:
+                $log = LaravelForge::setToken($this->menu->token)->getDeploymentLog($this->menu->server->id, $this->menu->site->id);
+
+                $deploymentLog = DeploymentLog::query()->create([
+                    'server_name' => $this->menu->server->name,
+                    'site_name' => $this->menu->site->name,
+                    'content' => $log,
+                ]);
+
+                CallbackQueryAnswer::make($callbackId, '↓ Got it! See the last message. ↓')->send();
+
+                OutboundMessage::make(
+                    $this->menu->user,
+                    "[Here]({$deploymentLog->url}) is your latest deployment log for {$deploymentLog->site_name} site."
+                )->parseMode(OutboundMessage::PARSE_MODE_MARKDOWN)->send();
+
+                break;
+
             case SiteScreen::ACTION_ADD_WEBHOOK:
                 // To the "Add webhook" screen.
                 $this->screens->screen(AddWebhookScreen::NAME)->show();

app/Integrations/Telegram/Menu/Screens/SiteScreen.php

@@ -13,6 +13,7 @@ class SiteScreen extends Screen
     public const NAME = 'site';
 
     public const ACTION_DEPLOY = 'deploy';
+    public const ACTION_DEPLOYMENT_LOG = 'deployment-log';
     public const ACTION_ADD_WEBHOOK = 'add-webhook';
 
     /**
@@ -44,6 +45,8 @@ public function show(): void
         $keyboard = InlineKeyboard::make()
             ->button(InlineKeyboardButton::make('🧱 Deploy Now')->callbackData($this->generateCallbackData(self::NAME, self::ACTION_DEPLOY)))
             ->row()
+            ->button(InlineKeyboardButton::make('📝 Get latest deployment log')->callbackData($this->generateCallbackData(self::NAME, self::ACTION_DEPLOYMENT_LOG)))
+            ->row()
             ->button(InlineKeyboardButton::make('➕ Add Notification Webhook')->callbackData($this->generateCallbackData(self::NAME, self::ACTION_ADD_WEBHOOK)));
 
         $webhooks = LaravelForge::setToken($this->menu->token)->webhooks($this->menu->server->id, $this->menu->site->id);

composer.json

@@ -28,6 +28,7 @@
         "clue/socks-react": "^1.0",
         "fideloper/proxy": "^4.2",
         "fruitcake/laravel-cors": "^1.0",
+        "goldspecdigital/laravel-eloquent-uuid": "^7.0",
         "guzzlehttp/guzzle": "^6.3",
         "hashids/hashids": "^4.0",
         "irazasyed/telegram-bot-sdk": "dev-develop#5bacf81",