From 832f6a55b9fc1434d03a7bc5dfc3f33b98467471 Mon Sep 17 00:00:00 2001
From: Matthias Leutenegger <2-mleutenegger@users.noreply.git.syntro.ch>
Date: Tue, 7 Dec 2021 17:58:36 +0100
Subject: [PATCH 1/7] add: settings to stop serving scripts in dev mode

---
 src/KlaroRequirements.php       | 51 +++++++++++++++++++++++++++++++--
 tests/KlaroRequirementsTest.php | 24 ++++++++++++++++
 2 files changed, 73 insertions(+), 2 deletions(-)

diff --git a/src/KlaroRequirements.php b/src/KlaroRequirements.php
index c1f41e1..f373079 100644
--- a/src/KlaroRequirements.php
+++ b/src/KlaroRequirements.php
@@ -4,6 +4,7 @@
 
 use SilverStripe\View\Requirements;
 use SilverStripe\View\Requirements_Backend;
+use SilverStripe\Control\Director;
 use Syntro\SilverstripeKlaro\KlaroRequirements_Backend;
 
 /**
@@ -22,6 +23,21 @@
 class KlaroRequirements
 {
 
+    /**
+     * @var string
+     */
+    const SERVE_LIVE = 'SERVELIVE';
+
+    /**
+     * @var string
+     */
+    const SERVE_LIVETEST = 'SERVELIVETEST';
+
+    /**
+     * @var string
+     */
+    const SERVE_ALWAYS = 'SERVE_ALWAYS';
+
     /**
      * Instance of the requirements for storage. You can create your own backend to change the
      * default JS and CSS inclusion behaviour.
@@ -47,10 +63,17 @@ public static function backend()
      *                           - 'type' : Override script type= value.
      *                           - 'integrity' : SubResource Integrity hash
      *                           - 'crossorigin' : Cross-origin policy for the resource
+     * @param  string $env       = KlaroRequirements::SERVE_LIVETEST where to serve this. available options are:
+     *                           - KlaroRequirements::SERVE_LIVE : serve only in live env.
+     *                           - KlaroRequirements::SERVE_LIVETEST : serve only in dev mode
+     *                           - KlaroRequirements::SERVE_ALWAYS : serve always
      * @return void
      */
-    public static function klaroJavascript($file, $klaroName, $options = [])
+    public static function klaroJavascript($file, $klaroName, $options = [], $env = KlaroRequirements::SERVE_LIVETEST)
     {
+        if (!static::canServeWith($env)) {
+            return;
+        }
         /** @var KlaroRequirements_Backend */
         $backend = self::backend();
         $backend->klaroJavascript($file, $klaroName, $options);
@@ -62,10 +85,17 @@ public static function klaroJavascript($file, $klaroName, $options = [])
      * @param string $script       The script content as a string (without enclosing `<script>` tag)
      * @param string $klaroName    the name used to identify the service
      * @param string $uniquenessID A unique ID that ensures a piece of code is only added once
+     * @param string $env          = KlaroRequirements::SERVE_LIVETEST where to serve this. available options are:
+     *                             - KlaroRequirements::SERVE_LIVE : serve only in live env.
+     *                             - KlaroRequirements::SERVE_LIVETEST : serve only in dev mode
+     *                             - KlaroRequirements::SERVE_ALWAYS : serve always
      * @return void
      */
-    public static function customKlaroScript($script, $klaroName, $uniquenessID = null)
+    public static function customKlaroScript($script, $klaroName, $uniquenessID = null, $env = KlaroRequirements::SERVE_LIVETEST)
     {
+        if (!static::canServeWith($env)) {
+            return;
+        }
         /** @var KlaroRequirements_Backend */
         $backend = self::backend();
         $backend->customKlaroScript($script, $klaroName, $uniquenessID);
@@ -90,4 +120,21 @@ public static function klaroCss($file, $klaroName, $media = null, $options = [])
         $backend = self::backend();
         $backend->klaroCss($file, $klaroName, $media, $options);
     }
+
+    /**
+     * canServeWith - checks if the current environment allows serving with the
+     * given Serving mode
+     *
+     * @param  string $key the key
+     * @return boolean
+     */
+    public static function canServeWith($key)
+    {
+        if (Director::isTest()) {
+            return $key === self::SERVE_LIVETEST || $key === self::SERVE_ALWAYS;
+        } elseif (Director::isDev()) {
+            return $key === self::SERVE_ALWAYS;
+        }
+        return true;
+    }
 }
