Merge branch 'develop'

* develop:
  specify next release
  replace old gif by a showcase video
  update readme
  run CS when proofs changes
  do not run psalm when modifying tests
  update changelog
  do not run tests when properties change as it is only compatible with blackbox now
  run proofs independently from tests
  remove deadcode
  do not clear the terminal after the start
  CS
  fix tests
  remove object wrapper on top of activity enum
  fiw watched paths
  pause the source when there is no activity
  replace sub processes with fibers via innmind/mantle
  update actions version

Author: Baptouuuu

.github/workflows/ci.yml

@@ -13,7 +13,7 @@ jobs:
     name: 'PHPUnit'
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
@@ -27,7 +27,7 @@ jobs:
           dependency-versions: ${{ matrix.dependencies }}
       - name: PHPUnit
         run: vendor/bin/phpunit --coverage-clover=coverage.clover
-      - uses: codecov/codecov-action@v1
+      - uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
   psalm:
@@ -39,7 +39,7 @@ jobs:
     name: 'Psalm'
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
@@ -59,7 +59,7 @@ jobs:
     name: 'CS'
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 4.0.0 - 2023-11-12
+
+### Added
+
+- You can use `proofs`, `blackbox` or `bb` as triggers to only run proofs via BlackBox
+
+### Changed
+
+- Tests are no longer run when the `proofs` or `properties` directories are modified
+- Proofs are no longer run when the `tests` directory is modified
+- Psalm is no longer run when the `tests` directory is modified
+- Coding standard is run when the `proofs` directory is modified
+
+### Fixed
+
+- Agents sub processes would become zombies when the parent process would crash (no longer possible as everything is done in the same process)
+
 ## 3.7.0 - 2023-09-24
 
 ### Added

README.md

@@ -8,13 +8,13 @@ Development tool to automate certain parts of the dev cycle.
 
 Automatisations:
 - Propose to update dependencies when starting working on the project
-- Launch BlackBox proofs when `src`, `tests`, `fixtures` or `properties` folders are modified
-- Launch PHPUnit tests when `src`, `tests`, `fixtures` or `properties` folders are modified
-- Launch Psalm checks (if a `psalm.xml` exists) when `src` or `tests` folders are modified
-- Verify the code style (if a `.php_cs.dist` or `.php-cs-fixer.dist.php` file exists) when `src`, `tests`, `fixtures` or `properties` folders are modified
+- Launch BlackBox proofs when `src`, `proofs`, `fixtures` or `properties` folders are modified
+- Launch PHPUnit tests when `src`, `tests` or `fixtures` folders are modified
+- Launch Psalm checks (if a `psalm.xml` exists) when `src` folder is modified
+- Verify the code style (if a `.php_cs.dist` or `.php-cs-fixer.dist.php` file exists) when `src`, `tests`, `proofs`, `fixtures` or `properties` folders are modified
 - Start docker compose when there is a `docker-compose.yml` at the project root
 
-![](example.gif)
+https://github.com/Innmind/LabStation/assets/851425/cbb99153-20db-450a-ac3a-bf68980c9ad1
 
 ## Installation
 

composer.json

@@ -18,12 +18,10 @@
         "php": "~8.2",
         "innmind/url": "~4.0",
         "innmind/cli": "~3.4",
-        "innmind/operating-system": "~3.1",
+        "innmind/operating-system": "~4.1",
         "innmind/json": "^1.1",
