add dry run option to models-count

Author: eloquentize

README.md

@@ -9,7 +9,7 @@ Eloquentize provides a full-featured monitoring toolkit for Laravel applications
 
 [<img src="https://alpha.eloquentize.com/images/eloquentize-logo-tr.svg" width="128px" />](https://alpha.eloquentize.com/docs)
 
-# Getting start
+# Getting started
 
 ## Installation
 

src/Commands/BaseCommand.php

@@ -24,7 +24,19 @@ protected function execute(InputInterface $input, OutputInterface $output)
         if (env('APP_ENV') === null) {
             throw new \Exception('app.env is not set in .env');
         }
+        if (env('APP_URL') === "http://localhost") {
+            throw new \Exception('app.url is set to http://localhost. Please change these values in .env bevause eloquentize identifies the environment by the app.url and app.env values.');
+        }
 
         return parent::execute($input, $output);
     }
+
+    protected function cleanAppUrl($url)
+    {
+        $url = preg_replace('#^https?://#', '', $url);
+        $url = preg_replace('#^http?://#', '', $url);
+        $url = rtrim($url, '/');
+
+        return $url;
+    }
 }

src/Commands/ModelsCount.php

@@ -15,12 +15,14 @@ class ModelsCount extends BaseCommand
 {
     use BuildPeriod, DateArgument, GatherModels, HasVerbose, ModelsOption, PrepareMetricsData, SendMetricsData;
 
-    protected $signature = 'eloquentize:models-count {date?} {--event=created_at} {--periodType=daily} {--dateFormat=} {--M|models=} {--modelsPath=} {--scope=} {--scopeValue=} ';
+    protected $signature = 'eloquentize:models-count {date?} {--event=created_at} {--periodType=daily} {--dateFormat=} {--M|models=} {--modelsPath=} {--scope=} {--scopeValue=} {--dry} ';
 
     protected $description = 'Send to Eloquentize the counts of all models for a given date and event.';
 
     protected $verbose = false;
 
+    protected $dry = false;
+
     public function performModelCount(array $models, CarbonPeriod $period, string $event, ?string $modelsPath = null, ?string $scope = null, ?string $scopeValue = null)
     {
         $metrics = [];
@@ -72,6 +74,7 @@ public function handle()
         $scope = $this->option('scope');
         $scopeValue = $this->option('scopeValue');
         $filteredModels = $this->parseModelsOption($this->option('models'));
+        $this->dry = $this->option('dry') ?? false;
 
         if ($scope && ! $filteredModels) {
             $this->error('"scope" option requires "--models" option to be set. models provided should have a corresponding scope.');
@@ -98,7 +101,27 @@ public function handle()
         $metricsData = $this->prepareMetricsData($metrics, $period, $event);
 
         $this->verbose('Sending models count data to eloquentize...'.config('eloquentize.api_url').'/api/metrics/models');
-        $this->sendMetricsData($metricsData, env('ELOQUENTIZE_API_TOKEN'), $event);
+        if ($this->dry) {
+            $this->line('');
+            $this->warn('Dry run enabled. Data NOT sent to eloquentize.');
+            $this->line('');
+            $this->line('----- Source data -----');
+            $this->line('The data will be stored in source :');
+            $this->info('***** '.$this->cleanAppUrl(env('APP_URL')) . '-' . env('APP_ENV').' *****');
+            $this->line('Be sure to define a comprehensive source name by setting APP_URL ');
+            $this->line('');
+            $this->line('----- Models tracked -----');
+            $this->info(implode(', ', $models));
+            $this->line('');
+
+            // $this->line('Metrics data:');
+            // $this->line(json_encode($metricsData, JSON_PRETTY_PRINT));
+
+            return 0;
+        }else{
+            $this->sendMetricsData($metricsData, env('ELOQUENTIZE_API_TOKEN'), $event);
+        }
+        
 
         $this->line('Models count data sent to eloquentize.');
 

src/Commands/Traits/GatherModels.php

@@ -130,7 +130,7 @@ protected function isModelValid(string $modelClass, string $column): bool
     {
 
         if (! class_exists($modelClass)) {
-            $this->defaultErrorMessage();
+            //$this->defaultErrorMessage();
             $this->verbose("Model class $modelClass did not exists.", 'warn');
 
             return false;
@@ -139,28 +139,28 @@ protected function isModelValid(string $modelClass, string $column): bool
         try {
             $instance = new $modelClass;
         } catch (\Throwable $e) {
-            $this->defaultErrorMessage();
+            //$this->defaultErrorMessage();
             $this->verbose("Model class $modelClass is not instanciable.", 'warn');
 
             return false;
         }
 
         if (! $instance instanceof \Illuminate\Database\Eloquent\Model) {
-            $this->defaultErrorMessage();
+            //$this->defaultErrorMessage();
             $this->verbose("Model class $modelClass is not an instance of \Illuminate\Database\Eloquent\Model.", 'warn');
 
             return false;
         }
 
         if (! $instance->usesTimestamps()) {
-            $this->defaultErrorMessage();
+            //$this->defaultErrorMessage();
             $this->verbose("Model class $modelClass does not use timestamps.", 'warn');
 
             return false;
         }
 
         if (! Schema::connection($instance->getConnectionName())->hasColumn($instance->getTable(), $column)) {
-            $this->defaultErrorMessage();
+            //$this->defaultErrorMessage();
             $this->verbose("Model class $modelClass does not have a column named ".$column, 'warn');
 
             return false;