feat: services trait + vite 5

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release Notes for Password Policy
 
+## 5.0.3 - unreleased
+### Fixed
+- Fixed a bug that could occur if the max length wasn't set, passwords always said "could not contain more than 0 characters".
+- Removed the "playground" from the settings to test the strength indicator, this was only meant for development.
+- Fixed an issue where the pwned option would always return that the password was compromised.
+
 ## 5.0.2.1 - 2024-12-19
 ### Fixed
 - Fixed `Failed to instantiate component or class` on the assetbundle [Thanks niektenhoopen](https://github.com/craftpulse/craft-password-policy/pull/33)

buildchain/package.json

@@ -27,11 +27,11 @@
     "stylelint-config-recommended-vue": "^1.0.0",
     "stylelint-config-standard-scss": "^3.0.0",
     "tailwindcss": "^3.0.0",
-    "vite": "^4.0.0",
+    "vite": "^5.0.0",
     "vite-plugin-compression": "^0.5.0",
     "vite-plugin-eslint": "^1.8.0",
-    "vite-plugin-restart": "^0.3.0",
-    "vite-plugin-stylelint": "^4.1.0",
+    "vite-plugin-restart": "^0.4.0",
+    "vite-plugin-stylelint": "^5.2.1",
     "vue-eslint-parser": "^9.0.0"
   },
   "scripts": {

buildchain/vite.config.ts

@@ -1,18 +1,17 @@
-import {defineConfig} from 'vite';
-import {visualizer} from 'rollup-plugin-visualizer';
-import viteEslintPlugin from 'vite-plugin-eslint';
-import viteCompressionPlugin from 'vite-plugin-compression';
-import viteRestartPlugin from 'vite-plugin-restart';
-import viteStylelintPlugin from 'vite-plugin-stylelint';
-import viteVuePlugin from '@vitejs/plugin-vue'
+import {defineConfig} from 'vite'
+import {visualizer} from 'rollup-plugin-visualizer'
+import viteEslintPlugin from 'vite-plugin-eslint'
+import viteCompressionPlugin from 'vite-plugin-compression'
+import viteRestartPlugin from 'vite-plugin-restart'
+import viteStylelintPlugin from 'vite-plugin-stylelint'
 import * as path from 'path';
 
 // https://vitejs.dev/config/
 export default defineConfig(({command}) => ({
   base: command === 'serve' ? '' : '/dist/',
   build: {
     emptyOutDir: true,
-    manifest: true,
+    manifest: 'manifest.json',
     outDir: '../src/web/assets/dist',
     rollupOptions: {
       input: {
@@ -29,7 +28,6 @@ export default defineConfig(({command}) => ({
         '../src/templates/**/*',
       ],
     }),
-    viteVuePlugin(),
     viteCompressionPlugin({
       filter: /\.(js|mjs|json|css|map)$/i
     }),

src/PasswordPolicy.php

@@ -32,8 +32,7 @@
 use craftpulse\passwordpolicy\assetbundles\passwordpolicy\PasswordPolicyAsset;
 use craftpulse\passwordpolicy\models\SettingsModel;
 use craftpulse\passwordpolicy\rules\UserRules;
-use craftpulse\passwordpolicy\services\PasswordService;
-use craftpulse\passwordpolicy\services\RetentionService;
+use craftpulse\passwordpolicy\services\ServicesTrait;
 use craftpulse\passwordpolicy\utilities\RetentionUtility;
 use craftpulse\passwordpolicy\variables\PasswordPolicyVariable;
 
@@ -43,6 +42,7 @@
 use nystudio107\pluginvite\services\ViteService;
 use Psr\Log\LogLevel;
 use Throwable;
+use Yii;
 use yii\base\Event;
 use yii\base\InvalidRouteException;
 use yii\log\Dispatcher;
@@ -65,6 +65,8 @@ class PasswordPolicy extends Plugin
     // Traits
     // =========================================================================
 
+    use ServicesTrait;
+
     // Static Properties
     // =========================================================================
     /**
@@ -99,31 +101,6 @@ class PasswordPolicy extends Plugin
      */
     public static ?SettingsModel $settings = null;
 
-    /**
-     * @inheritdoc
-     */
-    public static function config(): array
-    {
-        return [
-            'components' => [
-                'passwords' => PasswordService::class,
-                'retention' => RetentionService::class,
-                // Register the vite service
-                // @TODO devServerPublic / devServerInternal / serverPublic would benefit of `.env` vars for local dev
-                'vite' => [
-                    'class' => VitePluginService::class,
-                    'assetClass' => PasswordPolicyAsset::class,
-                    'useDevServer' => true,
-                    'devServerPublic' => 'http://localhost:3005',
-                    'serverPublic' => 'http://localhost:8000',
-                    'errorEntry' => 'src/js/PasswordPolicy.js',
-                    'devServerInternal' => 'http://craft-password-policy-v5-buildchain-dev:3005',
-                    'checkDevServer' => true,
-                ],
-            ],
-        ];
-    }
-
     public function init(): void
     {
         parent::init();
@@ -137,12 +114,14 @@ public function init(): void
             $this->controllerNamespace = 'craftpulse\passwordpolicy\console\controllers';
         }
 
-        // Install our global evnet handlers
+        // Install our global event handlers
         $this->installEventHandlers();
+        $this->installCpEventHandlers();
 
         // Register control panel events
         if (Craft::$app->getRequest()->getIsCpRequest()) {
             $this->registerCpUrlRules();
+            $this->installCpEventHandlers();
         }
 
         // Log that the plugin has loaded
@@ -285,6 +264,15 @@ static function(DefineRulesEvent $event) {
             }
         );
 
+        $this->registerUserPermissions();
+        $this->registerUtilities();
+    }
+
+    /**
+     * @return void
+     */
+    protected function installCpEventHandlers(): void
+    {
         // Load asset before page template is rendered
         Event::on(
             View::class,
@@ -296,13 +284,17 @@ function(TemplateEvent $event) {
                 // Register Asset Bundle
                 $view->registerAssetBundle(PasswordPolicyAsset::class);
 
-                // Load Asset
+                //$tagOptions = [
+                //    'depends' => [
+                //        'craftpulse\\passwordpolicy\\assetbundles\\passwordpolicy\\PasswordPolicyAsset'
+                //    ],
+                //];
+                $manifestPath = '@craftpulse/passwordpolicy/web/assets/dist/';
+                $this->vite->manifestPath = rtrim(Yii::getAlias($manifestPath), '/\\');
+                //$this->vite->manifestPath = $manifestPath;
                 $this->vite->register('src/js/indicator.ts', false);
             }
         );
-
-        $this->registerUserPermissions();
-        $this->registerUtilities();
     }
 
     // Private Methods

src/assetbundles/passwordpolicy/PasswordPolicyAsset.php

@@ -33,7 +33,7 @@ class PasswordPolicyAsset extends AssetBundle
      */
     public function init(): void
     {
-        $this->sourcePath = '@craftpulse/passwordpolicy/web/assets/dist';
+        $this->sourcePath = '@craftpulse/passwordpolicy/web/assets/dist/';
         $this->depends = [
             CpAsset::class,
         ];

src/rules/UserRules.php

@@ -40,17 +40,6 @@ public static function defineRules(): array
             ),
         ];
         $rules[] =
-        [
-            ['password', 'newPassword'],
-            'string',
-            'max' => $settings->maxLength,
-            'tooLong' => Craft::t(
-                'password-policy',
-                Craft::t('password-policy','Password can maximum contain {max} characters.'),
-                ['max' => $settings->maxLength]
-            ),
-        ];
-        $rules[] =
         [
             ['password', 'newPassword'],
             'match',
@@ -61,6 +50,20 @@ public static function defineRules(): array
             ) . PasswordPolicy::$plugin->passwords->generateMessage(),
         ];
 
+        if ($settings->maxLength > $settings->minLength) {
+            $rules[] =
+                [
+                    ['password', 'newPassword'],
+                    'string',
+                    'max' => $settings->maxLength,
+                    'tooLong' => Craft::t(
+                        'password-policy',
+                        Craft::t('password-policy','Password can maximum contain {max} characters.'),
+                        ['max' => $settings->maxLength]
+                    ),
+                ];
+        }
+
         if ($settings->pwned) {
             $rules[] = [['password', 'newPassword'], PwnedValidator::class];
         }

src/services/PasswordService.php

@@ -79,7 +79,7 @@ public function generateMessage(): string
      */
     public function pwned(string $password): ?bool
     {
-        $hash = strtoupper(sha1('password'));
+        $hash = strtoupper(sha1($password));
         $prefix = substr($hash, 0, 5);
         $suffix = substr($hash, 5);
 

src/services/ServicesTrait.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace craftpulse\passwordpolicy\services;
+
+use craftpulse\passwordpolicy\assetbundles\passwordpolicy\PasswordPolicyAsset;
+use nystudio107\pluginvite\services\VitePluginService;
+use yii\base\InvalidConfigException;
+
+/**
+ * @author    craftpulse
+ * @package   Password Policy
+ * @since     5.0.3
+ *
+ * @property Passwords $passwords
+ * @property Retention $retention
+ * @property VitePluginService $vite
+ */
+trait ServicesTrait
+{
+    public static function config(): array
+    {
+        return [
+            'components' => [
+                'passwords' => PasswordService::class,
+                'retention' => RetentionService::class,
+                // Register the vite service
+                // @TODO devServerPublic / devServerInternal / serverPublic would benefit of `.env` vars for local dev
+                'vite' => [
+                    'assetClass' => PasswordPolicyAsset::class,
+                    'checkDevServer' => true,
+                    'class' => VitePluginService::class,
+                    'devServerInternal' => 'http://craft-password-policy-v5-buildchain-dev:3005',
+                    'devServerPublic' => 'http://localhost:3005',
+                    'errorEntry' => 'src/js/indicator.ts',
+                    'useDevServer' => true,
+                ],
+            ],
+        ];
+    }
+
+    // Public Methods
+    // =========================================================================
+
+    /**
+     * Returns the passwords service
+     *
+     * @return Events The events service
+     * @throws InvalidConfigException
+     */
+    public function getPasswords(): Events
+    {
+        return $this->get('passwords');
+    }
+
+    /**
+     * Returns the retention service
+     *
+     * @return Redirects The redirects service
+     * @throws InvalidConfigException
+     */
+    public function getRetention(): Redirects
+    {
+        return $this->get('retention');
+    }
+
+    /**
+     * Returns the vite service
+     *
+     * @return VitePluginService The vite service
+     * @throws InvalidConfigException
+     */
+    public function getVite(): VitePluginService
+    {
+        return $this->get('vite');
+    }
+}

src/templates/_settings.twig

@@ -7,7 +7,6 @@
     features: { label: 'Configuration'|t('password-policy'), url: '#features' },
     rules: { label: 'Password Rules'|t('password-policy'), url: '#rules' },
     retention: { label: 'Password Retention Features'|t('password-policy'), url: '#retention' },
-    playground: { label: 'Playground'|t('password-policy'), url: '#playground' },
 } %}
 
 {% block actionButton %}
@@ -136,19 +135,4 @@
             id: 'expiryInput',
         }, expiryInput) }}
     </div>