-        "innmind/ipc": "~4.0",
-        "innmind/process-manager": "~4.0",
-        "innmind/server-control": "~4.2|~5.0",
-        "innmind/immutable": "~4.4|~5.0"
+        "innmind/immutable": "~5.2",
+        "innmind/mantle": "~2.0"
     },
     "autoload": {
         "psr-4": {

example.gif

@@ -0,0 +1,101 @@
+<?php
+declare(strict_types = 1);
+
+namespace Innmind\LabStation;
+
+use Innmind\CLI\Console;
+use Innmind\OperatingSystem\OperatingSystem;
+use Innmind\TimeContinuum\Earth\Period\Millisecond;
+use Innmind\Immutable\Set;
+
+final class Activities
+{
+    private Trigger $trigger;
+    private Iteration $iteration;
+    /** @var Set<Triggers> */
+    private Set $triggers;
+    /** @var list<Activity> */
+    private array $activities;
+
+    /**
+     * @param Set<Triggers> $triggers
+     * @param list<Activity> $activities
+     */
+    private function __construct(
+        Trigger $trigger,
+        Iteration $iteration,
+        Set $triggers,
+        array $activities,
+    ) {
+        $this->trigger = $trigger;
+        $this->iteration = $iteration;
+        $this->triggers = $triggers;
+        $this->activities = $activities;
+    }
+
+    public function __invoke(
+        Console $console,
+        OperatingSystem $os,
+    ): Console {
+        // If no activities yet we wait a little bit to avoid always calling
+        // this method.
+        // The better approach would be to use sockets and to monitor them so we
+        // would call the trigger as soon as an activity occured but the agents
+        // watch directories and the underlyin mecanism runs every second so
+        // there is always this delay. And if we use sockets we still need to
+        // exit this method periodically to allow the source to be restarted in
+        // order to check if any agent crashed in order to restart it.
+        if (\count($this->activities) === 0) {
+            $os->process()->halt(Millisecond::of(500));
+        }
+
+        while ($activity = \array_shift($this->activities)) {
+            $this->iteration->start();
+            $console = ($this->trigger)(
+                $console,
+                $os,
+                $activity,
+                $this->triggers,
+            );
+
+            if ($activity !== Activity::start) {
+                $console = $this->iteration->end($console);
+            }
+        }
+
+        return $console;
+    }
+
+    /**
+     * @param Set<Triggers> $triggers
+     */
+    public static function new(
+        Trigger $trigger,
+        Iteration $iteration,
+        Set $triggers,
+    ): self {
+        return new self(
+            $trigger,
+            $iteration,
+            $triggers,
+            [Activity::start],
+        );
+    }
+
+    public function push(Activity $activity): self
+    {
+        $this->activities[] = $activity;
+
+        return $this;
+    }
+
+    /**
+     * Used for tests only
+     *
+     * @return list<Activity>
+     */
+    public function toList(): array
+    {
+        return $this->activities;
+    }
+}

src/Activities.php

@@ -3,19 +3,12 @@
 
 namespace Innmind\LabStation;
 
-use Innmind\LabStation\Activity\Type;
-
-final class Activity
+enum Activity
 {
-    private Type $type;
-
-    public function __construct(Type $type)
-    {
-        $this->type = $type;
-    }
-
-    public function type(): Type
-    {
-        return $this->type;
-    }
+    case sourcesModified;
+    case testsModified;
+    case proofsModified;
+    case fixturesModified;
+    case propertiesModified;
+    case start;
 }

src/Activity.php

@@ -3,9 +3,17 @@
 
 namespace Innmind\LabStation;
 
+use Innmind\OperatingSystem\OperatingSystem;
 use Innmind\Url\Path;
 
 interface Agent
 {
-    public function __invoke(Path $project): void;
+    /**
+     * In case of a crash return the agent instance to be able to restart it
+     */
+    public function __invoke(
+        OperatingSystem $os,
+        Path $project,
+        Activities $activities,
+    ): ?self;
 }

src/Activity/Type.php

@@ -5,59 +5,34 @@
 
 use Innmind\LabStation\{
     Agent,
-    Protocol,
+    Activities,
     Activity,
-    Activity\Type,
-};
-use Innmind\OperatingSystem\Filesystem;
-use Innmind\IPC\{
-    IPC,
-    Process\Name,
 };
+use Innmind\OperatingSystem\OperatingSystem;
 use Innmind\Url\Path;
-use Innmind\Immutable\{
-    Sequence,
-    Either,
-};
+use Innmind\Immutable\Either;
 
 final class WatchFixtures implements Agent
 {
-    private Protocol $protocol;
-    private Filesystem $filesystem;
-    private IPC $ipc;
-    private Name $monitor;
-
-    public function __construct(
-        Protocol $protocol,
-        Filesystem $filesystem,
-        IPC $ipc,
-        Name $monitor,
-    ) {
-        $this->protocol = $protocol;
-        $this->filesystem = $filesystem;
-        $this->ipc = $ipc;
-        $this->monitor = $monitor;
-    }
-
-    public function __invoke(Path $project): void
-    {
-        $fixtures = $project->resolve(Path::of('fixtures'));
+    public function __invoke(
+        OperatingSystem $os,
+        Path $project,
+        Activities $activities,
+    ): ?Agent {
+        $fixtures = $project->resolve(Path::of('fixtures/'));
+        $filesystem = $os->filesystem();
 
-        if (!$this->filesystem->contains($fixtures)) {
-            return;
+        if (!$filesystem->contains($fixtures)) {
+            return null;
         }
 
-        $this->filesystem->watch($fixtures)(
-            $this->ipc,
-            fn(IPC $ipc) => $ipc
-                ->get($this->monitor)
-                ->flatMap(fn($process) => $process->send(Sequence::of(
-                    $this->protocol->encode(new Activity(Type::fixturesModified)),
-                )))
-                ->flatMap(static fn($process) => $process->close())
-                ->either()
-                ->map(static fn() => $ipc)
-                ->otherwise(static fn() => Either::right($ipc)), // even if it failed to send the message continue to watch for file changes
+        $filesystem->watch($fixtures)(
+            $activities,
+            static fn(Activities $activities) => Either::right( // right in order to have an infinite loop
+                $activities->push(Activity::fixturesModified),
+            ),
         );
+
+        return $this;
     }
 }