feat(aasrepository): restore new implementation after sync with main #90

Prajwala-Adiga · 2025-11-27T04:46:12Z

Description of Changes

This pull request introduces the initial implementation of the Asset Administration Shell (AAS) Repository service in the BaSyx Go components.

#Key Features Added

AAS Repository Service

Introduced a new AAS Repository service following the structure of existing Submodel and Discovery services
Implemented basic CRUD support for Asset Administration Shells:
- GET /shells
- GET /shells/{id}
- POST /shells
- DELETE /shells/{id}

PostgreSQL Persistence Layer

Implemented PostgreSQLAASDatabase backend
Added persistence methods:
- GetAllAAS
- GetAASByID
- InsertAAS
- DeleteAASByID
Refactored insertion logic to use goqu for safer SQL construction
Reduced cognitive complexity by splitting large persistence functions into focused helpers

Database Schema Integration

Integrated AAS tables into the global basyxschema.sql (instead of a service-specific schema)
Added and validated the following AAS-related tables:
- aas
- aas_display_name_ref
- aas_description_ref
- administration
- asset_information
- aas_specific_asset_id
- aas_resource
- asset_information_default_thumbnail
- aas_extension (schema only, not yet used)
Fixed schema ordering, foreign key references, and trigger definitions
Verified schema loading via service startup

AAS Data Model Support

Full persistence and retrieval of:
- Core AAS metadata
- DisplayName
- Description
- AdministrativeInformation
- AssetInformation
- SpecificAssetIds
- DefaultThumbnail
- DerivedFrom references
Explicitly excluded for now (to be implemented in follow-up PRs):
- Extensions
- EmbeddedDataSpecifications
- Submodel references

Testing & Quality Assurance

Added unit tests for the PostgreSQL persistence layer using sqlmock
Added integration tests for the AAS Repository service using Docker Compose
- Service startup validation
- End-to-end POST - GET flow against a real PostgreSQL instance
Fixed all golangci-lint and staticcheck issues (including SA5011 nil-dereference warnings) - in the internal/common/builder/unit_test/reference_builder_test.go

Configuration & Tooling

Updated main.go to:
Initialize database connection
Load global schema
Register AAS routes
Updated launch.json for local debugging
Aligned Docker setup with existing BaSyx services
Ensured compatibility with CI lint configuration

Related Issue #66

Notes for Reviewers

AAS columns (Extensions, EmbeddedDataSpecifications, Submodel linking) are not implemented. They are planned for follow-up PRs once the foundation is reviewed and merged.

Martin187187

You’ve implemented the new endpoints with a minimal version. This is a good starting point. Keep in mind that AssetAdministrationShell contains many more fields, so I assume this was meant as a prototype. I’ve added a few comments for future iterations:

Please use goqu as our query builder. Make sure to review existing patterns so the queries remain consistent with the rest of the codebase.
Make use of the global schema file. Many tables and subqueries can be reused, and this will help avoid duplication and ensure consistent structure.
Use our standard error response format. I included an example in the comments, all new endpoints should follow this structure.

Let me know if you need any guidance integrating these points.

.vscode/launch.json

internal/aasrepository/api/api_asset_administration_shell_repository_api_service.go

cmd/aasrepositoryservice/resources/sql/aasschema.sql

internal/aasrepository/persistence/PostgreSQLAASDatabase.go

… Administration, AssetInformation, DerivedFrom

…ry-v2

Martin187187

I’ve reviewed your changes and see two critical points:

Scalability of the GET request: The current implementation does not scale well with the number of AAS entries in the database. Ideally, the number of queries should remain constant, regardless of how much data is stored.
Code reuse and batching: A significant amount of existing code could be reused (e.g. LangStringNameTypes, LangStringTextTypes, SpecificAssetIds). These utilities are already highly optimized because they operate in batches. Reusing them would both improve performance and increase overall code quality and consistency.

The first point is particularly important from a scalability perspective. The second point is more about maintainability and quality, but it could still have a positive performance impact.
Feel free to share your thoughts—happy to discuss trade-offs or alternative approaches.

basyxschema.sql

Martin187187 · 2025-12-18T08:58:44Z

basyxschema.sql

