Merge pull request #294 from kortirso/issue_285

kortirso · web-flow · commit 33ebcb30c14a · 2024-05-04T22:44:27.000+03:00
IS-285 Conventional comments tracking
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+### Added
+- parsing body of comments with checking convention
+- rendering conventional comments count
+
 ### Modified
 - fetching commented and uniq accepted reviews from Github
 - calculating commented PRs
diff --git a/app/javascript/atoms/Insights/Insights.jsx b/app/javascript/atoms/Insights/Insights.jsx
@@ -5,6 +5,7 @@ import { Arrow } from '../../svg';
 const SHORT_INSIGHT_NAMES = {
   required_reviews_count: 'Req reviews',
   comments_count: 'Comments',
+  conventional_comments_count: 'Good comments',
   reviews_count: 'Reviews',
   bad_reviews_count: 'Bad reviews',
   review_involving: 'Involving',
@@ -21,6 +22,7 @@ const SHORT_INSIGHT_NAMES = {
 const INSIGHT_TOOLTIPS = {
   required_reviews_count: 'Required reviews',
   comments_count: 'Total comments',
+  conventional_comments_count: 'Good comments',
   reviews_count: 'Total reviews',
   bad_reviews_count: 'Total bad reviews',
   review_involving: 'Review involving',
diff --git a/app/javascript/atoms/Insights/RepositoryInsights.jsx b/app/javascript/atoms/Insights/RepositoryInsights.jsx
@@ -88,6 +88,7 @@ export const RepositoryInsights = ({ insightTypes, insights, ratioType }) => {
       <div className="p-4 rounded border border-stone-200">
         <h4 className="mb-4">Additional stats</h4>
         <p>Comments - {renderRepositoryInsight('comments_count')}</p>
+        <p>Good comments - {renderRepositoryInsight('conventional_comments_count')}</p>
         <p>Avg comments - {renderRepositoryInsight('average_comments_count')}</p>
         <p>Changed LOC - {renderRepositoryInsight('changed_loc')}</p>
         <p>Avg changed LOC - {renderRepositoryInsight('average_changed_loc')}</p>
diff --git a/app/models/insight.rb b/app/models/insight.rb
@@ -14,6 +14,7 @@ class Insight < ApplicationRecord
   SHORT_ATTRIBUTE_NAMES = {
     required_reviews_count: 'Required reviews',
     comments_count: 'Comments count',
+    conventional_comments_count: 'Good comments',
     reviews_count: 'Reviews count',
     bad_reviews_count: 'Bad reviews count',
     review_involving: 'Review involving',
diff --git a/app/models/jsonb_columns/configuration.rb b/app/models/jsonb_columns/configuration.rb
@@ -24,6 +24,7 @@ class Configuration
          %i[
            required_reviews_count
            comments_count
+           conventional_comments_count
            reviews_count
            bad_reviews_count
            average_review_seconds
diff --git a/app/models/jsonb_columns/insight.rb b/app/models/jsonb_columns/insight.rb
@@ -7,6 +7,7 @@ class Insight
     # attributes representing user reviewing
     attribute :required_reviews_count, :boolean
     attribute :comments_count, :boolean
+    attribute :conventional_comments_count, :boolean
     attribute :reviews_count, :boolean
     attribute :bad_reviews_count, :boolean
     attribute :review_involving, :boolean
diff --git a/app/models/repositories/insight.rb b/app/models/repositories/insight.rb
@@ -7,7 +7,7 @@ class Insight < ApplicationRecord
     DEFAULT_ATTRIBUTES = %i[
       open_pull_requests_count commented_pull_requests_count reviewed_pull_requests_count merged_pull_requests_count
       average_comment_time average_review_time average_merge_time
-      comments_count average_comments_count changed_loc average_changed_loc
+      comments_count conventional_comments_count average_comments_count changed_loc average_changed_loc
     ].freeze
     REVERSE_ORDER_ATTRIBUTES = %i[average_comment_time average_review_time average_merge_time].freeze
     DECIMAL_ATTRIBUTES = %i[average_comments_count average_changed_loc].freeze
diff --git a/app/services/import/concerns/comment_parseable.rb b/app/services/import/concerns/comment_parseable.rb
@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Import
+  module Concerns
+    module CommentParseable
+      COMMENT_MATCH_REGEXP = /\*\*(.*)\*\*\:(.*)/
+
+      private
+
+      def parse_comment_body(value)
+        return unless value
+        return if COMMENT_MATCH_REGEXP.match(value).nil?
+
+        header = value[/\*\*(.*)\*\*/, 1] # extract data between **...**
+        {
+          title: header.split.first,
+          subject: value[/\*\*:(.*)/, 1].strip, # extract data after **:...
+          decorations: header[/\((.*)\)/, 1]&.split(',')
+        }
+      end
+    end
+  end
+end
diff --git a/app/services/import/representers/github/comments.rb b/app/services/import/representers/github/comments.rb
@@ -5,14 +5,18 @@ module Representers
     module Github
       class Comments
         include Deps[entity_representer: 'services.import.representers.github.entity']
+        include Import::Concerns::CommentParseable
 
         def call(data:)
           data.map do |payload|
             payload = payload.with_indifferent_access
+            # payload [:reactions] contains hash
+            # "+1"=>0, "-1"=>0, "laugh"=>0, "hooray"=>0, "confused"=>0, "heart"=>0, "rocket"=>0, "eyes"=>0
             {
               external_id: payload[:id].to_s,
               comment_created_at: payload[:created_at],
-              author: entity_representer.call(data: payload[:user])
+              author: entity_representer.call(data: payload[:user]),
+              parsed_body: parse_comment_body(payload[:body]&.lines&.first)
             }
           end
         end
diff --git a/app/services/import/representers/gitlab/comments.rb b/app/services/import/representers/gitlab/comments.rb
@@ -5,14 +5,16 @@ module Representers
     module Gitlab
       class Comments
         include Deps[entity_representer: 'services.import.representers.gitlab.entity']
+        include Import::Concerns::CommentParseable
 
         def call(data:)
           data.map do |payload|
             payload = payload.with_indifferent_access
             {
               external_id: payload[:id].to_s,
               comment_created_at: payload[:created_at],
-              author: entity_representer.call(data: payload[:author])
+              author: entity_representer.call(data: payload[:author]),
+              parsed_body: parse_comment_body(payload[:body]&.lines&.first)
             }
           end
         end
diff --git a/app/services/import/savers/comments.rb b/app/services/import/savers/comments.rb
@@ -53,8 +53,9 @@ def existing_comments
 
       def create_comment(entity_id, payload)
         # commento: pull_requests_comments.external_id, pull_requests_comments.comment_created_at
+        # commento: pull_requests_comments.parsed_body
         @pull_request.pull_requests_comments.create!(
-          payload.slice(:external_id, :comment_created_at).merge(entity_id: entity_id)
+          payload.slice(:external_id, :comment_created_at, :parsed_body).merge(entity_id: entity_id)
         )
       end
     end
diff --git a/app/services/insights/generate/company_service.rb b/app/services/insights/generate/company_service.rb
@@ -21,6 +21,14 @@ def comments_count(date_from=@fetch_period, date_to=0)
         end
       end
 
+      def conventional_comments_count(date_from=@fetch_period, date_to=0)
+        @conventional_comments_count ||= {}
+
+        @conventional_comments_count.fetch("#{date_from},#{date_to}") do |key|
+          @conventional_comments_count[key] = sum_insights_attribute(date_to, :conventional_comments_count)
+        end
+      end
+
       def reviews_count(date_from=@fetch_period, date_to=0)
         @reviews_count ||= {}
 
@@ -91,6 +99,7 @@ def insights_data(date_to)
               .hashable_pluck(
                 :entity_id,
                 :comments_count,
+                :conventional_comments_count,
                 :reviews_count,
                 :bad_reviews_count,
                 :required_reviews_count,
diff --git a/app/services/insights/generate/repository_service.rb b/app/services/insights/generate/repository_service.rb
@@ -186,6 +186,14 @@ def repository_comments_count(date_from=@fetch_period, date_to=0)
         end
       end
 
+      def repository_conventional_comments_count(date_from=@fetch_period, date_to=0)
+        @repository_conventional_comments_count ||= {}
+
+        @repository_conventional_comments_count.fetch("#{date_from},#{date_to}") do |key|
+          @repository_conventional_comments_count[key] = conventional_comments_count(date_from, date_to).values.sum
+        end
+      end
+
       def repository_average_comments_count(date_from=@fetch_period, date_to=0)
         @repository_average_comments_count ||= {}
 
@@ -242,6 +250,18 @@ def comments_count(date_from=@fetch_period, date_to=0)
         end
       end
 
+      def conventional_comments_count(date_from=@fetch_period, date_to=0)
+        @conventional_comments_count ||= {}
+
+        @conventional_comments_count.fetch("#{date_from},#{date_to}") do |key|
+          @conventional_comments_count[key] =
+            PullRequests::Comment
+              .where(pull_request_id: pull_requests_ids(date_from, date_to))
+              .where.not(parsed_body: nil)
+              .group(:entity_id).count
+        end
+      end
+
       def reviews_count(date_from=@fetch_period, date_to=0)
         @reviews_count ||= {}
 
diff --git a/app/services/insights/generate_service.rb b/app/services/insights/generate_service.rb
@@ -82,6 +82,9 @@ def insight_fields
     # this method returns { entity_id => comments_count_by_entity }
     def comments_count(...) = raise NotImplementedError
 
+    # this method returns { entity_id => conventional_comments_count_by_entity }
+    def conventional_comments_count(...) = raise NotImplementedError
+
     # this method returns { entity_id => reviews_count }
     def reviews_count(...) = raise NotImplementedError
 
diff --git a/app/views/controllers/welcome/index.html.erb b/app/views/controllers/welcome/index.html.erb
@@ -1,5 +1,5 @@
 <%= render PageWrappers::GuestComponent.new do %>
-  <% cache(['welcome_page_v2', Current.user&.id, cookies[:pullmetry_subscriber_email]], expires_in: 24.hours) do %>
+  <% cache(['welcome_page_v3', Current.user&.id, cookies[:pullmetry_subscriber_email]], expires_in: 24.hours) do %>
     <section class="grid grid-cols-1 xl:grid-cols-2 gap-8 mx-auto mt-16 mb-8 xl:mt-24 xl:mb-20">
       <div class="flex flex-col justify-center">
         <h1 class="text-center lg:text-left">Get the PR statistics you always needed</h1>
@@ -167,11 +167,11 @@
             <p>Free</p>
           </div>
           <ul>
-            <li>6 insight metrics</li>
+            <li>7 insight metrics</li>
+            <li>12 repository insight metrics</li>
             <li>5 tracking repositories</li>
             <li>company metrics based on repositories</li>
-            <li>full access for developers</li>
-            <li>excluding developers for insights</li>
+            <li>easy access for developers</li>
             <li>configuring working time, vacations</li>
             <li>configuring exclude rules for PRs</li>
             <li>sending insights to Slack/Discord/Telegram</li>
@@ -185,7 +185,7 @@
           </div>
           <p class="mb-4">Everything in regular, plus:</p>
           <ul>
-            <li>12 insight metrics instead of 6</li>
+            <li>14 insight metrics instead of 7</li>
             <li>15 tracking repositories</li>
             <li>comparing data with previous periods</li>
           </ul>
diff --git a/app/views/controllers/welcome/metrics.html.erb b/app/views/controllers/welcome/metrics.html.erb
@@ -1,12 +1,14 @@
 <%= render PageWrappers::GuestComponent.new do %>
-  <% cache('metrics_v2', expires_in: 24.hours) do %>
+  <% cache('metrics_v3', expires_in: 24.hours) do %>
     <section class="mx-auto my-12">
       <h1>Review quality metrics</h1>
       <p class="mb-12">These metrics reflects quality of review performed by developer with PRs of other developers.</p>
       <h2 class="text-2xl">Required reviews count</h2>
       <p class="mb-8">Some pull requests may have a list of developers who were required to conduct a review. This metric just shows amount of such PRs for each developer.</p>
       <h2 class="text-2xl">Comments count</h2>
       <p class="mb-8">This metric shows the number of comments that developer leaves in the PRs of other developers. Higher value is better and means that developer more thoroughly reviews the code (or maybe code quality of PRs are low).</p>
+      <h2 class="text-2xl">Conventional comments count</h2>
+      <p class="mb-8">This metric shows the number of comments match <a href="https://conventionalcomments.org/" class="simple-link">standard for formatting comments</a>, it's always good to have good formatted useful comments so higher value is better and means that developer more often makes great comments.</p>
       <h2 class="text-2xl">Reviews count</h2>
       <p class="mb-8">This metric shows the number of approved PRs by developer. Higher value is better and means that developer more often approves pull requests.</p>
       <h2 class="text-2xl">Bad reviews count</h2>
diff --git a/db/migrate/20240504173744_add_parsed_body_to_comments.rb b/db/migrate/20240504173744_add_parsed_body_to_comments.rb
@@ -0,0 +1,5 @@
+class AddParsedBodyToComments < ActiveRecord::Migration[7.1]
+  def change
+    add_column :pull_requests_comments, :parsed_body, :jsonb
+  end
+end
diff --git a/db/migrate/20240504185723_add_conventional_comments_count_to_insights.rb b/db/migrate/20240504185723_add_conventional_comments_count_to_insights.rb
@@ -0,0 +1,6 @@
+class AddConventionalCommentsCountToInsights < ActiveRecord::Migration[7.1]
+  def change
+    add_column :insights, :conventional_comments_count, :integer, default: 0
+    add_column :repositories_insights, :conventional_comments_count, :integer, default: 0
+  end
+end
diff --git a/db/structure.sql b/db/structure.sql
@@ -9,6 +9,20 @@ SET xmloption = content;
 SET client_min_messages = warning;
 SET row_security = off;
 
+--
+-- Name: pg_stat_statements; Type: EXTENSION; Schema: -; Owner: -
+--
+
+CREATE EXTENSION IF NOT EXISTS pg_stat_statements WITH SCHEMA public;
+
+
+--
+-- Name: EXTENSION pg_stat_statements; Type: COMMENT; Schema: -; Owner: -
+--
+
+COMMENT ON EXTENSION pg_stat_statements IS 'track planning and execution statistics of all SQL statements executed';
+
+
 --
 -- Name: pgcrypto; Type: EXTENSION; Schema: -; Owner: -
 --
@@ -720,7 +734,8 @@ CREATE TABLE public.insights (
     changed_loc integer,
     average_changed_loc integer,
     hidden boolean DEFAULT false NOT NULL,
-    bad_reviews_count integer DEFAULT 0 NOT NULL
+    bad_reviews_count integer DEFAULT 0 NOT NULL,
+    conventional_comments_count integer DEFAULT 0
 );
 
 
@@ -968,7 +983,8 @@ CREATE TABLE public.pull_requests_comments (
     created_at timestamp(6) without time zone NOT NULL,
     updated_at timestamp(6) without time zone NOT NULL,
     pull_request_id bigint NOT NULL,
-    entity_id bigint NOT NULL
+    entity_id bigint NOT NULL,
+    parsed_body jsonb
 );
 
 
@@ -1156,7 +1172,8 @@ CREATE TABLE public.repositories_insights (
     changed_loc integer DEFAULT 0 NOT NULL,
     average_changed_loc numeric(8,2) DEFAULT 0.0 NOT NULL,
     created_at timestamp(6) without time zone NOT NULL,
-    updated_at timestamp(6) without time zone NOT NULL
+    updated_at timestamp(6) without time zone NOT NULL,
+    conventional_comments_count integer DEFAULT 0
 );
 
 
@@ -2249,7 +2266,7 @@ CREATE INDEX index_users_sessions_on_user_id ON public.users_sessions USING btre
 -- Name: index_users_sessions_on_uuid; Type: INDEX; Schema: public; Owner: -
 --
 
-CREATE INDEX index_users_sessions_on_uuid ON public.users_sessions USING btree (uuid);
+CREATE UNIQUE INDEX index_users_sessions_on_uuid ON public.users_sessions USING btree (uuid);
 
 
 --
@@ -2346,6 +2363,8 @@ ALTER TABLE ONLY public.kudos_achievements
 SET search_path TO "$user", public;
 
 INSERT INTO "schema_migrations" (version) VALUES
+('20240504185723'),
+('20240504173744'),
 ('20240501090856'),
 ('20240429175135'),
 ('20240423084933'),
diff --git a/public/sitemap.xml b/public/sitemap.xml
@@ -2,7 +2,7 @@
 <urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9" xmlns:mobile="http://www.google.com/schemas/sitemap-mobile/1.0" xmlns:pagemap="http://www.google.com/schemas/sitemap-pagemap/1.0" xmlns:xhtml="http://www.w3.org/1999/xhtml">
   <url>
     <loc>https://pullkeeper.dev</loc>
-    <lastmod>2024-03-21T14:00:00+04:00</lastmod>
+    <lastmod>2024-05-04T20:00:00+04:00</lastmod>
     <changefreq>monthly</changefreq>
     <priority>1.0</priority>
   </url>
@@ -14,7 +14,7 @@
   </url>
   <url>
     <loc>https://pullkeeper.dev/metrics</loc>
-    <lastmod>2023-11-08T22:00:00+04:00</lastmod>
+    <lastmod>2024-05-04T20:00:00+04:00</lastmod>
     <changefreq>monthly</changefreq>
     <priority>0.5</priority>
   </url>
diff --git a/public/sitemap.xml.gz b/public/sitemap.xml.gz
diff --git a/spec/controllers/companies/configurations_controller_spec.rb b/spec/controllers/companies/configurations_controller_spec.rb
@@ -156,6 +156,7 @@ def do_request
               expect(configuration.work_end_time).to eq DateTime.new(2023, 1, 1, 13, 0, 0)
               expect(configuration.insight_fields.attributes).to eq({
                 'comments_count' => true,
+                'conventional_comments_count' => nil,
                 'reviews_count' => nil,
                 'bad_reviews_count' => nil,
                 'required_reviews_count' => nil,
diff --git a/spec/services/import/representers/github/comments_spec.rb b/spec/services/import/representers/github/comments_spec.rb
diff --git a/spec/services/import/representers/gitlab/comments_spec.rb b/spec/services/import/representers/gitlab/comments_spec.rb
diff --git a/spec/services/import/savers/comments_spec.rb b/spec/services/import/savers/comments_spec.rb
