discourse-custom-wizard/spec/requests/custom_wizard/steps_controller_spec.rb

# frozen_string_literal: true

describe CustomWizard::StepsController do
  fab!(:user) { Fabricate(:user, username: 'angus', email: "angus@email.com", trust_level: TrustLevel[3]) }
  fab!(:user2) { Fabricate(:user, username: 'bob', email: "bob@email.com", trust_level: TrustLevel[2]) }
  let(:wizard_template) { get_wizard_fixture("wizard") }
  let(:wizard_field_condition_template) { get_wizard_fixture("condition/wizard_field_condition") }
  let(:user_condition_template) { get_wizard_fixture("condition/user_condition") }
  let(:permitted_json) { get_wizard_fixture("wizard/permitted") }
  let(:admin_permitted_json) { get_wizard_fixture("wizard/admin_permitted") }
  let(:route_to_template) { get_wizard_fixture("actions/route_to") }
  let(:guests_permitted) { get_wizard_fixture("wizard/guests_permitted") }

  before do
    CustomWizard::Template.save(wizard_template, skip_jobs: true)
  end

  def guest_template
    temp = wizard_template.dup
    temp["permitted"] = guests_permitted["permitted"]
    temp.delete("actions")
    temp["actions"] = [route_to_template]
    temp
  end

  context "with guest" do
    it "does not perform a step update" do
      put '/w/super-mega-fun-wizard/steps/step_1.json', params: {
        fields: {
          step_1_field_1: "Text input"
        }
      }
      expect(response.status).to eq(403)
    end

    context "with guests permitted" do
      before do
        enable_subscription("standard")
        result = CustomWizard::Template.save(guest_template, skip_jobs: true)
      end

      it "performs a step update" do
        put '/w/super-mega-fun-wizard/steps/step_1.json', params: {
          fields: {
            step_1_field_1: "Text input"
          }
        }
        expect(response.status).to eq(200)
        expect(response.parsed_body['wizard']['start']).to eq("step_2")

        wizard_id = response.parsed_body['wizard']['id']
        wizard = CustomWizard::Wizard.create(wizard_id, nil, cookies[:custom_wizard_guest_id])
        expect(wizard.current_submission.fields['step_1_field_1']).to eq("Text input")
      end

      context "raises an error" do
        it "when the wizard doesnt exist" do
          put '/w/not-super-mega-fun-wizard/steps/step_1.json'
          expect(response.status).to eq(400)
        end

        it "when the user cant access the wizard" do
          enable_subscription("standard")
          new_template = guest_template.dup
          new_template["permitted"] = permitted_json["permitted"]
          CustomWizard::Template.save(new_template, skip_jobs: true)

          put '/w/super-mega-fun-wizard/steps/step_1.json'
          expect(response.status).to eq(403)
        end

        it "when the step doesnt exist" do
          put '/w/super-mega-fun-wizard/steps/step_10.json'
          expect(response.status).to eq(400)
        end
      end

      it "works if the step has no fields" do
        put '/w/super-mega-fun-wizard/steps/step_1.json'
        expect(response.status).to eq(200)
        expect(response.parsed_body['wizard']['start']).to eq("step_2")
      end

      it "returns an updated wizard when condition passes" do
        new_template = guest_template.dup
        new_template['steps'][1]['condition'] = wizard_field_condition_template['condition']
        CustomWizard::Template.save(new_template, skip_jobs: true)

        put '/w/super-mega-fun-wizard/steps/step_1.json', params: {
          fields: {
            step_1_field_1: "Condition will pass"
          }
        }
        expect(response.status).to eq(200)
        expect(response.parsed_body['wizard']['start']).to eq("step_2")
      end

      it "runs completion actions if guest has completed wizard" do
        new_template = guest_template.dup

        ## route_to action
        new_template['actions'].last['run_after'] = 'wizard_completion'
        CustomWizard::Template.save(new_template, skip_jobs: true)

        put '/w/super-mega-fun-wizard/steps/step_1.json'
        put '/w/super-mega-fun-wizard/steps/step_2.json'
        put '/w/super-mega-fun-wizard/steps/step_3.json'
        expect(response.status).to eq(200)
        expect(response.parsed_body['redirect_on_complete']).to eq("https://google.com")
      end
    end
  end

  context "with user" do
    before do
      sign_in(user)
    end

    it 'performs a step update' do
      put '/w/super-mega-fun-wizard/steps/step_1.json', params: {
        fields: {
          step_1_field_1: "Text input"
        }
      }
      expect(response.status).to eq(200)
      expect(response.parsed_body['wizard']['start']).to eq("step_2")

      wizard_id = response.parsed_body['wizard']['id']
      wizard = CustomWizard::Wizard.create(wizard_id, user)
      expect(wizard.current_submission.fields['step_1_field_1']).to eq("Text input")
    end

    context "raises an error" do
      it "when the wizard doesnt exist" do
        put '/w/not-super-mega-fun-wizard/steps/step_1.json'
        expect(response.status).to eq(400)
      end

      it "when the user cant access the wizard" do
        enable_subscription("standard")
        new_template = wizard_template.dup
        new_template["permitted"] = admin_permitted_json["permitted"]
        CustomWizard::Template.save(new_template, skip_jobs: true)

        put '/w/super-mega-fun-wizard/steps/step_1.json'
        expect(response.status).to eq(403)
      end

      it "when the step doesnt exist" do
        put '/w/super-mega-fun-wizard/steps/step_10.json'
        expect(response.status).to eq(400)
      end
    end

    it "works if the step has no fields" do
      put '/w/super-mega-fun-wizard/steps/step_1.json'
      expect(response.status).to eq(200)
      expect(response.parsed_body['wizard']['start']).to eq("step_2")
    end

    it "returns an updated wizard when condition passes" do
      new_template = wizard_template.dup
      new_template['steps'][1]['condition'] = wizard_field_condition_template['condition']
      CustomWizard::Template.save(new_template, skip_jobs: true)

      put '/w/super-mega-fun-wizard/steps/step_1.json', params: {
        fields: {
          step_1_field_1: "Condition will pass"
        }
      }
      expect(response.status).to eq(200)
      expect(response.parsed_body['wizard']['start']).to eq("step_2")
    end

    it "runs completion actions if user has completed wizard" do
      new_template = wizard_template.dup

      ## route_to action
      new_template['actions'].last['run_after'] = 'wizard_completion'
      CustomWizard::Template.save(new_template, skip_jobs: true)

      put '/w/super-mega-fun-wizard/steps/step_1.json'
      put '/w/super-mega-fun-wizard/steps/step_2.json'
      put '/w/super-mega-fun-wizard/steps/step_3.json'
      expect(response.status).to eq(200)
      expect(response.parsed_body['redirect_on_complete']).to eq("https://google.com")
    end

    it "saves results of completion actions if user has completed wizard" do
      new_template = wizard_template.dup
      new_template['actions'].first['run_after'] = 'wizard_completion'
      CustomWizard::Template.save(new_template, skip_jobs: true)

      put '/w/super-mega-fun-wizard/steps/step_1.json', params: {
        fields: {
          step_1_field_1: "Topic title",
          step_1_field_2: "Topic post"
        }
      }
      put '/w/super-mega-fun-wizard/steps/step_2.json'
      put '/w/super-mega-fun-wizard/steps/step_3.json'

      wizard_id = response.parsed_body['wizard']['id']
      wizard = CustomWizard::Wizard.create(wizard_id, user)

      topic_id = wizard.submissions.first.fields[new_template['actions'].first['id']]
      topic = Topic.find(topic_id)
      expect(topic.present?).to eq(true)
    end

    it "returns a final step without conditions" do
      put '/w/super-mega-fun-wizard/steps/step_1.json'
      expect(response.status).to eq(200)
      expect(response.parsed_body['final']).to eq(false)

      put '/w/super-mega-fun-wizard/steps/step_2.json'
      expect(response.status).to eq(200)
      expect(response.parsed_body['final']).to eq(false)

      put '/w/super-mega-fun-wizard/steps/step_3.json'
      expect(response.status).to eq(200)
      expect(response.parsed_body['final']).to eq(true)
    end

    context "subscription" do
      before do
        enable_subscription("standard")
      end

      it "raises an error when user cant see the step due to conditions" do
        sign_in(user2)

        new_wizard_template = wizard_template.dup
        new_wizard_template['steps'][0]['condition'] = user_condition_template['condition']
        CustomWizard::Template.save(new_wizard_template, skip_jobs: true)

        put '/w/super-mega-fun-wizard/steps/step_1.json'
        expect(response.status).to eq(403)
      end

      it "returns an updated wizard when condition doesnt pass" do
        new_template = wizard_template.dup
        new_template['steps'][1]['condition'] = wizard_field_condition_template['condition']
        CustomWizard::Template.save(new_template, skip_jobs: true)

        put '/w/super-mega-fun-wizard/steps/step_1.json', params: {
          fields: {
            step_1_field_1: "Condition wont pass"
          }
        }
        expect(response.status).to eq(200)
        expect(response.parsed_body['wizard']['start']).to eq("step_3")
      end

      it "returns the correct final step when the conditional final step and last step are the same" do
        new_template = wizard_template.dup
        new_template['steps'][0]['condition'] = user_condition_template['condition']
        new_template['steps'][2]['condition'] = wizard_field_condition_template['condition']
        CustomWizard::Template.save(new_template, skip_jobs: true)
      end

      it "raises an error when user cant see the step due to conditions" do
        sign_in(user2)

        new_wizard_template = wizard_template.dup
        new_wizard_template['steps'][0]['condition'] = user_condition_template['condition']
        CustomWizard::Template.save(new_wizard_template, skip_jobs: true)

        put '/w/super-mega-fun-wizard/steps/step_1.json'
        expect(response.status).to eq(403)
      end

      it "returns an updated wizard when condition doesnt pass" do
        new_template = wizard_template.dup
        new_template['steps'][1]['condition'] = wizard_field_condition_template['condition']
        CustomWizard::Template.save(new_template, skip_jobs: true)

        put '/w/super-mega-fun-wizard/steps/step_1.json', params: {
          fields: {
            step_1_field_1: "Condition wont pass"
          }
        }
        expect(response.status).to eq(200)
        expect(response.parsed_body['wizard']['start']).to eq("step_3")
      end

      it "returns the correct final step when the conditional final step and last step are the same" do
        new_template = wizard_template.dup
        new_template['steps'][0]['condition'] = user_condition_template['condition']
        new_template['steps'][2]['condition'] = wizard_field_condition_template['condition']
        CustomWizard::Template.save(new_template, skip_jobs: true)

        put '/w/super-mega-fun-wizard/steps/step_1.json', params: {
          fields: {
            step_1_field_1: "Condition will pass"
          }
        }
        expect(response.status).to eq(200)
        expect(response.parsed_body['final']).to eq(false)

        put '/w/super-mega-fun-wizard/steps/step_2.json'
        expect(response.status).to eq(200)
        expect(response.parsed_body['final']).to eq(false)

        put '/w/super-mega-fun-wizard/steps/step_3.json'
        expect(response.status).to eq(200)
        expect(response.parsed_body['final']).to eq(true)
      end

      it "returns the correct final step when the conditional final step and last step are different" do
        new_template = wizard_template.dup
        new_template['steps'][2]['condition'] = wizard_field_condition_template['condition']
        CustomWizard::Template.save(new_template, skip_jobs: true)

        put '/w/super-mega-fun-wizard/steps/step_1.json', params: {
          fields: {
            step_1_field_1: "Condition will not pass"
          }
        }
        expect(response.status).to eq(200)
        expect(response.parsed_body['final']).to eq(false)

        put '/w/super-mega-fun-wizard/steps/step_2.json'
        expect(response.status).to eq(200)
        expect(response.parsed_body['final']).to eq(true)
      end

      it "returns the correct final step when the conditional final step is determined in the same action" do
        new_template = wizard_template.dup
        new_template['steps'][1]['condition'] = wizard_field_condition_template['condition']
        new_template['steps'][2]['condition'] = wizard_field_condition_template['condition']
        CustomWizard::Template.save(new_template, skip_jobs: true)

        put '/w/super-mega-fun-wizard/steps/step_1.json', params: {
          fields: {
            step_1_field_1: "Condition will not pass"
          }
        }
        expect(response.status).to eq(200)
        expect(response.parsed_body['final']).to eq(true)
      end

      it "excludes the non-included conditional fields from the submissions" do
        new_template = wizard_template.dup
        new_template['steps'][1]['fields'][0]['condition'] = wizard_field_condition_template['condition']
        CustomWizard::Template.save(new_template, skip_jobs: true)

        put '/w/super-mega-fun-wizard/steps/step_1.json', params: {
          fields: {
            step_1_field_1: "Condition will pass"
          }
        }

        put '/w/super-mega-fun-wizard/steps/step_2.json', params: {
          fields: {
            step_2_field_1: "1995-04-23"
          }
        }

        put '/w/super-mega-fun-wizard/steps/step_1.json', params: {
          fields: {
            step_1_field_1: "Condition will not pass"
          }
        }

        wizard_id = response.parsed_body['wizard']['id']
        wizard = CustomWizard::Wizard.create(wizard_id, user)
        submission = wizard.current_submission
        expect(submission.fields.keys).not_to include("step_2_field_1")
      end
    end
  end
end