Merge branch '330839-allow-setting-timelog-summary' into 'master'

Support setting timelog summary via API

See merge request gitlab-org/gitlab!66793

app/models/concerns/time_trackable.rb

@@ -11,7 +11,7 @@ module TimeTrackable
   extend ActiveSupport::Concern
 
   included do
-    attr_reader :time_spent, :time_spent_user, :spent_at
+    attr_reader :time_spent, :time_spent_user, :spent_at, :summary
 
     alias_method :time_spent?, :time_spent
 
@@ -29,6 +29,7 @@ module TimeTrackable
     @time_spent_note_id = options[:note_id]
     @time_spent_user = User.find(options[:user_id])
     @spent_at = options[:spent_at]
+    @summary = options[:summary]
     @original_total_time_spent = nil
 
     return if @time_spent == 0
@@ -78,7 +79,8 @@ module TimeTrackable
       time_spent: time_spent,
       note_id: @time_spent_note_id,
       user: @time_spent_user,
-      spent_at: @spent_at
+      spent_at: @spent_at,
+      summary: @summary
     )
   end
   # rubocop:enable Gitlab/ModuleWithInstanceVariables

doc/api/issues.md

@@ -1950,6 +1950,7 @@ POST /projects/:id/issues/:issue_iid/add_spent_time
 | `duration`  | string  | yes      | The duration in human format. e.g: 3h30m |
 | `id`        | integer/string | yes      | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user      |
 | `issue_iid` | integer | yes      | The internal ID of a project's issue     |
+| `summary`   | string  | no       | A summary of how the time was spent  |
 
 ```shell
 curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/93/add_spent_time?duration=1h"

doc/api/merge_requests.md

@@ -2538,6 +2538,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/add_spent_time
 | `id`                | integer/string | yes      | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user.                      |
 | `merge_request_iid` | integer | yes      | The internal ID of the merge request.     |
 | `duration`          | string  | yes      | The duration in human format, such as `3h30m` |
+| `summary`           | string  | no       | A summary of how the time was spent.  |
 
 ```shell
 curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/93/add_spent_time?duration=1h"

lib/api/time_tracking_endpoints.rb

@@ -88,6 +88,7 @@ module API
         update_params = {
           spend_time: {
             duration: Gitlab::TimeTrackingFormatter.parse(params.delete(:duration)),
+            summary: params.delete(:summary),
             user_id: current_user.id
           }
         }

spec/services/merge_requests/add_spent_time_service_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe MergeRequests::AddSpentTimeService do
   let_it_be_with_reload(:merge_request) { create(:merge_request, :simple, :unique_branches, source_project: project) }
 
   let(:duration) { 1500 }
-  let(:params) { { spend_time: { duration: duration, user_id: user.id } } }
+  let(:params) { { spend_time: { duration: duration, summary: 'summary', user_id: user.id } } }
   let(:service) { described_class.new(project: project, current_user: user, params: params) }
 
   describe '#execute' do
@@ -16,13 +16,14 @@ RSpec.describe MergeRequests::AddSpentTimeService do
       project.add_developer(user)
     end
 
-    it 'creates a new timelog with the specified duration' do
+    it 'creates a new timelog with the specified duration and summary' do
       expect { service.execute(merge_request) }.to change { Timelog.count }.from(0).to(1)
 
       timelog = merge_request.timelogs.last
 
       expect(timelog).not_to be_nil
       expect(timelog.time_spent).to eq(1500)
+      expect(timelog.summary).to eq('summary')
     end
 
     it 'creates a system note with the time added' do

spec/support/shared_examples/requests/api/time_tracking_shared_examples.rb

@@ -128,17 +128,25 @@ RSpec.shared_examples 'time tracking endpoints' do |issuable_name|
 
     if issuable_name == 'merge_request'
       it 'calls update service with :use_specialized_service param' do
-        expect(::MergeRequests::UpdateService).to receive(:new).with(project: project, current_user: user, params: hash_including(use_specialized_service: true))
-
-        post api("/projects/#{project.id}/#{issuable_collection_name}/#{issuable.iid}/add_spent_time", user), params: { duration: '2h' }
+        expect(::MergeRequests::UpdateService).to receive(:new).with(
+          project: project,
+          current_user: user,
+          params: hash_including(
+            use_specialized_service: true,
+            spend_time: hash_including(duration: 7200, summary: 'summary')))
+
+        post api("/projects/#{project.id}/#{issuable_collection_name}/#{issuable.iid}/add_spent_time", user), params: { duration: '2h', summary: 'summary' }
       end
     end
 
     if issuable_name == 'issue'
       it 'calls update service without :use_specialized_service param' do
-        expect(::Issues::UpdateService).to receive(:new).with(project: project, current_user: user, params: hash_not_including(use_specialized_service: true))
+        expect(::Issues::UpdateService).to receive(:new).with(
+          project: project,
+          current_user: user,
+          params: { spend_time: { duration: 3600, summary: 'summary', user_id: user.id } })
 
-        post api("/projects/#{project.id}/#{issuable_collection_name}/#{issuable.iid}/add_spent_time", user), params: { duration: '2h' }
+        post api("/projects/#{project.id}/#{issuable_collection_name}/#{issuable.iid}/add_spent_time", user), params: { duration: '1h', summary: 'summary' }
       end
     end
   end