Skip to content

Commit

Permalink
Reorganize ProcessTaskFinalizer to use CachedInstanceDataAccessor
Browse files Browse the repository at this point in the history
  • Loading branch information
@ivarne
ivarne committed Oct 3, 2024
1 parent a6ca853 commit 165af46
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 109 deletions.
139 changes: 30 additions & 109 deletions src/Altinn.App.Core/Internal/Process/ProcessTasks/Common/ProcessTaskFinalizer.cs
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
using System.Globalization;
using System.Reflection;
using System.Text.Json;
using Altinn.App.Core.Configuration;
using Altinn.App.Core.Features;
using Altinn.App.Core.Helpers;
using Altinn.App.Core.Helpers.DataModel;
using Altinn.App.Core.Helpers.Serialization;
using Altinn.App.Core.Internal.App;
using Altinn.App.Core.Internal.AppModel;
using Altinn.App.Core.Internal.Data;
using Altinn.App.Core.Internal.Expressions;
using Altinn.App.Core.Models;
Expand All @@ -20,6 +18,7 @@ public class ProcessTaskFinalizer : IProcessTaskFinalizer
{
private readonly IAppMetadata _appMetadata;
private readonly IDataClient _dataClient;
private readonly IAppModel _appModel;
private readonly ILayoutEvaluatorStateInitializer _layoutEvaluatorStateInitializer;
private readonly IOptions<AppSettings> _appSettings;
private readonly ModelSerializationService _modelSerializer;
Expand All @@ -30,6 +29,7 @@ public class ProcessTaskFinalizer : IProcessTaskFinalizer
public ProcessTaskFinalizer(
IAppMetadata appMetadata,
IDataClient dataClient,
IAppModel appModel,
ModelSerializationService modelSerializer,
ILayoutEvaluatorStateInitializer layoutEvaluatorStateInitializer,
IOptions<AppSettings> appSettings
Expand All @@ -39,100 +39,49 @@ IOptions<AppSettings> appSettings
_dataClient = dataClient;
_layoutEvaluatorStateInitializer = layoutEvaluatorStateInitializer;
_appSettings = appSettings;
_appModel = appModel;
_modelSerializer = modelSerializer;
}

/// <inheritdoc/>
public async Task Finalize(string taskId, Instance instance)
{
ApplicationMetadata applicationMetadata = await _appMetadata.GetApplicationMetadata();
List<DataType> connectedDataTypes = applicationMetadata.DataTypes.FindAll(dt => dt.TaskId == taskId);

var dataAccessor = new CachedInstanceDataAccessor(instance, _dataClient, _appMetadata, _modelSerializer);
var changedDataElements = await RunRemoveFieldsInModelOnTaskComplete(
instance,
dataAccessor,
taskId,
connectedDataTypes,
language: null
);

// Save changes to the data elements with app logic that was changed.
await Task.WhenAll(
changedDataElements.Select(async dataElement =>
{
var data = await dataAccessor.GetFormData(dataElement);
return _dataClient.UpdateData(
data,
Guid.Parse(instance.Id.Split('/')[1]),
data.GetType(),
instance.Org,
instance.AppId.Split('/')[1],
int.Parse(instance.InstanceOwner.PartyId, CultureInfo.InvariantCulture),
Guid.Parse(dataElement.Id)
);
})
);
}
ApplicationMetadata applicationMetadata = await _appMetadata.GetApplicationMetadata();

private async Task<IEnumerable<DataElement>> RunRemoveFieldsInModelOnTaskComplete(
Instance instance,
IInstanceDataAccessor dataAccessor,
string taskId,
List<DataType> dataTypesToLock,
string? language = null
)
{
ArgumentNullException.ThrowIfNull(instance.Data);
HashSet<DataElement> modifiedDataElements = [];
List<Task> tasks = [];
foreach (
var dataType in applicationMetadata.DataTypes.Where(dt =>
dt.TaskId == taskId && dt.AppLogic?.ClassRef is not null
)
)
{
foreach (var dataElement in instance.Data.Where(de => de.DataType == dataType.Id))
{
tasks.Add(RemoveFieldsOnTaskComplete(dataAccessor, taskId, applicationMetadata, dataElement, dataType));
}
}
await Task.WhenAll(tasks);

var dataTypesWithLogic = dataTypesToLock.Where(d => !string.IsNullOrEmpty(d.AppLogic?.ClassRef)).ToList();
await Task.WhenAll(
instance
.Data.Join(
dataTypesWithLogic,
de => de.DataType,
dt => dt.Id,
(de, dt) => (dataElement: de, dataType: dt)
)
.Select(
async (d) =>
{
if (
await RemoveFieldsOnTaskComplete(
instance,
dataAccessor,
taskId,
dataTypesWithLogic,
d.dataElement,
d.dataType,
language
)
)
{
modifiedDataElements.Add(d.dataElement);
}
}
)
);
return modifiedDataElements;
var changes = dataAccessor.GetDataElementChanges(initializeAltinnRowId: false);
await dataAccessor.UpdateInstanceData();
await dataAccessor.SaveChanges(changes);
}

private async Task<bool> RemoveFieldsOnTaskComplete(
Instance instance,
IInstanceDataAccessor dataAccessor,
private async Task RemoveFieldsOnTaskComplete(
CachedInstanceDataAccessor dataAccessor,
string taskId,
List<DataType> dataTypesWithLogic,
ApplicationMetadata applicationMetadata,
DataElement dataElement,
DataType dataType,
string? language = null
)
{
bool isModified = false;
var data = await dataAccessor.GetFormData(dataElement);

// remove AltinnRowIds
isModified |= ObjectUtils.RemoveAltinnRowId(data);
ObjectUtils.RemoveAltinnRowId(data);

// Remove hidden data before validation, ignore hidden rows.
if (_appSettings.Value?.RemoveHiddenData == true)
Expand All @@ -147,20 +96,17 @@ private async Task<bool> RemoveFieldsOnTaskComplete(
language
);
await LayoutEvaluator.RemoveHiddenData(evaluationState, RowRemovalOption.DeleteRow);
// TODO: Make RemoveHiddenData return a bool indicating if data was removed
isModified = true;
}

// Remove shadow fields
// TODO: Use reflection or code generation instead of JsonSerializer
if (dataType.AppLogic?.ShadowFields?.Prefix != null)
{
Type saveToModelType = data.GetType();
string serializedData = JsonSerializerIgnorePrefix.Serialize(data, dataType.AppLogic.ShadowFields.Prefix);
if (dataType.AppLogic.ShadowFields.SaveToDataType != null)
{
// Save the shadow fields to another data type
DataType? saveToDataType = dataTypesWithLogic.Find(dt =>
DataType? saveToDataType = applicationMetadata.DataTypes.Find(dt =>
dt.Id == dataType.AppLogic.ShadowFields.SaveToDataType
);
if (saveToDataType == null)
Expand All @@ -169,51 +115,26 @@ private async Task<bool> RemoveFieldsOnTaskComplete(
$"SaveToDataType {dataType.AppLogic.ShadowFields.SaveToDataType} not found"
);
}
Type saveToModelType = _appModel.GetModelType(saveToDataType.AppLogic.ClassRef);

object updatedData =
JsonSerializer.Deserialize(serializedData, saveToModelType)
?? throw new JsonException(
"Could not deserialize back datamodel after removing shadow fields. Data was \"null\""
);
// Save a new data element with the cleaned data without shadow fields.
Guid instanceGuid = Guid.Parse(instance.Id.Split("/")[1]);
string app = instance.AppId.Split("/")[1];
int instanceOwnerPartyId = int.Parse(instance.InstanceOwner.PartyId, CultureInfo.InvariantCulture);
var newDataElement = await _dataClient.InsertFormData(
updatedData,
instanceGuid,
saveToModelType,
instance.Org,
app,
instanceOwnerPartyId,
saveToDataType.Id
);
instance.Data.Add(newDataElement);
dataAccessor.AddFormDataElement(saveToDataType.Id, updatedData);
}
else
{
// Remove the shadow fields from the data using JsonSerializer
var newData =
JsonSerializer.Deserialize(serializedData, saveToModelType)
JsonSerializer.Deserialize(serializedData, data.GetType())
?? throw new JsonException(
"Could not deserialize back datamodel after removing shadow fields. Data was \"null\""
);
// Copy all properties with a public setter from newData to data
foreach (
var propertyInfo in saveToModelType
.GetProperties(BindingFlags.Instance | BindingFlags.Public)
.Where(p => p.CanWrite)
)
{
object? value = propertyInfo.GetValue(newData);
propertyInfo.SetValue(data, value);
}

isModified = true; // TODO: Detect if modifications were made
dataAccessor.SetFormData(dataElement, newData);
}
}

// Save the updated data
return isModified;
}
}
18 changes: 18 additions & 0 deletions ...ts/Controllers/ProcessControllerTests.RunProcessNext_PdfFails_DataIsUnlocked.verified.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,24 @@
],
IdFormat: W3C
},
{
ActivityName: SerializationService.DeserializeXml,
Tags: [
{
Type: Altinn.App.Api.Tests.Data.apps.tdd.contributer_restriction.models.Skjema
}
],
IdFormat: W3C
},
{
ActivityName: SerializationService.SerializeXml,
Tags: [
{
Type: Altinn.App.Api.Tests.Data.apps.tdd.contributer_restriction.models.Skjema
}
],
IdFormat: W3C
},
{
ActivityName: Validation.RunValidator,
Tags: [
Expand Down
1 change: 1 addition & 0 deletions test/Altinn.App.Core.Tests/Internal/Process/ProcessTasks/Common/ProcessTaskFinalizerTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ public ProcessTaskFinalizerTests()
_processTaskFinalizer = new ProcessTaskFinalizer(
_appMetadataMock.Object,
_dataClientMock.Object,
_appModelMock.Object,
new ModelSerializationService(_appModelMock.Object),
_layoutEvaluatorStateInitializerMock.Object,
_appSettings
Expand Down

0 comments on commit 165af46

Please sign in to comment.