feat: WebDAV endpoint support

FraunhoferIOSB · Feb 24, 2024 · e3ec10a · e3ec10a
1 parent 6f2a7ca
commit e3ec10a
Show file tree

Hide file tree

Showing 73 changed files with 7,831 additions and 729 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -31,7 +31,7 @@
                 "USER_STORAGE": "mongodb://localhost:27017/aasportal-users",
                 "TEMPLATE_STORAGE": "http://localhost:8080/templates",
                 "AAS_INDEX": "mysql://localhost:3306",
-                "ENDPOINTS": "[\"file:///endpoints/samples?name=Samples\",\"http://localhost:5001?name:AASX%20Server\"]",
+                "ENDPOINTS": "[\"file:///endpoints/samples?name=Samples\",\"http://localhost:5001?name=AASX%20Server\", \"http://localhost:8080/endpoints/idta?name=IDTA\"]",
             }
         },
         {

diff --git a/projects/aas-lib/src/lib/aas-tree/aas-tree-search.ts b/projects/aas-lib/src/lib/aas-tree/aas-tree-search.ts
@@ -320,6 +320,10 @@ export class AASTreeSearch {
             }
             case 'ReferenceElement': {
                 const referenceElement = referable as aas.ReferenceElement;
+                if (!referenceElement.value) {
+                    return false;
+                }
+
                 return referenceElement.value.keys.some(key => this.containsString(key.value, value as string));
             }
             case 'MultiLanguageProperty': {

diff --git a/projects/aas-lib/src/lib/aas-tree/aas-tree.component.ts b/projects/aas-lib/src/lib/aas-tree/aas-tree.component.ts
@@ -22,11 +22,9 @@ import {
     AASDocument,
     convertToString,
     toLocale,
-    EndpointType,
     selectSubmodel,
     getIdShortPath,
     mimeTypeToExtension,
-    AASEndpointType,
 } from 'common';
 
 import { AASTreeRow, AASTreeFeatureState } from './aas-tree.state';
@@ -513,17 +511,6 @@ export class AASTreeComponent implements OnInit, OnChanges, OnDestroy {
         }
     }
 
-    private toEndpointType(type: AASEndpointType): EndpointType {
-        switch (type) {
-            case 'OpcuaServer':
-                return 'opc';
-            case 'AasxDirectory':
-                return 'file';
-            default:
-                return 'http';
-        }
-    }
-
     private stop(): void {
         if (this.webSocketSubject) {
             this.webSocketSubject.unsubscribe();

diff --git a/projects/aas-lib/src/lib/aas-tree/aas-tree.state.ts b/projects/aas-lib/src/lib/aas-tree/aas-tree.state.ts
@@ -279,7 +279,7 @@ class TreeInitialize {
                     return blob.contentType ? `${blob.idShort}${extension}` : '-';
                 }
                 case 'ReferenceElement':
-                    return (referable as aas.ReferenceElement).value.keys.map(item => item.value).join('/');
+                    return (referable as aas.ReferenceElement).value?.keys.map(item => item.value).join('/');
                 case 'RelationshipElement':
                     return this.getRelationshipElementValue(referable as aas.RelationshipElement);
                 case 'MultiLanguageProperty':

diff --git a/projects/aas-lib/src/test/assets/test-document.ts b/projects/aas-lib/src/test/assets/test-document.ts
@@ -13,7 +13,7 @@ export function createContainer(url: string, documents: AASDocument[]): AASConta
         documents: documents,
         url: url,
         name: url,
-        type: 'AasxDirectory'
+        type: 'FileSystem'
     };
 }
 

diff --git a/projects/aas-lib/src/test/template.service.spec.ts b/projects/aas-lib/src/test/template.service.spec.ts
@@ -35,7 +35,6 @@ describe('TemplateService', () => {
             idShort: '',
             modelType: 'Property',
             endpoint: { type: 'file', address: 'property.json' },
-            template: null,
         };
 
         const url = `/api/v1/templates`;

diff --git a/projects/aas-portal/src/app/configuration.ts b/projects/aas-portal/src/app/configuration.ts
diff --git a/projects/aas-portal/src/app/dashboard/dashboard.service.ts b/projects/aas-portal/src/app/dashboard/dashboard.service.ts
@@ -380,7 +380,7 @@ export class DashboardService {
         switch (type) {
             case 'OpcuaServer':
                 return 'opc';
-            case 'AasxDirectory':
+            case 'FileSystem':
                 return 'file';
             default:
                 return 'http';

diff --git a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.ts b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.ts
@@ -29,8 +29,8 @@ export class AddEndpointFormComponent {
     ) {
         this.items = [
             {
-                name: this.translate.instant('AASEndpointType.AasxServer'),
-                type: 'AasxServer',
+                name: this.translate.instant('AASEndpointType.AASServer'),
+                type: 'AASServer',
                 value: 'http://',
             },
             {
@@ -39,22 +39,27 @@ export class AddEndpointFormComponent {
                 value: 'opc.tcp://',
             },
             {
-                name: this.translate.instant('AASEndpointType.AasxDirectory'),
-                type: 'AasxDirectory',
+                name: this.translate.instant('AASEndpointType.WebDAV'),
+                type: 'WebDAV',
+                value: 'http://',
+            },
+            {
+                name: this.translate.instant('AASEndpointType.FileSystem'),
+                type: 'FileSystem',
                 value: 'file:///',
             },
         ];
 
         this.item = this.items[0];
     }
 
-    public endpoints: string[] = [];
+    public endpoints: AASEndpoint[] = [];
 
     public messages: string[] = [];
 
     public name = '';
 
-    public version = '3.0';
+    public version = 'v3';
 
     public readonly items: EndpointItem[];
 
@@ -95,8 +100,8 @@ export class AddEndpointFormComponent {
             this.messages.push(this.createMessage('ERROR_EMPTY_ENDPOINT_NAME'));
             name = undefined;
         } else {
-            for (const workspace of this.endpoints) {
-                if (workspace.toLocaleLowerCase() === name.toLocaleLowerCase()) {
+            for (const endpoint of this.endpoints) {
+                if (endpoint.name.toLocaleLowerCase() === name.toLocaleLowerCase()) {
                     this.messages.push(this.createMessage('ERROR_ENDPOINT_ALREADY_EXIST', name));
                     name = undefined;
                     break;
@@ -110,22 +115,18 @@ export class AddEndpointFormComponent {
     private validateUrl(value: string): URL | undefined {
         try {
             const url = new URL(value);
-            switch (url.protocol) {
-                case 'opc.tcp:':
-                    if (url.pathname === '//') {
-                        throw new Error('Empty pathname.');
-                    }
+            switch (this.item.type) {
+                case 'AASServer':
+                    this.validateAASServerEndpoint(url);
+                    break;
+                case 'FileSystem':
+                    this.validateFileSystemEndpoint(url);
                     break;
-                case 'http:':
+                case 'OpcuaServer':
+                    this.validateOpcuaEndpoint(url);
                     break;
-                case 'file:':
-                    if (url.hostname !== '') {
-                        throw new Error(`Invalid host name ${url.hostname}.`);
-                    }
-
-                    if (url.pathname === '/') {
-                        throw new Error('Empty pathname.');
-                    }
+                case 'WebDAV':
+                    this.validateWebDAVEndpoint(url);
                     break;
             }
 
@@ -139,4 +140,48 @@ export class AddEndpointFormComponent {
     private createMessage(id: string, ...args: unknown[]): string {
         return stringFormat(this.translate.instant(id), args);
     }
+
+    private validateAASServerEndpoint(url: URL): void {
+        if (url.protocol !== 'http:' && url.protocol !== 'https:') {
+            throw new Error('Protocol "http:" or "https:" expected.');
+        }
+
+        if (url.pathname !== '/') {
+            throw new Error(`Unexpected pathname "${url.pathname}".`);
+        }
+    }
+
+    private validateFileSystemEndpoint(url: URL): void {
+        if (url.protocol !== 'file:') {
+            throw new Error('Protocol "file:" expected');
+        }
+
+        if (url.hostname !== '') {
+            throw new Error(`Invalid host name ${url.hostname}.`);
+        }
+
+        if (url.pathname === '/') {
+            throw new Error('Empty pathname.');
+        }
+    }
+
+    private validateOpcuaEndpoint(url: URL): void {
+        if (url.protocol !== 'opc.tcp:') {
+            throw new Error('Protocol "opc.tcp:" expected.');
+        }
+
+        if (url.pathname === '//' || url.pathname === '/') {
+            throw new Error('Empty pathname.');
+        }
+    }
+
+    private validateWebDAVEndpoint(url: URL): void {
+        if (url.protocol !== 'http:' && url.protocol !== 'https:') {
+            throw new Error('Protocol "http:" or "https:" expected.');
+        }
+
+        if (url.pathname === '/') {
+            throw new Error('Empty pathname.');
+        }
+    }
 }
diff --git a/projects/aas-portal/src/app/start/start.component.ts b/projects/aas-portal/src/app/start/start.component.ts
@@ -185,7 +185,7 @@ export class StartComponent implements OnDestroy, AfterViewInit {
             mergeMap(() => this.api.getEndpoints()),
             map(endpoints => {
                 const modalRef = this.modal.open(AddEndpointFormComponent, { backdrop: 'static' });
-                modalRef.componentInstance.workspaces = endpoints;
+                modalRef.componentInstance.endpoints = endpoints;
                 return modalRef;
             }),
             mergeMap(modalRef => from<Promise<AASEndpoint | undefined>>(modalRef.result)),

diff --git a/projects/aas-portal/src/assets/i18n/de-de.json b/projects/aas-portal/src/assets/i18n/de-de.json
@@ -163,9 +163,9 @@
     "OPTION_BAR_VERTICAL_CHART": "Balkendiagramm vertikal",
     "OPTION_BAR_HORIZONTAL_CHART": "Balkendiagramm horizontal",
     "AASEndpointType": {
-        "AasxDirectory": "Verzeichnis",
-        "AasxServer": "AASX-Server",
-        "AASRegistry": "AAS-Registry",
+        "FileSystem": "Verzeichnis",
+        "AASServer": "AAS-Server",
+        "WebDAV": "Cloud-Server",
         "OpcuaServer": "OPC-UA-Server"
     },
     "CustomerFeedback": {

diff --git a/projects/aas-portal/src/assets/i18n/en-us.json b/projects/aas-portal/src/assets/i18n/en-us.json
@@ -163,9 +163,9 @@
     "OPTION_BAR_VERTICAL_CHART": "Vertical bar chart",
     "OPTION_BAR_HORIZONTAL_CHART": "Horizontal bar chart",
     "AASEndpointType": {
-        "AasxDirectory": "Directory",
-        "AasxServer": "AASX Server",
-        "AASRegistry": "AAS Registry",
+        "FileSystem": "File system",
+        "AASServer": "AAS server",
+        "WebDAV": "Cloud server",
         "OpcuaServer": "OPC UA Server"
     },
     "CustomerFeedback": {

diff --git a/projects/aas-portal/src/test/aas/new-element-command.spec.ts b/projects/aas-portal/src/test/aas/new-element-command.spec.ts
@@ -28,14 +28,12 @@ describe('NewElementCommand', function () {
 
         TestBed.configureTestingModule({
             declarations: [],
-            providers: [
-            ],
+            providers: [],
             imports: [
-                StoreModule.forRoot(
-                    {
-                        aas: aasReducer
-                    }),
-            ]
+                StoreModule.forRoot({
+                    aas: aasReducer,
+                }),
+            ],
         });
 
         store = TestBed.inject(Store);
@@ -47,25 +45,34 @@ describe('NewElementCommand', function () {
     });
 
     it('can be executed', function (done: DoneFn) {
-        store.select(state => state.aas.document).pipe(first()).subscribe(document => {
-            const element = selectElement(document!.content!, 'TechnicalData');
-            expect(element).toBeDefined();
-            done();
-        });
+        store
+            .select(state => state.aas.document)
+            .pipe(first())
+            .subscribe(document => {
+                const element = selectElement(document!.content!, 'TechnicalData');
+                expect(element).toBeDefined();
+                done();
+            });
     });
 
     it('can be undone/redone', function (done: DoneFn) {
         command.undo();
-        store.select(state => state.aas.document).pipe(first()).subscribe(document => {
-            const element = selectElement(document!.content!, 'TechnicalData');
-            expect(element).toBeUndefined();
-        });
+        store
+            .select(state => state.aas.document)
+            .pipe(first())
+            .subscribe(document => {
+                const element = selectElement(document!.content!, 'TechnicalData');
+                expect(element).toBeUndefined();
+            });
 
         command.redo();
-        store.select(state => state.aas.document).pipe(first()).subscribe(document => {
-            const element = selectElement(document!.content!, 'TechnicalData');
-            expect(element).toBeDefined();
-            done();
-        });
+        store
+            .select(state => state.aas.document)
+            .pipe(first())
+            .subscribe(document => {
+                const element = selectElement(document!.content!, 'TechnicalData');
+                expect(element).toBeDefined();
+                done();
+            });
     });
-});
+});
diff --git a/projects/aas-portal/src/test/assets/test-document.ts b/projects/aas-portal/src/test/assets/test-document.ts
@@ -13,7 +13,7 @@ export function createContainer(url: string, documents: AASDocument[]): AASConta
         documents: documents,
         url: url,
         name: url,
-        type: 'AasxServer'
+        type: 'AASServer'
     };
 }