[NEP-18090]: Adding en endpoint for warming up the dataset cache

Version upgrade
Update changlog
Validations for dashboard_id
Added spec cases

Author: soundarya-mv

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Change Log
 
+## 0.1.6 - 2024-07-10
+
+* added a class **WarmUpCache** to hit the 'api/v1/dataset/warm_up_cache' endpoint to warm up the cache of all the datasets for a particular dashaboard being passed to the class - https://github.com/rdytech/superset-client/pull/28
+
 ## 0.1.5 - 2024-05-10
 
 * add multi config for multi env creds https://github.com/rdytech/superset-client/pull/22

Gemfile.lock

@@ -14,7 +14,7 @@ GIT
 PATH
   remote: .
   specs:
-    superset (0.1.5)
+    superset (0.1.6)
       dotenv (~> 2.7)
       enumerate_it (~> 1.7.0)
       faraday (~> 1.0)

lib/superset/dataset/warm_up_cache.rb

@@ -9,14 +9,20 @@ def initialize(dashboard_id:)
       end
 
       def perform
+        validate_dashboard_id
         dataset_details = fetch_dataset_details(dashboard_id)
         dataset_details.each do |dataset|
           begin
             client.put(route, params(dashboard_id, dataset["datasource_name"], dataset["name"]))
           rescue => e
             Rollbar.error(e.message)
           end 
-        end  
+        end
+        return "Dashboard warmed up" 
+      end
+
+      def validate_dashboard_id
+        raise InvalidParameterError, "dashboard_id must be present and must be an integer" unless dashboard_id.present? && dashboard_id.is_a?(Integer)
       end
 
       def params(dashboard_id, dataset_name, db_name)

lib/superset/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Superset
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

spec/superset/dataset/warm_up_cache_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+RSpec.describe Superset::Dataset::WarmUpCache do
+  subject { described_class.new(dashboard_id: dashboard_id) }
+  let(:dashboard_id) { 1 }
+  let(:response) { nil }
+
+  before do
+    allow(subject).to receive(:response).and_return(response)
+  end
+
+  describe '.perform' do
+    context 'when dashboard_id is not present' do
+      let(:dashboard_id) { nil }
+
+      it 'raises an error' do
+        expect { subject.perform }.to raise_error(Superset::Request::InvalidParameterError, "dashboard_id must be present and must be an integer")
+      end
+    end
+
+    context 'when dashboard_id is not an integer' do
+      let(:dashboard_id) { 'string' }
+
+      it 'raises an error' do
+        expect { subject.perform }.to raise_error(Superset::Request::InvalidParameterError, "dashboard_id must be present and must be an integer")
+      end
+    end
+
+    context 'when dashboard_id is an integer' do
+      let(:response) { 'Dashboard warmed up' }
+
+      it 'warms up the dataset' do
+        expect(subject.perform).to eq response
+      end
+    end
+  end
+end