chore(CE): add audit logs to sync runs controller (#450)

Co-authored-by: TivonB-AI2 <[email protected]>

Author: github-actions[bot]

server/app/controllers/api/v1/sync_runs_controller.rb

@@ -3,8 +3,10 @@
 module Api
   module V1
     class SyncRunsController < ApplicationController
+      include AuditLogger
       before_action :set_sync
       before_action :set_sync_run, only: [:show]
+      after_action :create_audit_log
       attr_reader :sync
 
       def index
@@ -31,6 +33,10 @@ def set_sync_run
         @sync_run = @sync.sync_runs.find_by(id: params[:id])
         render_error(message: "Sync Run not found", status: :not_found) unless @sync_run
       end
+
+      def create_audit_log
+        audit!(resource_id: params[:id])
+      end
     end
   end
 end

server/spec/requests/api/v1/sync_runs_controller_spec.rb

@@ -53,6 +53,17 @@
           expect(row.dig(:attributes, :status)).to eq(sync_run.status)
           expect(response_hash.dig(:links, :first)).to include("http://www.example.com/api/v1/syncs/#{sync.id}/sync_runs?page=1")
         end
+
+        audit_log = AuditLog.last
+        expect(audit_log).not_to be_nil
+        expect(audit_log.user_id).to eq(user.id)
+        expect(audit_log.action).to eq("index")
+        expect(audit_log.resource_type).to eq("Sync_run")
+        expect(audit_log.resource_id).to eq(nil)
+        expect(audit_log.resource).to eq(nil)
+        expect(audit_log.workspace_id).to eq(workspace.id)
+        expect(audit_log.created_at).not_to be_nil
+        expect(audit_log.updated_at).not_to be_nil
       end
 
       it "returns success and fetch sync for member_role" do
@@ -72,6 +83,17 @@
           expect(row.dig(:attributes, :status)).to eq(sync_run.status)
           expect(response_hash.dig(:links, :first)).to include("http://www.example.com/api/v1/syncs/#{sync.id}/sync_runs?page=1")
         end
+
+        audit_log = AuditLog.last
+        expect(audit_log).not_to be_nil
+        expect(audit_log.user_id).to eq(user.id)
+        expect(audit_log.action).to eq("index")
+        expect(audit_log.resource_type).to eq("Sync_run")
+        expect(audit_log.resource_id).to eq(nil)
+        expect(audit_log.resource).to eq(nil)
+        expect(audit_log.workspace_id).to eq(workspace.id)
+        expect(audit_log.created_at).not_to be_nil
+        expect(audit_log.updated_at).not_to be_nil
       end
 
       it "returns success and fetch sync for viewer_role" do
@@ -91,6 +113,17 @@
           expect(row.dig(:attributes, :status)).to eq(sync_run.status)
           expect(response_hash.dig(:links, :first)).to include("http://www.example.com/api/v1/syncs/#{sync.id}/sync_runs?page=1")
         end
+
+        audit_log = AuditLog.last
+        expect(audit_log).not_to be_nil
+        expect(audit_log.user_id).to eq(user.id)
+        expect(audit_log.action).to eq("index")
+        expect(audit_log.resource_type).to eq("Sync_run")
+        expect(audit_log.resource_id).to eq(nil)
+        expect(audit_log.resource).to eq(nil)
+        expect(audit_log.workspace_id).to eq(workspace.id)
+        expect(audit_log.created_at).not_to be_nil
+        expect(audit_log.updated_at).not_to be_nil
       end
     end
 
@@ -139,6 +172,17 @@
         expect(response_hash.dig(:data, :attributes, :successful_rows)).to eq(sync_runs.first.successful_rows)
         expect(response_hash.dig(:data, :attributes, :failed_rows)).to eq(sync_runs.first.failed_rows)
         expect(response_hash.dig(:data, :attributes, :status)).to eq(sync_runs.first.status)
+
+        audit_log = AuditLog.last
+        expect(audit_log).not_to be_nil
+        expect(audit_log.user_id).to eq(user.id)
+        expect(audit_log.action).to eq("show")
+        expect(audit_log.resource_type).to eq("Sync_run")
+        expect(audit_log.resource_id).to eq(sync_runs.first.id)
+        expect(audit_log.resource).to eq(nil)
+        expect(audit_log.workspace_id).to eq(workspace.id)
+        expect(audit_log.created_at).not_to be_nil
+        expect(audit_log.updated_at).not_to be_nil
       end
 
       it "returns success and fetch sync for " do
@@ -153,6 +197,17 @@
         expect(response_hash.dig(:data, :attributes, :successful_rows)).to eq(sync_runs.first.successful_rows)
         expect(response_hash.dig(:data, :attributes, :failed_rows)).to eq(sync_runs.first.failed_rows)
         expect(response_hash.dig(:data, :attributes, :status)).to eq(sync_runs.first.status)
+
+        audit_log = AuditLog.last
+        expect(audit_log).not_to be_nil
+        expect(audit_log.user_id).to eq(user.id)
+        expect(audit_log.action).to eq("show")
+        expect(audit_log.resource_type).to eq("Sync_run")
+        expect(audit_log.resource_id).to eq(sync_runs.first.id)
+        expect(audit_log.resource).to eq(nil)
+        expect(audit_log.workspace_id).to eq(workspace.id)
+        expect(audit_log.created_at).not_to be_nil
+        expect(audit_log.updated_at).not_to be_nil
       end
 
       it "returns success and fetch sync " do
@@ -166,6 +221,17 @@
         expect(response_hash.dig(:data, :attributes, :successful_rows)).to eq(sync_runs.first.successful_rows)
         expect(response_hash.dig(:data, :attributes, :failed_rows)).to eq(sync_runs.first.failed_rows)
         expect(response_hash.dig(:data, :attributes, :status)).to eq(sync_runs.first.status)
+
+        audit_log = AuditLog.last
+        expect(audit_log).not_to be_nil
+        expect(audit_log.user_id).to eq(user.id)
+        expect(audit_log.action).to eq("show")
+        expect(audit_log.resource_type).to eq("Sync_run")
+        expect(audit_log.resource_id).to eq(sync_runs.first.id)
+        expect(audit_log.resource).to eq(nil)
+        expect(audit_log.workspace_id).to eq(workspace.id)
+        expect(audit_log.created_at).not_to be_nil
+        expect(audit_log.updated_at).not_to be_nil
       end
     end