-
-    <div id="playground" class="hidden flex-fields">
-        <div>
-            <div id="newPassword-field" class="field" data-attribute="newPassword">
-                <div class="heading">
-                    <label id="newPassword-label" for="newPassword">New Password</label>
-                </div>
-                <div class="input ltr">
-                    <div class="passwordwrapper">
-                        <input type="password" id="newPassword" class="password text fullwidth" name="newPassword" autocomplete="new-password" dir="ltr" aria-labelledby="newPassword-label">
-                    </div>
-                </div>
-            </div>
-        </div>
-    </div>
 {% endblock %}

src/web/assets/dist/manifest.json

@@ -1,14 +1,11 @@
 {
-  "src/js/indicator.css": {
-    "file": "assets/indicator-b0f69606.css",
-    "src": "src/js/indicator.css"
-  },
   "src/js/indicator.ts": {
-    "css": [
-      "assets/indicator-b0f69606.css"
-    ],
-    "file": "assets/strengthIndicator-d691cd8c.js",
+    "file": "assets/strengthIndicator-DbbUdF_w.js",
+    "name": "strengthIndicator",
+    "src": "src/js/indicator.ts",
     "isEntry": true,
-    "src": "src/js/indicator.ts"
+    "css": [
+      "assets/strengthIndicator-BJVqszZH.css"
+    ]
   }
 }