Remove hidden data before validation and make clean data available in DataProcessor #1279
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,232 @@ | ||
| using Altinn.App.Analyzers.SourceTextGenerator; | ||
| using Altinn.App.Analyzers.Utils; | ||
| using NanoJsonReader; | ||
|
|
||
| namespace Altinn.App.Analyzers.IncrementalGenerator; | ||
|
|
||
| /// <summary> | ||
| /// Generate IFormDataWrapper implementations for classes in models/*.cs in the app. | ||
| /// </summary> | ||
| [Generator] | ||
| public class FormDataWrapperGenerator : IIncrementalGenerator | ||
| { | ||
| private sealed record Result<T>(T? Value, EquatableArray<EquatableDiagnostic> Diagnostics) | ||
| where T : class | ||
| { | ||
| public Result(EquatableDiagnostic diagnostics) | ||
| : this(null, new EquatableArray<EquatableDiagnostic>([diagnostics])) { } | ||
|
|
||
| public Result(T value) | ||
| : this(value, EquatableArray<EquatableDiagnostic>.Empty) { } | ||
| }; | ||
|
|
||
| private sealed record ModelClassOrDiagnostic( | ||
| string? ClassName, | ||
| Location? Location, | ||
| EquatableArray<EquatableDiagnostic> Diagnostics | ||
| ) | ||
| { | ||
| public ModelClassOrDiagnostic(EquatableDiagnostic diagnostic) | ||
| : this(null, null, new([diagnostic])) { } | ||
|
|
||
| public ModelClassOrDiagnostic(string className, Location? location) | ||
| : this(className, location, EquatableArray<EquatableDiagnostic>.Empty) { } | ||
| }; | ||
|
|
||
| /// <inheritdoc /> | ||
| public void Initialize(IncrementalGeneratorInitializationContext context) | ||
| { | ||
| var rootClasses = context | ||
| .AdditionalTextsProvider.Where(text => | ||
| text.Path.Replace('\\', '/').EndsWith("config/applicationmetadata.json") | ||
| ) | ||
| .SelectMany(ParseModelClassOrDiagnostic); | ||
|
|
||
| var modelPathNodesProvider = rootClasses.Combine(context.CompilationProvider).Select(CreateNodeTree); | ||
|
|
||
| context.RegisterSourceOutput(modelPathNodesProvider, GenerateFromNode); | ||
| } | ||
|
|
||
| private static ImmutableArray<ModelClassOrDiagnostic> ParseModelClassOrDiagnostic( | ||
| AdditionalText text, | ||
| CancellationToken token | ||
| ) | ||
| { | ||
| try | ||
| { | ||
| var textContent = text.GetText(token)?.ToString(); | ||
| if (textContent is null) | ||
| { | ||
| return | ||
| [ | ||
| new( | ||
| new EquatableDiagnostic( | ||
| Diagnostics.FormDataWrapperGenerator.AppMetadataError, | ||
| FileLocationHelper.GetLocation(text, 0, null), | ||
| ["Failed to read applicationmetadata.json"] | ||
| ) | ||
| ), | ||
| ]; | ||
| } | ||
|
|
||
| var appMetadata = JsonValue.Parse(textContent); | ||
| if (appMetadata.Type != JsonType.Object) | ||
| { | ||
| return | ||
| [ | ||
| new( | ||
| new EquatableDiagnostic( | ||
| Diagnostics.FormDataWrapperGenerator.AppMetadataError, | ||
| FileLocationHelper.GetLocation(text, appMetadata.Start, appMetadata.End), | ||
| ["applicationmetadata.json is not a valid JSON object"] | ||
| ) | ||
| ), | ||
| ]; | ||
| } | ||
|
|
||
| var dataTypes = appMetadata.GetProperty("dataTypes"); | ||
| if (dataTypes?.Type != JsonType.Array) | ||
| { | ||
| return | ||
| [ | ||
| new( | ||
| new( | ||
| Diagnostics.FormDataWrapperGenerator.AppMetadataError, | ||
| FileLocationHelper.GetLocation(text, appMetadata.Start, appMetadata.End), | ||
| ["the property dataTypes is not a valid JSON array"] | ||
| ) | ||
| ), | ||
| ]; | ||
| } | ||
|
|
||
| List<ModelClassOrDiagnostic> rootClasses = []; | ||
| foreach (var dataType in dataTypes.GetArrayValues()) | ||
| { | ||
| if (dataType.Type != JsonType.Object) | ||
| { | ||
| continue; | ||
|
Contributor
There was a problem hiding this comment. This branch could emit a diagnostic, all the values in
Member
Author
There was a problem hiding this comment. Yes, I definitely could add more diagnostics. Not sure I want to do that, because diagnostics from incremental source generators is pretty buggy. I wanted to have a diagnostic for not finding
Contributor
There was a problem hiding this comment. Reading up on the whole "diagnostics from incremental generators" topic, it seems like there is no intention to have a create story there. Maybe we should go in the opposite direction then? Drop all diagnostics here and rather implement analyzers if we feel it is necessary? |
||
| } | ||
|
|
||
| var appLogic = dataType.GetProperty("appLogic"); | ||
| if (appLogic?.Type != JsonType.Object) | ||
| { | ||
| continue; | ||
| } | ||
|
|
||
| var classRef = appLogic.GetProperty("classRef"); | ||
| if (classRef?.Type != JsonType.String) | ||
| { | ||
| continue; | ||
martinothamar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| rootClasses.Add( | ||
| new(classRef.GetString(), FileLocationHelper.GetLocation(text, classRef.Start, classRef.End)) | ||
| ); | ||
| } | ||
|
|
||
| return [.. rootClasses]; | ||
| } | ||
| catch (NanoJsonException e) | ||
| { | ||
| return | ||
| [ | ||
| new( | ||
| new EquatableDiagnostic( | ||
| Diagnostics.FormDataWrapperGenerator.AppMetadataError, | ||
| FileLocationHelper.GetLocation(text, e.StartIndex, e.EndIndex), | ||
| [e.Message] | ||
| ) | ||
| ), | ||
| ]; | ||
| } | ||
| } | ||
|
|
||
| private static Result<ModelPathNode> CreateNodeTree( | ||
| (ModelClassOrDiagnostic, Compilation) tuple, | ||
| CancellationToken _ | ||
| ) | ||
| { | ||
| var (rootSymbolFullName, compilation) = tuple; | ||
| if (rootSymbolFullName.ClassName is null) | ||
| { | ||
| return new Result<ModelPathNode>(null, rootSymbolFullName.Diagnostics); | ||
| } | ||
| var rootSymbol = compilation.GetBestTypeByMetadataName(rootSymbolFullName.ClassName); | ||
| if (rootSymbol == null) | ||
| { | ||
| return new Result<ModelPathNode>( | ||
| new EquatableDiagnostic( | ||
| Diagnostics.FormDataWrapperGenerator.AppMetadataError, | ||
| rootSymbolFullName.Location, | ||
| [$"Could not find class {rootSymbolFullName.ClassName} in the compilation"] | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| return new Result<ModelPathNode>( | ||
| new ModelPathNode("", "", SourceReaderUtils.TypeSymbolToString(rootSymbol), GetNodeProperties(rootSymbol)) | ||
| ); | ||
| } | ||
|
|
||
| private static EquatableArray<ModelPathNode>? GetNodeProperties(INamedTypeSymbol namedTypeSymbol) | ||
| { | ||
| var nodeProperties = new List<ModelPathNode>(); | ||
| foreach (var property in namedTypeSymbol.GetMembers().OfType<IPropertySymbol>()) | ||
| { | ||
| if ( | ||
| property.IsStatic | ||
| || property.IsReadOnly | ||
| || property.IsWriteOnly | ||
| || property.IsImplicitlyDeclared | ||
| || property.IsIndexer | ||
| ) | ||
| { | ||
| // Skip static, readonly, writeonly, implicitly declared and indexer properties | ||
| continue; | ||
| } | ||
| var (propertyTypeSymbol, propertyCollectionTypeSymbol) = SourceReaderUtils.GetTypeFromProperty( | ||
| property.Type | ||
| ); | ||
|
|
||
| var cSharpName = property.Name; | ||
| var jsonName = SourceReaderUtils.GetJsonName(property) ?? cSharpName; | ||
| var typeString = SourceReaderUtils.TypeSymbolToString(propertyTypeSymbol); | ||
| var collectionTypeString = propertyCollectionTypeSymbol is null | ||
| ? null | ||
| : SourceReaderUtils.TypeSymbolToString(propertyCollectionTypeSymbol); | ||
|
|
||
| if ( | ||
| propertyTypeSymbol is INamedTypeSymbol propertyNamedTypeSymbol | ||
| && !propertyNamedTypeSymbol.ContainingNamespace.ToString().StartsWith("System") | ||
| ) | ||
| { | ||
| nodeProperties.Add( | ||
| new ModelPathNode( | ||
| cSharpName, | ||
| jsonName, | ||
| typeString, | ||
| GetNodeProperties(propertyNamedTypeSymbol), | ||
| collectionTypeString | ||
| ) | ||
| ); | ||
| } | ||
| else | ||
| { | ||
| nodeProperties.Add(new ModelPathNode(cSharpName, jsonName, typeString, null, collectionTypeString)); | ||
| } | ||
| } | ||
| return nodeProperties; | ||
| } | ||
|
|
||
| private static void GenerateFromNode(SourceProductionContext context, Result<ModelPathNode> result) | ||
| { | ||
| foreach (var diagnostic in result.Diagnostics) | ||
| { | ||
| context.ReportDiagnostic(diagnostic.CreateDiagnostic()); | ||
| } | ||
| if (result is not { Value: { } node }) | ||
| return; | ||
| var sourceText = SourceTextGenerator.SourceTextGenerator.GenerateSourceText(node, "public"); | ||
| context.AddSource(node.Name + "FormDataWrapper.g.cs", sourceText); | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.