Refactor wizard client and add tests

Author: angusmcleod

app/controllers/custom_wizard/wizard.rb

@@ -1,54 +1,39 @@
 # frozen_string_literal: true
-class CustomWizard::WizardController < ::ApplicationController
-  include ApplicationHelper
-  prepend_view_path(Rails.root.join('plugins', 'discourse-custom-wizard', 'app', 'views'))
-  layout 'wizard'
+class CustomWizard::WizardController < ::ActionController::Base
+  helper ApplicationHelper
 
+  include CurrentUser
+  include CanonicalURL::ControllerExtensions
+  include GlobalPath
+
+  prepend_view_path(Rails.root.join('plugins', 'discourse-custom-wizard', 'views'))
+  layout :set_wizard_layout
+
+  before_action :preload_wizard_json
   before_action :ensure_plugin_enabled
   before_action :ensure_logged_in, only: [:skip]
+
   helper_method :wizard_page_title
   helper_method :wizard_theme_id
   helper_method :wizard_theme_lookup
   helper_method :wizard_theme_translations_lookup
 
-  def wizard
-    @builder = CustomWizard::Builder.new(params[:wizard_id].underscore, current_user)
-    @wizard ||= @builder.build
-    @wizard
-  end
-
-  def wizard_page_title
-    wizard ? (wizard.name || wizard.id) : I18n.t('wizard.custom_title')
-  end
-
-  def wizard_theme_id
-    wizard ? wizard.theme_id : nil
-  end
-
-  def wizard_theme_lookup(name)
-    Theme.lookup_field(wizard_theme_id, mobile_view? ? :mobile : :desktop, name)
-  end
-
-  def wizard_theme_translations_lookup
-    Theme.lookup_field(wizard_theme_id, :translations, I18n.locale)
+  def set_wizard_layout
+    action_name === 'qunit' ? 'qunit' : 'wizard'
   end
 
   def index
     respond_to do |format|
       format.json do
-        builder = CustomWizard::Builder.new(params[:wizard_id].underscore, current_user)
-
-        if builder.wizard.present?
-          builder_opts = {}
-          builder_opts[:reset] = params[:reset]
-          built_wizard = builder.build(builder_opts, params)
-
-          render_serialized(built_wizard, ::CustomWizard::WizardSerializer, root: false)
+        if wizard.present?
+          render json: CustomWizard::WizardSerializer.new(wizard, scope: guardian, root: false).as_json, status: 200
         else
           render json: { error: I18n.t('wizard.none') }
         end
       end
-      format.html {}
+      format.html do
+        render "default/empty"
+      end
     end
   end
 
@@ -62,8 +47,10 @@ def skip
     result = success_json
 
     if current_user && wizard.can_access?
-      if redirect_to = wizard.current_submission&.redirect_to
-        result.merge!(redirect_to: redirect_to)
+      submission = wizard.current_submission
+
+      if submission.present? && submission.redirect_to
+        result.merge!(redirect_to: submission.redirect_to)
       end
 
       wizard.cleanup_on_skip!
@@ -72,6 +59,64 @@ def skip
     render json: result
   end
 
+  def qunit
+    raise Discourse::InvalidAccess.new if Rails.env.production?
+
+    respond_to do |format|
+      format.html do
+        render "default/empty"
+      end
+    end
+  end
+
+  protected
+
+  def ensure_logged_in
+    raise Discourse::NotLoggedIn.new unless current_user.present?
+  end
+
+  def guardian
+    @guardian ||= Guardian.new(current_user, request)
+  end
+
+  def wizard
+    @wizard ||= begin
+      builder = CustomWizard::Builder.new(params[:wizard_id].underscore, current_user)
+      return nil unless builder.present?
+      opts = {}
+      opts[:reset] = params[:reset]
+      builder.build(opts, params)
+    end
+  end
+
+  def wizard_page_title
+    wizard ? (wizard.name || wizard.id) : I18n.t('wizard.custom_title')
+  end
+
+  def wizard_theme_id
+    wizard ? wizard.theme_id : nil
+  end
+
+  def wizard_theme_lookup(name)
+    Theme.lookup_field(wizard_theme_id, view_context.mobile_view? ? :mobile : :desktop, name)
+  end
+
+  def wizard_theme_translations_lookup
+    Theme.lookup_field(wizard_theme_id, :translations, I18n.locale)
+  end
+
+  def preload_wizard_json
+    return if request.xhr? || request.format.json?
+    return if request.method != "GET"
+
+    store_preloaded("siteSettings", SiteSetting.client_settings_json)
+  end
+
+  def store_preloaded(key, json)
+    @preloaded ||= {}
+    @preloaded[key] = json.gsub("</", "<\\/")
+  end
+
   private
 
   def ensure_plugin_enabled

