Replacement frontend engine with frontend type (#421)

* replacement frontend engine with frontend

* rename util function to isMPAApplication

Author: enmaboya

src/Http/Middleware/Billable.php

@@ -27,7 +27,7 @@ class Billable
      */
     public function handle(Request $request, Closure $next)
     {
-        if (Util::useNativeAppBridge() === false) {
+        if (!Util::isMPAApplication()) {
             throw new RuntimeException('You cannot use Billable middleware with SPA mode');
         }
 

src/Http/Middleware/VerifyShopify.php

@@ -91,6 +91,7 @@ public function handle(Request $request, Closure $next)
     {
         // Verify the HMAC (if available)
         $hmacResult = $this->verifyHmac($request);
+
         if ($hmacResult === false) {
             // Invalid HMAC
             throw new SignatureVerificationException('Unable to verify signature.');
@@ -101,6 +102,17 @@ public function handle(Request $request, Closure $next)
             return $next($request);
         }
 
+        if (!Util::isMPAApplication()) {
+            $shop = $this->getShopIfAlreadyInstalled($request);
+            $storeResult = !$this->isApiRequest($request) && $shop;
+
+            if ($storeResult) {
+                $this->loginFromShop($shop);
+
+                return $next($request);
+            }
+        }
+
         $tokenSource = $this->getAccessTokenFromRequest($request);
 
         if ($tokenSource === null) {
@@ -113,17 +125,6 @@ public function handle(Request $request, Closure $next)
                 throw new HttpException('Access denied.', Response::HTTP_FORBIDDEN);
             }
 
-            if (!Util::useNativeAppBridge()) {
-                $shop = $this->getShopIfAlreadyInstalled($request);
-                $storeResult = !$this->isApiRequest($request) && $shop;
-
-                if ($storeResult) {
-                    $this->loginFromShop($shop);
-
-                    return $next($request);
-                }
-            }
-
             //Check if there is a store record in the database
             return $this->checkPreviousInstallation($request)
                 // Shop exists, token not available, we need to get one
@@ -217,10 +218,7 @@ protected function handleInvalidShop(Request $request)
             throw new HttpException('Shop is not installed or missing data.', Response::HTTP_FORBIDDEN);
         }
 
-        return $this->installRedirect(
-            ShopDomain::fromRequest($request),
-            $request->has('id_token') ? $request->query('id_token') : null
-        );
+        return $this->installRedirect(ShopDomain::fromRequest($request));
     }
 
     /**
@@ -326,20 +324,11 @@ protected function tokenRedirect(Request $request): RedirectResponse
      * Redirect to install route.
      *
      * @param ShopDomainValue $shopDomain The shop domain.
-     * @param string|null $token The session token (for Managed App Installation).
      *
      * @return RedirectResponse
      */
-    protected function installRedirect(ShopDomainValue $shopDomain, ?string $token): RedirectResponse
+    protected function installRedirect(ShopDomainValue $shopDomain): RedirectResponse
     {
-        if ($token !== null) {
-            // Managed App Installation.
-            return Redirect::route(
-                Util::getShopifyConfig('route_names.authenticate'),
-                ['shop' => $shopDomain->toNative(), 'host' => request('host'), 'locale' => request('locale'), 'id_token' => $token]
-            );
-        }
-
         return Redirect::route(
             Util::getShopifyConfig('route_names.authenticate'),
             ['shop' => $shopDomain->toNative(), 'host' => request('host'), 'locale' => request('locale')]

src/Objects/Enums/FrontendEngine.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Osiset\ShopifyApp\Objects\Enums;
+
+use Funeralzone\ValueObjects\Enums\EnumTrait;
+use Funeralzone\ValueObjects\ValueObject;
+
+class FrontendType implements ValueObject
+{
+    use EnumTrait;
+
+    /**
+     * @var int
+     */
+    public const MPA = 0;
+
+    /**
+     * @var int
+     */
+    public const SPA = 1;
+}

src/Objects/Enums/FrontendType.php

@@ -107,7 +107,7 @@ public function process(
             'locale' => $request->get('locale'),
         ];
 
-        if (!Util::useNativeAppBridge()) {
+        if (!Util::isMPAApplication()) {
             $data['billing'] = $result ? 'success' : 'failure';
         }
 

src/Traits/BillingController.php

@@ -6,7 +6,7 @@
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Str;
 use LogicException;
-use Osiset\ShopifyApp\Objects\Enums\FrontendEngine;
+use Osiset\ShopifyApp\Objects\Enums\FrontendType;
 use Osiset\ShopifyApp\Objects\Values\Hmac;
 
 /**
@@ -182,9 +182,11 @@ public static function getShopifyConfig(string $key, $shop = null)
         }
 
         // Check if config API callback is defined
-        if (Str::startsWith($key, 'api')
+        if (
+            Str::startsWith($key, 'api')
             && Arr::exists($config, 'config_api_callback')
-            && is_callable($config['config_api_callback'])) {
+            && is_callable($config['config_api_callback'])
+        ) {
             // It is, use this to get the config value
             return call_user_func(
                 Arr::get($config, 'config_api_callback'),
@@ -237,14 +239,13 @@ public static function getShopsTableForeignKey(): string
      *
      * @return bool
      */
-    public static function useNativeAppBridge(): bool
+    public static function isMPAApplication(): bool
     {
-        $frontendEngine = FrontendEngine::fromNative(
-            self::getShopifyConfig('frontend_engine') ?? 'BLADE'
+        $frontendType = FrontendType::fromNative(
+            self::getShopifyConfig('frontend_type') ?? 'MPA'
         );
-        $reactEngine = FrontendEngine::fromNative('REACT');
 
-        return !$frontendEngine->isSame($reactEngine);
+        return !$frontendType->isSame(FrontendType::fromNative('SPA'));
     }
 
     public static function hasAppLegacySupport(string $feature): bool

src/Util.php

@@ -577,15 +577,14 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Frontend engine used
+    | Frontend type used
     |--------------------------------------------------------------------------
     |
-    | Available engines: "BLADE", "VUE", or "REACT".
-    | For example, if you use React, you do not need to be redirected to a separate page to get the JWT token.
-    | No changes are made for Vue.js and Blade.
+    | Available types: "SPA" (single-page application), "MPA" (multiple-page application).
+    | For example, if you use SPA, you do not need to be redirected to a separate page to get the JWT token.
     |
     */
-    'frontend_engine' => env('SHOPIFY_FRONTEND_ENGINE', 'BLADE'),
+    'frontend_type' => env('SHOPIFY_FRONTEND_TYPE', 'MPA'),
 
     'iframe_ancestors' => '',
 

src/resources/config/shopify-app.php

@@ -19,7 +19,7 @@
             </div>
         </div>
 
-        @if(\Osiset\ShopifyApp\Util::useNativeAppBridge())
+        @if(\Osiset\ShopifyApp\Util::isMPAApplication())
             @include('shopify-app::partials.token_handler')
         @endif
         @yield('scripts')

src/resources/views/layouts/default.blade.php

@@ -324,7 +324,7 @@ public function testNotNativeAppBridgeWithTokenProcessingAndLoginShop(): void
     {
         // Create a shop that matches the token from buildToken
         factory($this->model)->create(['name' => 'shop-name.myshopify.com']);
-        $this->app['config']->set('shopify-app.frontend_engine', 'REACT');
+        $this->app['config']->set('shopify-app.frontend_type', 'SPA');
 
         // Setup the request
         $currentRequest = Request::instance();

tests/Http/Middleware/VerifyShopifyTest.php

@@ -60,7 +60,7 @@ public function testReactFrontendShopAcceptsBilling(): void
             'post_recurring_application_charges_activate',
         ]);
 
-        config(['shopify-app.frontend_engine' => 'REACT']);
+        config(['shopify-app.frontend_type' => 'SPA']);
 
         // Create the shop and log them in
         $shop = factory($this->model)->create();
@@ -99,7 +99,7 @@ public function testBladeFrontendShopAcceptsBilling(): void
             'post_recurring_application_charges_activate',
         ]);
 
-        config(['shopify-app.frontend_engine' => 'BLADE']);
+        config(['shopify-app.frontend_type' => 'MPA']);
 
         // Create the shop and log them in
         $shop = factory($this->model)->create();
@@ -267,7 +267,8 @@ public function testUsageChargeFailWithoutShopParam(): void
         $data = [
             'description' => 'One email',
             'price' => 1.00,
-            'redirect' => 'https://localhost/usage-success',];
+            'redirect' => 'https://localhost/usage-success',
+        ];
         $signature = Util::createHmac(['data' => $data, 'buildQuery' => true], $secret);
 
         // Run the call