feat: #168 support rewrite rules

ptah-sh · Sep 6, 2024 · d4f0779 · d4f0779
1 parent c148295
commit d4f0779
Show file tree

Hide file tree

Showing 10 changed files with 191 additions and 50 deletions.
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,5 +1,7 @@
 set -e
 
 php artisan ide-helper:actions
+vendor/bin/pint _ide_helper_actions.php
+git add _ide_helper_actions.php
 
 lint-staged
diff --git a/Dockerfile b/Dockerfile
@@ -36,4 +36,5 @@ RUN php composer.phar install \
     && apt-get -y remove npm unzip \
     && apt-get -y clean \
     && apt-get -y autoremove \
-    && mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
+    && mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini" \
+    && echo "memory_limit = 256M" >> "$PHP_INI_DIR/php.ini"
diff --git a/_ide_helper_actions.php b/_ide_helper_actions.php
@@ -13,9 +13,8 @@
  * @method static dispatchAfterResponse(\App\Models\User $user, \App\Models\Node $node, string $advertiseAddr)
  * @method static mixed run(\App\Models\User $user, \App\Models\Node $node, string $advertiseAddr)
  */
-class InitCluster
-{
-}
+class InitCluster {}
+
 namespace App\Actions\Services;
 
 /**
@@ -29,32 +28,23 @@ class InitCluster
  * @method static dispatchAfterResponse(\App\Models\User $user, \App\Models\Service $service, \App\Models\DeploymentData $deploymentData)
  * @method static \App\Models\Deployment run(\App\Models\User $user, \App\Models\Service $service, \App\Models\DeploymentData $deploymentData)
  */
-class StartDeployment
-{
-}
+class StartDeployment {}
+
 namespace Lorisleiva\Actions\Concerns;
 
 /**
  * @method void asController()
  */
-trait AsController
-{
-}
+trait AsController {}
 /**
  * @method void asListener()
  */
-trait AsListener
-{
-}
+trait AsListener {}
 /**
  * @method void asJob()
  */
-trait AsJob
-{
-}
+trait AsJob {}
 /**
  * @method void asCommand(\Illuminate\Console\Command $command)
  */
