Merge pull request #1 from Shopify/adapt_to_cli_3

Adapt to CLI 3 and use new FE as submodule

.github/workflows/ci.yml

@@ -9,15 +9,21 @@ jobs:
       SHOPIFY_API_SECRET: test-secret-key
       SCOPES: read_products,write_products
       HOST: app-host-name.com
+      APP_ENV: local
     strategy:
       fail-fast: false
       matrix:
         php-version:
           - "7.4"
           - "8.0"
           - "8.1"
+    defaults:
+      run:
+        working-directory: ./web
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
 
       - name: Install PHP with extensions
         uses: shivammathur/setup-php@v2

.gitignore

@@ -13,8 +13,7 @@ npm-debug.log
 yarn-error.log
 yarn.lock
 
+**/node_modules
+
 .idea
 .vscode
-
-# Ignore app.js as it is autogenerated with each JS change
-web/public/js/app.js

.styleci.yml

@@ -6,8 +6,4 @@ php:
     not-name:
       - index.php
       - server.php
-js:
-  finder:
-    not-name:
-      - webpack.mix.js
 css: true

package.json

@@ -0,0 +1,17 @@
+{
+  "name": "shopify-app-template-php",
+  "version": "1.0.0",
+  "license": "MIT",
+  "scripts": {
+    "shopify": "shopify",
+    "build": "shopify app build",
+    "dev": "shopify app dev",
+    "push": "shopify app push",
+    "scaffold": "shopify app scaffold",
+    "deploy": "shopify app deploy"
+  },
+  "dependencies": {
+    "@shopify/app": "^3.0.0",
+    "@shopify/cli": "^3.0.0"
+  }
+}

shopify.app.toml

@@ -0,0 +1,3 @@
+# This file stores configurations for your Shopify app.
+
+scopes = "write_products"

web/.env.example

@@ -2,7 +2,6 @@ APP_NAME="Shopify PHP App"
 APP_ENV=local
 APP_KEY=
 APP_DEBUG=true
-APP_URL=http://localhost
 
 LOG_CHANNEL=stack
 LOG_LEVEL=debug
@@ -11,8 +10,3 @@ DB_CONNECTION=sqlite
 # The path to the database file should be absolute, make sure to update it!
 DB_DATABASE=storage/db.sqlite
 DB_FOREIGN_KEYS=true
-
-SHOPIFY_API_KEY=
-SHOPIFY_API_SECRET=
-SCOPES=
-HOST=

web/app/Http/Middleware/EnsureShopifySession.php

@@ -53,7 +53,7 @@ public function handle(Request $request, Closure $next, string $accessMode = sel
 
         if ($session && $shop && $session->getShop() !== $shop) {
             // This request is for a different shop. Go straight to login
-            return redirect("/login?shop=$shop");
+            return redirect("/api/auth?shop=$shop");
         }
 
         if ($session && $session->isValid()) {
@@ -83,10 +83,10 @@ public function handle(Request $request, Closure $next, string $accessMode = sel
 
             return response('', 401, [
                 self::REDIRECT_HEADER => '1',
-                self::REDIRECT_URL_HEADER => "/login?shop=$shop",
+                self::REDIRECT_URL_HEADER => "/api/auth?shop=$shop",
             ]);
         } else {
-            return redirect("/login?shop=$shop");
+            return redirect("/api/auth?shop=$shop");
         }
     }
 }

web/app/Http/Middleware/VerifyCsrfToken.php

@@ -12,7 +12,7 @@ class VerifyCsrfToken extends Middleware
      * @var array
      */
     protected $except = [
-        'graphql',
-        'webhooks',
+        'api/graphql',
+        'api/webhooks',
     ];
 }

web/app/Providers/AppServiceProvider.php

@@ -31,14 +31,17 @@ public function register()
      */
     public function boot()
     {
+        $host = str_replace('https://', '', env('HOST', 'not_defined'));
+
         Context::initialize(
-            Config::get('shopify.api_key'),
-            Config::get('shopify.api_secret'),
-            Config::get('shopify.scopes'),
-            str_replace('https://', '', Config::get('shopify.host')),
+            env('SHOPIFY_API_KEY', 'not_defined'),
+            env('SHOPIFY_API_SECRET', 'not_defined'),
+            env('SCOPES', 'not_defined'),
+            $host,
             new DbSessionStorage()
         );
 
+        URL::forceRootUrl("https://$host");
         URL::forceScheme('https');
 
         Registry::addHandler(Topics::APP_UNINSTALLED, new AppUninstalled());

web/artisan

@@ -15,9 +15,9 @@ define('LARAVEL_START', microtime(true));
 |
 */
 
-require __DIR__.'/vendor/autoload.php';
+require __DIR__ . '/vendor/autoload.php';
 
-$app = require_once __DIR__.'/bootstrap/app.php';
+$app = require_once __DIR__ . '/bootstrap/app.php';
 
 /*
 |--------------------------------------------------------------------------

web/composer.json

@@ -46,10 +46,11 @@
         "post-create-project-cmd": [
             "@php artisan key:generate --ansi"
         ],
-        "serve": "php artisan serve",
+        "serve": "php artisan serve --port=\"${BACKEND_PORT:-$PORT}\"",
         "react": "npm run watch",
         "test": "php artisan test --env=testing",
-        "lint": "./vendor/bin/phpcs --standard=PSR12 app tests routes"
+        "lint": "./vendor/bin/phpcs --standard=PSR12 app tests routes",
+        "build-frontend-links": "ln -sf ../frontend/dist/assets public/assets && ln -sf ../frontend/dist/index.html public/index.html"
     },
     "extra": {
         "laravel": {

web/config/app.php

@@ -52,7 +52,7 @@
     |
     */
 
-    'url' => env('APP_URL', 'http://localhost'),
+    'url' => env('HOST', 'http://localhost'),
 
     'asset_url' => env('ASSET_URL', null),
 

web/public/assets

@@ -0,0 +1 @@
+../frontend/dist/assets

web/public/index.html

@@ -0,0 +1 @@
+../frontend/dist/index.html

web/public/index.php

@@ -16,8 +16,8 @@
 |
 */
 
-if (file_exists(__DIR__.'/../storage/framework/maintenance.php')) {
-    require __DIR__.'/../storage/framework/maintenance.php';
+if (file_exists(__DIR__ . '/../storage/framework/maintenance.php')) {
+    require __DIR__ . '/../storage/framework/maintenance.php';
 }
 
 /*
@@ -31,7 +31,7 @@
 |
 */
 
-require __DIR__.'/../vendor/autoload.php';
+require __DIR__ . '/../vendor/autoload.php';
 
 /*
 |--------------------------------------------------------------------------
@@ -44,7 +44,7 @@
 |
 */
 
-$app = require_once __DIR__.'/../bootstrap/app.php';
+$app = require_once __DIR__ . '/../bootstrap/app.php';
 
 $kernel = $app->make(Kernel::class);