Merge pull request #21 from rdytech/NEP-16354-delete-cascade-endpoint

NEP-16354 add delete cascade endpoint

Author: jbat

lib/superset/dashboard/bulk_delete.rb

@@ -6,6 +6,7 @@
 #   2 or do not have any charts or filters linked to them
 #  ( not sure if this needed at this point )
 
+# NOTE: deletes the Dashboard Only. Use Dashboard::BulkDeleteCascade to delete all related objects
 module Superset
   module Dashboard
     class BulkDelete < Superset::Request

lib/superset/dashboard/bulk_delete_cascade.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# WARNING: DESTRUCTIVE OPERATION .. use with caution
+# This class is used to delete multiple dashboards and all related charts and datasets.
+# There are NO CHECKS currently to confirm if a dataset is used on other dashboards.
+
+module Superset
+  module Dashboard
+    class BulkDeleteCascade
+      class InvalidParameterError < StandardError; end
+
+      attr_reader :dashboard_ids
+
+      def initialize(dashboard_ids: [])
+        @dashboard_ids = dashboard_ids
+      end
+
+      def perform
+        raise InvalidParameterError, "dashboard_ids array of integers expected" unless dashboard_ids.is_a?(Array)
+        raise InvalidParameterError, "dashboard_ids array must contain Integer only values" unless dashboard_ids.all? { |item| item.is_a?(Integer) }
+
+        dashboard_ids.sort.each do |dashboard_id|
+          logger.info("Dashboard Id: #{dashboard_id.to_s} Attempting CASCADE delete of dashboard, charts, datasets")
+          delete_datasets(dashboard_id)
+          delete_charts(dashboard_id)
+          delete_dashboard(dashboard_id)
+        end
+        true
+      end
+
+      private
+
+      def delete_datasets(dashboard_id)
+        datasets_to_delete = Superset::Dashboard::Datasets::List.new(dashboard_id).datasets_details.map{|d| d[:id] }
+        Superset::Dataset::BulkDelete.new(dataset_ids: datasets_to_delete).perform if datasets_to_delete.any?
+      end
+
+      def delete_charts(dashboard_id)
+        charts_to_delete = Superset::Dashboard::Charts::List.new(dashboard_id).chart_ids
+        Superset::Chart::BulkDelete.new(chart_ids: charts_to_delete).perform if charts_to_delete.any?
+      end
+
+      def delete_dashboard(dashboard_id)
+        Superset::Dashboard::Delete.new(dashboard_id: dashboard_id, confirm_zero_charts: true).perform
+      end
+
+      def logger
+        @logger ||= Superset::Logger.new
+      end 
+    end
+  end
+end

lib/superset/dashboard/put.rb

@@ -17,7 +17,6 @@ def perform
         raise "Error: params hash is required" unless params.present? && params.is_a?(Hash)
 
         response
-        Superset::Dashboard::Get.new(id).perform
       end
 
       def response

lib/superset/services/duplicate_dashboard.rb

@@ -7,14 +7,15 @@ module Superset
   module Services
     class DuplicateDashboard < Superset::Request
 
-      attr_reader :source_dashboard_id, :target_schema, :target_database_id, :allowed_domains, :tags
+      attr_reader :source_dashboard_id, :target_schema, :target_database_id, :allowed_domains, :tags, :publish
 
-      def initialize(source_dashboard_id:, target_schema:, target_database_id: , allowed_domains: [], tags: [])
+      def initialize(source_dashboard_id:, target_schema:, target_database_id: , allowed_domains: [], tags: [], publish: false)
         @source_dashboard_id = source_dashboard_id
         @target_schema = target_schema
         @target_database_id = target_database_id
         @allowed_domains = allowed_domains
         @tags = tags
+        @publish = publish
       end
 
       def perform
@@ -43,10 +44,12 @@ def perform
 
         add_tags_to_new_dashboard
 
+        publish_dashboard if publish
+
         end_log_message
 
         # return the new dashboard id and url
-        { new_dashboard_id: new_dashboard.id, new_dashboard_url: new_dashboard.url }
+        { new_dashboard_id: new_dashboard.id, new_dashboard_url: new_dashboard.url, published: publish }
 
       rescue => e
         logger.error("#{e.message}")
@@ -153,6 +156,10 @@ def update_source_dashboard_json_metadata
         Superset::Dashboard::Put.new(target_dashboard_id: new_dashboard.id, params: { "json_metadata" => @new_dashboard_json_metadata_configuration.to_json }).perform
       end
 
+      def publish_dashboard
+        Superset::Dashboard::Put.new(target_dashboard_id: new_dashboard.id, params: { published: publish } ).perform
+      end
+
       def new_dashboard
         @new_dashboard ||= begin
           copy = Superset::Dashboard::Copy.new(

spec/superset/dashboard/bulk_delete_cascade_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+RSpec.describe Superset::Dashboard::BulkDeleteCascade do
+  subject { described_class.new(dashboard_ids: dashboard_ids) }
+  let(:dashboard_ids) { nil }
+
+  describe '.perform' do
+    context 'when dashboard_ids is not present' do
+      it 'raises an error' do
+        expect { subject.perform }.to raise_error(Superset::Dashboard::BulkDeleteCascade::InvalidParameterError, "dashboard_ids array of integers expected")
+      end
+    end
+
+    context 'when dashboard_ids contains non integer values' do
+      let(:dashboard_ids) { [1, 'string'] }
+
+      it 'raises an error' do
+        expect { subject.perform }.to raise_error(Superset::Dashboard::BulkDeleteCascade::InvalidParameterError, "dashboard_ids array must contain Integer only values")
+      end
+    end
+
+    context 'when dashboard_ids are valid' do
+      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::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]))
+        allow(Superset::Chart::BulkDelete).to receive(:new).with(chart_ids: [21, 22]).and_return(double(perform: true))
+
+        allow(Superset::Dashboard::Delete).to receive(:new).with(dashboard_id: 1, confirm_zero_charts: true).and_return(double(perform: true))
+      end
+
+      it 'bulk deletes related charts, datasets and the dashboard' do
+        expect(subject.perform).to eq(true)
+      end
+    end
+  end
+end

