Skip to content

A platform for community discussion. Free, open, simple.

UX: Decide on the server when a Rewind report has enough data

Régis Hanolb88c2b9451b3
diff --git a/plugins/discourse-rewind/app/services/discourse_rewind/action/ai_usage.rb b/plugins/discourse-rewind/app/services/discourse_rewind/action/ai_usage.rb
index 4f11f0fafa3..36bba44c326 100644
--- a/plugins/discourse-rewind/app/services/discourse_rewind/action/ai_usage.rb
+++ b/plugins/discourse-rewind/app/services/discourse_rewind/action/ai_usage.rb
@@ -1,29 +1,26 @@
# frozen_string_literal: true
-# AI usage statistics from discourse-ai plugin
-# Shows total usage, favorite features, token consumption, etc.
-# Uses AiApiRequestStat for efficient aggregation queries
module DiscourseRewind
module Action
class AiUsage < BaseReport
+ MAX_USAGES = 3
+ MINIMUM_REQUESTS = 10
+ MINIMUM_TOKENS = 1000
+
FakeData = {
data: {
total_requests: 247,
total_tokens: 156_890,
- request_tokens: 45_230,
- response_tokens: 111_660,
- feature_usage: {
- "chat_composer_helper" => 89,
- "post_summarizer" => 56,
- "semantic_search" => 42,
- "topic_gist" => 38,
- "similar_topics" => 22,
- },
- model_usage: {
- "gpt-4" => 123,
- "claude-3-5-sonnet" => 89,
- "gpt-3.5-turbo" => 35,
- },
+ feature_usage: [
+ { name: "chat_composer_helper", count: 89 },
+ { name: "post_summarizer", count: 56 },
+ { name: "semantic_search", count: 42 },
+ ],
+ model_usage: [
+ { name: "gpt-4", count: 123 },
+ { name: "claude-3-5-sonnet", count: 89 },
+ { name: "gpt-3.5-turbo", count: 35 },
+ ],
success_rate: 94.7,
},
identifier: "ai-usage",
@@ -34,7 +31,6 @@ module DiscourseRewind
base_query = AiApiRequestStat.where(user_id: user.id).where(bucket_date: date)
- # Get aggregated stats in a single query
stats =
base_query.select(
"COALESCE(SUM(usage_count), 0) as total_requests",
@@ -43,59 +39,48 @@ module DiscourseRewind
"COALESCE(SUM(CASE WHEN response_tokens > 0 THEN usage_count ELSE 0 END), 0) as successful_requests",
).take
- return if stats.total_requests == 0
+ return if stats.total_requests < MINIMUM_REQUESTS
total_tokens = stats.total_request_tokens + stats.total_response_tokens
- success_rate =
- (
- if stats.total_requests > 0
- (stats.successful_requests.to_f / stats.total_requests * 100).round(1)
- else
- 0
- end
- )
+ return if total_tokens < MINIMUM_TOKENS
- # Most used features (top 5)
- feature_usage =
- base_query
- .group(:feature_name)
- .order("SUM(usage_count) DESC", :feature_name)
- .limit(5)
- .pluck(:feature_name, Arel.sql("SUM(usage_count)"))
- .to_h
+ success_rate = (stats.successful_requests.to_f / stats.total_requests * 100).round(1)
- # Most used AI model (top 5)
- model_usage =
- base_query
- .where.not(language_model: nil)
- .group(:language_model)
- .order("SUM(usage_count) DESC", :language_model)
- .limit(5)
- .pluck(:language_model, Arel.sql("SUM(usage_count)"))
- .to_h
+ feature_usage = usage_by(base_query, :feature_name)
+ model_usage = usage_by(base_query, :language_model)
{
data: {
total_requests: stats.total_requests,
- total_tokens: total_tokens,
- request_tokens: stats.total_request_tokens,
- response_tokens: stats.total_response_tokens,
- feature_usage: feature_usage,
- model_usage: model_usage,
- success_rate: success_rate,
+ total_tokens:,
+ feature_usage:,
+ model_usage:,
+ success_rate:,
},
identifier: "ai-usage",
}
end
+ def self.filter_for_viewer(report, guardian:, for_user:)
+ return report if guardian.is_me?(for_user) || guardian.is_admin?
+
+ report.merge(data: report[:data].except(:model_usage))
+ end
+
def self.enabled?
plugin_enabled?("discourse-ai")
end
- def self.filter_for_viewer(report, guardian:, for_user:)
- return report if guardian.is_me?(for_user) || guardian.is_admin?
+ private
- report.merge(data: report[:data].except(:model_usage))
+ def usage_by(query, column)
+ query
+ .where.not(column => [nil, ""])
+ .group(column)
+ .order(Arel.sql("SUM(usage_count) DESC"), column)
+ .limit(MAX_USAGES)
+ .pluck(column, Arel.sql("SUM(usage_count)"))
+ .map { |name, count| { name:, count: } }
end
end
end
diff --git a/plugins/discourse-rewind/app/services/discourse_rewind/action/assignments.rb b/plugins/discourse-rewind/app/services/discourse_rewind/action/assignments.rb
index e9be4dfcf80..b186017a304 100644
--- a/plugins/discourse-rewind/app/services/discourse_rewind/action/assignments.rb
+++ b/plugins/discourse-rewind/app/services/discourse_rewind/action/assignments.rb
@@ -1,7 +1,5 @@
# frozen_string_literal: true
-# Assignment statistics using discourse-assign plugin data
-# Shows how many assignments, completed, pending, etc.
module DiscourseRewind
module Action
class Assignments < BaseReport
@@ -19,44 +17,30 @@ module DiscourseRewind
def call
return FakeData if should_use_fake_data?
- # Assignments made to the user
- assignments_scope =
- Assignment.where(assigned_to_id: user.id, assigned_to_type: "User").where(
- created_at: date,
- )
+ assigned = Assignment.where(assigned_to: user)
+ assigned_this_year = assigned.where(created_at: date)
+ total_assigned = assigned_this_year.count
- total_assigned = assignments_scope.count
+ return if total_assigned == 0
- # Completed assignments (topics that were assigned and then closed or unassigned)
completed_count =
- assignments_scope
+ assigned_this_year
.joins(:topic)
.where(
"topics.closed = true OR assignments.active = false OR assignments.updated_at > assignments.created_at",
)
- .distinct
.count
+ pending_count = assigned.active.joins(:topic).where(topics: { closed: false }).count
- # Currently pending (still open and assigned)
- pending_count =
- Assignment
- .where(assigned_to_id: user.id, assigned_to_type: "User", active: true)
- .joins(:topic)
- .where(topics: { closed: false })
- .count
-
- # Assignments made by the user to others
- assigned_by_user =
- Assignment.where(assigned_by_user_id: user.id).where(created_at: date).count
+ return if completed_count == 0 && pending_count == 0
{
data: {
- total_assigned: total_assigned,
+ total_assigned:,
completed: completed_count,
pending: pending_count,
- assigned_by_user: assigned_by_user,
- completion_rate:
- total_assigned > 0 ? (completed_count.to_f / total_assigned * 100).round(1) : 0,
+ assigned_by_user: Assignment.where(assigned_by_user: user, created_at: date).count,
+ completion_rate: (completed_count.to_f / total_assigned * 100).round(1),
},
identifier: "assignments",
}
diff --git a/plugins/discourse-rewind/app/services/discourse_rewind/action/chat_usage.rb b/plugins/discourse-rewind/app/services/discourse_rewind/action/chat_usage.rb
index 39d2a3d4a29..faa4907b4f3 100644
--- a/plugins/discourse-rewind/app/services/discourse_rewind/action/chat_usage.rb
+++ b/plugins/discourse-rewind/app/services/discourse_rewind/action/chat_usage.rb
@@ -1,10 +1,11 @@
# frozen_string_literal: true
-# Chat usage statistics
-# Shows message counts, favorite channels, DM activity, etc.
module DiscourseRewind
module Action
class ChatUsage < BaseReport
+ MINIMUM_MESSAGES = 20
+ MINIMUM_DM_CHANNELS = 2
+
FakeData = {
data: {
total_messages: 342,
@@ -17,7 +18,6 @@ module DiscourseRewind
],
dm_message_count: 87,
unique_dm_channels: 12,
- messages_with_reactions: 42,
total_reactions_received: 156,
avg_message_length: 78.5,
},
@@ -27,14 +27,16 @@ module DiscourseRewind
def call
return FakeData if should_use_fake_data?
- messages =
- Chat::Message.where(user_id: user.id).where(created_at: date).where(deleted_at: nil)
+ messages = Chat::Message.where(user_id: user.id, created_at: date)
+ total_messages, avg_message_length =
+ messages.pick(
+ Arel.sql("COUNT(*)"),
+ Arel.sql("AVG(LENGTH(message)) FILTER (WHERE LENGTH(message) > 0)"),
+ )
- total_messages = messages.count
- return if total_messages == 0
+ return if total_messages < MINIMUM_MESSAGES
- # Get favorite channels (public channels only, excluding read-restricted categories)
- channel_usage =
+ favorite_channels =
messages
.joins(:chat_channel)
.merge(self.class.public_category_channels)
@@ -42,52 +44,27 @@ module DiscourseRewind
.order("COUNT(*) DESC", "chat_channels.id")
.limit(5)
.count
- .map do |(id, slug), count|
- { channel_id: id, channel_slug: slug, message_count: count }
+ .map do |(channel_id, channel_slug), message_count|
+ { channel_id:, channel_slug:, message_count: }
end
- # DM statistics
- dm_message_count =
- messages.joins(:chat_channel).where(chat_channels: { type: "DirectMessageChannel" }).count
-
- # Unique DM conversations
- unique_dm_channels =
- messages
- .joins(:chat_channel)
- .where(chat_channels: { type: "DirectMessageChannel" })
- .distinct
- .count(:chat_channel_id)
-
- # Messages with reactions received
- messages_with_reactions =
- Chat::MessageReaction
- .joins(:chat_message)
- .where(chat_messages: { user_id: user.id })
- .where(chat_messages: { created_at: date })
- .distinct
- .count(:chat_message_id)
-
- # Total reactions received
- total_reactions_received =
- Chat::MessageReaction
- .joins(:chat_message)
- .where(chat_messages: { user_id: user.id })
- .where(chat_messages: { created_at: date })
- .count
+ dm_message_count, unique_dm_channels =
+ messages.in_dm_channel.pick(
+ Arel.sql("COUNT(*)"),
+ Arel.sql("COUNT(DISTINCT chat_messages.chat_channel_id)"),
+ )
- # Average message length
- avg_message_length =
- messages.where("LENGTH(message) > 0").average("LENGTH(message)")&.to_f&.round(1) || 0
+ return if unique_dm_channels < MINIMUM_DM_CHANNELS || favorite_channels.empty?
{
data: {
- total_messages: total_messages,
- favorite_channels: channel_usage,
- dm_message_count: dm_message_count,
- unique_dm_channels: unique_dm_channels,
- messages_with_reactions: messages_with_reactions,
- total_reactions_received: total_reactions_received,
- avg_message_length: avg_message_length,
+ total_messages:,
+ favorite_channels:,
+ dm_message_count:,
+ unique_dm_channels:,
+ total_reactions_received:
+ Chat::MessageReaction.where(chat_message_id: messages.select(:id)).count,
+ avg_message_length: avg_message_length.to_f.round(1),
},
identifier: "chat-usage",
}
diff --git a/plugins/discourse-rewind/app/services/discourse_rewind/action/invites.rb b/plugins/discourse-rewind/app/services/discourse_rewind/action/invites.rb
index 772e6b22317..8d655bb4c81 100644
--- a/plugins/discourse-rewind/app/services/discourse_rewind/action/invites.rb
+++ b/plugins/discourse-rewind/app/services/discourse_rewind/action/invites.rb
@@ -1,10 +1,12 @@
# frozen_string_literal: true
-# Invite statistics
-# Shows how many users this user invited and the impact of those invitees
module DiscourseRewind
module Action
class Invites < BaseReport
+ MINIMUM_INVITES = 2
+ MINIMUM_REDEEMED = 1
+ MINIMUM_INVITEE_POSTS = 5
+
FakeData = {
data: {
total_invites: 18,
@@ -13,7 +15,6 @@ module DiscourseRewind
invitee_post_count: 145,
invitee_topic_count: 23,
invitee_like_count: 89,
- avg_trust_level: 1.8,
most_active_invitee: {
id: 42,
username: "newbie_123",
@@ -26,72 +27,38 @@ module DiscourseRewind
def call
return FakeData if should_use_fake_data?
- # Get all invites created by this user in the date range
- invites = Invite.where(invited_by_id: user.id).where(created_at: date)
-
- total_invites = invites.count
- return if total_invites == 0
-
- # Redeemed invites (users who actually joined)
- redeemed_count = invites.where("redemption_count > 0").count
-
- # Get the users who were invited (via InvitedUser or redeemed invites)
- invited_user_ids = InvitedUser.where(invite: invites).pluck(:user_id).compact
-
- invited_users = User.where(id: invited_user_ids)
-
- # Calculate impact of invitees
- invitee_post_count =
- Post.where(user_id: invited_user_ids).where(created_at: date).where(deleted_at: nil).count
- invitee_topic_count =
- Topic
- .where(user_id: invited_user_ids)
- .where(created_at: date)
- .where(deleted_at: nil)
- .count
+ invites = Invite.where(invited_by_id: user.id, created_at: date)
+ total_invites, redeemed_count =
+ invites.pick(
+ Arel.sql("COUNT(*)"),
+ Arel.sql("COUNT(*) FILTER (WHERE redemption_count > 0)"),
+ )
- invitee_like_count =
- UserAction
- .where(user_id: invited_user_ids)
- .where(action_type: UserAction::LIKE)
- .where(created_at: date)
- .count
+ return if total_invites < MINIMUM_INVITES || redeemed_count < MINIMUM_REDEEMED
- # Calculate average trust level of invitees
- avg_trust_level = invited_users.average(:trust_level)&.to_f&.round(1) || 0
+ invitee_ids = InvitedUser.where(invite: invites).select(:user_id)
+ post_counts = Post.where(user_id: invitee_ids, created_at: date).group(:user_id).count
+ invitee_post_count = post_counts.values.sum
- # Most active invitee
- most_active_invitee = nil
- if invited_user_ids.any?
- most_active_id =
- Post
- .where(user_id: invited_user_ids)
- .where(created_at: date)
- .where(deleted_at: nil)
- .group(:user_id)
- .count
- .max_by { |_, count| count }
- &.first
+ return if invitee_post_count < MINIMUM_INVITEE_POSTS
- if most_active_id
- most_active_user = User.find_by(id: most_active_id)
- most_active_invitee =
- BasicUserSerializer.new(most_active_user, root: false).as_json if most_active_user
- end
- end
+ most_active_invitee = User.find(post_counts.max_by(&:last).first)
{
data: {
- total_invites: total_invites,
- redeemed_count: redeemed_count,
- redemption_rate:
- total_invites > 0 ? (redeemed_count.to_f / total_invites * 100).round(1) : 0,
- invitee_post_count: invitee_post_count,
- invitee_topic_count: invitee_topic_count,
- invitee_like_count: invitee_like_count,
- avg_trust_level: avg_trust_level,
- most_active_invitee: most_active_invitee,
+ total_invites:,
+ redeemed_count:,
+ redemption_rate: (redeemed_count.to_f / total_invites * 100).round(1),
+ invitee_post_count:,
+ invitee_topic_count: Topic.where(user_id: invitee_ids, created_at: date).count,
+ invitee_like_count:
+ UserAction.where(
+ user_id: invitee_ids,
+ action_type: UserAction::LIKE,
+ created_at: date,
+ ).count,
+ most_active_invitee: BasicUserSerializer.new(most_active_invitee, root: false).as_json,
},
identifier: "invites",
}
diff --git a/plugins/discourse-rewind/app/services/discourse_rewind/action/writing_analysis.rb b/plugins/discourse-rewind/app/services/discourse_rewind/action/writing_analysis.rb
index f5810d06176..bab630be684 100644
--- a/plugins/discourse-rewind/app/services/discourse_rewind/action/writing_analysis.rb
+++ b/plugins/discourse-rewind/app/services/discourse_rewind/action/writing_analysis.rb
@@ -3,6 +3,9 @@
module DiscourseRewind
module Action
class WritingAnalysis < BaseReport
+ MINIMUM_WORDS = 100
+ MINIMUM_POSTS = 5
+
FakeData = {
data: {
total_words: 45_230,
@@ -16,30 +19,11 @@ module DiscourseRewind
def call
return FakeData if should_use_fake_data?
- total_words =
- DB.query_single(<<~SQL, user_id: user.id, date_start: date.first, date_end: date.last)
- SELECT SUM(p.word_count)
- FROM posts p
- INNER JOIN topics t ON t.id = p.topic_id
- WHERE p.user_id = :user_id
- AND p.created_at BETWEEN :date_start AND :date_end
- AND p.deleted_at IS NULL
- AND t.deleted_at IS NULL
- SQL
-
- post_count =
- DB.query_single(<<~SQL, user_id: user.id, date_start: date.first, date_end: date.last)
- SELECT COUNT(*)
- FROM posts p
- INNER JOIN topics t ON t.id = p.topic_id
- WHERE p.user_id = :user_id
- AND p.created_at BETWEEN :date_start AND :date_end
- AND p.deleted_at IS NULL
- AND t.deleted_at IS NULL
- SQL
+ posts = Post.joins(:topic).where(user_id: user.id, created_at: date)
+ total_words, total_posts =
+ posts.pick(Arel.sql("COALESCE(SUM(posts.word_count), 0)"), Arel.sql("COUNT(*)"))
- average_post_length =
- post_count.first > 0 ? (total_words.first.to_f / post_count.first).round(2) : 0
+ return if total_words < MINIMUM_WORDS || total_posts < MINIMUM_POSTS
# Calculated using the Flesch Reading Ease formula,
# with a statistical approximation for syllables (1.45 per word,
@@ -51,74 +35,30 @@ module DiscourseRewind
# and ending with emojis by treating them as a single sentence.
#
# Scores are bounded between 0-100 to prevent extreme negative values.
- readability_score =
- DB.query_single(<<~SQL, user_id: user.id, start: date.first, end: date.last)
+ readability_score = DB.query_single(<<~SQL).first
WITH cleaned AS (
- SELECT
- p.id AS post_id,
- p.user_id,
- p.created_at,
- p.word_count,
- regexp_replace(p.cooked, '<[^>]+>', ' ', 'g') AS plain
- FROM posts p
- INNER JOIN topics t ON t.id = p.topic_id
- WHERE p.user_id = :user_id
- AND p.created_at BETWEEN :start AND :end
- AND p.deleted_at IS NULL
- AND t.deleted_at IS NULL
+ #{posts.select("posts.word_count AS words", "regexp_replace(posts.cooked, '<[^>]+>', ' ', 'g') AS plain").to_sql}
),
metrics AS (
SELECT
- post_id,
- user_id,
- created_at,
- plain,
- word_count AS words,
- regexp_count(plain, '[.!?;:](\s|$)') AS sentences_raw,
- (word_count * 1.45) AS syllables
- FROM cleaned
- ),
- scores AS (
- SELECT
- post_id,
- user_id,
- created_at,
words,
- syllables,
- plain,
-
- CASE
- WHEN sentences_raw = 0 AND words > 5 THEN 1
- ELSE sentences_raw
- END AS sentences_fixed,
-
- -- Flesch Reading Ease formula with bounds (0-100)
CASE
- WHEN words = 0 THEN NULL
- WHEN (CASE WHEN sentences_raw = 0 AND words > 5 THEN 1 ELSE sentences_raw END) = 0 THEN NULL
- ELSE GREATEST(0, LEAST(100,
- 206.835
- - 1.015 * (
- words::float /
- (CASE WHEN sentences_raw = 0 AND words > 5 THEN 1 ELSE sentences_raw END)
- )
- - 84.6 * (syllables::float / words)
- ))
- END AS readability_score
-
- FROM metrics
+ WHEN regexp_count(plain, '[.!?;:](\s|$)') = 0 AND words > 5 THEN 1
+ ELSE regexp_count(plain, '[.!?;:](\s|$)')
+ END AS sentences
+ FROM cleaned
)
- SELECT AVG(readability_score) AS avg_readability_score
- FROM scores
- GROUP BY user_id;
+ SELECT AVG(GREATEST(0, LEAST(100, 206.835 - 1.015 * (words::float / sentences) - 84.6 * 1.45)))
+ FROM metrics
+ WHERE words > 0 AND sentences > 0
SQL
{
data: {
- total_words: total_words.first,
- total_posts: post_count.first,
- average_post_length: average_post_length,
- readability_score: readability_score.first,
+ total_words:,
+ total_posts:,
+ average_post_length: (total_words.to_f / total_posts).round(2),
+ readability_score:,
},
identifier: "writing-analysis",
}
diff --git a/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/ai-usage.gjs b/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/ai-usage.gjs
index 57ea15b36c3..ffffc8f569d 100644
--- a/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/ai-usage.gjs
+++ b/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/ai-usage.gjs
@@ -1,62 +1,20 @@
import Component from "@glimmer/component";
-import { get } from "@ember/helper";
import { action } from "@ember/object";
-import didInsert from "@ember/render-modifiers/modifiers/did-insert";
-import willDestroy from "@ember/render-modifiers/modifiers/will-destroy";
+import { modifier } from "ember-modifier";
+import { prefersReducedMotion } from "discourse/lib/utilities";
import dNumber from "discourse/ui-kit/helpers/d-number";
import { i18n } from "discourse-i18n";
export default class AiUsage extends Component {
- matrixInterval = null;
-
- get totalRequests() {
- return this.args.report.data.total_requests ?? 0;
- }
-
- get totalTokens() {
- return this.args.report.data.total_tokens ?? 0;
- }
-
- get successRate() {
- return this.args.report.data.success_rate ?? 0;
- }
-
- get featureUsage() {
- return Object.entries(this.args.report.data.feature_usage ?? {})
- .filter(([name]) => name && name.trim().length > 0)
- .slice(0, 3);
- }
-
- get modelUsage() {
- return Object.entries(this.args.report.data.model_usage ?? {})
- .filter(([name]) => name && name.trim().length > 0)
- .slice(0, 3);
- }
-
- get minimumDataThresholdMet() {
- return this.totalRequests >= 10 && this.totalTokens >= 1000;
- }
-
- @action
- formatFeatureName(featureName) {
- return featureName.replace(/_/g, " ");
- }
-
- @action
- setupMatrix(element) {
- const prefersReducedMotion = window.matchMedia(
- "(prefers-reduced-motion: reduce)"
- ).matches;
-
- if (prefersReducedMotion) {
+ matrixRain = modifier((canvas) => {
+ if (prefersReducedMotion()) {
return;
}
- const canvas = element;
const ctx = canvas.getContext("2d");
- canvas.width = element.offsetWidth;
- canvas.height = element.offsetHeight;
+ canvas.width = canvas.offsetWidth;
+ canvas.height = canvas.offsetHeight;
const characters =
"01アイウエオカキクケコサシスセソタチツテトナニヌネノハヒフヘホマミムメモヤユヨラリルレロワヲン";
@@ -86,104 +44,97 @@ export default class AiUsage extends Component {
}
};
- this.matrixInterval = setInterval(draw, 33);
- }
+ const interval = setInterval(draw, 33);
+ return () => clearInterval(interval);
+ });
@action
- cleanupMatrix() {
- if (this.matrixInterval) {
- clearInterval(this.matrixInterval);
- }
+ formatFeatureName(featureName) {
+ return featureName.replace(/_/g, " ");
}
<template>
- {{#if this.minimumDataThresholdMet}}
- <div class="rewind-report-page --ai-usage">
- <div class="matrix-container">
- <canvas
- class="matrix-rain"
- {{didInsert this.setupMatrix}}
- {{willDestroy this.cleanupMatrix}}
- ></canvas>
-
- <div class="matrix-content">
- <h2 class="matrix-title">
- <div class="matrix-subhead">
- {{i18n
- "discourse_rewind.reports.ai_usage.wake_up"
- }}
+ <div class="rewind-report-page --ai-usage">
+ <div class="matrix-container">
+ <canvas class="matrix-rain" {{this.matrixRain}}></canvas>
+
+ <div class="matrix-content">
+ <h2 class="matrix-title">
+ <div class="matrix-subhead">
+ {{i18n
+ "discourse_rewind.reports.ai_usage.wake_up"
+ }}
+ </div>
+ {{i18n "discourse_rewind.reports.ai_usage.system_title"}}
+ </h2>
+
+ <div class="matrix-stats">
+ <div class="matrix-stat">
+ <div class="matrix-stat__label">
+ {{i18n "discourse_rewind.reports.ai_usage.total_requests"}}
+ </div>
+ <div class="matrix-stat__value">
+ {{dNumber @report.data.total_requests}}
</div>
- {{i18n "discourse_rewind.reports.ai_usage.system_title"}}
- </h2>
-
- <div class="matrix-stats">
- <div class="matrix-stat">
- <div class="matrix-stat__label">
- {{i18n "discourse_rewind.reports.ai_usage.total_requests"}}
- </div>
- <div class="matrix-stat__value">
- {{dNumber this.totalRequests}}
- </div>
+ </div>
+
+ <div class="matrix-stat">
+ <div class="matrix-stat__label">
+ {{i18n "discourse_rewind.reports.ai_usage.total_tokens"}}
</div>
+ <div class="matrix-stat__value">{{dNumber
+ @report.data.total_tokens
+ }}</div>
+ </div>
- <div class="matrix-stat">
- <div class="matrix-stat__label">
- {{i18n "discourse_rewind.reports.ai_usage.total_tokens"}}
- </div>
- <div class="matrix-stat__value">{{dNumber
- this.totalTokens
- }}</div>
+ <div class="matrix-stat">
+ <div class="matrix-stat__label">
+ {{i18n "discourse_rewind.reports.ai_usage.success_rate"}}
</div>
+ <div class="matrix-stat__value">
+ <span class="number">
+ {{@report.data.success_rate}}%
+ </span>
+ </div>
+ </div>
+ </div>
- <div class="matrix-stat">
- <div class="matrix-stat__label">
- {{i18n "discourse_rewind.reports.ai_usage.success_rate"}}
- </div>
- <div class="matrix-stat__value">
- <span class="number">
- {{this.successRate}}%
- </span>
- </div>
+ {{#if @report.data.feature_usage.length}}
+ <div class="matrix-section">
+ <div class="matrix-section__title">&gt;
+ {{i18n "discourse_rewind.reports.ai_usage.section_features"}}
+ </div>
+ <div class="matrix-list">
+ {{#each @report.data.feature_usage as |entry|}}
+ <div class="matrix-list__item">
+ <span class="matrix-list__name">
+ {{this.formatFeatureName entry.name}}
+ </span>
+ <span class="matrix-list__count">{{entry.count}}</span>
+ </div>
+ {{/each}}
</div>
</div>
+ {{/if}}
- {{#if this.featureUsage.length}}
- <div class="matrix-section">
- <div class="matrix-section__title">&gt;
- {{i18n "discourse_rewind.reports.ai_usage.section_features"}}
- </div>
- <div class="matrix-list">
- {{#each this.featureUsage as |entry|}}
- <div class="matrix-list__item">
- <span class="matrix-list__name">
- {{this.formatFeatureName (get entry "0")}}
- </span>
- <span class="matrix-list__count">{{get entry "1"}}</span>
- </div>
- {{/each}}
- </div>
+ {{#if @report.data.model_usage.length}}
+ <div class="matrix-section">
+ <div class="matrix-section__title">&gt;
+ {{i18n "discourse_rewind.reports.ai_usage.section_models"}}
</div>
- {{/if}}
-
- {{#if this.modelUsage.length}}
- <div class="matrix-section">
- <div class="matrix-section__title">&gt;
- {{i18n "discourse_rewind.reports.ai_usage.section_models"}}
- </div>
- <div class="matrix-list">
- {{#each this.modelUsage as |entry|}}
- <div class="matrix-list__item">
- <span class="matrix-list__name">{{get entry "0"}}</span>
- <span class="matrix-list__count">{{get entry "1"}}</span>
- </div>
- {{/each}}
- </div>
+ <div class="matrix-list">
+ {{#each @report.data.model_usage as |entry|}}
+ <div class="matrix-list__item">
+ <span class="matrix-list__name">{{entry.name}}</span>
+ <span class="matrix-list__count">{{entry.count}}</span>
+ </div>
+ {{/each}}
</div>
- {{/if}}
- </div>
+ </div>
+ {{/if}}
</div>
</div>
- {{/if}}
+ </div>
</template>
}
diff --git a/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/assignments.gjs b/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/assignments.gjs
index 69d5ac9c30f..4194a0bc438 100644
--- a/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/assignments.gjs
+++ b/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/assignments.gjs
@@ -4,14 +4,6 @@ import { i18n } from "discourse-i18n";
import { i18nForOwner } from "discourse/plugins/discourse-rewind/discourse/lib/rewind-i18n";
export default class Assignments extends Component {
- get minimumDataThresholdMet() {
- return (
- (this.args.report.data.completed > 0 ||
- this.args.report.data.pending > 0) &&
- this.args.report.data.total_assigned > 0
- );
- }
-
get totalAssignedText() {
return i18nForOwner(
"discourse_rewind.reports.assignments.total_assigned",
@@ -21,65 +13,63 @@ export default class Assignments extends Component {
}
<template>
- {{#if this.minimumDataThresholdMet}}
- <div class="rewind-report-page --assignments">
- <div class="sticky-board">
- <div class="sticky-note --yellow --rotate-left">
- <div class="sticky-note__content">
- <div class="sticky-note__title">
- {{i18n "discourse_rewind.reports.assignments.completed"}}
- </div>
- <div class="sticky-note__value">
- {{dNumber @report.data.completed}}
- </div>
+ <div class="rewind-report-page --assignments">
+ <div class="sticky-board">
+ <div class="sticky-note --yellow --rotate-left">
+ <div class="sticky-note__content">
+ <div class="sticky-note__title">
+ {{i18n "discourse_rewind.reports.assignments.completed"}}
+ </div>
+ <div class="sticky-note__value">
+ {{dNumber @report.data.completed}}
</div>
</div>
+ </div>
- <div class="sticky-note --pink --rotate-right">
- <div class="sticky-note__content">
- <div class="sticky-note__title">
- {{i18n "discourse_rewind.reports.assignments.pending"}}
- </div>
- <div class="sticky-note__value">{{dNumber
- @report.data.pending
- }}</div>
+ <div class="sticky-note --pink --rotate-right">
+ <div class="sticky-note__content">
+ <div class="sticky-note__title">
+ {{i18n "discourse_rewind.reports.assignments.pending"}}
</div>
+ <div class="sticky-note__value">{{dNumber
+ @report.data.pending
+ }}</div>
</div>
+ </div>
- <div class="sticky-note --blue --rotate-left-small">
- <div class="sticky-note__content">
- <div class="sticky-note__title">
- {{this.totalAssignedText}}
- </div>
- <div class="sticky-note__value">
- {{dNumber @report.data.total_assigned}}
- </div>
+ <div class="sticky-note --blue --rotate-left-small">
+ <div class="sticky-note__content">
+ <div class="sticky-note__title">
+ {{this.totalAssignedText}}
+ </div>
+ <div class="sticky-note__value">
+ {{dNumber @report.data.total_assigned}}
</div>
</div>
+ </div>
- <div class="sticky-note --green --rotate-right-small">
- <div class="sticky-note__content">
- <div class="sticky-note__title">
- {{i18n "discourse_rewind.reports.assignments.assigned_by_user"}}
- </div>
- <div class="sticky-note__value">
- {{dNumber @report.data.assigned_by_user}}
- </div>
+ <div class="sticky-note --green --rotate-right-small">
+ <div class="sticky-note__content">
+ <div class="sticky-note__title">
+ {{i18n "discourse_rewind.reports.assignments.assigned_by_user"}}
+ </div>
+ <div class="sticky-note__value">
+ {{dNumber @report.data.assigned_by_user}}
</div>
</div>
+ </div>
- <div class="sticky-note --orange">
- <div class="sticky-note__content">
- <div class="sticky-note__title">
- {{i18n "discourse_rewind.reports.assignments.completion_rate"}}
- </div>
- <div
- class="sticky-note__value"
- >{{@report.data.completion_rate}}%</div>
+ <div class="sticky-note --orange">
+ <div class="sticky-note__content">
+ <div class="sticky-note__title">
+ {{i18n "discourse_rewind.reports.assignments.completion_rate"}}
</div>
+ <div
+ class="sticky-note__value"
+ >{{@report.data.completion_rate}}%</div>
</div>
</div>
</div>
- {{/if}}
+ </div>
</template>
}
diff --git a/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/chat-usage.gjs b/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/chat-usage.gjs
index 88a0f74baee..fb108eff594 100644
--- a/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/chat-usage.gjs
+++ b/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/chat-usage.gjs
@@ -40,18 +40,6 @@ const UserMessage = <template>
</template>;
export default class ChatUsage extends Component {
- get favoriteChannels() {
- return this.args.report.data.favorite_channels ?? [];
- }
-
- get minimumDataThresholdMet() {
- return (
- this.args.report.data.total_messages >= 20 &&
- this.args.report.data.unique_dm_channels >= 2 &&
- this.args.report.data.favorite_channels.length >= 1
- );
- }
-
get authorText() {
return i18nForOwner(
"discourse_rewind.reports.chat_usage.author",
@@ -88,106 +76,104 @@ export default class ChatUsage extends Component {
});
}
- get message5Text() {
- return i18n("discourse_rewind.reports.chat_usage.message_5");
- }
-
<template>
- {{#if this.minimumDataThresholdMet}}
- <div class="rewind-report-page --chat-usage">
- <h2 class="rewind-report-title">{{i18n
- "discourse_rewind.reports.chat_usage.title"
- }}</h2>
-
- <div class="chat-window">
- <div class="chat-window__header">
- <span class="chat-window__title">
- {{i18n "discourse_rewind.reports.chat_usage.channel_title"}}
- </span>
- <span class="chat-window__status">
- {{i18n "discourse_rewind.reports.chat_usage.status_online"}}
- </span>
+ <div class="rewind-report-page --chat-usage">
+ <h2 class="rewind-report-title">{{i18n
+ "discourse_rewind.reports.chat_usage.title"
+ }}</h2>
+
+ <div class="chat-window">
+ <div class="chat-window__header">
+ <span class="chat-window__title">
+ {{i18n "discourse_rewind.reports.chat_usage.channel_title"}}
+ </span>
+ <span class="chat-window__status">
+ {{i18n "discourse_rewind.reports.chat_usage.status_online"}}
+ </span>
+ </div>
+
+ <div class="chat-window__messages">
+ <div class="chat-message --left">
+ <BotMessage @message={{this.message1Text}} />
</div>
- <div class="chat-window__messages">
- <div class="chat-message --left">
- <BotMessage @message={{trustHTML this.message1Text}} />
- </div>
+ <div class="chat-message --right">
+ <UserMessage
+ @authorText={{this.authorText}}
+ @replyKey="reply_1"
+ @user={{@user}}
+ />
+ </div>
- <div class="chat-message --right">
- <UserMessage
- @authorText={{this.authorText}}
- @replyKey="reply_1"
- @user={{@user}}
- />
- </div>
+ <div class="chat-message --left">
+ <BotMessage @message={{this.message2Text}} />
+ </div>
- <div class="chat-message --left">
- <BotMessage @message={{trustHTML this.message2Text}} />
- </div>
+ <div class="chat-message --right">
+ <UserMessage
+ @authorText={{this.authorText}}
+ @replyKey="reply_2"
+ @user={{@user}}
+ />
+ </div>
- <div class="chat-message --right">
- <UserMessage
- @authorText={{this.authorText}}
- @replyKey="reply_2"
- @user={{@user}}
- />
- </div>
+ <div class="chat-message --left">
+ <BotMessage @message={{this.message3Text}} />
+ </div>
- <div class="chat-message --left">
- <BotMessage @message={{trustHTML this.message3Text}} />
- </div>
+ <div class="chat-message --right">
+ <UserMessage
+ @authorText={{this.authorText}}
+ @replyKey="reply_3"
+ @user={{@user}}
+ />
+ </div>
- <div class="chat-message --right">
- <UserMessage
- @authorText={{this.authorText}}
- @replyKey="reply_3"
- @user={{@user}}
- />
- </div>
+ <div class="chat-message --left">
+ <BotMessage @message={{this.message4Text}} />
+ </div>
+ {{#if @report.data.favorite_channels.length}}
<div class="chat-message --left">
- <BotMessage @message={{trustHTML this.message4Text}} />
- </div>
-
- {{#if this.favoriteChannels.length}}
- <div class="chat-message --left">
- <BotMessage @message={{this.message5Text}}>
- <div class="chat-message__channels">
- {{#each this.favoriteChannels as |channel|}}
- <a
- class="chat-channel-link"
- href={{getURL (concat "/chat/c/-/" channel.channel_id)}}
- >
- <span
- class="chat-channel-link__name"
- >#{{channel.channel_slug}}</span>
- <span class="chat-channel-link__count">
- {{dNumber channel.message_count}}
- </span>
- </a>
- {{/each}}
- </div>
- </BotMessage>
- </div>
- {{/if}}
-
- <div class="chat-message --right">
- <UserMessage @authorText={{this.authorText}} @user={{@user}}>
- <img
- alt={{i18n
- "discourse_rewind.reports.chat_usage.dancing_baby_alt"
- }}
- class="chat-message__gif"
- src={{getURL
- "/plugins/discourse-rewind/images/dancing_baby.gif"
- }}
- />
- </UserMessage>
+ <BotMessage
+ @message={{i18n
+ "discourse_rewind.reports.chat_usage.message_5"
+ }}
+ >
+ <div class="chat-message__channels">
+ {{#each @report.data.favorite_channels as |channel|}}
+ <a
+ class="chat-channel-link"
+ href={{getURL (concat "/chat/c/-/" channel.channel_id)}}
+ >
+ <span
+ class="chat-channel-link__name"
+ >#{{channel.channel_slug}}</span>
+ <span class="chat-channel-link__count">
+ {{dNumber channel.message_count}}
+ </span>
+ </a>
+ {{/each}}
+ </div>
+ </BotMessage>
</div>
+ {{/if}}
+
+ <div class="chat-message --right">
+ <UserMessage @authorText={{this.authorText}} @user={{@user}}>
+ <img
+ alt={{i18n
+ "discourse_rewind.reports.chat_usage.dancing_baby_alt"
+ }}
+ class="chat-message__gif"
+ src={{getURL
+ "/plugins/discourse-rewind/images/dancing_baby.gif"
+ }}
+ />
+ </UserMessage>
</div>
</div>
</div>
- {{/if}}
+ </div>
</template>
}
diff --git a/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/invites.gjs b/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/invites.gjs
index 1d6215f268e..63f9320bcfa 100644
--- a/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/invites.gjs
+++ b/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/invites.gjs
@@ -1,6 +1,5 @@
import Component from "@glimmer/component";
-import { concat } from "@ember/helper";
-import getURL from "discourse/lib/get-url";
+import { userPath } from "discourse/lib/url";
import dBoundAvatarTemplate from "discourse/ui-kit/helpers/d-bound-avatar-template";
import dNumber from "discourse/ui-kit/helpers/d-number";
import { i18n } from "discourse-i18n";
@@ -11,14 +10,6 @@ export default class Invites extends Component {
return this.args.report.data.most_active_invitee;
}
- get minimumDataThresholdMet() {
- return (
- this.args.report.data.total_invites >= 2 &&
- this.args.report.data.redeemed_count >= 1 &&
- this.args.report.data.invitee_post_count >= 5
- );
- }
-
get subtitleText() {
return i18nForOwner(
"discourse_rewind.reports.invites.guest_book_subtitle",
@@ -28,115 +19,107 @@ export default class Invites extends Component {
}
<template>
- {{#if this.minimumDataThresholdMet}}
- <div class="rewind-report-page --invites">
- <div class="guest-book">
- <div class="guest-book__cover">
- <div class="guest-book__title">
- {{i18n "discourse_rewind.reports.invites.guest_book_title"}}
+ <div class="rewind-report-page --invites">
+ <div class="guest-book">
+ <div class="guest-book__cover">
+ <div class="guest-book__title">
+ {{i18n "discourse_rewind.reports.invites.guest_book_title"}}
+ </div>
+ <div class="guest-book__subtitle">
+ {{this.subtitleText}}
+ </div>
+ </div>
+
+ <div class="guest-book__page">
+ <div class="guest-book__entry">
+ <div class="guest-book__entry-label">
+ {{i18n "discourse_rewind.reports.invites.label_invitations_sent"}}
</div>
- <div class="guest-book__subtitle">
- {{this.subtitleText}}
+ <div class="guest-book__entry-value">
+ {{dNumber @report.data.total_invites}}
</div>
</div>
- <div class="guest-book__page">
- <div class="guest-book__entry">
- <div class="guest-book__entry-label">
- {{i18n
- "discourse_rewind.reports.invites.label_invitations_sent"
- }}
- </div>
- <div class="guest-book__entry-value">
- {{dNumber @report.data.total_invites}}
- </div>
+ <div class="guest-book__entry">
+ <div class="guest-book__entry-label">
+ {{i18n "discourse_rewind.reports.invites.label_guests_joined"}}
</div>
-
- <div class="guest-book__entry">
- <div class="guest-book__entry-label">
- {{i18n "discourse_rewind.reports.invites.label_guests_joined"}}
- </div>
- <div class="guest-book__entry-value">
- {{dNumber @report.data.redeemed_count}}
- </div>
+ <div class="guest-book__entry-value">
+ {{dNumber @report.data.redeemed_count}}
</div>
+ </div>
- <div class="guest-book__entry">
- <div class="guest-book__entry-label">
- {{i18n
- "discourse_rewind.reports.invites.label_acceptance_rate"
- }}
- </div>
- <div class="guest-book__entry-value">
- {{@report.data.redemption_rate}}%
- </div>
+ <div class="guest-book__entry">
+ <div class="guest-book__entry-label">
+ {{i18n "discourse_rewind.reports.invites.label_acceptance_rate"}}
</div>
+ <div class="guest-book__entry-value">
+ {{@report.data.redemption_rate}}%
+ </div>
+ </div>
- <div class="guest-book__divider"></div>
+ <div class="guest-book__divider"></div>
- <div class="guest-book__section-title">
- {{i18n "discourse_rewind.reports.invites.section_contributions"}}
- </div>
+ <div class="guest-book__section-title">
+ {{i18n "discourse_rewind.reports.invites.section_contributions"}}
+ </div>
- <div class="guest-book__entry --small">
- <div class="guest-book__entry-label">
- {{i18n "discourse_rewind.reports.invites.label_posts_written"}}
- </div>
- <div class="guest-book__entry-value">
- {{dNumber @report.data.invitee_post_count}}
- </div>
+ <div class="guest-book__entry --small">
+ <div class="guest-book__entry-label">
+ {{i18n "discourse_rewind.reports.invites.label_posts_written"}}
</div>
-
- <div class="guest-book__entry --small">
- <div class="guest-book__entry-label">
- {{i18n "discourse_rewind.reports.invites.label_topics_started"}}
- </div>
- <div class="guest-book__entry-value">
- {{dNumber @report.data.invitee_topic_count}}
- </div>
+ <div class="guest-book__entry-value">
+ {{dNumber @report.data.invitee_post_count}}
</div>
+ </div>
- <div class="guest-book__entry --small">
- <div class="guest-book__entry-label">
- {{i18n "discourse_rewind.reports.invites.label_likes_given"}}
- </div>
- <div class="guest-book__entry-value">
- {{dNumber @report.data.invitee_like_count}}
- </div>
+ <div class="guest-book__entry --small">
+ <div class="guest-book__entry-label">
+ {{i18n "discourse_rewind.reports.invites.label_topics_started"}}
+ </div>
+ <div class="guest-book__entry-value">
+ {{dNumber @report.data.invitee_topic_count}}
</div>
+ </div>
- {{#if this.mostActiveInvitee}}
- <div class="guest-book__divider"></div>
+ <div class="guest-book__entry --small">
+ <div class="guest-book__entry-label">
+ {{i18n "discourse_rewind.reports.invites.label_likes_given"}}
+ </div>
+ <div class="guest-book__entry-value">
+ {{dNumber @report.data.invitee_like_count}}
+ </div>
+ </div>
- <div class="guest-book__section-title">
- {{i18n "discourse_rewind.reports.invites.section_most_active"}}
- </div>
+ <div class="guest-book__divider"></div>
- <a
- class="guest-book__signature"
- href={{getURL (concat "/u/" this.mostActiveInvitee.username)}}
- >
- {{dBoundAvatarTemplate
- this.mostActiveInvitee.avatar_template
- "large"
- username=this.mostActiveInvitee.username
- name=this.mostActiveInvitee.name
- }}
- <div class="guest-book__signature-info">
- <span class="guest-book__signature-name">
- {{this.mostActiveInvitee.username}}
- </span>
- {{#if this.mostActiveInvitee.name}}
- <span class="guest-book__signature-realname">
- {{this.mostActiveInvitee.name}}
- </span>
- {{/if}}
- </div>
- </a>
- {{/if}}
+ <div class="guest-book__section-title">
+ {{i18n "discourse_rewind.reports.invites.section_most_active"}}
</div>
+
+ <a
+ class="guest-book__signature"
+ href={{userPath this.mostActiveInvitee.username}}
+ >
+ {{dBoundAvatarTemplate
+ this.mostActiveInvitee.avatar_template
+ "large"
+ username=this.mostActiveInvitee.username
+ name=this.mostActiveInvitee.name
+ }}
+ <div class="guest-book__signature-info">
+ <span class="guest-book__signature-name">
+ {{this.mostActiveInvitee.username}}
+ </span>
+ {{#if this.mostActiveInvitee.name}}
+ <span class="guest-book__signature-realname">
+ {{this.mostActiveInvitee.name}}
+ </span>
+ {{/if}}
+ </div>
+ </a>
</div>
</div>
- {{/if}}
+ </div>
</template>
}
diff --git a/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/writing-analysis.gjs b/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/writing-analysis.gjs
index d321649dd56..735bf102b9e 100644
--- a/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/writing-analysis.gjs
+++ b/plugins/discourse-rewind/assets/javascripts/discourse/components/reports/writing-analysis.gjs
@@ -1,9 +1,8 @@
import Component from "@glimmer/component";
import { tracked } from "@glimmer/tracking";
-import { action } from "@ember/object";
-import didInsert from "@ember/render-modifiers/modifiers/did-insert";
-import willDestroy from "@ember/render-modifiers/modifiers/will-destroy";
import { service } from "@ember/service";
+import { modifier } from "ember-modifier";
+import { bind } from "discourse/lib/decorators";
import dNumber from "discourse/ui-kit/helpers/d-number";
import { i18n } from "discourse-i18n";
@@ -14,57 +13,22 @@ export default class WritingAnalysis extends Component {
terminalColors = ["#0f0", "#ffbf00", "#00ffff", "#ff00ff"];
- constructor() {
- super(...arguments);
- this.handleKeyDown = this.handleKeyDown.bind(this);
- }
+ keyListener = modifier(() => {
+ document.addEventListener("keydown", this.handleKeyDown);
+ return () => document.removeEventListener("keydown", this.handleKeyDown);
+ });
get scoreLabel() {
const score = this.args.report.data.readability_score;
+ const bucket = [80, 60, 40, 20].find((min) => score >= min) ?? 0;
const randomNum = Math.floor(Math.random() * 4) + 1;
- switch (true) {
- case score >= 80 && score <= 100:
- return i18n(
- `discourse_rewind.reports.writing_analysis.readability_score.over_80.${randomNum}`
- );
- case score >= 60 && score < 80:
- return i18n(
- `discourse_rewind.reports.writing_analysis.readability_score.over_60.${randomNum}`
- );
- case score >= 40 && score < 60:
- return i18n(
- `discourse_rewind.reports.writing_analysis.readability_score.over_40.${randomNum}`
- );
- case score >= 20 && score < 40:
- return i18n(
- `discourse_rewind.reports.writing_analysis.readability_score.over_20.${randomNum}`
- );
- default:
- return i18n(
- `discourse_rewind.reports.writing_analysis.readability_score.over_0.${randomNum}`
- );
- }
- }
-
- get minimumDataThresholdMet() {
- return (
- this.args.report.data.total_words >= 100 &&
- this.args.report.data.total_posts >= 5
+ return i18n(
+ `discourse_rewind.reports.writing_analysis.readability_score.over_${bucket}.${randomNum}`
);
}
- @action
- setupKeyListener(element) {
- document.addEventListener("keydown", this.handleKeyDown);
- this.element = element;
- }
-
- @action
- teardownKeyListener() {
- document.removeEventListener("keydown", this.handleKeyDown);
- }
-
+ @bind
handleKeyDown(event) {
if (event.key === "F1") {
event.preventDefault();
@@ -72,7 +36,6 @@ export default class WritingAnalysis extends Component {
}
}
- @action
cycleColor() {
this.currentColorIndex =
(this.currentColorIndex + 1) % this.terminalColors.length;
@@ -81,106 +44,100 @@ export default class WritingAnalysis extends Component {
}
<template>
- {{#if this.minimumDataThresholdMet}}
- <div
- class="rewind-report-page --writing-analysis"
- {{didInsert this.setupKeyListener}}
- {{willDestroy this.teardownKeyListener}}
- >
- <h2 class="rewind-report-title">
- {{i18n "discourse_rewind.reports.writing_analysis.title"}}
- </h2>
-
- <div class="writing-analysis">
-
- <div class="writing-analysis__menubar">
- <span class="writing-analysis__menu-item">{{i18n
- "discourse_rewind.reports.writing_analysis.menu_file"
- }}</span>
- <span class="writing-analysis__menu-item">{{i18n
- "discourse_rewind.reports.writing_analysis.menu_other"
- }}</span>
- <span class="writing-analysis__menu-item">{{i18n
- "discourse_rewind.reports.writing_analysis.menu_additional"
- }}</span>
- <span
- class="writing-analysis__menu-item writing-analysis__menu-item--right"
- >{{i18n
- "discourse_rewind.reports.writing_analysis.menu_opening"
- }}</span>
- </div>
+ <div class="rewind-report-page --writing-analysis" {{this.keyListener}}>
+ <h2 class="rewind-report-title">
+ {{i18n "discourse_rewind.reports.writing_analysis.title"}}
+ </h2>
+
+ <div class="writing-analysis">
+
+ <div class="writing-analysis__menubar">
+ <span class="writing-analysis__menu-item">{{i18n
+ "discourse_rewind.reports.writing_analysis.menu_file"
+ }}</span>
+ <span class="writing-analysis__menu-item">{{i18n
+ "discourse_rewind.reports.writing_analysis.menu_other"
+ }}</span>
+ <span class="writing-analysis__menu-item">{{i18n
+ "discourse_rewind.reports.writing_analysis.menu_additional"
+ }}</span>
+ <span
+ class="writing-analysis__menu-item writing-analysis__menu-item--right"
+ >{{i18n
+ "discourse_rewind.reports.writing_analysis.menu_opening"
+ }}</span>
+ </div>
- <div class="writing-analysis__frame">
+ <div class="writing-analysis__frame">
- <div class="writing-analysis__header-row">
+ <div class="writing-analysis__header-row">
- <div class="writing-analysis__helpbox">
- {{i18n "discourse_rewind.reports.writing_analysis.help_text"}}
- </div>
+ <div class="writing-analysis__helpbox">
+ {{i18n "discourse_rewind.reports.writing_analysis.help_text"}}
+ </div>
- <div class="writing-analysis__release">
- <div class="writing-analysis__release-name">{{i18n
- "discourse_rewind.reports.writing_analysis.app_name"
- }}</div>
- <div class="writing-analysis__release-meta">
- {{i18n
- "discourse_rewind.reports.writing_analysis.release_info"
- rewindYear=this.rewind.fetchRewindYear
- }}
- <span>&lt;3</span>
- </div>
+ <div class="writing-analysis__release">
+ <div class="writing-analysis__release-name">{{i18n
+ "discourse_rewind.reports.writing_analysis.app_name"
+ }}</div>
+ <div class="writing-analysis__release-meta">
+ {{i18n
+ "discourse_rewind.reports.writing_analysis.release_info"
+ rewindYear=this.rewind.fetchRewindYear
+ }}
+ <span>&lt;3</span>
</div>
-
</div>
- <div class="writing-analysis__stats">
-
- <div class="writing-analysis__stats-col">
- <div class="writing-analysis__stats-label">{{i18n
- "discourse_rewind.reports.writing_analysis.total_words"
- }}</div>
- <div
- class="writing-analysis__stats-value"
- >{{@report.data.total_words}}</div>
-
- <div class="writing-analysis__stats-label">{{i18n
- "discourse_rewind.reports.writing_analysis.total_posts"
- }}</div>
- <div
- class="writing-analysis__stats-value"
- >{{@report.data.total_posts}}</div>
- </div>
+ </div>
- <div class="writing-analysis__stats-col">
- <div class="writing-analysis__stats-label">{{i18n
- "discourse_rewind.reports.writing_analysis.avg_post_length"
- }}</div>
- <div class="writing-analysis__stats-value">{{dNumber
- @report.data.average_post_length
- }}</div>
-
- <div class="writing-analysis__stats-label">{{i18n
- "discourse_rewind.reports.writing_analysis.readability_score_label"
- }}</div>
- <div class="writing-analysis__stats-value">{{dNumber
- @report.data.readability_score
- }}/100</div>
- </div>
+ <div class="writing-analysis__stats">
+
+ <div class="writing-analysis__stats-col">
+ <div class="writing-analysis__stats-label">{{i18n
+ "discourse_rewind.reports.writing_analysis.total_words"
+ }}</div>
+ <div class="writing-analysis__stats-value">{{dNumber
+ @report.data.total_words
+ }}</div>
+
+ <div class="writing-analysis__stats-label">{{i18n
+ "discourse_rewind.reports.writing_analysis.total_posts"
+ }}</div>
+ <div class="writing-analysis__stats-value">{{dNumber
+ @report.data.total_posts
+ }}</div>
+ </div>
- <div class="writing-analysis__stats-col">
- <div class="writing-analysis__stats-label">{{i18n
- "discourse_rewind.reports.writing_analysis.readability_level"
- }}</div>
- <div
- class="writing-analysis__stats-value"
- >{{this.scoreLabel}}</div>
- </div>
+ <div class="writing-analysis__stats-col">
+ <div class="writing-analysis__stats-label">{{i18n
+ "discourse_rewind.reports.writing_analysis.avg_post_length"
+ }}</div>
+ <div class="writing-analysis__stats-value">{{dNumber
+ @report.data.average_post_length
+ }}</div>
+
+ <div class="writing-analysis__stats-label">{{i18n
+ "discourse_rewind.reports.writing_analysis.readability_score_label"
+ }}</div>
+ <div class="writing-analysis__stats-value">{{dNumber
+ @report.data.readability_score
+ }}/100</div>
+ </div>
+ <div class="writing-analysis__stats-col">
+ <div class="writing-analysis__stats-label">{{i18n
+ "discourse_rewind.reports.writing_analysis.readability_level"
+ }}</div>
+ <div
+ class="writing-analysis__stats-value"
+ >{{this.scoreLabel}}</div>
</div>
</div>
+
</div>
</div>
- {{/if}}
+ </div>
</template>
}
diff --git a/plugins/discourse-rewind/spec/actions/ai_usage_spec.rb b/plugins/discourse-rewind/spec/actions/ai_usage_spec.rb
index 5ee60434f61..7170146119c 100644
--- a/plugins/discourse-rewind/spec/actions/ai_usage_spec.rb
+++ b/plugins/discourse-rewind/spec/actions/ai_usage_spec.rb
@@ -5,6 +5,20 @@ RSpec.describe DiscourseRewind::Action::AiUsage do
before { SiteSetting.discourse_ai_enabled = true }
+ describe ".call" do
+ it "returns nothing when there is too little usage to show" do
+ AiApiRequestStat.create!(
+ user_id: user.id,
+ bucket_date: random_datetime,
+ provider_id: 1,
+ request_tokens: 10,
+ response_tokens: 10,
+ )
+
+ expect(call_report).to be_nil
+ end
+ end
+
describe ".filter_for_viewer" do
let(:report) do
{ data: { total_requests: 1, model_usage: [{ name: "secret-model", count: 1 }] } }
diff --git a/plugins/discourse-rewind/spec/actions/assignments_spec.rb b/plugins/discourse-rewind/spec/actions/assignments_spec.rb
new file mode 100644
index 00000000000..875d0004b1b
--- /dev/null
+++ b/plugins/discourse-rewind/spec/actions/assignments_spec.rb
@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+RSpec.describe DiscourseRewind::Action::Assignments do
+ fab!(:user)
+
+ before { SiteSetting.assign_enabled = true }
+
+ describe ".call" do
+ it "returns nothing when no assignment was made during the year" do
+ Fabricate(:topic_assignment, assigned_to: user, created_at: Date.new(2020, 6, 1))
+
+ expect(call_report).to be_nil
+ end
+
+ it "returns the assignment statistics" do
+ assigned_at = random_datetime
+ Fabricate(
+ :topic_assignment,
+ assigned_to: user,
+ created_at: assigned_at,
+ updated_at: assigned_at,
+ )
+ Fabricate(
+ :topic_assignment,
+ assigned_to: user,
+ topic: Fabricate(:topic, closed: true),
+ created_at: assigned_at,
+ updated_at: assigned_at,
+ )
+ Fabricate(:topic_assignment, assigned_to: user, active: false, created_at: assigned_at)
+ Fabricate(:topic_assignment, assigned_by_user: user, created_at: assigned_at)
+
+ expect(call_report[:data]).to eq(
+ total_assigned: 3,
+ completed: 2,
+ pending: 1,
+ assigned_by_user: 1,
+ completion_rate: 66.7,
+ )
+ end
+ end
+end
diff --git a/plugins/discourse-rewind/spec/actions/chat_usage_spec.rb b/plugins/discourse-rewind/spec/actions/chat_usage_spec.rb
index f728086b9ec..6dc4abceac1 100644
--- a/plugins/discourse-rewind/spec/actions/chat_usage_spec.rb
+++ b/plugins/discourse-rewind/spec/actions/chat_usage_spec.rb
@@ -1,7 +1,6 @@
# frozen_string_literal: true
RSpec.describe DiscourseRewind::Action::ChatUsage do
- fab!(:date) { Date.new(2021).all_year }
fab!(:user)
fab!(:public_category, :category)
fab!(:private_category) { Fabricate(:private_category, group: Fabricate(:group)) }
@@ -13,37 +12,60 @@ RSpec.describe DiscourseRewind::Action::ChatUsage do
describe ".call" do
context "with messages in public and private channels" do
before do
- 5.times do
+ 2.times do
Fabricate(
:chat_message,
chat_channel: public_channel,
- user: user,
+ user:,
+ message: "hi",
created_at: random_datetime,
)
end
-
- 3.times do
+ Fabricate(
+ :chat_message,
+ chat_channel: private_channel,
+ user:,
+ message: "hello",
+ created_at: random_datetime,
+ )
+ direct_message =
Fabricate(
:chat_message,
- chat_channel: private_channel,
- user: user,
+ chat_channel: Fabricate(:direct_message_channel, users: [user, Fabricate(:user)]),
+ user:,
+ message: "hey you",
created_at: random_datetime,
)
- end
+ Fabricate(:chat_message_reaction, chat_message: direct_message)
end
- it "only includes public channels in favorite_channels" do
- result = call_report
-
- expect(result[:data][:favorite_channels].length).to eq(1)
- expect(result[:data][:favorite_channels].first[:channel_id]).to eq(public_channel.id)
- expect(result[:data][:favorite_channels].first[:message_count]).to eq(5)
+ it "returns nothing when there is too little chat activity to show" do
+ expect(call_report).to be_nil
end
- it "includes all messages in total_messages count" do
- result = call_report
+ context "when above the minimum activity" do
+ around do |example|
+ stub_const(described_class, "MINIMUM_MESSAGES", 1) do
+ stub_const(described_class, "MINIMUM_DM_CHANNELS", 0) { example.run }
+ end
+ end
- expect(result[:data][:total_messages]).to eq(8)
+ it "returns the chat statistics, with only public channels as favorites" do
+ expect(call_report[:data]).to eq(
+ total_messages: 4,
+ favorite_channels: [
+ {
+ channel_id: public_channel.id,
+ channel_slug: public_channel.slug,
+ message_count: 2,
+ },
+ ],
+ dm_message_count: 1,
+ unique_dm_channels: 1,
+ total_reactions_received: 1,
+ avg_message_length: 4.0,
+ )
+ end
end
end
end
diff --git a/plugins/discourse-rewind/spec/actions/invites_spec.rb b/plugins/discourse-rewind/spec/actions/invites_spec.rb
index de7ff50f1fd..47fc05e20d5 100644
--- a/plugins/discourse-rewind/spec/actions/invites_spec.rb
+++ b/plugins/discourse-rewind/spec/actions/invites_spec.rb
@@ -3,6 +3,49 @@
RSpec.describe DiscourseRewind::Action::Invites do
fab!(:user)
+ describe ".call" do
+ it "returns nothing when there are too few invites to show" do
+ Fabricate(:invite, invited_by: user, created_at: random_datetime)
+
+ expect(call_report).to be_nil
+ end
+
+ it "returns the invite statistics" do
+ busy_invitee, quiet_invitee = Fabricate.times(2, :user)
+ redeemed_invite =
+ Fabricate(:invite, invited_by: user, redemption_count: 1, created_at: random_datetime)
+ Fabricate(:invite, invited_by: user, created_at: random_datetime)
+ [busy_invitee, quiet_invitee].each do |invitee|
+ Fabricate(:invited_user, invite: redeemed_invite, user: invitee, redeemed_at: Time.current)
+ end
+ 4.times { Fabricate(:post, user: busy_invitee, created_at: random_datetime) }
+ liked_post = Fabricate(:post, user: quiet_invitee, created_at: random_datetime)
+ [quiet_invitee, user].each do |author|
+ Fabricate(:topic, user: author, created_at: random_datetime)
+ end
+ [UserAction::LIKE, UserAction::WAS_LIKED].each do |action_type|
+ Fabricate(
+ :user_action,
+ action_type:,
+ user: quiet_invitee,
+ target_post: liked_post,
+ target_topic: liked_post.topic,
+ created_at: random_datetime,
+ )
+ end
+
+ expect(call_report[:data]).to eq(
+ total_invites: 2,
+ redeemed_count: 1,
+ redemption_rate: 50.0,
+ invitee_post_count: 5,
+ invitee_topic_count: 1,
+ invitee_like_count: 1,
+ most_active_invitee: BasicUserSerializer.new(busy_invitee, root: false).as_json,
+ )
+ end
+ end
+
describe ".filter_for_viewer" do
let(:report) { { data: { total_invites: 1 } } }
diff --git a/plugins/discourse-rewind/spec/actions/writing_analysis_spec.rb b/plugins/discourse-rewind/spec/actions/writing_analysis_spec.rb
index f4178ed51d9..54efe7dfb70 100644
--- a/plugins/discourse-rewind/spec/actions/writing_analysis_spec.rb
+++ b/plugins/discourse-rewind/spec/actions/writing_analysis_spec.rb
@@ -1,8 +1,7 @@
# frozen_string_literal: true
RSpec.describe DiscourseRewind::Action::WritingAnalysis do
- fab!(:date) { Date.new(2021).all_year }
- fab!(:user) { Fabricate(:user, refresh_auto_groups: true) }
+ fab!(:user)
fab!(:other_user, :user)
fab!(:post1) do
@@ -44,204 +43,46 @@ RSpec.describe DiscourseRewind::Action::WritingAnalysis do
end
describe ".call" do
- it "calculates total words correctly" do
- result = call_report
-
- expect(result[:data][:total_words]).to be > 0
- expect(result[:data][:total_words]).to eq(
- [post1, post2, post3].sum { |p| p.reload.word_count },
- )
- end
-
- it "calculates total posts correctly" do
- result = call_report
-
- expect(result[:data][:total_posts]).to eq(3)
- end
-
- it "calculates average post length correctly" do
- result = call_report
-
- total_words = [post1, post2, post3].sum { |p| p.reload.word_count }
- expected_avg = (total_words.to_f / 3).round(2)
-
- expect(result[:data][:average_post_length]).to eq(expected_avg)
- end
-
- it "calculates readability score" do
- result = call_report
-
- expect(result[:data][:readability_score]).to be_present
- expect(result[:data][:readability_score]).to be_a(Numeric)
- end
-
- it "returns correct identifier" do
- result = call_report
-
- expect(result[:identifier]).to eq("writing-analysis")
- end
-
- it "bounds readability score between 0 and 100" do
- result = call_report
-
- score = result[:data][:readability_score]
- expect(score).to be >= 0
- expect(score).to be <= 100
- end
-
- context "when user has posts with very long sentences" do
- fab!(:long_sentence_post) do
- Fabricate(
- :post,
- user: user,
- raw:
- "This is an extremely long sentence that goes on and on without any punctuation to break it up which would normally result in a very low readability score because readers generally find it difficult to follow sentences that contain too many clauses and ideas without pausing for breath or mental processing time",
- created_at: random_datetime,
- )
- end
-
- it "handles low readability scores" do
- result = call_report
-
- expect(result[:data][:readability_score]).to be >= 0
- end
- end
-
- context "when user has posts without punctuation" do
- fab!(:no_punctuation_post) do
- Fabricate(
- :post,
- user: user,
- raw: "Just some words without any sentence ending punctuation",
- created_at: random_datetime,
- )
- end
-
- it "treats posts as having at least one sentence" do
- result = call_report
-
- expect(result[:data][:readability_score]).to be_present
- end
- end
-
- context "when a post is deleted" do
- before { post1.trash!(Discourse.system_user) }
-
- it "does not include deleted posts in total posts" do
- result = call_report
-
- expect(result[:data][:total_posts]).to eq(2)
- end
-
- it "does not include deleted posts in total words" do
- result = call_report
-
- total_words = [post2, post3].sum { |p| p.reload.word_count }
-
- expect(result[:data][:total_words]).to eq(total_words)
- end
-
- it "does not include deleted posts in readability score calculation" do
- result_with_deletion = call_report
-
- post1.recover!
- result_without_deletion = call_report
-
- expect(result_with_deletion[:data][:readability_score]).not_to eq(
- result_without_deletion[:data][:readability_score],
- )
- end
+ it "returns nothing when there is too little writing to analyse" do
+ expect(call_report).to be_nil
end
- context "when a post's topic is deleted" do
- before { post1.topic.trash!(Discourse.system_user) }
-
- it "does not include deleted topic posts in total posts" do
- result = call_report
-
- expect(result[:data][:total_posts]).to eq(2)
+ context "when above the minimum writing volume" do
+ around do |example|
+ stub_const(described_class, "MINIMUM_WORDS", 1) do
+ stub_const(described_class, "MINIMUM_POSTS", 1) { example.run }
+ end
end
- it "does not include deleted topic posts in total words" do
- result = call_report
-
- total_words = [post2, post3].sum { |p| p.reload.word_count }
-
- expect(result[:data][:total_words]).to eq(total_words)
- end
-
- it "does not include deleted topic posts in readability score calculation" do
- result_with_deletion = call_report
-
- post1.topic.recover!
- result_without_deletion = call_report
-
- expect(result_with_deletion[:data][:readability_score]).not_to eq(
- result_without_deletion[:data][:readability_score],
+ it "returns the writing statistics" do
+ expect(call_report[:data]).to match(
+ total_words: 54,
+ total_posts: 3,
+ average_post_length: 18.0,
+ readability_score: be_within(0.0001).of(78.3569),
)
end
- end
-
- context "when posts are from another user" do
- it "does not include other users' posts in total posts" do
- result = call_report
- expect(result[:data][:total_posts]).to eq(3)
- end
+ it "treats unpunctuated text as one sentence and never scores below zero" do
+ writer = Fabricate(:user)
+ Fabricate(:post, user: writer, raw: "word " * 90, created_at: random_datetime)
- it "does not include other users' posts in total words" do
- result = call_report
+ report = described_class.call(user: writer, date:)
- expected_words = [post1, post2, post3].sum { |p| p.reload.word_count }
-
- expect(result[:data][:total_words]).to eq(expected_words)
+ expect(report[:data][:readability_score]).to eq(0)
end
- end
- context "when user has no posts" do
- fab!(:user_with_no_posts, :user)
- fab!(:date) { Date.new(2021).all_year }
+ it "ignores deleted posts, posts in deleted topics and other users' posts" do
+ post1.trash!(Discourse.system_user)
+ post2.topic.trash!(Discourse.system_user)
+ report = call_report
- it "returns zero values gracefully" do
- result = described_class.call(user: user_with_no_posts, date: date, guardian: user.guardian)
+ [post1, other_user_post].each(&:destroy!)
+ post2.topic.destroy!
- expect(result[:data][:total_words]).to be_nil
- expect(result[:data][:total_posts]).to eq(0)
- expect(result[:data][:average_post_length]).to eq(0)
- end
- end
-
- context "with posts containing HTML and markdown" do
- fab!(:formatted_post) do
- Fabricate(
- :post,
- user: user,
- raw:
- "**Bold text** and *italic text*. [A link](https://example.com) and some code `var x = 1;`",
- created_at: random_datetime,
- )
+ expect(report).to eq(call_report)
+ expect(report[:data][:total_posts]).to eq(1)
end
-
- it "strips HTML from readability calculation" do
- result = call_report
-
- expect(result[:data][:readability_score]).to be_present
- expect(result[:data][:readability_score]).to be > 0
- end
- end
- end
-
- context "when in rails development mode" do
- before { Rails.env.stubs(:development?).returns(true) }
-
- it "returns fake data" do
- result = call_report
-
- expect(result[:identifier]).to eq("writing-analysis")
- expect(result[:data][:total_words]).to eq(45_230)
- expect(result[:data][:total_posts]).to eq(197)
- expect(result[:data][:average_post_length]).to eq(230)
- expect(result[:data][:readability_score]).to eq(65.4)
end
end
end
diff --git a/plugins/discourse-rewind/spec/services/fetch_reports_spec.rb b/plugins/discourse-rewind/spec/services/fetch_reports_spec.rb
index dc3b3d35fcc..addeec54d17 100644
--- a/plugins/discourse-rewind/spec/services/fetch_reports_spec.rb
+++ b/plugins/discourse-rewind/spec/services/fetch_reports_spec.rb
@@ -19,11 +19,7 @@ RSpec.describe(DiscourseRewind::FetchReports) do
expect(result).to have_attributes(
year: 2021,
for_user: current_user,
- reports: [
- nil,
- include(identifier: "reading-time"),
- include(identifier: "writing-analysis"),
- ],
+ reports: [nil, include(identifier: "reading-time"), nil],
total_available: described_class.enabled_reports.size,
)
end
@@ -62,12 +58,12 @@ RSpec.describe(DiscourseRewind::FetchReports) do
.call(guardian:, params:)
.reports
.map { |report| report&.dig(:identifier) },
- ).to eq([nil, nil, "writing-analysis"])
+ ).to eq([nil, nil, nil])
DiscourseRewind::Action::ReadingTime.unstub(:call)
expect(result.reports.map { |report| report&.dig(:identifier) }).to eq(
- [nil, "reading-time", "writing-analysis"],
+ [nil, "reading-time", nil],
)
end
end