diff --git a/app/controllers/v3/domains_controller.rb b/app/controllers/v3/domains_controller.rb index aa86234ff82..a6726b3551c 100644 --- a/app/controllers/v3/domains_controller.rb +++ b/app/controllers/v3/domains_controller.rb @@ -18,7 +18,11 @@ def index message = DomainsListMessage.from_params(query_params) invalid_param!(message.errors.full_messages) unless message.valid? - dataset = DomainFetcher.fetch(message, permission_queryer.readable_org_ids_for_domains_query) + dataset = DomainFetcher.fetch( + message, + permission_queryer.readable_org_ids_for_domains_query, + eager_loaded_associations: Presenters::V3::DomainPresenter.associated_resources + ) render status: :ok, json: Presenters::V3::PaginatedListPresenter.new( presenter: Presenters::V3::DomainPresenter, @@ -249,7 +253,7 @@ def presenter_args if permission_queryer.can_read_globally? { all_orgs_visible: true } else - { visible_org_ids_query: permission_queryer.readable_org_ids_query } + { visible_org_guids: permission_queryer.readable_org_guids } end end end diff --git a/app/controllers/v3/organizations_controller.rb b/app/controllers/v3/organizations_controller.rb index 162ea64ab6e..d69609e044d 100644 --- a/app/controllers/v3/organizations_controller.rb +++ b/app/controllers/v3/organizations_controller.rb @@ -150,7 +150,7 @@ def index_org_domains invalid_param!(message.errors.full_messages) unless message.valid? readable_org_ids = Organization.where(id: org.id).where(id: permission_queryer.readable_org_ids_for_domains_query).select(:id) - domains = DomainFetcher.fetch(message, readable_org_ids) + domains = DomainFetcher.fetch(message, readable_org_ids, eager_loaded_associations: Presenters::V3::DomainPresenter.associated_resources) render status: :ok, json: Presenters::V3::PaginatedListPresenter.new( presenter: Presenters::V3::DomainPresenter, @@ -273,7 +273,7 @@ def presenter_args if permission_queryer.can_read_globally? { all_orgs_visible: true } else - { visible_org_ids_query: permission_queryer.readable_org_ids_query } + { visible_org_guids: permission_queryer.readable_org_guids } end end end diff --git a/app/fetchers/domain_fetcher.rb b/app/fetchers/domain_fetcher.rb index faac79f9443..031b2ee03e6 100644 --- a/app/fetchers/domain_fetcher.rb +++ b/app/fetchers/domain_fetcher.rb @@ -3,7 +3,7 @@ module VCAP::CloudController class DomainFetcher < BaseListFetcher class << self - def fetch_all_for_orgs(readable_org_ids) + def fetch_all_for_orgs(readable_org_ids, eager_loaded_associations: []) shared_domain_ids = Domain.where(owning_organization_id: nil).select(:id) owned_domain_ids = Domain.where(owning_organization_id: readable_org_ids).select(:id) shared_private_domain_ids = Domain.dataset.db[:organizations_private_domains].where( @@ -14,11 +14,13 @@ def fetch_all_for_orgs(readable_org_ids) union(owned_domain_ids, all: true, from_self: false). union(shared_private_domain_ids, all: true, from_self: false) - Domain.where(id: all_domain_ids).qualify + dataset = Domain.where(id: all_domain_ids).qualify + dataset = dataset.eager(eager_loaded_associations) if eager_loaded_associations.any? + dataset end - def fetch(message, readable_org_ids) - dataset = fetch_all_for_orgs(readable_org_ids) + def fetch(message, readable_org_ids, eager_loaded_associations: []) + dataset = fetch_all_for_orgs(readable_org_ids, eager_loaded_associations:) filter(message, dataset) end diff --git a/app/presenters/v3/domain_presenter.rb b/app/presenters/v3/domain_presenter.rb index 8d3b86ddea1..6bc687300f8 100644 --- a/app/presenters/v3/domain_presenter.rb +++ b/app/presenters/v3/domain_presenter.rb @@ -6,14 +6,21 @@ module VCAP::CloudController::Presenters::V3 class DomainPresenter < BasePresenter include VCAP::CloudController::Presenters::Mixins::MetadataPresentationHelpers + class << self + # :labels and :annotations come from MetadataPresentationHelpers + def associated_resources + %i[owning_organization shared_organizations].concat(super) + end + end + def initialize( resource, show_secrets: false, censored_message: VCAP::CloudController::Presenters::Censorship::REDACTED_CREDENTIAL, - visible_org_ids_query: nil, + visible_org_guids: [], all_orgs_visible: false ) - @visible_org_ids_query = visible_org_ids_query + @visible_org_guids = visible_org_guids @all_orgs_visible = all_orgs_visible super(resource, show_secrets:, censored_message:) @@ -55,12 +62,12 @@ def to_hash private - attr_reader :visible_org_ids_query, :all_orgs_visible + attr_reader :visible_org_guids, :all_orgs_visible def shared_org_guids - ds = domain.shared_organizations_dataset - ds = ds.where(id: @visible_org_ids_query) unless @all_orgs_visible - ds.select_map(:guid).map { |g| { guid: g } } + orgs = domain.shared_organizations + orgs = orgs.select { |org| visible_org_guids.include?(org.guid) } unless all_orgs_visible + orgs.map { |org| { guid: org.guid } } end def owning_org_guid diff --git a/app/presenters/v3/domain_shared_orgs_presenter.rb b/app/presenters/v3/domain_shared_orgs_presenter.rb index 0a2e948caee..7ae9d58275b 100644 --- a/app/presenters/v3/domain_shared_orgs_presenter.rb +++ b/app/presenters/v3/domain_shared_orgs_presenter.rb @@ -6,10 +6,10 @@ module VCAP::CloudController::Presenters::V3 class DomainSharedOrgsPresenter < BasePresenter def initialize( resource, - visible_org_ids_query: nil, + visible_org_guids: [], all_orgs_visible: false ) - @visible_org_ids_query = visible_org_ids_query + @visible_org_guids = visible_org_guids @all_orgs_visible = all_orgs_visible super(resource) @@ -23,12 +23,12 @@ def to_hash private - attr_reader :visible_org_ids_query, :all_orgs_visible + attr_reader :visible_org_guids, :all_orgs_visible def shared_org_guids - ds = domain.shared_organizations_dataset - ds = ds.where(id: @visible_org_ids_query) unless @all_orgs_visible - ds.select_map(:guid).map { |g| { guid: g } } + orgs = domain.shared_organizations + orgs = orgs.select { |org| visible_org_guids.include?(org.guid) } unless all_orgs_visible + orgs.map { |org| { guid: org.guid } } end def domain diff --git a/spec/request/domains_spec.rb b/spec/request/domains_spec.rb index 6bcf286dfc5..8810da9d86d 100644 --- a/spec/request/domains_spec.rb +++ b/spec/request/domains_spec.rb @@ -38,6 +38,41 @@ end end + describe 'number of queries does not scale with the number of domains' do + let(:owning_org) { create(:organization) } + let(:shared_org) { create(:organization) } + + def create_private_domain_with_metadata(index) + domain = create(:private_domain, name: "domain#{index}.example.com", owning_organization: owning_org) + shared_org.add_private_domain(domain) + create(:domain_label_model, resource_guid: domain.guid, key_name: 'key', value: 'value') + create(:domain_annotation_model, resource_guid: domain.guid, key_name: 'key', value: 'value') + domain + end + + let(:owning_org_query) { /SELECT \* FROM "organizations" WHERE/ } + let(:shared_org_query) { /FROM "organizations" INNER JOIN "organizations_private_domains"/ } + let(:labels_query) { /SELECT \* FROM "domain_labels" WHERE/ } + let(:annotations_query) { /SELECT \* FROM "domain_annotations" WHERE/ } + + it 'issues a constant number of per-association queries regardless of page size' do + create_private_domain_with_metadata(1) + + expect { get '/v3/domains', nil, admin_header }.to have_queried_db_times(owning_org_query, 1) + expect { get '/v3/domains', nil, admin_header }.to have_queried_db_times(shared_org_query, 1) + expect { get '/v3/domains', nil, admin_header }.to have_queried_db_times(labels_query, 1) + expect { get '/v3/domains', nil, admin_header }.to have_queried_db_times(annotations_query, 1) + + create_private_domain_with_metadata(2) + create_private_domain_with_metadata(3) + + expect { get '/v3/domains', nil, admin_header }.to have_queried_db_times(owning_org_query, 1) + expect { get '/v3/domains', nil, admin_header }.to have_queried_db_times(shared_org_query, 1) + expect { get '/v3/domains', nil, admin_header }.to have_queried_db_times(labels_query, 1) + expect { get '/v3/domains', nil, admin_header }.to have_queried_db_times(annotations_query, 1) + end + end + describe 'when the user is not logged in' do it 'returns 401 for Unauthenticated requests' do get '/v3/domains' diff --git a/spec/unit/fetchers/domain_fetcher_spec.rb b/spec/unit/fetchers/domain_fetcher_spec.rb index e73085efef9..c9e1aeb1ef0 100644 --- a/spec/unit/fetchers/domain_fetcher_spec.rb +++ b/spec/unit/fetchers/domain_fetcher_spec.rb @@ -69,6 +69,30 @@ module VCAP::CloudController Domain.dataset.destroy end + describe 'eager loading associated resources' do + let!(:org1) { create(:organization, guid: 'org1') } + let!(:private_domain) { create(:private_domain, guid: 'private_domain', owning_organization: org1) } + let(:message) { DomainsListMessage.from_params({}) } + + it 'eager loads the specified associations for the domains' do + results = DomainFetcher.fetch( + message, [org1.id], + eager_loaded_associations: %i[owning_organization labels] + ).all + + expect(results.first.associations.key?(:owning_organization)).to be(true) + expect(results.first.associations.key?(:labels)).to be(true) + expect(results.first.associations.key?(:annotations)).to be(false) + end + + it 'eager loads nothing by default' do + results = DomainFetcher.fetch(message, [org1.id]).all + + expect(results.first.associations.key?(:owning_organization)).to be(false) + expect(results.first.associations.key?(:labels)).to be(false) + end + end + context 'when fetching a single domain by guid' do let(:message) do DomainShowMessage.new({ guid: domain_guid_filter }) diff --git a/spec/unit/presenters/v3/domain_presenter_spec.rb b/spec/unit/presenters/v3/domain_presenter_spec.rb index 9471b8351fb..40d8c8c1ba9 100644 --- a/spec/unit/presenters/v3/domain_presenter_spec.rb +++ b/spec/unit/presenters/v3/domain_presenter_spec.rb @@ -4,12 +4,19 @@ module VCAP::CloudController::Presenters::V3 RSpec.describe DomainPresenter do let(:visible_org_guids) { [] } - let(:visible_org_ids_query) { VCAP::CloudController::Organization.where(guid: visible_org_guids).select(:id) } let(:all_orgs_visible) { false } + describe '.associated_resources' do + it 'includes the associations the presenter reads so the list fetcher can eager load them' do + expect(DomainPresenter.associated_resources).to contain_exactly( + :owning_organization, :shared_organizations, :labels, :annotations + ) + end + end + describe '#to_hash' do subject do - DomainPresenter.new(domain, visible_org_ids_query:, all_orgs_visible:).to_hash + DomainPresenter.new(domain, visible_org_guids:, all_orgs_visible:).to_hash end context 'when the domain is public (shared)' do diff --git a/spec/unit/presenters/v3/domain_shared_orgs_presenter_spec.rb b/spec/unit/presenters/v3/domain_shared_orgs_presenter_spec.rb index f9ec5108ee0..4714059c87a 100644 --- a/spec/unit/presenters/v3/domain_shared_orgs_presenter_spec.rb +++ b/spec/unit/presenters/v3/domain_shared_orgs_presenter_spec.rb @@ -4,7 +4,6 @@ module VCAP::CloudController::Presenters::V3 RSpec.describe DomainSharedOrgsPresenter do let(:visible_org_guids) { [] } - let(:visible_org_ids_query) { VCAP::CloudController::Organization.where(guid: visible_org_guids).select(:id) } let(:all_orgs_visible) { false } describe '#to_hash' do @@ -17,7 +16,7 @@ module VCAP::CloudController::Presenters::V3 subject do DomainSharedOrgsPresenter.new( domain, - visible_org_ids_query:, + visible_org_guids:, all_orgs_visible: ).to_hash end