-trait AsCommand
-{
-}
+trait AsCommand {}
diff --git a/app/Models/Deployment.php b/app/Models/Deployment.php
@@ -113,35 +113,52 @@ public function asNodeTasks(): array
                 $caddyHandlers[] = collect($process->caddy)->map(function (Caddy $caddy) use ($deployment, $process) {
                     $routes = [];
 
+                    $handlers = [];
+
+                    $pathRegexps = [];
+                    foreach ($process->rewriteRules as $rewriteRule) {
+                        $pathRegexps[] = [
+                            'find' => $rewriteRule->pathFrom,
+                            'replace' => $rewriteRule->pathTo,
+                        ];
+                    }
+
+                    if (! empty($pathRegexps)) {
+                        $handlers[] = [
+                            'handler' => 'rewrite',
+                            'path_regexp' => $pathRegexps,
+                        ];
+                    }
+
+                    $handlers[] = [
+                        'handler' => 'reverse_proxy',
+                        'headers' => [
+                            'request' => [
+                                'set' => $this->getForwardedHeaders($caddy),
+                            ],
+                            'response' => [
+                                'set' => [
+                                    'X-Powered-By' => ['https://ptah.sh'],
+                                    'X-Ptah-Rule-Id' => [$caddy->id],
+                                ],
+                            ],
+                        ],
+                        'transport' => $this->getTransportOptions($caddy, $process),
+                        'upstreams' => [
+                            [
+                                'dial' => "{$process->name}.{$deployment->data->internalDomain}:{$caddy->targetPort}",
+                            ],
+                        ],
+                    ];
+
                     $routes[] = [
                         'match' => [
                             [
                                 'host' => [$caddy->domain],
                                 'path' => [$caddy->path],
                             ],
                         ],
-                        'handle' => [
-                            [
-                                'handler' => 'reverse_proxy',
-                                'headers' => [
-                                    'request' => [
-                                        'set' => $this->getForwardedHeaders($caddy),
-                                    ],
-                                    'response' => [
-                                        'set' => [
-                                            'X-Powered-By' => ['https://ptah.sh'],
-                                            'X-Ptah-Rule-Id' => [$caddy->id],
-                                        ],
-                                    ],
-                                ],
-                                'transport' => $this->getTransportOptions($caddy, $process),
-                                'upstreams' => [
-                                    [
-                                        'dial' => "{$process->name}.{$deployment->data->internalDomain}:{$caddy->targetPort}",
-                                    ],
-                                ],
-                            ],
-                        ],
+                        'handle' => $handlers,
                     ];
 
                     foreach ($process->redirectRules as $redirectRule) {

diff --git a/app/Models/DeploymentData.php b/app/Models/DeploymentData.php
@@ -52,6 +52,7 @@ public static function make(array $attributes): static
             'caddy' => [],
             'fastCgi' => null,
             'redirectRules' => [],
+            'rewriteRules' => [],
         ];
 
         $defaults = [

diff --git a/app/Models/DeploymentData/Process.php b/app/Models/DeploymentData/Process.php
@@ -60,7 +60,10 @@ public function __construct(
         public ?FastCgi $fastCgi,
         #[DataCollectionOf(RedirectRule::class)]
         /* @var RedirectRule[] */
-        public array $redirectRules
+        public array $redirectRules,
+        #[DataCollectionOf(RewriteRule::class)]
+        /* @var RewriteRule[] */
+        public array $rewriteRules
     ) {}
 
     public function findVolume(string $id): ?Volume

diff --git a/app/Models/DeploymentData/RewriteRule.php b/app/Models/DeploymentData/RewriteRule.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace App\Models\DeploymentData;
+
+use Spatie\LaravelData\Data;
+
+class RewriteRule extends Data
+{
+    public function __construct(
+        public string $id,
+        public string $pathFrom,
+        public string $pathTo
+    ) {}
+}
diff --git a/database/migrations/2024_09_06_091348_alter_deployments_add_rewrite_rules_data.php b/database/migrations/2024_09_06_091348_alter_deployments_add_rewrite_rules_data.php
@@ -0,0 +1,45 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Support\Facades\DB;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        DB::update("
+            UPDATE deployments
+            SET data = jsonb_set(
+                data,
+                '{processes}',
+                (
+                    SELECT jsonb_agg(
+                        process || jsonb_build_object('rewriteRules', '[]'::jsonb)
+                    )
+                    FROM jsonb_array_elements(data -> 'processes') AS process
+                )
+            )
+        ");
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        DB::update("
+            UPDATE deployments
+            SET data = jsonb_set(
+                data,
+                '{processes}',
+                (
+                    SELECT jsonb_agg(process - 'rewriteRules')
+                    FROM jsonb_array_elements(data -> 'processes') AS process
+                )
+            )
+        ");
+    }
+};
diff --git a/resources/js/Pages/Services/Partials/DeploymentData.vue b/resources/js/Pages/Services/Partials/DeploymentData.vue
@@ -1,26 +1,19 @@
 <script setup>
 import InputError from "@/Components/InputError.vue";
-import InputLabel from "@/Components/InputLabel.vue";
-import PrimaryButton from "@/Components/PrimaryButton.vue";
-import AppLayout from "@/Layouts/AppLayout.vue";
 import TextInput from "@/Components/TextInput.vue";
 import ActionSection from "@/Components/ActionSection.vue";
-import { useForm } from "@inertiajs/vue3";
 import FormField from "@/Components/FormField.vue";
 import Select from "@/Components/Select.vue";
 import SecondaryButton from "@/Components/SecondaryButton.vue";
 import TextArea from "@/Components/TextArea.vue";
 import { computed, effect, nextTick, reactive, ref } from "vue";
-import ServiceDetailsForm from "@/Pages/Services/Partials/ServiceDetailsForm.vue";
-import TabItem from "@/Components/Tabs/TabItem.vue";
 import { FwbToggle, FwbTooltip } from "flowbite-vue";
 import ProcessTabs from "@/Pages/Services/Partials/ProcessTabs.vue";
 import DangerButton from "@/Components/DangerButton.vue";
 import DialogModal from "@/Components/DialogModal.vue";
 import AddComponentButton from "@/Components/Service/AddComponentButton.vue";
 import RemoveComponentButton from "@/Components/Service/RemoveComponentButton.vue";
 import ComponentBlock from "@/Components/Service/ComponentBlock.vue";
-import FormFieldGrid from "@/Components/FormFieldGrid.vue";
 import BackupSchedule from "@/Components/BackupSchedule.vue";
 
 const model = defineModel();
@@ -122,6 +115,16 @@ const addRedirectRule = () => {
     });
 };
 
+const addRewriteRule = () => {
+    model.value.processes[
+        state.selectedProcessIndex["caddy"]
+    ].rewriteRules.push({
+        id: makeId("rewrite-rule"),
+        pathFrom: "",
+        pathTo: "",
+    });
+};
+
 const addFastCgiVar = () => {
     model.value.processes[state.selectedProcessIndex["caddy"]].fastCgi.env.push(
         { id: makeId("fastcgi"), name: "", value: "" },
@@ -154,6 +157,7 @@ const addProcess = () => {
         replicas: 1,
         caddy: [],
         redirectRules: [],
+        rewriteRules: [],
         fastCgi: null,
     });
 
@@ -1987,6 +1991,54 @@ const extractFieldErrors = (basePath) => {
                         />
                     </FormField>
                 </ComponentBlock>
+
+                <ComponentBlock
+                    v-model="
+                        model.processes[state.selectedProcessIndex['caddy']]
+                            .rewriteRules
+                    "
+                    v-slot="{ item }"
+                    label="Rewrite Rules"
+                    @remove="
+                        model.processes[
+                            state.selectedProcessIndex['caddy']
+                        ].rewriteRules.splice($event, 1)
+                    "
+                >
+                    <FormField
+                        :error="
+                            props.errors[
+                                `processes.${state.selectedProcessIndex['caddy']}.rewriteRules.${item.$index}.pathFrom`
+                            ]
+                        "
+                        class="col-span-3"
+                    >
+                        <template #label>Path From</template>
+
+                        <TextInput
+                            v-model="item.pathFrom"
+                            class="w-full"
+                            placeholder="/old-path/(.*)"
+                        />
+                    </FormField>
+
+                    <FormField
+                        :error="
+                            props.errors[
+                                `processes.${state.selectedProcessIndex['caddy']}.rewriteRules.${item.$index}.pathTo`
+                            ]
+                        "
+                        class="col-span-3"
+                    >
+                        <template #label>Path To</template>
+
+                        <TextInput
+                            v-model="item.pathTo"
+                            class="w-full"
+                            placeholder="/new-path/$1"
+                        />
+                    </FormField>
+                </ComponentBlock>
             </div>
 
             <template v-if="hasFastCgiHandlers">
@@ -2142,6 +2194,15 @@ const extractFieldErrors = (basePath) => {
             >
                 Redirect Rule
             </AddComponentButton>
+            <AddComponentButton
+                v-if="
+                    model.processes[state.selectedProcessIndex['caddy']].caddy
+                        .length > 0
+                "
+                @click="addRewriteRule"
+            >
+                Rewrite Rule
+            </AddComponentButton>
             <SecondaryButton v-if="hasFastCgiHandlers" @click="addFastCgiVar">
                 <svg
                     class="w-4 h-4 me-2 -ms-1 text-gray-800 dark:text-white"

diff --git a/resources/js/Pages/Services/Partials/DynamicForm.vue b/resources/js/Pages/Services/Partials/DynamicForm.vue
@@ -1,6 +1,7 @@
 <script setup>
 import { computed } from "vue";
 import TextInput from "@/Components/TextInput.vue";
+import TextArea from "@/Components/TextArea.vue";
 import FormField from "@/Components/FormField.vue";
 
 const props = defineProps({
@@ -47,7 +48,13 @@ const itemName = computed(() => {
             <template #label>{{ item.label }}</template>
 
             <TextInput
-                v-if="item.type === 'text-field'"
+                v-if="item.type === 'text-field' && !item.multiline"
+                v-model="form[itemName]"
+                class="w-full"
+            />
+
+            <TextArea
+                v-else-if="item.type === 'text-field' && item.multiline"
                 v-model="form[itemName]"
                 class="w-full"
             />