Skip to content
This repository was archived by the owner on Jan 5, 2026. It is now read-only.

Log missing update activity and fix infinite loop #5287

Merged
EricDahlvang merged 1 commit into from
Mar 15, 2021
Merged

Log missing update activity and fix infinite loop #5287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions libraries/Microsoft.Bot.Builder.Azure.Blobs/BlobsTranscriptStore.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,23 +91,29 @@ public async Task LogActivityAsync(IActivity activity)
{
case ActivityTypes.MessageUpdate:
{
var updatedActivity = JsonConvert.DeserializeObject<Activity>(JsonConvert.SerializeObject(activity));
updatedActivity.Type = ActivityTypes.Message; // fixup original type (should be Message)

var activityAndBlob = await InnerReadBlobAsync(activity).ConfigureAwait(false);
if (activityAndBlob.Item1 != null)
if (activityAndBlob != default && activityAndBlob.Item1 != null)
{
var updatedActivity = JsonConvert.DeserializeObject<Activity>(JsonConvert.SerializeObject(activity));
updatedActivity.Type = ActivityTypes.Message; // fixup original type (should be Message)
updatedActivity.LocalTimestamp = activityAndBlob.Item1.LocalTimestamp;
updatedActivity.Timestamp = activityAndBlob.Item1.Timestamp;
await LogActivityToBlobClientAsync(updatedActivity, activityAndBlob.Item2, true).ConfigureAwait(false);
}
else
{
// The activity was not found, so just add a record of this update.
await InnerLogActivityAsync(updatedActivity).ConfigureAwait(false);
}

return;
}

case ActivityTypes.MessageDelete:
{
var activityAndBlob = await InnerReadBlobAsync(activity).ConfigureAwait(false);
if (activityAndBlob.Item1 != null)
if (activityAndBlob != default && activityAndBlob.Item1 != null)
{
// tombstone the original message
var tombstonedActivity = new Activity()
Expand All @@ -132,9 +138,7 @@ public async Task LogActivityAsync(IActivity activity)
}

default:
var blobName = GetBlobName(activity);
var blobClient = _containerClient.Value.GetBlobClient(blobName);
await LogActivityToBlobClientAsync(activity, blobClient).ConfigureAwait(false);
await InnerLogActivityAsync(activity).ConfigureAwait(false);
return;
}
}
Expand Down Expand Up @@ -352,6 +356,7 @@ public async Task DeleteTranscriptAsync(string channelId, string conversationId)
}
}
while (!string.IsNullOrEmpty(token));
return default;
}
catch (RequestFailedException ex)
when ((HttpStatusCode)ex.Status == HttpStatusCode.PreconditionFailed)
Expand All @@ -375,6 +380,13 @@ private async Task<Activity> GetActivityFromBlobClientAsync(BlobClient blobClien
return _jsonSerializer.Deserialize(jsonReader, typeof(Activity)) as Activity;
}

private Task InnerLogActivityAsync(IActivity activity)
{
var blobName = GetBlobName(activity);
var blobClient = _containerClient.Value.GetBlobClient(blobName);
return LogActivityToBlobClientAsync(activity, blobClient);
}

private async Task LogActivityToBlobClientAsync(IActivity activity, BlobClient blobClient, bool overwrite = false)
{
using (var memoryStream = new MemoryStream())
Expand Down
22 changes: 17 additions & 5 deletions libraries/Microsoft.Bot.Builder.Azure/AzureBlobTranscriptStore.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,16 +91,23 @@ public async Task LogActivityAsync(IActivity activity)
{
case ActivityTypes.MessageUpdate:
{
var updatedActivity = JsonConvert.DeserializeObject<Activity>(JsonConvert.SerializeObject(activity));
updatedActivity.Type = ActivityTypes.Message; // fixup original type (should be Message)

var blob = await FindActivityBlobAsync(activity).ConfigureAwait(false);
if (blob != null)
{
var originalActivity = JsonConvert.DeserializeObject<Activity>(await blob.DownloadTextAsync().ConfigureAwait(false));
var updatedActivity = JsonConvert.DeserializeObject<Activity>(JsonConvert.SerializeObject(activity));
updatedActivity.Type = ActivityTypes.Message; // fixup original type (should be Message)

updatedActivity.LocalTimestamp = originalActivity.LocalTimestamp;
updatedActivity.Timestamp = originalActivity.Timestamp;
await LogActivityAsync(updatedActivity, blob).ConfigureAwait(false);
}
else
{
// The activity was not found, so just add a record of this update.
await InnerLogActivityAsync(updatedActivity).ConfigureAwait(false);
}

return;
}
Expand Down Expand Up @@ -135,9 +142,7 @@ public async Task LogActivityAsync(IActivity activity)
}

default:
var blobName = GetBlobName(activity);
var blobReference = this.Container.Value.GetBlockBlobReference(blobName);
await LogActivityAsync(activity, blobReference).ConfigureAwait(false);
await InnerLogActivityAsync(activity).ConfigureAwait(false);
return;
}
}
Expand Down Expand Up @@ -366,6 +371,13 @@ private static string SanitizeKey(string key)
return Uri.EscapeDataString(key);
}

private Task InnerLogActivityAsync(IActivity activity)
{
var blobName = GetBlobName(activity);
var blobReference = this.Container.Value.GetBlockBlobReference(blobName);
return LogActivityAsync(activity, blobReference);
}

private async Task<CloudBlockBlob> FindActivityBlobAsync(IActivity activity)
{
var dirName = GetDirName(activity.ChannelId, activity.Conversation.Id);
Expand Down
31 changes: 31 additions & 0 deletions tests/Microsoft.Bot.Builder.Azure.Tests/TranscriptStoreBaseTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,37 @@ public async Task LogUpdateActivities()
}
}

[Fact]
[Trait("TestCategory", "Middleware")]
public async Task LogMissingUpdateActivity()
{
if (StorageEmulatorHelper.CheckEmulator())
{
var conversation = TestAdapter.CreateConversation(Guid.NewGuid().ToString("n"));
var adapter = new TestAdapter(conversation)
.Use(new TranscriptLoggerMiddleware(TranscriptStore));
string fooId = string.Empty;
await new TestFlow(adapter, async (context, cancellationToken) =>
{
fooId = context.Activity.Id;
var updateActivity = JsonConvert.DeserializeObject<Activity>(JsonConvert.SerializeObject(context.Activity));
updateActivity.Text = "updated response";
var response = await context.UpdateActivityAsync(updateActivity);
})
.Send("foo")
.StartTestAsync();

await Task.Delay(3000);

var pagedResult = await GetPagedResultAsync(conversation, 2);
Assert.Equal(2, pagedResult.Items.Length);
Assert.Equal(fooId, pagedResult.Items[0].AsMessageActivity().Id);
Assert.Equal("foo", pagedResult.Items[0].AsMessageActivity().Text);
Assert.StartsWith("g_", pagedResult.Items[1].AsMessageActivity().Id);
Assert.Equal("updated response", pagedResult.Items[1].AsMessageActivity().Text);
}
}

[Fact]
[Trait("TestCategory", "Middleware")]
public async Task TestDateLogUpdateActivities()
Expand Down