Merge branch '213651-deprecate-graphql-field-date-in-timelogtype' into 'master'

Add GraphQL field spentAt to TimelogType and deprecate date field

Closes #213651

See merge request gitlab-org/gitlab!29024

doc/api/graphql/reference/gitlab_schema.graphql

@@ -8353,15 +8353,20 @@ scalar Time
 
 type Timelog {
   """
-  The date when the time tracked was spent at
+  Timestamp of when the time tracked was spent at. Deprecated in 12.10: Use `spentAt`
   """
-  date: Time!
+  date: Time! @deprecated(reason: "Use `spentAt`. Deprecated in 12.10")
 
   """
   The issue that logged time was added to
   """
   issue: Issue
 
+  """
+  Timestamp of when the time tracked was spent at
+  """
+  spentAt: Time
+
   """
   The time spent displayed in seconds
   """

doc/api/graphql/reference/gitlab_schema.json

@@ -25299,7 +25299,7 @@
           "fields": [
             {
               "name": "date",
-              "description": "The date when the time tracked was spent at",
+              "description": "Timestamp of when the time tracked was spent at. Deprecated in 12.10: Use `spentAt`",
               "args": [
 
               ],
@@ -25312,8 +25312,8 @@
                   "ofType": null
                 }
               },
-              "isDeprecated": false,
-              "deprecationReason": null
+              "isDeprecated": true,
+              "deprecationReason": "Use `spentAt`. Deprecated in 12.10"
             },
             {
               "name": "issue",
@@ -25329,6 +25329,20 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "spentAt",
+              "description": "Timestamp of when the time tracked was spent at",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Time",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "timeSpent",
               "description": "The time spent displayed in seconds",

doc/api/graphql/reference/index.md

@@ -1306,8 +1306,9 @@ Completion status of tasks
 
 | Name  | Type  | Description |
 | ---   |  ---- | ----------  |
-| `date` | Time! | The date when the time tracked was spent at |
+| `date` **{warning-solid}** | Time! | **Deprecated:** Use `spentAt`. Deprecated in 12.10 |
 | `issue` | Issue | The issue that logged time was added to |
+| `spentAt` | Time | Timestamp of when the time tracked was spent at |
 | `timeSpent` | Int! | The time spent displayed in seconds |
 | `user` | User! | The user that logged the time |
 

ee/app/graphql/types/timelog_type.rb

@@ -10,7 +10,13 @@ module Types
           Types::TimeType,
           null: false,
           method: :spent_at,
-          description: 'The date when the time tracked was spent at'
+          deprecated: { reason: 'Use `spentAt`', milestone: '12.10' },
+          description: 'Timestamp of when the time tracked was spent at'
+
+    field :spent_at,
+          Types::TimeType,
+          null: true,
+          description: 'Timestamp of when the time tracked was spent at'
 
     field :time_spent,
           GraphQL::INT_TYPE,

ee/changelogs/unreleased/213651-deprecate-graphql-field-date-in-timelogtype.yml

+---
+title: Add spentAt field to TimelogType and deprecate date field
+merge_request: 29024
+author:
+type: added

ee/spec/graphql/types/timelog_type_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe GitlabSchema.types['Timelog'] do
-  let(:fields) { %i[date time_spent user issue] }
+  let(:fields) { %i[date spent_at time_spent user issue] }
 
   it { expect(described_class.graphql_name).to eq('Timelog') }
   it { expect(described_class).to have_graphql_fields(fields) }

ee/spec/requests/api/graphql/group/timelogs_spec.rb

@@ -19,6 +19,7 @@ describe 'Timelogs through GroupQuery' do
       timelog_nodes = <<~NODE
       nodes {
         date
+        spentAt
         timeSpent
         user {
           username
@@ -65,14 +66,16 @@ describe 'Timelogs through GroupQuery' do
 
       it 'contains correct data' do
         username = timelog_array.map {|data| data['user']['username'] }
-        date = timelog_array.map { |data| data['date'].to_date.to_s }
+        date = timelog_array.map { |data| data['date'].to_time }
+        spent_at = timelog_array.map { |data| data['spentAt'].to_time }
         time_spent = timelog_array.map { |data| data['timeSpent'] }
         issue_title = timelog_array.map {|data| data['issue']['title'] }
         milestone_title = timelog_array.map {|data| data['issue']['milestone']['title'] }
         epic_title = timelog_array.map {|data| data['issue']['epic']['title'] }
 
         expect(username).to eq([user.username])
-        expect(date).to eq([timelog1.spent_at.to_date.to_s])
+        expect(date.first).to be_like_time(timelog1.spent_at)
+        expect(spent_at.first).to be_like_time(timelog1.spent_at)
         expect(time_spent).to eq([timelog1.time_spent])
         expect(issue_title).to eq([issue.title])
         expect(milestone_title).to eq([milestone.title])