app/views/layouts/qunit.html.erb

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Custom Wizard QUnit Test Runner</title>
+    <%= discourse_stylesheet_link_tag(:test_helper, theme_id: nil) %>
+    <%= discourse_stylesheet_link_tag :wizard, theme_id: nil %>
+    <%= discourse_stylesheet_link_tag :wizard_custom %>
+    <%= preload_script "locales/en" %>
+    <%= preload_script "ember_jquery" %>
+    <%= preload_script "wizard-vendor" %>
+    <%= preload_script "wizard-custom" %>
+    <%= preload_script "wizard-raw-templates" %>
+    <%= preload_script "wizard-plugin" %>
+    <%= preload_script "pretty-text-bundle" %>
+    <%= preload_script "wizard-qunit" %>
+    <%= csrf_meta_tags %>
+
+    <script src="<%= ExtraLocalesController.url("wizard") %>"></script>
+
+    <%= tag.meta id: 'data-discourse-setup', data: client_side_setup_data %>
+    <meta name="discourse_theme_id" content="">
+    <meta name="discourse-base-uri" content="<%= Discourse.base_path %>">
+  </head>
+  <body class="custom-wizard">
+    <div id="qunit"></div>
+    <div id="qunit-fixture"></div>
+  </body>
+</html>

app/views/layouts/wizard.html.erb

@@ -11,10 +11,8 @@
     <%= preload_script "locales/#{I18n.locale}" %>
     <%= preload_script "ember_jquery" %>
     <%= preload_script "wizard-vendor" %>
-    <%= preload_script "wizard-application" %>
-    <%= preload_script "wizard-custom-globals" %>
-    <%= preload_script "wizard-raw-templates" %>
     <%= preload_script "wizard-custom" %>
+    <%= preload_script "wizard-raw-templates" %>
     <%= preload_script "wizard-plugin" %>
     <%= preload_script "pretty-text-bundle" %>
     <script src="<%= ExtraLocalesController.url("wizard") %>"></script>
@@ -58,5 +56,7 @@
         <%= raw SvgSprite.bundle %>
       </div>
     </div>
+
+    <div class="hidden" id="data-preloaded-wizard" data-preloaded-wizard="<%= preloaded_json %>"></div>
   </body>
 </html>

assets/javascripts/wizard-custom-globals.js

@@ -1,4 +1,4 @@
 (function () {
-  let wizard = require("discourse/plugins/discourse-custom-wizard/wizard/custom-wizard").default.create();
+  let wizard = require("discourse/plugins/discourse-custom-wizard/wizard/application").default.create();
   wizard.start();
 })();

assets/javascripts/wizard-custom-start.js

@@ -1,20 +1,20 @@
+//= require_tree_discourse truth-helpers/addon
+//= require_tree_discourse discourse-common/addon
+//= require_tree_discourse select-kit/addon
+//= require_tree_discourse wizard/lib
+//= require_tree_discourse wizard/mixins
 //= require_tree_discourse discourse/app/lib
 //= require_tree_discourse discourse/app/mixins
 
 //= require discourse/app/adapters/rest
-
 //= require message-bus
