fix: Added logger as a dependency for storage class

- chore(tw): Wrapped import function in try catch and logged error

composer.json

@@ -17,7 +17,7 @@
     ],
     "require": {
         "php": ">=5.5",
-        "sabre/dav"     : "~4.0.2",
+        "sabre/dav"     : "~4.1.0",
         "sabre/vobject": "^4.0",
         "nesbot/carbon": "^2.0.0",
         "laminas/laminas-validator": "^2.13",

lib/Configs/ConfigBuilder.php

@@ -6,6 +6,7 @@ use Symfony\Component\Config\Definition\ConfigurationInterface;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\Processor;
 use Symfony\Component\Yaml\Yaml;
+use Carbon\CarbonTimeZone;
 
 class ConfigBuilder implements ConfigurationInterface {
   private $configs = [];
@@ -24,6 +25,8 @@ class ConfigBuilder implements ConfigurationInterface {
     $treeBuilder = new TreeBuilder();
     $rootNode = $treeBuilder->root('configs');
     $ref = $rootNode->children()
+        ->arrayNode('general')
+              ->children()
                 ->arrayNode('logger')
                   ->canBeEnabled()
                   ->children()
@@ -36,8 +39,18 @@ class ConfigBuilder implements ConfigurationInterface {
                       ->end() 
                     ->end() 
                   ->end() 
-            ->end();
+                ->end() 
-    
+                ->scalarNode('timezone')
+                  ->defaultValue('UTC')
+                    ->validate()
+                      ->IfNotInArray(CarbonTimeZone::listIdentifiers())
+                      ->thenInvalid('Invalid timezone identifier %s')
+                    ->end() 
+                  ->end() 
+                ->end() 
+              ->end() 
+            ->arrayNode('storages')
+                ->children();
     foreach ($this->configs as $config) {
       $ref = $ref->append($config->get());
     }

lib/Console.php

@@ -23,16 +23,15 @@ class Console extends AbstractConsole {
     $stdin = array_merge($stdin, $this->defaultArgs, $args); 
 
     if (isset($input)) {
-      $stdin[] = $this->convertToString($input);
+      $input = $this->convertToString($input);
     }
-    $process = new Process(implode(' ', $stdin), $input, $envs);
+    $process = new Process(implode(' ', $stdin), null, $envs, $input);
     $process->inheritEnvironmentVariables();
 
     try {
       $process->mustRun();
       return $process->getOutput();
     } catch (ProcessFailedException $error) {
-      echo $error->getMessage();
       throw $error;
     }
   }

lib/Logger.php

@@ -9,16 +9,25 @@ class Logger {
   private $configs = ['enabled' => false];
 
   function __construct($configs, $tag) {
-    if (isset($configs['logger'])) {
+    if (isset($configs['general']) && isset($configs['general']['logger'])) {
-      $this->configs = $configs['logger'];
+      $this->configs = $configs['general']['logger'];
     }
     if ($this->configs['enabled']) {
+      $this->createLoggerFile();
       $this->logger = new Monolog($tag);
       $logLevel = Monolog::getLevels()[$this->configs['level']];
       $this->logger->pushHandler(new StreamHandler($this->configs['file'], $logLevel));
     }
   }
 
+  public function createLoggerFile() {
+    if (!file_exists($this->configs['file'])) {
+      if (!fopen($this->configs['file'], 'w')) {
+        throw new \Exception(sprintf('Could not create logger file %s', $this->configs['file']));
+      }
+    }
+  }
+
   public function debug($message) {
     if ($this->configs['enabled']) {
       $this->logger->debug($message);

lib/Plugin.php

@@ -2,6 +2,7 @@
 
 namespace Aerex\BaikalStorage;
 
+use Aerex\BaikalStorage\Logger;
 use Aerex\BaikalStorage\Storages\Taskwarrior;
 use Aerex\BaikalStorage\Configs\ConfigBuilder;
 use Aerex\BaikalStorage\Configs\TaskwarriorConfig;
@@ -33,7 +34,7 @@ class Plugin extends ServerPlugin {
 
     
     /**
-     * Creates the Taskwarrior plugin
+     * Creates the Storage plugin
      *
      * @param CalendarProcessor $TWCalManager
      *
@@ -56,7 +57,7 @@ class Plugin extends ServerPlugin {
      */
 
     public function initializeStorages($configs) {
-      $taskwarrior = new Taskwarrior(new Console(['rc.verbose=nothing', 'rc.hooks=off']),  $configs);
+      $taskwarrior = new Taskwarrior(new Console(['rc.verbose=nothing', 'rc.hooks=off']),  $configs, new Logger($configs, 'Taskwarrior'););
       $this->storageManager->addStorage(Taskwarrior::NAME, $taskwarrior); 
     }
 

lib/StorageManager.php

@@ -38,7 +38,7 @@ class StorageManager {
     if (!isset($this->configs)) {
       throw new \Exception('StorageManger was not initialize or configs are not defined'); 
     }
-    foreach ($this->configs as $key => $value) {
+    foreach ($this->configs['storages'] as $key => $value) {
       $storage = $this->storages[$key];
       if (!isset($storage)){
         throw new \Exception();

lib/Storages/Taskwarrior.php

@@ -3,8 +3,8 @@
 namespace Aerex\BaikalStorage\Storages;
 
 use Sabre\VObject\Component\VCalendar as Calendar;
-use Aerex\BaikalStorage\Logger;
 use Carbon\Carbon;
+use Carbon\CarbonTimeZone;
 
 class Taskwarrior implements IStorage {
 
@@ -12,11 +12,13 @@ class Taskwarrior implements IStorage {
   private $tasks = [];
   private $configs;
   private $logger;
+  private $tz;
 
-  public function __construct($console, $configs) {
+  public function __construct($console, $configs, $logger) {
     $this->console = $console;
-    $this->configs = $configs['taskwarrior'];
+    $this->configs = $configs['storages']['taskwarrior'];
-    $this->logger = new Logger($configs, 'Taskwarrior');
+    $this->logger = $logger; 
+    $this->tz = new CarbonTimeZone($configs['general']['timezone']);
   }
 
   public function getConfig() {
@@ -26,6 +28,13 @@ class Taskwarrior implements IStorage {
   public function refresh() {
     $output = $this->console->execute('task', ['sync'], null, 
       ['TASKRC' => $this->configs['taskrc'],'TASKDATA' => $this->configs['taskdata']]);
+      $this->tasks = json_decode($this->console->execute('task', ['export'], null,
+        ['TASKRC' => $this->configs['taskrc'], 'TASKDATA' => $this->configs['taskdata']]), true);
+      foreach ($this->tasks as $task) {
+        if (isset($task['uid'])) {
+          $this->tasks[$task['uid']] = $task;
+        }
+      }
     $this->logger->info($output);
   }
 
@@ -37,26 +46,26 @@ class Taskwarrior implements IStorage {
       $task['uid'] = (string)$vtodo->UID;
     }
 
-    if (isset($vtodo->SUMMARY) && !isset($vtodo->DESCRIPTION)){
+    if (isset($vtodo->SUMMARY)){
       $task['description'] = (string)$vtodo->SUMMARY;
     } else if(isset($vtodo->DESCRIPTION)) {
       $task['description'] = (string)$vtodo->DESCRIPTION;
     }
 
     if (isset($vtodo->DTSTAMP)){
-      $task['entry'] = new Carbon($vtodo->DTSTAMP->getDateTime()->format(\DateTime::W3C));
+      $task['entry'] = new Carbon($vtodo->DTSTAMP->getDateTime()->format(\DateTime::W3C), $this->tz);
     } 
 
     if (isset($vtodo->DTSTART)) {
-      $task['start'] = new Carbon($vtodo->DTSTART->getDateTime()->format(\DateTime::W3C));
+      $task['start'] = new Carbon($vtodo->DTSTART->getDateTime()->format(\DateTime::W3C), $this->tz);
     }
 
     if (isset($vtodo->DTEND)){
-      $task['end'] = new Carbon($vtodo->DTEND->getDateTime()->format(\DateTime::W3C));
+      $task['end'] = new Carbon($vtodo->DTEND->getDateTime()->format(\DateTime::W3C), $this->tz);
     }
 
     if (isset($vtodo->{'LAST-MODIFIED'})) {
-      $task['modified'] = new Carbon($vtodo->{'LAST-MODIFIED'}->getDateTime()->format(\DateTime::W3C));
+      $task['modified'] = new Carbon($vtodo->{'LAST-MODIFIED'}->getDateTime()->format(\DateTime::W3C), $this->tz);
     }
 
     if (isset($vtodo->PRIORITY)) {
@@ -71,7 +80,7 @@ class Taskwarrior implements IStorage {
     }
 
     if (isset($vtodo->DUE)){
-      $task['due'] = new Carbon($vtodo->DUE->getDateTime()->format(\DateTime::W3C)); 
+      $task['due'] = new Carbon($vtodo->DUE->getDateTime()); 
     }
 
     if (isset($vtodo->RRULE)) {
@@ -92,13 +101,13 @@ class Taskwarrior implements IStorage {
         case 'COMPLETED':
           $task['status'] = 'completed';
           if (!isset($task['end'])) {
-            $task['end'] = new Carbon($vtodo->DTSTAMP->getDateTime()->format(\DateTime::W3C));
+            $task['end'] = new Carbon($vtodo->DTSTAMP->getDateTime()->format(\DateTime::W3C), $this->tz);
           }
           break;
         case 'CANCELED':
           $task['status'] = 'deleted';
           if (!isset($task['end'])) {
-            $task['end'] = new Carbon($vtodo->DTSTAMP->getDateTime()->format(\DateTime::W3C));
+            $task['end'] = new Carbon($vtodo->DTSTAMP->getDateTime()->format(\DateTime::W3C), $this->tz);
           }
           break;
       }
@@ -108,8 +117,8 @@ class Taskwarrior implements IStorage {
       $task['tags'] = [];
         foreach ($vtodo->CATEGORIES as $category) {
           if (isset($this->configs['project_tag_suffix'])) {
-            $projTagSuffixRegExp = sprintf('/^%s_/', $this->configs['project_tag_suffix']);
+            $projTagSuffixRegExp = sprintf('/^%s/', $this->configs['project_tag_suffix']);
-            if (preg_match($category, $projTagSuffixRegExp)) {
+            if (preg_match($projTagSuffixRegExp, $category)) {
               $task['project'] = preg_replace($projTagSuffixRegExp, '', $category);
               continue;
             }
@@ -122,19 +131,23 @@ class Taskwarrior implements IStorage {
   }
 
   public function save(Calendar $c) {
+    try {
       if (!isset($c->VTODO)){
         throw new \Exception('Calendar event does not contain VTODO');
-      $this->logger->error('Calendar event does not contain VTODO');
       }
-    $this->logger->info($c->VTODO->getJsonValue());
+      $this->logger->info(json_encode($c->jsonSerialize()));
       $this->refresh();
       $task = $this->vObjectToTask($c->VTODO);
       $this->logger->info(json_encode($task));
       $this->logger->info(
-      sprintf('Executing TASKRC = %s TASKDATA = %s task import %s', $this->configs['taskrc'], $this->configs['taskdata'], $task)
+        sprintf('Executing TASKRC = %s TASKDATA = %s task import %s', $this->configs['taskrc'], $this->configs['taskdata'], json_encode($task))
       );
       $output = $this->console->execute('task', ['import'], $task, 
         ['TASKRC' => $this->configs['taskrc'],'TASKDATA' => $this->configs['taskdata']]);
       $this->logger->info($output);
+    } catch (\Exception $e) {
+      $this->logger->error($e->getTraceAsString());
+      throw $e;
+    }
   }
 }

tests/Configs/ConfigTest.php

@@ -13,18 +13,21 @@ class ConfigTest extends TestCase {
 
   public $mockConfigBuilder;
 
-  public function testLoggerConfigs() {
+  public function testGeneralLoggerConfigs() {
     $configs = new ConfigBuilder(__DIR__ . '/Fixtures/LoggerConfig.yaml');
     $contents = $configs->loadYaml();
     $this->assertEquals(sizeof($contents), 1);
-    $this->assertArrayHasKey('logger', $contents, 'config missing logger property');
+    $this->assertArrayHasKey('general', $contents, 'config missing general config');
-    $this->assertArrayHasKey('file', $contents['logger'], 'config missing logger.file property');
+    $generalConfigs = $contents['general'];
-    $this->assertEquals($contents['logger']['file'], '/home/user/logger.yaml');
+    $this->assertArrayHasKey('logger', $generalConfigs, 'general config is missing logger property');
-    $this->assertArrayHasKey('level', $contents['logger'], 'config missing logger.level property');
+    $this->assertArrayHasKey('file', $generalConfigs['logger'], 'general logger config missing file property');
-    $this->assertEquals($contents['logger']['level'], 'ERROR', 'ERROR is not set as default logger level');
+    $this->assertEquals($generalConfigs['logger']['file'], '/home/user/logger.yaml');
-    $this->assertArrayHasKey('enabled', $contents['logger'], 'config missing logger.enabled property');
+    $this->assertArrayHasKey('level', $generalConfigs['logger'], 'general logger config missing level property');
-    $this->assertTrue($contents['logger']['enabled']);
+    $this->assertEquals($generalConfigs['logger']['level'], 'ERROR', 'ERROR is not set as default logger level');
-
+    $this->assertArrayHasKey('enabled', $generalConfigs['logger'], 'general config logger enabled property is missing');
+    $this->assertTrue($generalConfigs['logger']['enabled']);
+    $this->assertArrayHasKey('timezone', $generalConfigs, 'general config is missing timezone property');
+    $this->assertEquals($generalConfigs['timezone'], 'UTC', 'UTC is not set as default timezone');
   }
 
   public function testTaskwarriorConfig() {
@@ -32,19 +35,15 @@ class ConfigTest extends TestCase {
     $configs->add(new TaskwarriorConfig());
     $contents = $configs->loadYaml();
     $this->assertEquals(sizeof($contents), 2);
-    $this->assertArrayHasKey('logger', $contents, 'config missing logger property');
+    $this->assertArrayHasKey('storages', $contents, 'storages config missing');
-    $this->assertArrayHasKey('file', $contents['logger'], 'config missing logger.file property');
+    $this->assertArrayHasKey('taskwarrior', $contents['storages'], 'storage config missing taskwarrior property');
-    $this->assertArrayHasKey('level', $contents['logger'], 'config missing logger.level property');
+    $taskwarriorConfigs = $contents['storages']['taskwarrior'];
-    $this->assertArrayHasKey('enabled', $contents['logger'], 'config missing logger.enabled property');
+    $this->assertArrayHasKey('taskrc', $taskwarriorConfigs, 'taskwarrior config is missing taskrc property');
-    $this->assertArrayHasKey('taskwarrior', $contents, 'config missing taskwarrior property');
+    $this->assertEquals($taskwarriorConfigs['taskrc'], '/home/aerex/.taskrc');
-    $this->assertArrayHasKey('taskrc', $contents['taskwarrior'], 'config missing taskwarrior.taskrc property');
+    $this->assertArrayHasKey('taskdata', $taskwarriorConfigs, 'taskwarrior config is missing taskdata property');
-    $this->assertEquals($contents['taskwarrior']['taskrc'], '/home/aerex/.taskrc');
+    $this->assertEquals($taskwarriorConfigs['taskdata'], '/home/aerex/.task');
-    $this->assertArrayHasKey('taskdata', $contents['taskwarrior'], 'config missing taskwarrior.taskdata property');
+    $this->assertArrayHasKey('project_tag_suffix', $taskwarriorConfigs, 'taskwarrior config is missing project_tag_suffix property');
-    $this->assertEquals($contents['taskwarrior']['taskdata'], '/home/aerex/.task');
+    $this->assertEquals($taskwarriorConfigs['project_tag_suffix'], 'project_');
-    $this->assertArrayHasKey('project_tag_suffix', $contents['taskwarrior'], 'config missing taskwarrior.taskdata property');
-    $this->assertEquals($contents['taskwarrior']['project_tag_suffix'], 'project_');
   }
-
-
 }
 

tests/Configs/Fixtures/LoggerConfig.yaml

@@ -1,2 +1,3 @@
-logger:
+general:
+  logger:
     file: /home/user/logger.yaml

tests/Configs/Fixtures/TaskwarriorConfig.yaml

@@ -1,7 +1,10 @@
-logger:
+general:
+  logger:
     file: /home/aerex/baikal-storage-plugin.log
     level: DEBUG
-taskwarrior:
+  timezone: 'America/Denver'
+storages:
+  taskwarrior:
     taskdata: /home/aerex/.task
     taskrc: /home/aerex/.taskrc
     project_tag_suffix: project_

tests/StorageManagerTest.php

@@ -6,7 +6,7 @@ use PHPUnit\Framework\TestCase;
 use Aerex\BaikalStorage\AbstractConsole;
 use Aerex\BaikalStorage\Configs\ConfigBuilder;
 use Aerex\BaikalStorage\Storages\Taskwarrior;
-use Aerex\BaikalStorage\Storages\IStorage;
+use Aerex\BaikalStorage\Logger;
 use Sabre\VObject\Component\VCalendar as Calendar;
 
 class StorageManagerTest extends TestCase {
@@ -27,11 +27,20 @@ class StorageManagerTest extends TestCase {
         ->getMock();
     $this->mockConsole = $this->createMock(AbstractConsole::class);
     $this->mockStorage = $this->createMock(Taskwarrior::class);
-  }
+    $this->mockLogger = $this->createMock(Logger::class);
+    $this->configs = [
+      'general' => [
+        'logger' => ['file' => '', 'level'=>  'DEBUG', 'enabled' => true],
+        'timezone' => 'UTC'
+      ], 
+      'storages' => [
+        'taskwarrior' => ['taskrc' => '', 'taskdata' => '']
+      ]
+    ];
+}
 
-  public function testAddTaskwarriorStorage() {
+public function testAddTaskwarriorStorage() {
-    $configs = ['taskwarrior' => ['taskrc' => '', 'taskdata' => '']];
+    $tw = new Taskwarrior($this->mockConsole, $this->configs, $this->mockLogger);
-    $tw = new Taskwarrior($this->mockConsole, $configs);
     $manager = new StorageManager($this->mockConfigBuilder);
     $manager->addStorage(Taskwarrior::NAME, $tw);
     $storages = $manager->getStorages();
@@ -46,8 +55,7 @@ class StorageManagerTest extends TestCase {
       ->method('save')
         ->with($this->equalTo($cal));
 
-    $configs = ['taskwarrior' => ['taskrc' => '', 'taskdata' => '']];
+    $manager = new StorageManager($this->configs);
-    $manager = new StorageManager($configs);
     $manager->addStorage(Taskwarrior::NAME, $this->mockStorage);
     $manager->import($cal);
 

tests/Storages/TaskwarriorTest.php

@@ -4,6 +4,7 @@ namespace Aerex\BaikalStorage;
 
 use PHPUnit\Framework\TestCase;
 use Aerex\BaikalStorage\AbstractConsole;
+use Aerex\BaikalStorage\Logger;
 use Sabre\VObject\Component\VCalendar as Calendar;
 use Aerex\BaikalStorage\Storages\Taskwarrior;
 
@@ -16,11 +17,20 @@ class TaskwarriorTest extends TestCase {
 
   protected function setUp(): void {
     $this->mockConsole = $this->createMock(AbstractConsole::class);
+    $this->mockLogger = $this->createMock(Logger::class);
   }
 
   public function testVObjectToTask() {
-    $configs = ['taskwarrior' => ['taskrc' => '', 'taskdata' => ''], 'logger' => ['file' => '', 'level'=>  'DEBUG', 'enabled' => true]];
+    $configs = [
-    $this->taskwarrior = new Taskwarrior($this->mockConsole, $configs);
+      'general' => [
+        'logger' => ['file' => '', 'level'=>  'DEBUG', 'enabled' => true],
+        'timezone' => 'UTC'
+      ], 
+      'storages' => [
+        'taskwarrior' => ['taskrc' => '', 'taskdata' => '']
+      ]
+    ];
+    $this->taskwarrior = new Taskwarrior($this->mockConsole, $configs, $this->mockLogger);
     $vcalendar = new Calendar([
       'VTODO' => [
         'SUMMARY' => 'Finish project',