Allow features to be available publicly for Twill users

README.md

@@ -87,3 +87,15 @@ Or in Blade:
 ```
 
 Don't forget to add the feature flags to your navigation too.
+
+## Allow users logged in Twill option
+You can allow your users to have access to a feature in public available domains if they are logged in on Twill. But there are some caveats for it to work:
+
+- Twill must be int he same domain of the web application, meaning that `ADMIN_APP_URL` must be empty or have the same domain as the frontend; or
+- The Laravel session domain should set in order for the apps to share the session cookie:
+
+```dotenv
+SESSION_DOMAIN=.laravel-twill-project.test
+```
+
+Also, make sure your sessions are working fine, when you switch to a shared domain they might break and a browser cookie clear might be needed.

phpstan.neon

@@ -9,12 +9,10 @@ parameters:
 
     excludePaths:
 
-    checkMissingIterableValueType: false
-
     universalObjectCratesClasses:
 
     ignoreErrors:
+        - identifier: missingType.generics
+        - identifier: missingType.iterableValue
 
     reportUnmatchedIgnoredErrors: false
-
-    checkGenericClassInNonGenericObjectType: false

src/Http/Controllers/TwillFeatureFlagController.php

@@ -27,6 +27,12 @@ class TwillFeatureFlagController extends ModuleController
             'sort' => true,
         ],
 
+        'publicly_available_twill_users' => [
+            'title' => 'Publicly available for Twill users',
+            'field' => 'publicly_available_twill_users_yes_no',
+            'sort' => true,
+        ],
+
         'publicly_available_ips' => [
             'title' => 'Publicly available to (IPs)',
             'field' => 'publicly_available_ips',

src/Models/TwillFeatureFlag.php

@@ -14,12 +14,13 @@
  * @property string $publicly_available_yes_no
  * @property string|null $publicly_available_ips
  * @property bool $published
+ * @property bool $publicly_available_twill_users
  */
 class TwillFeatureFlag extends Model
 {
     use HasRevisions;
 
-    protected $fillable = ['published', 'title', 'description', 'code', 'publicly_available', 'ip_addresses'];
+    protected $fillable = ['published', 'title', 'description', 'code', 'publicly_available', 'ip_addresses', 'publicly_available_twill_users'];
 
     /**
      * Save the model to the database.
@@ -39,6 +40,11 @@ public function getPubliclyAvailableYesNoAttribute(): string
         return $this->publicly_available ? 'Yes' : '';
     }
 
+    public function getPubliclyAvailableTwillUsersYesNoAttribute(): string
+    {
+        return $this->publicly_available_twill_users ? 'Yes' : '';
+    }
+
     public function getPubliclyAvailableIpsAttribute(): string|null
     {
         return $this->ip_addresses ?? null;

src/Repositories/TwillFeatureFlagRepository.php

@@ -40,7 +40,7 @@ public function getFeature(string $code): bool
             return false;
         }
 
-        if (blank($featureFlag) || blank($featureFlag?->published) || $featureFlag?->published === false) {
+        if (blank($featureFlag) || blank($featureFlag->published) || $featureFlag->published === false) {
             return false;
         }
 
@@ -73,11 +73,8 @@ public function featureList(bool $all = false): array
 
     private function isPubliclyAvailableToCurrentUser(TwillFeatureFlag $featureFlag): bool
     {
-        return (new GeolocationService())->currentIpAddressIsOnList(
-            collect(explode(',', $featureFlag->ip_addresses))
-                ->map(fn($ip) => trim($ip))
-                ->toArray(),
-        );
+        return $this->isPubliclyAvailableToIpAddresses($featureFlag) ||
+            $this->isPubliclyAvailableToTwillUsers($featureFlag);
     }
 
     private function bootCache(): void
@@ -132,4 +129,27 @@ protected function url(array|bool $parsed, string $attribute): string|null
 
         return $parsed[$attribute];
     }
+
+    public function isPubliclyAvailableToIpAddresses(TwillFeatureFlag $featureFlag): bool
+    {
+        if (blank($featureFlag->ip_addresses)) {
+            return false;
+        }
+
+        return (new GeolocationService())->currentIpAddressIsOnList(
+            collect(explode(',', $featureFlag->ip_addresses))
+                ->map(fn($ip) => trim($ip))
+                ->toArray(),
+        );
+    }
+
+    public function isPubliclyAvailableToTwillUsers(TwillFeatureFlag $featureFlag): bool
+    {
+        if (!$featureFlag->publicly_available_twill_users) {
+            return false;
+        }
+
+        // Is the user authenticated on Twill?
+        return auth('twill_users')->check();
+    }
 }

src/ServiceProvider.php

@@ -5,6 +5,7 @@
 use Illuminate\Support\Str;
 use A17\Twill\Facades\TwillCapsules;
 use A17\Twill\TwillPackageServiceProvider;
+use A17\TwillFeatureFlags\Services\Helpers;
 
 class ServiceProvider extends TwillPackageServiceProvider
 {
@@ -15,6 +16,8 @@ public function boot(): void
     {
         $this->registerThisCapsule();
 
+        Helpers::load();
+
         parent::boot();
     }
 

src/Services/Helpers.php

@@ -6,6 +6,6 @@ class Helpers
 {
     public static function load(): void
     {
-        require __DIR__ . '/../Support/helpers.php';
+        require_once __DIR__ . '/../Support/helpers.php';
     }
 }

src/Support/helpers.php

@@ -15,3 +15,27 @@ function feature_list(bool $all = false): array
         return (new TwillFeatureFlagRepository())->featureList($all);
     }
 }
+
+if (!function_exists('features_can_be_public_on_twill')) {
+    function features_can_be_public_on_twill(): bool
+    {
+        $sessionDomain = config('session.domain');
+
+        $twillAdminAppHost = parse_url(config('twill.admin_app_url') ?? '')['host'] ?? null;
+
+        $appDomainHost = parse_url(config('app.url') ?? '')['host'] ?? null;
+
+        // If the admin app is not set it probably means Twill is in the same domain of the frontend
+        if (blank($twillAdminAppHost)) {
+            return true;
+        }
+
+        // Otherwise the domain must be the same
+        if ($twillAdminAppHost === $appDomainHost) {
+            return true;
+        }
+
+        // Otherwise the session domain must be set
+        return filled($sessionDomain);
+    }
+}

src/database/migrations/2024_06_04_114937_add_public_available_for_twill.php

@@ -0,0 +1,28 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::table('twill_feature_flags', function (Blueprint $table) {
+            $table->boolean('publicly_available_twill_users')->default(false);
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::table('twill_feature_flags', function (Blueprint $table) {
+            $table->dropColumn('publicly_available_twill_users');
+        });
+    }
+};

src/resources/views/admin/form.blade.php

@@ -12,6 +12,13 @@
     'label' => 'Publicly available',
     ])
 
+    @if(features_can_be_public_on_twill())
+        @formField('checkbox', [
+        'name' => 'publicly_available_twill_users',
+        'label' => 'Publicly available for users logged in Twill',
+        ])
+    @endif
+
     @formField('input', [
     'label' => 'IP Addresses',
     'name' => 'ip_addresses',