diff --git a/tests/KlaroRequirementsTest.php b/tests/KlaroRequirementsTest.php
index 374a825..aa2ccdf 100644
--- a/tests/KlaroRequirementsTest.php
+++ b/tests/KlaroRequirementsTest.php
@@ -3,6 +3,7 @@
 namespace Syntro\SilverstripeKlaro\Tests;
 
 use SilverStripe\Dev\SapphireTest;
+use SilverStripe\Control\Director;
 use Syntro\SilverstripeKlaro\KlaroRequirements_Backend;
 use Syntro\SilverstripeKlaro\KlaroRequirements;
 
@@ -77,4 +78,27 @@ public function testKlaroCss()
         $this->assertEquals(1, count($backend->getKlaroCss()));
         $this->assertArrayHasKey('/file.css', $backend->getKlaroCss());
     }
+
+    /**
+     * testCanServeWith
+     *
+     * @return void
+     */
+    public function testCanServeWith()
+    {
+        $currentType = Director::get_session_environment_type();
+        define('SS_ENVIRONMENT_TYPE', 'dev');
+        $this->assertFalse(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVE));
+        $this->assertFalse(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVETEST));
+        $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_ALWAYS));
+        define('SS_ENVIRONMENT_TYPE', 'test');
+        $this->assertFalse(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVE));
+        $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVETEST));
+        $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_ALWAYS));
+        define('SS_ENVIRONMENT_TYPE', 'live');
+        $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVE));
+        $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVETEST));
+        $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_ALWAYS));
+        define('SS_ENVIRONMENT_TYPE', $currentType);
+    }
 }

From 973e83c4ccb1a613109f142a4eb007424359c3f6 Mon Sep 17 00:00:00 2001
From: Matthias Leutenegger <2-mleutenegger@users.noreply.git.syntro.ch>
Date: Tue, 7 Dec 2021 18:07:38 +0100
Subject: [PATCH 2/7] fix unit

---
 tests/KlaroRequirementsTest.php | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/tests/KlaroRequirementsTest.php b/tests/KlaroRequirementsTest.php
index aa2ccdf..93227a9 100644
--- a/tests/KlaroRequirementsTest.php
+++ b/tests/KlaroRequirementsTest.php
@@ -86,19 +86,19 @@ public function testKlaroCss()
      */
     public function testCanServeWith()
     {
-        $currentType = Director::get_session_environment_type();
-        define('SS_ENVIRONMENT_TYPE', 'dev');
+        $currentType = Director::get_environment_type();
+        Director::set_environment_type('dev');
         $this->assertFalse(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVE));
         $this->assertFalse(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVETEST));
         $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_ALWAYS));
-        define('SS_ENVIRONMENT_TYPE', 'test');
+        Director::set_environment_type('test');
         $this->assertFalse(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVE));
         $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVETEST));
         $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_ALWAYS));
-        define('SS_ENVIRONMENT_TYPE', 'live');
+        Director::set_environment_type('live');
         $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVE));
         $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVETEST));
         $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_ALWAYS));
-        define('SS_ENVIRONMENT_TYPE', $currentType);
+        Director::set_environment_type($currentType);
     }
 }

From ac01655285e4cc487b343a12df3b81aaa8857e66 Mon Sep 17 00:00:00 2001
From: Matthias Leutenegger <2-mleutenegger@users.noreply.git.syntro.ch>
Date: Wed, 8 Dec 2021 10:29:46 +0100
Subject: [PATCH 3/7] unit 2

---
 tests/KlaroRequirementsTest.php | 21 ++++++++++++++++-----
 1 file changed, 16 insertions(+), 5 deletions(-)

diff --git a/tests/KlaroRequirementsTest.php b/tests/KlaroRequirementsTest.php
index 93227a9..04732ec 100644
--- a/tests/KlaroRequirementsTest.php
+++ b/tests/KlaroRequirementsTest.php
@@ -4,6 +4,8 @@
 
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\Control\Director;
+use SilverStripe\Core\Injector\Injector;
+use SilverStripe\Core\Kernel;
 use Syntro\SilverstripeKlaro\KlaroRequirements_Backend;
 use Syntro\SilverstripeKlaro\KlaroRequirements;
 