-
 //= require_tree_discourse discourse/app/models
 
 //= require discourse/app/helpers/category-link
 //= require discourse/app/helpers/user-avatar
 //= require discourse/app/helpers/format-username
 //= require discourse/app/helpers/share-url
 //= require discourse/app/helpers/decorate-username-selector
-//= require discourse-common/addon/helpers/component-for-collection
-//= require discourse-common/addon/helpers/component-for-row
-//= require discourse-common/addon/lib/raw-templates
 //= require discourse/app/helpers/discourse-tag
 
 //= require discourse/app/services/app-events
@@ -70,11 +70,11 @@
 //= require bootbox.js
 //= require discourse-shims
 
-//= require ./wizard/custom-wizard
+//= require ./wizard/application
+//= require ./wizard/router
 //= require_tree ./wizard/components
 //= require_tree ./wizard/controllers
 //= require_tree ./wizard/helpers
-//= require_tree ./wizard/initializers
 //= require_tree ./wizard/lib
 //= require_tree ./wizard/models
 //= require_tree ./wizard/routes

assets/javascripts/wizard-custom.js

@@ -0,0 +1,16 @@
+//= require route-recognizer
+//= require fake_xml_http_request
+//= require pretender
+//= require qunit
+//= require ember-qunit
+//= require test-shims
+//= require jquery.debug
+//= require ember.debug
+//= require ember-template-compiler
+
+//= require_tree ./wizard/tests/fixtures
+//= require ./wizard/tests/pretender
+//= require_tree ./wizard/tests/helpers
+//= require_tree ./wizard/tests/acceptance
+
+//= require ./wizard/tests/bootstrap

assets/javascripts/wizard-qunit.js

@@ -0,0 +1,19 @@
+import { buildResolver } from "discourse-common/resolver";
+import Application from "@ember/application";
+import WizardInitializer from "./lib/initialize/wizard";
+import { isTesting } from "discourse-common/config/environment";
+
+export default Application.extend({
+  rootElement: "#custom-wizard-main",
+  Resolver: buildResolver("discourse/plugins/discourse-custom-wizard/wizard"),
+
+  customEvents: {
+    paste: "paste",
+  },
+
+  start() {
+    if (!isTesting()) {
+      this.initializer(WizardInitializer);
+    }
+  },
+});

assets/javascripts/wizard/application.js.es6

@@ -1,6 +1,6 @@
 import {
   default as computed,
-  observes,
+  observes
 } from "discourse-common/utils/decorators";
 import { renderAvatar } from "discourse/helpers/user-avatar";
 import userSearch from "../lib/user-search";
@@ -55,7 +55,6 @@ export default Ember.TextField.extend({
     let self = this,
       selected = [],
       groups = [],
-      currentUser = this.currentUser,
       includeMentionableGroups =
         this.get("includeMentionableGroups") === "true",
       includeMessageableGroups =
@@ -66,13 +65,8 @@ export default Ember.TextField.extend({
     function excludedUsernames() {
       // hack works around some issues with allowAny eventing
       const usernames = self.get("single") ? [] : selected;
-
-      if (currentUser && self.get("excludeCurrentUser")) {
-        return usernames.concat([currentUser.get("username")]);
-      }
       return usernames;
     }
-
     $(this.element)
       .val(this.get("usernames"))
       .autocomplete({
@@ -84,7 +78,6 @@ export default Ember.TextField.extend({
 
         dataSource(term) {
           const termRegex = /[^a-zA-Z0-9_\-\.@\+]/;
-
           let results = userSearch({
             term: term.replace(termRegex, ""),
             topicId: self.get("topicId"),

assets/javascripts/wizard/components/custom-user-selector.js.es6

@@ -1,5 +1,8 @@
 import Component from "@ember/component";
+
 export default Component.extend({
+  layoutName: 'wizard/templates/components/field-validators',
+
   actions: {
     perform() {
       this.appEvents.trigger("custom-wizard:validate");