Merge pull request #936 from userfrosting/develop-jordan

ClassMapper and Docker improvements

Author: Silic0nS0ldier

CHANGELOG.md

@@ -10,10 +10,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - `sprinkle:list` bakery command
 - `NoCache` middleware to prevent caching of routes with dynamic content
+- Sample test environment for Docker
 
 ### Changed
 - Sprinkle list in the bakery `debug` command to uses the new `sprinkle:list` table
 - `routerCacheFile` config now only contains filename. Locator is used to find the full path
+- Updated Docker integration
 - Moved some constants from `app/defines.php` to `app/sprinkles/core/defines.php`
 - Move route initialization from system to core sprinkle as router service is located in the core sprinkle
 
@@ -33,6 +35,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
     - Added specific tests for sprinkleManager with 100% test coverage
 - Ignore existing `package-lock.json` which caused incorrect dependencies to be installed when upgrading from older versions of UserFrosting.
 - Vendor assets not found in production mode
+- Various Docker specific edge cases and misconfigurations
 - Fix path issue on Windows
 
 ## 4.2.0-beta.1

app/sprinkles/core/src/Util/ClassMapper.php

@@ -37,10 +37,7 @@ public function createInstance($identifier)
 
         $params = array_slice(func_get_args(), 1);
 
-        // We must use reflection in PHP < 5.6.  See http://stackoverflow.com/questions/8734522/dynamically-call-class-with-variable-number-of-parameters-in-the-constructor
-        $reflection = new \ReflectionClass($className);
-
-        return $reflection->newInstanceArgs($params);
+        return new $className(...$params);
     }
 
     /**
@@ -90,6 +87,6 @@ public function staticMethod($identifier, $methodName)
 
         $params = array_slice(func_get_args(), 2);
 
-        return call_user_func_array("$className::$methodName", $params);
+        return $className::$methodName(...$params);
     }
 }

build/gulpfile.esm.js

@@ -261,29 +261,29 @@ export function bundle() {
     rawConfig.BundlesVirtualBasePath = "./assets/";
 
     // Bundle results callback
+    /**
+     * 
+     * @param {Map<string, any[]} results 
+     */
     function bundleResults(results) {
+        // Compute possible asset base paths (for matching later)
+        /** @type {string[]} */
+        const assetBasePaths = [];
+        assetBasePaths.push(resolvePath(vendorAssetsDir, "bower_components"));
+        assetBasePaths.push(resolvePath(vendorAssetsDir, "node_modules"));
+        for (const sprinkle of sprinkles) {
+            assetBasePaths.push(resolvePath(sprinklesDir, sprinkle, "assets"));
+        }
+
+
         /**
          * Resolves absolute path to gulp-uf-bundle-assets v2 style path
          * @param {string} path Absolute path to resolve.
          */
         function resolveToAssetPath(path) {
-            // TODO There is a significant amount of duplicated code here. We can do better.
-            if (path.startsWith(resolvePath(sprinklesDir))) {
-                // Handle sprinkle path
-                for (const sprinkle of sprinkles) {
-                    const sprinklePath = resolvePath(sprinklesDir, sprinkle, "assets");
-                    if (path.startsWith(sprinklePath)) {
-                        return path.replace(sprinklePath, "").replace(/\\/g, "/").replace("/", "");
-                    }
-                }
-            }
-            else {
-                // Handle vendor path
-                if (path.startsWith(resolvePath(vendorAssetsDir, "bower_components"))) {
-                    return path.replace(resolvePath(vendorAssetsDir, "bower_components"), "").replace(/\\/g, "/").replace("/", "");
-                }
-                else if (path.startsWith(resolvePath(vendorAssetsDir, "node_modules"))) {
-                    return path.replace(resolvePath(vendorAssetsDir, "node_modules"), "").replace(/\\/g, "/").replace("/", "");
+            for (const basePath of assetBasePaths) {
+                if (path.startsWith(basePath)) {
+                    return path.replace(basePath, "").replace(/\\/g, "/").replace("/", "");
                 }
             }
 

build/package.json

@@ -2,10 +2,10 @@
   "private": true,
   "dependencies": {
     "@userfrosting/browserify-dependencies": "^1.0.0-beta.1",
-    "@userfrosting/gulp-bundle-assets": "^3.0.0-rc.1",
+    "@userfrosting/gulp-bundle-assets": "^3.0.0-rc.2",
     "@userfrosting/merge-package-dependencies": "^1.2.1",
-    "bower": "^1.8.4",
-    "esm": "^3.0.84",
+    "bower": "^1.8.8",
+    "esm": "^3.2.5",
     "del": "^3.0.0",
     "dotenv": "^6.2.0",
     "gulp": "^4.0.0",

docker-compose-testdb.yml

@@ -24,6 +24,7 @@ services:
       - ./docker/php/custom.ini:/usr/local/etc/php/conf.d/custom.ini
     networks:
       - backend
+
   nginx:
     restart: unless-stopped
     tty: true
@@ -41,6 +42,7 @@ services:
     networks:
       - frontend
       - backend
+
   ufmysql:
     image: mysql:5.7
     networks:
@@ -54,6 +56,7 @@ services:
       - 8593:3306
     volumes:
       - userfrosting-db:/var/lib/mysql
+
   ufmysqltest:
     image: mysql:5.7
     networks:
@@ -67,25 +70,26 @@ services:
       - 8594:3306
     volumes:
       - userfrosting-test-db:/var/lib/mysql
+
   composer:
     image: "composer"
     volumes:
       - .:/app
     working_dir: /app
-    command: -V
+
   node:
-    image: node:alpine
     build:
       context: ./docker/node
     volumes:
       - .:/app
     working_dir: /app/build
-    command: npm run uf-assets-install
+
 volumes:
   userfrosting-db:
     driver: local
   userfrosting-test-db:
     driver: local
+
 networks:
   frontend:
   backend:

docker-compose.yml

@@ -17,6 +17,7 @@ services:
       - ./docker/php/custom.ini:/usr/local/etc/php/conf.d/custom.ini
     networks:
       - backend
+
   nginx:
     restart: unless-stopped
     tty: true
@@ -33,6 +34,7 @@ services:
     networks:
       - frontend
       - backend
+
   ufmysql:
     image: mysql:5.7
     networks:
@@ -46,21 +48,19 @@ services:
       - 8593:3306
     volumes:
       - userfrosting-db:/var/lib/mysql
+
   composer:
     image: "composer"
     volumes:
       - .:/app
     working_dir: /app
-    command: -V
 
   node:
-    image: node:alpine
     build:
       context: ./docker/node
     volumes:
       - .:/app
     working_dir: /app/build
-    command: npm run uf-assets-install
 
 volumes:
   userfrosting-db:

docker/README.md

@@ -1,48 +1,56 @@
 # Docker Development Environment
 
+>This is also documented at [UserFrosting Learn](https://learn.userfrosting.com/installation/environment/docker).
+
 First, install [Docker Compose](https://docs.docker.com/compose/install/).
 
 Second, initialize a new UserFrosting project:
-1. Clone the repository `git clone https://github.com/userfrosting/UserFrosting.git .` and change into that directory `cd userfrosting`
-1. Run `cp app/sprinkles.example.json app/sprinkles.json` or upload your own (also upload your sprinkles if you have some)
-2. Run `sudo chown -R 33 app/{logs,cache,sessions}` (Changes the user to the www-data user of the image, more information [here](https://serversforhackers.com/c/dckr-file-permissions) )
-2. Run `sudo docker-compose run composer install` to install all composer modules.
-3. Run `sudo docker-compose run node npm install` to install all npm modules.
+
+1. Copy `app/sprinkles.example.json` to `app/sprinkles.json`
+2. Run `chmod 777 app/{logs,cache,sessions}` to fix file permissions for web server. (NOTE: File
+   permissions should be properly secured in a production environment!)
+3. Run `docker-compose run composer install --ignore-platform-reqs --no-scripts` to install all composer modules. (https://hub.docker.com/_/composer) Sometimes dependencies or Composer scripts require the availability of certain PHP extensions. You can work around this as follows: Pass the `--ignore-platform-reqs and --no-scripts` flags to install or update
+4. Run `docker-compose run node npm install` to install all npm modules.
+5. Run `docker-compose run composer update --ignore-platform-reqs --no-scripts` to install remaining composer modules
+6. Run `docker-compose run node npm run uf-assets-install` to install all frontend vendor assets.
 
 Now you can start up the entire Nginx + PHP + MySQL stack using docker with:
 
-    $ sudo docker-compose up -d
+    $ docker-compose up -d
+
+the `-d` flag will launch this in the background so you can continue to use the terminal window. On the first run you need to init the database (your container name may be different depending on the name of your root directory):
+
+    $ docker exec -it -u www-data userfrosting_php_1 sh -c 'php bakery migrate'
 
-On the first run you need to init the database (Be sure to execute this in the same directory, `${PWD##*/}` is a statement to get your current working directorys name. Docker uses it to name your container):
+You also need to setup the first admin user (again, your container name may be different depending on the name of your root directory):
 
-    $ sudo docker exec -it -u www-data ${PWD##*/}_php_1 bash -c 'php bakery migrate'
-    
-You also need to setup the first admin user (again, `${PWD##*/}` is a statement to get your current working directorys name):
+    $ docker exec -it -u www-data userfrosting_php_1 sh -c 'php bakery create-admin'
 
-    $ sudo docker exec -it -u www-data ${PWD##*/}_php_1 bash -c 'php bakery create-admin'
+Now visit `http://localhost:8591/` to see your UserFrosting homepage!
 
-Now visit http://localhost:8570/ to see your UserFrosting homepage!
+**Paste these into a bash file and execute it!**
 
-**This is not (yet) meant for production!!**
+```
+chmod 777 app/{logs,cache,sessions}
+docker-compose build --force-rm --no-cache
+docker-compose run composer install --ignore-platform-reqs --no-scripts
+docker-compose run node npm install
+docker-compose run composer update --ignore-platform-reqs --no-scripts
+docker-compose run node npm run uf-assets-install
+docker-compose up -d
+echo -n "Enter Docker Container Name --> "
+read docker_container
+docker exec -it -u www-data $docker_container sh -c 'php bakery migrate'
+docker exec -it -u www-data $docker_container sh -c 'php bakery create-admin'
+```
+
+**This is not (yet) meant for production!**
 
 You may be tempted to run with this in production but this setup has not been security-hardened. For example:
 
-- Database is exposed on port 8571 so you can access MySQL using your favorite client at localhost:8571. However,
+- Database is exposed on port 8593 so you can access MySQL using your favorite client at localhost:8593. However,
   the way Docker exposes this actually bypasses common firewalls like `ufw` so this should not be exposed in production.
 - Database credentials are hard-coded so obviously not secure.
 - File permissions may be more open than necessary.
+- HTTPS not implemented fully
 - It just hasn't been thoroughly tested in the capacity of being a production system.
-
-## Updating your code
-As you might guessed you will have to run 
-
-    $ sudo docker exec -it -u www-data userfrosting_php_1 bash -c 'php bakery migrate'
-    
-again if you want to migrate tables.
-You can change `php bakery migrate` to other `bakery` commands as well.
-Be aware that the userfrosting container doesn't know about npm!  
-Similary for composer:
-
-    $ sudo docker-compose run composer update
-   
-See the [Docker](https://docs.docker.com/engine) and [Docker-compose documentation](https://docs.docker.com/compose/) for more details.

docker/php/Dockerfile

@@ -1,12 +1,17 @@
-FROM php:7.2-fpm
-RUN apt-get update && apt-get install -y \
-    libfreetype6-dev \
-    libjpeg62-turbo-dev \
+FROM php:7.2-fpm-alpine
+
+# Update and install packages
+RUN apk update
+RUN apk add \
+    freetype-dev \
+    libjpeg-turbo-dev \
     libpng-dev \
-    zip \
-    && docker-php-ext-configure gd --with-freetype-dir=/usr/include/ --with-jpeg-dir=/usr/include/ \
+    zip
+
+# Install and configure PHP extensions
+RUN docker-php-ext-configure gd --with-freetype-dir=/usr/include/ --with-jpeg-dir=/usr/include/ \
     && docker-php-ext-install -j$(nproc) gd \
     && docker-php-ext-install -j$(nproc) pdo pdo_mysql \
     && docker-php-ext-install -j$(nproc) zip
-RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+
 WORKDIR /app