@@ -36,6 +38,9 @@ public function testGetBackend()
      */
     public function testKlaroJavascript()
     {
+        $kernel = Injector::inst()->get(Kernel::class);
+        $currentType = $kernel->getEnvironment();
+        $kernel->setEnvironment(Kernel::LIVE);
         $backend = KlaroRequirements::backend();
 
         $this->assertEquals(0, count($backend->getKlaroJavascript()));
@@ -44,6 +49,7 @@ public function testKlaroJavascript()
 
         $this->assertEquals(1, count($backend->getKlaroJavascript()));
         $this->assertArrayHasKey('/file.js', $backend->getKlaroJavascript());
+        $kernel->setEnvironment($currentType);
     }
 
     /**
@@ -53,6 +59,8 @@ public function testKlaroJavascript()
      */
     public function testCustomKlaroScript()
     {
+        $kernel = Injector::inst()->get(Kernel::class);
+        $currentType = $kernel->getEnvironment();
         $backend = KlaroRequirements::backend();
 
         $this->assertEquals(0, count($backend->getcustomKlaroScript()));
@@ -60,6 +68,7 @@ public function testCustomKlaroScript()
         KlaroRequirements::customKlaroScript('script', 'name');
 
         $this->assertEquals(1, count($backend->getcustomKlaroScript()));
+        $kernel->setEnvironment($currentType);
     }
 
     /**
@@ -86,19 +95,21 @@ public function testKlaroCss()
      */
     public function testCanServeWith()
     {
-        $currentType = Director::get_environment_type();
-        Director::set_environment_type('dev');
+
+        $kernel = Injector::inst()->get(Kernel::class);
+        $currentType = $kernel->getEnvironment();
+        $kernel->setEnvironment(Kernel::DEV);
         $this->assertFalse(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVE));
         $this->assertFalse(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVETEST));
         $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_ALWAYS));
-        Director::set_environment_type('test');
+        $kernel->setEnvironment(Kernel::TEST);
         $this->assertFalse(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVE));
         $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVETEST));
         $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_ALWAYS));
-        Director::set_environment_type('live');
+        $kernel->setEnvironment(Kernel::LIVE);
         $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVE));
         $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_LIVETEST));
         $this->assertTrue(KlaroRequirements::canServeWith(KlaroRequirements::SERVE_ALWAYS));
-        Director::set_environment_type($currentType);
+        $kernel->setEnvironment($currentType);
     }
 }

From 0312fe13049b262147e8fb3925e3c003b6ee0fed Mon Sep 17 00:00:00 2001
From: Matthias Leutenegger <2-mleutenegger@users.noreply.git.syntro.ch>
Date: Wed, 8 Dec 2021 10:54:16 +0100
Subject: [PATCH 4/7] fix env setup

---
 tests/KlaroRequirementsTest.php | 1 +
 1 file changed, 1 insertion(+)

