openproject/spec/lib/api/v3/queries/query_representer_generation_spec.rb

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2021 the OpenProject GmbH
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#
# See COPYRIGHT and LICENSE files for more details.
#++

require 'spec_helper'

describe ::API::V3::Queries::QueryRepresenter do
  include ::API::V3::Utilities::PathHelper

  let(:query) { FactoryBot.build_stubbed(:query, project: project) }
  let(:unpersisted_query) { FactoryBot.build(:query, project: project, user: other_user) }
  let(:project) { FactoryBot.build_stubbed(:project) }
  let(:user) { double('current_user', allowed_to_globally?: true, allowed_to?: true, admin: true, admin?: true, active?: true) }
  let(:other_user) { FactoryBot.build_stubbed(:user) }
  let(:embed_links) { true }
  let(:representer) do
    described_class.new(query, current_user: user, embed_links: embed_links)
  end

  let(:permissions) { [] }

  let(:policy) do
    policy_stub = double('policy stub')

    allow(QueryPolicy)
      .to receive(:new)
      .with(user)
      .and_return(policy_stub)

    allow(policy_stub)
      .to receive(:allowed?)
      .and_return(false)

    permissions.each do |permission|
      allow(policy_stub)
        .to receive(:allowed?)
        .with(query, permission)
        .and_return(true)
    end
  end

  before do
    policy
  end

  def non_empty_to_query(hash)
    hash.map do |key, value|
      if value.is_a?(Array) && value.empty?
        "#{key}=%5B%5D"
      else
        value.to_query(key)
      end
    end.compact.sort! * '&'
  end

  subject { representer.to_json }

  describe 'generation' do
    describe '_links' do
      context 'self' do
        it_behaves_like 'has a titled link' do
          let(:link) { 'self' }
          let(:href) { api_v3_paths.query(query.id) }
          let(:title) { query.name }
        end

        context 'with params' do
          let(:representer) do
            described_class.new(query, current_user: user, embed_links: embed_links,
                                       params: { "filters" => "something", "id" => "234" })
          end

          it_behaves_like 'has a titled link' do
            let(:link) { 'self' }
            let(:href) { "#{api_v3_paths.query(query.id)}?filters=something" }
            let(:title) { query.name }
          end
        end
      end

      it_behaves_like 'has a titled link' do
        let(:link) { 'user' }
        let(:href) { api_v3_paths.user query.user_id }
        let(:title) { query.user.name }
      end

      it_behaves_like 'has a titled link' do
        let(:link) { 'project' }
        let(:href) { api_v3_paths.project query.project_id }
        let(:title) { query.project.name }
      end

      it_behaves_like 'has an untitled link' do
        let(:link) { 'results' }
        let(:href) do
          params = {
            offset: 1,
            showSums: false,
            showHierarchies: false,
            pageSize: Setting.per_page_options_array.first,
            filters: []
          }
          "#{api_v3_paths.work_packages_by_project(project.id)}?#{non_empty_to_query(params)}"
        end
      end

      it_behaves_like 'has an untitled link' do
        let(:link) { 'schema' }
        let(:href) { api_v3_paths.query_project_schema(project.identifier) }
      end

      context 'has no project' do
        let(:query) { FactoryBot.build_stubbed(:query, project: nil) }

        it_behaves_like 'has an empty link' do
          let(:link) { 'project' }
        end

        it_behaves_like 'has an untitled link' do
          let(:link) { 'schema' }
          let(:href) { api_v3_paths.query_schema }
        end

        it_behaves_like 'has an untitled link' do
          let(:link) { 'results' }
          let(:href) do
            params = {
              offset: 1,
              pageSize: Setting.per_page_options_array.first,
              showSums: false,
              showHierarchies: false,
              filters: []
            }
            "#{api_v3_paths.work_packages}?#{non_empty_to_query(params)}"
          end
        end
      end

      describe 'update action link' do
        it_behaves_like 'has an untitled link' do
          let(:link) { 'update' }
          let(:href) { api_v3_paths.query_form(query.id) }
        end

        context 'without a project' do
          let(:query) { FactoryBot.build_stubbed(:query, project: nil) }

          it_behaves_like 'has an untitled link' do
            let(:link) { 'schema' }
            let(:href) { api_v3_paths.query_schema }
          end
        end

        context 'when unpersisted' do
          let(:query) { unpersisted_query }

          it_behaves_like 'has an untitled link' do
            let(:link) { 'update' }
            let(:href) { api_v3_paths.create_query_form }
          end
        end

        context 'when unpersisted outside a project' do
          let(:project) { nil }
          let(:query) { unpersisted_query }

          it_behaves_like 'has an untitled link' do
            let(:link) { 'update' }
            let(:href) { api_v3_paths.create_query_form }
          end
        end
      end

      describe 'delete action link' do
        let(:permissions) { [:destroy] }

        it_behaves_like 'has an untitled link' do
          let(:link) { 'delete' }
          let(:href) { api_v3_paths.query query.id }
        end

        context 'when not persisted' do
          let(:query) { unpersisted_query }

          it_behaves_like 'has no link' do
            let(:link) { 'delete' }
          end
        end

        context 'when not allowed to delete' do
          let(:permissions) { [] }

          it_behaves_like 'has no link' do
            let(:link) { 'delete' }
          end
        end

        context 'when no user is provided' do
          let(:user) { nil }
          let(:embed_links) { false }

          it_behaves_like 'has no link' do
            let(:link) { 'delete' }
          end
        end
      end

      describe 'updateImmediately action link' do
        let(:permissions) { [:update] }

        it_behaves_like 'has an untitled link' do
          let(:link) { 'updateImmediately' }
          let(:href) { api_v3_paths.query query.id }
        end

        context 'when not persisted and lacking permission' do
          let(:query) { unpersisted_query }

          it_behaves_like 'has no link' do
            let(:link) { 'updateImmediately' }
          end
        end

        context 'when not persisted and having permission' do
          let(:permissions) { [:create] }

          let(:query) { unpersisted_query }

          it_behaves_like 'has an untitled link' do
            let(:link) { 'updateImmediately' }
            let(:href) { api_v3_paths.query query.id }
          end
        end

        context 'when not allowed to update' do
          let(:permissions) { [] }

          it_behaves_like 'has no link' do
            let(:link) { 'updateImmediately' }
          end
        end

        context 'when no user is provided' do
          let(:user) { nil }
          let(:embed_links) { false }

          it_behaves_like 'has no link' do
            let(:link) { 'updateImmediately' }
          end
        end
      end

      describe 'updateOrderedWorkPackages action link' do
        let(:permissions) { %i[update reorder_work_packages] }

        it_behaves_like 'has an untitled link' do
          let(:link) { 'updateOrderedWorkPackages' }
          let(:href) { api_v3_paths.query_order query.id }
        end

        context 'when not persisted and lacking permission' do
          let(:query) { unpersisted_query }

          it_behaves_like 'has no link' do
            let(:link) { 'updateOrderedWorkPackages' }
          end
        end

        context 'when not persisted and having permission' do
          let(:permissions) { [:create] }

          let(:query) { unpersisted_query }

          it_behaves_like 'has an untitled link' do
            let(:link) { 'updateOrderedWorkPackages' }
            let(:href) { api_v3_paths.query_order query.id }
          end
        end

        context 'when not allowed to update' do
          let(:permissions) { [] }

          it_behaves_like 'has no link' do
            let(:link) { 'updateOrderedWorkPackages' }
          end
        end

        context 'when no user is provided' do
          let(:user) { nil }
          let(:embed_links) { false }

          it_behaves_like 'has no link' do
            let(:link) { 'updateOrderedWorkPackages' }
          end
        end
      end

      context 'with filter, sort, group by and pageSize' do
        let(:representer) do
          described_class.new(query,
                              current_user: user)
        end

        let(:query) do
          query = FactoryBot.build_stubbed(:query, project: project)
          query.add_filter('subject', '~', ['bogus'])
          query.group_by = 'author'
          query.sort_criteria = [['assigned_to', 'asc'], ['type', 'desc']]

          query
        end

        let(:expected_href) do
          params = {
            offset: 1,
            pageSize: Setting.per_page_options_array.first,
            filters: JSON::dump([{ subject: { operator: '~', values: ['bogus'] } }]),
            showSums: false,
            showHierarchies: false,
            groupBy: 'author',
            sortBy: JSON::dump([['assignee', 'asc'], ['type', 'desc']])
          }

          api_v3_paths.work_packages_by_project(project.id) + "?#{params.to_query}"
        end

        it_behaves_like 'has an untitled link' do
          let(:link) { 'results' }
          let(:href) { expected_href }
        end
      end

      context 'with offset and page size' do
        let(:representer) do
          described_class.new(query,
                              current_user: user,
                              params: { offset: 2, pageSize: 25 })
        end

        let(:expected_href) do
          params = {
            offset: 2,
            pageSize: 25,
            showSums: false,
            showHierarchies: false,
            filters: []
          }

          api_v3_paths.work_packages_by_project(project.id) + "?#{non_empty_to_query(params)}"
        end

        it_behaves_like 'has an untitled link' do
          let(:link) { 'results' }
          let(:href) { expected_href }
        end
      end

      context 'without columns' do
        let(:query) do
          query = FactoryBot.build_stubbed(:query, project: project)

          # need to write bogus here because the query
          # will otherwise sport the default columns
          query.column_names = ['blubs']

          query
        end

        it 'has an empty columns array' do
          is_expected
            .to be_json_eql([].to_json)
            .at_path('_links/columns')
        end
      end

      context 'with columns' do
        let(:query) do
          query = FactoryBot.build_stubbed(:query, project: project)

          query.column_names = ['status', 'assigned_to', 'updated_at']

          query
        end

        it 'has an array of columns' do
          status = {
            href: '/api/v3/queries/columns/status',
            title: 'Status'
          }
          assignee = {
            href: '/api/v3/queries/columns/assignee',
            title: 'Assignee'
          }
          subproject = {
            href: '/api/v3/queries/columns/updatedAt',
            title: 'Updated on'
          }

          expected = [status, assignee, subproject]

          is_expected
            .to be_json_eql(expected.to_json)
            .at_path('_links/columns')
        end
      end

      context 'without group_by' do
        it_behaves_like 'has a titled link' do
          let(:href) { nil }
          let(:link) { 'groupBy' }
          let(:title) { nil }
        end
      end

      context 'with group_by' do
        let(:query) do
          query = FactoryBot.build_stubbed(:query, project: project)

          query.group_by = 'status'

          query
        end

        it_behaves_like 'has a titled link' do
          let(:href) { '/api/v3/queries/group_bys/status' }
          let(:link) { 'groupBy' }
          let(:title) { 'Status' }
        end
      end

      context 'without sort_by' do
        it 'has an empty sortBy array' do
          is_expected
            .to be_json_eql([].to_json)
            .at_path('_links/sortBy')
        end
      end

      context 'with sort_by' do
        let(:query) do
          FactoryBot.build_stubbed(:query,
                                   sort_criteria: [['subject', 'asc'], ['assigned_to', 'desc']])
        end

        it 'has an array of sortBy' do
          expected = [
            {
              href: api_v3_paths.query_sort_by('subject', 'asc'),
              title: 'Subject (Ascending)'
            },
            {
              href: api_v3_paths.query_sort_by('assignee', 'desc'),
              title: 'Assignee (Descending)'
            }
          ]

          is_expected
            .to be_json_eql(expected.to_json)
            .at_path('_links/sortBy')
        end
      end

      context 'when not starred' do
        let(:permissions) { %i(star unstar) }
        before do
          allow(query)
            .to receive(:starred)
            .and_return(false)
        end

        it_behaves_like 'has an untitled link' do
          let(:link) { 'star' }
          let(:href) { api_v3_paths.query_star query.id }
        end

        it 'has no unstar link' do
          is_expected
            .to_not have_json_path('_links/unstar')
        end

        context 'lacking permission' do
          let(:permissions) { [] }

          it 'has no star link' do
            is_expected
              .to_not have_json_path('_links/star')
          end
        end
      end

      context 'when starred' do
        let(:permissions) { %i(star unstar) }
        before do
          allow(query)
            .to receive(:starred)
            .and_return(true)
        end

        it_behaves_like 'has an untitled link' do
          let(:link) { 'unstar' }
          let(:href) { api_v3_paths.query_unstar query.id }
        end

        it 'has no star link' do
          is_expected
            .to_not have_json_path('_links/star')
        end

        context 'lacking permission' do
          let(:permissions) { [] }

          it 'has no unstar link' do
            is_expected
              .to_not have_json_path('_links/unstar')
          end
        end
      end
    end

    context 'properties' do
      it 'should show an id' do
        is_expected.to be_json_eql(query.id).at_path('id')
      end

      it 'should show the query name' do
        is_expected.to be_json_eql(query.name.to_json).at_path('name')
      end

      it 'should indicate whether sums are shown' do
        is_expected.to be_json_eql(query.display_sums.to_json).at_path('sums')
      end

      it 'should indicate whether timeline is shown' do
        is_expected.to be_json_eql(query.timeline_visible.to_json).at_path('timelineVisible')
      end

      it 'should show the current zoom level' do
        is_expected.to be_json_eql(query.timeline_zoom_level.to_json).at_path('timelineZoomLevel')
      end

      it 'should show the default timelineLabels' do
        is_expected.to be_json_eql(query.timeline_labels.to_json).at_path('timelineLabels')
      end

      it 'should indicate whether the query is publicly visible' do
        is_expected.to be_json_eql(query.is_public.to_json).at_path('public')
      end

      describe 'hidden' do
        it 'renders when the value is not set' do
          is_expected.to be_json_eql(false.to_json).at_path('hidden')
        end

        it 'renders when the value is set' do
          query.hidden = true
          is_expected.to be_json_eql(true.to_json).at_path('hidden')
        end
      end

      it_behaves_like 'has UTC ISO 8601 date and time' do
        let(:date) { query.created_at }
        let(:json_path) { 'createdAt' }
      end

      it_behaves_like 'has UTC ISO 8601 date and time' do
        let(:date) { query.updated_at }
        let(:json_path) { 'updatedAt' }
      end

      describe 'highlighting' do
        context 'with EE', with_ee: %i[conditional_highlighting] do
          it 'renders when the value is set' do
            query.highlighting_mode = 'status'

            is_expected.to be_json_eql('status'.to_json).at_path('highlightingMode')
          end

          it 'renders the default' do
            query.highlighting_mode = nil
            query.highlighted_attributes = nil
            is_expected.to be_json_eql('inline'.to_json).at_path('highlightingMode')
            is_expected.to_not have_json_path('highlightedAttributes')
          end

          context "inline attribute highlighting" do
            let :status do
              {
                href: '/api/v3/queries/columns/status',
                title: 'Status'
              }
            end

            let :type do
              {
                href: '/api/v3/queries/columns/type',
                title: 'Type'
              }
            end

            let :priority do
              {
                href: '/api/v3/queries/columns/priority',
                title: 'Priority'
              }
            end

            let :due_date do
              {
                href: '/api/v3/queries/columns/dueDate',
                title: 'Finish date'
              }
            end

            let(:query) do
              query = FactoryBot.build_stubbed(:query, project: project)

              query.highlighted_attributes = ['status', 'type', 'priority', 'due_date']

              query
            end

            let(:highlighted_attributes) do
              [status, priority, due_date]
            end

            it 'links an array of highlighted attributes' do
              is_expected
                .to be_json_eql(highlighted_attributes.to_json).at_path('_links/highlightedAttributes')
            end

            it 'embeds selected inline attributes' do
              query.highlighted_attributes[0..0].each_with_index do |attr, index|
                is_expected
                  .to be_json_eql("/api/v3/queries/columns/#{attr}".to_json)
                  .at_path("_embedded/highlightedAttributes/#{index}/_links/self/href")
              end
            end
          end
        end

        context 'without EE' do
          it 'renders when the value is set' do
            query.highlighting_mode = 'status'

            is_expected.to be_json_eql('none'.to_json).at_path('highlightingMode')
          end

          it 'renders none when not set' do
            query.highlighting_mode = nil

            is_expected.to be_json_eql('none'.to_json).at_path('highlightingMode')
          end
        end
      end

      context 'showHierarchies' do
        it 'is true if query.show_hierarchies is true' do
          query.show_hierarchies = true

          is_expected.to be_json_eql(true.to_json).at_path('showHierarchies')
        end

        it 'is false if query.show_hierarchies is false' do
          query.show_hierarchies = false

          is_expected.to be_json_eql(false.to_json).at_path('showHierarchies')
        end
      end

      describe 'with filters' do
        let(:query) do
          query = FactoryBot.build_stubbed(:query)
          query.add_filter('status_id', '=', [filter_status.id.to_s])
          allow(query.filters.last)
            .to receive(:value_objects)
            .and_return([filter_status])
          query.add_filter('assigned_to_id', '!', [filter_user.id.to_s])
          allow(query.filters.last)
            .to receive(:value_objects)
            .and_return([filter_user])
          query
        end

        let(:filter_status) { FactoryBot.build_stubbed(:status) }
        let(:filter_user) { FactoryBot.build_stubbed(:user) }

        it 'should render the filters' do
          expected_status = {
            "_type": "StatusQueryFilter",
            "name": "Status",
            "_links": {
              "filter": {
                "href": "/api/v3/queries/filters/status",
                "title": "Status"
              },
              "operator": {
                "href": api_v3_paths.query_operator(CGI.escape('=')),
                "title": "is"
              },
              "values": [
                {
                  "href": api_v3_paths.status(filter_status.id),
                  "title": filter_status.name
                }
              ],
              "schema": {
                "href": api_v3_paths.query_filter_instance_schema('status')
              }
            }
          }
          expected_assignee = {
            "_type": "AssigneeQueryFilter",
            "name": "Assignee",
            "_links": {
              "filter": {
                "href": "/api/v3/queries/filters/assignee",
                "title": "Assignee"
              },
              "operator": {
                "href": api_v3_paths.query_operator(CGI.escape('!')),
                "title": "is not"
              },
              "values": [
                {
                  "href": api_v3_paths.user(filter_user.id),
                  "title": filter_user.name
                }
              ],
              "schema": {
                "href": api_v3_paths.query_filter_instance_schema('assignee')
              }
            }
          }

          expected = [expected_status, expected_assignee]

          is_expected.to be_json_eql(expected.to_json).at_path('filters')
        end
      end

      describe 'with sort criteria' do
        let(:query) do
          FactoryBot.build_stubbed(:query,
                                   sort_criteria: [['subject', 'asc'], ['assigned_to', 'desc']])
        end

        it 'has the sort criteria embedded' do
          is_expected
            .to be_json_eql('/api/v3/queries/sort_bys/subject-asc'.to_json)
            .at_path('_embedded/sortBy/0/_links/self/href')

          is_expected
            .to be_json_eql('/api/v3/queries/sort_bys/assignee-desc'.to_json)
            .at_path('_embedded/sortBy/1/_links/self/href')
        end
      end

      describe 'with columns' do
        let(:query) do
          query = FactoryBot.build_stubbed(:query, project: project)

          query.column_names = ['status', 'assigned_to', 'updated_at']

          query
        end

        it 'has the columns embedded' do
          is_expected
            .to be_json_eql('/api/v3/queries/columns/status'.to_json)
            .at_path('_embedded/columns/0/_links/self/href')
        end

        context 'when not embedding' do
          let(:representer) do
            described_class.new(query, current_user: user, embed_links: false)
          end

          it 'has no columns embedded' do
            is_expected
              .not_to have_json_path('_embedded/columns')
          end
        end
      end

      describe 'with group by' do
        let(:query) do
          query = FactoryBot.build_stubbed(:query, project: project)

          query.group_by = 'status'

          query
        end

        it 'has the group by embedded' do
          is_expected
            .to be_json_eql('/api/v3/queries/group_bys/status'.to_json)
            .at_path('_embedded/groupBy/_links/self/href')
        end

        context 'when not embedding' do
          let(:representer) do
            described_class.new(query, current_user: user, embed_links: false)
          end

          it 'has no group bys embedded' do
            is_expected
              .not_to have_json_path('_embedded/groupBy')
          end
        end
      end

      describe 'when timeline is visible' do
        let(:query) do
          FactoryBot.build_stubbed(:query, project: project).tap do |query|
            query.timeline_visible = true
          end
        end
        it do
          is_expected.to be_json_eql('true').at_path('timelineVisible')
        end
      end

      describe 'when labels are overridden' do
        let(:query) do
          FactoryBot.build_stubbed(:query, project: project).tap do |query|
            query.timeline_labels = expected
          end
        end
        let(:expected) do
          { 'left' => 'assignee', 'right' => 'status', 'farRight' => 'type' }
        end

        it do
          is_expected.to be_json_eql(expected.to_json).at_path('timelineLabels')
        end
      end

      describe 'when timeline zoom level is changed' do
        let(:query) do
          FactoryBot.build_stubbed(:query, project: project).tap do |query|
            query.timeline_zoom_level = :weeks
          end
        end
        it do
          is_expected.to be_json_eql('weeks'.to_json).at_path('timelineZoomLevel')
        end
      end
    end

    describe 'embedded results' do
      let(:query) { FactoryBot.build_stubbed(:query) }
      let(:representer) do
        described_class.new(query,
                            current_user: user,
                            results: results_representer)
      end

      context 'results are provided' do
        let(:results_representer) do
          {
            _type: 'BogusResultType'
          }
        end

        it 'should embed the results' do
          is_expected
            .to be_json_eql('BogusResultType'.to_json)
            .at_path('_embedded/results/_type')
        end
      end

      context 'no results provided' do
        let(:results_representer) { nil }

        it 'should not embed the results' do
          is_expected
            .not_to have_json_path('_embedded/results')
        end
      end
    end
  end
end