Jtikekar/reverting nullables #353

juileetikekar · 2024-09-26T09:16:44Z

Description

Upgrading the AAS Repo APIs to BugFix Version 3.0.2 and fixing the broken Get APIs.

Motivation and Context

Due to refactoring lot of APIs have stopped working. Thus, fixing the API step by step also upgrading the APIs to the latest BugFix Version.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

The APIs have been tested manually and with the aas-test-engine.

Screenshots (if appropriate):

Checklist:

My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works

Revert DTO-nullables, Add Metadata-serializer

Revert nullables, Revert DTO-nullables, Add Metadata-serializer

epgrading to API version 3.0.2

Support for Metadata as per 3.0.2

Support for /submodel-elements and Get + $path

Support for $Path

src/AasCore.Aas3_0/DiaryData/DiaryDataDef.cs

+
+        [XmlIgnore]
+        [JsonIgnore]
+        private DateTime[] _timeStamp = new DateTime[2];


src/IO.Swagger.Lib.V3/Formatters/AasResponseFormatter.cs

+            else if(typeof(IMetadataDTO).IsAssignableFrom(context.ObjectType))
+            {
+                JsonNode? json = MetadataJsonSerializer.ToJsonObject((IMetadataDTO)context.Object);
+                var writer = new Utf8JsonWriter(response.Body);


src/IO.Swagger.Lib.V3/Formatters/AasResponseFormatter.cs

+                    foreach (var item in pagedResult.result)
+                    {
+                        var json = MetadataJsonSerializer.ToJsonObject(item);
+                        jsonArray.Add(json);
+                    }


src/IO.Swagger.Lib.V3/Formatters/AasResponseFormatter.cs

+                    pagingMetadata["cursor"] = cursor;
+                }
+                jsonNode["paging_metadata"] = pagingMetadata;
+                var writer = new Utf8JsonWriter(response.Body);


src/IO.Swagger.Lib.V3/Formatters/AasResponseFormatter.cs

+                {
+                    jsonNode = JsonSerializer.SerializeToNode(pagedResult);
+                }
+                var writer = new Utf8JsonWriter(response.Body);


src/IO.Swagger.Lib.V3/SerializationModifiers/LevelExtent/LevelExtentTransformer.cs

src/IO.Swagger.Lib.V3/SerializationModifiers/Mappers/ValueMappers/ValueOnlyJsonSerializer.cs

-                        var valueNode = JsonSerializer.Deserialize<JsonNode>(valueString);
-                        valueArray.Add(valueNode);
-                    }
+                    var elementNode = ToJsonObject(element, true) as JsonNode;


src/IO.Swagger.Lib.V3/SerializationModifiers/Mappers/ValueMappers/ValueOnlyJsonSerializer.cs

+                return valueObject;
+            }
+
+            if (isParentSML)


src/IO.Swagger.Lib.V3/Services/LevelExtentModifierService.cs

-        var context = new LevelExtentModifierContext(level, extent);
-        return that.Select(source => source != null ? _transformer.Transform(source, context) : null).ToList();
+        private readonly IAppLogger<LevelExtentModifierService> _logger;
+        LevelExtentTransformer _transformer;


src/IO.Swagger.Registry.Lib.V3/Controllers/AssetAdministrationShellRegistryAPIApi.cs

@@ -214,7 +214,7 @@
    [SwaggerResponse(statusCode: 404, type: typeof(Result), description: "Not Found")]
    [SwaggerResponse(statusCode: 500, type: typeof(Result), description: "Internal Server Error")]
    [SwaggerResponse(statusCode: 0, type: typeof(Result), description: "Default error handling for unmentioned status codes")]
