[NEP-18619]: Adding filter datasets to list endpoint, changing all references to use named attribute, adding filter_only attribute for filter datasets

Author: soundarya-mv

doc/usage.md

@@ -10,7 +10,9 @@ Superset::Database::GetSchemas.new(1).list # get schemas for database 1
 
 Superset::Dashboard::List.call
 Superset::Dashboard::List.new(title_contains: 'Sales').list
-Superset::Dashboard::Datasets::List.new(10).list  # get all datasets for dashboard 10
+Superset::Dashboard::Datasets::List.new(dashboard_id: 10).list  # get all datasets for dashboard 10
+
+Superset::Dashboard::Datasets::List.new(dashboard_id: 10, include_filter_datasets: true).list  # get all datasets for dashboard 10 including the ones used only in dashboard filters
 Superset::Dashboard::WarmUpCache.new(dashboard_id: 10).perform
 
 Superset::Dataset::List.call

lib/superset/dashboard/bulk_delete_cascade.rb

@@ -31,7 +31,7 @@ def perform
       private
 
       def delete_datasets(dashboard_id)
-        datasets_to_delete = Superset::Dashboard::Datasets::List.new(dashboard_id).datasets_details.map{|d| d[:id] }
+        datasets_to_delete = Superset::Dashboard::Datasets::List.new(dashboard_id: dashboard_id).datasets_details.map{|d| d[:id] }
         Superset::Dataset::BulkDelete.new(dataset_ids: datasets_to_delete).perform if datasets_to_delete.any?
       end
 

lib/superset/dashboard/compare.rb

@@ -37,8 +37,8 @@ def second_dashboard
 
       def list_datasets
         puts "\n ====== DASHBOARD DATASETS ====== "
-        Superset::Dashboard::Datasets::List.new(first_dashboard_id).list
-        Superset::Dashboard::Datasets::List.new(second_dashboard_id).list
+        Superset::Dashboard::Datasets::List.new(dashboard_id: first_dashboard_id).list
+        Superset::Dashboard::Datasets::List.new(dashboard_id: second_dashboard_id).list
       end
 
       def list_charts

lib/superset/dashboard/datasets/list.rb

@@ -62,7 +62,7 @@ def filter_datasets(filter_dataset_ids_not_used_in_charts)
               'name' => filter_dataset['database']['database_name'],
               'backend' => filter_dataset['database']['backend']
             }
-            filter_dataset.slice('id', 'datasource_name', 'schema', 'sql').merge('database' => database_info).with_indifferent_access
+            filter_dataset.slice('id', 'datasource_name', 'schema', 'sql').merge('database' => database_info, 'filter_only': true).with_indifferent_access
           end
         end
 
@@ -71,18 +71,19 @@ def route
         end
 
         def list_attributes
-          ['id', 'datasource_name', 'database_id', 'database_name', 'database_backend', 'schema'].map(&:to_sym)
+          ['id', 'datasource_name', 'database_id', 'database_name', 'database_backend', 'schema', 'filter_only'].map(&:to_sym)
         end
 
         def rows
-          result.map do |d|
+          datasets_details.map do |d|
             [
               d[:id],
               d[:datasource_name],
               d[:database][:id],
               d[:database][:name],
               d[:database][:backend],
-              d[:schema]
+              d[:schema],
+              d[:filter_only]
             ]
           end
         end
@@ -93,7 +94,7 @@ def title
         end
 
         def dashboard
-          @dashboard = Superset::Dashboard::Get.new(id)
+          @dashboard ||= Superset::Dashboard::Get.new(id)
         end
       end
     end

lib/superset/dashboard/warm_up_cache.rb

@@ -35,7 +35,7 @@ def validate_dashboard_id
       end
 
       def fetch_dataset_details(dashboard_id)
-        Superset::Dashboard::Datasets::List.new(dashboard_id).datasets_details.map { |dataset| dataset['database'].slice('name').merge(dataset.slice('datasource_name'))}
+        Superset::Dashboard::Datasets::List.new(dashboard_id: dashboard_id).datasets_details.map { |dataset| dataset['database'].slice('name').merge(dataset.slice('datasource_name'))}
       end
     end
   end

spec/superset/dashboard/bulk_delete_cascade_spec.rb

@@ -23,7 +23,7 @@
       let(:dashboard_ids) { [1] }
 
       before do
-        allow(Superset::Dashboard::Datasets::List).to receive(:new).with(1).and_return(double(datasets_details: [{ id: 11 }, { id: 12 }]))
+        allow(Superset::Dashboard::Datasets::List).to receive(:new).with(dashboard_id: 1).and_return(double(datasets_details: [{ id: 11 }, { id: 12 }]))
         allow(Superset::Dataset::BulkDelete).to receive(:new).with(dataset_ids: [11,12]).and_return(double(perform: true))
 
         allow(Superset::Dashboard::Charts::List).to receive(:new).with(1).and_return(double(chart_ids: [21, 22]))