Merge pull request #7 from merefield/add_daily_workflow_stats

FEATURE: Add daily workflow stats

Author: merefield

app/jobs/scheduled/workflow_daily_stats.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ::Jobs::WorkflowDailyStats < ::Jobs::Scheduled
+  sidekiq_options retry: false
+
+  every 24.hours
+
+  def execute(args)
+    ::DiscourseWorkflow::Stats.new.calculate_daily_stats
+  end
+end

app/jobs/scheduled/workflow_data_explorer_queries_completeness.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+class ::Jobs::WorkflowDataExplorerQueriesCompleteness < ::Jobs::Scheduled
+  sidekiq_options retry: false
+
+  every 24.hours
+
+  def execute(args)
+    if !ActiveRecord::Base.connection.table_exists?(:data_explorer_queries)
+      Rails.logger.warn "Skipping WorkflowDataExplorerQueriesCompleteness: doesn't look like Data Explorer plugin is properly installed"
+      return
+    end
+
+    if !::DiscourseDataExplorer::Query.exists?(name: "Workflow Stats (default)")
+      query_sql = <<~SQL
+        -- [params]
+        -- int :workflow_id = 1
+        -- int :num_of_days_history = 14
+
+        SELECT cob_date as "COB DATE",
+            w.name as "Workflow",
+            wstp.name as "Step",
+            wstt.count as "Count"
+        FROM workflow_stats wstt
+        INNER JOIN workflow_steps wstp ON wstt.workflow_step_id = wstp.id
+        INNER JOIN workflows w ON wstt.workflow_id = w.id
+        WHERE wstt.cob_date >= NOW() - (:num_of_days_history * INTERVAL '1 day')
+          AND wstt.workflow_id = :workflow_id
+      SQL
+
+      DB.exec <<~SQL, now: Time.zone.now, query_sql: query_sql
+        INSERT INTO data_explorer_queries(name, description, sql, created_at, updated_at)
+        VALUES
+        ('Workflow Stats (default)',
+        'Daily counts for each workflow step in a workflow (useful for e.g. burndown/burnup charts)',
+        :query_sql,
+        :now,
+        :now)
+      SQL
+    end
+
+    if !::DiscourseDataExplorer::Query.exists?(
+         name: "Workflow Audit Log (default)"
+       )
+      query_sql = <<~SQL
+        -- [params]
+        -- int :workflow_id = 1
+        -- int :num_of_days_history = 14
+
+        SELECT user_id,
+            topic_id,
+            workflow_name,
+            starting_step_name,
+            step_option_name
+        FROM
+            workflow_audit_logs
+        WHERE created_at >= NOW() - (:num_of_days_history * INTERVAL '1 day')
+        AND workflow_id = :workflow_id
+      SQL
+
+      DB.exec <<~SQL, now: Time.zone.now, query_sql: query_sql
+        INSERT INTO data_explorer_queries(name, description, sql, created_at, updated_at)
+        VALUES
+        ('Workflow Audit Log (default)',
+        'Audit log for workflow actions',
+        :query_sql,
+        :now,
+        :now)
+      SQL
+    end
+  end
+end

app/models/discourse_workflow/workflow_stat.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ::DiscourseWorkflow
+  class WorkflowStat < ActiveRecord::Base
+    self.table_name = 'workflow_stats'
+    has_one :workflow
+    has_one :workflow_step
+    validates :cob_date, presence: true
+    validates :workflow_id, presence: true
+    validates :workflow_step_id, presence: true
+    validates :count, presence: true, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
+  end
+end
+
+# == Schema Information
+#
+# Table name: workflow_stats
+#
+#  id               :bigint           not null, primary key
+#  cob_date         :datetime
+#  count            :integer
+#  created_at       :datetime         not null
+#  updated_at       :datetime         not null
+#  workflow_id      :bigint
+#  workflow_step_id :bigint
+#
+# Indexes
+#
+#  index_workflow_stats_on_workflow_id       (workflow_id)
+#  index_workflow_stats_on_workflow_step_id  (workflow_step_id)
+#
+# Foreign Keys
+#
+#  fk_rails_...  (workflow_id => workflows.id)
+#  fk_rails_...  (workflow_step_id => workflow_steps.id)
+#

app/models/discourse_workflow/workflow_step_option.rb

@@ -14,11 +14,11 @@ class WorkflowStepOption < ActiveRecord::Base
 #
 #  id                 :bigint           not null, primary key
 #  position           :integer
-#  workflow_step_id   :bigint
-#  workflow_option_id :bigint
-#  target_step_id     :bigint
 #  created_at         :datetime         not null
 #  updated_at         :datetime         not null
+#  target_step_id     :bigint
+#  workflow_option_id :bigint
+#  workflow_step_id   :bigint
 #
 # Indexes
 #

db/fixtures/002_workflow_data_explorer_query.rb

@@ -0,0 +1,15 @@
+
+# frozen_string_literal: true
+# rubocop:disable Discourse/NoAddReferenceOrAliasesActiveRecordMigration
+class CreateWorkflowStats < ActiveRecord::Migration[7.2]
+  def change
+    create_table :workflow_stats do |t|
+      t.datetime :cob_date
+      t.references :workflow, foreign_key: true
+      t.references :workflow_step, foreign_key: true
+      t.integer :count
+
+      t.timestamps
+    end
+  end
+end

db/migrate/20250530102741_create_workflow_stats.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module DiscourseWorkflow
+  class Stats
+
+    def calculate_daily_stats
+      return unless SiteSetting.workflow_enabled
+
+      current_date = Date.current
+
+      ::DiscourseWorkflow::WorkflowStat.where(cob_date: current_date).destroy_all
+
+      Workflow.all.each do |workflow|
+        workflow.workflow_state.each do |state|
+          stat = ::DiscourseWorkflow::WorkflowStat.find_or_initialize_by(
+            cob_date: current_date,
+            workflow_id: workflow.id,
+            workflow_step_id: state.workflow_step_id
+          )
+          stat.count ||= 0
+          stat.count += 1
+          stat.save!
+        end
+        ::Rails.logger.info("Workflow Daily Stats recorded for: #{workflow.name}")
+      end
+    end
+  end
+end

lib/discourse_workflow/stats.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # name: discourse-workflow
 # about: A topic-based workflow engine for Discourse
-# version: 0.0.15
+# version: 0.0.16
 # authors: Robert Barrow
 # contact_emails: [email protected]
 # url: https://github.com/merefield/discourse-workflow