-    public virtual IActionResult GetAllSubmodelDescriptorsThroughSuperpath([FromRoute] [Required] string aasIdentifier,
+    public virtual IActionResult GetAllSubmodelDescriptorsThroughSuperpath([FromRoute] [Required] string? aasIdentifier,


To fix the issue, we need to add an authorization check to the GetAllSubmodelDescriptorsThroughSuperpath method. The best way to do this in an ASP.NET Core MVC application is to use the [Authorize] attribute, which ensures that only authenticated users can access the method. If specific roles are required, we can specify them within the attribute.

Add the [Authorize] attribute to the GetAllSubmodelDescriptorsThroughSuperpath method.

Ensure that the necessary imports for authorization are present.

CLAassistant · 2024-09-29T19:33:38Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ juileetikekar
❌ martafullen
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

martafullen · 2024-09-29T19:39:10Z

Added copyright headers.
Note that this branch still contains OPCFoundation dependencies (and so does main), see PR #352

…n-shell-io/aasx-server into jtikekar/revertingNullables

src/AasxServerStandardBib/Services/AssetAdministrationShellService.cs

Change in incorrect level and extent handling

src/AasxServerStandardBib/Services/AssetAdministrationShellService.cs

                    var aasList = new List<IAssetAdministrationShell>();
                    foreach (var assetId in assetIds)
                    {
-                        aasList = output.Where(a => a.AssetInformation.SpecificAssetIds.ContainsSpecificAssetId(assetId)).ToList();
+                        var result = new List<IAssetAdministrationShell>();


src/AasxServerStandardBib/Services/AssetAdministrationShellService.cs

+                            if (assetId.Name.Equals("globalAssetId", StringComparison.OrdinalIgnoreCase))
+                            {
+                                result = output.Where(a => a.AssetInformation.GlobalAssetId!.Equals(assetId.Value)).ToList();
+                            }
+                            else
+                            {
+                                result = output.Where(a => a.AssetInformation.SpecificAssetIds!.ContainsSpecificAssetId(assetId)).ToList();
+                            }


src/IO.Swagger.Lib.V3/Models/OperationRequestValueOnly.cs

+                (
+                    InoutputArguments == other.InoutputArguments ||
+                    InoutputArguments != null &&
+                    InoutputArguments.Equals(other.InoutputArguments)
+                ) && 
+                (
+                    InputArguments == other.InputArguments ||
+                    InputArguments != null &&
+                    InputArguments.Equals(other.InputArguments)
+                ) && 
+                (
+                    ClientTimeoutDuration == other.ClientTimeoutDuration ||
+                    ClientTimeoutDuration != null &&
+                    ClientTimeoutDuration.Equals(other.ClientTimeoutDuration)
+                );


src/IO.Swagger.Lib.V3/Models/OperationRequestValueOnly.cs

+                    if (InoutputArguments != null)
+                    hashCode = hashCode * 59 + InoutputArguments.GetHashCode();


src/IO.Swagger.Lib.V3/Models/OperationRequestValueOnly.cs

+                    if (InputArguments != null)
+                    hashCode = hashCode * 59 + InputArguments.GetHashCode();


src/IO.Swagger.Lib.V3/Models/OperationResultValueOnly.cs

+                    if (InoutputArguments != null)
+                    hashCode = hashCode * 59 + InoutputArguments.GetHashCode();


src/IO.Swagger.Lib.V3/Services/ValidateSerializationModifierService.cs

+            catch (Exception e)
+            {
+                throw new InvalidSerializationModifierException("extent");
+            }


src/IO.Swagger.Lib.V3/Services/ValidateSerializationModifierService.cs

+            {
+                result = Enum.Parse<ExtentEnum>(extent, true);
+            }
+            catch (Exception e)


src/IO.Swagger.Lib.V3/Services/ValidateSerializationModifierService.cs

+            catch(Exception e)
+            {
+                throw new InvalidSerializationModifierException("level");
+            }


src/IO.Swagger.Lib.V3/Services/ValidateSerializationModifierService.cs

+            {
+                result = Enum.Parse<LevelEnum>(level, true);
+            }
+            catch(Exception e)


src/IO.Swagger.Lib.V3/Controllers/DescriptionAPIApi.cs

+        [SwaggerResponse(statusCode: 403, type: typeof(Result), description: "Forbidden")]
+        public virtual IActionResult GetDescription()
+        {
+            var output = new ServiceDescription();


src/IO.Swagger.Lib.V3/Models/ServiceDescription.cs


    /// <inheritdoc cref="IServiceDescription.ToString" />
    public override string ToString()
    {
        var sb = new StringBuilder();
        sb.Append("class ServiceDescription {\n");
-        sb.Append("  Profiles: ").Append(Profiles).Append('\n');
+        sb.Append("  Profiles: ").Append(profiles).Append('\n');


src/IO.Swagger.Lib.V3/Controllers/ConceptDescriptionRepositoryAPIApi.cs

+            var reqIsCaseOf = _jsonQueryDeserializer.DeserializeReference("isCaseOf", isCaseOf);
+            var reqDataSpecificationRef = _jsonQueryDeserializer.DeserializeReference("dataSpecificationRef", dataSpecificationRef);
+
+            var cdList = new List<IConceptDescription>();


src/IO.Swagger.Lib.V3/Services/GenerateSerializationService.cs

            outputEnv.AssetAdministrationShells.AddRange(aasList);
        }

        //Fetch Submodels for the requested submodelIds
        var submodelList = _submodelService.GetAllSubmodels();
        //Using is null or empty, as the query parameter in controll currently receives empty list (not null, but count = 0)
-        if (submodelIds.IsNullOrEmpty())
+        if (!submodelIds.IsNullOrEmpty())


src/IO.Swagger.Lib.V3/Services/GenerateSerializationService.cs

-                                                 .Where(foundSubmodel => foundSubmodel.Any()))
+
+
+        if((bool)includeCD)


Revert nullables, Revert DTO-nullables, Add Metadata-serializer

Upgrading to API version 3.0.2

Remove child elements from MetadataDTOs (3.0.2)

Support for Metadata as per 3.0.2

Support for /submodel-elements and Get + $path

Support for $Path

Change in incorrect level and extent handling

…n-shell-io/aasx-server into jtikekar/revertingNullables

juileetikekar added 18 commits August 23, 2024 13:57

Revert nullables,

bd9177f

Revert DTO-nullables, Add Metadata-serializer

Upgrading to API version 3.0.2

8019df6

Remove child elements from MetadataDTOs (3.0.2)

7903985

Support for Metadata as per 3.0.2

82968b6

Support for /submodel-elements and Get + $path

afcd792

Fix for ExceptionHandling

b1047e9

Support for $Path

970cc96

Support for Level in case of Operation Element

6eb3b40

Rebasing and resoling conflicts

eb02564

Revert nullables, Revert DTO-nullables, Add Metadata-serializer

rebase and resolve conflicts

d0e2e7c

epgrading to API version 3.0.2

Remove child elements from MetadataDTOs (3.0.2)

6294e63

Resolve conflicts

72cb493

Support for Metadata as per 3.0.2

Resolve conflicts

a27d37e

Support for /submodel-elements and Get + $path

Fix for ExceptionHandling

679483b

Resolve conflicts

e4b29fb

Support for $Path

Support for Level in case of Operation Element

3652758

Resolve conflicts

537acf7

Resolve issues after rebase

6522200

juileetikekar requested a review from martafullen September 26, 2024 09:17

github-advanced-security bot found potential problems Sep 26, 2024

View reviewed changes

Headers added

384ba1a

martafullen approved these changes Sep 29, 2024

View reviewed changes

juileetikekar added 3 commits October 15, 2024 09:06

Remove null check on DataSpecRef

9bbbd20

Merge branch 'jtikekar/revertingNullables' of https://github.com/admi…

86dd10c

…n-shell-io/aasx-server into jtikekar/revertingNullables

Support for encoded AssetId in GetAllShells

7058fe9

github-advanced-security bot found potential problems Oct 16, 2024

View reviewed changes

src/AasxServerStandardBib/Services/AssetAdministrationShellService.cs Fixed Show fixed Hide fixed

Upgrade to 3.0.3,

2890023

Change in incorrect level and extent handling

github-advanced-security bot found potential problems Oct 21, 2024

View reviewed changes

Update to BugFix Version 3.0.3

0e3bacc

github-advanced-security bot found potential problems Oct 30, 2024

View reviewed changes

src/IO.Swagger.Lib.V3/Controllers/DescriptionAPIApi.cs Fixed Show fixed Hide fixed

Fix bugs w.r.t., Path and submodel service

a5bc270

github-advanced-security bot found potential problems Oct 31, 2024

View reviewed changes

Upgrade CD APIs to 3.0.3

1b820ad

github-advanced-security bot found potential problems Oct 31, 2024

View reviewed changes

juileetikekar and others added 23 commits October 31, 2024 15:31

Fix tests

ad136e6

Removing support of Path on AnnotatedRelationshipElement

5eb7d44

Support for API Versioning

3ad1ea8

Resolove conflicts with main

58c3465

Revert nullables, Revert DTO-nullables, Add Metadata-serializer

Resolve conflicts with main

186e732

Upgrading to API version 3.0.2

resolve conflicts with main

fda39c7

Remove child elements from MetadataDTOs (3.0.2)

Resolve conflicts with main

ff8d934

Support for Metadata as per 3.0.2

Resolve conflicts with main

6c15c5d

Support for /submodel-elements and Get + $path

Resolve conflicts with main

0f61bdf

Support for $Path

Support for Level in case of Operation Element

8602797

Remove null check on DataSpecRef

6946eed

Headers added

ca45b6f

Support for encoded AssetId in GetAllShells

ad5204a

Upgrade to 3.0.3,

0dd86cd

Change in incorrect level and extent handling

Upgrade to BugFix version 3.0.3

8732300

Update to BugFix Version 3.0.3

1ca0668

Fix bugs w.r.t., Path and submodel service

0c8b7ef

Upgrade CD APIs to 3.0.3

050ed8c

Fix tests

6a881e0

Removing support of Path on AnnotatedRelationshipElement

e92ee14

Support for API Versioning

bf0b061

Merge branch 'jtikekar/revertingNullables' of https://github.com/admi…

933c76a

…n-shell-io/aasx-server into jtikekar/revertingNullables

Correct errors after rebase

de30a84

juileetikekar merged commit d1cffea into main Nov 6, 2024
6 of 7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Jtikekar/reverting nullables #353

Jtikekar/reverting nullables #353

juileetikekar commented Sep 26, 2024 •

edited

Loading

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

CLAassistant commented Sep 29, 2024

martafullen commented Sep 29, 2024

		if (InoutputArguments != null)
		hashCode = hashCode * 59 + InoutputArguments.GetHashCode();

		if (InputArguments != null)
		hashCode = hashCode * 59 + InputArguments.GetHashCode();

		.Where(foundSubmodel => foundSubmodel.Any()))


		if((bool)includeCD)

Jtikekar/reverting nullables #353

Jtikekar/reverting nullables #353

Conversation

juileetikekar commented Sep 26, 2024 • edited Loading

Description

Motivation and Context

Type of change

How Has This Been Tested?

Screenshots (if appropriate):

Checklist:

CLAassistant commented Sep 29, 2024

martafullen commented Sep 29, 2024

juileetikekar commented Sep 26, 2024 •

edited

Loading