spec/superset/dashboard/put_spec.rb

@@ -9,25 +9,16 @@
       "positions" => { "key2" => "value2" }
     }.to_json 
   }}
-
-  let(:new_dashboard_id) { 2 }
-  let(:new_dashboard_instance) { instance_double("Superset::Dashboard::Get") }
+  let(:response) { { "result" => { "id" => 2, "last_modified_time" => 1708484547.0 } } }
 
   before do
-    allow(subject).to receive(:response).and_return( { "result" => 
-      {"id"=>new_dashboard_id, "last_modified_time"=>1708484547.0} }
-    )
+    allow(subject).to receive(:response).and_return(response)
   end
 
   describe 'perform' do
     context 'with valid params' do
-      before do
-        allow(Superset::Dashboard::Get).to receive(:new).with(new_dashboard_id).and_return(new_dashboard_instance)
-        allow(new_dashboard_instance).to receive(:perform).and_return(new_dashboard_instance)
-      end
-
-      it 'returns the new dashboard object' do
-        expect(subject.perform).to be new_dashboard_instance
+      it 'returns response' do
+        expect(subject.perform).to eq(response)
       end
     end
 

spec/superset/services/duplicate_dashboard_spec.rb

@@ -133,7 +133,7 @@
       context 'completes duplicate process' do
         context 'and returns the new dashboard details' do
           specify do
-            expect(subject.perform).to eq( { new_dashboard_id: 2, new_dashboard_url: "http://superset-host.com/superset/dashboard/2" }) 
+            expect(subject.perform).to eq( { new_dashboard_id: 2, new_dashboard_url: "http://superset-host.com/superset/dashboard/2", published: false})
           end
         end
 
@@ -187,7 +187,7 @@
             expect(Superset::Dashboard::Embedded::Put).to_not receive(:new)
           end
 
-          specify { expect(subject.perform).to eq( { new_dashboard_id: 2, new_dashboard_url: "http://superset-host.com/superset/dashboard/2" }) }
+          specify { expect(subject.perform).to eq( { new_dashboard_id: 2, new_dashboard_url: "http://superset-host.com/superset/dashboard/2", published: false}) }
         end
 
         context 'are not empty' do
@@ -197,13 +197,13 @@
             expect(Superset::Dashboard::Embedded::Put).to receive(:new).with(dashboard_id: new_dashboard_id, allowed_domains: allowed_domains).and_return(double(result: { allowed_domains: allowed_domains }))
           end
 
-          specify { expect(subject.perform).to eq( { new_dashboard_id: 2, new_dashboard_url: "http://superset-host.com/superset/dashboard/2" }) }
+          specify { expect(subject.perform).to eq( { new_dashboard_id: 2, new_dashboard_url: "http://superset-host.com/superset/dashboard/2", published: false}) }
         end
       end
 
       context 'and tags' do
         context 'are empty' do
-          specify { expect(subject.perform).to eq( { new_dashboard_id: 2, new_dashboard_url: "http://superset-host.com/superset/dashboard/2" }) }
+          specify { expect(subject.perform).to eq( { new_dashboard_id: 2, new_dashboard_url: "http://superset-host.com/superset/dashboard/2", published: false}) }
         end
 
         context 'are not empty' do
@@ -213,10 +213,47 @@
             expect(Superset::Tag::AddToObject).to receive(:new).with(object_type_id: ObjectType::DASHBOARD, object_id: new_dashboard_id, tags: tags).and_return(double(perform: true))
           end
 
-          specify { expect(subject.perform).to eq( { new_dashboard_id: 2, new_dashboard_url: "http://superset-host.com/superset/dashboard/2" }) }
+          specify { expect(subject.perform).to eq( { new_dashboard_id: 2, new_dashboard_url: "http://superset-host.com/superset/dashboard/2", published: false}) }
         end
       end
 
+      context 'and publish attr is' do
+        context 'excluded from params' do
+          before do
+            expect(Superset::Dashboard::Put).to_not receive(:new).with(
+              target_dashboard_id: new_dashboard_id,
+              params: { published: false })
+          end
+
+          specify 'defaults to false' do
+            expect(subject.perform).to eq( {
+              new_dashboard_id: 2,
+              new_dashboard_url: "http://superset-host.com/superset/dashboard/2",
+              published: false
+            })
+          end
+        end
+
+        context 'included in params as true' do
+          subject { described_class.new(
+              source_dashboard_id: source_dashboard_id,
+              target_schema:       target_schema,
+              target_database_id:  target_database_id,
+              publish:           true ) }
+
+          before do
+            expect(Superset::Dashboard::Put).to receive(:new).with(
+              target_dashboard_id: new_dashboard_id,
+              params: { published: true }).and_return(double(perform: true))
+          end
+
+          specify { expect(subject.perform).to eq( {
+            new_dashboard_id: 2,
+            new_dashboard_url: "http://superset-host.com/superset/dashboard/2",
+            published: true
+            }) }
+        end
+      end
     end
 
     context 'with invalid params' do