drafting metrics: record SF draft generation request id to ease matching

Author: marksvc

src/SIL.XForge.Scripture/Services/IMachineApiService.cs

@@ -146,13 +146,11 @@ CancellationToken cancellationToken
     Task<LanguageDto> IsLanguageSupportedAsync(string languageCode, CancellationToken cancellationToken);
 
     [Mutex]
-    [LogEventMetric(EventScope.Drafting, projectId: nameof(sfProjectId), captureReturnValue: true)]
     Task<string> RetrievePreTranslationStatusAsync(string sfProjectId, CancellationToken cancellationToken);
 
     [LogEventMetric(EventScope.Drafting, nameof(curUserId), nameof(sfProjectId))]
     Task StartBuildAsync(string curUserId, string sfProjectId, CancellationToken cancellationToken);
 
-    [LogEventMetric(EventScope.Drafting, nameof(curUserId), projectId: "buildConfig.ProjectId")]
     Task StartPreTranslationBuildAsync(string curUserId, BuildConfig buildConfig, CancellationToken cancellationToken);
     Task TrainSegmentAsync(
         string curUserId,

src/SIL.XForge.Scripture/Services/IMachineProjectService.cs

@@ -15,7 +15,8 @@ Task BuildProjectForBackgroundJobAsync(
         string curUserId,
         BuildConfig buildConfig,
         bool preTranslate,
-        CancellationToken cancellationToken
+        CancellationToken cancellationToken,
+        string? draftGenerationRequestId
     );
     Task<string> GetProjectZipAsync(string sfProjectId, Stream outputStream, CancellationToken cancellationToken);
     Task RemoveProjectAsync(string sfProjectId, bool preTranslate, CancellationToken cancellationToken);

src/SIL.XForge.Scripture/Services/MachineApiService.cs

@@ -773,6 +773,13 @@ public async Task ExecuteWebhookAsync(string json, string signature)
             { "event", delivery.Event },
             { "translationEngineId", delivery.Payload.Engine.Id },
         };