+
+
+CREATE TABLE IF NOT EXISTS aas_extension (
+    aas_id VARCHAR(2048) NOT NULL REFERENCES aas(id) ON DELETE CASCADE,


use the primary key to reference to aas

@Martin187187 Could you help me understand this comment? 'id' is the PK for the table aas

CREATE TABLE IF NOT EXISTS aas ( id VARCHAR(2048) PRIMARY KEY, id_short VARCHAR(2048), category VARCHAR(2048), model_type VARCHAR(128) NOT NULL, administration_id BIGINT REFERENCES administrative_information(id), asset_information_id BIGINT REFERENCES asset_information(id), derived_from_reference_id BIGINT REFERENCES reference(id) );

Sorry, my explanation is extremly bad here. What i meant:

Create a new primary key in aas that is an integer.

make id unique in aas table. use the new primary key for references as it is more efficient to use integer in relationships (less byte)
This doesnt change any logic but would be best practice for designing schemas.

Martin187187 · 2025-12-18T09:29:55Z

internal/aasrepository/persistence/PostgreSQLAASDatabase.go

+	return ai, nil
+}
+
+func (p *PostgreSQLAASDatabase) insertReference(ref *model.Reference) (int64, error) {


you can use existing code: https://github.com/Prajwala-Adiga/basyx-go-components/blob/aasrepository-v2/internal/submodelrepository/persistence/utils/PostgreSQLSharedUtils.go#L479

Martin187187 · 2025-12-18T09:31:34Z

internal/aasrepository/persistence/PostgreSQLAASDatabase.go

+
+// insertDisplayName inserts the DisplayName entries for the AAS.
+func (p *PostgreSQLAASDatabase) insertDisplayName(aas model.AssetAdministrationShell) error {
+	if len(aas.DisplayName) == 0 {


you could use existing code: https://github.com/Prajwala-Adiga/basyx-go-components/blob/aasrepository-v2/internal/submodelrepository/persistence/utils/PostgreSQLSharedUtils.go#L645

Martin187187 · 2025-12-18T09:32:08Z

internal/aasrepository/persistence/PostgreSQLAASDatabase.go

+}
+
+// insertDescription inserts the Description entries for the AAS.
+func (p *PostgreSQLAASDatabase) insertDescription(aas model.AssetAdministrationShell) error {


you can use existing code: https://github.com/Prajwala-Adiga/basyx-go-components/blob/aasrepository-v2/internal/submodelrepository/persistence/utils/PostgreSQLSharedUtils.go#L678

Martin187187 · 2025-12-18T09:34:09Z

internal/aasrepository/persistence/PostgreSQLAASDatabase.go

+	// 3) Specific Asset IDs
+	for _, sid := range aas.AssetInformation.SpecificAssetIds {
+		query, _, err = dialect.
+			Insert("aas_specific_asset_id").
+			Rows(goqu.Record{
+				"asset_information_id": assetInfoID,
+				"name":                 sid.Name,
+				"value":                sid.Value,
+				"semantic_id":          sid.SemanticID,
+				"external_subject_id":  sid.ExternalSubjectID,
+			}).
+			ToSQL()
+		if err != nil {
+			return err
+		}
+		if _, err = p.DB.Exec(query); err != nil {
+			return err
+		}
+	}


you could use existing code if you reuse the specific asset table: https://github.com/Prajwala-Adiga/basyx-go-components/blob/aasrepository-v2/internal/common/descriptors/WriteSpecificAssetId.go

Martin187187 · 2025-12-18T09:35:52Z

internal/aasrepository/persistence/PostgreSQLAASDatabase.go

+	for _, d := range aas.Description {
+		query, _, err = dialect.
+			Insert("lang_string_text_type").
+			Rows(goqu.Record{
+				"lang_string_text_type_reference_id": descRefID,
+				"language":                           d.Language,
+				"text":                               d.Text,
+			}).
+			ToSQL()
+		if err != nil {
+			return err
+		}
+		if _, err = p.DB.Exec(query); err != nil {
+			return err
+		}
+	}


you could reuse code that handles that in a batched requests: https://github.com/Prajwala-Adiga/basyx-go-components/blob/aasrepository-v2/internal/common/descriptors/ReadLanguages.go

FriedJannik

I added some things i caught - i think Martin reviewed the rest :)

FriedJannik · 2025-12-18T09:39:25Z

basyxschema.sql

    CREATE TYPE modelling_kind AS ENUM ('Instance', 'Template');
 END IF;
-END $$;
+END;


There are a lot of these changes - are those necessarry? If o, would you mind reverting them so that the diff is not that large ? :)

These were the changes that were giving me compilation errors. So, I was forced to make these changes. But to give the benefit of doubt, I can revert them and test them again for completeness.

FriedJannik · 2025-12-18T09:40:10Z

basyxschema.sql

+
+CREATE TABLE IF NOT EXISTS asset_information (
+    id BIGSERIAL PRIMARY KEY,
+    asset_kind VARCHAR(64),


Please use the ENUM here (cf ll.136-141)

FriedJannik · 2025-12-18T09:41:48Z

cmd/aasrepositoryservice/Dockerfile

+
+
+# ---------- Runtime stage ----------
+FROM alpine:3.19


Please use alpine 3.22 here aswell

Suggested change

FROM alpine:3.19

FROM alpine:3.22

FriedJannik · 2025-12-18T09:42:34Z

cmd/aasrepositoryservice/resources/sql/aasschema.sql

Is this file needed?

Martin187187 · 2025-12-18T10:26:24Z

I just noticed that the current specficAssetId table has descriptorId as a column. Therefore this table cannot be reused.

… to avoid compile errors

…t IDs

Prajwala-Adiga added 2 commits November 27, 2025 05:35

feat(aasrepository): restore new implementation after sync with main

5a7d589

cleanup: lint errors fixed

05684c8

Prajwala-Adiga requested review from Martin187187 and aaronzi November 27, 2025 05:18

Martin187187 reviewed Nov 27, 2025

View reviewed changes

Prajwala-Adiga added 8 commits December 2, 2025 06:43

fix: using esisting helpers for error responses

3a69cc2

fix: modify persistence to use goqu query builder

6d9cf0d

universal schema adapted

53e493d

feat:add full nested field support for AAS: DisplayName, Description,…

4c795a8

… Administration, AssetInformation, DerivedFrom

fix: merge with main

b311314

fix: lint errors

b84a5bf

Merge remote-tracking branch 'origin/main' into aasrepository-v2

6756eb2

fix:merge conflicts resolved

8a7e8d7

Prajwala-Adiga requested a review from Martin187187 December 11, 2025 10:52

Prajwala-Adiga and others added 5 commits December 17, 2025 13:21

fix: updated schema table name for aas_resource and fixed syntax errors

85ae397

Merge branch 'main' into aasrepository-v2

facc1f2

fix: lint errors

1c66e22

Merge remote-tracking branch 'fork/aasrepository-v2' into aasreposito…

a729d9a

…ry-v2

fix: lint errors-2

97ee80a

Prajwala-Adiga requested a review from FriedJannik December 17, 2025 13:44

Prajwala-Adiga marked this pull request as draft December 17, 2025 13:54

Prajwala-Adiga added 6 commits December 17, 2025 16:42

test: add sqlmock unit tests for AAS PostgreSQL persistence

e41d98e

chore: add Dockerfile for AAS repository service

4589535

test(integration): add AAS repository integration tests

6aa0826

clean:fix lint errors

c239039

clean:fix lint errors

6bb6488

clean:fix lint errors

6a0d8b1

Martin187187 suggested changes Dec 18, 2025

View reviewed changes

FriedJannik requested changes Dec 18, 2025

View reviewed changes

Prajwala-Adiga added 7 commits December 19, 2025 11:07

fix: added correct aas_resource table reference, restructuring schema…

6884fb4

… to avoid compile errors

fix: make asset_information table use enum

90c3caf

fix:deleted unwanted files and added correct version numbers

bab30bd

schema add: add supplemental semantic ID link table for specific asse…

fade075

…t IDs

refactor(aas): move minimal AAS validation to model layer

062f274

fix(aas-repository): return 409 on duplicate AAS creation

de96a44

changed integration test format to match other repositories

d3c7f87



		CREATE TABLE IF NOT EXISTS aas_extension (
		aas_id VARCHAR(2048) NOT NULL REFERENCES aas(id) ON DELETE CASCADE,

feat(aasrepository): restore new implementation after sync with main #90

Are you sure you want to change the base?

feat(aasrepository): restore new implementation after sync with main #90

Uh oh!

Conversation

Prajwala-Adiga commented Nov 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Changes

Related Issue #66

Uh oh!

Martin187187 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Martin187187 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FriedJannik left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Martin187187 commented Dec 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Prajwala-Adiga commented Nov 27, 2025 •

edited

Loading