diff --git a/tests/KlaroRequirementsTest.php b/tests/KlaroRequirementsTest.php
index 04732ec..574f62a 100644
--- a/tests/KlaroRequirementsTest.php
+++ b/tests/KlaroRequirementsTest.php
@@ -61,6 +61,7 @@ public function testCustomKlaroScript()
     {
         $kernel = Injector::inst()->get(Kernel::class);
         $currentType = $kernel->getEnvironment();
+        $kernel->setEnvironment(Kernel::LIVE);
         $backend = KlaroRequirements::backend();
 
         $this->assertEquals(0, count($backend->getcustomKlaroScript()));

From 0401360fcd5878c78d01b07b91be7ebccf8432a4 Mon Sep 17 00:00:00 2001
From: Matthias Leutenegger <2-mleutenegger@users.noreply.git.syntro.ch>
Date: Wed, 8 Dec 2021 11:06:27 +0100
Subject: [PATCH 5/7] increase coverage

---
 tests/KlaroRequirementsTest.php | 19 ++++++++++++++-----
 1 file changed, 14 insertions(+), 5 deletions(-)

diff --git a/tests/KlaroRequirementsTest.php b/tests/KlaroRequirementsTest.php
index 574f62a..55a0608 100644
--- a/tests/KlaroRequirementsTest.php
+++ b/tests/KlaroRequirementsTest.php
@@ -40,15 +40,20 @@ public function testKlaroJavascript()
     {
         $kernel = Injector::inst()->get(Kernel::class);
         $currentType = $kernel->getEnvironment();
-        $kernel->setEnvironment(Kernel::LIVE);
         $backend = KlaroRequirements::backend();
 
+        $kernel->setEnvironment(Kernel::LIVE);
         $this->assertEquals(0, count($backend->getKlaroJavascript()));
-
         KlaroRequirements::klaroJavascript('/file.js', 'name');
-
         $this->assertEquals(1, count($backend->getKlaroJavascript()));
         $this->assertArrayHasKey('/file.js', $backend->getKlaroJavascript());
+
+        $kernel->setEnvironment(Kernel::DEV);
+        $this->assertEquals(1, count($backend->getKlaroJavascript()));
+        KlaroRequirements::klaroJavascript('/file_dev.js', 'namedev');
+        $this->assertEquals(1, count($backend->getKlaroJavascript()));
+        $this->assertArrayHasKey('/file_dev.js', $backend->getKlaroJavascript());
+
         $kernel->setEnvironment($currentType);
     }
 
@@ -61,14 +66,18 @@ public function testCustomKlaroScript()
     {
         $kernel = Injector::inst()->get(Kernel::class);
         $currentType = $kernel->getEnvironment();
-        $kernel->setEnvironment(Kernel::LIVE);
         $backend = KlaroRequirements::backend();
 
+        $kernel->setEnvironment(Kernel::LIVE);
         $this->assertEquals(0, count($backend->getcustomKlaroScript()));
-
         KlaroRequirements::customKlaroScript('script', 'name');
+        $this->assertEquals(1, count($backend->getcustomKlaroScript()));
 
+        $kernel->setEnvironment(Kernel::DEV);
         $this->assertEquals(1, count($backend->getcustomKlaroScript()));
+        KlaroRequirements::customKlaroScript('scriptdev', 'namedev');
+        $this->assertEquals(1, count($backend->getcustomKlaroScript()));
+
         $kernel->setEnvironment($currentType);
     }
 

From 2a15d9afff7b8c26ec139825f101ea70fc5c5bcc Mon Sep 17 00:00:00 2001
From: Matthias Leutenegger <2-mleutenegger@users.noreply.git.syntro.ch>
Date: Wed, 8 Dec 2021 11:10:10 +0100
Subject: [PATCH 6/7] update docs

---
 README.md                     | 2 +-
 docs/en/service_management.md | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 0031183..b642708 100644
--- a/README.md
+++ b/README.md
@@ -48,7 +48,7 @@ use Syntro\SilverstripeKlaro\KlaroRequirements;
 
 // ...
 
-KlaroRequirements::klaroJavascript('path/to/file.js', 'myservice');
+KlaroRequirements::klaroJavascript('path/to/file.js', 'myservice', [], KlaroRequirements::SERVE_ALWAYS);
 
 ```
 In order to add this service to the notice, create a config like so:
diff --git a/docs/en/service_management.md b/docs/en/service_management.md
index a5eb748..d381e6b 100644
--- a/docs/en/service_management.md
+++ b/docs/en/service_management.md
@@ -19,9 +19,9 @@ functions:
 use Syntro\SilverstripeKlaro\KlaroRequirements;
 
 // Add a javascript file
-KlaroRequirements::klaroJavascript('path/to/file.js', 'myservice');
+KlaroRequirements::klaroJavascript('path/to/file.js', 'myservice', [], KlaroRequirements::SERVE_ALWAYS);
 // Add a css file
-KlaroRequirements::klaroCss('path/to/file.css', 'myservice');
+KlaroRequirements::klaroCss('path/to/file.css', 'myservice', [], KlaroRequirements::SERVE_ALWAYS);
 // Add a custom script
 KlaroRequirements::customKlaroScript(<<<JS alert('hello') JS, 'myservice');
 ```

From 67bc1778c6cdce77f3f6a07adc90b2ac57ed0e56 Mon Sep 17 00:00:00 2001
From: Matthias Leutenegger <mleutenegger@users.noreply.github.com>
Date: Wed, 8 Dec 2021 11:18:46 +0100
Subject: [PATCH 7/7] Update KlaroRequirementsTest.php

---
 tests/KlaroRequirementsTest.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tests/KlaroRequirementsTest.php b/tests/KlaroRequirementsTest.php
index 55a0608..37e8709 100644
--- a/tests/KlaroRequirementsTest.php
+++ b/tests/KlaroRequirementsTest.php
@@ -52,7 +52,7 @@ public function testKlaroJavascript()
         $this->assertEquals(1, count($backend->getKlaroJavascript()));
         KlaroRequirements::klaroJavascript('/file_dev.js', 'namedev');
         $this->assertEquals(1, count($backend->getKlaroJavascript()));
-        $this->assertArrayHasKey('/file_dev.js', $backend->getKlaroJavascript());
+        $this->assertArrayNotHasKey('/file_dev.js', $backend->getKlaroJavascript());
 
         $kernel->setEnvironment($currentType);
     }