+
+        string? draftGenerationRequestId = await GetDraftGenerationRequestIdForBuildAsync(buildId);
+        if (!string.IsNullOrEmpty(draftGenerationRequestId))
+        {
+            arguments["draftGenerationRequestId"] = draftGenerationRequestId;
+        }
+
         await eventMetricService.SaveEventMetricAsync(
             projectId,
             userId: null,
@@ -1750,6 +1757,9 @@ public async Task<LanguageDto> IsLanguageSupportedAsync(string languageCode, Can
         CancellationToken cancellationToken
     )
     {
+        string? buildId = null;
+        Exception? caughtException = null;
+
         try
         {
             // Record the SF Project id to help with debugging
@@ -1779,6 +1789,8 @@ await translationEnginesClient.GetAllBuildsAsync(translationEngineId, cancellati
                     .Where(b => b.State == JobState.Completed)
                     .MaxBy(b => b.DateFinished);
 
+                buildId = translationBuild?.Id;
+
                 // Set the retrieved flag as in progress
                 await projectSecrets.UpdateAsync(
                     sfProjectId,
@@ -1802,21 +1814,15 @@ await projectSecrets.UpdateAsync(
                 // Notify any SignalR clients subscribed to the project
                 await hubContext.NotifyBuildProgress(
                     sfProjectId,
-                    new ServalBuildState
-                    {
-                        BuildId = translationBuild?.Id,
-                        State = nameof(ServalData.PreTranslationsRetrieved),
-                    }
+                    new ServalBuildState { BuildId = buildId, State = nameof(ServalData.PreTranslationsRetrieved) }
                 );
-
-                // Return the build id
-                return translationBuild?.Id;
             }
         }
         catch (TaskCanceledException e) when (e.InnerException is not TimeoutException)
         {
             // Do not log error - the job was cancelled
             // Exclude TaskCanceledException with an inner TimeoutException, as this generated by an HttpClient timeout
+            caughtException = e;
 
             // Ensure that the retrieved flag is cleared
             await projectSecrets.UpdateAsync(
@@ -1827,6 +1833,8 @@ await projectSecrets.UpdateAsync(
         }
         catch (Exception e)
         {
+            caughtException = e;
+
             // Log the error and report to bugsnag
             const string message =
                 "Retrieve pre-translation status exception occurred for project {sfProjectId} running in background job.";
@@ -1847,8 +1855,34 @@ await projectSecrets.UpdateAsync(
                 throw;
             }
         }
+        finally
+        {
+            var payload = new Dictionary<string, object> { { "sfProjectId", sfProjectId } };
+            if (buildId is not null)
+            {
+                string? draftGenerationRequestId = await GetDraftGenerationRequestIdForBuildAsync(buildId);
+                if (!string.IsNullOrEmpty(draftGenerationRequestId))
+                {
+                    payload["draftGenerationRequestId"] = draftGenerationRequestId;
+                }
+            }
+            if (!string.IsNullOrEmpty(buildId))
+            {
+                payload["buildId"] = buildId;
+            }
 
-        return null;
+            await eventMetricService.SaveEventMetricAsync(
+                sfProjectId,
+                userId: null,
+                eventType: nameof(RetrievePreTranslationStatusAsync),
+                EventScope.Drafting,
+                payload,
+                result: buildId,
+                exception: caughtException
+            );
+        }
+
+        return buildId;
     }
 
     public async Task StartBuildAsync(string curUserId, string sfProjectId, CancellationToken cancellationToken)
@@ -1879,7 +1913,8 @@ public async Task StartBuildAsync(string curUserId, string sfProjectId, Cancella
                     curUserId,
                     new BuildConfig { ProjectId = sfProjectId },
                     false,
-                    CancellationToken.None
+                    CancellationToken.None,
+                    null
                 ),
             null,
             JobContinuationOptions.OnAnyFinishedState
@@ -1904,6 +1939,22 @@ public async Task StartPreTranslationBuildAsync(
         CancellationToken cancellationToken
     )
     {
+        // SF-specific id of the draft generation request
+        string draftGenerationRequestId = ObjectId.GenerateNewId().ToString();
+
+        await eventMetricService.SaveEventMetricAsync(
+            buildConfig.ProjectId,
+            curUserId,
+            eventType: nameof(StartPreTranslationBuildAsync),
+            EventScope.Drafting,
+            new Dictionary<string, object>
+            {
+                { "curUserId", curUserId },
+                { "buildConfig", buildConfig },
+                { "draftGenerationRequestId", draftGenerationRequestId },
+            }
+        );
+
         // Load the project from the realtime service
         await using IConnection conn = await realtimeService.ConnectAsync(curUserId);
         IDocument<SFProject> projectDoc = await conn.FetchAsync<SFProject>(buildConfig.ProjectId);
@@ -2018,7 +2069,14 @@ await projectDoc.SubmitJson0OpAsync(op =>
         //       so that the interceptor functions for BuildProjectAsync().
         jobId = backgroundJobClient.ContinueJobWith<MachineProjectService>(
             jobId,
-            r => r.BuildProjectForBackgroundJobAsync(curUserId, buildConfig, true, CancellationToken.None)
+            r =>
+                r.BuildProjectForBackgroundJobAsync(
+                    curUserId,
+                    buildConfig,
+                    true,
+                    CancellationToken.None,
+                    draftGenerationRequestId
+                )
         );
 
         // Set the pre-translation queued date and time, and hang fire job id
@@ -2586,6 +2644,28 @@ CancellationToken cancellationToken
         return project;
     }
 
+    /// <summary>
+    /// Gets the SF-specific draft generation request identifier for a build by looking up the BuildProjectAsync event.
+    /// </summary>
+    /// <param name="buildId">The Serval build identifier.</param>
+    /// <returns>The draft generation request identifier, or null if not found.</returns>
+    private async Task<string?> GetDraftGenerationRequestIdForBuildAsync(string buildId)
+    {
+        // BuildProjectAsync events serve as a record of what Serval build id corresponds to what draft generation
+        // request id.
+        QueryResults<EventMetric> buildProjectEvents = await eventMetricService.GetEventMetricsAsync(
+            projectId: null,
+            scopes: [EventScope.Drafting],
+            eventTypes: [nameof(MachineProjectService.BuildProjectAsync)]
+        );
+        EventMetric? buildEvent = buildProjectEvents.Results.FirstOrDefault(e => e.Result?.ToString() == buildId);
+        if (buildEvent?.Payload.TryGetValue("draftGenerationRequestId", out BsonValue? requestId) == true)
+        {
+            return requestId.ToString();
+        }
+        return null;
+    }
+
     private async Task<string> GetTranslationIdAsync(
         string sfProjectId,
         bool preTranslate,

src/SIL.XForge.Scripture/Services/MachineProjectService.cs

@@ -107,6 +107,7 @@ public async Task<string> AddSmtProjectAsync(string sfProjectId, CancellationTok
     /// <param name="buildConfig">The build configuration.</param>
     /// <param name="preTranslate">If <c>true</c> use NMT; otherwise if <c>false</c> use SMT.</param>
     /// <param name="cancellationToken">The cancellation token.</param>
+    /// <param name="draftGenerationRequestId">The SF-specific NMT draft generation request id. (Or null when SMT.)</param>
     /// <returns>An asynchronous task.</returns>
     /// <remarks>
     /// This cannot be run multiple times in different threads.
@@ -115,12 +116,13 @@ public async Task BuildProjectForBackgroundJobAsync(
         string curUserId,
         BuildConfig buildConfig,
         bool preTranslate,
-        CancellationToken cancellationToken
+        CancellationToken cancellationToken,
+        string? draftGenerationRequestId
     )
     {
         try
         {
-            await BuildProjectAsync(curUserId, buildConfig, preTranslate, cancellationToken);
+            await BuildProjectAsync(curUserId, buildConfig, preTranslate, cancellationToken, draftGenerationRequestId);
         }
         catch (TaskCanceledException e) when (e.InnerException is not TimeoutException)
         {
@@ -599,7 +601,8 @@ await projectDoc.SubmitJson0OpAsync(op =>
     /// <param name="buildConfig">The build configuration.</param>
     /// <param name="preTranslate">If <c>true</c> use NMT; otherwise if <c>false</c> use SMT.</param>
     /// <param name="cancellationToken">The cancellation token.</param>
-    /// <returns>An asynchronous task.</returns>
+    /// <param name="draftGenerationRequestId">The SF-specific draft generation request id</param>
+    /// <returns>Serval build id</returns>
     /// <exception cref="DataNotFoundException">The project or project secret could not be found.</exception>
     /// <exception cref="InvalidDataException">The language of the source project was not specified.</exception>
     /// <remarks>
@@ -616,7 +619,8 @@ public virtual async Task<string> BuildProjectAsync(
         string curUserId,
         BuildConfig buildConfig,
         bool preTranslate,
-        CancellationToken cancellationToken
+        CancellationToken cancellationToken,
+        string? draftGenerationRequestId
     )
     {
         // Load the target project secrets, so we can get the translation engine ID

src/SIL.XForge.Scripture/Services/SyncService.cs

@@ -198,7 +198,8 @@ await projectSecrets.UpdateAsync(
                                 syncConfig.UserId,
                                 new BuildConfig { ProjectId = syncConfig.ProjectId },
                                 false,
-                                CancellationToken.None
+                                CancellationToken.None,
+                                null
                             ),
                         null,
                         JobContinuationOptions.OnAnyFinishedState