fix: allows user to cache the agent's configuration (#82)

BREAKING CHANGE: add a new configuration file config/forest.php and move the previous configuration to a new template file agentTemplate/forest_admin.php
ForestAdmin · Jan 16, 2024 · 8d39c44 · 8d39c44
1 parent 5ad8678
commit 8d39c44
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 40 deletions.
diff --git a/agentTemplate/forest_admin.php b/agentTemplate/forest_admin.php
@@ -0,0 +1,22 @@
+<?php
+
+use ForestAdmin\AgentPHP\Agent\Builder\AgentFactory;
+use ForestAdmin\AgentPHP\DatasourceEloquent\EloquentDatasource;
+
+return static function () {
+    $defaultDB = config('database.default');
+    app()->make(AgentFactory::class)->addDatasource(
+        new EloquentDatasource(
+            [
+                'driver'   => config('database.connections.' . $defaultDB . '.driver'),
+                'host'     => config('database.connections.' . $defaultDB . '.host'),
+                'port'     => config('database.connections.' . $defaultDB . '.port'),
+                'database' => config('database.connections.' . $defaultDB . '.database'),
+                'username' => config('database.connections.' . $defaultDB . '.username'),
+                'password' => config('database.connections.' . $defaultDB . '.password'),
+                // OR
+                // 'url' => config('database.connections.' . $defaultDB . '.url'),
+            ]
+        ),
+    );
+};
diff --git a/config/forest.php b/config/forest.php
@@ -0,0 +1,14 @@
+<?php
+
+return [
+    'debug'                => env('FOREST_DEBUG', true),
+    'authSecret'           => env('FOREST_AUTH_SECRET'),
+    'envSecret'            => env('FOREST_ENV_SECRET'),
+    'forestServerUrl'      => env('FOREST_SERVER_URL', 'https://api.forestadmin.com'),
+    'isProduction'         => env('FOREST_ENVIRONMENT', 'dev') === 'prod',
+    'prefix'               => env('FOREST_PREFIX', 'forest'),
+    'permissionExpiration' => env('FOREST_PERMISSIONS_EXPIRATION_IN_SECONDS', 300),
+    'cacheDir'             => storage_path('framework/cache/data/forest'),
+    'schemaPath'           => base_path() . '/.forestadmin-schema.json',
+    'projectDir'           => base_path(),
+];
diff --git a/config/forest_admin.php b/config/forest_admin.php
diff --git a/src/Commands/ForestInstall.php b/src/Commands/ForestInstall.php
@@ -23,6 +23,7 @@ public function handle(): void
 
         $this->call('vendor:publish', [
             '--provider' => ForestServiceProvider::class,
+            '--tag'      => 'forest',
             '--tag'      => 'config',
         ]);
     }

diff --git a/src/ForestServiceProvider.php b/src/ForestServiceProvider.php
@@ -26,11 +26,18 @@ public function boot(Kernel $kernel): void
 
         $this->publishes(
             [
-                $this->configFile() => $this->app['path.config'] . DIRECTORY_SEPARATOR . 'forest_admin.php',
+                $this->configFile() => config_path('forest.php'),
             ],
             'config'
         );
 
+        $this->publishes(
+            [
+                $this->agentTemplateFile() => $this->appForestPath() . DIRECTORY_SEPARATOR . 'forest_admin.php',
+            ],
+            'forest'
+        );
+
         $kernel->pushMiddleware(ForestCors::class);
     }
 
@@ -41,6 +48,16 @@ public function boot(Kernel $kernel): void
      */
     protected function configFile(): string
     {
-        return realpath(__DIR__ . '/../config/forest_admin.php');
+        return realpath(__DIR__ . '/../config/forest.php');
+    }
+
+    protected function agentTemplateFile(): string
+    {
+        return realpath(__DIR__ . '/../agentTemplate/forest_admin.php');
+    }
+
+    protected function appForestPath(): string
+    {
+        return base_path() . DIRECTORY_SEPARATOR . 'forest';
     }
 }
diff --git a/src/Providers/AgentProvider.php b/src/Providers/AgentProvider.php
@@ -15,7 +15,7 @@ class AgentProvider extends ServiceProvider
     public function boot()
     {
         if ($this->forestIsPlanted()) {
-            $this->app->instance(AgentFactory::class, new AgentFactory($this->loadOptions()));
+            $this->app->instance(AgentFactory::class, new AgentFactory(config('forest')));
             $this->loadConfiguration();
         }
     }
@@ -34,7 +34,7 @@ public function loadRoutes()
 
     private function forestIsPlanted(): bool
     {
-        return env('FOREST_AUTH_SECRET') && env('FOREST_ENV_SECRET');
+        return config('forest.authSecret') && config('forest.envSecret');
     }
 
     private function transformMethodsValuesToUpper(array|string $methods): array
@@ -48,28 +48,17 @@ private function transformMethodsValuesToUpper(array|string $methods): array
 
     private function loadConfiguration(): void
     {
-        if (file_exists($this->app['path.config'] . DIRECTORY_SEPARATOR . 'forest_admin.php')) {
-            $callback = require $this->app['path.config'] . DIRECTORY_SEPARATOR . 'forest_admin.php';
+        if (file_exists($this->appForestConfig())) {
+            $callback = require $this->appForestConfig();
             $callback($this);
 
             $this->app->make(AgentFactory::class)->build();
             $this->loadRoutes();
         }
     }
 
-    private function loadOptions(): array
+    private function appForestConfig(): string
     {
-        return [
-            'debug'                => env('FOREST_DEBUG', true),
-            'authSecret'           => env('FOREST_AUTH_SECRET'),
-            'envSecret'            => env('FOREST_ENV_SECRET'),
-            'forestServerUrl'      => env('FOREST_SERVER_URL', 'https://api.forestadmin.com'),
-            'isProduction'         => env('FOREST_ENVIRONMENT', 'dev') === 'prod',
-            'prefix'               => env('FOREST_PREFIX', 'forest'),
-            'permissionExpiration' => env('FOREST_PERMISSIONS_EXPIRATION_IN_SECONDS', 300),
-            'cacheDir'             => storage_path('framework/cache/data/forest'),
-            'schemaPath'           => base_path() . '/.forestadmin-schema.json',
-            'projectDir'           => base_path(),
-        ];
+        return base_path() . DIRECTORY_SEPARATOR . 'forest' . DIRECTORY_SEPARATOR . 'forest_admin.php';
     }
 }