From dc7f3ed89f1d169c5f1dace261060dc896ed9215 Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Sun, 13 Oct 2024 22:06:59 +0200 Subject: [PATCH 01/76] fix: add headers to AASEndpoint --- projects/aas-core/src/lib/types.ts | 1 + .../add-endpoint-form.component.html | 63 +++++++- .../add-endpoint-form.component.ts | 116 ++++++++++--- .../aas-portal/src/assets/i18n/de-de.json | 15 +- .../aas-portal/src/assets/i18n/en-us.json | 13 +- .../src/app/aas-index/mysql/mysql-index.ts | 4 +- .../src/app/aas-index/mysql/mysql-types.ts | 10 +- .../aas-provider/aas-resource-scan-factory.ts | 17 +- .../src/app/live/http/http-subscription.ts | 2 +- .../src/app/packages/aas-resource-factory.ts | 28 ++-- .../src/app/packages/aas-resource.ts | 7 +- .../packages/aas-server/aas-api-client-v0.ts | 19 +-- .../packages/aas-server/aas-api-client-v1.ts | 75 ++++++--- .../packages/aas-server/aas-api-client-v3.ts | 79 ++++++--- .../app/packages/aas-server/aas-api-client.ts | 23 +-- .../packages/aas-server/aas-server-package.ts | 2 +- .../packages/file-system/aasx-directory.ts | 16 +- .../app/packages/file-system/aasx-package.ts | 2 +- .../{server-message.ts => http-client.ts} | 50 ++++-- .../src/app/packages/opcua/opcua-client.ts | 10 +- .../src/app/packages/opcua/opcua-package.ts | 6 +- .../src/app/template/template-scan.ts | 17 +- .../src/app/template/template-storage.ts | 17 +- .../aas-server/aas-api-client-v0.spec.ts | 137 ++++++++-------- .../aas-server/aas-api-client-v3.spec.ts | 152 ++++-------------- .../aas-server/aas-server-package.spec.ts | 3 +- ...er-message.spec.ts => http-client.spec.ts} | 50 +++--- projects/aasportal-index/schema.sql | 3 +- 28 files changed, 532 insertions(+), 405 deletions(-) rename projects/aas-server/src/app/packages/{server-message.ts => http-client.ts} (83%) rename projects/aas-server/src/test/packages/{server-message.spec.ts => http-client.spec.ts} (82%) diff --git a/projects/aas-core/src/lib/types.ts b/projects/aas-core/src/lib/types.ts index 25053dd7..a0746c97 100644 --- a/projects/aas-core/src/lib/types.ts +++ b/projects/aas-core/src/lib/types.ts @@ -54,6 +54,7 @@ export type AASEndpoint = { url: string; type: AASEndpointType; version?: string; + headers?: Record; }; /** Represents a server (AASX, OPC-UA) or file directory (AASX package files). */ diff --git a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html index 65e046d3..e24a0b7e 100644 --- a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html +++ b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html @@ -22,22 +22,73 @@

} - + - +
- +
@for (item of items(); track item) { - + }
+ @if (item().type === 'AAS_API') { +
+ + + + + + + + + @for (header of headers(); track header.name) { + + + + + + + } + +
+ + + @if (!header.selected) { +
{{header.name}}
+ } @else { + + } + 		+ @if (!header.selected) { +
{{header.value}}
+ } @else { + + } + 		+ @if (header === lastHeader()) { + + + + } @else { + + + + } +
+
+ }
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 index f49fe1ab..c897ecd9 100644 --- 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 @@ -6,16 +6,25 @@ * *****************************************************************************/ -import { ChangeDetectionStrategy, Component, signal } from '@angular/core'; +import head from 'lodash-es/head'; +import { ChangeDetectionStrategy, Component, computed, signal } from '@angular/core'; import { FormsModule } from '@angular/forms'; import { NgbActiveModal, NgbDropdownModule, NgbToast } from '@ng-bootstrap/ng-bootstrap'; import { TranslateModule, TranslateService } from '@ngx-translate/core'; import { AASEndpoint, AASEndpointType, stringFormat } from 'aas-core'; -export interface EndpointItem { +export interface HeaderItem { name: string; + value: string; + selected: boolean; +} + +export interface EndpointItem { type: AASEndpointType; value: string; + placeholder: string; + headers: HeaderItem[]; + selected: boolean; } @Component({ @@ -28,48 +37,69 @@ export interface EndpointItem { }) export class AddEndpointFormComponent { private readonly endpoints = signal([]); - public readonly _messages = signal([]); - - public constructor( - private modal: NgbActiveModal, - private translate: TranslateService, - ) {} - - public readonly messages = this._messages.asReadonly(); - - public readonly name = signal(''); - - public readonly items = signal([ + private readonly _messages = signal([]); + private readonly _items = signal([ { - name: this.translate.instant('AASEndpointType.AAS_API'), type: 'AAS_API', - value: 'http://', + value: '', + placeholder: 'AddEndpointForm.PLACEHOLDER_URL_HTTP', + headers: [{ name: '', value: '', selected: true }], + selected: true, }, { - name: this.translate.instant('AASEndpointType.OPC_UA'), type: 'OPC_UA', - value: 'opc.tcp://', + value: '', + placeholder: 'AddEndpointForm.PLACEHOLDER_URL_OPCUA', + headers: [{ name: '', value: '', selected: true }], + selected: false, }, { - name: this.translate.instant('AASEndpointType.WebDAV'), type: 'WebDAV', - value: 'http://', + value: '', + placeholder: 'AddEndpointForm.PLACEHOLDER_URL_WEBDAV', + headers: [{ name: '', value: '', selected: true }], + selected: false, }, { - name: this.translate.instant('AASEndpointType.FileSystem'), type: 'FileSystem', - value: 'file:///', + value: '', + placeholder: 'AddEndpointForm.PLACEHOLDER_URL_FILE', + headers: [{ name: '', value: '', selected: true }], + selected: false, }, - ]).asReadonly(); + ]); + + public constructor( + private modal: NgbActiveModal, + private translate: TranslateService, + ) {} - public readonly item = signal(this.items()[0]); + public readonly name = signal(''); + + public readonly messages = this._messages.asReadonly(); + + public readonly items = this._items.asReadonly(); + + public readonly item = computed(() => this._items().find(item => item.selected)!); + + public readonly headers = computed(() => this.item().headers); + + public readonly header = computed(() => this.item().headers.find(header => header.selected)!); + + public readonly lastHeader = computed(() => head(this.headers())!); public initialize(endpoints: AASEndpoint[]): void { this.endpoints.set(endpoints); } public setItem(value: EndpointItem): void { - this.item.set(value); + this._items.update(items => + items.map(item => { + item.selected = item === value; + return item; + }), + ); + this.clearMessages(); } @@ -77,6 +107,36 @@ export class AddEndpointFormComponent { this.clearMessages(); } + public addHeader(): void { + this._items.update(items => + items.map(item => { + if (item.selected) { + const headers = item.headers.map(header => { + header.selected = false; + return header; + }); + + headers.push({ name: '', value: '', selected: true }); + item.headers = headers; + } + + return item; + }), + ); + } + + public removeHeader(header: HeaderItem): void { + this._items.update(items => + items.map(item => { + if (item.selected) { + item.headers = item.headers.filter(head => head !== header); + } + + return item; + }), + ); + } + public submit(): void { this.clearMessages(); const name = this.validateName(); @@ -91,6 +151,12 @@ export class AddEndpointFormComponent { endpoint.version = 'v3'; } + const headers = this.item().headers.filter(header => header.name && header.value); + if (headers.length > 0) { + endpoint.headers = {}; + headers.forEach(header => (endpoint.headers![header.name] = header.value)); + } + this.modal.close(endpoint); } } diff --git a/projects/aas-portal/src/assets/i18n/de-de.json b/projects/aas-portal/src/assets/i18n/de-de.json index e7ce96b3..a6429b7a 100644 --- a/projects/aas-portal/src/assets/i18n/de-de.json +++ b/projects/aas-portal/src/assets/i18n/de-de.json @@ -88,8 +88,6 @@ "LABEL_SELECT_WORKSPACE": "Gruppe", "LABEL_SELECT_REGISTRY": "AAS-Registry", "LABEL_SHOW_ALL": "Alle anzeigen", - "LABEL_ENDPOINT_NAME": "Name", - "LABEL_ENDPOINT_URL": "URL", "LABEL_VIEW_MODE": "Anzeige:", "LABEL_INFO": "Info", "LABEL_WARNING": "Warnungen", @@ -118,8 +116,6 @@ "PLACEHOLDER_NEW_PASSWORD": "Neues Passwort eingeben", "PLACEHOLDER_REPEAT_PASSWORD": "Passwort bestätigen", "PLACEHOLDER_USERNAME": "Namen eingeben", - "PLACEHOLDER_ENDPOINT_URL": "URL eingeben", - "PLACEHOLDER_ENDPOINT_NAME": "Name eingeben", "PLACEHOLDER_FILTER": "Filter", "PLACEHOLDER_WORKSPACE": "Gruppenname", "PLACEHOLDER_SEARCH": "Suche", @@ -178,11 +174,18 @@ "OPTION_BAR_HORIZONTAL_CHART": "Balkendiagramm horizontal", "TEXT_ADD_FAVORITE": "1 Favorit hinzufügen ({0}).", "TEXT_ADD_FAVORITES": "{0} Favoriten hinzufügen ({1}).", - "AASEndpointType": { + "AddEndpointForm": { "FileSystem": "Dateisystem", "AAS_API": "AAS API", "WebDAV": "WebDAV", - "OPC_UA": "OPC UA" + "OPC_UA": "OPC UA", + "LABEL_NAME": "Name", + "LABEL_URL": "URL", + "PLACEHOLDER_NAME": "eindeutigen Namen eingeben", + "PLACEHOLDER_URL_FILE": "file:///", + "PLACEHOLDER_URL_HTTP": "http(s)://", + "PLACEHOLDER_URL_OPCUA": "opc.tcp://", + "PLACEHOLDER_URL_WEBDAV": "http(s)://" }, "CustomerFeedback": { "OverallRating": "Gesamtbewertung", diff --git a/projects/aas-portal/src/assets/i18n/en-us.json b/projects/aas-portal/src/assets/i18n/en-us.json index cf300cf0..2da15364 100644 --- a/projects/aas-portal/src/assets/i18n/en-us.json +++ b/projects/aas-portal/src/assets/i18n/en-us.json @@ -118,8 +118,6 @@ "PLACEHOLDER_NEW_PASSWORD": "enter new password", "PLACEHOLDER_CONFIRM_PASSWORD": "confirm password", "PLACEHOLDER_USERNAME": "enter a name", - "PLACEHOLDER_ENDPOINT_URL": "enter an URL", - "PLACEHOLDER_ENDPOINT_NAME": "enter a name", "PLACEHOLDER_FILTER": "Filter", "PLACEHOLDER_WORKSPACE": "group name", "PLACEHOLDER_SEARCH": "Search", @@ -177,11 +175,18 @@ "OPTION_BAR_HORIZONTAL_CHART": "Horizontal bar chart", "TEXT_ADD_FAVORITE": "Add 1 favorite ({0}).", "TEXT_ADD_FAVORITES": "Add {0} favorites ({1}).", - "AASEndpointType": { + "AddEndpointForm": { "FileSystem": "File system", "AAS_API": "AAS API", "WebDAV": "WebDAV", - "OPC_UA": "OPC UA" + "OPC_UA": "OPC UA", + "LABEL_NAME": "Name", + "LABEL_URL": "URL", + "PLACEHOLDER_NAME": "enter a unique name", + "PLACEHOLDER_URL_FILE": "file:///", + "PLACEHOLDER_URL_HTTP": "http(s)://", + "PLACEHOLDER_URL_OPCUA": "opc.tcp://", + "PLACEHOLDER_URL_WEBDAV": "http(s)://" }, "CustomerFeedback": { "OverallRating": "Overall rating", diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts index a4083187..da7fd15e 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts @@ -38,6 +38,7 @@ export class MySqlIndex extends AASIndex { url: row.url, type: row.type, version: row.version, + headers: row.headers ? JSON.parse(row.headers) : undefined, }) as AASEndpoint, ); } @@ -67,11 +68,12 @@ export class MySqlIndex extends AASIndex { public override async addEndpoint(endpoint: AASEndpoint): Promise { await ( await this.connection - ).query('INSERT INTO `endpoints` (name, url, type, version) VALUES (?, ?, ?, ?)', [ + ).query('INSERT INTO `endpoints` (name, url, type, version, headers) VALUES (?, ?, ?, ?, ?)', [ endpoint.name, endpoint.url, endpoint.type, endpoint.version, + endpoint.headers ? JSON.stringify(endpoint.headers) : undefined, ]); } diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts index f72bdf82..2d560da5 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts @@ -7,9 +7,15 @@ *****************************************************************************/ import { RowDataPacket } from 'mysql2/promise'; -import { AASEndpoint, AASDocument } from 'aas-core'; +import { AASDocument, AASEndpointType } from 'aas-core'; -export interface MySqlEndpoint extends AASEndpoint, RowDataPacket {} +export interface MySqlEndpoint extends RowDataPacket { + name: string; + url: string; + type: AASEndpointType; + version?: string; + headers?: string; +} export interface MySqlDocument extends AASDocument, RowDataPacket { uuid: string; diff --git a/projects/aas-server/src/app/aas-provider/aas-resource-scan-factory.ts b/projects/aas-server/src/app/aas-provider/aas-resource-scan-factory.ts index 70b2a6df..4aae34bb 100644 --- a/projects/aas-server/src/app/aas-provider/aas-resource-scan-factory.ts +++ b/projects/aas-server/src/app/aas-provider/aas-resource-scan-factory.ts @@ -20,12 +20,14 @@ import { AASApiClientV3 } from '../packages/aas-server/aas-api-client-v3.js'; import { AASApiClientV1 } from '../packages/aas-server/aas-api-client-v1.js'; import { AASApiClientV0 } from '../packages/aas-server/aas-api-client-v0.js'; import { FileStorageProvider } from '../file-storage/file-storage-provider.js'; +import { HttpClient } from '../packages/http-client.js'; @singleton() export class AASResourceScanFactory { public constructor( @inject('Logger') private readonly logger: Logger, @inject(FileStorageProvider) private readonly fileStorageProvider: FileStorageProvider, + @inject(HttpClient) private readonly http: HttpClient, ) {} public create(endpoint: AASEndpoint): AASResourceScan { @@ -34,13 +36,13 @@ export class AASResourceScanFactory { let source: AASApiClient; switch (endpoint.version) { case 'v0': - source = new AASApiClientV0(this.logger, endpoint.url, endpoint.name); + source = new AASApiClientV0(this.logger, this.http, endpoint); break; case 'v1': - source = new AASApiClientV1(this.logger, endpoint.url, endpoint.name); + source = new AASApiClientV1(this.logger, this.http, endpoint); break; case 'v3': - source = new AASApiClientV3(this.logger, endpoint.url, endpoint.name); + source = new AASApiClientV3(this.logger, this.http, endpoint); break; default: throw new Error('Not implemented.'); @@ -49,17 +51,12 @@ export class AASResourceScanFactory { return new AASServerScan(this.logger, source); } case 'OPC_UA': - return new OpcuaServerScan(this.logger, new OpcuaClient(this.logger, endpoint.url, endpoint.name)); + return new OpcuaServerScan(this.logger, new OpcuaClient(this.logger, endpoint)); case 'WebDAV': case 'FileSystem': return new DirectoryScan( this.logger, - new AasxDirectory( - this.logger, - this.fileStorageProvider.get(endpoint.url), - endpoint.url, - endpoint.name, - ), + new AasxDirectory(this.logger, this.fileStorageProvider.get(endpoint.url), endpoint), ); default: throw new Error('Not implemented.'); diff --git a/projects/aas-server/src/app/live/http/http-subscription.ts b/projects/aas-server/src/app/live/http/http-subscription.ts index d7e2601f..53ef92ee 100644 --- a/projects/aas-server/src/app/live/http/http-subscription.ts +++ b/projects/aas-server/src/app/live/http/http-subscription.ts @@ -36,7 +36,7 @@ export class HttpSubscription extends SocketSubscription { if (!this.timeoutId) { this.timeoutId = setTimeout(this.readValues.bind(this), 10); } else { - this.logger.debug(`The subscription ${this.server.url} is already open.`); + this.logger.debug(`The subscription ${this.server.endpoint} is already open.`); } } diff --git a/projects/aas-server/src/app/packages/aas-resource-factory.ts b/projects/aas-server/src/app/packages/aas-resource-factory.ts index b1c54f7c..114fbf92 100644 --- a/projects/aas-server/src/app/packages/aas-resource-factory.ts +++ b/projects/aas-server/src/app/packages/aas-resource-factory.ts @@ -17,12 +17,14 @@ import { OpcuaClient } from './opcua/opcua-client.js'; import { ERRORS } from '../errors.js'; import { FileStorageProvider } from '../file-storage/file-storage-provider.js'; import { AASApiClientV1 } from './aas-server/aas-api-client-v1.js'; +import { HttpClient } from './http-client.js'; @singleton() export class AASResourceFactory { public constructor( @inject('Logger') private readonly logger: Logger, @inject(FileStorageProvider) private readonly fileStorageProvider: FileStorageProvider, + @inject(HttpClient) private readonly http: HttpClient, ) {} /** @@ -35,24 +37,19 @@ export class AASResourceFactory { case 'AAS_API': switch (endpoint.version) { case 'v3': - return new AASApiClientV3(this.logger, endpoint.url, endpoint.name); + return new AASApiClientV3(this.logger, this.http, endpoint); case 'v1': - return new AASApiClientV1(this.logger, endpoint.url, endpoint.name); + return new AASApiClientV1(this.logger, this.http, endpoint); case 'v0': - return new AASApiClientV0(this.logger, endpoint.url, endpoint.name); + return new AASApiClientV0(this.logger, this.http, endpoint); default: throw new Error(`AASX server version ${endpoint.version} is not supported.`); } case 'OPC_UA': - return new OpcuaClient(this.logger, endpoint.url, endpoint.name); + return new OpcuaClient(this.logger, endpoint); case 'WebDAV': case 'FileSystem': { - return new AasxDirectory( - this.logger, - this.fileStorageProvider.get(endpoint.url), - endpoint.url, - endpoint.name, - ); + return new AasxDirectory(this.logger, this.fileStorageProvider.get(endpoint.url), endpoint); } default: throw new Error('Not implemented.'); @@ -70,20 +67,20 @@ export class AASResourceFactory { case 'AAS_API': switch (endpoint.version) { case 'v3': - await new AASApiClientV3(this.logger, endpoint.url, endpoint.name).testAsync(); + await new AASApiClientV3(this.logger, this.http, endpoint).testAsync(); break; case 'v1': - await new AASApiClientV1(this.logger, endpoint.url, endpoint.name).testAsync(); + await new AASApiClientV1(this.logger, this.http, endpoint).testAsync(); break; case 'v0': - await new AASApiClientV0(this.logger, endpoint.url, endpoint.name).testAsync(); + await new AASApiClientV0(this.logger, this.http, endpoint).testAsync(); break; default: throw new Error(`AASX server version ${endpoint.version} is not supported.`); } break; case 'OPC_UA': - await new OpcuaClient(this.logger, endpoint.url, endpoint.name).testAsync(); + await new OpcuaClient(this.logger, endpoint).testAsync(); break; case 'WebDAV': case 'FileSystem': @@ -91,8 +88,7 @@ export class AASResourceFactory { await new AasxDirectory( this.logger, this.fileStorageProvider.get(endpoint.url), - endpoint.url, - endpoint.name, + endpoint, ).testAsync(); } break; diff --git a/projects/aas-server/src/app/packages/aas-resource.ts b/projects/aas-server/src/app/packages/aas-resource.ts index df808c92..f1b4f6bf 100644 --- a/projects/aas-server/src/app/packages/aas-resource.ts +++ b/projects/aas-server/src/app/packages/aas-resource.ts @@ -6,7 +6,7 @@ * *****************************************************************************/ -import { aas, LiveRequest } from 'aas-core'; +import { aas, AASEndpoint, LiveRequest } from 'aas-core'; import { Logger } from '../logging/logger.js'; import { SocketClient } from '../live/socket-client.js'; import { AASPackage } from './aas-package.js'; @@ -16,8 +16,7 @@ import { SocketSubscription } from '../live/socket-subscription.js'; export abstract class AASResource { protected constructor( protected readonly logger: Logger, - public readonly url: string, - public readonly name: string, + public readonly endpoint: AASEndpoint, ) {} public abstract readonly version: string; @@ -102,6 +101,6 @@ export abstract class AASResource { * @returns A new URL. */ protected resolve(url: string): URL { - return new URL(url, this.url); + return new URL(url, this.endpoint.url); } } diff --git a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v0.ts b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v0.ts index b9f821b0..cd2c4122 100644 --- a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v0.ts +++ b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v0.ts @@ -6,20 +6,21 @@ * *****************************************************************************/ -import { aas, DifferenceItem, selectSubmodel } from 'aas-core'; +import { aas, AASEndpoint, DifferenceItem, selectSubmodel } from 'aas-core'; import { Logger } from '../../logging/logger.js'; import { JsonReaderV2 } from '../json-reader-v2.js'; import { AASApiClient } from './aas-api-client.js'; import { JsonWriterV2 } from '../json-writer-v2.js'; import * as aasV2 from '../../types/aas-v2.js'; +import { HttpClient } from '../http-client.js'; interface AASList { aaslist: string[]; } export class AASApiClientV0 extends AASApiClient { - public constructor(logger: Logger, url: string, name: string) { - super(logger, url, name); + public constructor(logger: Logger, http: HttpClient, endpoint: AASEndpoint) { + super(logger, http, endpoint); } public override readonly version = '0.0'; @@ -29,13 +30,13 @@ export class AASApiClientV0 extends AASApiClient { public readonly onlineReady = true; public async getShellsAsync(): Promise { - const value = await this.message.get(this.resolve('/server/listaas')); + const value = await this.http.get(this.resolve('/server/listaas')); return value.aaslist.map(item => item.split(' : ')[1].trim()); } public override async readEnvironmentAsync(id: string): Promise { const url = this.resolve(`/aas/${id}/aasenv`); - const sourceEnv = await this.message.get(url); + const sourceEnv = await this.http.get(url, this.endpoint.headers); return new JsonReaderV2(sourceEnv).readEnvironment(); } @@ -98,7 +99,7 @@ export class AASApiClientV0 extends AASApiClient { public async openFileAsync(shell: aas.AssetAdministrationShell, file: aas.File): Promise { const url = await this.getFileUrlAsync(shell.idShort, file.value!); - return await this.message.getResponse(url); + return await this.http.getResponse(url, this.endpoint.headers); } public override getPackageAsync(): Promise { @@ -122,7 +123,7 @@ export class AASApiClientV0 extends AASApiClient { } private async getFileUrlAsync(idShort: string, address: string): Promise { - const listAAS = await this.message.get(this.resolve('/server/listaas')); + const listAAS = await this.http.get(this.resolve('/server/listaas'), this.endpoint.headers); for (const aas of listAAS.aaslist) { const items = aas.split(':'); if (items[1].trim() === idShort) { @@ -161,10 +162,10 @@ export class AASApiClientV0 extends AASApiClient { } private putSubmodelAsync(aas: string, submodel: aasV2.Submodel): Promise { - return this.message.put(this.resolve('/aas/' + aas + '/submodels/'), submodel); + return this.http.put(this.resolve('/aas/' + aas + '/submodels/'), submodel, this.endpoint.headers); } private deleteSubmodelAsync(aas: string, submodelId: string): Promise { - return this.message.delete(this.resolve('/aas/' + aas + '/submodels/' + submodelId)); + return this.http.delete(this.resolve('/aas/' + aas + '/submodels/' + submodelId)); } } diff --git a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v1.ts b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v1.ts index 63732b94..097fa04b 100644 --- a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v1.ts +++ b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v1.ts @@ -10,6 +10,7 @@ import FormData from 'form-data'; import { createReadStream } from 'fs'; import { aas, + AASEndpoint, ApplicationError, DifferenceItem, getIdShortPath, @@ -27,6 +28,7 @@ import { JsonReaderV2 } from '../json-reader-v2.js'; import { JsonWriterV2 } from '../json-writer-v2.js'; import { ERRORS } from '../../errors.js'; import { JsonReaderV3 } from '../json-reader-v3.js'; +import { HttpClient } from '../http-client.js'; interface PackageDescriptor { aasIds: string[]; @@ -59,8 +61,8 @@ interface OperationResult { } export class AASApiClientV1 extends AASApiClient { - public constructor(logger: Logger, url: string, name: string) { - super(logger, url, name); + public constructor(logger: Logger, http: HttpClient, endpoint: AASEndpoint) { + super(logger, http, endpoint); } public override readonly version = 'v1'; @@ -70,20 +72,31 @@ export class AASApiClientV1 extends AASApiClient { public readonly onlineReady = true; public async getShellsAsync(): Promise { - const result = await this.message.get(this.resolve('shells')); + const result = await this.http.get( + this.resolve('shells'), + this.endpoint.headers, + ); + return result.map(shell => shell.identification.id); } public async readEnvironmentAsync(id: string): Promise { const aasId = encodeBase64Url(id); - const shell = await this.message.get(this.resolve(`shells/${aasId}`)); + const shell = await this.http.get( + this.resolve(`shells/${aasId}`), + this.endpoint.headers, + ); + const submodels: aasv2.Submodel[] = []; if (shell.submodels) { for (const reference of shell.submodels) { const submodelId = encodeBase64Url(reference.keys[0].value); try { submodels.push( - await this.message.get(this.resolve(`submodels/${submodelId}/submodel`)), + await this.http.get( + this.resolve(`submodels/${submodelId}/submodel`), + this.endpoint.headers, + ), ); } catch (error) { this.logger.error(`Unable to read Submodel "${reference.keys[0].value}": ${error?.message}`); @@ -91,7 +104,7 @@ export class AASApiClientV1 extends AASApiClient { } } - const conceptDescriptions = await this.message.get( + const conceptDescriptions = await this.http.get( this.resolve(`concept-descriptions`), ); @@ -113,7 +126,10 @@ export class AASApiClientV1 extends AASApiClient { } public override getThumbnailAsync(id: string): Promise { - return this.message.getResponse(this.resolve(`shells/${encodeBase64Url(id)}/asset-information/thumbnail`)); + return this.http.getResponse( + this.resolve(`shells/${encodeBase64Url(id)}/asset-information/thumbnail`), + this.endpoint.headers, + ); } public async commitAsync( @@ -165,7 +181,7 @@ export class AASApiClientV1 extends AASApiClient { const smId = encodeBase64Url(file.parent!.keys[0].value); const path = getIdShortPath(file); const url = this.resolve(`submodels/${smId}/submodel/submodel-elements/${path}/attachment`); - return await this.message.getResponse(url); + return await this.http.getResponse(url, this.endpoint.headers); } public resolveNodeId(shell: aas.AssetAdministrationShell, nodeId: string): string { @@ -177,23 +193,31 @@ export class AASApiClientV1 extends AASApiClient { public async getPackageAsync(aasIdentifier: string): Promise { const aasId = encodeBase64Url(aasIdentifier); - const descriptors: PackageDescriptor[] = await this.message.get(this.resolve(`packages?aasId=${aasId}`)); + const descriptors: PackageDescriptor[] = await this.http.get( + this.resolve(`packages?aasId=${aasId}`), + this.endpoint.headers, + ); + const packageId = encodeBase64Url(descriptors[0].packageId); - return await this.message.getResponse(this.resolve(`packages/${packageId}`)); + return await this.http.getResponse(this.resolve(`packages/${packageId}`), this.endpoint.headers); } public postPackageAsync(file: Express.Multer.File): Promise { const formData = new FormData(); formData.append('file', createReadStream(file.path)); formData.append('fileName', file.filename); - return this.message.post(this.resolve(`packages`), formData); + return this.http.post(this.resolve(`packages`), formData, this.endpoint.headers); } public async deletePackageAsync(aasIdentifier: string): Promise { const aasId = encodeBase64Url(aasIdentifier); - const descriptors: PackageDescriptor[] = await this.message.get(this.resolve(`packages?aasId=${aasId}`)); + const descriptors: PackageDescriptor[] = await this.http.get( + this.resolve(`packages?aasId=${aasId}`), + this.endpoint.headers, + ); + const packageId = encodeBase64Url(descriptors[0].packageId); - return await this.message.delete(this.resolve(`packages/${packageId}`)); + return await this.http.delete(this.resolve(`packages/${packageId}`), this.endpoint.headers); } public async invoke(env: aas.Environment, operation: aas.Operation): Promise { @@ -214,9 +238,10 @@ export class AASApiClientV1 extends AASApiClient { }; const result: OperationResult = JSON.parse( - await this.message.post( + await this.http.post( this.resolve(`shells/${aasId}/aas/submodels/${smId}/submodel/submodel-elements/${path}/invoke`), request, + this.endpoint.headers, ), ); @@ -242,8 +267,9 @@ export class AASApiClientV1 extends AASApiClient { idShortPath: string, ): Promise { const smId = encodeBase64Url(submodelId); - const blob = await this.message.get( + const blob = await this.http.get( this.resolve(`submodels/${smId}/submodel/submodel-elements/${idShortPath}/?extent=WithBlobValue`), + this.endpoint.headers, ); if (!blob) { @@ -255,26 +281,27 @@ export class AASApiClientV1 extends AASApiClient { private async putShellAsync(shell: aas.AssetAdministrationShell): Promise { const aasId = encodeBase64Url(shell.id); - return await this.message.put(this.resolve(`shells/${aasId}`), new JsonWriterV2().convert(shell)); + return await this.http.put(this.resolve(`shells/${aasId}`), new JsonWriterV2().convert(shell)); } private async putSubmodelAsync(aasId: string, submodel: aas.Submodel): Promise { const smId = encodeBase64Url(submodel.id); - return await this.message.put( + return await this.http.put( this.resolve(`shells/${aasId}/submodels/${smId}/submodel`), new JsonWriterV2().convert(submodel), + this.endpoint.headers, ); } private async postSubmodelAsync(aasId: string, submodel: aas.Submodel): Promise { - return await this.message.post( + return await this.http.post( this.resolve(`submodels?aasIdentifier=${aasId}`), new JsonWriterV2().convert(submodel), ); } private async deleteSubmodelAsync(smId: string): Promise { - return await this.message.delete(this.resolve(`submodels/${encodeBase64Url(smId)}`)); + return await this.http.delete(this.resolve(`submodels/${encodeBase64Url(smId)}`), this.endpoint.headers); } private async putSubmodelElementAsync( @@ -283,7 +310,7 @@ export class AASApiClientV1 extends AASApiClient { ): Promise { const smId = encodeBase64Url(submodel.id); const path = getIdShortPath(submodelElement); - return await this.message.put( + return await this.http.put( this.resolve(`submodels/${smId}/submodel/submodel-elements/${path}`), new JsonWriterV2().convert(submodelElement), ); @@ -295,9 +322,10 @@ export class AASApiClientV1 extends AASApiClient { ): Promise { const smId = encodeBase64Url(submodel.id); const path = getIdShortPath(submodelElement); - return await this.message.post( + return await this.http.post( this.resolve(`submodels/${smId}/submodel/submodel-elements/${path}`), new JsonWriterV2().convert(submodelElement), + this.endpoint.headers, ); } @@ -307,7 +335,10 @@ export class AASApiClientV1 extends AASApiClient { ): Promise { const smId = encodeBase64Url(submodel.id); const path = getIdShortPath(submodelElement); - return await this.message.delete(this.resolve(`submodels/${smId}/submodel-elements/${path}`)); + return await this.http.delete( + this.resolve(`submodels/${smId}/submodel-elements/${path}`), + this.endpoint.headers, + ); } private getSubmodel(env: aas.Environment, referable?: aas.Referable): aas.Submodel { diff --git a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts index d7eabad5..c40a6e3f 100644 --- a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts +++ b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts @@ -17,6 +17,7 @@ import { JsonWriterV3 } from '../json-writer-v3.js'; import { ERRORS } from '../../errors.js'; import { aas, + AASEndpoint, ApplicationError, DifferenceItem, getIdShortPath, @@ -25,6 +26,7 @@ import { isSubmodelElement, selectSubmodel, } from 'aas-core'; +import { HttpClient } from '../http-client.js'; interface PackageDescriptor { aasIds: string[]; @@ -63,8 +65,8 @@ interface PagedResult { } export class AASApiClientV3 extends AASApiClient { - public constructor(logger: Logger, url: string, name: string) { - super(logger, url, name); + public constructor(logger: Logger, http: HttpClient, endpoint: AASEndpoint) { + super(logger, http, endpoint); } public override readonly version = 'v3'; @@ -74,20 +76,32 @@ export class AASApiClientV3 extends AASApiClient { public readonly onlineReady = true; public async getShellsAsync(): Promise { - const result = await this.message.get>(this.resolve('shells')); + const result = await this.http.get>( + this.resolve('shells'), + this.endpoint.headers, + ); + return result.result.map(shell => shell.id); } public async readEnvironmentAsync(id: string): Promise { const aasId = encodeBase64Url(id); - const shell = await this.message.get(this.resolve(`shells/${aasId}`)); + const shell = await this.http.get( + this.resolve(`shells/${aasId}`), + this.endpoint.headers, + ); const submodels: aas.Submodel[] = []; if (shell.submodels) { for (const reference of shell.submodels) { const submodelId = encodeBase64Url(reference.keys[0].value); try { - submodels.push(await this.message.get(this.resolve(`submodels/${submodelId}`))); + submodels.push( + await this.http.get( + this.resolve(`submodels/${submodelId}`), + this.endpoint.headers, + ), + ); } catch (error) { this.logger.error(`Unable to read Submodel "${reference.keys[0].value}": ${error?.message}`); } @@ -96,8 +110,9 @@ export class AASApiClientV3 extends AASApiClient { let conceptDescriptions: aas.ConceptDescription[]; try { - const pagedResult = await this.message.get>( + const pagedResult = await this.http.get>( this.resolve(`concept-descriptions`), + this.endpoint.headers, ); conceptDescriptions = pagedResult.result; @@ -115,7 +130,10 @@ export class AASApiClientV3 extends AASApiClient { } public override getThumbnailAsync(id: string): Promise { - return this.message.getResponse(this.resolve(`shells/${encodeBase64Url(id)}/asset-information/thumbnail`)); + return this.http.getResponse( + this.resolve(`shells/${encodeBase64Url(id)}/asset-information/thumbnail`), + this.endpoint.headers, + ); } public async commitAsync( @@ -167,7 +185,7 @@ export class AASApiClientV3 extends AASApiClient { const smId = encodeBase64Url(file.parent!.keys[0].value); const path = getIdShortPath(file); const url = this.resolve(`submodels/${smId}/submodel-elements/${path}/attachment`); - return await this.message.getResponse(url); + return await this.http.getResponse(url, this.endpoint.headers); } public resolveNodeId(shell: aas.AssetAdministrationShell, nodeId: string): string { @@ -179,23 +197,31 @@ export class AASApiClientV3 extends AASApiClient { public async getPackageAsync(aasIdentifier: string): Promise { const aasId = encodeBase64Url(aasIdentifier); - const result: PagedResult = await this.message.get(this.resolve(`packages?aasId=${aasId}`)); + const result: PagedResult = await this.http.get( + this.resolve(`packages?aasId=${aasId}`), + this.endpoint.headers, + ); + const packageId = encodeBase64Url(result.result[0].packageId); - return await this.message.getResponse(this.resolve(`packages/${packageId}`)); + return await this.http.getResponse(this.resolve(`packages/${packageId}`), this.endpoint.headers); } public postPackageAsync(file: Express.Multer.File): Promise { const formData = new FormData(); formData.append('file', createReadStream(file.path)); formData.append('fileName', file.filename); - return this.message.post(this.resolve(`packages`), formData); + return this.http.post(this.resolve(`packages`), formData, this.endpoint.headers); } public async deletePackageAsync(aasIdentifier: string): Promise { const aasId = encodeBase64Url(aasIdentifier); - const descriptors: PackageDescriptor[] = await this.message.get(this.resolve(`packages?aasId=${aasId}`)); + const descriptors: PackageDescriptor[] = await this.http.get( + this.resolve(`packages?aasId=${aasId}`), + this.endpoint.headers, + ); + const packageId = encodeBase64Url(descriptors[0].packageId); - return await this.message.delete(this.resolve(`packages/${packageId}`)); + return await this.http.delete(this.resolve(`packages/${packageId}`), this.endpoint.headers); } public async invoke(env: aas.Environment, operation: aas.Operation): Promise { @@ -217,9 +243,10 @@ export class AASApiClientV3 extends AASApiClient { } const result: OperationResult = JSON.parse( - await this.message.post( + await this.http.post( this.resolve(`shells/${aasId}/submodels/${smId}/submodel-elements/${path}/invoke`), request, + this.endpoint.headers, ), ); @@ -239,8 +266,9 @@ export class AASApiClientV3 extends AASApiClient { submodelId: string, idShortPath: string, ): Promise { - const blob = await this.message.get( + const blob = await this.http.get( this.resolve(`submodels/${submodelId}/submodel-elements/${idShortPath}/?extent=WithBlobValue`), + this.endpoint.headers, ); if (!blob) { @@ -252,26 +280,28 @@ export class AASApiClientV3 extends AASApiClient { private async putShellAsync(shell: aas.AssetAdministrationShell): Promise { const aasId = encodeBase64Url(shell.id); - return await this.message.put(this.resolve(`shells/${aasId}`), new JsonWriterV3().convert(shell)); + return await this.http.put(this.resolve(`shells/${aasId}`), new JsonWriterV3().convert(shell)); } private async putSubmodelAsync(aasId: string, submodel: aas.Submodel): Promise { const smId = encodeBase64Url(submodel.id); - return await this.message.put( + return await this.http.put( this.resolve(`shells/${aasId}/submodels/${smId}`), new JsonWriterV3().convert(submodel), + this.endpoint.headers, ); } private async postSubmodelAsync(aasId: string, submodel: aas.Submodel): Promise { - return await this.message.post( + return await this.http.post( this.resolve(`submodels?aasIdentifier=${aasId}`), new JsonWriterV3().convert(submodel), + this.endpoint.headers, ); } private async deleteSubmodelAsync(smId: string): Promise { - return await this.message.delete(this.resolve(`submodels/${encodeBase64Url(smId)}`)); + return await this.http.delete(this.resolve(`submodels/${encodeBase64Url(smId)}`), this.endpoint.headers); } private async putSubmodelElementAsync( @@ -280,9 +310,10 @@ export class AASApiClientV3 extends AASApiClient { ): Promise { const smId = encodeBase64Url(submodel.id); const path = getIdShortPath(submodelElement); - return await this.message.put( + return await this.http.put( this.resolve(`submodels/${smId}/submodel-elements/${path}`), new JsonWriterV3().convert(submodelElement), + this.endpoint.headers, ); } @@ -292,9 +323,10 @@ export class AASApiClientV3 extends AASApiClient { ): Promise { const smId = encodeBase64Url(submodel.id); const path = getIdShortPath(submodelElement); - return await this.message.post( + return await this.http.post( this.resolve(`submodels/${smId}/submodel-elements/${path}`), new JsonWriterV3().convert(submodelElement), + this.endpoint.headers, ); } @@ -304,7 +336,10 @@ export class AASApiClientV3 extends AASApiClient { ): Promise { const smId = encodeBase64Url(submodel.id); const path = getIdShortPath(submodelElement); - return await this.message.delete(this.resolve(`submodels/${smId}/submodel-elements/${path}`)); + return await this.http.delete( + this.resolve(`submodels/${smId}/submodel-elements/${path}`), + this.endpoint.headers, + ); } private getSubmodel(env: aas.Environment, referable?: aas.Referable): aas.Submodel { diff --git a/projects/aas-server/src/app/packages/aas-server/aas-api-client.ts b/projects/aas-server/src/app/packages/aas-server/aas-api-client.ts index f8c8d7b5..bcb8c7da 100644 --- a/projects/aas-server/src/app/packages/aas-server/aas-api-client.ts +++ b/projects/aas-server/src/app/packages/aas-server/aas-api-client.ts @@ -6,8 +6,8 @@ * *****************************************************************************/ -import { aas, convertFromString, DefaultType, DifferenceItem, LiveRequest } from 'aas-core'; -import { ServerMessage } from '../server-message.js'; +import { aas, AASEndpoint, convertFromString, DefaultType, DifferenceItem, LiveRequest } from 'aas-core'; +import { HttpClient } from '../http-client.js'; import { Logger } from '../../logging/logger.js'; import { HttpSubscription } from '../../live/http/http-subscription.js'; import { SocketClient } from '../../live/socket-client.js'; @@ -25,13 +25,18 @@ export abstract class AASApiClient extends AASResource { private reentry = 0; /** - * @param url The URL of the AASX-Server. + * @param logger The logger. + * @param http The HTTP client. + * @param endpoint AAS endpoint. + * @param name The endpoint name. */ - public constructor(logger: Logger, url: string, name: string) { - super(logger, url, name); + public constructor(logger: Logger, http: HttpClient, endpoint: AASEndpoint) { + super(logger, endpoint); + + this.http = http; } - protected readonly message = new ServerMessage(); + protected readonly http: HttpClient; public get isOpen(): boolean { return this.reentry > 0; @@ -39,14 +44,14 @@ export abstract class AASApiClient extends AASResource { public async testAsync(): Promise { if (this.reentry === 0) { - await this.message.checkUrlExist(this.url); + await this.http.checkUrlExist(this.endpoint.url); } } /** * Reads the environment of the AAS with the specified identifier. * @param id The AAS identifier. - * @returns + * @returns An AAS environment. */ public abstract readEnvironmentAsync(id: string): Promise; @@ -115,7 +120,7 @@ export abstract class AASApiClient extends AASResource { * @returns The current value. */ public async readValueAsync(url: string, valueType: aas.DataTypeDefXsd): Promise { - const property = await this.message.get(new URL(url)); + const property = await this.http.get(new URL(url), this.endpoint.headers); return convertFromString(property.value, valueType); } diff --git a/projects/aas-server/src/app/packages/aas-server/aas-server-package.ts b/projects/aas-server/src/app/packages/aas-server/aas-server-package.ts index 3df0e80d..da9a4f76 100644 --- a/projects/aas-server/src/app/packages/aas-server/aas-server-package.ts +++ b/projects/aas-server/src/app/packages/aas-server/aas-server-package.ts @@ -46,7 +46,7 @@ export class AASServerPackage extends AASPackage { const environment = await this.server.readEnvironmentAsync(this.idShort); const document: AASDocument = { id: environment.assetAdministrationShells[0].id, - endpoint: this.server.name, + endpoint: this.server.endpoint.name, address: this.idShort, idShort: environment.assetAdministrationShells[0].idShort, assetId: environment.assetAdministrationShells[0].assetInformation.globalAssetId, diff --git a/projects/aas-server/src/app/packages/file-system/aasx-directory.ts b/projects/aas-server/src/app/packages/file-system/aasx-directory.ts index a2a13a79..69b63e6d 100644 --- a/projects/aas-server/src/app/packages/file-system/aasx-directory.ts +++ b/projects/aas-server/src/app/packages/file-system/aasx-directory.ts @@ -6,8 +6,8 @@ * *****************************************************************************/ -import { aas, ApplicationError } from 'aas-core'; -import { basename, extname, join } from 'path/posix'; +import { aas, AASEndpoint, ApplicationError } from 'aas-core'; +import { extname, join } from 'path/posix'; import { readFile } from 'fs/promises'; import { ERRORS } from '../../errors.js'; import { FileStorage } from '../../file-storage/file-storage.js'; @@ -24,14 +24,10 @@ export class AasxDirectory extends AASResource { public constructor( logger: Logger, private readonly fileStorage: FileStorage, - url: string | URL, - name?: string, + endpoint: AASEndpoint, ) { - if (typeof url === 'string') { - url = new URL(url); - } - - super(logger, url.href, name ?? basename(url.pathname)); + const url = new URL(endpoint.url); + super(logger, endpoint); this.root = url.pathname; } @@ -69,7 +65,7 @@ export class AasxDirectory extends AASResource { public async openAsync(): Promise { if (this.reentry === 0) { if (!(await this.fileStorage.exists(this.root))) { - throw new Error(`The directory '${this.url}' does not exist.`); + throw new Error(`The directory '${this.endpoint}' does not exist.`); } ++this.reentry; diff --git a/projects/aas-server/src/app/packages/file-system/aasx-package.ts b/projects/aas-server/src/app/packages/file-system/aasx-package.ts index efb47167..bd13565b 100644 --- a/projects/aas-server/src/app/packages/file-system/aasx-package.ts +++ b/projects/aas-server/src/app/packages/file-system/aasx-package.ts @@ -46,7 +46,7 @@ export class AasxPackage extends AASPackage { const id = environment.assetAdministrationShells[0].id; document = { id: id, - endpoint: this.source.name, + endpoint: this.source.endpoint.name, address: this.file, idShort: environment.assetAdministrationShells[0].idShort, assetId: environment.assetAdministrationShells[0].assetInformation.globalAssetId, diff --git a/projects/aas-server/src/app/packages/server-message.ts b/projects/aas-server/src/app/packages/http-client.ts similarity index 83% rename from projects/aas-server/src/app/packages/server-message.ts rename to projects/aas-server/src/app/packages/http-client.ts index eb14ddc1..7a9d6e94 100644 --- a/projects/aas-server/src/app/packages/server-message.ts +++ b/projects/aas-server/src/app/packages/http-client.ts @@ -11,15 +11,18 @@ import https from 'https'; import net from 'net'; import FormData from 'form-data'; import { parseUrl } from '../convert.js'; +import { singleton } from 'tsyringe'; -export class ServerMessage { +@singleton() +export class HttpClient { /** * Gets an object of type `T` from a server. - * @param url The URL of the object. * @template T The type of the object. + * @param url The URL of the object. + * @param headers Additional outgoing http headers. * @returns The requested object. */ - public get(url: URL): Promise { + public get(url: URL, headers?: http.OutgoingHttpHeaders): Promise { return new Promise((result, reject) => { const options: http.RequestOptions = { host: url.hostname, @@ -29,6 +32,10 @@ export class ServerMessage { timeout: 3000, }; + if (headers) { + options.headers = { ...headers }; + } + const requester = url.protocol === 'https:' ? https.request : http.request; const request = requester(options, response => { let data = ''; @@ -38,7 +45,7 @@ export class ServerMessage { response.on('end', () => { try { - ServerMessage.checkStatusCode(response, data); + HttpClient.checkStatusCode(response, data); result(JSON.parse(data)); } catch (error) { reject(error); @@ -58,9 +65,10 @@ export class ServerMessage { /** * Gets the response of the request with the specified URL. * @param url The URL of the request. + * @param headers Additional outgoing http headers. * @returns The request. */ - public getResponse(url: URL): Promise { + public getResponse(url: URL, headers?: http.OutgoingHttpHeaders): Promise { return new Promise((result, reject) => { const options: http.RequestOptions = { host: url.hostname, @@ -70,6 +78,10 @@ export class ServerMessage { timeout: 3000, }; + if (headers) { + options.headers = { ...headers }; + } + const requester = url.protocol === 'https:' ? https.request : http.request; const request = requester(options, response => result(response)); request @@ -83,8 +95,9 @@ export class ServerMessage { * Updates the specified object. * @param url The destination URL. * @param obj The object to send. + * @param headers Additional outgoing http headers. */ - public put(url: URL, obj: object): Promise { + public put(url: URL, obj: object, headers: http.OutgoingHttpHeaders = {}): Promise { return new Promise((result, reject) => { const data = JSON.stringify(obj); const options: http.RequestOptions = { @@ -95,6 +108,7 @@ export class ServerMessage { headers: { 'Content-Type': 'application/json', 'Content-Length': Buffer.byteLength(data), + ...headers, }, }; @@ -107,7 +121,7 @@ export class ServerMessage { response.on('end', () => { try { - ServerMessage.checkStatusCode(response, responseData); + HttpClient.checkStatusCode(response, responseData); result(responseData); } catch (error) { reject(error); @@ -126,16 +140,18 @@ export class ServerMessage { * Inserts the specified object. * @param url The destination URL. * @param obj The object to send. + * @param headers Additional outgoing http headers. */ - public post(url: URL, obj: FormData | object): Promise { - return obj instanceof FormData ? this.postFormData(url, obj) : this.postObject(url, obj); + public post(url: URL, obj: FormData | object, headers?: http.OutgoingHttpHeaders): Promise { + return obj instanceof FormData ? this.postFormData(url, obj, headers) : this.postObject(url, obj, headers); } /** * Deletes an object. * @param url The URL of the object to delete. + * @param headers Additional outgoing http headers. */ - public delete(url: URL): Promise { + public delete(url: URL, headers: http.OutgoingHttpHeaders = {}): Promise { return new Promise((result, reject) => { const options: https.RequestOptions = { hostname: url.hostname, @@ -144,6 +160,7 @@ export class ServerMessage { method: 'DELETE', headers: { 'Content-Type': 'application/json', + ...headers, }, }; @@ -156,7 +173,7 @@ export class ServerMessage { response.on('end', function () { try { - ServerMessage.checkStatusCode(response, responseData); + HttpClient.checkStatusCode(response, responseData); result(responseData); } catch (error) { reject(error); @@ -201,7 +218,7 @@ export class ServerMessage { }); } - private postObject(url: URL, obj: object): Promise { + private postObject(url: URL, obj: object, headers: http.OutgoingHttpHeaders = {}): Promise { return new Promise((result, reject) => { const data = JSON.stringify(obj); const options: http.RequestOptions = { @@ -212,6 +229,7 @@ export class ServerMessage { headers: { 'Content-Type': 'application/json', 'Content-Length': Buffer.byteLength(data), + ...headers, }, }; @@ -224,7 +242,7 @@ export class ServerMessage { response.on('end', () => { try { - ServerMessage.checkStatusCode(response, responseData); + HttpClient.checkStatusCode(response, responseData); result(responseData); } catch (error) { reject(error); @@ -239,14 +257,14 @@ export class ServerMessage { }); } - private postFormData(url: URL, formData: FormData): Promise { + private postFormData(url: URL, formData: FormData, headers: http.OutgoingHttpHeaders = {}): Promise { return new Promise((result, reject) => { const options: http.RequestOptions = { hostname: url.hostname, port: url.port, path: url.pathname + url.search, method: 'POST', - headers: formData.getHeaders(), + headers: { ...formData.getHeaders(), ...headers }, }; const requester = url.protocol === 'https:' ? https.request : http.request; @@ -258,7 +276,7 @@ export class ServerMessage { response.on('end', function () { try { - ServerMessage.checkStatusCode(response, responseData); + HttpClient.checkStatusCode(response, responseData); result(responseData); } catch (error) { reject(error); diff --git a/projects/aas-server/src/app/packages/opcua/opcua-client.ts b/projects/aas-server/src/app/packages/opcua/opcua-client.ts index ac822bb3..4d44a025 100644 --- a/projects/aas-server/src/app/packages/opcua/opcua-client.ts +++ b/projects/aas-server/src/app/packages/opcua/opcua-client.ts @@ -7,7 +7,7 @@ *****************************************************************************/ import fs from 'fs'; -import { LiveRequest, aas } from 'aas-core'; +import { AASEndpoint, LiveRequest, aas } from 'aas-core'; import { Logger } from '../../logging/logger.js'; import { OpcuaSubscription } from '../../live/opcua/opcua-subscription.js'; import { SocketClient } from '../../live/socket-client.js'; @@ -35,8 +35,8 @@ export class OpcuaClient extends AASResource { private session: ClientSession | null = null; private reentry = 0; - public constructor(logger: Logger, url: string, name: string, options?: OPCUAClientOptions) { - super(logger, url, name); + public constructor(logger: Logger, endpoint: AASEndpoint, options?: OPCUAClientOptions) { + super(logger, endpoint); if (options) { this.options = this.resolveOpcuaClientOptions(options); @@ -69,7 +69,7 @@ export class OpcuaClient extends AASResource { **/ public getSession(): ClientSession { if (this.reentry <= 0 || this.session == null) { - throw new Error(`No session to ${this.url} established.`); + throw new Error(`No session to ${this.endpoint} established.`); } return this.session; @@ -88,7 +88,7 @@ export class OpcuaClient extends AASResource { public async openAsync(): Promise { if (this.reentry === 0) { this.client = OPCUAClient.create(this.options as OPCUAClientOptions); - await this.client.connect(this.url); + await this.client.connect(this.endpoint.url); this.session = await this.client.createSession(); } diff --git a/projects/aas-server/src/app/packages/opcua/opcua-package.ts b/projects/aas-server/src/app/packages/opcua/opcua-package.ts index 4bcbc3c3..52cd21d9 100644 --- a/projects/aas-server/src/app/packages/opcua/opcua-package.ts +++ b/projects/aas-server/src/app/packages/opcua/opcua-package.ts @@ -42,7 +42,7 @@ export class OpcuaPackage extends AASPackage { const content = await new OpcuaReader(this.logger, component, this.dataTypes).readEnvironment(); const document: AASDocument = { id: this.getIdentifier(component), - endpoint: this.server.name, + endpoint: this.server.endpoint.name, address: this.nodeId, idShort: component.browseName, assetId: 'ToDo...', @@ -149,7 +149,9 @@ export class OpcuaPackage extends AASPackage { let id = this.readIdentifier(component); if (!id) { id = this.nodeId; - this.logger.debug(`Unable to read AAS identifier for '${component.browseName}' in '${this.server.url}'.'`); + this.logger.debug( + `Unable to read AAS identifier for '${component.browseName}' in '${this.server.endpoint}'.'`, + ); } return id; diff --git a/projects/aas-server/src/app/template/template-scan.ts b/projects/aas-server/src/app/template/template-scan.ts index 6f4e4d7f..90d5829c 100644 --- a/projects/aas-server/src/app/template/template-scan.ts +++ b/projects/aas-server/src/app/template/template-scan.ts @@ -8,7 +8,7 @@ import { parentPort } from 'worker_threads'; import { extname, join } from 'path/posix'; -import { TemplateDescriptor, isSubmodel } from 'aas-core'; +import { AASEndpoint, TemplateDescriptor, isSubmodel } from 'aas-core'; import { Logger } from '../logging/logger.js'; import { FileStorage } from '../file-storage/file-storage.js'; import { inject, singleton } from 'tsyringe'; @@ -25,16 +25,21 @@ import { WorkerData } from '../aas-provider/worker-data.js'; export class TemplateScan { private readonly fileStorage: FileStorage; private readonly root: string; - private readonly url: URL; + private readonly endpoint: AASEndpoint; public constructor( @inject('Logger') private readonly logger: Logger, @inject(Variable) variable: Variable, @inject(FileStorageProvider) provider: FileStorageProvider, ) { - this.url = new URL(variable.TEMPLATE_STORAGE); - this.root = this.url.pathname; - this.fileStorage = provider.get(this.url); + const url = new URL(variable.TEMPLATE_STORAGE); + this.root = url.pathname; + this.fileStorage = provider.get(url); + this.endpoint = { + name: url.hostname, + type: url.protocol === 'file:' ? 'FileSystem' : 'WebDAV', + url: url.toString(), + }; } public async scanAsync(data: WorkerData): Promise { @@ -126,7 +131,7 @@ export class TemplateScan { private async fromAasxFile(file: string): Promise { let source: AasxDirectory | undefined; try { - source = new AasxDirectory(this.logger, this.fileStorage, this.url); + source = new AasxDirectory(this.logger, this.fileStorage, this.endpoint); await source.openAsync(); const pkg = source.createPackage(file); const submodel = (await pkg.getEnvironmentAsync()).submodels[0]; diff --git a/projects/aas-server/src/app/template/template-storage.ts b/projects/aas-server/src/app/template/template-storage.ts index f92473b7..a9eb9e5c 100644 --- a/projects/aas-server/src/app/template/template-storage.ts +++ b/projects/aas-server/src/app/template/template-storage.ts @@ -7,7 +7,7 @@ *****************************************************************************/ import { extname, join } from 'path/posix'; -import { TemplateDescriptor, aas } from 'aas-core'; +import { AASEndpoint, TemplateDescriptor, aas } from 'aas-core'; import { Logger } from '../logging/logger.js'; import { FileStorage } from '../file-storage/file-storage.js'; import { inject, singleton } from 'tsyringe'; @@ -26,7 +26,7 @@ export class TemplateStorage { private readonly fileStorage: FileStorage; private readonly root: string; private readonly timeout: number; - private readonly url: URL; + private readonly endpoint: AASEndpoint; private templates: TemplateDescriptor[] = []; public constructor( @@ -36,10 +36,15 @@ export class TemplateStorage { @inject(Parallel) private readonly parallel: Parallel, @inject(TaskHandler) private readonly taskHandler: TaskHandler, ) { - this.url = new URL(variable.TEMPLATE_STORAGE); + const url = new URL(variable.TEMPLATE_STORAGE); this.timeout = variable.SCAN_TEMPLATES_TIMEOUT; - this.root = this.url.pathname; - this.fileStorage = provider.get(this.url); + this.root = url.pathname; + this.fileStorage = provider.get(url); + this.endpoint = { + name: url.hostname, + type: url.protocol === 'file:' ? 'FileSystem' : 'WebDAV', + url: url.toString(), + }; this.parallel.on('message', this.parallelOnMessage); this.parallel.on('end', this.parallelOnEnd); @@ -83,7 +88,7 @@ export class TemplateStorage { private async readFromAasx(file: string): Promise { let source: AasxDirectory | undefined; try { - source = new AasxDirectory(this.logger, this.fileStorage, this.url); + source = new AasxDirectory(this.logger, this.fileStorage, this.endpoint); await source.openAsync(); const pkg = source.createPackage(file); return await pkg.getEnvironmentAsync(); diff --git a/projects/aas-server/src/test/packages/aas-server/aas-api-client-v0.spec.ts b/projects/aas-server/src/test/packages/aas-server/aas-api-client-v0.spec.ts index c2bf34c6..ee08ab06 100644 --- a/projects/aas-server/src/test/packages/aas-server/aas-api-client-v0.spec.ts +++ b/projects/aas-server/src/test/packages/aas-server/aas-api-client-v0.spec.ts @@ -7,7 +7,7 @@ *****************************************************************************/ import { describe, beforeEach, it, expect, jest, afterEach } from '@jest/globals'; -import http, { IncomingMessage } from 'http'; +import { IncomingMessage } from 'http'; import { Socket } from 'net'; import { aas, selectElement } from 'aas-core'; import { AASApiClient } from '../../../app/packages/aas-server/aas-api-client.js'; @@ -21,110 +21,101 @@ import { AASApiClientV0 } from '../../../app/packages/aas-server/aas-api-client- import { Logger } from '../../../app/logging/logger.js'; import aasEnvironment from '../../assets/aas-environment.js'; import { createSpyObj } from 'fhg-jest'; +import { HttpClient } from '../../../app/packages/http-client.js'; describe('AASApiClientV0', function () { let logger: jest.Mocked; let client: AASApiClient; + let http: jest.Mocked; - beforeEach(function () { + beforeEach(() => { logger = createSpyObj(['error', 'warning', 'info', 'debug', 'start', 'stop']); - client = new AASApiClientV0(logger, 'http://localhost:1234', 'AASX Server'); + http = createSpyObj(['get', 'getResponse']); + client = new AASApiClientV0(logger, http, { + name: 'AASX Server', + type: 'AAS_API', + url: 'http://localhost:1234', + }); }); afterEach(() => { jest.restoreAllMocks(); }); - it('returns the AAS list', async function () { - jest.spyOn(http, 'request').mockImplementation((options, callback) => { - const stream = new IncomingMessage(new Socket()); - stream.push(JSON.stringify(listaas)); - stream.push(null); - stream.statusCode = 200; - stream.statusMessage = 'OK'; - (callback as (res: IncomingMessage) => void)(stream); - return new http.ClientRequest('http://localhost:1234'); + describe('getShellsAsync', () => { + it('returns the AAS list', async () => { + http.get.mockResolvedValue(listaas); + await expect(client.getShellsAsync()).resolves.toEqual([ + 'AssistanceSystem_Dte', + 'CunaCup_Becher1', + 'CunaCup_Becher2', + 'DTOrchestrator', + ]); }); - - await expect(client.getShellsAsync()).resolves.toEqual([ - 'AssistanceSystem_Dte', - 'CunaCup_Becher1', - 'CunaCup_Becher2', - 'DTOrchestrator', - ]); }); - it('gets the AAS with the specified idShort', async function () { - jest.spyOn(http, 'request').mockImplementation((options, callback) => { - let value: unknown; - switch ((options as http.RequestOptions).path) { - case '/aas/CunaCup_Becher1/submodels': - value = submodels; - break; - case '/aas/CunaCup_Becher1/submodels/Nameplate_Becher1/complete': - value = nameplate; - break; - case '/aas/CunaCup_Becher1/submodels/DigitalProductPassport_Becher1/complete': - value = digitalProductPassport; - break; - case '/aas/CunaCup_Becher1/submodels/CustomerFeedback_Becher1/complete': - value = customerFeedback; - break; - default: - value = becher1; - break; - } - - const stream = new IncomingMessage(new Socket()); - stream.push(JSON.stringify(value)); - stream.push(null); - stream.statusCode = 200; - stream.statusMessage = 'OK'; - (callback as (res: IncomingMessage) => void)(stream); - - return new http.ClientRequest('http://localhost:1234'); + describe('readEnvironmentAsync', () => { + it('gets the AAS with the specified idShort', async () => { + http.get.mockImplementation(url => { + // eslint-disable-next-line @typescript-eslint/no-explicit-any + let value: any; + switch (url.pathname) { + case '/aas/CunaCup_Becher1/submodels': + value = submodels; + break; + case '/aas/CunaCup_Becher1/submodels/Nameplate_Becher1/complete': + value = nameplate; + break; + case '/aas/CunaCup_Becher1/submodels/DigitalProductPassport_Becher1/complete': + value = digitalProductPassport; + break; + case '/aas/CunaCup_Becher1/submodels/CustomerFeedback_Becher1/complete': + value = customerFeedback; + break; + default: + value = becher1; + break; + } + + return new Promise(resolve => resolve(value)); + }); + + await expect(client.readEnvironmentAsync('CunaCup_Becher1')).resolves.toBeTruthy(); }); - - await expect(client.readEnvironmentAsync('CunaCup_Becher1')).resolves.toBeTruthy(); }); - it('can open a file', async function () { - jest.spyOn(http, 'request').mockImplementation((options, callback) => { + describe('openFileAsync', () => { + it('can open a file', async () => { const stream = new IncomingMessage(new Socket()); stream.push( JSON.stringify({ aaslist: ['0 : ExampleMotor : [IRI] http://customer.com/aas/9175_7013_7091_9168 : '], }), ); + stream.push(null); stream.statusCode = 200; stream.statusMessage = 'OK'; - (callback as (res: IncomingMessage) => void)(stream); - return new http.ClientRequest('http://localhost:1234'); + http.get.mockResolvedValue({ + aaslist: ['0 : ExampleMotor : [IRI] http://customer.com/aas/9175_7013_7091_9168 : '], + }); + + http.getResponse.mockResolvedValue(stream); + await expect( + client.openFileAsync( + aasEnvironment.assetAdministrationShells[0], + selectElement(aasEnvironment, 'Documentation', 'OperatingManual', 'DigitalFile_PDF')!, + ), + ).resolves.toBeTruthy(); }); - - await expect( - client.openFileAsync( - aasEnvironment.assetAdministrationShells[0], - selectElement(aasEnvironment, 'Documentation', 'OperatingManual', 'DigitalFile_PDF')!, - ), - ).resolves.toBeTruthy(); }); - it('reads the current value of a data element', async function () { - jest.spyOn(http, 'request').mockImplementation((options, callback) => { - const stream = new IncomingMessage(new Socket()); - stream.push(JSON.stringify({ value: 42 })); - stream.push(null); - stream.statusCode = 200; - stream.statusMessage = 'OK'; - (callback as (res: IncomingMessage) => void)(stream); - - return new http.ClientRequest('http://localhost:1234'); + describe('readValueAsync', () => { + it('reads the current value of a data element', async () => { + http.get.mockResolvedValue({ value: '42' }); + await expect(client.readValueAsync('http://localhost:1234', 'xs:int')).resolves.toBe(42); }); - - await expect(client.readValueAsync('http://localhost:1234', 'xs:int')).resolves.toBe(42); }); describe('resolveNodeId', function () { diff --git a/projects/aas-server/src/test/packages/aas-server/aas-api-client-v3.spec.ts b/projects/aas-server/src/test/packages/aas-server/aas-api-client-v3.spec.ts index 3c26f8b1..580d0087 100644 --- a/projects/aas-server/src/test/packages/aas-server/aas-api-client-v3.spec.ts +++ b/projects/aas-server/src/test/packages/aas-server/aas-api-client-v3.spec.ts @@ -6,33 +6,38 @@ * *****************************************************************************/ -import http, { IncomingMessage } from 'http'; import { createSpyObj } from 'fhg-jest'; import env from '../../assets/aas-environment.js'; import cloneDeep from 'lodash-es/cloneDeep.js'; import { AASApiClientV3, OperationResult } from '../../../app/packages/aas-server/aas-api-client-v3.js'; import { aas, DifferenceItem } from 'aas-core'; -import { Socket } from 'net'; import { Logger } from '../../../app/logging/logger.js'; import { describe, beforeEach, it, expect, jest, afterEach } from '@jest/globals'; +import { HttpClient } from '../../../app/packages/http-client.js'; -describe('AASApiClientV3', function () { +describe('AASApiClientV3', () => { let logger: Logger; let client: AASApiClientV3; + let http: jest.Mocked; - beforeEach(function () { + beforeEach(() => { logger = createSpyObj(['error', 'warning', 'info', 'debug', 'start', 'stop']); - client = new AASApiClientV3(logger, 'http://localhost:1234', 'AASX Server'); + http = createSpyObj(['get', 'getResponse', 'post', 'put', 'delete']); + client = new AASApiClientV3(logger, http, { + name: 'AASX Server', + type: 'AAS_API', + url: 'http://localhost:1234', + }); }); - describe('resolveNodeId', function () { + describe('resolveNodeId', () => { let shell: jest.Mocked; - beforeEach(function () { + beforeEach(() => { shell = createSpyObj({}, { id: 'http://localhost/test/aas' }); }); - it('returns the URL to "property1"', function () { + it('returns the URL to "property1"', () => { const aasId = Buffer.from('http://localhost/test/aas').toString('base64url'); const smId = Buffer.from('http://localhost/test/submodel1').toString('base64url'); const nodeId = smId + '.submodel1/property1'; @@ -42,11 +47,11 @@ describe('AASApiClientV3', function () { }); }); - describe('commitAsync', function () { + describe('commitAsync', () => { let source: aas.Environment; let destination: aas.Environment; - beforeEach(async function () { + beforeEach(async () => { source = env; destination = cloneDeep(source); }); @@ -55,17 +60,8 @@ describe('AASApiClientV3', function () { jest.restoreAllMocks(); }); - it('inserts a submodel', async function () { - jest.spyOn(http, 'request').mockImplementation((options, callback) => { - const stream = new IncomingMessage(new Socket()); - stream.push('Submodel inserted.'); - stream.push(null); - (callback as (res: IncomingMessage) => void)(stream); - stream.statusCode = 201; - stream.statusMessage = 'Created'; - return new http.ClientRequest('http://localhost:1234'); - }); - + it('inserts a submodel', async () => { + http.post.mockResolvedValue('Submodel inserted.'); const diffs: DifferenceItem[] = [ { type: 'inserted', @@ -76,17 +72,8 @@ describe('AASApiClientV3', function () { await expect(client.commitAsync(source, destination, diffs)).resolves.toEqual(['Submodel inserted.']); }); - it('inserts a submodel-element', async function () { - jest.spyOn(http, 'request').mockImplementation((options, callback) => { - const stream = new IncomingMessage(new Socket()); - stream.push('SubmodelElement inserted.'); - stream.push(null); - (callback as (res: IncomingMessage) => void)(stream); - stream.statusCode = 201; - stream.statusMessage = 'Created'; - return new http.ClientRequest('http://localhost:1234'); - }); - + it('inserts a submodel-element', async () => { + http.post.mockResolvedValue('SubmodelElement inserted.'); const diffs: DifferenceItem[] = [ { type: 'inserted', @@ -101,17 +88,8 @@ describe('AASApiClientV3', function () { ]); }); - it('updates a submodel', async function () { - jest.spyOn(http, 'request').mockImplementation((options, callback) => { - const stream = new IncomingMessage(new Socket()); - stream.push('Submodel updated.'); - stream.push(null); - (callback as (res: IncomingMessage) => void)(stream); - stream.statusCode = 200; - stream.statusMessage = 'OK'; - return new http.ClientRequest('http://localhost:1234'); - }); - + it('updates a submodel', async () => { + http.put.mockResolvedValue('Submodel updated.'); const diffs: DifferenceItem[] = [ { type: 'changed', @@ -123,17 +101,8 @@ describe('AASApiClientV3', function () { await expect(client.commitAsync(source, destination, diffs)).resolves.toEqual(['Submodel updated.']); }); - it('updates a submodel-element', async function () { - jest.spyOn(http, 'request').mockImplementation((options, callback) => { - const stream = new IncomingMessage(new Socket()); - stream.push('SubmodelElement updated.'); - stream.push(null); - (callback as (res: IncomingMessage) => void)(stream); - stream.statusCode = 200; - stream.statusMessage = 'OK'; - return new http.ClientRequest('http://localhost:1234'); - }); - + it('updates a submodel-element', async () => { + http.put.mockResolvedValue('SubmodelElement updated.'); const diffs: DifferenceItem[] = [ { type: 'changed', @@ -147,17 +116,8 @@ describe('AASApiClientV3', function () { await expect(client.commitAsync(source, destination, diffs)).resolves.toEqual(['SubmodelElement updated.']); }); - it('deletes a submodel', async function () { - jest.spyOn(http, 'request').mockImplementation((options, callback) => { - const stream = new IncomingMessage(new Socket()); - stream.push('Submodel deleted.'); - stream.push(null); - (callback as (res: IncomingMessage) => void)(stream); - stream.statusCode = 204; - stream.statusMessage = 'No Content'; - return new http.ClientRequest('http://localhost:1234'); - }); - + it('deletes a submodel', async () => { + http.delete.mockResolvedValue('Submodel deleted.'); const diffs: DifferenceItem[] = [ { type: 'deleted', @@ -168,17 +128,8 @@ describe('AASApiClientV3', function () { await expect(client.commitAsync(source, destination, diffs)).resolves.toEqual(['Submodel deleted.']); }); - it('deletes a submodel-element', async function () { - jest.spyOn(http, 'request').mockImplementation((options, callback) => { - const stream = new IncomingMessage(new Socket()); - stream.push('SubmodelElement deleted.'); - stream.push(null); - (callback as (res: IncomingMessage) => void)(stream); - stream.statusCode = 204; - stream.statusMessage = 'No Content'; - return new http.ClientRequest('http://localhost:1234'); - }); - + it('deletes a submodel-element', async () => { + http.delete.mockResolvedValue('SubmodelElement deleted.'); const diffs: DifferenceItem[] = [ { type: 'deleted', @@ -191,22 +142,14 @@ describe('AASApiClientV3', function () { }); }); - describe('invoke', function () { - it('invokes an operation synchronously', async function () { + describe('invoke', () => { + it('invokes an operation synchronously', async () => { const result: OperationResult = { executionState: 'Completed', success: true, }; - jest.spyOn(http, 'request').mockImplementation((options, callback) => { - const stream = new IncomingMessage(new Socket()); - stream.push(JSON.stringify(result)); - stream.push(null); - (callback as (res: IncomingMessage) => void)(stream); - stream.statusCode = 204; - stream.statusMessage = 'No Content'; - return new http.ClientRequest('http://localhost:1234'); - }); + http.post.mockResolvedValue(JSON.stringify(result)); const operation: aas.Operation = { idShort: 'noop', @@ -220,44 +163,13 @@ describe('AASApiClientV3', function () { await expect(client.invoke(env, operation)).resolves.toEqual(operation); }); - it('throws an error if the server returns with status code 500', async function () { - jest.spyOn(http, 'request').mockImplementation((options, callback) => { - const stream = new IncomingMessage(new Socket()); - stream.push(null); - (callback as (res: IncomingMessage) => void)(stream); - stream.statusCode = 500; - stream.statusMessage = 'Internal server error.'; - return new http.ClientRequest('http://localhost:1234'); - }); - - const operation: aas.Operation = { - idShort: 'noop', - modelType: 'Operation', - parent: { - type: 'ModelReference', - keys: [{ type: 'Submodel', value: 'http://i40.customer.com/type/1/1/F13E8576F6488342' }], - }, - }; - - await expect(client.invoke(env, operation)).rejects.toThrowError(); - }); - - it('throws an error if the operation fails', async function () { + it('throws an error if the operation fails', async () => { const result: OperationResult = { - messages: [{ messageType: 'Error', text: 'Operation failed.' }], executionState: 'Failed', success: false, }; - jest.spyOn(http, 'request').mockImplementation((options, callback) => { - const stream = new IncomingMessage(new Socket()); - stream.push(JSON.stringify(result)); - stream.push(null); - (callback as (res: IncomingMessage) => void)(stream); - stream.statusCode = 204; - stream.statusMessage = 'No Content'; - return new http.ClientRequest('http://localhost:1234'); - }); + http.post.mockResolvedValue(JSON.stringify(result)); const operation: aas.Operation = { idShort: 'noop', diff --git a/projects/aas-server/src/test/packages/aas-server/aas-server-package.spec.ts b/projects/aas-server/src/test/packages/aas-server/aas-server-package.spec.ts index 8dd4e113..e039a6b9 100644 --- a/projects/aas-server/src/test/packages/aas-server/aas-server-package.spec.ts +++ b/projects/aas-server/src/test/packages/aas-server/aas-server-package.spec.ts @@ -22,8 +22,7 @@ describe('AasxServerPackage', () => { beforeEach(() => { logger = createSpyObj(['error', 'warning', 'info', 'debug', 'start', 'stop']); server = createSpyObj(['readEnvironmentAsync'], { - url: 'http:/localhost:1234', - name: 'Test', + endpoint: { name: 'Test', type: 'AAS_API', url: 'http:/localhost:1234' }, }); aasPackage = new AASServerPackage(logger, server, 'CunaCup_Becher1'); diff --git a/projects/aas-server/src/test/packages/server-message.spec.ts b/projects/aas-server/src/test/packages/http-client.spec.ts similarity index 82% rename from projects/aas-server/src/test/packages/server-message.spec.ts rename to projects/aas-server/src/test/packages/http-client.spec.ts index 6b1decc4..4b08486d 100644 --- a/projects/aas-server/src/test/packages/server-message.spec.ts +++ b/projects/aas-server/src/test/packages/http-client.spec.ts @@ -9,27 +9,27 @@ import net from 'net'; import http, { IncomingMessage } from 'http'; import { Socket } from 'net'; -import { ServerMessage } from '../../app/packages/server-message.js'; +import { HttpClient } from '../../app/packages/http-client.js'; import { createSpyObj } from 'fhg-jest'; import { describe, beforeEach, it, expect, jest, afterEach } from '@jest/globals'; -describe('ServerMessage', function () { - let server: ServerMessage; +describe('HttpClient', () => { + let server: HttpClient; - beforeEach(function () { - server = new ServerMessage(); + beforeEach(() => { + server = new HttpClient(); }); afterEach(() => { jest.restoreAllMocks(); }); - it('should created', function () { + it('should created', () => { expect(server).toBeTruthy(); }); - describe('get', function () { - beforeEach(function () { + describe('get', () => { + beforeEach(() => { jest.spyOn(http, 'request').mockImplementation((_, callback) => { const stream = new IncomingMessage(new Socket()); stream.push(JSON.stringify({ text: 'Hello World!' })); @@ -41,15 +41,15 @@ describe('ServerMessage', function () { }); }); - it('gets an object from a server', async function () { + it('gets an object from a server', async () => { await expect(server.get<{ text: string }>(new URL('http://localhost:1234/hello/world'))).resolves.toEqual({ text: 'Hello World!', }); }); }); - describe('getResponse', function () { - beforeEach(function () { + describe('getResponse', () => { + beforeEach(() => { jest.spyOn(http, 'request').mockImplementation((_, callback) => { const stream = new IncomingMessage(new Socket()); stream.push(JSON.stringify({ text: 'Hello World!' })); @@ -59,13 +59,13 @@ describe('ServerMessage', function () { }); }); - it('gets the message response', async function () { + it('gets the message response', async () => { await expect(server.getResponse(new URL('http://localhost:1234/hello/world'))).resolves.toBeTruthy(); }); }); - describe('put', function () { - beforeEach(function () { + describe('put', () => { + beforeEach(() => { jest.spyOn(http, 'request').mockImplementation((_, callback) => { const stream = new IncomingMessage(new Socket()); stream.push(JSON.stringify('OK')); @@ -77,15 +77,15 @@ describe('ServerMessage', function () { }); }); - it('updates an object on a server', async function () { + it('updates an object on a server', async () => { await expect( server.put(new URL('http://localhost:1234/hello/world'), { text: 'Hello World!' }), ).resolves.toEqual(JSON.stringify('OK')); }); }); - describe('post', function () { - beforeEach(function () { + describe('post', () => { + beforeEach(() => { jest.spyOn(http, 'request').mockImplementation((_, callback) => { const stream = new IncomingMessage(new Socket()); stream.push(JSON.stringify('Created')); @@ -97,15 +97,15 @@ describe('ServerMessage', function () { }); }); - it('updates an object on a server', async function () { + it('updates an object on a server', async () => { await expect( server.post(new URL('http://localhost:1234/hello/world'), { text: 'Hello World!' }), ).resolves.toEqual(JSON.stringify('Created')); }); }); - describe('delete', function () { - beforeEach(function () { + describe('delete', () => { + beforeEach(() => { jest.spyOn(http, 'request').mockImplementation((_, callback) => { const stream = new IncomingMessage(new Socket()); stream.push(JSON.stringify('Deleted')); @@ -117,21 +117,21 @@ describe('ServerMessage', function () { }); }); - it('updates an object on a server', async function () { + it('updates an object on a server', async () => { await expect(server.delete(new URL('http://localhost:1234/hello/world'))).resolves.toEqual( JSON.stringify('Deleted'), ); }); }); - describe('checkUrlExist', function () { + describe('checkUrlExist', () => { let socket: jest.Mocked; - beforeEach(function () { + beforeEach(() => { socket = createSpyObj(['setTimeout', 'on', 'end', 'destroy']); }); - it('validates a connection', async function () { + it('validates a connection', async () => { socket.on.mockImplementation((event, listener) => { if (event === 'end') { setTimeout(() => (listener as () => void)()); @@ -144,7 +144,7 @@ describe('ServerMessage', function () { await expect(server.checkUrlExist('http://localhost:1234')).resolves.toBeUndefined(); }); - it('throws an error if a connection does not exist', async function () { + it('throws an error if a connection does not exist', async () => { socket.on.mockImplementation((event, listener) => { if (event === 'timeout') { setTimeout(() => (listener as () => void)()); diff --git a/projects/aasportal-index/schema.sql b/projects/aasportal-index/schema.sql index 9022eb2e..e4ccffd9 100644 --- a/projects/aasportal-index/schema.sql +++ b/projects/aasportal-index/schema.sql @@ -4,7 +4,8 @@ CREATE TABLE endpoints ( name VARCHAR(32) PRIMARY KEY, url VARCHAR(255) UNIQUE NOT NULL, type VARCHAR(32) NOT NULL, - version VARCHAR(8) + version VARCHAR(8), + headers VARCHAR(255) ); CREATE TABLE documents ( From 870ad0ba89159b4c603144b22336c801badd8a18 Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Tue, 15 Oct 2024 21:00:49 +0200 Subject: [PATCH 02/76] fix: AddEndpointForm headers --- .../aas-lib/src/lib/aas-tree/aas-tree-row.ts | 2 +- .../add-endpoint-form.component.html | 56 ++++------ .../add-endpoint-form.component.ts | 102 +++++++----------- .../aas-provider/aas-resource-scan-factory.ts | 2 +- .../src/app/{packages => }/http-client.ts | 13 ++- .../src/app/packages/aas-resource-factory.ts | 2 +- .../packages/aas-server/aas-api-client-v0.ts | 2 +- .../packages/aas-server/aas-api-client-v1.ts | 2 +- .../packages/aas-server/aas-api-client-v3.ts | 2 +- .../app/packages/aas-server/aas-api-client.ts | 2 +- .../test/{packages => }/http-client.spec.ts | 2 +- .../aas-server/aas-api-client-v0.spec.ts | 2 +- .../aas-server/aas-api-client-v3.spec.ts | 2 +- 13 files changed, 77 insertions(+), 114 deletions(-) rename projects/aas-server/src/app/{packages => }/http-client.ts (97%) rename projects/aas-server/src/test/{packages => }/http-client.spec.ts (98%) diff --git a/projects/aas-lib/src/lib/aas-tree/aas-tree-row.ts b/projects/aas-lib/src/lib/aas-tree/aas-tree-row.ts index 852529af..0aeff323 100644 --- a/projects/aas-lib/src/lib/aas-tree/aas-tree-row.ts +++ b/projects/aas-lib/src/lib/aas-tree/aas-tree-row.ts @@ -83,7 +83,7 @@ class TreeInitialize { for (const shell of this.env.assetAdministrationShells) { const row = this.createRow(shell, -1, 0, true); this.rows.push(row); - row.firstChild = this.hasChildren(shell) ? this.rows.length : -1; + row.firstChild = this.env.submodels.length > 0 ? this.rows.length : -1; this.traverse(shell, this.rows.length - 1, 1); for (const stateRow of this.rows) { if (stateRow.expanded || stateRow.selected) { diff --git a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html index e24a0b7e..5a79fc55 100644 --- a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html +++ b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html @@ -28,63 +28,51 @@

(input)="inputValue()">
-
@for (item of items(); track item) { - }
- @if (item().type === 'AAS_API') { -
+ @if (selectedItem().type === 'AAS_API') { +
- - - - + + + + + - @for (header of headers(); track header.name) { + @for (header of headers(); track header.id) { + + @if (header === selectedHeader()) { - - - - } + + } + }
#HeaderValue
{{header.id}} - - - @if (!header.selected) { -
{{header.name}}
- } @else { - } 		- @if (!header.selected) { -
{{header.value}}
- } @else { - } 		- @if (header === lastHeader()) { - - - - } @else { - - - - } + } @else { + +
{{header.name}}
+
{{header.value}}
+
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 index c897ecd9..4c555cf2 100644 --- 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 @@ -6,7 +6,6 @@ * *****************************************************************************/ -import head from 'lodash-es/head'; import { ChangeDetectionStrategy, Component, computed, signal } from '@angular/core'; import { FormsModule } from '@angular/forms'; import { NgbActiveModal, NgbDropdownModule, NgbToast } from '@ng-bootstrap/ng-bootstrap'; @@ -14,17 +13,15 @@ import { TranslateModule, TranslateService } from '@ngx-translate/core'; import { AASEndpoint, AASEndpointType, stringFormat } from 'aas-core'; export interface HeaderItem { + id: string; name: string; value: string; - selected: boolean; } export interface EndpointItem { type: AASEndpointType; value: string; placeholder: string; - headers: HeaderItem[]; - selected: boolean; } @Component({ @@ -38,37 +35,37 @@ export interface EndpointItem { export class AddEndpointFormComponent { private readonly endpoints = signal([]); private readonly _messages = signal([]); + private _selectedItemIndex = signal(0); private readonly _items = signal([ { type: 'AAS_API', value: '', placeholder: 'AddEndpointForm.PLACEHOLDER_URL_HTTP', - headers: [{ name: '', value: '', selected: true }], - selected: true, }, { type: 'OPC_UA', value: '', placeholder: 'AddEndpointForm.PLACEHOLDER_URL_OPCUA', - headers: [{ name: '', value: '', selected: true }], - selected: false, }, { type: 'WebDAV', value: '', placeholder: 'AddEndpointForm.PLACEHOLDER_URL_WEBDAV', - headers: [{ name: '', value: '', selected: true }], - selected: false, }, { type: 'FileSystem', value: '', placeholder: 'AddEndpointForm.PLACEHOLDER_URL_FILE', - headers: [{ name: '', value: '', selected: true }], - selected: false, }, ]); + private readonly _selectedHeaderIndex = signal(-1); + private readonly _headers = signal([ + { id: '1', name: '', value: '' }, + { id: '2', name: '', value: '' }, + { id: '3', name: '', value: '' }, + ]); + public constructor( private modal: NgbActiveModal, private translate: TranslateService, @@ -80,78 +77,60 @@ export class AddEndpointFormComponent { public readonly items = this._items.asReadonly(); - public readonly item = computed(() => this._items().find(item => item.selected)!); + public readonly selectedItem = computed(() => this._items()[this._selectedItemIndex()]); - public readonly headers = computed(() => this.item().headers); + public readonly headers = this._headers.asReadonly(); - public readonly header = computed(() => this.item().headers.find(header => header.selected)!); - - public readonly lastHeader = computed(() => head(this.headers())!); + public readonly selectedHeader = computed(() => + this._selectedHeaderIndex() < 0 ? undefined : this._headers()[this._selectedHeaderIndex()], + ); public initialize(endpoints: AASEndpoint[]): void { this.endpoints.set(endpoints); } - public setItem(value: EndpointItem): void { - this._items.update(items => - items.map(item => { - item.selected = item === value; - return item; - }), - ); - + public selectItem(value: EndpointItem): void { + this._selectedItemIndex.set(this._items().indexOf(value)); this.clearMessages(); } - public inputValue(): void { - this.clearMessages(); - } + public selectHeader(value: HeaderItem): void { + this._selectedHeaderIndex.update(state => { + const index = this._headers().indexOf(value); + if (state >= 0 && index === state) { + return -1; + } - public addHeader(): void { - this._items.update(items => - items.map(item => { - if (item.selected) { - const headers = item.headers.map(header => { - header.selected = false; - return header; - }); - - headers.push({ name: '', value: '', selected: true }); - item.headers = headers; - } + return index; + }); - return item; - }), - ); + this.clearMessages(); } - public removeHeader(header: HeaderItem): void { - this._items.update(items => - items.map(item => { - if (item.selected) { - item.headers = item.headers.filter(head => head !== header); - } - - return item; - }), - ); + public inputValue(): void { + this.clearMessages(); } public submit(): void { + const selectedItem = this.selectedItem(); + if (selectedItem === undefined) { + return; + } + this.clearMessages(); const name = this.validateName(); - const url = this.validateUrl(this.item().value.trim()); + const url = this.validateUrl(selectedItem.value.trim(), selectedItem.type); if (name && url) { const version = url.searchParams.get('version'); url.search = ''; - const endpoint: AASEndpoint = { url: url.href, name, type: this.item().type }; + const endpoint: AASEndpoint = { url: url.href, name, type: selectedItem.type }; if (version) { endpoint.version = version; - } else if (this.item().type === 'AAS_API') { + } else if (selectedItem.type === 'AAS_API') { endpoint.version = 'v3'; } - const headers = this.item().headers.filter(header => header.name && header.value); + const headers = this.headers().filter(header => header.name && header.value); if (headers.length > 0) { endpoint.headers = {}; headers.forEach(header => (endpoint.headers![header.name] = header.value)); @@ -192,10 +171,10 @@ export class AddEndpointFormComponent { return name; } - private validateUrl(value: string): URL | undefined { + private validateUrl(value: string, type: AASEndpointType): URL | undefined { try { const url = new URL(value); - switch (this.item().type) { + switch (type) { case 'AAS_API': this.validateAASApiEndpoint(url); break; @@ -212,10 +191,7 @@ export class AddEndpointFormComponent { return url; } catch (error) { - this._messages.update(messages => [ - ...messages, - this.createMessage('ERROR_INVALID_URL', this.item().value), - ]); + this._messages.update(messages => [...messages, this.createMessage('ERROR_INVALID_URL', value)]); return undefined; } diff --git a/projects/aas-server/src/app/aas-provider/aas-resource-scan-factory.ts b/projects/aas-server/src/app/aas-provider/aas-resource-scan-factory.ts index 4aae34bb..72728ef4 100644 --- a/projects/aas-server/src/app/aas-provider/aas-resource-scan-factory.ts +++ b/projects/aas-server/src/app/aas-provider/aas-resource-scan-factory.ts @@ -20,7 +20,7 @@ import { AASApiClientV3 } from '../packages/aas-server/aas-api-client-v3.js'; import { AASApiClientV1 } from '../packages/aas-server/aas-api-client-v1.js'; import { AASApiClientV0 } from '../packages/aas-server/aas-api-client-v0.js'; import { FileStorageProvider } from '../file-storage/file-storage-provider.js'; -import { HttpClient } from '../packages/http-client.js'; +import { HttpClient } from '../http-client.js'; @singleton() export class AASResourceScanFactory { diff --git a/projects/aas-server/src/app/packages/http-client.ts b/projects/aas-server/src/app/http-client.ts similarity index 97% rename from projects/aas-server/src/app/packages/http-client.ts rename to projects/aas-server/src/app/http-client.ts index 7a9d6e94..6b42cc00 100644 --- a/projects/aas-server/src/app/packages/http-client.ts +++ b/projects/aas-server/src/app/http-client.ts @@ -10,7 +10,7 @@ import http from 'http'; import https from 'https'; import net from 'net'; import FormData from 'form-data'; -import { parseUrl } from '../convert.js'; +import { parseUrl } from './convert.js'; import { singleton } from 'tsyringe'; @singleton() @@ -22,20 +22,19 @@ export class HttpClient { * @param headers Additional outgoing http headers. * @returns The requested object. */ - public get(url: URL, headers?: http.OutgoingHttpHeaders): Promise { + public get(url: URL, headers: http.OutgoingHttpHeaders = {}): Promise { return new Promise((result, reject) => { const options: http.RequestOptions = { host: url.hostname, port: url.port, path: url.pathname + url.search, method: 'GET', - timeout: 3000, + headers: { + connection: 'keep-alive', + ...headers, + }, }; - if (headers) { - options.headers = { ...headers }; - } - const requester = url.protocol === 'https:' ? https.request : http.request; const request = requester(options, response => { let data = ''; diff --git a/projects/aas-server/src/app/packages/aas-resource-factory.ts b/projects/aas-server/src/app/packages/aas-resource-factory.ts index 114fbf92..fd44b112 100644 --- a/projects/aas-server/src/app/packages/aas-resource-factory.ts +++ b/projects/aas-server/src/app/packages/aas-resource-factory.ts @@ -17,7 +17,7 @@ import { OpcuaClient } from './opcua/opcua-client.js'; import { ERRORS } from '../errors.js'; import { FileStorageProvider } from '../file-storage/file-storage-provider.js'; import { AASApiClientV1 } from './aas-server/aas-api-client-v1.js'; -import { HttpClient } from './http-client.js'; +import { HttpClient } from '../http-client.js'; @singleton() export class AASResourceFactory { diff --git a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v0.ts b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v0.ts index cd2c4122..997bd2f0 100644 --- a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v0.ts +++ b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v0.ts @@ -12,7 +12,7 @@ import { JsonReaderV2 } from '../json-reader-v2.js'; import { AASApiClient } from './aas-api-client.js'; import { JsonWriterV2 } from '../json-writer-v2.js'; import * as aasV2 from '../../types/aas-v2.js'; -import { HttpClient } from '../http-client.js'; +import { HttpClient } from '../../http-client.js'; interface AASList { aaslist: string[]; diff --git a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v1.ts b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v1.ts index 097fa04b..82e97431 100644 --- a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v1.ts +++ b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v1.ts @@ -28,7 +28,7 @@ import { JsonReaderV2 } from '../json-reader-v2.js'; import { JsonWriterV2 } from '../json-writer-v2.js'; import { ERRORS } from '../../errors.js'; import { JsonReaderV3 } from '../json-reader-v3.js'; -import { HttpClient } from '../http-client.js'; +import { HttpClient } from '../../http-client.js'; interface PackageDescriptor { aasIds: string[]; diff --git a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts index c40a6e3f..5d30e17b 100644 --- a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts +++ b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts @@ -26,7 +26,7 @@ import { isSubmodelElement, selectSubmodel, } from 'aas-core'; -import { HttpClient } from '../http-client.js'; +import { HttpClient } from '../../http-client.js'; interface PackageDescriptor { aasIds: string[]; diff --git a/projects/aas-server/src/app/packages/aas-server/aas-api-client.ts b/projects/aas-server/src/app/packages/aas-server/aas-api-client.ts index bcb8c7da..5645a83a 100644 --- a/projects/aas-server/src/app/packages/aas-server/aas-api-client.ts +++ b/projects/aas-server/src/app/packages/aas-server/aas-api-client.ts @@ -7,7 +7,7 @@ *****************************************************************************/ import { aas, AASEndpoint, convertFromString, DefaultType, DifferenceItem, LiveRequest } from 'aas-core'; -import { HttpClient } from '../http-client.js'; +import { HttpClient } from '../../http-client.js'; import { Logger } from '../../logging/logger.js'; import { HttpSubscription } from '../../live/http/http-subscription.js'; import { SocketClient } from '../../live/socket-client.js'; diff --git a/projects/aas-server/src/test/packages/http-client.spec.ts b/projects/aas-server/src/test/http-client.spec.ts similarity index 98% rename from projects/aas-server/src/test/packages/http-client.spec.ts rename to projects/aas-server/src/test/http-client.spec.ts index 4b08486d..724ba989 100644 --- a/projects/aas-server/src/test/packages/http-client.spec.ts +++ b/projects/aas-server/src/test/http-client.spec.ts @@ -9,7 +9,7 @@ import net from 'net'; import http, { IncomingMessage } from 'http'; import { Socket } from 'net'; -import { HttpClient } from '../../app/packages/http-client.js'; +import { HttpClient } from '../app/http-client.js'; import { createSpyObj } from 'fhg-jest'; import { describe, beforeEach, it, expect, jest, afterEach } from '@jest/globals'; diff --git a/projects/aas-server/src/test/packages/aas-server/aas-api-client-v0.spec.ts b/projects/aas-server/src/test/packages/aas-server/aas-api-client-v0.spec.ts index ee08ab06..bb0dbcea 100644 --- a/projects/aas-server/src/test/packages/aas-server/aas-api-client-v0.spec.ts +++ b/projects/aas-server/src/test/packages/aas-server/aas-api-client-v0.spec.ts @@ -21,7 +21,7 @@ import { AASApiClientV0 } from '../../../app/packages/aas-server/aas-api-client- import { Logger } from '../../../app/logging/logger.js'; import aasEnvironment from '../../assets/aas-environment.js'; import { createSpyObj } from 'fhg-jest'; -import { HttpClient } from '../../../app/packages/http-client.js'; +import { HttpClient } from '../../../app/http-client.js'; describe('AASApiClientV0', function () { let logger: jest.Mocked; diff --git a/projects/aas-server/src/test/packages/aas-server/aas-api-client-v3.spec.ts b/projects/aas-server/src/test/packages/aas-server/aas-api-client-v3.spec.ts index 580d0087..fb05cfad 100644 --- a/projects/aas-server/src/test/packages/aas-server/aas-api-client-v3.spec.ts +++ b/projects/aas-server/src/test/packages/aas-server/aas-api-client-v3.spec.ts @@ -13,7 +13,7 @@ import { AASApiClientV3, OperationResult } from '../../../app/packages/aas-serve import { aas, DifferenceItem } from 'aas-core'; import { Logger } from '../../../app/logging/logger.js'; import { describe, beforeEach, it, expect, jest, afterEach } from '@jest/globals'; -import { HttpClient } from '../../../app/packages/http-client.js'; +import { HttpClient } from '../../../app/http-client.js'; describe('AASApiClientV3', () => { let logger: Logger; From ab5ded3a1f374a49fbc4ddf322526d328ff88376 Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Wed, 16 Oct 2024 16:03:04 +0200 Subject: [PATCH 03/76] fix: AASApiClientV3 updated --- .../aas-server/src/app/packages/aas-server/aas-api-client-v3.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts index 5d30e17b..8252d4f2 100644 --- a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts +++ b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts @@ -98,7 +98,7 @@ export class AASApiClientV3 extends AASApiClient { try { submodels.push( await this.http.get( - this.resolve(`submodels/${submodelId}`), + this.resolve(`shells/${aasId}/submodels/${submodelId}`), this.endpoint.headers, ), ); From e774f57638bc920c7edceb932278f20ac0f3b837 Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Mon, 21 Oct 2024 07:27:26 +0200 Subject: [PATCH 04/76] fix: pagination --- package-lock.json | 23 +- package.json | 1 + projects/aas-core/src/lib/server-message.ts | 6 +- projects/aas-core/src/lib/types.ts | 1 + .../start/add-endpoint-form.component.spec.ts | 16 +- projects/aas-server/package.json | 1 + .../aas-server/src/app/aas-index/aas-index.ts | 8 +- .../src/app/aas-index/lowdb/lowdb-index.ts | 48 ++- .../src/app/aas-index/mysql/mysql-index.ts | 31 +- .../src/app/aas-provider/aas-provider.ts | 67 +++-- .../src/app/aas-provider/aas-resource-scan.ts | 8 +- .../src/app/aas-provider/aas-server-scan.ts | 8 +- .../src/app/aas-provider/directory-scan.ts | 9 +- .../src/app/aas-provider/opcua-server-scan.ts | 8 +- .../src/app/aas-provider/parallel.ts | 21 +- .../src/app/aas-provider/scan-result.ts | 21 +- .../src/app/aas-provider/task-handler.ts | 6 +- .../src/app/aas-provider/worker-data.ts | 16 +- .../{scan-container.ts => endpoint-scan.ts} | 57 ++-- projects/aas-server/src/app/http-client.ts | 283 ++++-------------- .../src/app/packages/aas-resource.ts | 11 +- .../packages/aas-server/aas-api-client-v0.ts | 10 +- .../packages/aas-server/aas-api-client-v1.ts | 8 +- .../packages/aas-server/aas-api-client-v3.ts | 113 ++++--- .../app/packages/aas-server/aas-api-client.ts | 3 +- .../packages/file-system/aasx-directory.ts | 8 +- .../src/app/template/template-storage.ts | 4 +- .../aas-server/src/app/types/paged-result.ts | 16 + projects/aas-server/src/app/worker-app.ts | 68 ++++- .../test/aas-index/lowdb/lowdb-index.spec.ts | 4 +- .../packages/aas-server/aasx-package.spec.ts | 6 +- .../test/packages/opcua/opcua-client.spec.ts | 8 +- projects/aas-server/tsoa.json | 2 +- 33 files changed, 488 insertions(+), 412 deletions(-) rename projects/aas-server/src/app/{scan-container.ts => endpoint-scan.ts} (69%) create mode 100644 projects/aas-server/src/app/types/paged-result.ts diff --git a/package-lock.json b/package-lock.json index ef1cb648..ad67e2cd 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "aas-portal-project", - "version": "3.0.0-development.94", + "version": "3.0.0-development.97", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "aas-portal-project", - "version": "3.0.0-development.94", + "version": "3.0.0-development.97", "license": "Apache-2.0", "workspaces": [ "projects/fhg-jest", @@ -32,6 +32,7 @@ "@popperjs/core": "^2.11.8", "@xmldom/xmldom": "^0.8.10", "aas-core": "projects/aas-core", + "axios": "^1.7.7", "bcryptjs": "^2.4.3", "bootstrap": "^5.3.3", "bootstrap-icons": "^1.11.3", @@ -9124,6 +9125,17 @@ "node": ">= 6.0.0" } }, + "node_modules/axios": { + "version": "1.7.7", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.7.7.tgz", + "integrity": "sha512-S4kL7XrjgBmvdGut0sN3yJxqYzrDOnivkBiN0OFs6hLiUam3UPvswUo0kqGyhqUZGEOytHyumEdXsAkgCOUf3Q==", + "license": "MIT", + "dependencies": { + "follow-redirects": "^1.15.6", + "form-data": "^4.0.0", + "proxy-from-env": "^1.1.0" + } + }, "node_modules/axobject-query": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/axobject-query/-/axobject-query-4.1.0.tgz", @@ -13389,7 +13401,6 @@ "version": "1.15.6", "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.6.tgz", "integrity": "sha512-wWN62YITEaOpSK584EZXJafH1AGpO8RVgElfkuXbTOrPX4fIfOyEpW/CsiNd8JdYrAoOvafRTOEnvsO++qCqFA==", - "dev": true, "funding": [ { "type": "individual", @@ -26136,6 +26147,12 @@ "node": ">= 0.10" } }, + "node_modules/proxy-from-env": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz", + "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==", + "license": "MIT" + }, "node_modules/prr": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/prr/-/prr-1.0.1.tgz", diff --git a/package.json b/package.json index e8105371..1d8a25cb 100644 --- a/package.json +++ b/package.json @@ -55,6 +55,7 @@ "@popperjs/core": "^2.11.8", "@xmldom/xmldom": "^0.8.10", "aas-core": "projects/aas-core", + "axios": "^1.7.7", "bcryptjs": "^2.4.3", "bootstrap": "^5.3.3", "bootstrap-icons": "^1.11.3", diff --git a/projects/aas-core/src/lib/server-message.ts b/projects/aas-core/src/lib/server-message.ts index 4f19cd86..5e31ce8c 100644 --- a/projects/aas-core/src/lib/server-message.ts +++ b/projects/aas-core/src/lib/server-message.ts @@ -6,7 +6,7 @@ * *****************************************************************************/ -import { AASContainer, AASDocument, AASEndpoint } from './types.js'; +import { AASDocument, AASEndpoint } from './types.js'; /** Defines the message types. */ export type AASServerMessageType = @@ -22,9 +22,7 @@ export type AASServerMessageType = export interface AASServerMessage { /** The type of change. */ type: AASServerMessageType; - /** The container if type `ContainerAdded` and `ContainerRemoved`. */ - container?: AASContainer; - /** The endpoint if type `ContainerAdded`, `ContainerRemoved`, `EndpointAdded`, `EndpointRemoved`. */ + /** The endpoint if type `EndpointAdded`, `EndpointRemoved`. */ endpoint?: AASEndpoint; /** The document if type `Added`, `Removed` or `Changed` */ document?: AASDocument; diff --git a/projects/aas-core/src/lib/types.ts b/projects/aas-core/src/lib/types.ts index a0746c97..3e1b2047 100644 --- a/projects/aas-core/src/lib/types.ts +++ b/projects/aas-core/src/lib/types.ts @@ -59,6 +59,7 @@ export type AASEndpoint = { /** Represents a server (AASX, OPC-UA) or file directory (AASX package files). */ export interface AASContainer extends AASEndpoint { + cursor?: string; documents?: AASDocument[]; } diff --git a/projects/aas-portal/src/test/start/add-endpoint-form.component.spec.ts b/projects/aas-portal/src/test/start/add-endpoint-form.component.spec.ts index 4e5b4de0..3e39d753 100644 --- a/projects/aas-portal/src/test/start/add-endpoint-form.component.spec.ts +++ b/projects/aas-portal/src/test/start/add-endpoint-form.component.spec.ts @@ -51,7 +51,7 @@ describe('AddEndpointFormComponent', () => { let endpoint: AASEndpoint | undefined; spyOn(modal, 'close').and.callFake(result => (endpoint = result)); - component.item.set({ ...component.items()[3], value: 'file:///my-endpoint' }); + component.selectItem(component.items()[3]); component.name.set('My endpoint'); form.dispatchEvent(new Event('submit')); @@ -65,7 +65,7 @@ describe('AddEndpointFormComponent', () => { let endpoint: AASEndpoint | undefined; spyOn(modal, 'close').and.callFake(result => (endpoint = result)); - component.item.set({ ...component.items()[3], value: 'file:///a\\b\\my-endpoint' }); + component.selectItem(component.items()[3]); component.name.set('My endpoint'); form.dispatchEvent(new Event('submit')); @@ -78,7 +78,7 @@ describe('AddEndpointFormComponent', () => { it('ignores AAS endpoint: Name: "", URL: "file:///my-endpoint"', () => { spyOn(modal, 'close'); - component.item.set({ ...component.items()[3], value: 'file:///my-endpoint' }); + component.selectItem(component.items()[3]); component.name.set(''); form.dispatchEvent(new Event('submit')); @@ -89,7 +89,7 @@ describe('AddEndpointFormComponent', () => { it('ignores AAS endpoint Name: "My endpoint", URL: "file:///"', () => { spyOn(modal, 'close'); - component.item.set({ ...component.items()[3], value: 'file:///' }); + component.selectItem(component.items()[3]); component.name.set('My endpoint'); form.dispatchEvent(new Event('submit')); @@ -101,7 +101,7 @@ describe('AddEndpointFormComponent', () => { let endpoint: AASEndpoint | undefined; spyOn(modal, 'close').and.callFake(result => (endpoint = result)); - component.item.set({ ...component.items()[1], value: 'opc.tcp://localhost:30001/I4AASServer' }); + component.selectItem(component.items()[1]); component.name.set('I4AAS Server'); form.dispatchEvent(new Event('submit')); @@ -114,7 +114,7 @@ describe('AddEndpointFormComponent', () => { it('ignores AAS endpoint Name: "I4AAS Server", URL: "opc.tcp://"', () => { spyOn(modal, 'close'); - component.item.set(component.items()[1]); + component.selectItem(component.items()[1]); fixture.detectChanges(); inputNameElement.value = 'I4AAS Server'; @@ -131,7 +131,7 @@ describe('AddEndpointFormComponent', () => { let endpoint: AASEndpoint | undefined; spyOn(modal, 'close').and.callFake(result => (endpoint = result)); - component.item.set({ ...component.items()[0], value: 'http://localhost:50001/' }); + component.selectItem(component.items()[0]); component.name.set('AASX Server'); form.dispatchEvent(new Event('submit')); @@ -145,7 +145,7 @@ describe('AddEndpointFormComponent', () => { let endpoint: AASEndpoint | undefined; spyOn(modal, 'close').and.callFake(result => (endpoint = result)); - component.item.set({ ...component.items()[2], value: 'http://localhost:8080/root/folder' }); + component.selectItem(component.items()[2]); component.name.set('WebDAV Server'); form.dispatchEvent(new Event('submit')); diff --git a/projects/aas-server/package.json b/projects/aas-server/package.json index 683b53d3..4f754ceb 100644 --- a/projects/aas-server/package.json +++ b/projects/aas-server/package.json @@ -22,6 +22,7 @@ "dependencies": { "@babel/polyfill": "^7.4.4", "@xmldom/xmldom": "^0.8.10", + "axios": "^1.7.7", "bcryptjs": "^2.4.3", "chalk": "^2.4.1", "cors": "^2.8.5", diff --git a/projects/aas-server/src/app/aas-index/aas-index.ts b/projects/aas-server/src/app/aas-index/aas-index.ts index 36045caf..a63a1b24 100644 --- a/projects/aas-server/src/app/aas-index/aas-index.ts +++ b/projects/aas-server/src/app/aas-index/aas-index.ts @@ -20,6 +20,8 @@ import { toBoolean, } from 'aas-core'; +import { PagedResult } from '../types/paged-result.js'; + export abstract class AASIndex { public abstract getCount(query?: string): Promise; @@ -35,7 +37,11 @@ export abstract class AASIndex { public abstract getDocuments(cursor: AASCursor, query?: string, language?: string): Promise; - public abstract getContainerDocuments(endpointName: string): Promise; + public abstract nextPage( + endpointName: string, + cursor: string | undefined, + limit?: number, + ): Promise>; public abstract update(document: AASDocument): Promise; diff --git a/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts b/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts index 8cf486eb..4cdcf8ed 100644 --- a/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts +++ b/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts @@ -26,6 +26,8 @@ import { Variable } from '../../variable.js'; import { urlToEndpoint } from '../../configuration.js'; import { ERRORS } from '../../errors.js'; import { LowDbData, LowDbDocument, LowDbElement } from './lowdb-types.js'; +import { decodeBase64Url, encodeBase64Url } from '../../convert.js'; +import { PagedResult } from '../../types/paged-result.js'; export class LowDbIndex extends AASIndex { private readonly promise: Promise; @@ -88,9 +90,51 @@ export class LowDbIndex extends AASIndex { return true; } - public override async getContainerDocuments(endpointName: string): Promise { + public override async nextPage( + endpointName: string, + cursor: string | undefined, + limit: number = 10, + ): Promise> { await this.promise; - return this.db.data.documents.filter(document => document.endpoint === endpointName); + + if (cursor) { + cursor = decodeBase64Url(cursor); + } + + const documents: AASDocument[] = []; + if (this.db.data.documents.length === 0) { + return { result: documents, paging_metadata: {} }; + } + + const items = this.db.data.documents; + const index = items.findIndex(item => { + if (item.endpoint !== endpointName) { + return false; + } + + return cursor === undefined || cursor.localeCompare(item.id) <= 0; + }); + + if (index < 0) { + return { result: documents, paging_metadata: {} }; + } + + const result: AASDocument[] = []; + for (let i = 0, j = index, n = items.length; i < limit && j < n; i++, j++) { + const item = items[j]; + if (item.endpoint !== endpointName) { + break; + } + + result.push(item); + } + + const k = index + limit + 1; + if (k >= items.length || items[k].endpoint !== endpointName) { + return { result, paging_metadata: {} }; + } + + return { result, paging_metadata: { cursor: encodeBase64Url(items[k].id) } }; } public override async getDocuments(cursor: AASCursor, query?: string, language?: string): Promise { diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts index da7fd15e..80dbd517 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts @@ -15,6 +15,8 @@ import { Variable } from '../../variable.js'; import { urlToEndpoint } from '../../configuration.js'; import { MySqlQuery } from './mysql-query.js'; import { DocumentCount, MySqlDocument, MySqlEndpoint } from './mysql-types.js'; +import { PagedResult } from '../../types/paged-result.js'; +import { encodeBase64Url } from '../../convert.js'; export class MySqlIndex extends AASIndex { private readonly connection: Promise; @@ -117,12 +119,29 @@ export class MySqlIndex extends AASIndex { return this.getLastPage(cursor.limit); } - public override async getContainerDocuments(endpointName: string): Promise { - return ( - await ( - await this.connection - ).query('SELECT * FROM `documents` WHERE endpoint = ?', [endpointName]) - )[0].map(row => this.toDocument(row)); + public override async nextPage( + endpointName: string, + cursor: string | undefined, + limit: number = 100, + ): Promise> { + const connection = await this.connection; + let sql: string; + const values: unknown[] = [endpointName + cursor]; + if (cursor) { + values.push(limit + 1); + sql = 'SELECT * FROM `documents` WHERE CONCAT(endpoint, id) > ? ORDER BY endpoint ASC, id ASC LIMIT ?;'; + } else { + sql = 'SELECT * FROM `documents` ORDER BY endpoint ASC, id ASC LIMIT ?;'; + } + + const [results] = await connection.query(sql, values); + const documents = results.map(result => this.toDocument(result)); + return { + result: documents.slice(0, limit), + paging_metadata: { + cursor: documents.length >= limit + 1 ? encodeBase64Url(documents[limit].id) : undefined, + }, + }; } public override async update(document: AASDocument): Promise { diff --git a/projects/aas-server/src/app/aas-provider/aas-provider.ts b/projects/aas-server/src/app/aas-provider/aas-provider.ts index ec528b33..b8f4e33e 100644 --- a/projects/aas-server/src/app/aas-provider/aas-provider.ts +++ b/projects/aas-server/src/app/aas-provider/aas-provider.ts @@ -26,10 +26,10 @@ import { import { ImageProcessing } from '../image-processing.js'; import { AASIndex } from '../aas-index/aas-index.js'; -import { ScanResultType, ScanResult, ScanContainerResult } from './scan-result.js'; +import { ScanResultType, ScanResult, ScanEndpointResult, ScanNextPageResult } from './scan-result.js'; import { Logger } from '../logging/logger.js'; import { Parallel } from './parallel.js'; -import { ScanContainerData } from './worker-data.js'; +import { ScanEndpointData } from './worker-data.js'; import { SocketClient } from '../live/socket-client.js'; import { EmptySubscription } from '../live/empty-subscription.js'; import { SocketSubscription } from '../live/socket-subscription.js'; @@ -61,6 +61,7 @@ export class AASProvider { this.timeout = variable.SCAN_CONTAINER_TIMEOUT; this.parallel.on('message', this.parallelOnMessage); this.parallel.on('end', this.parallelOnEnd); + this.parallel.on('nextPage', this.parallelOnNextPage); } /** @@ -232,7 +233,7 @@ export class AASProvider { } as AASServerMessage, }); - setTimeout(this.scanContainer, 0, this.taskHandler.createTaskId(), endpoint); + setTimeout(this.scanEndpoint, 0, this.taskHandler.createTaskId(), endpoint); } /** @@ -376,8 +377,8 @@ export class AASProvider { public async scanAsync(factory: AASResourceScanFactory): Promise { for (const endpoint of await this.index.getEndpoints()) { if (endpoint.type === 'FileSystem') { - const documents = await factory.create(endpoint).scanAsync(); - documents.forEach(async document => await this.index.add(document)); + const result = await factory.create(endpoint).scanAsync(); + result.result.forEach(async document => await this.index.add(document)); } } } @@ -463,22 +464,23 @@ export class AASProvider { private startScan = async (): Promise => { try { for (const endpoint of await this.index.getEndpoints()) { - setTimeout(this.scanContainer, 0, this.taskHandler.createTaskId(), endpoint); + setTimeout(this.scanEndpoint, 0, this.taskHandler.createTaskId(), endpoint); } } catch (error) { this.logger.error(error); } }; - private scanContainer = async (taskId: number, endpoint: AASEndpoint) => { - const documents = await this.index.getContainerDocuments(endpoint.name); - const data: ScanContainerData = { - type: 'ScanContainerData', + private scanEndpoint = async (taskId: number, endpoint: AASEndpoint) => { + const result = await this.index.nextPage(endpoint.name, undefined); + const data: ScanEndpointData = { + type: 'ScanEndpointData', taskId, - container: { ...endpoint, documents }, + endpoint, + documents: result.result, }; - this.taskHandler.set(taskId, { name: endpoint.name, owner: this, type: 'ScanContainer' }); + this.taskHandler.set(taskId, { endpointName: endpoint.name, owner: this, type: 'ScanEndpoint' }); this.parallel.execute(data); }; @@ -496,13 +498,13 @@ export class AASProvider { } this.taskHandler.delete(result.taskId); - if ((await await this.index.hasEndpoint(task.name)) === true) { - const endpoint = await this.index.getEndpoint(task.name); - setTimeout(this.scanContainer, this.timeout, result.taskId, endpoint); + if ((await await this.index.hasEndpoint(task.endpointName)) === true) { + const endpoint = await this.index.getEndpoint(task.endpointName); + setTimeout(this.scanEndpoint, this.timeout, result.taskId, endpoint); } if (result.messages) { - this.logger.start(`scan ${task.name ?? 'undefined'}`); + this.logger.start(`scan ${task.endpointName ?? 'undefined'}`); result.messages.forEach(message => this.logger.log(message)); this.logger.stop(); } @@ -512,17 +514,17 @@ export class AASProvider { } }; - private parallelOnMessage = async (result: ScanResult) => { + private parallelOnMessage = async (result: ScanEndpointResult) => { try { switch (result.type) { case ScanResultType.Changed: - await this.onChanged(result as ScanContainerResult); + await this.onChanged(result); break; case ScanResultType.Added: - await this.onAdded(result as ScanContainerResult); + await this.onAdded(result); break; case ScanResultType.Removed: - await this.onRemoved(result as ScanContainerResult); + await this.onRemoved(result); break; } } catch (error) { @@ -530,7 +532,20 @@ export class AASProvider { } }; - private async onChanged(result: ScanContainerResult): Promise { + private parallelOnNextPage = async (result: ScanNextPageResult, worker: Worker) => { + const a = await this.index.nextPage(result.endpoint.name, result.cursor); + const data: ScanEndpointData = { + type: 'ScanEndpointData', + taskId: result.taskId, + endpoint: result.endpoint, + documents: a.result, + cursor: a.paging_metadata.cursor, + }; + + worker.postMessage(data); + }; + + private async onChanged(result: ScanEndpointResult): Promise { const document = result.document; if ((await this.index.hasEndpoint(document.endpoint)) === false) { return; @@ -544,25 +559,25 @@ export class AASProvider { this.sendMessage({ type: 'Changed', document: { ...document, content: null } }); } - private async onAdded(result: ScanContainerResult): Promise { + private async onAdded(result: ScanEndpointResult): Promise { if ((await this.index.hasEndpoint(result.document.endpoint)) === false) { return; } await this.index.add(result.document); - this.logger.info(`Added: AAS ${result.document.idShort} [${result.document.id}] in ${result.container.url}`); + this.logger.info(`Added: AAS ${result.document.idShort} [${result.document.id}] in ${result.endpoint.url}`); this.sendMessage({ type: 'Added', document: result.document }); } - private async onRemoved(result: ScanContainerResult): Promise { + private async onRemoved(result: ScanEndpointResult): Promise { const document = result.document; if ((await this.index.hasEndpoint(document.endpoint)) === false) { return; } - await this.index.remove(result.container.name, document.id); + await this.index.remove(result.endpoint.name, document.id); this.cache.remove(document.endpoint, document.id); - this.logger.info(`Removed: AAS ${document.idShort} [${document.id}] in ${result.container.url}`); + this.logger.info(`Removed: AAS ${document.idShort} [${document.id}] in ${result.endpoint.url}`); this.sendMessage({ type: 'Removed', document: { ...document, content: null } }); } diff --git a/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts b/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts index 45806610..23be2d98 100644 --- a/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts +++ b/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts @@ -8,9 +8,13 @@ import EventEmitter from 'events'; import { AASDocument } from 'aas-core'; +import { PagedResult } from '../types/paged-result.js'; /** Defines an automate to scan an AAS resource for Asset Administration Shells. */ export abstract class AASResourceScan extends EventEmitter { - /** Gets all documents of the current container. */ - public abstract scanAsync(): Promise; + /** + * Gets all documents of the current container. + * @param cursor ToDo. + * */ + public abstract scanAsync(cursor?: string): Promise>; } diff --git a/projects/aas-server/src/app/aas-provider/aas-server-scan.ts b/projects/aas-server/src/app/aas-provider/aas-server-scan.ts index b34f2acb..5fc28902 100644 --- a/projects/aas-server/src/app/aas-provider/aas-server-scan.ts +++ b/projects/aas-server/src/app/aas-provider/aas-server-scan.ts @@ -11,6 +11,7 @@ import { Logger } from '../logging/logger.js'; import { AASApiClient } from '../packages/aas-server/aas-api-client.js'; import { AASServerPackage } from '../packages/aas-server/aas-server-package.js'; import { AASResourceScan } from './aas-resource-scan.js'; +import { PagedResult } from '../types/paged-result.js'; export class AASServerScan extends AASResourceScan { private readonly logger: Logger; @@ -23,11 +24,12 @@ export class AASServerScan extends AASResourceScan { this.server = server; } - public async scanAsync(): Promise { + public async scanAsync(cursor?: string): Promise> { try { await this.server.openAsync(); const documents: AASDocument[] = []; - const ids = new Set(await this.server.getShellsAsync()); + const result = await this.server.getShellsAsync(cursor); + const ids = new Set(result.result); for (const id of ids) { try { const aasPackage = new AASServerPackage(this.logger, this.server, id); @@ -39,7 +41,7 @@ export class AASServerScan extends AASResourceScan { } } - return documents; + return { result: documents, paging_metadata: { cursor: result.paging_metadata.cursor } }; } finally { await this.server.closeAsync(); } diff --git a/projects/aas-server/src/app/aas-provider/directory-scan.ts b/projects/aas-server/src/app/aas-provider/directory-scan.ts index 65b418f7..e3ffddbd 100644 --- a/projects/aas-server/src/app/aas-provider/directory-scan.ts +++ b/projects/aas-server/src/app/aas-provider/directory-scan.ts @@ -11,6 +11,7 @@ import { Logger } from '../logging/logger.js'; import { AasxPackage } from '../packages/file-system/aasx-package.js'; import { AasxDirectory } from '../packages/file-system/aasx-directory.js'; import { AASResourceScan } from './aas-resource-scan.js'; +import { PagedResult } from '../types/paged-result.js'; export class DirectoryScan extends AASResourceScan { public constructor( @@ -20,12 +21,12 @@ export class DirectoryScan extends AASResourceScan { super(); } - public async scanAsync(): Promise { + public async scanAsync(cursor?: string): Promise> { try { await this.source.openAsync(); - const files = await this.source.getFiles(); + const result = await this.source.getFiles(cursor); const documents: AASDocument[] = []; - for (const file of files) { + for (const file of result.result) { try { const aasxPackage = new AasxPackage(this.logger, this.source, file); const document = await aasxPackage.createDocumentAsync(); @@ -36,7 +37,7 @@ export class DirectoryScan extends AASResourceScan { } } - return documents; + return { result: documents, paging_metadata: { cursor: result.paging_metadata.cursor } }; } finally { await this.source.closeAsync(); } diff --git a/projects/aas-server/src/app/aas-provider/opcua-server-scan.ts b/projects/aas-server/src/app/aas-provider/opcua-server-scan.ts index fb39e0e0..0c405de6 100644 --- a/projects/aas-server/src/app/aas-provider/opcua-server-scan.ts +++ b/projects/aas-server/src/app/aas-provider/opcua-server-scan.ts @@ -7,12 +7,13 @@ *****************************************************************************/ import { AttributeIds, BrowseDescriptionLike, QualifiedName, ReferenceDescription } from 'node-opcua'; -import { AASDocument } from 'aas-core'; +import { AASDocument, noop } from 'aas-core'; import { Logger } from '../logging/logger.js'; import { OpcuaDataTypeDictionary } from '../packages/opcua/opcua-data-type-dictionary.js'; import { OpcuaClient } from '../packages/opcua/opcua-client.js'; import { OpcuaPackage } from '../packages/opcua/opcua-package.js'; import { AASResourceScan } from './aas-resource-scan.js'; +import { PagedResult } from '../types/paged-result.js'; export class OpcuaServerScan extends AASResourceScan { private readonly logger: Logger; @@ -25,8 +26,9 @@ export class OpcuaServerScan extends AASResourceScan { this.server = server; } - public async scanAsync(): Promise { + public async scanAsync(cursor?: string): Promise> { try { + noop(cursor); await this.server.openAsync(); const documents: AASDocument[] = []; const dataTypes = new OpcuaDataTypeDictionary(); @@ -43,7 +45,7 @@ export class OpcuaServerScan extends AASResourceScan { } } - return documents; + return { result: documents, paging_metadata: {} }; } finally { await this.server.closeAsync(); } diff --git a/projects/aas-server/src/app/aas-provider/parallel.ts b/projects/aas-server/src/app/aas-provider/parallel.ts index 052e84b3..f10a9660 100644 --- a/projects/aas-server/src/app/aas-provider/parallel.ts +++ b/projects/aas-server/src/app/aas-provider/parallel.ts @@ -53,10 +53,16 @@ class WorkerTask extends EventEmitter { private workerOnMessage = (value: Uint8Array) => { const result: ScanResult = JSON.parse(Buffer.from(value).toString()); - if (result.type === ScanResultType.End) { - this.emit('end', this, result); - } else { - this.emit('message', result); + switch (result.type) { + case ScanResultType.End: + this.emit('end', result, this); + break; + case ScanResultType.NextPage: + this.emit('nextPage', result, this); + break; + default: + this.emit('message', result); + break; } }; @@ -95,6 +101,7 @@ export class Parallel extends EventEmitter { public execute(data: WorkerData): void { const task = new WorkerTask(data); task.on('message', this.taskOnMessage); + task.on('nextPage', this.taskOnNextPage); task.on('end', this.taskOnEnd); task.on('error', this.taskOnError); @@ -127,7 +134,11 @@ export class Parallel extends EventEmitter { this.emit('message', result); }; - private taskOnEnd = (task: WorkerTask, result: ScanResult) => { + private taskOnNextPage = (result: ScanResult, task: WorkerTask) => { + this.emit('nextPage', result, task.worker); + }; + + private taskOnEnd = (result: ScanResult, task: WorkerTask) => { this.emit('end', result); if (task) { diff --git a/projects/aas-server/src/app/aas-provider/scan-result.ts b/projects/aas-server/src/app/aas-provider/scan-result.ts index 3ba9db13..ce2262ed 100644 --- a/projects/aas-server/src/app/aas-provider/scan-result.ts +++ b/projects/aas-server/src/app/aas-provider/scan-result.ts @@ -6,13 +6,14 @@ * *****************************************************************************/ -import { AASDocument, AASContainer, Message, TemplateDescriptor } from 'aas-core'; +import { AASDocument, Message, TemplateDescriptor, AASEndpoint } from 'aas-core'; export enum ScanResultType { Added, Removed, Changed, Update, + NextPage, End, } @@ -26,15 +27,21 @@ export interface ScanResult { messages?: Message[]; } -/** The result of a container scan. */ -export interface ScanContainerResult extends ScanResult { - /** The AAS container. */ - container: AASContainer; - /** The result subject. */ +/** The result of an endpoint scan. */ +export interface ScanEndpointResult extends ScanResult { + endpoint: AASEndpoint; + documents: AASDocument[]; + cursor?: string; document: AASDocument; } -/** The result of a container scan. */ +/** The result of a template scan. */ export interface ScanTemplatesResult extends ScanResult { templates: TemplateDescriptor[]; } + +/** The result for a next page request. */ +export interface ScanNextPageResult extends ScanResult { + endpoint: AASEndpoint; + cursor: string; +} diff --git a/projects/aas-server/src/app/aas-provider/task-handler.ts b/projects/aas-server/src/app/aas-provider/task-handler.ts index 3ca0cf51..760ec767 100644 --- a/projects/aas-server/src/app/aas-provider/task-handler.ts +++ b/projects/aas-server/src/app/aas-provider/task-handler.ts @@ -9,9 +9,9 @@ import { singleton } from 'tsyringe'; export interface Task { - name: string; + endpointName: string; owner: object; - type: 'ScanContainer' | 'ScanTemplates'; + type: 'ScanEndpoint' | 'ScanTemplates'; } @singleton() @@ -34,7 +34,7 @@ export class TaskHandler { public empty(owner: object, name?: string): boolean { for (const task of this.tasks.values()) { - if (task.owner === owner && (!name || task.name === name)) { + if (task.owner === owner && (!name || task.endpointName === name)) { return false; } } diff --git a/projects/aas-server/src/app/aas-provider/worker-data.ts b/projects/aas-server/src/app/aas-provider/worker-data.ts index a8757836..c34b749f 100644 --- a/projects/aas-server/src/app/aas-provider/worker-data.ts +++ b/projects/aas-server/src/app/aas-provider/worker-data.ts @@ -6,24 +6,26 @@ * *****************************************************************************/ -import { AASContainer } from 'aas-core'; +import { AASDocument, AASEndpoint } from 'aas-core'; export interface WorkerData { taskId: number; - type: 'ScanContainerData' | 'ScanTemplatesData'; + type: 'ScanEndpointData' | 'ScanTemplatesData'; } -export interface ScanContainerData extends WorkerData { - type: 'ScanContainerData'; - container: AASContainer; +export interface ScanEndpointData extends WorkerData { + type: 'ScanEndpointData'; + endpoint: AASEndpoint; + documents: AASDocument[]; + cursor?: string; } export interface ScanTemplatesData extends WorkerData { type: 'ScanTemplatesData'; } -export function isScanContainerData(data: WorkerData): data is ScanContainerData { - return data.type === 'ScanContainerData'; +export function isScanEndpointData(data: WorkerData): data is ScanEndpointData { + return data.type === 'ScanEndpointData'; } export function isScanTemplatesData(data: WorkerData): data is ScanTemplatesData { diff --git a/projects/aas-server/src/app/scan-container.ts b/projects/aas-server/src/app/endpoint-scan.ts similarity index 69% rename from projects/aas-server/src/app/scan-container.ts rename to projects/aas-server/src/app/endpoint-scan.ts index e96a99b8..a2b1ca52 100644 --- a/projects/aas-server/src/app/scan-container.ts +++ b/projects/aas-server/src/app/endpoint-scan.ts @@ -10,15 +10,15 @@ import { inject, singleton } from 'tsyringe'; import { parentPort } from 'worker_threads'; import { Logger } from './logging/logger.js'; import { AASDocument } from 'aas-core'; -import { ScanContainerData } from './aas-provider/worker-data.js'; -import { ScanContainerResult, ScanResultType } from './aas-provider/scan-result.js'; +import { ScanEndpointData } from './aas-provider/worker-data.js'; +import { ScanEndpointResult, ScanResultType } from './aas-provider/scan-result.js'; import { toUint8Array } from './convert.js'; import { AASResourceScanFactory } from './aas-provider/aas-resource-scan-factory.js'; import { Variable } from './variable.js'; @singleton() -export class ScanContainer { - private data!: ScanContainerData; +export class EndpointScan { + private data!: ScanEndpointData; public constructor( @inject('Logger') private readonly logger: Logger, @@ -26,15 +26,15 @@ export class ScanContainer { @inject(Variable) private readonly variable: Variable, ) {} - public async scanAsync(data: ScanContainerData): Promise { + public async scanAsync(data: ScanEndpointData): Promise { this.data = data; - let documents: AASDocument[]; - const scan = this.resourceScanFactory.create(data.container); + const scan = this.resourceScanFactory.create(data.endpoint); try { scan.on('scanned', this.onDocumentScanned); scan.on('error', this.onError); - documents = await scan.scanAsync(); - this.computeDeleted(documents); + const result = await scan.scanAsync(data.cursor); + this.computeDeleted(result.result); + return result.paging_metadata.cursor; } finally { scan.off('scanned', this.onDocumentScanned); scan.off('error', this.onError); @@ -42,10 +42,12 @@ export class ScanContainer { } private computeDeleted(documents: AASDocument[]): void { - if (!this.data.container.documents) return; + if (this.data.documents === undefined) { + return; + } const current = new Map(documents.map(item => [item.id, item])); - for (const document of this.data.container.documents) { + for (const document of this.data.documents) { if (!current.has(document.id)) { this.postDeleted(document); } @@ -53,7 +55,7 @@ export class ScanContainer { } private onDocumentScanned = (document: AASDocument): void => { - const reference = this.data.container.documents?.find(item => item.id === document.id); + const reference = this.data.documents?.find(item => item.id === document.id); if (reference) { if (this.documentChanged(document, reference)) { this.postChanged(document); @@ -68,10 +70,12 @@ export class ScanContainer { }; private postChanged(document: AASDocument): void { - const value: ScanContainerResult = { + const value: ScanEndpointResult = { taskId: this.data.taskId, type: ScanResultType.Changed, - container: this.data.container, + endpoint: this.data.endpoint, + documents: this.data.documents, + cursor: this.data.cursor, document: document, }; @@ -80,10 +84,12 @@ export class ScanContainer { } private postDeleted(document: AASDocument): void { - const value: ScanContainerResult = { + const value: ScanEndpointResult = { taskId: this.data.taskId, type: ScanResultType.Removed, - container: this.data.container, + endpoint: this.data.endpoint, + documents: this.data.documents, + cursor: this.data.cursor, document: document, }; @@ -92,10 +98,12 @@ export class ScanContainer { } private postAdded(document: AASDocument): void { - const value: ScanContainerResult = { + const value: ScanEndpointResult = { taskId: this.data.taskId, type: ScanResultType.Added, - container: this.data.container, + endpoint: this.data.endpoint, + documents: this.data.documents, + cursor: this.data.cursor, document: document, }; @@ -113,17 +121,4 @@ export class ScanContainer { return true; } - - // private equalContent(a: aas.Environment | null, b: aas.Environment | null): boolean { - // let equals: boolean; - // if (a === b) { - // equals = true; - // } else if (a !== null && b !== null) { - // equals = isDeepEqual(a, b); - // } else { - // equals = false; - // } - - // return equals; - // } } diff --git a/projects/aas-server/src/app/http-client.ts b/projects/aas-server/src/app/http-client.ts index 6b42cc00..ced44f64 100644 --- a/projects/aas-server/src/app/http-client.ts +++ b/projects/aas-server/src/app/http-client.ts @@ -7,11 +7,11 @@ *****************************************************************************/ import http from 'http'; -import https from 'https'; import net from 'net'; import FormData from 'form-data'; -import { parseUrl } from './convert.js'; +import axios, { AxiosResponse } from 'axios'; import { singleton } from 'tsyringe'; +import { parseUrl } from './convert.js'; @singleton() export class HttpClient { @@ -22,43 +22,12 @@ export class HttpClient { * @param headers Additional outgoing http headers. * @returns The requested object. */ - public get(url: URL, headers: http.OutgoingHttpHeaders = {}): Promise { - return new Promise((result, reject) => { - const options: http.RequestOptions = { - host: url.hostname, - port: url.port, - path: url.pathname + url.search, - method: 'GET', - headers: { - connection: 'keep-alive', - ...headers, - }, - }; - - const requester = url.protocol === 'https:' ? https.request : http.request; - const request = requester(options, response => { - let data = ''; - response.on('data', (chunk: string) => { - data += chunk; - }); - - response.on('end', () => { - try { - HttpClient.checkStatusCode(response, data); - result(JSON.parse(data)); - } catch (error) { - reject(error); - } - }); - - response.on('error', error => reject(error)); - }); - - request - .on('timeout', () => request.destroy()) - .on('error', error => reject(error)) - .end(); + public async get(url: URL, headers?: Record): Promise { + const response: AxiosResponse = await axios.get(url.toString(), { + headers, }); + + return response.data; } /** @@ -67,27 +36,13 @@ export class HttpClient { * @param headers Additional outgoing http headers. * @returns The request. */ - public getResponse(url: URL, headers?: http.OutgoingHttpHeaders): Promise { - return new Promise((result, reject) => { - const options: http.RequestOptions = { - host: url.hostname, - port: url.port, - path: url.pathname + url.search, - method: 'GET', - timeout: 3000, - }; - - if (headers) { - options.headers = { ...headers }; - } - - const requester = url.protocol === 'https:' ? https.request : http.request; - const request = requester(options, response => result(response)); - request - .on('timeout', () => request.destroy()) - .on('error', error => reject(error)) - .end(); + public async getResponse(url: URL, headers?: Record): Promise { + const response = await axios.get(url.toString(), { + headers, + responseType: 'stream', }); + + return response.data; } /** @@ -96,43 +51,18 @@ export class HttpClient { * @param obj The object to send. * @param headers Additional outgoing http headers. */ - public put(url: URL, obj: object, headers: http.OutgoingHttpHeaders = {}): Promise { - return new Promise((result, reject) => { - const data = JSON.stringify(obj); - const options: http.RequestOptions = { - hostname: url.hostname, - port: url.port, - path: url.pathname + url.search, - method: 'PUT', - headers: { - 'Content-Type': 'application/json', - 'Content-Length': Buffer.byteLength(data), - ...headers, - }, - }; - - const requester = url.protocol === 'https:' ? https.request : http.request; - const request = requester(options, response => { - let responseData = ''; - response.on('data', (chunk: string) => { - responseData += chunk; - }); - - response.on('end', () => { - try { - HttpClient.checkStatusCode(response, responseData); - result(responseData); - } catch (error) { - reject(error); - } - }); + public async put(url: URL, obj: object, headers?: Record): Promise { + const response = await axios.put(url.toString(), { + obj, + headers, + }); - response.on('error', error => reject(error)); - }).on('error', error => reject(error)); + const data = response.data; + if (typeof data === 'string') { + return data; + } - request.write(data); - request.end(); - }); + return response.statusText; } /** @@ -141,7 +71,7 @@ export class HttpClient { * @param obj The object to send. * @param headers Additional outgoing http headers. */ - public post(url: URL, obj: FormData | object, headers?: http.OutgoingHttpHeaders): Promise { + public post(url: URL, obj: FormData | object, headers?: Record): Promise { return obj instanceof FormData ? this.postFormData(url, obj, headers) : this.postObject(url, obj, headers); } @@ -150,40 +80,17 @@ export class HttpClient { * @param url The URL of the object to delete. * @param headers Additional outgoing http headers. */ - public delete(url: URL, headers: http.OutgoingHttpHeaders = {}): Promise { - return new Promise((result, reject) => { - const options: https.RequestOptions = { - hostname: url.hostname, - port: url.port, - path: url.pathname + url.search, - method: 'DELETE', - headers: { - 'Content-Type': 'application/json', - ...headers, - }, - }; - - const requester = url.protocol === 'https:' ? https.request : http.request; - requester(options, response => { - let responseData = ''; - response.on('data', (chunk: string) => { - responseData += chunk; - }); + public async delete(url: URL, headers?: Record): Promise { + const response = await axios.delete(url.toString(), { + headers, + }); - response.on('end', function () { - try { - HttpClient.checkStatusCode(response, responseData); - result(responseData); - } catch (error) { - reject(error); - } - }); + const data = response.data; + if (typeof data === 'string') { + return data; + } - response.on('error', error => reject(error)); - }) - .on('error', error => reject(error)) - .end(); - }); + return response.statusText; } /** @@ -196,110 +103,42 @@ export class HttpClient { const port = Number(temp.port ? temp.port : temp.protocol === 'http:' ? 80 : 443); const socket = net.createConnection(port, temp.hostname); socket.setTimeout(3000); - socket.on('connect', () => { - socket.end(); - }); - - socket.on('end', () => { - socket.destroy(); - resolve(); - }); - - socket.on('timeout', () => { - socket.destroy(); - reject(new Error(`${url} does not exist.`)); - }); - - socket.on('error', () => { - socket.destroy(); - reject(new Error(`${url} does not exist.`)); - }); - }); - } - - private postObject(url: URL, obj: object, headers: http.OutgoingHttpHeaders = {}): Promise { - return new Promise((result, reject) => { - const data = JSON.stringify(obj); - const options: http.RequestOptions = { - hostname: url.hostname, - port: url.port, - path: url.pathname + url.search, - method: 'POST', - headers: { - 'Content-Type': 'application/json', - 'Content-Length': Buffer.byteLength(data), - ...headers, - }, - }; - - const requester = url.protocol === 'https:' ? https.request : http.request; - const request = requester(options, response => { - let responseData = ''; - response.on('data', (chunk: string) => { - responseData += chunk; - }); - - response.on('end', () => { - try { - HttpClient.checkStatusCode(response, responseData); - result(responseData); - } catch (error) { - reject(error); - } + socket + .on('connect', () => { + socket.end(); + }) + .on('end', () => { + socket.destroy(); + resolve(); + }) + .on('timeout', () => { + socket.destroy(); + reject(new Error(`${url} does not exist.`)); + }) + .on('error', () => { + socket.destroy(); + reject(new Error(`${url} does not exist.`)); }); - - response.on('error', error => reject(error)); - }).on('error', error => reject(error)); - - request.write(data); - request.end(); }); } - private postFormData(url: URL, formData: FormData, headers: http.OutgoingHttpHeaders = {}): Promise { - return new Promise((result, reject) => { - const options: http.RequestOptions = { - hostname: url.hostname, - port: url.port, - path: url.pathname + url.search, - method: 'POST', - headers: { ...formData.getHeaders(), ...headers }, - }; - - const requester = url.protocol === 'https:' ? https.request : http.request; - const request = requester(options, response => { - let responseData = ''; - response.on('data', (chunk: string) => { - responseData += chunk; - }); - - response.on('end', function () { - try { - HttpClient.checkStatusCode(response, responseData); - result(responseData); - } catch (error) { - reject(error); - } - }); - - response.on('error', error => reject(error)); - }).on('error', error => reject(error)); + private async postObject(url: URL, obj: object, headers: Record | undefined): Promise { + const response = await axios.post(url.toString(), obj, { headers }); + const data = response.data; + if (typeof data === 'string') { + return data; + } - formData.pipe(request); - }); + return response.statusText; } - private static checkStatusCode(response: http.IncomingMessage, data?: string): void { - if (!response.statusCode) { - throw new Error(data ? `Unknown status code: ${data}` : 'Unknown status code.'); + private async postFormData(url: URL, formData: FormData, headers?: Record): Promise { + const response = await axios.post(url.toString(), formData, { headers }); + const data = response.data; + if (typeof data === 'string') { + return data; } - if (response.statusCode < 200 || response.statusCode >= 300) { - throw new Error( - data - ? `(${response.statusCode}) ${response.statusMessage}: ${data}` - : `(${response.statusCode}) ${response.statusMessage}.`, - ); - } + return response.statusText; } } diff --git a/projects/aas-server/src/app/packages/aas-resource.ts b/projects/aas-server/src/app/packages/aas-resource.ts index f1b4f6bf..381eb6bc 100644 --- a/projects/aas-server/src/app/packages/aas-resource.ts +++ b/projects/aas-server/src/app/packages/aas-resource.ts @@ -100,7 +100,14 @@ export abstract class AASResource { * @param url The URL. * @returns A new URL. */ - protected resolve(url: string): URL { - return new URL(url, this.endpoint.url); + protected resolve(url: string, searchParams?: Record): URL { + const resolvedUrl = new URL(url, this.endpoint.url); + if (searchParams) { + for (const name in searchParams) { + resolvedUrl.searchParams.set(name, String(searchParams[name])); + } + } + + return resolvedUrl; } } diff --git a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v0.ts b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v0.ts index 997bd2f0..72cec3ca 100644 --- a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v0.ts +++ b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v0.ts @@ -6,13 +6,14 @@ * *****************************************************************************/ -import { aas, AASEndpoint, DifferenceItem, selectSubmodel } from 'aas-core'; +import { aas, AASEndpoint, DifferenceItem, noop, selectSubmodel } from 'aas-core'; import { Logger } from '../../logging/logger.js'; import { JsonReaderV2 } from '../json-reader-v2.js'; import { AASApiClient } from './aas-api-client.js'; import { JsonWriterV2 } from '../json-writer-v2.js'; import * as aasV2 from '../../types/aas-v2.js'; import { HttpClient } from '../../http-client.js'; +import { PagedResult } from '../../types/paged-result.js'; interface AASList { aaslist: string[]; @@ -29,9 +30,12 @@ export class AASApiClientV0 extends AASApiClient { public readonly onlineReady = true; - public async getShellsAsync(): Promise { + public async getShellsAsync(cursor?: string): Promise> { const value = await this.http.get(this.resolve('/server/listaas')); - return value.aaslist.map(item => item.split(' : ')[1].trim()); + + noop(cursor); + + return { result: value.aaslist.map(item => item.split(' : ')[1].trim()), paging_metadata: {} }; } public override async readEnvironmentAsync(id: string): Promise { diff --git a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v1.ts b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v1.ts index 82e97431..803cc8b7 100644 --- a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v1.ts +++ b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v1.ts @@ -17,6 +17,7 @@ import { isAssetAdministrationShell, isSubmodel, isSubmodelElement, + noop, selectSubmodel, } from 'aas-core'; @@ -29,6 +30,7 @@ import { JsonWriterV2 } from '../json-writer-v2.js'; import { ERRORS } from '../../errors.js'; import { JsonReaderV3 } from '../json-reader-v3.js'; import { HttpClient } from '../../http-client.js'; +import { PagedResult } from '../../types/paged-result.js'; interface PackageDescriptor { aasIds: string[]; @@ -71,13 +73,15 @@ export class AASApiClientV1 extends AASApiClient { public readonly onlineReady = true; - public async getShellsAsync(): Promise { + public async getShellsAsync(cursor?: string): Promise> { const result = await this.http.get( this.resolve('shells'), this.endpoint.headers, ); - return result.map(shell => shell.identification.id); + noop(cursor); + + return { result: result.map(shell => shell.identification.id), paging_metadata: {} }; } public async readEnvironmentAsync(id: string): Promise { diff --git a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts index 8252d4f2..04801c21 100644 --- a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts +++ b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts @@ -9,12 +9,6 @@ import FormData from 'form-data'; import cloneDeep from 'lodash-es/cloneDeep.js'; import { createReadStream } from 'fs'; -import { encodeBase64Url } from '../../convert.js'; -import { AASApiClient } from './aas-api-client.js'; -import { Logger } from '../../logging/logger.js'; -import { JsonReaderV3 } from '../json-reader-v3.js'; -import { JsonWriterV3 } from '../json-writer-v3.js'; -import { ERRORS } from '../../errors.js'; import { aas, AASEndpoint, @@ -26,7 +20,15 @@ import { isSubmodelElement, selectSubmodel, } from 'aas-core'; + +import { encodeBase64Url } from '../../convert.js'; +import { AASApiClient } from './aas-api-client.js'; +import { Logger } from '../../logging/logger.js'; +import { JsonReaderV3 } from '../json-reader-v3.js'; +import { JsonWriterV3 } from '../json-writer-v3.js'; +import { ERRORS } from '../../errors.js'; import { HttpClient } from '../../http-client.js'; +import { PagedResult } from '../../types/paged-result.js'; interface PackageDescriptor { aasIds: string[]; @@ -55,15 +57,6 @@ export interface OperationResult { inoutputVariables?: aas.OperationVariable[]; } -interface PagedResultPagingMetadata { - cursor?: string; -} - -interface PagedResult { - result: T[]; - paging_metadata: PagedResultPagingMetadata; -} - export class AASApiClientV3 extends AASApiClient { public constructor(logger: Logger, http: HttpClient, endpoint: AASEndpoint) { super(logger, http, endpoint); @@ -75,13 +68,21 @@ export class AASApiClientV3 extends AASApiClient { public readonly onlineReady = true; - public async getShellsAsync(): Promise { + public async getShellsAsync(cursor?: string): Promise> { + const searchParams: Record = { limit: 10 }; + if (cursor) { + searchParams.cursor = cursor; + } + const result = await this.http.get>( - this.resolve('shells'), + this.resolve('shells', searchParams), this.endpoint.headers, ); - return result.result.map(shell => shell.id); + return { + result: result.result.map(shell => shell.id), + paging_metadata: { cursor: result.paging_metadata.cursor }, + }; } public async readEnvironmentAsync(id: string): Promise { @@ -91,42 +92,34 @@ export class AASApiClientV3 extends AASApiClient { this.endpoint.headers, ); - const submodels: aas.Submodel[] = []; - if (shell.submodels) { - for (const reference of shell.submodels) { - const submodelId = encodeBase64Url(reference.keys[0].value); - try { - submodels.push( - await this.http.get( - this.resolve(`shells/${aasId}/submodels/${submodelId}`), - this.endpoint.headers, - ), - ); - } catch (error) { - this.logger.error(`Unable to read Submodel "${reference.keys[0].value}": ${error?.message}`); - } + const env: aas.Environment = { + assetAdministrationShells: [shell], + submodels: await this.readSubmodels(aasId, shell.submodels), + conceptDescriptions: [], + }; + + return new JsonReaderV3(env).readEnvironment(); + } + + public async readConceptDescriptionsAsync(): Promise { + const conceptDescriptions: aas.ConceptDescription[] = []; + let cursor: string | undefined; + const searchParams: Record = { limit: 100 }; + do { + if (cursor) { + searchParams.cursor = cursor; } - } - let conceptDescriptions: aas.ConceptDescription[]; - try { const pagedResult = await this.http.get>( this.resolve(`concept-descriptions`), this.endpoint.headers, ); - conceptDescriptions = pagedResult.result; - } catch { - conceptDescriptions = []; - } + conceptDescriptions.push(...pagedResult.result); + cursor = pagedResult.paging_metadata.cursor; + } while (cursor); - const sourceEnv: aas.Environment = { - assetAdministrationShells: [shell], - submodels, - conceptDescriptions, - }; - - return new JsonReaderV3(sourceEnv).readEnvironment(); + return conceptDescriptions; } public override getThumbnailAsync(id: string): Promise { @@ -181,10 +174,11 @@ export class AASApiClientV3 extends AASApiClient { return messages; } - public async openFileAsync(_: aas.AssetAdministrationShell, file: aas.File): Promise { + public async openFileAsync(shell: aas.AssetAdministrationShell, file: aas.File): Promise { + const aasId = encodeBase64Url(shell.id); const smId = encodeBase64Url(file.parent!.keys[0].value); const path = getIdShortPath(file); - const url = this.resolve(`submodels/${smId}/submodel-elements/${path}/attachment`); + const url = this.resolve(`shells/${aasId}/submodels/${smId}/submodel-elements/${path}/attachment`); return await this.http.getResponse(url, this.endpoint.headers); } @@ -278,6 +272,29 @@ export class AASApiClientV3 extends AASApiClient { return blob.value; } + private async readSubmodels(aasId: string, submodelRefs: aas.Reference[] | undefined): Promise { + const submodels: aas.Submodel[] = []; + if (submodelRefs === undefined) { + return submodels; + } + + for (const reference of submodelRefs) { + const smId = encodeBase64Url(reference.keys[0].value); + try { + submodels.push( + await this.http.get( + this.resolve(`shells/${aasId}/submodels/${smId}`), + this.endpoint.headers, + ), + ); + } catch (error) { + this.logger.error(`Unable to read Submodel "${reference.keys[0].value}": ${error?.message}`); + } + } + + return submodels; + } + private async putShellAsync(shell: aas.AssetAdministrationShell): Promise { const aasId = encodeBase64Url(shell.id); return await this.http.put(this.resolve(`shells/${aasId}`), new JsonWriterV3().convert(shell)); diff --git a/projects/aas-server/src/app/packages/aas-server/aas-api-client.ts b/projects/aas-server/src/app/packages/aas-server/aas-api-client.ts index 5645a83a..203e60e7 100644 --- a/projects/aas-server/src/app/packages/aas-server/aas-api-client.ts +++ b/projects/aas-server/src/app/packages/aas-server/aas-api-client.ts @@ -15,6 +15,7 @@ import { AASPackage } from '../aas-package.js'; import { AASResource } from '../aas-resource.js'; import { AASServerPackage } from './aas-server-package.js'; import { SocketSubscription } from '../../live/socket-subscription.js'; +import { PagedResult } from '../../types/paged-result.js'; interface PropertyValue { value: string; @@ -91,7 +92,7 @@ export abstract class AASApiClient extends AASResource { * Gets the names of the Asset Administration Shells contained in the current AASX server. * @returns The names of the AASs contained in the current AASX server. */ - public abstract getShellsAsync(): Promise; + public abstract getShellsAsync(cursor?: string): Promise>; /** * ToDo diff --git a/projects/aas-server/src/app/packages/file-system/aasx-directory.ts b/projects/aas-server/src/app/packages/file-system/aasx-directory.ts index 69b63e6d..823ccb6a 100644 --- a/projects/aas-server/src/app/packages/file-system/aasx-directory.ts +++ b/projects/aas-server/src/app/packages/file-system/aasx-directory.ts @@ -6,7 +6,7 @@ * *****************************************************************************/ -import { aas, AASEndpoint, ApplicationError } from 'aas-core'; +import { aas, AASEndpoint, ApplicationError, noop } from 'aas-core'; import { extname, join } from 'path/posix'; import { readFile } from 'fs/promises'; import { ERRORS } from '../../errors.js'; @@ -16,6 +16,7 @@ import { AASPackage } from '../aas-package.js'; import { AASResource } from '../aas-resource.js'; import { AasxPackage } from './aasx-package.js'; import { SocketSubscription } from '../../live/socket-subscription.js'; +import { PagedResult } from '../../types/paged-result.js'; export class AasxDirectory extends AASResource { private readonly root: string; @@ -46,10 +47,11 @@ export class AasxDirectory extends AASResource { return this.fileStorage.readFile(join(this.root, name)); } - public async getFiles(): Promise { + public async getFiles(cursor?: string): Promise> { + noop(cursor); const files: string[] = []; await this.readDirAsync(this.root, '', files); - return files; + return { result: files, paging_metadata: {} }; } public async testAsync(): Promise { diff --git a/projects/aas-server/src/app/template/template-storage.ts b/projects/aas-server/src/app/template/template-storage.ts index a9eb9e5c..2ef64b83 100644 --- a/projects/aas-server/src/app/template/template-storage.ts +++ b/projects/aas-server/src/app/template/template-storage.ts @@ -81,7 +81,7 @@ export class TemplateStorage { taskId, }; - this.taskHandler.set(taskId, { name: 'TemplateStorage', owner: this, type: 'ScanTemplates' }); + this.taskHandler.set(taskId, { endpointName: 'TemplateStorage', owner: this, type: 'ScanTemplates' }); this.parallel.execute(data); }; @@ -127,7 +127,7 @@ export class TemplateStorage { setTimeout(this.scanTemplates, this.timeout, result.taskId); if (result.messages) { - this.logger.start(`scan ${task?.name ?? 'undefined'}`); + this.logger.start(`scan ${task?.endpointName ?? 'undefined'}`); result.messages.forEach(message => this.logger.log(message)); this.logger.stop(); } diff --git a/projects/aas-server/src/app/types/paged-result.ts b/projects/aas-server/src/app/types/paged-result.ts new file mode 100644 index 00000000..91f4808a --- /dev/null +++ b/projects/aas-server/src/app/types/paged-result.ts @@ -0,0 +1,16 @@ +/****************************************************************************** + * + * Copyright (c) 2019-2024 Fraunhofer IOSB-INA Lemgo, + * eine rechtlich nicht selbstaendige Einrichtung der Fraunhofer-Gesellschaft + * zur Foerderung der angewandten Forschung e.V. + * + *****************************************************************************/ + +export interface PagedResultPagingMetadata { + cursor?: string; +} + +export interface PagedResult { + result: T[]; + paging_metadata: PagedResultPagingMetadata; +} diff --git a/projects/aas-server/src/app/worker-app.ts b/projects/aas-server/src/app/worker-app.ts index d2d68985..366b743e 100644 --- a/projects/aas-server/src/app/worker-app.ts +++ b/projects/aas-server/src/app/worker-app.ts @@ -9,17 +9,23 @@ import { inject, singleton } from 'tsyringe'; import { parentPort } from 'worker_threads'; import { Logger } from './logging/logger.js'; -import { WorkerData, isScanContainerData, isScanTemplatesData } from './aas-provider/worker-data.js'; -import { ScanResult, ScanResultType } from './aas-provider/scan-result.js'; +import { ScanNextPageResult, ScanResult, ScanResultType } from './aas-provider/scan-result.js'; import { toUint8Array } from './convert.js'; -import { ScanContainer } from './scan-container.js'; +import { EndpointScan } from './endpoint-scan.js'; import { TemplateScan } from './template/template-scan.js'; +import { + ScanEndpointData, + ScanTemplatesData, + WorkerData, + isScanEndpointData, + isScanTemplatesData, +} from './aas-provider/worker-data.js'; @singleton() export class WorkerApp { public constructor( @inject('Logger') private readonly logger: Logger, - @inject(ScanContainer) private readonly scanContainer: ScanContainer, + @inject(EndpointScan) private readonly endpointScan: EndpointScan, @inject(TemplateScan) private readonly templateScan: TemplateScan, ) {} @@ -28,16 +34,29 @@ export class WorkerApp { } private parentPortOnMessage = async (data: WorkerData) => { + if (parentPort === null) { + return; + } + try { this.logger.start(`Scan ${data.taskId}`); - if (isScanContainerData(data)) { - await this.scanContainer.scanAsync(data); + let result: ScanResult; + + if (isScanEndpointData(data)) { + result = await this.scanEndpoint(data); } else if (isScanTemplatesData(data)) { - await this.templateScan.scanAsync(data); + result = await this.scanTemplates(data); + } else { + result = { + taskId: data.taskId, + type: ScanResultType.End, + messages: this.logger.getMessages(), + }; } + + parentPort.postMessage(toUint8Array(result)); } catch (error) { this.logger.error(error); - } finally { this.logger.stop(); const result: ScanResult = { taskId: data.taskId, @@ -45,7 +64,38 @@ export class WorkerApp { messages: this.logger.getMessages(), }; - parentPort?.postMessage(toUint8Array(result)); + parentPort.postMessage(toUint8Array(result)); } }; + + private async scanEndpoint(data: ScanEndpointData): Promise { + const cursor = await this.endpointScan.scanAsync(data); + this.logger.stop(); + + if (cursor) { + return { + taskId: data.taskId, + type: ScanResultType.NextPage, + cursor, + messages: this.logger.getMessages(), + } as ScanNextPageResult; + } + + return { + taskId: data.taskId, + type: ScanResultType.End, + messages: this.logger.getMessages(), + } as ScanResult; + } + + private async scanTemplates(data: ScanTemplatesData): Promise { + await this.templateScan.scanAsync(data); + this.logger.stop(); + + return { + taskId: data.taskId, + type: ScanResultType.End, + messages: this.logger.getMessages(), + } as ScanResult; + } } diff --git a/projects/aas-server/src/test/aas-index/lowdb/lowdb-index.spec.ts b/projects/aas-server/src/test/aas-index/lowdb/lowdb-index.spec.ts index 5d25d9b1..732aed54 100644 --- a/projects/aas-server/src/test/aas-index/lowdb/lowdb-index.spec.ts +++ b/projects/aas-server/src/test/aas-index/lowdb/lowdb-index.spec.ts @@ -44,8 +44,8 @@ describe('LowDbIndex', () => { describe('getContainerDocuments', () => { it('returns all documents that belongs to a container', async () => { - const array = await index.getContainerDocuments('Samples'); - expect(array).toEqual(db.data.documents.filter(document => document.endpoint === 'Samples')); + const result = await index.nextPage('Samples', undefined); + expect(result.result).toEqual(db.data.documents.filter(document => document.endpoint === 'Samples')); }); }); diff --git a/projects/aas-server/src/test/packages/aas-server/aasx-package.spec.ts b/projects/aas-server/src/test/packages/aas-server/aasx-package.spec.ts index 361b73b2..1e13df72 100644 --- a/projects/aas-server/src/test/packages/aas-server/aasx-package.spec.ts +++ b/projects/aas-server/src/test/packages/aas-server/aasx-package.spec.ts @@ -22,7 +22,11 @@ describe('AasxPackage', function () { beforeEach(function () { logger = createSpyObj(['error', 'warning', 'info', 'debug', 'start', 'stop']); fileStorage = new LocalFileStorage('file:///samples', './src/test/assets/'); - source = new AasxDirectory(logger, fileStorage, 'file:///samples', 'Samples'); + source = new AasxDirectory(logger, fileStorage, { + url: 'file:///samples', + name: 'Samples', + type: 'FileSystem', + }); }); describe('createDocumentAsync', function () { diff --git a/projects/aas-server/src/test/packages/opcua/opcua-client.spec.ts b/projects/aas-server/src/test/packages/opcua/opcua-client.spec.ts index b3c2ecc6..b425ba34 100644 --- a/projects/aas-server/src/test/packages/opcua/opcua-client.spec.ts +++ b/projects/aas-server/src/test/packages/opcua/opcua-client.spec.ts @@ -23,7 +23,11 @@ describe('OpcuaClient', function () { beforeEach(function () { logger = createSpyObj(['error', 'warning', 'info', 'debug', 'start', 'stop']); - server = new OpcuaClient(logger, 'opc.tcp://localhost:1234/I4AASServer', 'OPCUA Server'); + server = new OpcuaClient(logger, { + url: 'opc.tcp://localhost:1234/I4AASServer', + name: 'OPCUA Server', + type: 'OPC_UA', + }); }); afterEach(() => { @@ -167,6 +171,7 @@ describe('OpcuaClient', function () { return new Promise(resolve => resolve(result)); }; + // eslint-disable-next-line @typescript-eslint/no-explicit-any session.call.mockImplementation(call as any); const operation: aas.Operation = { idShort: 'add', @@ -208,6 +213,7 @@ describe('OpcuaClient', function () { return new Promise(resolve => resolve(result)); }; + // eslint-disable-next-line @typescript-eslint/no-explicit-any session.call.mockImplementation(call as any); const operation: aas.Operation = { idShort: 'add', diff --git a/projects/aas-server/tsoa.json b/projects/aas-server/tsoa.json index 85b383fe..9e4e81aa 100644 --- a/projects/aas-server/tsoa.json +++ b/projects/aas-server/tsoa.json @@ -1,6 +1,6 @@ { "entryFile": "src/app/aas-server.ts", - "noImplicitAdditionalProperties": "silently-remove-extras", + "noImplicitAdditionalProperties": "ignore", "controllerPathGlobs": [ "src/app/controller/**/*controller.ts" ], From 98c11f347b9fff479caa774015791eff0a88a02d Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Wed, 23 Oct 2024 07:08:03 +0200 Subject: [PATCH 05/76] in progress... --- .../src/app/aas-provider/aas-provider.ts | 66 +++++++------------ .../src/app/aas-provider/aas-resource-scan.ts | 4 +- .../src/app/aas-provider/aas-server-scan.ts | 16 +++-- .../src/app/aas-provider/directory-scan.ts | 5 +- .../src/app/aas-provider/opcua-server-scan.ts | 8 +-- .../src/app/aas-provider/scan-result.ts | 8 --- .../src/app/aas-provider/worker-data.ts | 4 +- projects/aas-server/src/app/endpoint-scan.ts | 46 ++++--------- projects/aas-server/src/app/worker-app.ts | 62 +++-------------- 9 files changed, 62 insertions(+), 157 deletions(-) diff --git a/projects/aas-server/src/app/aas-provider/aas-provider.ts b/projects/aas-server/src/app/aas-provider/aas-provider.ts index b8f4e33e..314c214c 100644 --- a/projects/aas-server/src/app/aas-provider/aas-provider.ts +++ b/projects/aas-server/src/app/aas-provider/aas-provider.ts @@ -26,7 +26,7 @@ import { import { ImageProcessing } from '../image-processing.js'; import { AASIndex } from '../aas-index/aas-index.js'; -import { ScanResultType, ScanResult, ScanEndpointResult, ScanNextPageResult } from './scan-result.js'; +import { ScanResultType, ScanResult, ScanEndpointResult } from './scan-result.js'; import { Logger } from '../logging/logger.js'; import { Parallel } from './parallel.js'; import { ScanEndpointData } from './worker-data.js'; @@ -61,7 +61,6 @@ export class AASProvider { this.timeout = variable.SCAN_CONTAINER_TIMEOUT; this.parallel.on('message', this.parallelOnMessage); this.parallel.on('end', this.parallelOnEnd); - this.parallel.on('nextPage', this.parallelOnNextPage); } /** @@ -471,25 +470,41 @@ export class AASProvider { } }; + private notify(data: AASServerMessage): void { + this.wsServer.notify('IndexChange', { + type: 'AASServerMessage', + data: data, + }); + } + private scanEndpoint = async (taskId: number, endpoint: AASEndpoint) => { - const result = await this.index.nextPage(endpoint.name, undefined); const data: ScanEndpointData = { type: 'ScanEndpointData', taskId, endpoint, - documents: result.result, }; this.taskHandler.set(taskId, { endpointName: endpoint.name, owner: this, type: 'ScanEndpoint' }); this.parallel.execute(data); }; - private notify(data: AASServerMessage): void { - this.wsServer.notify('IndexChange', { - type: 'AASServerMessage', - data: data, - }); - } + private parallelOnMessage = async (result: ScanEndpointResult) => { + try { + switch (result.type) { + case ScanResultType.Changed: + await this.onChanged(result); + break; + case ScanResultType.Added: + await this.onAdded(result); + break; + case ScanResultType.Removed: + await this.onRemoved(result); + break; + } + } catch (error) { + this.logger.error(error); + } + }; private parallelOnEnd = async (result: ScanResult) => { const task = this.taskHandler.get(result.taskId); @@ -514,37 +529,6 @@ export class AASProvider { } }; - private parallelOnMessage = async (result: ScanEndpointResult) => { - try { - switch (result.type) { - case ScanResultType.Changed: - await this.onChanged(result); - break; - case ScanResultType.Added: - await this.onAdded(result); - break; - case ScanResultType.Removed: - await this.onRemoved(result); - break; - } - } catch (error) { - this.logger.error(error); - } - }; - - private parallelOnNextPage = async (result: ScanNextPageResult, worker: Worker) => { - const a = await this.index.nextPage(result.endpoint.name, result.cursor); - const data: ScanEndpointData = { - type: 'ScanEndpointData', - taskId: result.taskId, - endpoint: result.endpoint, - documents: a.result, - cursor: a.paging_metadata.cursor, - }; - - worker.postMessage(data); - }; - private async onChanged(result: ScanEndpointResult): Promise { const document = result.document; if ((await this.index.hasEndpoint(document.endpoint)) === false) { diff --git a/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts b/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts index 23be2d98..75b08f89 100644 --- a/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts +++ b/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts @@ -7,8 +7,6 @@ *****************************************************************************/ import EventEmitter from 'events'; -import { AASDocument } from 'aas-core'; -import { PagedResult } from '../types/paged-result.js'; /** Defines an automate to scan an AAS resource for Asset Administration Shells. */ export abstract class AASResourceScan extends EventEmitter { @@ -16,5 +14,5 @@ export abstract class AASResourceScan extends EventEmitter { * Gets all documents of the current container. * @param cursor ToDo. * */ - public abstract scanAsync(cursor?: string): Promise>; + public abstract scanAsync(): Promise; } diff --git a/projects/aas-server/src/app/aas-provider/aas-server-scan.ts b/projects/aas-server/src/app/aas-provider/aas-server-scan.ts index 5fc28902..e73321ed 100644 --- a/projects/aas-server/src/app/aas-provider/aas-server-scan.ts +++ b/projects/aas-server/src/app/aas-provider/aas-server-scan.ts @@ -11,12 +11,13 @@ import { Logger } from '../logging/logger.js'; import { AASApiClient } from '../packages/aas-server/aas-api-client.js'; import { AASServerPackage } from '../packages/aas-server/aas-server-package.js'; import { AASResourceScan } from './aas-resource-scan.js'; -import { PagedResult } from '../types/paged-result.js'; export class AASServerScan extends AASResourceScan { private readonly logger: Logger; private readonly server: AASApiClient; + private static set = new Set(); + public constructor(logger: Logger, server: AASApiClient) { super(); @@ -24,13 +25,20 @@ export class AASServerScan extends AASResourceScan { this.server = server; } - public async scanAsync(cursor?: string): Promise> { + public async scanAsync(): Promise { try { await this.server.openAsync(); + const documents: AASDocument[] = []; - const result = await this.server.getShellsAsync(cursor); + const result = await this.server.getShellsAsync(); const ids = new Set(result.result); for (const id of ids) { + if (AASServerScan.set.has(id)) { + AASServerScan.set.delete(id); + } else { + AASServerScan.set.add(id); + } + try { const aasPackage = new AASServerPackage(this.logger, this.server, id); const document = await aasPackage.createDocumentAsync(); @@ -40,8 +48,6 @@ export class AASServerScan extends AASResourceScan { this.emit('error', error, this.server, id); } } - - return { result: documents, paging_metadata: { cursor: result.paging_metadata.cursor } }; } finally { await this.server.closeAsync(); } diff --git a/projects/aas-server/src/app/aas-provider/directory-scan.ts b/projects/aas-server/src/app/aas-provider/directory-scan.ts index e3ffddbd..8f943705 100644 --- a/projects/aas-server/src/app/aas-provider/directory-scan.ts +++ b/projects/aas-server/src/app/aas-provider/directory-scan.ts @@ -11,7 +11,6 @@ import { Logger } from '../logging/logger.js'; import { AasxPackage } from '../packages/file-system/aasx-package.js'; import { AasxDirectory } from '../packages/file-system/aasx-directory.js'; import { AASResourceScan } from './aas-resource-scan.js'; -import { PagedResult } from '../types/paged-result.js'; export class DirectoryScan extends AASResourceScan { public constructor( @@ -21,7 +20,7 @@ export class DirectoryScan extends AASResourceScan { super(); } - public async scanAsync(cursor?: string): Promise> { + public async scanAsync(): Promise { try { await this.source.openAsync(); const result = await this.source.getFiles(cursor); @@ -36,8 +35,6 @@ export class DirectoryScan extends AASResourceScan { this.emit('error', error, this.source, file); } } - - return { result: documents, paging_metadata: { cursor: result.paging_metadata.cursor } }; } finally { await this.source.closeAsync(); } diff --git a/projects/aas-server/src/app/aas-provider/opcua-server-scan.ts b/projects/aas-server/src/app/aas-provider/opcua-server-scan.ts index 0c405de6..a7056dc5 100644 --- a/projects/aas-server/src/app/aas-provider/opcua-server-scan.ts +++ b/projects/aas-server/src/app/aas-provider/opcua-server-scan.ts @@ -7,13 +7,12 @@ *****************************************************************************/ import { AttributeIds, BrowseDescriptionLike, QualifiedName, ReferenceDescription } from 'node-opcua'; -import { AASDocument, noop } from 'aas-core'; +import { AASDocument } from 'aas-core'; import { Logger } from '../logging/logger.js'; import { OpcuaDataTypeDictionary } from '../packages/opcua/opcua-data-type-dictionary.js'; import { OpcuaClient } from '../packages/opcua/opcua-client.js'; import { OpcuaPackage } from '../packages/opcua/opcua-package.js'; import { AASResourceScan } from './aas-resource-scan.js'; -import { PagedResult } from '../types/paged-result.js'; export class OpcuaServerScan extends AASResourceScan { private readonly logger: Logger; @@ -26,9 +25,8 @@ export class OpcuaServerScan extends AASResourceScan { this.server = server; } - public async scanAsync(cursor?: string): Promise> { + public async scanAsync(): Promise { try { - noop(cursor); await this.server.openAsync(); const documents: AASDocument[] = []; const dataTypes = new OpcuaDataTypeDictionary(); @@ -44,8 +42,6 @@ export class OpcuaServerScan extends AASResourceScan { this.emit('error', error, this.server, nodeId); } } - - return { result: documents, paging_metadata: {} }; } finally { await this.server.closeAsync(); } diff --git a/projects/aas-server/src/app/aas-provider/scan-result.ts b/projects/aas-server/src/app/aas-provider/scan-result.ts index ce2262ed..495fb645 100644 --- a/projects/aas-server/src/app/aas-provider/scan-result.ts +++ b/projects/aas-server/src/app/aas-provider/scan-result.ts @@ -30,8 +30,6 @@ export interface ScanResult { /** The result of an endpoint scan. */ export interface ScanEndpointResult extends ScanResult { endpoint: AASEndpoint; - documents: AASDocument[]; - cursor?: string; document: AASDocument; } @@ -39,9 +37,3 @@ export interface ScanEndpointResult extends ScanResult { export interface ScanTemplatesResult extends ScanResult { templates: TemplateDescriptor[]; } - -/** The result for a next page request. */ -export interface ScanNextPageResult extends ScanResult { - endpoint: AASEndpoint; - cursor: string; -} diff --git a/projects/aas-server/src/app/aas-provider/worker-data.ts b/projects/aas-server/src/app/aas-provider/worker-data.ts index c34b749f..47bff72f 100644 --- a/projects/aas-server/src/app/aas-provider/worker-data.ts +++ b/projects/aas-server/src/app/aas-provider/worker-data.ts @@ -6,7 +6,7 @@ * *****************************************************************************/ -import { AASDocument, AASEndpoint } from 'aas-core'; +import { AASEndpoint } from 'aas-core'; export interface WorkerData { taskId: number; @@ -16,8 +16,6 @@ export interface WorkerData { export interface ScanEndpointData extends WorkerData { type: 'ScanEndpointData'; endpoint: AASEndpoint; - documents: AASDocument[]; - cursor?: string; } export interface ScanTemplatesData extends WorkerData { diff --git a/projects/aas-server/src/app/endpoint-scan.ts b/projects/aas-server/src/app/endpoint-scan.ts index a2b1ca52..0e763d09 100644 --- a/projects/aas-server/src/app/endpoint-scan.ts +++ b/projects/aas-server/src/app/endpoint-scan.ts @@ -26,42 +26,26 @@ export class EndpointScan { @inject(Variable) private readonly variable: Variable, ) {} - public async scanAsync(data: ScanEndpointData): Promise { + public async scanAsync(data: ScanEndpointData): Promise { this.data = data; const scan = this.resourceScanFactory.create(data.endpoint); try { - scan.on('scanned', this.onDocumentScanned); + scan.on('compare', this.compare); + scan.on('removed', this.removed); scan.on('error', this.onError); - const result = await scan.scanAsync(data.cursor); - this.computeDeleted(result.result); + const result = await scan.scanAsync(data); + // this.computeDeleted(result.result); return result.paging_metadata.cursor; } finally { - scan.off('scanned', this.onDocumentScanned); + scan.off('compare', this.compare); + scan.off('removed', this.removed); scan.off('error', this.onError); } } - private computeDeleted(documents: AASDocument[]): void { - if (this.data.documents === undefined) { - return; - } - - const current = new Map(documents.map(item => [item.id, item])); - for (const document of this.data.documents) { - if (!current.has(document.id)) { - this.postDeleted(document); - } - } - } - - private onDocumentScanned = (document: AASDocument): void => { - const reference = this.data.documents?.find(item => item.id === document.id); - if (reference) { - if (this.documentChanged(document, reference)) { - this.postChanged(document); - } - } else { - this.postAdded(document); + private compare = (reference: AASDocument, document: AASDocument): void => { + if (this.documentChanged(document, reference)) { + this.postChanged(document); } }; @@ -74,8 +58,6 @@ export class EndpointScan { taskId: this.data.taskId, type: ScanResultType.Changed, endpoint: this.data.endpoint, - documents: this.data.documents, - cursor: this.data.cursor, document: document, }; @@ -83,27 +65,23 @@ export class EndpointScan { parentPort?.postMessage(array, [array.buffer]); } - private postDeleted(document: AASDocument): void { + private removed = (document: AASDocument): void => { const value: ScanEndpointResult = { taskId: this.data.taskId, type: ScanResultType.Removed, endpoint: this.data.endpoint, - documents: this.data.documents, - cursor: this.data.cursor, document: document, }; const array = toUint8Array(value); parentPort?.postMessage(array, [array.buffer]); - } + }; private postAdded(document: AASDocument): void { const value: ScanEndpointResult = { taskId: this.data.taskId, type: ScanResultType.Added, endpoint: this.data.endpoint, - documents: this.data.documents, - cursor: this.data.cursor, document: document, }; diff --git a/projects/aas-server/src/app/worker-app.ts b/projects/aas-server/src/app/worker-app.ts index 366b743e..17e6c201 100644 --- a/projects/aas-server/src/app/worker-app.ts +++ b/projects/aas-server/src/app/worker-app.ts @@ -9,17 +9,11 @@ import { inject, singleton } from 'tsyringe'; import { parentPort } from 'worker_threads'; import { Logger } from './logging/logger.js'; -import { ScanNextPageResult, ScanResult, ScanResultType } from './aas-provider/scan-result.js'; +import { ScanResult, ScanResultType } from './aas-provider/scan-result.js'; import { toUint8Array } from './convert.js'; import { EndpointScan } from './endpoint-scan.js'; import { TemplateScan } from './template/template-scan.js'; -import { - ScanEndpointData, - ScanTemplatesData, - WorkerData, - isScanEndpointData, - isScanTemplatesData, -} from './aas-provider/worker-data.js'; +import { WorkerData, isScanEndpointData, isScanTemplatesData } from './aas-provider/worker-data.js'; @singleton() export class WorkerApp { @@ -40,62 +34,24 @@ export class WorkerApp { try { this.logger.start(`Scan ${data.taskId}`); - let result: ScanResult; - if (isScanEndpointData(data)) { - result = await this.scanEndpoint(data); + await this.endpointScan.scanAsync(data); } else if (isScanTemplatesData(data)) { - result = await this.scanTemplates(data); - } else { - result = { - taskId: data.taskId, - type: ScanResultType.End, - messages: this.logger.getMessages(), - }; + await this.templateScan.scanAsync(data); } - - parentPort.postMessage(toUint8Array(result)); } catch (error) { this.logger.error(error); + } finally { this.logger.stop(); - const result: ScanResult = { - taskId: data.taskId, - type: ScanResultType.End, - messages: this.logger.getMessages(), - }; - - parentPort.postMessage(toUint8Array(result)); + parentPort.postMessage(toUint8Array(this.createEndResult)); } }; - private async scanEndpoint(data: ScanEndpointData): Promise { - const cursor = await this.endpointScan.scanAsync(data); - this.logger.stop(); - - if (cursor) { - return { - taskId: data.taskId, - type: ScanResultType.NextPage, - cursor, - messages: this.logger.getMessages(), - } as ScanNextPageResult; - } - - return { - taskId: data.taskId, - type: ScanResultType.End, - messages: this.logger.getMessages(), - } as ScanResult; - } - - private async scanTemplates(data: ScanTemplatesData): Promise { - await this.templateScan.scanAsync(data); - this.logger.stop(); - + private createEndResult(taskId: number): ScanResult { return { - taskId: data.taskId, + taskId: taskId, type: ScanResultType.End, messages: this.logger.getMessages(), - } as ScanResult; + }; } } From 6a5ccd5b24d4a72931fb98dfb455ad89ebce9ea7 Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Wed, 23 Oct 2024 16:47:55 +0200 Subject: [PATCH 06/76] in progress... --- projects/aas-core/src/lib/server-message.ts | 2 +- .../aas-lib/src/lib/index-change.service.ts | 6 +- .../src/app/aas-provider/aas-provider.ts | 40 ++++---- .../src/app/aas-provider/aas-resource-scan.ts | 93 ++++++++++++++++++- .../src/app/aas-provider/aas-server-scan.ts | 41 +++----- .../src/app/aas-provider/directory-scan.ts | 47 ++++++---- .../src/app/aas-provider/opcua-server-scan.ts | 53 +++++++---- .../src/app/aas-provider/parallel.ts | 8 -- .../src/app/aas-provider/scan-result.ts | 6 +- .../aas-server/src/app/aas-scan-worker.ts | 2 + projects/aas-server/src/app/endpoint-scan.ts | 28 +++--- 11 files changed, 214 insertions(+), 112 deletions(-) diff --git a/projects/aas-core/src/lib/server-message.ts b/projects/aas-core/src/lib/server-message.ts index 5e31ce8c..76eaa8e5 100644 --- a/projects/aas-core/src/lib/server-message.ts +++ b/projects/aas-core/src/lib/server-message.ts @@ -12,7 +12,7 @@ import { AASDocument, AASEndpoint } from './types.js'; export type AASServerMessageType = | 'Added' | 'Removed' - | 'Changed' + | 'Update' | 'Offline' | 'EndpointAdded' | 'EndpointRemoved' diff --git a/projects/aas-lib/src/lib/index-change.service.ts b/projects/aas-lib/src/lib/index-change.service.ts index e88124fd..d0c67221 100644 --- a/projects/aas-lib/src/lib/index-change.service.ts +++ b/projects/aas-lib/src/lib/index-change.service.ts @@ -105,8 +105,8 @@ export class IndexChangeService { case 'Removed': this.documentRemoved(); break; - case 'Changed': - this.documentChanged(); + case 'Update': + this.documentUpdate(); break; case 'EndpointAdded': this.endpointAdded(); @@ -128,7 +128,7 @@ export class IndexChangeService { this.state.update(state => ({ ...state, removedDocuments: state.removedDocuments + 1 })); } - private documentChanged(): void { + private documentUpdate(): void { this.state.update(state => ({ ...state, changedDocuments: state.changedDocuments + 1 })); } diff --git a/projects/aas-server/src/app/aas-provider/aas-provider.ts b/projects/aas-server/src/app/aas-provider/aas-provider.ts index 314c214c..77efebaa 100644 --- a/projects/aas-server/src/app/aas-provider/aas-provider.ts +++ b/projects/aas-server/src/app/aas-provider/aas-provider.ts @@ -22,6 +22,7 @@ import { ApplicationError, getChildren, isReferenceElement, + noop, } from 'aas-core'; import { ImageProcessing } from '../image-processing.js'; @@ -374,12 +375,13 @@ export class AASProvider { /** Only used for test. */ public async scanAsync(factory: AASResourceScanFactory): Promise { - for (const endpoint of await this.index.getEndpoints()) { - if (endpoint.type === 'FileSystem') { - const result = await factory.create(endpoint).scanAsync(); - result.result.forEach(async document => await this.index.add(document)); - } - } + noop(factory); + // for (const endpoint of await this.index.getEndpoints()) { + // if (endpoint.type === 'FileSystem') { + // const result = await factory.create(endpoint).scanAsync(); + // result.result.forEach(async document => await this.index.add(document)); + // } + // } } /** @@ -460,6 +462,13 @@ export class AASProvider { return resource.createSubscription(client, message, env); } + private notify(data: AASServerMessage): void { + this.wsServer.notify('IndexChange', { + type: 'AASServerMessage', + data: data, + }); + } + private startScan = async (): Promise => { try { for (const endpoint of await this.index.getEndpoints()) { @@ -470,13 +479,6 @@ export class AASProvider { } }; - private notify(data: AASServerMessage): void { - this.wsServer.notify('IndexChange', { - type: 'AASServerMessage', - data: data, - }); - } - private scanEndpoint = async (taskId: number, endpoint: AASEndpoint) => { const data: ScanEndpointData = { type: 'ScanEndpointData', @@ -491,13 +493,13 @@ export class AASProvider { private parallelOnMessage = async (result: ScanEndpointResult) => { try { switch (result.type) { - case ScanResultType.Changed: - await this.onChanged(result); + case ScanResultType.Update: + await this.onUpdate(result); break; - case ScanResultType.Added: + case ScanResultType.Add: await this.onAdded(result); break; - case ScanResultType.Removed: + case ScanResultType.Remove: await this.onRemoved(result); break; } @@ -529,7 +531,7 @@ export class AASProvider { } }; - private async onChanged(result: ScanEndpointResult): Promise { + private async onUpdate(result: ScanEndpointResult): Promise { const document = result.document; if ((await this.index.hasEndpoint(document.endpoint)) === false) { return; @@ -540,7 +542,7 @@ export class AASProvider { this.cache.set(document.endpoint, document.id, document.content); } - this.sendMessage({ type: 'Changed', document: { ...document, content: null } }); + this.sendMessage({ type: 'Update', document: { ...document, content: null } }); } private async onAdded(result: ScanEndpointResult): Promise { diff --git a/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts b/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts index 75b08f89..abdb72e5 100644 --- a/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts +++ b/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts @@ -7,12 +7,101 @@ *****************************************************************************/ import EventEmitter from 'events'; +import { AASDocument, AASEndpoint } from 'aas-core'; +import { AASIndex } from '../aas-index/aas-index.js'; +import { PagedResult } from '../types/paged-result.js'; /** Defines an automate to scan an AAS resource for Asset Administration Shells. */ export abstract class AASResourceScan extends EventEmitter { /** * Gets all documents of the current container. - * @param cursor ToDo. + * @param index The AAS index. + * @param endpoint The endpoint. * */ - public abstract scanAsync(): Promise; + public async scanAsync(index: AASIndex, endpoint: AASEndpoint): Promise { + try { + await this.open(); + + const map = new Map(); + let indexCursor: string | undefined; + let endpointCursor: string | undefined; + let a = true; + let b = true; + do { + if (a) { + const result = await index.nextPage(endpoint.name, indexCursor); + for (const reference of result.result) { + let value = map.get(reference.id); + if (value === undefined) { + value = { reference }; + map.set(reference.id, value); + } else if (value.reference === undefined) { + value.reference = reference; + } + } + + indexCursor = result.paging_metadata.cursor; + if (indexCursor === undefined) { + a = false; + } + } + + if (b) { + const result = await this.nextEndpointPage(endpointCursor); + for (const id of result.result) { + let value = map.get(id); + if (value === undefined) { + value = {}; + map.set(id, value); + } + + if (value.document === undefined) { + value.document = await this.createDocument(id); + } + } + + endpointCursor = result.paging_metadata.cursor; + if (endpointCursor === undefined) { + b = false; + } + } + + const keys: string[] = []; + for (const value of map.values()) { + if (value.reference && value.document) { + keys.push(value.reference.id); + this.emit('compare', value.reference, value.document); + } else if (!a && value.document) { + keys.push(value.document.id); + this.emit('add', value.document); + } else if (!b && value.reference) { + keys.push(value.reference.id); + this.emit('remove', value.document); + } + } + + keys.forEach(key => map.delete(key)); + } while (a || b); + + for (const value of map.values()) { + if (value.reference && value.document) { + this.emit('compare', value.reference, value.document); + } else if (!a && value.document) { + this.emit('add', value.document); + } else if (!b && value.reference) { + this.emit('remove', value.document); + } + } + } finally { + await this.close(); + } + } + + protected abstract open(): Promise; + + protected abstract close(): Promise; + + protected abstract createDocument(id: string): Promise; + + protected abstract nextEndpointPage(cursor: string | undefined): Promise>; } diff --git a/projects/aas-server/src/app/aas-provider/aas-server-scan.ts b/projects/aas-server/src/app/aas-provider/aas-server-scan.ts index e73321ed..cbdce44d 100644 --- a/projects/aas-server/src/app/aas-provider/aas-server-scan.ts +++ b/projects/aas-server/src/app/aas-provider/aas-server-scan.ts @@ -11,13 +11,12 @@ import { Logger } from '../logging/logger.js'; import { AASApiClient } from '../packages/aas-server/aas-api-client.js'; import { AASServerPackage } from '../packages/aas-server/aas-server-package.js'; import { AASResourceScan } from './aas-resource-scan.js'; +import { PagedResult } from '../types/paged-result.js'; export class AASServerScan extends AASResourceScan { private readonly logger: Logger; private readonly server: AASApiClient; - private static set = new Set(); - public constructor(logger: Logger, server: AASApiClient) { super(); @@ -25,31 +24,19 @@ export class AASServerScan extends AASResourceScan { this.server = server; } - public async scanAsync(): Promise { - try { - await this.server.openAsync(); + protected override open(): Promise { + return this.server.openAsync(); + } + protected override close(): Promise { + return this.server.closeAsync(); + } + + protected override createDocument(id: string): Promise { + const aasPackage = new AASServerPackage(this.logger, this.server, id); + return aasPackage.createDocumentAsync(); + } - const documents: AASDocument[] = []; - const result = await this.server.getShellsAsync(); - const ids = new Set(result.result); - for (const id of ids) { - if (AASServerScan.set.has(id)) { - AASServerScan.set.delete(id); - } else { - AASServerScan.set.add(id); - } - - try { - const aasPackage = new AASServerPackage(this.logger, this.server, id); - const document = await aasPackage.createDocumentAsync(); - documents.push(document); - this.emit('scanned', document); - } catch (error) { - this.emit('error', error, this.server, id); - } - } - } finally { - await this.server.closeAsync(); - } + protected override nextEndpointPage(cursor: string | undefined): Promise> { + return this.server.getShellsAsync(cursor); } } diff --git a/projects/aas-server/src/app/aas-provider/directory-scan.ts b/projects/aas-server/src/app/aas-provider/directory-scan.ts index 8f943705..81468a2b 100644 --- a/projects/aas-server/src/app/aas-provider/directory-scan.ts +++ b/projects/aas-server/src/app/aas-provider/directory-scan.ts @@ -11,8 +11,11 @@ import { Logger } from '../logging/logger.js'; import { AasxPackage } from '../packages/file-system/aasx-package.js'; import { AasxDirectory } from '../packages/file-system/aasx-directory.js'; import { AASResourceScan } from './aas-resource-scan.js'; +import { PagedResult } from '../types/paged-result.js'; export class DirectoryScan extends AASResourceScan { + private readonly map = new Map(); + public constructor( private readonly logger: Logger, private readonly source: AasxDirectory, @@ -20,23 +23,35 @@ export class DirectoryScan extends AASResourceScan { super(); } - public async scanAsync(): Promise { - try { - await this.source.openAsync(); - const result = await this.source.getFiles(cursor); - const documents: AASDocument[] = []; - for (const file of result.result) { - try { - const aasxPackage = new AasxPackage(this.logger, this.source, file); - const document = await aasxPackage.createDocumentAsync(); - documents.push(document); - this.emit('scanned', document); - } catch (error) { - this.emit('error', error, this.source, file); - } + protected override open(): Promise { + this.map.clear(); + return this.source.openAsync(); + } + + protected override close(): Promise { + this.map.clear(); + return this.source.closeAsync(); + } + + protected override createDocument(id: string): Promise { + const document = this.map.get(id); + return document ? Promise.resolve(document) : Promise.reject(new Error(`${id} not found.`)); + } + + protected override async nextEndpointPage(cursor: string | undefined): Promise> { + const result = await this.source.getFiles(cursor); + const ids: string[] = []; + for (const file of result.result) { + try { + const aasxPackage = new AasxPackage(this.logger, this.source, file); + const document = await aasxPackage.createDocumentAsync(); + ids.push(document.id); + this.map.set(document.id, document); + } catch (error) { + this.emit('error', error, this.source, file); } - } finally { - await this.source.closeAsync(); } + + return { result: ids, paging_metadata: {} }; } } diff --git a/projects/aas-server/src/app/aas-provider/opcua-server-scan.ts b/projects/aas-server/src/app/aas-provider/opcua-server-scan.ts index a7056dc5..f1726dc5 100644 --- a/projects/aas-server/src/app/aas-provider/opcua-server-scan.ts +++ b/projects/aas-server/src/app/aas-provider/opcua-server-scan.ts @@ -7,16 +7,18 @@ *****************************************************************************/ import { AttributeIds, BrowseDescriptionLike, QualifiedName, ReferenceDescription } from 'node-opcua'; -import { AASDocument } from 'aas-core'; +import { AASDocument, noop } from 'aas-core'; import { Logger } from '../logging/logger.js'; import { OpcuaDataTypeDictionary } from '../packages/opcua/opcua-data-type-dictionary.js'; import { OpcuaClient } from '../packages/opcua/opcua-client.js'; import { OpcuaPackage } from '../packages/opcua/opcua-package.js'; import { AASResourceScan } from './aas-resource-scan.js'; +import { PagedResult } from '../types/paged-result.js'; export class OpcuaServerScan extends AASResourceScan { private readonly logger: Logger; private readonly server: OpcuaClient; + private readonly map = new Map(); public constructor(logger: Logger, server: OpcuaClient) { super(); @@ -25,26 +27,39 @@ export class OpcuaServerScan extends AASResourceScan { this.server = server; } - public async scanAsync(): Promise { - try { - await this.server.openAsync(); - const documents: AASDocument[] = []; - const dataTypes = new OpcuaDataTypeDictionary(); - await dataTypes.initializeAsync(this.server.getSession()); - for (const description of await this.browseAsync('ObjectsFolder')) { - const nodeId = description.nodeId.toString(); - try { - const opcuaPackage = new OpcuaPackage(this.logger, this.server, nodeId, dataTypes); - const document = await opcuaPackage.createDocumentAsync(); - documents.push(document); - this.emit('scanned', document); - } catch (error) { - this.emit('error', error, this.server, nodeId); - } + protected override open(): Promise { + this.map.clear(); + return this.server.openAsync(); + } + + protected override close(): Promise { + this.map.clear(); + return this.server.closeAsync(); + } + + protected override createDocument(id: string): Promise { + const document = this.map.get(id); + return document ? Promise.resolve(document) : Promise.reject(new Error(`${id} not found.`)); + } + + protected override async nextEndpointPage(cursor: string | undefined): Promise> { + noop(cursor); + const ids: string[] = []; + const dataTypes = new OpcuaDataTypeDictionary(); + await dataTypes.initializeAsync(this.server.getSession()); + for (const description of await this.browseAsync('ObjectsFolder')) { + const nodeId = description.nodeId.toString(); + try { + const opcuaPackage = new OpcuaPackage(this.logger, this.server, nodeId, dataTypes); + const document = await opcuaPackage.createDocumentAsync(); + ids.push(document.id); + this.map.set(document.id, document); + } catch (error) { + this.emit('error', error, this.server, nodeId); } - } finally { - await this.server.closeAsync(); } + + return { result: ids, paging_metadata: {} }; } private async browseAsync( diff --git a/projects/aas-server/src/app/aas-provider/parallel.ts b/projects/aas-server/src/app/aas-provider/parallel.ts index f10a9660..eefa940a 100644 --- a/projects/aas-server/src/app/aas-provider/parallel.ts +++ b/projects/aas-server/src/app/aas-provider/parallel.ts @@ -57,9 +57,6 @@ class WorkerTask extends EventEmitter { case ScanResultType.End: this.emit('end', result, this); break; - case ScanResultType.NextPage: - this.emit('nextPage', result, this); - break; default: this.emit('message', result); break; @@ -101,7 +98,6 @@ export class Parallel extends EventEmitter { public execute(data: WorkerData): void { const task = new WorkerTask(data); task.on('message', this.taskOnMessage); - task.on('nextPage', this.taskOnNextPage); task.on('end', this.taskOnEnd); task.on('error', this.taskOnError); @@ -134,10 +130,6 @@ export class Parallel extends EventEmitter { this.emit('message', result); }; - private taskOnNextPage = (result: ScanResult, task: WorkerTask) => { - this.emit('nextPage', result, task.worker); - }; - private taskOnEnd = (result: ScanResult, task: WorkerTask) => { this.emit('end', result); diff --git a/projects/aas-server/src/app/aas-provider/scan-result.ts b/projects/aas-server/src/app/aas-provider/scan-result.ts index 495fb645..11a81827 100644 --- a/projects/aas-server/src/app/aas-provider/scan-result.ts +++ b/projects/aas-server/src/app/aas-provider/scan-result.ts @@ -9,11 +9,9 @@ import { AASDocument, Message, TemplateDescriptor, AASEndpoint } from 'aas-core'; export enum ScanResultType { - Added, - Removed, - Changed, + Add, + Remove, Update, - NextPage, End, } diff --git a/projects/aas-server/src/app/aas-scan-worker.ts b/projects/aas-server/src/app/aas-scan-worker.ts index 4b70cb5a..91807ce5 100644 --- a/projects/aas-server/src/app/aas-scan-worker.ts +++ b/projects/aas-server/src/app/aas-scan-worker.ts @@ -10,8 +10,10 @@ import 'reflect-metadata'; import { MemoryLogger, MemoryLoggerLevel } from './logging/memory-logger.js'; import { container } from 'tsyringe'; import { WorkerApp } from './worker-app.js'; +import { AASIndexFactory } from './aas-index/aas-index-factory.js'; container.register('Logger', MemoryLogger); +container.register('AASIndex', { useFactory: c => new AASIndexFactory(c).create() }); container.registerInstance( 'LOG_LEVEL', process.env.NODE_ENV === 'production' ? MemoryLoggerLevel.Error : MemoryLoggerLevel.All, diff --git a/projects/aas-server/src/app/endpoint-scan.ts b/projects/aas-server/src/app/endpoint-scan.ts index 0e763d09..611582ca 100644 --- a/projects/aas-server/src/app/endpoint-scan.ts +++ b/projects/aas-server/src/app/endpoint-scan.ts @@ -15,6 +15,7 @@ import { ScanEndpointResult, ScanResultType } from './aas-provider/scan-result.j import { toUint8Array } from './convert.js'; import { AASResourceScanFactory } from './aas-provider/aas-resource-scan-factory.js'; import { Variable } from './variable.js'; +import { AASIndex } from './aas-index/aas-index.js'; @singleton() export class EndpointScan { @@ -22,6 +23,7 @@ export class EndpointScan { public constructor( @inject('Logger') private readonly logger: Logger, + @inject('AASIndex') private readonly index: AASIndex, @inject(AASResourceScanFactory) private readonly resourceScanFactory: AASResourceScanFactory, @inject(Variable) private readonly variable: Variable, ) {} @@ -31,21 +33,21 @@ export class EndpointScan { const scan = this.resourceScanFactory.create(data.endpoint); try { scan.on('compare', this.compare); - scan.on('removed', this.removed); + scan.on('remove', this.postRemove); + scan.on('add', this.postAdd); scan.on('error', this.onError); - const result = await scan.scanAsync(data); - // this.computeDeleted(result.result); - return result.paging_metadata.cursor; + await scan.scanAsync(this.index, data.endpoint); } finally { scan.off('compare', this.compare); - scan.off('removed', this.removed); + scan.off('remove', this.postRemove); + scan.off('add', this.postAdd); scan.off('error', this.onError); } } private compare = (reference: AASDocument, document: AASDocument): void => { if (this.documentChanged(document, reference)) { - this.postChanged(document); + this.postUpdate(document); } }; @@ -53,10 +55,10 @@ export class EndpointScan { this.logger.error(error); }; - private postChanged(document: AASDocument): void { + private postUpdate(document: AASDocument): void { const value: ScanEndpointResult = { taskId: this.data.taskId, - type: ScanResultType.Changed, + type: ScanResultType.Update, endpoint: this.data.endpoint, document: document, }; @@ -65,10 +67,10 @@ export class EndpointScan { parentPort?.postMessage(array, [array.buffer]); } - private removed = (document: AASDocument): void => { + private postRemove = (document: AASDocument): void => { const value: ScanEndpointResult = { taskId: this.data.taskId, - type: ScanResultType.Removed, + type: ScanResultType.Remove, endpoint: this.data.endpoint, document: document, }; @@ -77,17 +79,17 @@ export class EndpointScan { parentPort?.postMessage(array, [array.buffer]); }; - private postAdded(document: AASDocument): void { + private postAdd = (document: AASDocument): void => { const value: ScanEndpointResult = { taskId: this.data.taskId, - type: ScanResultType.Added, + type: ScanResultType.Add, endpoint: this.data.endpoint, document: document, }; const array = toUint8Array(value); parentPort?.postMessage(array, [array.buffer]); - } + }; private documentChanged(document: AASDocument, reference: AASDocument): boolean { if ( From cafb6e5bfff25803cf803b0b6821283872662608 Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Sat, 26 Oct 2024 14:21:34 +0200 Subject: [PATCH 07/76] fix: reading PxC API --- .vscode/launch.json | 2 +- .vscode/tasks.json | 2 +- projects/aas-core/src/lib/aas.ts | 2 +- .../add-endpoint-form.component.html | 72 ++++++++++-------- .../add-endpoint-form.component.ts | 41 +++++++--- .../aas-portal/src/assets/i18n/de-de.json | 3 +- .../aas-portal/src/assets/i18n/en-us.json | 3 +- .../start/add-endpoint-form.component.spec.ts | 19 +++-- .../src/app/aas-index/aas-index-factory.ts | 6 +- .../aas-server/src/app/aas-index/aas-index.ts | 36 ++++++++- .../src/app/aas-index/keyword-directory.ts | 75 +++++++++++++++++++ .../src/app/aas-index/lowdb/lowdb-index.ts | 6 +- .../src/app/aas-index/mysql/mysql-index.ts | 39 +++++++--- .../src/app/aas-provider/aas-resource-scan.ts | 23 +++--- .../packages/aas-server/aas-api-client-v3.ts | 2 +- .../src/app/packages/json-reader-v2.ts | 4 +- .../src/app/packages/json-reader-v3.ts | 2 +- .../src/app/packages/json-writer-v3.ts | 2 +- .../src/app/packages/xml-writer-v3.ts | 2 +- projects/aas-server/src/app/worker-app.ts | 2 +- projects/aas-server/src/assets/keywords.json | 8 ++ .../test/aas-index/keyword-directory.spec.ts | 50 +++++++++++++ .../test/aas-index/lowdb/lowdb-index.spec.ts | 5 +- .../src/test/assets/aas-environment.ts | 38 +++++----- .../src/test/assets/aas-example.json | 38 +++++----- .../aas-server/src/test/assets/keywords.json | 6 ++ .../aas-server/src/test/http-client.spec.ts | 63 ++++------------ .../aas-server/aas-api-client-v0.spec.ts | 3 +- projects/aasportal-index/docker-compose.yml | 4 +- 29 files changed, 370 insertions(+), 188 deletions(-) create mode 100644 projects/aas-server/src/app/aas-index/keyword-directory.ts create mode 100644 projects/aas-server/src/assets/keywords.json create mode 100644 projects/aas-server/src/test/aas-index/keyword-directory.spec.ts create mode 100644 projects/aas-server/src/test/assets/keywords.json diff --git a/.vscode/launch.json b/.vscode/launch.json index ea5f119f..22ddce69 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -57,7 +57,7 @@ "name": "Test aas-portal", "type": "chrome", "request": "launch", - "preLaunchTask": "test", + "preLaunchTask": "test-aas-portal", "url": "http://localhost:9876/debug.html", }, { diff --git a/.vscode/tasks.json b/.vscode/tasks.json index 0234a9da..309bd082 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -23,7 +23,7 @@ }, { "type": "shell", - "label": "test", + "label": "test-aas-portal", "command": "npm", "args": ["run", "test", "-w", "aas-portal"], "isBackground": true, diff --git a/projects/aas-core/src/lib/aas.ts b/projects/aas-core/src/lib/aas.ts index a3703ea0..88257645 100644 --- a/projects/aas-core/src/lib/aas.ts +++ b/projects/aas-core/src/lib/aas.ts @@ -117,7 +117,7 @@ export type ModelType = | 'Blob' | 'Capability' | 'ConceptDescription' - | 'DataSpecificationIec61360' + | 'DataSpecificationIEC61360' | 'Entity' | 'File' | 'MultiLanguageProperty' diff --git a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html index 5a79fc55..a42af250 100644 --- a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html +++ b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html @@ -42,39 +42,45 @@

(input)="inputValue()">

@if (selectedItem().type === 'AAS_API') { -
- - - - - - - - - - @for (header of headers(); track header.id) { - - - @if (header === selectedHeader()) { - - - } @else { - - - } - } - -
#HeaderValue
{{header.id}} - - - - -
{{header.name}}
- 		-
{{header.value}}
-
+ +
+
+ + + + + + + + + + @for (header of headers(); track header.id) { + + + @if (header === selectedHeader()) { + + + } @else { + + + } + } + +
#HeaderValue
{{header.id}} + + + + +
{{header.name}}
+ 		+
{{header.value}}
+
+
}
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 index 4c555cf2..b2a17d78 100644 --- 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 @@ -8,7 +8,7 @@ import { ChangeDetectionStrategy, Component, computed, signal } from '@angular/core'; import { FormsModule } from '@angular/forms'; -import { NgbActiveModal, NgbDropdownModule, NgbToast } from '@ng-bootstrap/ng-bootstrap'; +import { NgbActiveModal, NgbCollapse, NgbDropdownModule, NgbToast } from '@ng-bootstrap/ng-bootstrap'; import { TranslateModule, TranslateService } from '@ngx-translate/core'; import { AASEndpoint, AASEndpointType, stringFormat } from 'aas-core'; @@ -29,7 +29,7 @@ export interface EndpointItem { templateUrl: './add-endpoint-form.component.html', styleUrls: ['./add-endpoint-form.component.scss'], standalone: true, - imports: [NgbToast, NgbDropdownModule, TranslateModule, FormsModule], + imports: [NgbToast, NgbDropdownModule, NgbCollapse, TranslateModule, FormsModule], changeDetection: ChangeDetectionStrategy.OnPush, }) export class AddEndpointFormComponent { @@ -60,11 +60,7 @@ export class AddEndpointFormComponent { ]); private readonly _selectedHeaderIndex = signal(-1); - private readonly _headers = signal([ - { id: '1', name: '', value: '' }, - { id: '2', name: '', value: '' }, - { id: '3', name: '', value: '' }, - ]); + private readonly _headers = signal([{ id: '1', name: '', value: '' }]); public constructor( private modal: NgbActiveModal, @@ -81,6 +77,8 @@ export class AddEndpointFormComponent { public readonly headers = this._headers.asReadonly(); + public readonly isCollapsed = signal(true); + public readonly selectedHeader = computed(() => this._selectedHeaderIndex() < 0 ? undefined : this._headers()[this._selectedHeaderIndex()], ); @@ -98,6 +96,7 @@ export class AddEndpointFormComponent { this._selectedHeaderIndex.update(state => { const index = this._headers().indexOf(value); if (state >= 0 && index === state) { + this.updateHeaders(); return -1; } @@ -192,7 +191,6 @@ export class AddEndpointFormComponent { return url; } catch (error) { this._messages.update(messages => [...messages, this.createMessage('ERROR_INVALID_URL', value)]); - return undefined; } } @@ -205,6 +203,10 @@ export class AddEndpointFormComponent { if (url.protocol !== 'http:' && url.protocol !== 'https:') { throw new Error('Protocol "http:" or "https:" expected.'); } + + if (!url.hostname) { + throw new Error('Empty host name.'); + } } private validateFileSystemEndpoint(url: URL): void { @@ -226,8 +228,8 @@ export class AddEndpointFormComponent { throw new Error('Protocol "opc.tcp:" expected.'); } - if (url.pathname === '//' || url.pathname === '/') { - throw new Error('Empty pathname.'); + if (!url.hostname) { + throw new Error('Empty host name.'); } } @@ -236,8 +238,23 @@ export class AddEndpointFormComponent { throw new Error('Protocol "http:" or "https:" expected.'); } - if (url.pathname === '/') { - throw new Error('Empty pathname.'); + if (!url.hostname) { + throw new Error('Empty host name.'); } } + + private updateHeaders(): void { + this._headers.update(state => { + let index = 1; + const items: HeaderItem[] = []; + for (const item of state) { + if (item.name || item.value) { + items.push({ ...item, id: String(index++) }); + } + } + + items.push({ id: String(index++), name: '', value: '' }); + return items; + }); + } } diff --git a/projects/aas-portal/src/assets/i18n/de-de.json b/projects/aas-portal/src/assets/i18n/de-de.json index a6429b7a..66ab259d 100644 --- a/projects/aas-portal/src/assets/i18n/de-de.json +++ b/projects/aas-portal/src/assets/i18n/de-de.json @@ -185,7 +185,8 @@ "PLACEHOLDER_URL_FILE": "file:///", "PLACEHOLDER_URL_HTTP": "http(s)://", "PLACEHOLDER_URL_OPCUA": "opc.tcp://", - "PLACEHOLDER_URL_WEBDAV": "http(s)://" + "PLACEHOLDER_URL_WEBDAV": "http(s)://", + "ADVANCED_SETTINGS": "Erweiterte Einstellungen" }, "CustomerFeedback": { "OverallRating": "Gesamtbewertung", diff --git a/projects/aas-portal/src/assets/i18n/en-us.json b/projects/aas-portal/src/assets/i18n/en-us.json index 2da15364..648c73a9 100644 --- a/projects/aas-portal/src/assets/i18n/en-us.json +++ b/projects/aas-portal/src/assets/i18n/en-us.json @@ -186,7 +186,8 @@ "PLACEHOLDER_URL_FILE": "file:///", "PLACEHOLDER_URL_HTTP": "http(s)://", "PLACEHOLDER_URL_OPCUA": "opc.tcp://", - "PLACEHOLDER_URL_WEBDAV": "http(s)://" + "PLACEHOLDER_URL_WEBDAV": "http(s)://", + "ADVANCED_SETTINGS": "Advanced settings" }, "CustomerFeedback": { "OverallRating": "Overall rating", diff --git a/projects/aas-portal/src/test/start/add-endpoint-form.component.spec.ts b/projects/aas-portal/src/test/start/add-endpoint-form.component.spec.ts index 3e39d753..7e5df61c 100644 --- a/projects/aas-portal/src/test/start/add-endpoint-form.component.spec.ts +++ b/projects/aas-portal/src/test/start/add-endpoint-form.component.spec.ts @@ -15,8 +15,6 @@ import { AddEndpointFormComponent } from '../../app/start/add-endpoint-form/add- describe('AddEndpointFormComponent', () => { let component: AddEndpointFormComponent; let fixture: ComponentFixture; - let inputNameElement: HTMLInputElement; - let inputUrlElement: HTMLInputElement; let modal: NgbActiveModal; let form: HTMLFormElement; @@ -39,8 +37,6 @@ describe('AddEndpointFormComponent', () => { fixture.detectChanges(); form = fixture.debugElement.nativeElement.querySelector('form'); - inputNameElement = fixture.debugElement.nativeElement.querySelector('#input-endpoint-name'); - inputUrlElement = fixture.debugElement.nativeElement.querySelector('#input-endpoint-url'); }); it('should create', () => { @@ -53,6 +49,7 @@ describe('AddEndpointFormComponent', () => { component.selectItem(component.items()[3]); component.name.set('My endpoint'); + component.selectedItem().value = 'file:///my-endpoint'; form.dispatchEvent(new Event('submit')); expect(modal.close).toHaveBeenCalled(); @@ -67,6 +64,7 @@ describe('AddEndpointFormComponent', () => { component.selectItem(component.items()[3]); component.name.set('My endpoint'); + component.selectedItem().value = 'file:///a\\b\\my-endpoint'; form.dispatchEvent(new Event('submit')); expect(modal.close).toHaveBeenCalled(); @@ -80,6 +78,7 @@ describe('AddEndpointFormComponent', () => { component.selectItem(component.items()[3]); component.name.set(''); + component.selectedItem().value = 'file:///my-endpoint'; form.dispatchEvent(new Event('submit')); expect(modal.close).toHaveBeenCalledTimes(0); @@ -91,6 +90,7 @@ describe('AddEndpointFormComponent', () => { component.selectItem(component.items()[3]); component.name.set('My endpoint'); + component.selectedItem().value = 'file:///'; form.dispatchEvent(new Event('submit')); expect(modal.close).toHaveBeenCalledTimes(0); @@ -103,6 +103,7 @@ describe('AddEndpointFormComponent', () => { component.selectItem(component.items()[1]); component.name.set('I4AAS Server'); + component.selectedItem().value = 'opc.tcp://localhost:30001/I4AASServer'; form.dispatchEvent(new Event('submit')); expect(modal.close).toHaveBeenCalled(); @@ -115,12 +116,8 @@ describe('AddEndpointFormComponent', () => { spyOn(modal, 'close'); component.selectItem(component.items()[1]); - fixture.detectChanges(); - - inputNameElement.value = 'I4AAS Server'; - inputNameElement.dispatchEvent(new Event('input')); - inputUrlElement.value = 'opc.tcp://'; - inputUrlElement.dispatchEvent(new Event('input')); + component.name.set('I4AAS Server'); + component.selectedItem().value = 'opc.tcp://'; form.dispatchEvent(new Event('submit')); expect(modal.close).toHaveBeenCalledTimes(0); @@ -133,6 +130,7 @@ describe('AddEndpointFormComponent', () => { component.selectItem(component.items()[0]); component.name.set('AASX Server'); + component.selectedItem().value = 'http://localhost:50001/'; form.dispatchEvent(new Event('submit')); expect(modal.close).toHaveBeenCalled(); @@ -147,6 +145,7 @@ describe('AddEndpointFormComponent', () => { component.selectItem(component.items()[2]); component.name.set('WebDAV Server'); + component.selectedItem().value = 'http://localhost:8080/root/folder'; form.dispatchEvent(new Event('submit')); expect(modal.close).toHaveBeenCalled(); diff --git a/projects/aas-server/src/app/aas-index/aas-index-factory.ts b/projects/aas-server/src/app/aas-index/aas-index-factory.ts index 2bf1cd7f..5ffa77ad 100644 --- a/projects/aas-server/src/app/aas-index/aas-index-factory.ts +++ b/projects/aas-server/src/app/aas-index/aas-index-factory.ts @@ -17,6 +17,7 @@ import { LowDbData } from './lowdb/lowdb-types.js'; import { MySqlIndex } from './mysql/mysql-index.js'; import { Logger } from '../logging/logger.js'; import { urlToString } from '../convert.js'; +import { KeywordDirectory } from './keyword-directory.js'; export class AASIndexFactory { public constructor(private readonly container: DependencyContainer) {} @@ -24,11 +25,12 @@ export class AASIndexFactory { public create(): AASIndex { const variable = this.container.resolve(Variable); const logger = this.container.resolve('Logger'); + const keywordDirectory = this.container.resolve(KeywordDirectory); if (variable.AAS_INDEX) { try { const url = new URL(variable.AAS_INDEX); if (url.protocol === 'mysql:') { - const index = new MySqlIndex(variable); + const index = new MySqlIndex(keywordDirectory, variable); logger.info(`AAS index connected to ${urlToString(url)}.`); return index; } @@ -41,7 +43,7 @@ export class AASIndexFactory { const dbFile = path.join(variable.CONTENT_ROOT, 'db.json'); const db = new Low(new JSONFile(dbFile), { documents: [], endpoints: [], elements: [] }); - const index = new LowDbIndex(db, variable); + const index = new LowDbIndex(db, keywordDirectory, variable); logger.info('Using internal AAS index.'); return index; } diff --git a/projects/aas-server/src/app/aas-index/aas-index.ts b/projects/aas-server/src/app/aas-index/aas-index.ts index a63a1b24..566f7500 100644 --- a/projects/aas-server/src/app/aas-index/aas-index.ts +++ b/projects/aas-server/src/app/aas-index/aas-index.ts @@ -21,8 +21,13 @@ import { } from 'aas-core'; import { PagedResult } from '../types/paged-result.js'; +import { KeywordDirectory } from './keyword-directory.js'; +import { LangString } from '../types/aas-v2.js'; +/** Represents an index of Asset Administration Shells. */ export abstract class AASIndex { + protected constructor(private readonly keywordDirectory: KeywordDirectory) {} + public abstract getCount(query?: string): Promise; public abstract getEndpoints(): Promise; @@ -68,18 +73,18 @@ export abstract class AASIndex { return getAbbreviation(referable.modelType)!.toLowerCase(); } - protected toStringValue(referable: aas.Referable): string | undefined { + protected toStringValue(referable: aas.Referable, max: number = 512): string | undefined { switch (referable.modelType) { case 'Property': { const property = referable as aas.Property; if (baseType(property.valueType) === 'string') { - return property.value; + return this.preprocessString(property.value, max); } return undefined; } case 'MultiLanguageProperty': - return (referable as aas.MultiLanguageProperty).value?.map(item => item.text).join(' '); + return this.preprocessString((referable as aas.MultiLanguageProperty).value); case 'File': return (referable as aas.File).value; case 'Blob': @@ -127,4 +132,29 @@ export abstract class AASIndex { return BigInt(referable.value); } + + private preprocessString(value: string | LangString[] | undefined, max: number = 512): string | undefined { + if (value === undefined) { + return undefined; + } + + if (typeof value === 'string') { + if (value.length < 128) { + return value; + } + + return this.keywordDirectory.toString(this.keywordDirectory.containedKeyword(value), ';', max); + } + + const keywords: string[] = []; + for (const item of value) { + if (item.text.length < 32) { + keywords.push(item.text); + } else { + keywords.push(...this.keywordDirectory.containedKeyword(item.text, item.language)); + } + } + + return this.keywordDirectory.toString(keywords, ';', max); + } } diff --git a/projects/aas-server/src/app/aas-index/keyword-directory.ts b/projects/aas-server/src/app/aas-index/keyword-directory.ts new file mode 100644 index 00000000..ec37ff9f --- /dev/null +++ b/projects/aas-server/src/app/aas-index/keyword-directory.ts @@ -0,0 +1,75 @@ +/****************************************************************************** + * + * Copyright (c) 2019-2024 Fraunhofer IOSB-INA Lemgo, + * eine rechtlich nicht selbstaendige Einrichtung der Fraunhofer-Gesellschaft + * zur Foerderung der angewandten Forschung e.V. + * + *****************************************************************************/ + +import fs from 'fs'; +import path from 'path'; +import { inject, singleton } from 'tsyringe'; +import { Variable } from '../variable.js'; +import { Logger } from '../logging/logger.js'; + +@singleton() +export class KeywordDirectory { + private directory: [string, string][] = []; + + public constructor( + @inject(Variable) private readonly variable: Variable, + @inject('Logger') private readonly logger: Logger, + ) { + const file = path.resolve(this.variable.ASSETS, 'keywords.json'); + if (!fs.existsSync(file)) { + this.wait = Promise.resolve(); + return; + } + + this.wait = fs.promises + .readFile(file) + .then(value => { + this.directory = JSON.parse(value.toString()); + this.directory.forEach((item, i, array) => { + array[i] = [item[0].toLocaleLowerCase(), item[1].toLocaleLowerCase()]; + }); + + this.logger.info(`Keyword directory loaded from ${file}`); + }) + .catch(error => this.logger.error(error)); + } + + public readonly wait: Promise; + + public containedKeyword(s: string, language?: string): string[] { + const result: string[] = []; + s = s.toLocaleLowerCase(); + for (const [keyword, lang] of this.directory) { + if (!lang || !language || lang === language) { + if (s.indexOf(keyword) >= 0) { + result.push(keyword); + } + } + } + + return result; + } + + public toString(keywords: string[], separator: string, max: number = 0): string { + if (keywords.length === 0) { + return ''; + } + + let s = keywords[0]; + for (let i = 1, n = keywords.length; i < n; i++) { + const keyword = keywords[i]; + if (max > 0 && s.length + separator.length + keyword.length >= max) { + break; + } + + s += separator + keyword; + } + + return s; + } +} diff --git a/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts b/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts index 4cdcf8ed..4d933b67 100644 --- a/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts +++ b/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts @@ -28,15 +28,17 @@ import { ERRORS } from '../../errors.js'; import { LowDbData, LowDbDocument, LowDbElement } from './lowdb-types.js'; import { decodeBase64Url, encodeBase64Url } from '../../convert.js'; import { PagedResult } from '../../types/paged-result.js'; +import { KeywordDirectory } from '../keyword-directory.js'; export class LowDbIndex extends AASIndex { private readonly promise: Promise; public constructor( private readonly db: Low, + keywordDirectory: KeywordDirectory, private readonly variable: Variable, ) { - super(); + super(keywordDirectory); this.promise = this.initialize(); } @@ -93,7 +95,7 @@ export class LowDbIndex extends AASIndex { public override async nextPage( endpointName: string, cursor: string | undefined, - limit: number = 10, + limit: number = 100, ): Promise> { await this.promise; diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts index 80dbd517..6bec9e2b 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts @@ -16,13 +16,16 @@ import { urlToEndpoint } from '../../configuration.js'; import { MySqlQuery } from './mysql-query.js'; import { DocumentCount, MySqlDocument, MySqlEndpoint } from './mysql-types.js'; import { PagedResult } from '../../types/paged-result.js'; -import { encodeBase64Url } from '../../convert.js'; +import { KeywordDirectory } from '../keyword-directory.js'; export class MySqlIndex extends AASIndex { private readonly connection: Promise; - public constructor(private readonly variable: Variable) { - super(); + public constructor( + keywordDirectory: KeywordDirectory, + private readonly variable: Variable, + ) { + super(keywordDirectory); this.connection = this.initialize(); } @@ -54,9 +57,22 @@ export class MySqlIndex extends AASIndex { throw new Error(`An endpoint with the name "${name}" does not exist.`); } - const endpoint = results[0]; + const result = results[0]; + const endpoint: AASEndpoint = { + name: result.name, + url: result.url, + type: result.type, + }; + + if (result.version) { + endpoint.version = result.version; + } + + if (result.headers) { + endpoint.headers = JSON.parse(result.headers); + } - return { name: endpoint.name, url: endpoint.url, type: endpoint.type, version: endpoint.version }; + return endpoint; } public override async hasEndpoint(name: string): Promise { @@ -126,20 +142,21 @@ export class MySqlIndex extends AASIndex { ): Promise> { const connection = await this.connection; let sql: string; - const values: unknown[] = [endpointName + cursor]; + const values: unknown[] = [endpointName]; if (cursor) { - values.push(limit + 1); - sql = 'SELECT * FROM `documents` WHERE CONCAT(endpoint, id) > ? ORDER BY endpoint ASC, id ASC LIMIT ?;'; + values.push(cursor); + sql = 'SELECT * FROM `documents` WHERE endpoint = ? AND id >= ? ORDER BY id ASC LIMIT ?;'; } else { - sql = 'SELECT * FROM `documents` ORDER BY endpoint ASC, id ASC LIMIT ?;'; + sql = 'SELECT * FROM `documents` WHERE endpoint = ? ORDER BY id ASC LIMIT ?;'; } + values.push(limit + 1); const [results] = await connection.query(sql, values); const documents = results.map(result => this.toDocument(result)); return { result: documents.slice(0, limit), paging_metadata: { - cursor: documents.length >= limit + 1 ? encodeBase64Url(documents[limit].id) : undefined, + cursor: documents.length >= limit + 1 ? documents[limit].id : undefined, }, }; } @@ -461,7 +478,7 @@ export class MySqlIndex extends AASIndex { this.toAbbreviation(referable), isIdentifiable(referable) ? referable.id : undefined, referable.idShort, - this.toStringValue(referable), + this.toStringValue(referable, 512), this.toNumberValue(referable), this.toDateValue(referable), this.toBooleanValue(referable), diff --git a/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts b/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts index abdb72e5..59c1fd97 100644 --- a/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts +++ b/projects/aas-server/src/app/aas-provider/aas-resource-scan.ts @@ -21,14 +21,13 @@ export abstract class AASResourceScan extends EventEmitter { public async scanAsync(index: AASIndex, endpoint: AASEndpoint): Promise { try { await this.open(); - const map = new Map(); let indexCursor: string | undefined; let endpointCursor: string | undefined; - let a = true; - let b = true; + let endOfIndex = false; + let endOfEndpoint = false; do { - if (a) { + if (!endOfIndex) { const result = await index.nextPage(endpoint.name, indexCursor); for (const reference of result.result) { let value = map.get(reference.id); @@ -42,11 +41,11 @@ export abstract class AASResourceScan extends EventEmitter { indexCursor = result.paging_metadata.cursor; if (indexCursor === undefined) { - a = false; + endOfIndex = true; } } - if (b) { + if (!endOfEndpoint) { const result = await this.nextEndpointPage(endpointCursor); for (const id of result.result) { let value = map.get(id); @@ -62,7 +61,7 @@ export abstract class AASResourceScan extends EventEmitter { endpointCursor = result.paging_metadata.cursor; if (endpointCursor === undefined) { - b = false; + endOfEndpoint = true; } } @@ -71,24 +70,24 @@ export abstract class AASResourceScan extends EventEmitter { if (value.reference && value.document) { keys.push(value.reference.id); this.emit('compare', value.reference, value.document); - } else if (!a && value.document) { + } else if (endOfIndex && value.document) { keys.push(value.document.id); this.emit('add', value.document); - } else if (!b && value.reference) { + } else if (endOfEndpoint && value.reference) { keys.push(value.reference.id); this.emit('remove', value.document); } } keys.forEach(key => map.delete(key)); - } while (a || b); + } while (!endOfIndex || !endOfEndpoint); for (const value of map.values()) { if (value.reference && value.document) { this.emit('compare', value.reference, value.document); - } else if (!a && value.document) { + } else if (value.document) { this.emit('add', value.document); - } else if (!b && value.reference) { + } else if (value.reference) { this.emit('remove', value.document); } } diff --git a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts index 04801c21..ab23a8a0 100644 --- a/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts +++ b/projects/aas-server/src/app/packages/aas-server/aas-api-client-v3.ts @@ -69,7 +69,7 @@ export class AASApiClientV3 extends AASApiClient { public readonly onlineReady = true; public async getShellsAsync(cursor?: string): Promise> { - const searchParams: Record = { limit: 10 }; + const searchParams: Record = { limit: 100 }; if (cursor) { searchParams.cursor = cursor; } diff --git a/projects/aas-server/src/app/packages/json-reader-v2.ts b/projects/aas-server/src/app/packages/json-reader-v2.ts index 18cd8e07..e41d890b 100644 --- a/projects/aas-server/src/app/packages/json-reader-v2.ts +++ b/projects/aas-server/src/app/packages/json-reader-v2.ts @@ -642,11 +642,11 @@ export class JsonReaderV2 extends AASReader { source: aasv2.DataSpecificationIec61360Content, ): aas.DataSpecificationIec61360 { if (!source.preferredName) { - throw new Error(`DataSpecificationIec61360.preferredName`); + throw new Error(`DataSpecificationIEC61360.preferredName`); } const iec61360: aas.DataSpecificationIec61360 = { - modelType: 'DataSpecificationIec61360', + modelType: 'DataSpecificationIEC61360', preferredName: this.readLangStringSet(source.preferredName), }; diff --git a/projects/aas-server/src/app/packages/json-reader-v3.ts b/projects/aas-server/src/app/packages/json-reader-v3.ts index 4a8f749d..cb0d4960 100644 --- a/projects/aas-server/src/app/packages/json-reader-v3.ts +++ b/projects/aas-server/src/app/packages/json-reader-v3.ts @@ -703,7 +703,7 @@ export class JsonReaderV3 extends AASReader { let dataSpecificationContent: aas.DataSpecificationContent; if ( !source.dataSpecificationContent.modelType || - source.dataSpecificationContent.modelType === 'DataSpecificationIec61360' + source.dataSpecificationContent.modelType === 'DataSpecificationIEC61360' ) { dataSpecificationContent = this.readDataSpecificationIEC61360( source.dataSpecificationContent as aas.DataSpecificationIec61360, diff --git a/projects/aas-server/src/app/packages/json-writer-v3.ts b/projects/aas-server/src/app/packages/json-writer-v3.ts index df882ebd..b8b68d7a 100644 --- a/projects/aas-server/src/app/packages/json-writer-v3.ts +++ b/projects/aas-server/src/app/packages/json-writer-v3.ts @@ -628,7 +628,7 @@ export class JsonWriterV3 extends AASWriter { } let dataSpecificationContent: aas.DataSpecificationContent; - if (source.dataSpecificationContent.modelType === 'DataSpecificationIec61360') { + if (source.dataSpecificationContent.modelType === 'DataSpecificationIEC61360') { dataSpecificationContent = this.writeDataSpecificationIEC61360( source.dataSpecificationContent as aas.DataSpecificationIec61360, ); diff --git a/projects/aas-server/src/app/packages/xml-writer-v3.ts b/projects/aas-server/src/app/packages/xml-writer-v3.ts index 370ed0b9..b987ffc2 100644 --- a/projects/aas-server/src/app/packages/xml-writer-v3.ts +++ b/projects/aas-server/src/app/packages/xml-writer-v3.ts @@ -177,7 +177,7 @@ export class XmlWriterV3 extends AASWriter { this.writeReference(embeddedDataSpecification.dataSpecification, this.appendChild(node, 'dataSpecification')); const contentNode = this.appendChild(node, 'dataSpecificationContent'); const content = embeddedDataSpecification.dataSpecificationContent; - if (content.modelType === 'DataSpecificationIec61360') { + if (content.modelType === 'DataSpecificationIEC61360') { this.writeDataSpecificationIec61360( content as aas.DataSpecificationIec61360, this.appendChild(contentNode, 'dataSpecificationIec61360'), diff --git a/projects/aas-server/src/app/worker-app.ts b/projects/aas-server/src/app/worker-app.ts index 17e6c201..3d88d42f 100644 --- a/projects/aas-server/src/app/worker-app.ts +++ b/projects/aas-server/src/app/worker-app.ts @@ -43,7 +43,7 @@ export class WorkerApp { this.logger.error(error); } finally { this.logger.stop(); - parentPort.postMessage(toUint8Array(this.createEndResult)); + parentPort.postMessage(toUint8Array(this.createEndResult(data.taskId))); } }; diff --git a/projects/aas-server/src/assets/keywords.json b/projects/aas-server/src/assets/keywords.json new file mode 100644 index 00000000..6dec3535 --- /dev/null +++ b/projects/aas-server/src/assets/keywords.json @@ -0,0 +1,8 @@ +[ + ["AAS", ""], + ["Asset Administration Shell", "en"], + ["Fraunhofer", ""], + ["Verwaltungsschale", "de"], + ["Phoenix Contact", ""], + ["Submodel", ""] +] \ No newline at end of file diff --git a/projects/aas-server/src/test/aas-index/keyword-directory.spec.ts b/projects/aas-server/src/test/aas-index/keyword-directory.spec.ts new file mode 100644 index 00000000..03f39ddd --- /dev/null +++ b/projects/aas-server/src/test/aas-index/keyword-directory.spec.ts @@ -0,0 +1,50 @@ +/****************************************************************************** + * + * Copyright (c) 2019-2024 Fraunhofer IOSB-INA Lemgo, + * eine rechtlich nicht selbstaendige Einrichtung der Fraunhofer-Gesellschaft + * zur Foerderung der angewandten Forschung e.V. + * + *****************************************************************************/ + +import 'reflect-metadata'; +import { createSpyObj } from 'fhg-jest'; +import { describe, beforeEach, it, expect, jest } from '@jest/globals'; +import { KeywordDirectory } from '../../app/aas-index/keyword-directory.js'; +import { Logger } from '../../app/logging/logger.js'; +import { Variable } from '../../app/variable.js'; + +describe('KeywordDirectory', () => { + let keywords: KeywordDirectory; + let logger: jest.Mocked; + let variable: jest.Mocked; + + beforeEach(async () => { + variable = createSpyObj({}, { ASSETS: './src/test/assets' }); + logger = createSpyObj(['error', 'info']); + keywords = new KeywordDirectory(variable, logger); + await keywords.wait; + }); + + it('should be created', function () { + expect(keywords).toBeTruthy(); + }); + + describe('containedKeyword', () => { + it('returns AAS and Submodel', () => { + expect(keywords.containedKeyword('This is an AAS with many submodels')).toEqual(['aas', 'submodel']); + }); + }); + + describe('toString', () => { + it('', () => { + const actual = keywords.toString( + ['keyword1', 'keyword2', 'keyword3', 'keyword4', 'keyword5', 'keyword6', 'keyword7', 'keyword8'], + ';', + 64, + ); + + expect(actual).toEqual('keyword1;keyword2;keyword3;keyword4;keyword5;keyword6;keyword7'); + expect(actual.length).toBeLessThanOrEqual(64); + }); + }); +}); diff --git a/projects/aas-server/src/test/aas-index/lowdb/lowdb-index.spec.ts b/projects/aas-server/src/test/aas-index/lowdb/lowdb-index.spec.ts index 732aed54..76990237 100644 --- a/projects/aas-server/src/test/aas-index/lowdb/lowdb-index.spec.ts +++ b/projects/aas-server/src/test/aas-index/lowdb/lowdb-index.spec.ts @@ -15,11 +15,13 @@ import { createSpyObj } from 'fhg-jest'; import { Variable } from '../../../app/variable.js'; import { LowDbIndex } from '../../../app/aas-index/lowdb/lowdb-index.js'; import { LowDbData } from '../../../app/aas-index/lowdb/lowdb-types.js'; +import { KeywordDirectory } from 'projects/aas-server/src/app/aas-index/keyword-directory.js'; describe('LowDbIndex', () => { let index: LowDbIndex; let db: jest.Mocked>; let variable: jest.Mocked; + let keywords: jest.Mocked; let dbData: LowDbData; beforeAll(async () => { @@ -35,7 +37,8 @@ describe('LowDbIndex', () => { db = createSpyObj>(['read', 'write'], { data: dbData }); db.read.mockResolvedValue(); variable = createSpyObj([], { ENDPOINTS: [] }); - index = new LowDbIndex(db, variable); + keywords = createSpyObj(['containedKeyword', 'toString']); + index = new LowDbIndex(db, keywords, variable); }); it('should create', () => { diff --git a/projects/aas-server/src/test/assets/aas-environment.ts b/projects/aas-server/src/test/assets/aas-environment.ts index 17512260..37db3c69 100644 --- a/projects/aas-server/src/test/assets/aas-environment.ts +++ b/projects/aas-server/src/test/assets/aas-environment.ts @@ -693,7 +693,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [], "dataType": "ENTITY", "definition": [ @@ -730,7 +730,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [], "dataType": "STRING", "definition": [ @@ -765,7 +765,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [], "dataType": "STRING", "definition": [ @@ -800,7 +800,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [], "dataType": "STRING_TRANSLATABLE", "definition": [ @@ -835,7 +835,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "EN", @@ -879,7 +879,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "DE", @@ -923,7 +923,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "DE", @@ -978,7 +978,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "DE", @@ -1017,7 +1017,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "EN", @@ -1061,7 +1061,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "EN", @@ -1105,7 +1105,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [], "dataType": "DATE", "definition": [ @@ -1140,7 +1140,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [], "dataType": "STRING", "definition": [ @@ -1175,7 +1175,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [], "dataType": "FILE", "definition": [ @@ -1210,7 +1210,7 @@ export default { "keys": [] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "de", @@ -1265,7 +1265,7 @@ export default { "keys": [] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "EN", @@ -1315,7 +1315,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "DE", @@ -1370,7 +1370,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [], "dataType": "REAL_MEASURE", "definition": [ @@ -1415,7 +1415,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "DE", @@ -1459,7 +1459,7 @@ export default { ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "EN", diff --git a/projects/aas-server/src/test/assets/aas-example.json b/projects/aas-server/src/test/assets/aas-example.json index e81b21d6..900943ce 100644 --- a/projects/aas-server/src/test/assets/aas-example.json +++ b/projects/aas-server/src/test/assets/aas-example.json @@ -467,7 +467,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [], "dataType": "ENTITY", "definition": [ @@ -504,7 +504,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [], "dataType": "STRING", "definition": [ @@ -539,7 +539,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [], "dataType": "STRING", "definition": [ @@ -574,7 +574,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [], "dataType": "STRING_TRANSLATABLE", "definition": [ @@ -609,7 +609,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "EN", @@ -653,7 +653,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "DE", @@ -697,7 +697,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "DE", @@ -752,7 +752,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "DE", @@ -791,7 +791,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "EN", @@ -835,7 +835,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "EN", @@ -879,7 +879,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [], "dataType": "DATE", "definition": [ @@ -914,7 +914,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [], "dataType": "STRING", "definition": [ @@ -949,7 +949,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [], "dataType": "FILE", "definition": [ @@ -984,7 +984,7 @@ "keys": [] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "de", @@ -1039,7 +1039,7 @@ "keys": [] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "EN", @@ -1089,7 +1089,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "DE", @@ -1144,7 +1144,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [], "dataType": "REAL_MEASURE", "definition": [ @@ -1189,7 +1189,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "DE", @@ -1233,7 +1233,7 @@ ] }, "dataSpecificationContent": { - "modelType": "DataSpecificationIec61360", + "modelType": "DataSpecificationIEC61360", "preferredName": [ { "language": "EN", diff --git a/projects/aas-server/src/test/assets/keywords.json b/projects/aas-server/src/test/assets/keywords.json new file mode 100644 index 00000000..565c3c6e --- /dev/null +++ b/projects/aas-server/src/test/assets/keywords.json @@ -0,0 +1,6 @@ +[ + ["AAS", ""], + ["Asset Administration Shell", "en"], + ["Verwaltungsschale", "de"], + ["Submodel", ""] +] \ No newline at end of file diff --git a/projects/aas-server/src/test/http-client.spec.ts b/projects/aas-server/src/test/http-client.spec.ts index 724ba989..c68586cc 100644 --- a/projects/aas-server/src/test/http-client.spec.ts +++ b/projects/aas-server/src/test/http-client.spec.ts @@ -6,8 +6,10 @@ * *****************************************************************************/ +import 'reflect-metadata'; import net from 'net'; -import http, { IncomingMessage } from 'http'; +import { IncomingMessage } from 'http'; +import axios from 'axios'; import { Socket } from 'net'; import { HttpClient } from '../app/http-client.js'; import { createSpyObj } from 'fhg-jest'; @@ -30,15 +32,7 @@ describe('HttpClient', () => { describe('get', () => { beforeEach(() => { - jest.spyOn(http, 'request').mockImplementation((_, callback) => { - const stream = new IncomingMessage(new Socket()); - stream.push(JSON.stringify({ text: 'Hello World!' })); - stream.push(null); - stream.statusCode = 200; - stream.statusMessage = 'OK'; - (callback as (res: IncomingMessage) => void)(stream); - return new http.ClientRequest('http://localhost:1234/hello/world'); - }); + jest.spyOn(axios, 'get').mockResolvedValue({ data: { text: 'Hello World!' } }); }); it('gets an object from a server', async () => { @@ -50,13 +44,10 @@ describe('HttpClient', () => { describe('getResponse', () => { beforeEach(() => { - jest.spyOn(http, 'request').mockImplementation((_, callback) => { - const stream = new IncomingMessage(new Socket()); - stream.push(JSON.stringify({ text: 'Hello World!' })); - stream.push(null); - (callback as (res: IncomingMessage) => void)(stream); - return new http.ClientRequest('http://localhost:1234/hello/world'); - }); + const stream = new IncomingMessage(new Socket()); + stream.push(JSON.stringify({ text: 'Hello World!' })); + stream.push(null); + jest.spyOn(axios, 'get').mockResolvedValue({ data: stream }); }); it('gets the message response', async () => { @@ -66,61 +57,35 @@ describe('HttpClient', () => { describe('put', () => { beforeEach(() => { - jest.spyOn(http, 'request').mockImplementation((_, callback) => { - const stream = new IncomingMessage(new Socket()); - stream.push(JSON.stringify('OK')); - stream.push(null); - (callback as (res: IncomingMessage) => void)(stream); - stream.statusCode = 200; - stream.statusMessage = 'OK'; - return new http.ClientRequest('http://localhost:1234/hello/world'); - }); + jest.spyOn(axios, 'put').mockResolvedValue({ data: 42, statusText: 'OK' }); }); it('updates an object on a server', async () => { await expect( server.put(new URL('http://localhost:1234/hello/world'), { text: 'Hello World!' }), - ).resolves.toEqual(JSON.stringify('OK')); + ).resolves.toEqual('OK'); }); }); describe('post', () => { beforeEach(() => { - jest.spyOn(http, 'request').mockImplementation((_, callback) => { - const stream = new IncomingMessage(new Socket()); - stream.push(JSON.stringify('Created')); - stream.push(null); - (callback as (res: IncomingMessage) => void)(stream); - stream.statusCode = 201; - stream.statusMessage = 'Created'; - return new http.ClientRequest('http://localhost:1234/hello/world'); - }); + jest.spyOn(axios, 'post').mockResolvedValue({ data: 4711, statusText: 'Created' }); }); it('updates an object on a server', async () => { await expect( server.post(new URL('http://localhost:1234/hello/world'), { text: 'Hello World!' }), - ).resolves.toEqual(JSON.stringify('Created')); + ).resolves.toEqual('Created'); }); }); describe('delete', () => { beforeEach(() => { - jest.spyOn(http, 'request').mockImplementation((_, callback) => { - const stream = new IncomingMessage(new Socket()); - stream.push(JSON.stringify('Deleted')); - stream.push(null); - (callback as (res: IncomingMessage) => void)(stream); - stream.statusCode = 204; - stream.statusMessage = 'No Content'; - return new http.ClientRequest('http://localhost:1234/hello/world'); - }); + jest.spyOn(axios, 'delete').mockResolvedValue({ data: {}, statusText: 'Deleted' }); }); it('updates an object on a server', async () => { - await expect(server.delete(new URL('http://localhost:1234/hello/world'))).resolves.toEqual( - JSON.stringify('Deleted'), - ); + await expect(server.delete(new URL('http://localhost:1234/hello/world'))).resolves.toEqual('Deleted'); }); }); diff --git a/projects/aas-server/src/test/packages/aas-server/aas-api-client-v0.spec.ts b/projects/aas-server/src/test/packages/aas-server/aas-api-client-v0.spec.ts index bb0dbcea..226aad7a 100644 --- a/projects/aas-server/src/test/packages/aas-server/aas-api-client-v0.spec.ts +++ b/projects/aas-server/src/test/packages/aas-server/aas-api-client-v0.spec.ts @@ -45,7 +45,8 @@ describe('AASApiClientV0', function () { describe('getShellsAsync', () => { it('returns the AAS list', async () => { http.get.mockResolvedValue(listaas); - await expect(client.getShellsAsync()).resolves.toEqual([ + const result = await client.getShellsAsync(); + expect(result.result).toEqual([ 'AssistanceSystem_Dte', 'CunaCup_Becher1', 'CunaCup_Becher2', diff --git a/projects/aasportal-index/docker-compose.yml b/projects/aasportal-index/docker-compose.yml index c5cf74c3..6d0f4c2e 100644 --- a/projects/aasportal-index/docker-compose.yml +++ b/projects/aasportal-index/docker-compose.yml @@ -5,7 +5,7 @@ services: command: --default-authentication-plugin=mysql_native_password volumes: - ./schema.sql:/docker-entrypoint-initdb.d/1.sql - - sqldata:/var/lib/mysql + - aasindex:/var/lib/mysql restart: always environment: @@ -17,4 +17,4 @@ services: - 3306:3306 volumes: - sqldata: \ No newline at end of file + aasindex: \ No newline at end of file From 738463270b495d7ba86565d81d0575f038f259ed Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Sun, 27 Oct 2024 20:15:34 +0100 Subject: [PATCH 08/76] fix: testing AASIndex --- .../src/app/aas-index/aas-index-factory.ts | 8 +-- .../aas-server/src/app/aas-index/aas-index.ts | 2 +- .../src/app/aas-index/lowdb/lowdb-index.ts | 21 ++++++- .../src/app/aas-index/mysql/mysql-index.ts | 34 +++++++++-- projects/aas-server/src/app/convert.ts | 6 +- .../test/aas-index/lowdb/lowdb-index.spec.ts | 7 ++- .../test/aas-index/mysql/mysql-index.spec.ts | 56 ++++++++++++++++++- 7 files changed, 114 insertions(+), 20 deletions(-) diff --git a/projects/aas-server/src/app/aas-index/aas-index-factory.ts b/projects/aas-server/src/app/aas-index/aas-index-factory.ts index 5ffa77ad..2856aac7 100644 --- a/projects/aas-server/src/app/aas-index/aas-index-factory.ts +++ b/projects/aas-server/src/app/aas-index/aas-index-factory.ts @@ -30,9 +30,7 @@ export class AASIndexFactory { try { const url = new URL(variable.AAS_INDEX); if (url.protocol === 'mysql:') { - const index = new MySqlIndex(keywordDirectory, variable); - logger.info(`AAS index connected to ${urlToString(url)}.`); - return index; + return new MySqlIndex(logger, variable, keywordDirectory); } throw new Error(`${urlToString(url)} is a not supported AAS index.`); @@ -43,8 +41,6 @@ export class AASIndexFactory { const dbFile = path.join(variable.CONTENT_ROOT, 'db.json'); const db = new Low(new JSONFile(dbFile), { documents: [], endpoints: [], elements: [] }); - const index = new LowDbIndex(db, keywordDirectory, variable); - logger.info('Using internal AAS index.'); - return index; + return new LowDbIndex(logger, variable, db, keywordDirectory); } } diff --git a/projects/aas-server/src/app/aas-index/aas-index.ts b/projects/aas-server/src/app/aas-index/aas-index.ts index 566f7500..cda862bc 100644 --- a/projects/aas-server/src/app/aas-index/aas-index.ts +++ b/projects/aas-server/src/app/aas-index/aas-index.ts @@ -28,7 +28,7 @@ import { LangString } from '../types/aas-v2.js'; export abstract class AASIndex { protected constructor(private readonly keywordDirectory: KeywordDirectory) {} - public abstract getCount(query?: string): Promise; + public abstract getCount(endpoint?: string): Promise; public abstract getEndpoints(): Promise; diff --git a/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts b/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts index 4d933b67..384c3371 100644 --- a/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts +++ b/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts @@ -29,22 +29,37 @@ import { LowDbData, LowDbDocument, LowDbElement } from './lowdb-types.js'; import { decodeBase64Url, encodeBase64Url } from '../../convert.js'; import { PagedResult } from '../../types/paged-result.js'; import { KeywordDirectory } from '../keyword-directory.js'; +import { Logger } from '../../logging/logger.js'; export class LowDbIndex extends AASIndex { private readonly promise: Promise; public constructor( + private readonly logger: Logger, + private readonly variable: Variable, private readonly db: Low, keywordDirectory: KeywordDirectory, - private readonly variable: Variable, ) { super(keywordDirectory); this.promise = this.initialize(); + this.promise.then(() => logger.info('Using internal AAS index.')).catch(error => logger.error(error)); } - public override getCount(): Promise { - return Promise.resolve(this.db.data.documents.length); + public override async getCount(endpoint?: string): Promise { + await this.promise; + if (endpoint === undefined) { + return this.db.data.documents.length; + } + + let count = 0; + this.db.data.documents.forEach(item => { + if (item.endpoint === endpoint) { + ++count; + } + }); + + return count; } public override async getEndpoints(): Promise { diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts index 6bec9e2b..8d4f1831 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts @@ -17,22 +17,46 @@ import { MySqlQuery } from './mysql-query.js'; import { DocumentCount, MySqlDocument, MySqlEndpoint } from './mysql-types.js'; import { PagedResult } from '../../types/paged-result.js'; import { KeywordDirectory } from '../keyword-directory.js'; +import { Logger } from '../../logging/logger.js'; +import { urlToString } from '../../convert.js'; export class MySqlIndex extends AASIndex { private readonly connection: Promise; public constructor( - keywordDirectory: KeywordDirectory, + private readonly logger: Logger, private readonly variable: Variable, + keywordDirectory: KeywordDirectory, + connection?: Connection, ) { super(keywordDirectory); - this.connection = this.initialize(); + if (connection === undefined) { + this.connection = this.initialize(); + this.connection + .then(() => { + logger.info(`AAS index connected to ${urlToString(this.variable.AAS_INDEX)}.`); + }) + .catch(error => { + this.logger.error(error); + }); + } else { + this.connection = new Promise(resolve => resolve(connection)); + } } - public override async getCount(): Promise { - return (await (await this.connection).query('SELECT COUNT(*) FROM `documents` AS count'))[0][0] - .count; + public override async getCount(endpoint?: string): Promise { + if (endpoint === undefined) { + return ( + await (await this.connection).query('SELECT COUNT(*) FROM `documents` AS count') + )[0][0].count; + } + + return ( + await ( + await this.connection + ).query('SELECT COUNT(*) FROM `documents` WHERE endpoint = ? AS count', [endpoint]) + )[0][0].count; } public override async getEndpoints(): Promise { diff --git a/projects/aas-server/src/app/convert.ts b/projects/aas-server/src/app/convert.ts index 7695afd1..0c5714b9 100644 --- a/projects/aas-server/src/app/convert.ts +++ b/projects/aas-server/src/app/convert.ts @@ -30,7 +30,11 @@ export function parseUrl(url: string): URL { } } -export function urlToString(url: URL | string): string { +export function urlToString(url: URL | string | undefined): string { + if (url === undefined) { + return ''; + } + const temp = new URL(url); temp.password = ''; temp.username = ''; diff --git a/projects/aas-server/src/test/aas-index/lowdb/lowdb-index.spec.ts b/projects/aas-server/src/test/aas-index/lowdb/lowdb-index.spec.ts index 76990237..465ffa70 100644 --- a/projects/aas-server/src/test/aas-index/lowdb/lowdb-index.spec.ts +++ b/projects/aas-server/src/test/aas-index/lowdb/lowdb-index.spec.ts @@ -16,10 +16,12 @@ import { Variable } from '../../../app/variable.js'; import { LowDbIndex } from '../../../app/aas-index/lowdb/lowdb-index.js'; import { LowDbData } from '../../../app/aas-index/lowdb/lowdb-types.js'; import { KeywordDirectory } from 'projects/aas-server/src/app/aas-index/keyword-directory.js'; +import { Logger } from '../../../app/logging/logger.js'; describe('LowDbIndex', () => { let index: LowDbIndex; let db: jest.Mocked>; + let logger: jest.Mocked; let variable: jest.Mocked; let keywords: jest.Mocked; let dbData: LowDbData; @@ -36,16 +38,17 @@ describe('LowDbIndex', () => { beforeEach(() => { db = createSpyObj>(['read', 'write'], { data: dbData }); db.read.mockResolvedValue(); + logger = createSpyObj(['error', 'info']); variable = createSpyObj([], { ENDPOINTS: [] }); keywords = createSpyObj(['containedKeyword', 'toString']); - index = new LowDbIndex(db, keywords, variable); + index = new LowDbIndex(logger, variable, db, keywords); }); it('should create', () => { expect(index).toBeTruthy(); }); - describe('getContainerDocuments', () => { + describe('nextPage', () => { it('returns all documents that belongs to a container', async () => { const result = await index.nextPage('Samples', undefined); expect(result.result).toEqual(db.data.documents.filter(document => document.endpoint === 'Samples')); diff --git a/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts b/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts index 9512baab..cae1b76a 100644 --- a/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts +++ b/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts @@ -6,8 +6,60 @@ * *****************************************************************************/ -import { describe, it } from '@jest/globals'; +import { beforeEach, describe, expect, it, jest } from '@jest/globals'; +import { Connection } from 'mysql2/promise'; +import { createSpyObj } from 'fhg-jest'; +import { MySqlIndex } from '../../../app/aas-index/mysql/mysql-index.js'; +import { Logger } from '../../../app/logging/logger.js'; +import { Variable } from '../../../app/variable.js'; +import { KeywordDirectory } from '../../../app/aas-index/keyword-directory.js'; +import { DocumentCount } from '../../../app/aas-index/mysql/mysql-types.js'; describe('MySqlIndex', () => { - it.todo('MySqlIndex'); + let index: MySqlIndex; + let logger: jest.Mocked; + let variable: jest.Mocked; + let connection: jest.Mocked; + let keywords: jest.Mocked; + + beforeEach(() => { + logger = createSpyObj(['error', 'info']); + variable = createSpyObj({}, { ENDPOINTS: [] }); + keywords = createSpyObj(['containedKeyword', 'toString']); + connection = createSpyObj(['query']); + index = new MySqlIndex(logger, variable, keywords, connection); + }); + + it('should be created', () => { + expect(index).toBeTruthy(); + }); + + describe('getCount', () => { + it('returns the total number of documents', async () => { + const result: DocumentCount = { + constructor: { name: 'RowDataPacket' }, + count: 42, + }; + + connection.query.mockResolvedValue([[result], []]); + const count = await index.getCount(); + expect(connection.query).toBeCalledWith('SELECT COUNT(*) FROM `documents` AS count'); + expect(count).toEqual(42); + }); + + it('returns the total number of documents of the specified Endpoint', async () => { + const result: DocumentCount = { + constructor: { name: 'RowDataPacket' }, + count: 42, + }; + + connection.query.mockResolvedValue([[result], []]); + const count = await index.getCount('Samples'); + expect(connection.query).toBeCalledWith('SELECT COUNT(*) FROM `documents` WHERE endpoint = ? AS count', [ + 'Samples', + ]); + + expect(count).toEqual(42); + }); + }); }); From 682ece555e66c3b0dd8f5e384b3e3376e9ac3135 Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Mon, 28 Oct 2024 15:27:06 +0100 Subject: [PATCH 09/76] fix: test MySqlIndex --- .../test/aas-index/mysql/mysql-index.spec.ts | 29 ++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts b/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts index cae1b76a..c79ccffe 100644 --- a/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts +++ b/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts @@ -13,7 +13,7 @@ import { MySqlIndex } from '../../../app/aas-index/mysql/mysql-index.js'; import { Logger } from '../../../app/logging/logger.js'; import { Variable } from '../../../app/variable.js'; import { KeywordDirectory } from '../../../app/aas-index/keyword-directory.js'; -import { DocumentCount } from '../../../app/aas-index/mysql/mysql-types.js'; +import { DocumentCount, MySqlEndpoint } from '../../../app/aas-index/mysql/mysql-types.js'; describe('MySqlIndex', () => { let index: MySqlIndex; @@ -62,4 +62,31 @@ describe('MySqlIndex', () => { expect(count).toEqual(42); }); }); + + describe('getEndpoints', () => { + it('returns all registered endpoints', () => { + const result: MySqlEndpoint[] = [ + { + constructor: { name: 'RowDataPacket' }, + name: 'Endpoint 1', + url: 'http://endpoint1.com', + type: 'AAS_API', + }, + { + constructor: { name: 'RowDataPacket' }, + name: 'Endpoint 2', + url: 'http://endpoint2.com', + type: 'AAS_API', + }, + ]; + + connection.query.mockResolvedValue([[result], []]); + const actual = index.getEndpoints(); + expect(connection.query).toBeCalledWith('SELECT * FROM `endpoints`'); + expect(actual).toEqual([ + { name: 'Endpoint 1', url: 'http://endpoint1.com', type: 'AAS_API' }, + { name: 'Endpoint 2', url: 'http://endpoint2.com', type: 'AAS_API' }, + ]); + }); + }); }); From 446450934423c5e8c89563647605fdef4463237d Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Mon, 4 Nov 2024 06:43:20 +0100 Subject: [PATCH 10/76] in progress --- projects/aas-core/src/lib/types.ts | 9 +- .../add-endpoint-form.component.html | 19 +- .../src/app/start/start-api.service.ts | 6 +- .../aas-portal/src/app/start/start.store.ts | 6 +- .../aas-server/src/app/aas-index/aas-index.ts | 4 +- .../src/app/aas-index/lowdb/lowdb-index.ts | 13 +- .../src/app/aas-index/mysql/mysql-index.ts | 63 +++-- .../src/app/aas-index/mysql/mysql-types.ts | 1 + .../src/app/aas-provider/aas-provider.ts | 66 +++-- .../src/app/aas-provider/scan-result.ts | 6 +- .../src/app/aas-provider/worker-data.ts | 1 + .../app/controller/documents-controller.ts | 4 +- projects/aas-server/src/app/endpoint-scan.ts | 3 + .../src/app/template/template-scan.ts | 1 + .../src/app/template/template-storage.ts | 1 + projects/aas-server/src/app/variable.ts | 12 +- projects/aas-server/src/app/worker-app.ts | 7 +- .../test/aas-index/mysql/mysql-index.spec.ts | 229 ++++++++++++++++-- .../test/template/template-storage.spec.ts | 1 + projects/aasportal-index/schema.sql | 3 +- 20 files changed, 369 insertions(+), 86 deletions(-) diff --git a/projects/aas-core/src/lib/types.ts b/projects/aas-core/src/lib/types.ts index 3e1b2047..2a8c5ad1 100644 --- a/projects/aas-core/src/lib/types.ts +++ b/projects/aas-core/src/lib/types.ts @@ -45,6 +45,12 @@ export type AASAbbreviation = | 'SME' | 'SML'; +/** The schedule type. */ +export interface AASEndpointSchedule { + type: 'never' | 'once' | 'every' | 'daily' | 'weekly'; + values?: (string | number)[]; +} + /** The kind of AAS container or server. */ export type AASEndpointType = 'FileSystem' | 'AAS_API' | 'OPC_UA' | 'WebDAV'; @@ -53,6 +59,7 @@ export type AASEndpoint = { name: string; url: string; type: AASEndpointType; + schedule?: AASEndpointSchedule; version?: string; headers?: Record; }; @@ -99,7 +106,7 @@ export interface AASDocument extends AASDocumentId { } /** Represents a page of AAS documents from the total set. */ -export interface AASPage { +export interface AASPagedResult { previous: AASDocumentId | null; next: AASDocumentId | null; documents: AASDocument[]; diff --git a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html index a42af250..96aa3e84 100644 --- a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html +++ b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html @@ -42,13 +42,30 @@

(input)="inputValue()">

@if (selectedItem().type === 'AAS_API') { -
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+ diff --git a/projects/aas-portal/src/app/start/start-api.service.ts b/projects/aas-portal/src/app/start/start-api.service.ts index 26ecf3d6..54954426 100644 --- a/projects/aas-portal/src/app/start/start-api.service.ts +++ b/projects/aas-portal/src/app/start/start-api.service.ts @@ -9,7 +9,7 @@ import { Injectable } from '@angular/core'; import { HttpClient } from '@angular/common/http'; import { Observable } from 'rxjs'; -import { AASCursor, AASDocument, AASEndpoint, AASPage, aas } from 'aas-core'; +import { AASCursor, AASDocument, AASEndpoint, AASPagedResult, aas } from 'aas-core'; import { encodeBase64Url } from 'aas-lib'; /** The client side AAS provider service. */ @@ -65,7 +65,7 @@ export class StartApiService { * @param language The language to used for the filter. * @returns The document page. */ - public getPage(cursor: AASCursor, filter?: string, language?: string): Observable { + public getPage(cursor: AASCursor, filter?: string, language?: string): Observable { let url = `/api/v1/documents?cursor=${encodeBase64Url(JSON.stringify(cursor))}`; if (filter) { url += `&filter=${encodeBase64Url(filter)}`; @@ -74,7 +74,7 @@ export class StartApiService { } } - return this.http.get(url); + return this.http.get(url); } /** diff --git a/projects/aas-portal/src/app/start/start.store.ts b/projects/aas-portal/src/app/start/start.store.ts index ddacbc50..2db55b42 100644 --- a/projects/aas-portal/src/app/start/start.store.ts +++ b/projects/aas-portal/src/app/start/start.store.ts @@ -1,7 +1,7 @@ import { Injectable, computed, signal } from '@angular/core'; import { Observable, catchError, concat, from, map, mergeMap, of } from 'rxjs'; import { ViewMode } from 'aas-lib'; -import { AASDocument, AASDocumentId, AASPage, aas, equalArray } from 'aas-core'; +import { AASDocument, AASDocumentId, AASPagedResult, aas, equalArray } from 'aas-core'; import { StartApiService } from './start-api.service'; import { TranslateService } from '@ngx-translate/core'; import { FavoritesService } from './favorites.service'; @@ -198,7 +198,7 @@ export class StartStore { return { id: document.id, endpoint: document.endpoint }; } - private setPageAndLoadContents(page: AASPage, limit?: number, filter?: string): Observable { + private setPageAndLoadContents(page: AASPagedResult, limit?: number, filter?: string): Observable { return concat( of(this.setPage(page, limit, filter)), from(page.documents).pipe( @@ -212,7 +212,7 @@ export class StartStore { ); } - private setPage(page: AASPage, limit: number | undefined, filter: string | undefined): void { + private setPage(page: AASPagedResult, limit: number | undefined, filter: string | undefined): void { this._viewMode.set(ViewMode.List); this._activeFavorites.set(''); this._documents.set(page.documents); diff --git a/projects/aas-server/src/app/aas-index/aas-index.ts b/projects/aas-server/src/app/aas-index/aas-index.ts index cda862bc..d345219a 100644 --- a/projects/aas-server/src/app/aas-index/aas-index.ts +++ b/projects/aas-server/src/app/aas-index/aas-index.ts @@ -10,7 +10,7 @@ import { AASCursor, AASDocument, AASEndpoint, - AASPage, + AASPagedResult, aas, baseType, getAbbreviation, @@ -40,7 +40,7 @@ export abstract class AASIndex { public abstract removeEndpoint(endpointName: string): Promise; - public abstract getDocuments(cursor: AASCursor, query?: string, language?: string): Promise; + public abstract getDocuments(cursor: AASCursor, query?: string, language?: string): Promise; public abstract nextPage( endpointName: string, diff --git a/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts b/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts index 384c3371..02c2a5ff 100644 --- a/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts +++ b/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts @@ -13,13 +13,14 @@ import { AASDocument, AASDocumentId, AASEndpoint, - AASPage, + AASPagedResult, ApplicationError, BaseValueType, aas, flat, isIdentifiable, } from 'aas-core'; + import { AASIndex } from '../aas-index.js'; import { LowDbQuery } from './lowdb-query.js'; import { Variable } from '../../variable.js'; @@ -154,7 +155,7 @@ export class LowDbIndex extends AASIndex { return { result, paging_metadata: { cursor: encodeBase64Url(items[k].id) } }; } - public override async getDocuments(cursor: AASCursor, query?: string, language?: string): Promise { + public override async getDocuments(cursor: AASCursor, query?: string, language?: string): Promise { await this.promise; let filter: LowDbQuery | undefined; @@ -293,7 +294,7 @@ export class LowDbIndex extends AASIndex { return index; } - private getFirstPage(limit: number, filter?: LowDbQuery): AASPage { + private getFirstPage(limit: number, filter?: LowDbQuery): AASPagedResult { const documents: AASDocument[] = []; if (this.db.data.documents.length === 0) { return { previous: null, documents, next: null }; @@ -324,7 +325,7 @@ export class LowDbIndex extends AASIndex { }; } - private getNextPage(current: AASDocumentId, limit: number, filter?: LowDbQuery): AASPage { + private getNextPage(current: AASDocumentId, limit: number, filter?: LowDbQuery): AASPagedResult { const documents: AASDocument[] = []; if (this.db.data.documents.length === 0) { return { previous: null, documents, next: null }; @@ -362,7 +363,7 @@ export class LowDbIndex extends AASIndex { }; } - private getPreviousPage(current: AASDocumentId, limit: number, filter?: LowDbQuery): AASPage { + private getPreviousPage(current: AASDocumentId, limit: number, filter?: LowDbQuery): AASPagedResult { const documents: AASDocument[] = []; if (this.db.data.documents.length === 0) { return { previous: null, documents, next: null }; @@ -400,7 +401,7 @@ export class LowDbIndex extends AASIndex { }; } - private getLastPage(limit: number, filter?: LowDbQuery): AASPage { + private getLastPage(limit: number, filter?: LowDbQuery): AASPagedResult { const documents: AASDocument[] = []; if (this.db.data.documents.length === 0) { return { previous: null, documents, next: null }; diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts index 8d4f1831..3646c612 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts @@ -9,7 +9,17 @@ import { v4 } from 'uuid'; import isEmpty from 'lodash-es/isEmpty.js'; import mysql, { Connection, ResultSetHeader } from 'mysql2/promise'; -import { AASEndpoint, AASCursor, AASPage, AASDocument, flat, aas, AASDocumentId, isIdentifiable } from 'aas-core'; +import { + AASEndpoint, + AASCursor, + AASDocument, + flat, + aas, + AASDocumentId, + isIdentifiable, + AASPagedResult, +} from 'aas-core'; + import { AASIndex } from '../aas-index.js'; import { Variable } from '../../variable.js'; import { urlToEndpoint } from '../../configuration.js'; @@ -48,19 +58,19 @@ export class MySqlIndex extends AASIndex { public override async getCount(endpoint?: string): Promise { if (endpoint === undefined) { return ( - await (await this.connection).query('SELECT COUNT(*) FROM `documents` AS count') + await (await this.connection).query('SELECT COUNT(*) FROM `documents` AS count;') )[0][0].count; } return ( await ( await this.connection - ).query('SELECT COUNT(*) FROM `documents` WHERE endpoint = ? AS count', [endpoint]) + ).query('SELECT COUNT(*) FROM `documents` WHERE endpoint = ? AS count;', [endpoint]) )[0][0].count; } public override async getEndpoints(): Promise { - return (await (await this.connection).query('SELECT * FROM `endpoints`'))[0].map( + return (await (await this.connection).query('SELECT * FROM `endpoints`;'))[0].map( row => ({ name: row.name, @@ -75,7 +85,7 @@ export class MySqlIndex extends AASIndex { public override async getEndpoint(name: string): Promise { const [results] = await ( await this.connection - ).query('SELECT * FROM `endpoints` WHERE name = ?', [name]); + ).query('SELECT * FROM `endpoints` WHERE name = ?;', [name]); if (results.length === 0) { throw new Error(`An endpoint with the name "${name}" does not exist.`); @@ -96,13 +106,17 @@ export class MySqlIndex extends AASIndex { endpoint.headers = JSON.parse(result.headers); } + if (result.schedule) { + endpoint.schedule = JSON.parse(result.schedule); + } + return endpoint; } public override async hasEndpoint(name: string): Promise { const [results] = await ( await this.connection - ).query('SELECT * FROM `endpoints` WHERE name = ?', [name]); + ).query('SELECT * FROM `endpoints` WHERE name = ?;', [name]); return results.length > 0; } @@ -110,13 +124,16 @@ export class MySqlIndex extends AASIndex { public override async addEndpoint(endpoint: AASEndpoint): Promise { await ( await this.connection - ).query('INSERT INTO `endpoints` (name, url, type, version, headers) VALUES (?, ?, ?, ?, ?)', [ - endpoint.name, - endpoint.url, - endpoint.type, - endpoint.version, - endpoint.headers ? JSON.stringify(endpoint.headers) : undefined, - ]); + ).query( + 'INSERT INTO `endpoints` (name, url, type, version, headers) VALUES (?, ?, ?, ?, ?);', + [ + endpoint.name, + endpoint.url, + endpoint.type, + endpoint.version, + endpoint.headers ? JSON.stringify(endpoint.headers) : undefined, + ], + ); } public override async removeEndpoint(endpointName: string): Promise { @@ -126,7 +143,7 @@ export class MySqlIndex extends AASIndex { const result = await ( await this.connection - ).query('DELETE FROM `endpoints` WHERE name = ?', [endpointName]); + ).query('DELETE FROM `endpoints` WHERE name = ?;', [endpointName]); this.removeDocuments(endpointName); @@ -138,7 +155,7 @@ export class MySqlIndex extends AASIndex { } } - public override getDocuments(cursor: AASCursor, query?: string, language?: string): Promise { + public override getDocuments(cursor: AASCursor, query?: string, language?: string): Promise { let q: MySqlQuery | undefined; if (query) { q = new MySqlQuery(query, language ?? 'en'); @@ -200,7 +217,7 @@ export class MySqlIndex extends AASIndex { const uuid = result[0][0].uuid; await connection.query( - 'UPDATE `documents` SET address = ?, crc32 = ?, idShort = ?, onlineReady = ?, readonly = ?, timestamp = ?, thumbnail = ? WHERE uuid = ?', + 'UPDATE `documents` SET address = ?, crc32 = ?, idShort = ?, onlineReady = ?, readonly = ?, timestamp = ?, thumbnail = ? WHERE uuid = ?;', [ document.address, document.crc32, @@ -231,7 +248,7 @@ export class MySqlIndex extends AASIndex { await connection.beginTransaction(); const uuid = v4(); await connection.query( - 'INSERT INTO `documents` (uuid, address, crc32, endpoint, id, idShort, assetId, onlineReady, readonly, thumbnail, timestamp) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)', + 'INSERT INTO `documents` (uuid, address, crc32, endpoint, id, idShort, assetId, onlineReady, readonly, thumbnail, timestamp) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?);', [ uuid, document.address, @@ -320,17 +337,17 @@ export class MySqlIndex extends AASIndex { private async removeDocuments(endpointName: string): Promise { const connection = await this.connection; const documents = ( - await connection.query('SELECT * FROM `documents` WHERE endpoint = ?', [endpointName]) + await connection.query('SELECT * FROM `documents` WHERE endpoint = ?;', [endpointName]) )[0]; - await connection.query('DELETE FROM `documents` WHERE endpoint = ?', [endpointName]); + await connection.query('DELETE FROM `documents` WHERE endpoint = ?;', [endpointName]); for (const document of documents) { await connection.query('DELETE FROM `elements` WHERE uuid = ?;', [document.uuid]); } } - private async getFirstPage(limit: number, query?: MySqlQuery): Promise { + private async getFirstPage(limit: number, query?: MySqlQuery): Promise { const connection = await this.connection; let sql: string; const values: unknown[] = []; @@ -361,7 +378,7 @@ export class MySqlIndex extends AASIndex { }; } - private async getNextPage(current: AASDocumentId, limit: number, query?: MySqlQuery): Promise { + private async getNextPage(current: AASDocumentId, limit: number, query?: MySqlQuery): Promise { const connection = await this.connection; let sql: string; const values: unknown[] = [current.endpoint + current.id]; @@ -393,7 +410,7 @@ export class MySqlIndex extends AASIndex { }; } - private async getPreviousPage(current: AASDocumentId, limit: number, query?: MySqlQuery): Promise { + private async getPreviousPage(current: AASDocumentId, limit: number, query?: MySqlQuery): Promise { const connection = await this.connection; let sql: string; const values: unknown[] = [current.endpoint + current.id]; @@ -425,7 +442,7 @@ export class MySqlIndex extends AASIndex { }; } - private async getLastPage(limit: number, query?: MySqlQuery): Promise { + private async getLastPage(limit: number, query?: MySqlQuery): Promise { const connection = await this.connection; let sql: string; const values: unknown[] = []; diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts index 2d560da5..7641a627 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts @@ -15,6 +15,7 @@ export interface MySqlEndpoint extends RowDataPacket { type: AASEndpointType; version?: string; headers?: string; + schedule?: string; } export interface MySqlDocument extends AASDocument, RowDataPacket { diff --git a/projects/aas-server/src/app/aas-provider/aas-provider.ts b/projects/aas-server/src/app/aas-provider/aas-provider.ts index 77efebaa..97da1412 100644 --- a/projects/aas-server/src/app/aas-provider/aas-provider.ts +++ b/projects/aas-server/src/app/aas-provider/aas-provider.ts @@ -17,11 +17,12 @@ import { aas, selectElement, AASCursor, - AASPage, + AASPagedResult, AASEndpoint, ApplicationError, getChildren, isReferenceElement, + AASEndpointSchedule, noop, } from 'aas-core'; @@ -35,7 +36,6 @@ import { SocketClient } from '../live/socket-client.js'; import { EmptySubscription } from '../live/empty-subscription.js'; import { SocketSubscription } from '../live/socket-subscription.js'; import { AASResourceFactory } from '../packages/aas-resource-factory.js'; -import { AASResourceScanFactory } from './aas-resource-scan-factory.js'; import { Variable } from '../variable.js'; import { WSServer } from '../ws-server.js'; import { ERRORS } from '../errors.js'; @@ -45,21 +45,19 @@ import { AASCache } from './aas-cache.js'; @singleton() export class AASProvider { - private readonly timeout: number; private readonly file: string | undefined; private readonly cache = new AASCache(); private wsServer!: WSServer; private resetRequested = false; public constructor( - @inject(Variable) variable: Variable, + @inject(Variable) private readonly variable: Variable, @inject('Logger') private readonly logger: Logger, @inject(Parallel) private readonly parallel: Parallel, @inject(AASResourceFactory) private readonly resourceFactory: AASResourceFactory, @inject('AASIndex') private readonly index: AASIndex, @inject(TaskHandler) private readonly taskHandler: TaskHandler, ) { - this.timeout = variable.SCAN_CONTAINER_TIMEOUT; this.parallel.on('message', this.parallelOnMessage); this.parallel.on('end', this.parallelOnEnd); } @@ -88,7 +86,7 @@ export class AASProvider { * @param language The current language. * @returns A page of documents. */ - public getDocumentsAsync(cursor: AASCursor, filter?: string, language?: string): Promise { + public getDocumentsAsync(cursor: AASCursor, filter?: string, language?: string): Promise { const minFilterLength = 3; if (filter && filter.length >= minFilterLength) { return this.index.getDocuments(cursor, filter, language ?? 'en'); @@ -373,17 +371,6 @@ export class AASProvider { } } - /** Only used for test. */ - public async scanAsync(factory: AASResourceScanFactory): Promise { - noop(factory); - // for (const endpoint of await this.index.getEndpoints()) { - // if (endpoint.type === 'FileSystem') { - // const result = await factory.create(endpoint).scanAsync(); - // result.result.forEach(async document => await this.index.add(document)); - // } - // } - } - /** * Invokes an operation synchronous. * @param endpointName The endpoint name. @@ -472,18 +459,47 @@ export class AASProvider { private startScan = async (): Promise => { try { for (const endpoint of await this.index.getEndpoints()) { - setTimeout(this.scanEndpoint, 0, this.taskHandler.createTaskId(), endpoint); + if (endpoint.schedule?.type === 'never') { + continue; + } + + setTimeout( + this.scanEndpoint, + this.computeTimeout(endpoint.schedule), + this.taskHandler.createTaskId(), + endpoint, + ); } } catch (error) { this.logger.error(error); } }; + private computeTimeout(schedule: AASEndpointSchedule | undefined, start?: number): number { + if (schedule === undefined) { + return this.variable.SCAN_ENDPOINT_TIMEOUT; + } + + start = start || Date.now(); + if (schedule.type === 'every') { + const values = schedule.values; + if (values && values.length > 0 && typeof values[0] === 'number') { + const timeout = Date.now() - start - values[0]; + return timeout >= 0 ? timeout : values[0]; + } + } else if (schedule.type === 'daily' || ) { + noop(); + } + + return this.variable.SCAN_ENDPOINT_TIMEOUT; + } + private scanEndpoint = async (taskId: number, endpoint: AASEndpoint) => { const data: ScanEndpointData = { type: 'ScanEndpointData', taskId, endpoint, + start: Date.now(), }; this.taskHandler.set(taskId, { endpointName: endpoint.name, owner: this, type: 'ScanEndpoint' }); @@ -515,9 +531,19 @@ export class AASProvider { } this.taskHandler.delete(result.taskId); - if ((await await this.index.hasEndpoint(task.endpointName)) === true) { + if ((await this.index.hasEndpoint(task.endpointName)) === true) { const endpoint = await this.index.getEndpoint(task.endpointName); - setTimeout(this.scanEndpoint, this.timeout, result.taskId, endpoint); + + if (endpoint.schedule?.type === 'once') { + return; + } + + setTimeout( + this.scanEndpoint, + this.computeTimeout(endpoint.schedule, result.start), + result.taskId, + endpoint, + ); } if (result.messages) { diff --git a/projects/aas-server/src/app/aas-provider/scan-result.ts b/projects/aas-server/src/app/aas-provider/scan-result.ts index 11a81827..d77abd00 100644 --- a/projects/aas-server/src/app/aas-provider/scan-result.ts +++ b/projects/aas-server/src/app/aas-provider/scan-result.ts @@ -15,13 +15,11 @@ export enum ScanResultType { End, } -/** The result of a container scan. */ +/** The result of an endpoint scan. */ export interface ScanResult { - /** The result. */ type: ScanResultType; - /** The task identifier. */ taskId: number; - /** The message memory. */ + start: number; messages?: Message[]; } diff --git a/projects/aas-server/src/app/aas-provider/worker-data.ts b/projects/aas-server/src/app/aas-provider/worker-data.ts index 47bff72f..a2f2592b 100644 --- a/projects/aas-server/src/app/aas-provider/worker-data.ts +++ b/projects/aas-server/src/app/aas-provider/worker-data.ts @@ -11,6 +11,7 @@ import { AASEndpoint } from 'aas-core'; export interface WorkerData { taskId: number; type: 'ScanEndpointData' | 'ScanTemplatesData'; + start: number; } export interface ScanEndpointData extends WorkerData { diff --git a/projects/aas-server/src/app/controller/documents-controller.ts b/projects/aas-server/src/app/controller/documents-controller.ts index 36c9e1fb..fbb3dfb8 100644 --- a/projects/aas-server/src/app/controller/documents-controller.ts +++ b/projects/aas-server/src/app/controller/documents-controller.ts @@ -12,7 +12,7 @@ import { Logger } from '../logging/logger.js'; import { AASController } from './aas-controller.js'; import { AuthService } from '../auth/auth-service.js'; import { Variable } from '../variable.js'; -import { AASDocument, AASPage } from 'aas-core'; +import { AASDocument, AASPagedResult } from 'aas-core'; import { AASProvider } from '../aas-provider/aas-provider.js'; import { decodeBase64Url } from '../convert.js'; @@ -42,7 +42,7 @@ export class DocumentsController extends AASController { @Query() cursor: string, @Query() filter?: string, @Query() language?: string, - ): Promise { + ): Promise { try { this.logger.start('getDocuments'); if (filter) { diff --git a/projects/aas-server/src/app/endpoint-scan.ts b/projects/aas-server/src/app/endpoint-scan.ts index 611582ca..5507f4f7 100644 --- a/projects/aas-server/src/app/endpoint-scan.ts +++ b/projects/aas-server/src/app/endpoint-scan.ts @@ -61,6 +61,7 @@ export class EndpointScan { type: ScanResultType.Update, endpoint: this.data.endpoint, document: document, + start: this.data.start, }; const array = toUint8Array(value); @@ -73,6 +74,7 @@ export class EndpointScan { type: ScanResultType.Remove, endpoint: this.data.endpoint, document: document, + start: this.data.start, }; const array = toUint8Array(value); @@ -85,6 +87,7 @@ export class EndpointScan { type: ScanResultType.Add, endpoint: this.data.endpoint, document: document, + start: this.data.start, }; const array = toUint8Array(value); diff --git a/projects/aas-server/src/app/template/template-scan.ts b/projects/aas-server/src/app/template/template-scan.ts index 90d5829c..fd32ca61 100644 --- a/projects/aas-server/src/app/template/template-scan.ts +++ b/projects/aas-server/src/app/template/template-scan.ts @@ -52,6 +52,7 @@ export class TemplateScan { taskId: data.taskId, type: ScanResultType.Update, templates: templates, + start: data.start, }; const array = toUint8Array(value); diff --git a/projects/aas-server/src/app/template/template-storage.ts b/projects/aas-server/src/app/template/template-storage.ts index 2ef64b83..80084086 100644 --- a/projects/aas-server/src/app/template/template-storage.ts +++ b/projects/aas-server/src/app/template/template-storage.ts @@ -79,6 +79,7 @@ export class TemplateStorage { const data: ScanTemplatesData = { type: 'ScanTemplatesData', taskId, + start: Date.now(), }; this.taskHandler.set(taskId, { endpointName: 'TemplateStorage', owner: this, type: 'ScanTemplates' }); diff --git a/projects/aas-server/src/app/variable.ts b/projects/aas-server/src/app/variable.ts index 202867e9..35c9cce6 100644 --- a/projects/aas-server/src/app/variable.ts +++ b/projects/aas-server/src/app/variable.ts @@ -24,8 +24,14 @@ export class Variable { this.WEB_ROOT = path.resolve(process.env.WEB_ROOT ?? './wwwroot'); this.ASSETS = path.resolve(process.env.ASSETS ?? './assets'); this.ENDPOINTS = process.env.ENDPOINTS ? JSON.parse(process.env.ENDPOINTS) : ['file:///samples?name=Samples']; - this.SCAN_TEMPLATES_TIMEOUT = process.env.SCAN_TEMPLATES_TIMEOUT ? Number(process.env.TIMEOUT) : 300000; - this.SCAN_CONTAINER_TIMEOUT = process.env.SCAN_CONTAINER_TIMEOUT ? Number(process.env.TIMEOUT) : 5000; + this.SCAN_TEMPLATES_TIMEOUT = process.env.SCAN_TEMPLATES_TIMEOUT + ? Number(process.env.SCAN_TEMPLATES_TIMEOUT) + : 300000; + + this.SCAN_ENDPOINT_TIMEOUT = process.env.SCAN_ENDPOINT_TIMEOUT + ? Number(process.env.SCAN_ENDPOINT_TIMEOUT) + : 5000; + this.HTTPS_CERT_FILE = process.env.HTTPS_CERT_FILE; this.HTTPS_KEY_FILE = process.env.HTTPS_KEY_FILE; this.HTTPS_PFX_FILE = process.env.HTTPS_PFX_FILE; @@ -75,7 +81,7 @@ export class Variable { public readonly ENDPOINTS: string[]; /** The time before a new endpoint scan starts.*/ - public readonly SCAN_CONTAINER_TIMEOUT: number; + public readonly SCAN_ENDPOINT_TIMEOUT: number; /** The time before a new template scan starts. */ public readonly SCAN_TEMPLATES_TIMEOUT: number; diff --git a/projects/aas-server/src/app/worker-app.ts b/projects/aas-server/src/app/worker-app.ts index 3d88d42f..1d8bcf93 100644 --- a/projects/aas-server/src/app/worker-app.ts +++ b/projects/aas-server/src/app/worker-app.ts @@ -43,14 +43,15 @@ export class WorkerApp { this.logger.error(error); } finally { this.logger.stop(); - parentPort.postMessage(toUint8Array(this.createEndResult(data.taskId))); + parentPort.postMessage(toUint8Array(this.createEndResult(data))); } }; - private createEndResult(taskId: number): ScanResult { + private createEndResult(data: WorkerData): ScanResult { return { - taskId: taskId, + taskId: data.taskId, type: ScanResultType.End, + start: data.start, messages: this.logger.getMessages(), }; } diff --git a/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts b/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts index c79ccffe..7dbdfe6e 100644 --- a/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts +++ b/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts @@ -9,11 +9,12 @@ import { beforeEach, describe, expect, it, jest } from '@jest/globals'; import { Connection } from 'mysql2/promise'; import { createSpyObj } from 'fhg-jest'; +import { AASEndpoint } from 'aas-core'; import { MySqlIndex } from '../../../app/aas-index/mysql/mysql-index.js'; import { Logger } from '../../../app/logging/logger.js'; import { Variable } from '../../../app/variable.js'; import { KeywordDirectory } from '../../../app/aas-index/keyword-directory.js'; -import { DocumentCount, MySqlEndpoint } from '../../../app/aas-index/mysql/mysql-types.js'; +import { DocumentCount, MySqlDocument, MySqlEndpoint } from '../../../app/aas-index/mysql/mysql-types.js'; describe('MySqlIndex', () => { let index: MySqlIndex; @@ -26,7 +27,7 @@ describe('MySqlIndex', () => { logger = createSpyObj(['error', 'info']); variable = createSpyObj({}, { ENDPOINTS: [] }); keywords = createSpyObj(['containedKeyword', 'toString']); - connection = createSpyObj(['query']); + connection = createSpyObj(['query', 'beginTransaction', 'commit', 'rollback']); index = new MySqlIndex(logger, variable, keywords, connection); }); @@ -42,9 +43,8 @@ describe('MySqlIndex', () => { }; connection.query.mockResolvedValue([[result], []]); - const count = await index.getCount(); - expect(connection.query).toBeCalledWith('SELECT COUNT(*) FROM `documents` AS count'); - expect(count).toEqual(42); + await expect(index.getCount()).resolves.toEqual(42); + expect(connection.query).toBeCalledWith('SELECT COUNT(*) FROM `documents` AS count;'); }); it('returns the total number of documents of the specified Endpoint', async () => { @@ -54,17 +54,15 @@ describe('MySqlIndex', () => { }; connection.query.mockResolvedValue([[result], []]); - const count = await index.getCount('Samples'); - expect(connection.query).toBeCalledWith('SELECT COUNT(*) FROM `documents` WHERE endpoint = ? AS count', [ + await expect(index.getCount('Samples')).resolves.toEqual(42); + expect(connection.query).toBeCalledWith('SELECT COUNT(*) FROM `documents` WHERE endpoint = ? AS count;', [ 'Samples', ]); - - expect(count).toEqual(42); }); }); describe('getEndpoints', () => { - it('returns all registered endpoints', () => { + it('returns all registered endpoints', async () => { const result: MySqlEndpoint[] = [ { constructor: { name: 'RowDataPacket' }, @@ -80,13 +78,216 @@ describe('MySqlIndex', () => { }, ]; - connection.query.mockResolvedValue([[result], []]); - const actual = index.getEndpoints(); - expect(connection.query).toBeCalledWith('SELECT * FROM `endpoints`'); - expect(actual).toEqual([ + connection.query.mockResolvedValue([result, []]); + await expect(index.getEndpoints()).resolves.toEqual([ { name: 'Endpoint 1', url: 'http://endpoint1.com', type: 'AAS_API' }, { name: 'Endpoint 2', url: 'http://endpoint2.com', type: 'AAS_API' }, ]); + + expect(connection.query).toBeCalledWith('SELECT * FROM `endpoints`;'); + }); + }); + + describe('getEndpoint', () => { + it('returns the endpoint with the specified name', async () => { + const result: MySqlEndpoint = { + constructor: { name: 'RowDataPacket' }, + name: 'Endpoint 1', + url: 'http://endpoint1.com', + type: 'AAS_API', + }; + + connection.query.mockResolvedValue([[result], []]); + const actual = await index.getEndpoint('Endpoint 1'); + expect(connection.query).toBeCalledWith('SELECT * FROM `endpoints` WHERE name = ?;', ['Endpoint 1']); + expect(actual).toEqual({ name: 'Endpoint 1', url: 'http://endpoint1.com', type: 'AAS_API' }); + }); + + it('throws an error if endpoint does not exist', async () => { + connection.query.mockResolvedValue([[], []]); + await expect(index.getEndpoint('Unknown')).rejects.toThrowError(); + expect(connection.query).toBeCalledWith('SELECT * FROM `endpoints` WHERE name = ?;', ['Unknown']); + }); + }); + + describe('hasEndpoint', () => { + it('indicates that Endpoint 1 exists', async () => { + const result: MySqlEndpoint = { + constructor: { name: 'RowDataPacket' }, + name: 'Endpoint 1', + url: 'http://endpoint1.com', + type: 'AAS_API', + }; + + connection.query.mockResolvedValue([[result], []]); + await expect(index.hasEndpoint('Endpoint 1')).resolves.toEqual(true); + expect(connection.query).toBeCalledWith('SELECT * FROM `endpoints` WHERE name = ?;', ['Endpoint 1']); + }); + + it('indicates that Unknown does not exist', async () => { + connection.query.mockResolvedValue([[], []]); + await expect(index.hasEndpoint('Endpoint 1')).resolves.toEqual(false); + expect(connection.query).toBeCalledWith('SELECT * FROM `endpoints` WHERE name = ?;', ['Endpoint 1']); + }); + }); + + describe('addEndpoint', () => { + it('adds a new Endpoint', async () => { + const endpoint: AASEndpoint = { + name: 'Endpoint 1', + url: 'http://endpoint1.com', + type: 'AAS_API', + }; + + await expect(index.addEndpoint(endpoint)).resolves.toEqual(void 0); + expect(connection.query).toHaveBeenLastCalledWith( + 'INSERT INTO `endpoints` (name, url, type, version, headers) VALUES (?, ?, ?, ?, ?);', + [endpoint.name, endpoint.url, endpoint.type, undefined, undefined], + ); + }); + }); + + describe('removeEndpoint', () => { + it('removes the specified endpoint', async () => { + // eslint-disable-next-line @typescript-eslint/no-explicit-any + const impl: any = (sql: string): Promise => { + if (sql === 'DELETE FROM `endpoints` WHERE name = ?;') { + return Promise.resolve([ + { + constructor: { name: 'ResultSetHeader' }, + affectedRows: 1, + fieldCount: 0, + info: '', + insertId: 0, + serverStatus: 0, + warningStatus: 0, + changedRows: 0, + }, + ]); + } + + if (sql === 'SELECT * FROM `documents` WHERE endpoint = ?;') { + return Promise.resolve([[{ uuid: 'uuid1' }]]); + } + + if (sql === 'DELETE FROM `documents` WHERE endpoint = ?;') { + return Promise.resolve(); + } + + if (sql === 'DELETE FROM `elements` WHERE uuid = ?;') { + return Promise.resolve(); + } + + return Promise.reject(new Error(`Unexpected sql: ${sql}`)); + }; + + connection.query.mockImplementation(impl); + await expect(index.removeEndpoint('Endpoint 1')).resolves.toEqual(true); + expect(connection.query).toHaveBeenCalledTimes(4); + }); + }); + + describe('getDocuments', () => { + it.todo('gets the first'); + }); + + describe('nextPage', () => { + it('selects the first page', async () => { + const results: MySqlDocument[] = []; + connection.query.mockResolvedValue([results, []]); + await expect(index.nextPage('Endpoint 1', undefined, 10)).resolves.toEqual({ + paging_metadata: { cursor: undefined }, + result: [], + }); + + expect(connection.query).toHaveBeenLastCalledWith( + 'SELECT * FROM `documents` WHERE endpoint = ? ORDER BY id ASC LIMIT ?;', + ['Endpoint 1', 11], + ); + }); + }); + + describe('update', () => { + it.todo('update'); + }); + + describe('add', () => { + it.todo('add'); + }); + + describe('find', () => { + it.todo('find'); + }); + + describe('remove', () => { + it('removes a document from the index', async () => { + // eslint-disable-next-line @typescript-eslint/no-explicit-any + const impl: any = (sql: string): Promise => { + if (sql === 'SELECT uuid FROM `documents` WHERE endpoint = ? AND id = ?;') { + const results: MySqlDocument[] = [ + { + constructor: { name: 'RowDataPacket' }, + uuid: '1', + address: '', + crc32: 0, + idShort: 'Shell 1', + readonly: false, + timestamp: 0, + id: 'http://document1/aas', + endpoint: 'Endpoint 1', + }, + { + constructor: { name: 'RowDataPacket' }, + uuid: '2', + address: '', + crc32: 0, + idShort: 'Shell 2', + readonly: false, + timestamp: 0, + id: 'http://document2/aas', + endpoint: 'Endpoint 1', + }, + ]; + + return Promise.resolve([results]); + } + + if (sql === 'DELETE FROM `elements` WHERE uuid = ?;') { + return Promise.resolve(); + } + + if (sql === 'DELETE FROM `documents` WHERE uuid = ?;') { + return Promise.resolve(); + } + + return Promise.reject(new Error(`Unexpected sql: ${sql}`)); + }; + + connection.query.mockImplementation(impl); + await expect(index.remove('Endpoint 1', 'http://document/aas')).resolves.toEqual(true); + expect(connection.beginTransaction).toHaveBeenCalled(); + expect(connection.commit).toHaveBeenCalled(); + }); + }); + + describe('clear', () => { + it('clears the index', async () => { + connection.query.mockResolvedValue([[], []]); + await expect(index.clear()).resolves.toEqual(void 0); + expect(connection.beginTransaction).toHaveBeenCalled(); + expect(connection.query).toHaveBeenNthCalledWith(1, 'DELETE FROM `elements`;'); + expect(connection.query).toHaveBeenNthCalledWith(2, 'DELETE FROM `documents`;'); + expect(connection.query).toHaveBeenNthCalledWith(3, 'DELETE FROM `endpoints`;'); + expect(connection.commit).toHaveBeenCalled(); + }); + }); + + describe('reset', () => { + it('resets the index', async () => { + connection.query.mockResolvedValue([[], []]); + await expect(index.reset()).resolves.toEqual(void 0); + expect(connection.beginTransaction).toHaveBeenCalled(); + expect(connection.commit).toHaveBeenCalled(); }); }); }); diff --git a/projects/aas-server/src/test/template/template-storage.spec.ts b/projects/aas-server/src/test/template/template-storage.spec.ts index 03c33bb0..635c5f18 100644 --- a/projects/aas-server/src/test/template/template-storage.spec.ts +++ b/projects/aas-server/src/test/template/template-storage.spec.ts @@ -39,6 +39,7 @@ describe('TemplateStorage', function () { const result: ScanTemplatesResult = { taskId: 1, type: ScanResultType.Update, + start: 0, templates: [ { idShort: 'aSubmodel', diff --git a/projects/aasportal-index/schema.sql b/projects/aasportal-index/schema.sql index e4ccffd9..5bf4d17f 100644 --- a/projects/aasportal-index/schema.sql +++ b/projects/aasportal-index/schema.sql @@ -5,7 +5,8 @@ CREATE TABLE endpoints ( url VARCHAR(255) UNIQUE NOT NULL, type VARCHAR(32) NOT NULL, version VARCHAR(8), - headers VARCHAR(255) + headers VARCHAR(255), + schedule VARCHAR(255), ); CREATE TABLE documents ( From b98aa44abb6feab4917e5449fe25b7d63d34990a Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Mon, 4 Nov 2024 16:28:40 +0100 Subject: [PATCH 11/76] fix: in progress --- projects/aas-core/src/lib/types.ts | 4 +++- .../add-endpoint-form.component.html | 21 +++++++++++++------ .../add-endpoint-form.component.ts | 20 +++++++++++++++++- projects/aas-server/src/app/variable.ts | 4 ++-- 4 files changed, 39 insertions(+), 10 deletions(-) diff --git a/projects/aas-core/src/lib/types.ts b/projects/aas-core/src/lib/types.ts index 2a8c5ad1..c62a6b74 100644 --- a/projects/aas-core/src/lib/types.ts +++ b/projects/aas-core/src/lib/types.ts @@ -45,9 +45,11 @@ export type AASAbbreviation = | 'SME' | 'SML'; +export type AASEndpointScheduleType = 'never' | 'once' | 'every' | 'daily' | 'weekly'; + /** The schedule type. */ export interface AASEndpointSchedule { - type: 'never' | 'once' | 'every' | 'daily' | 'weekly'; + type: AASEndpointScheduleType; values?: (string | number)[]; } diff --git a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html index 96aa3e84..9525f128 100644 --- a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html +++ b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html @@ -48,21 +48,30 @@

- +
- +
- +
-
- - + @if (schedule() === 'every') { +
+ + Hours + + Minutes
+ }

Headers
#
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 index b2a17d78..5ce9166e 100644 --- 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 @@ -10,7 +10,7 @@ import { ChangeDetectionStrategy, Component, computed, signal } from '@angular/c import { FormsModule } from '@angular/forms'; import { NgbActiveModal, NgbCollapse, NgbDropdownModule, NgbToast } from '@ng-bootstrap/ng-bootstrap'; import { TranslateModule, TranslateService } from '@ngx-translate/core'; -import { AASEndpoint, AASEndpointType, stringFormat } from 'aas-core'; +import { AASEndpoint, AASEndpointScheduleType, AASEndpointType, stringFormat } from 'aas-core'; export interface HeaderItem { id: string; @@ -75,6 +75,12 @@ export class AddEndpointFormComponent { public readonly selectedItem = computed(() => this._items()[this._selectedItemIndex()]); + public readonly schedule = signal('every'); + + public readonly minutes = signal(0); + + public readonly hours = signal(1); + public readonly headers = this._headers.asReadonly(); public readonly isCollapsed = signal(true); @@ -129,6 +135,18 @@ export class AddEndpointFormComponent { endpoint.version = 'v3'; } + switch (this.schedule()) { + case 'never': + endpoint.schedule = { type: 'never' }; + break; + case 'once': + endpoint.schedule = { type: 'once' }; + break; + default: + endpoint.schedule = { type: 'every', values: [(this.hours() * 60 + this.minutes()) * 60000] }; + break; + } + const headers = this.headers().filter(header => header.name && header.value); if (headers.length > 0) { endpoint.headers = {}; diff --git a/projects/aas-server/src/app/variable.ts b/projects/aas-server/src/app/variable.ts index 35c9cce6..93438822 100644 --- a/projects/aas-server/src/app/variable.ts +++ b/projects/aas-server/src/app/variable.ts @@ -26,11 +26,11 @@ export class Variable { this.ENDPOINTS = process.env.ENDPOINTS ? JSON.parse(process.env.ENDPOINTS) : ['file:///samples?name=Samples']; this.SCAN_TEMPLATES_TIMEOUT = process.env.SCAN_TEMPLATES_TIMEOUT ? Number(process.env.SCAN_TEMPLATES_TIMEOUT) - : 300000; + : 3600000; this.SCAN_ENDPOINT_TIMEOUT = process.env.SCAN_ENDPOINT_TIMEOUT ? Number(process.env.SCAN_ENDPOINT_TIMEOUT) - : 5000; + : 3600000; this.HTTPS_CERT_FILE = process.env.HTTPS_CERT_FILE; this.HTTPS_KEY_FILE = process.env.HTTPS_KEY_FILE; From 7040ece3d022df10cb1eb362f33b4d88a3a12ae0 Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Tue, 5 Nov 2024 06:48:26 +0100 Subject: [PATCH 12/76] fix: AddEndpointForm update --- .vscode/launch.json | 2 +- .../add-endpoint-form.component.html | 12 ++++++------ projects/aas-portal/src/assets/i18n/de-de.json | 4 +++- projects/aas-portal/src/assets/i18n/en-us.json | 4 +++- .../src/app/aas-provider/aas-provider.ts | 3 --- projects/aas-server/src/app/configuration.ts | 14 +++++++++++++- 6 files changed, 26 insertions(+), 13 deletions(-) diff --git a/.vscode/launch.json b/.vscode/launch.json index 22ddce69..abee2a30 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -6,7 +6,7 @@ "type": "chrome", "request": "launch", "preLaunchTask": "start", - "url": "http://localhost:4200/", + "url": "http://127.0.0.1:4200/", "webRoot": "${workspaceFolder}" }, { diff --git a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html index 9525f128..c00578c0 100644 --- a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html +++ b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html @@ -64,12 +64,12 @@

@if (schedule() === 'every') {
- - Hours - - Minutes + + AddEndpointForm.HOURS + + AddEndpointForm.MINUTES
}
diff --git a/projects/aas-portal/src/assets/i18n/de-de.json b/projects/aas-portal/src/assets/i18n/de-de.json index 66ab259d..ae564dd9 100644 --- a/projects/aas-portal/src/assets/i18n/de-de.json +++ b/projects/aas-portal/src/assets/i18n/de-de.json @@ -186,7 +186,9 @@ "PLACEHOLDER_URL_HTTP": "http(s)://", "PLACEHOLDER_URL_OPCUA": "opc.tcp://", "PLACEHOLDER_URL_WEBDAV": "http(s)://", - "ADVANCED_SETTINGS": "Erweiterte Einstellungen" + "ADVANCED_SETTINGS": "Erweiterte Einstellungen", + "MINUTES": "Minuten", + "HOURS": "Stunden" }, "CustomerFeedback": { "OverallRating": "Gesamtbewertung", diff --git a/projects/aas-portal/src/assets/i18n/en-us.json b/projects/aas-portal/src/assets/i18n/en-us.json index 648c73a9..d77ec306 100644 --- a/projects/aas-portal/src/assets/i18n/en-us.json +++ b/projects/aas-portal/src/assets/i18n/en-us.json @@ -187,7 +187,9 @@ "PLACEHOLDER_URL_HTTP": "http(s)://", "PLACEHOLDER_URL_OPCUA": "opc.tcp://", "PLACEHOLDER_URL_WEBDAV": "http(s)://", - "ADVANCED_SETTINGS": "Advanced settings" + "ADVANCED_SETTINGS": "Advanced settings", + "MINUTES": "Minutes", + "HOURS": "Hours" }, "CustomerFeedback": { "OverallRating": "Overall rating", diff --git a/projects/aas-server/src/app/aas-provider/aas-provider.ts b/projects/aas-server/src/app/aas-provider/aas-provider.ts index 97da1412..f5681424 100644 --- a/projects/aas-server/src/app/aas-provider/aas-provider.ts +++ b/projects/aas-server/src/app/aas-provider/aas-provider.ts @@ -23,7 +23,6 @@ import { getChildren, isReferenceElement, AASEndpointSchedule, - noop, } from 'aas-core'; import { ImageProcessing } from '../image-processing.js'; @@ -487,8 +486,6 @@ export class AASProvider { const timeout = Date.now() - start - values[0]; return timeout >= 0 ? timeout : values[0]; } - } else if (schedule.type === 'daily' || ) { - noop(); } return this.variable.SCAN_ENDPOINT_TIMEOUT; diff --git a/projects/aas-server/src/app/configuration.ts b/projects/aas-server/src/app/configuration.ts index f63ad711..00badce6 100644 --- a/projects/aas-server/src/app/configuration.ts +++ b/projects/aas-server/src/app/configuration.ts @@ -7,6 +7,7 @@ *****************************************************************************/ import { AASEndpoint, getEndpointName, getEndpointType } from 'aas-core'; +import { decodeBase64Url } from './convert.js'; /** The AAS Server configuration. */ export interface AASServerConfiguration { @@ -23,9 +24,20 @@ export function urlToEndpoint(url: string | URL): AASEndpoint { const name = getEndpointName(value); const type = getEndpointType(value); const version = value.searchParams.get('version') ?? 'v3'; + const schedule = value.searchParams.get('schedule'); + const headers = value.searchParams.get('headers'); value.search = ''; value.hash = ''; - return { url: value.href.split('?')[0], name: name, type, version }; + const endpoint: AASEndpoint = { url: value.href.split('?')[0], name: name, type, version }; + if (schedule) { + endpoint.schedule = JSON.parse(decodeBase64Url(schedule)); + } + + if (headers) { + endpoint.headers = JSON.parse(decodeBase64Url(headers)); + } + + return endpoint; } From b0270112fe29aaef896dc84f4b1bd3b0cbdcabe7 Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Thu, 7 Nov 2024 19:54:56 +0100 Subject: [PATCH 13/76] fix: update and bug fixing --- .vscode/launch.json | 4 +- .../aas-lib/src/lib/index-change.service.ts | 74 +++++++++---------- .../src/app/main/main.component.html | 4 +- .../aas-portal/src/app/main/main.component.ts | 2 - .../src/app/start/favorites.service.ts | 17 ++--- .../src/app/start/start-api.service.ts | 4 +- .../src/app/start/start.component.ts | 2 +- .../aas-portal/src/assets/i18n/de-de.json | 4 + .../aas-portal/src/assets/i18n/en-us.json | 4 + .../src/test/main/main.component.spec.ts | 12 ++- .../aas-server/src/app/aas-index/aas-index.ts | 2 + .../src/app/aas-index/lowdb/lowdb-index.ts | 5 ++ .../src/app/aas-index/mysql/mysql-index.ts | 26 +++++-- .../src/app/aas-index/mysql/mysql-types.ts | 2 +- .../src/app/aas-provider/aas-provider.ts | 52 +++++++------ .../src/app/aas-provider/parallel.ts | 6 +- .../src/app/aas-provider/scan-result.ts | 5 +- .../app/controller/documents-controller.ts | 21 +++--- .../app/controller/endpoints-controller.ts | 42 ++++++++++- projects/aas-server/src/app/endpoint-scan.ts | 11 ++- .../src/app/packages/xml-reader-v3.ts | 4 +- .../src/app/template/template-scan.ts | 12 ++- .../src/app/template/template-storage.ts | 4 +- projects/aas-server/src/app/worker-app.ts | 5 +- .../test/aas-index/mysql/mysql-index.spec.ts | 4 +- .../controller/documents-controller.spec.ts | 4 +- .../test/template/template-storage.spec.ts | 5 +- projects/aasportal-index/schema.sql | 2 +- 28 files changed, 210 insertions(+), 129 deletions(-) diff --git a/.vscode/launch.json b/.vscode/launch.json index abee2a30..5642e427 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -6,7 +6,7 @@ "type": "chrome", "request": "launch", "preLaunchTask": "start", - "url": "http://127.0.0.1:4200/", + "url": "http://localhost:4200/", "webRoot": "${workspaceFolder}" }, { @@ -32,7 +32,7 @@ "ENDPOINTS": "[\"file:///endpoints/samples?name=Samples\"]", // "USER_STORAGE": "mongodb://aas-server:bObXJWW6e8Nh78YF@localhost:27017/aasportal-users", // "TEMPLATE_STORAGE": "http://aas-server:5w0vmrkzrwDIDyZs@localhost:8080/templates", - // "AAS_INDEX": "mysql://aas-server:60PYRe6Vd8C99u4n@localhost:3306", + "AAS_INDEX": "mysql://aas-server:60PYRe6Vd8C99u4n@localhost:3306", } }, { diff --git a/projects/aas-lib/src/lib/index-change.service.ts b/projects/aas-lib/src/lib/index-change.service.ts index d0c67221..3c02c789 100644 --- a/projects/aas-lib/src/lib/index-change.service.ts +++ b/projects/aas-lib/src/lib/index-change.service.ts @@ -7,17 +7,16 @@ *****************************************************************************/ import { computed, EventEmitter, Injectable, signal } from '@angular/core'; -import { WebSocketData, AASServerMessage } from 'aas-core'; +import { TranslateService } from '@ngx-translate/core'; import { WebSocketSubject } from 'rxjs/webSocket'; +import { WebSocketData, AASServerMessage } from 'aas-core'; import { WebSocketFactoryService } from './web-socket-factory.service'; -import { NotifyService } from '../public-api'; +import { HttpClient } from '@angular/common/http'; interface State { - addedDocuments: number; + documentCount: number; + endpointCount: number; changedDocuments: number; - removedDocuments: number; - addedEndpoints: number; - removedEndpoints: number; } @Injectable({ @@ -26,52 +25,51 @@ interface State { export class IndexChangeService { private webSocketSubject?: WebSocketSubject; private readonly state = signal({ - addedDocuments: 0, + documentCount: 0, + endpointCount: 0, changedDocuments: 0, - removedDocuments: 0, - addedEndpoints: 0, - removedEndpoints: 0, }); public constructor( + private readonly http: HttpClient, private readonly webSocketFactory: WebSocketFactoryService, - private readonly notify: NotifyService, + private readonly translate: TranslateService, ) { this.subscribeIndexChanged(); + + this.http.get<{ count: number }>('/api/v1/endpoints/count').subscribe({ + next: result => { + this.state.update(state => ({ ...state, endpointCount: result.count })); + }, + error: error => { + console.debug(error); + }, + }); + + this.http + .get<{ count: number }>('/api/v1/documents/count') + .subscribe(result => this.state.update(state => ({ ...state, documentCount: result.count }))); } public readonly reset = new EventEmitter(); - public readonly count = computed(() => { - const state = this.state(); - return ( - state.addedDocuments + - state.addedEndpoints + - state.changedDocuments + - state.removedDocuments + - state.removedEndpoints - ); - }); - public readonly summary = computed(() => { const state = this.state(); - return `+${state.addedDocuments}/${state.changedDocuments}/-${state.removedDocuments}; +${state.addedEndpoints}/-${state.removedEndpoints}`; + if (state.changedDocuments === 0) { + return `${state.documentCount} ${this.translate.instant('IndexChangeService.SHELLS')} / ${state.endpointCount} ${this.translate.instant('IndexChangeService.ENDPOINTS')}`; + } + + return `${state.documentCount} ${this.translate.instant('IndexChangeService.SHELLS')} (${state.changedDocuments}) / ${state.endpointCount} ${this.translate.instant('IndexChangeService.ENDPOINTS')}`; }); - public readonly addedDocuments = computed(() => this.state().addedDocuments); - public readonly addedEndpoints = computed(() => this.state().addedEndpoints); + public readonly documentCount = computed(() => this.state().documentCount); + + public readonly endpointCount = computed(() => this.state().endpointCount); + public readonly changedDocuments = computed(() => this.state().changedDocuments); - public readonly removedDocuments = computed(() => this.state().removedDocuments); - public readonly removedEndpoints = computed(() => this.state().removedEndpoints); public clear(): void { - this.state.set({ - addedDocuments: 0, - changedDocuments: 0, - removedDocuments: 0, - addedEndpoints: 0, - removedEndpoints: 0, - }); + this.state.update(state => ({ ...state, changedDocuments: 0 })); } private subscribeIndexChanged = (): void => { @@ -121,11 +119,11 @@ export class IndexChangeService { } private documentAdded(): void { - this.state.update(state => ({ ...state, addedDocuments: state.addedDocuments + 1 })); + this.state.update(state => ({ ...state, addedDocuments: state.documentCount + 1 })); } private documentRemoved(): void { - this.state.update(state => ({ ...state, removedDocuments: state.removedDocuments + 1 })); + this.state.update(state => ({ ...state, removedDocuments: state.documentCount - 1 })); } private documentUpdate(): void { @@ -133,10 +131,10 @@ export class IndexChangeService { } private endpointAdded(): void { - this.state.update(state => ({ ...state, addedEndpoints: state.addedEndpoints + 1 })); + this.state.update(state => ({ ...state, addedEndpoints: state.endpointCount + 1 })); } private endpointRemoved(): void { - this.state.update(state => ({ ...state, removedEndpoints: state.removedEndpoints + 1 })); + this.state.update(state => ({ ...state, removedEndpoints: state.endpointCount - 1 })); } } diff --git a/projects/aas-portal/src/app/main/main.component.html b/projects/aas-portal/src/app/main/main.component.html index 4fcfff6b..b592bd07 100644 --- a/projects/aas-portal/src/app/main/main.component.html +++ b/projects/aas-portal/src/app/main/main.component.html @@ -45,10 +45,8 @@
© 2024 Fraunhofer IOSB-INA - AASPortal (v{{version()}})
- @if (count() > 0) { - {{summary()}} - }
diff --git a/projects/aas-portal/src/app/main/main.component.ts b/projects/aas-portal/src/app/main/main.component.ts index 851a30e4..2862e06d 100644 --- a/projects/aas-portal/src/app/main/main.component.ts +++ b/projects/aas-portal/src/app/main/main.component.ts @@ -95,8 +95,6 @@ export class MainComponent implements OnInit { public readonly version = signal(environment.version).asReadonly(); - public readonly count = this.indexChange.count; - public readonly summary = this.indexChange.summary; public ngOnInit(): void { diff --git a/projects/aas-portal/src/app/start/favorites.service.ts b/projects/aas-portal/src/app/start/favorites.service.ts index 8e3784da..c13c8397 100644 --- a/projects/aas-portal/src/app/start/favorites.service.ts +++ b/projects/aas-portal/src/app/start/favorites.service.ts @@ -27,10 +27,11 @@ export class FavoritesService { .pipe( first(ready => ready === true), mergeMap(() => this.auth.getCookie('.Favorites')), + map(value => { + this._lists.set(value ? (JSON.parse(value) as FavoritesList[]) : []); + }), ) - .subscribe(value => { - this._lists.set(value ? (JSON.parse(value) as FavoritesList[]) : []); - }); + .subscribe(); } public readonly lists = this._lists.asReadonly(); @@ -44,8 +45,7 @@ export class FavoritesService { } public add(documents: AASDocument[], name: string, newName?: string): Observable { - return of(this._lists).pipe( - map(lists => [...lists()]), + return of(this._lists()).pipe( map(lists => { const i = lists.findIndex(list => list.name === name); let list: FavoritesList; @@ -80,8 +80,7 @@ export class FavoritesService { } public remove(documents: AASDocument[], name: string): Observable { - return of(this._lists).pipe( - map(lists => [...lists()]), + return of(this._lists()).pipe( map(lists => { const i = lists.findIndex(list => list.name === name); if (i < 0) { @@ -108,8 +107,8 @@ export class FavoritesService { } public delete(name: string): Observable { - return of(this._lists).pipe( - map(lists => lists().filter(list => list.name !== name)), + return of(this._lists()).pipe( + map(lists => lists.filter(list => list.name !== name)), mergeMap(lists => { return ( lists.length > 0 diff --git a/projects/aas-portal/src/app/start/start-api.service.ts b/projects/aas-portal/src/app/start/start-api.service.ts index 54954426..843be450 100644 --- a/projects/aas-portal/src/app/start/start-api.service.ts +++ b/projects/aas-portal/src/app/start/start-api.service.ts @@ -32,7 +32,7 @@ export class StartApiService { * @param endpoint The AAS container endpoint. */ public addEndpoint(endpoint: AASEndpoint): Observable { - return this.http.post(`/api/v1/endpoints/${endpoint.name}`, endpoint); + return this.http.post(`/api/v1/endpoints/${encodeBase64Url(endpoint.name)}`, endpoint); } /** @@ -40,7 +40,7 @@ export class StartApiService { * @param name The name of the endpoint. */ public removeEndpoint(name: string): Observable { - return this.http.delete(`/api/v1/endpoints/${name}`); + return this.http.delete(`/api/v1/endpoints/${encodeBase64Url(name)}`); } /** Restores the default AAS endpoint configuration. */ diff --git a/projects/aas-portal/src/app/start/start.component.ts b/projects/aas-portal/src/app/start/start.component.ts index d6b51b93..2c371555 100644 --- a/projects/aas-portal/src/app/start/start.component.ts +++ b/projects/aas-portal/src/app/start/start.component.ts @@ -240,7 +240,7 @@ export class StartComponent implements OnDestroy, AfterViewInit { return of(this.activeFavorites()).pipe( mergeMap(activeFavorites => { if (activeFavorites) { - this.favorites.remove(this.selected(), activeFavorites); + this.favorites.remove(this.selected(), activeFavorites).subscribe(); this.store.removeFavorites([...this.selected()]); return of(void 0); } else { diff --git a/projects/aas-portal/src/assets/i18n/de-de.json b/projects/aas-portal/src/assets/i18n/de-de.json index ae564dd9..0d4c7912 100644 --- a/projects/aas-portal/src/assets/i18n/de-de.json +++ b/projects/aas-portal/src/assets/i18n/de-de.json @@ -214,5 +214,9 @@ "MODEL_TYPE_EXPECTED": "Modelltypabkürzung an Position {0} erwartet.", "TERM_EXPECTED": "Term erwartet an Position {0}.", "UNEXPECTED_CLOSING_BRACKET": "Unerwartete schließende Klammer an Position ${0}." + }, + "IndexChangeService": { + "ENDPOINTS": "Endpunkte", + "SHELLS": "Verwaltungsschalen" } } \ No newline at end of file diff --git a/projects/aas-portal/src/assets/i18n/en-us.json b/projects/aas-portal/src/assets/i18n/en-us.json index d77ec306..fc18c5bd 100644 --- a/projects/aas-portal/src/assets/i18n/en-us.json +++ b/projects/aas-portal/src/assets/i18n/en-us.json @@ -215,5 +215,9 @@ "MODEL_TYPE_EXPECTED": "Model type abbreviation expected at position {0}.", "TERM_EXPECTED": "Term expected at position {0}.", "UNEXPECTED_CLOSING_BRACKET": "Unexpected closing bracket at position ${0}." + }, + "IndexChangeService": { + "ENDPOINTS": "Endpoints", + "SHELLS": "Shells" } } diff --git a/projects/aas-portal/src/test/main/main.component.spec.ts b/projects/aas-portal/src/test/main/main.component.spec.ts index ef09d9e2..4dfff6e7 100644 --- a/projects/aas-portal/src/test/main/main.component.spec.ts +++ b/projects/aas-portal/src/test/main/main.component.spec.ts @@ -7,16 +7,16 @@ *****************************************************************************/ import { ComponentFixture, TestBed } from '@angular/core/testing'; +import { Component, input, Signal, signal } from '@angular/core'; import { TranslateFakeLoader, TranslateLoader, TranslateModule } from '@ngx-translate/core'; import { provideRouter } from '@angular/router'; import { Subject } from 'rxjs'; import { AASDocument } from 'aas-core'; -import { AuthComponent, LocalizeComponent, NotifyComponent, WindowService } from 'aas-lib'; +import { AuthComponent, IndexChangeService, LocalizeComponent, NotifyComponent, WindowService } from 'aas-lib'; import { MainComponent } from '../../app/main/main.component'; import { MainApiService } from '../../app/main/main-api.service'; import { ToolbarService } from '../../app/toolbar.service'; -import { Component, input, signal } from '@angular/core'; @Component({ selector: 'fhg-auth', @@ -48,6 +48,7 @@ describe('MainComponent', () => { let api: jasmine.SpyObj; let window: jasmine.SpyObj; let toolbar: jasmine.SpyObj; + let indexChange: jasmine.SpyObj; beforeEach(() => { documentSubject = new Subject(); @@ -56,6 +57,9 @@ describe('MainComponent', () => { window = jasmine.createSpyObj(['getQueryParams']); window.getQueryParams.and.returnValue(new URLSearchParams()); toolbar = jasmine.createSpyObj(['set', 'clear'], { toolbarTemplate: signal(null) }); + indexChange = jasmine.createSpyObj(['clear'], { + summary: (() => 'Hallo') as Signal, + }); TestBed.configureTestingModule({ providers: [ @@ -71,6 +75,10 @@ describe('MainComponent', () => { provide: ToolbarService, useValue: toolbar, }, + { + provide: IndexChangeService, + useValue: indexChange, + }, provideRouter([]), ], imports: [ diff --git a/projects/aas-server/src/app/aas-index/aas-index.ts b/projects/aas-server/src/app/aas-index/aas-index.ts index d345219a..0012420d 100644 --- a/projects/aas-server/src/app/aas-index/aas-index.ts +++ b/projects/aas-server/src/app/aas-index/aas-index.ts @@ -32,6 +32,8 @@ export abstract class AASIndex { public abstract getEndpoints(): Promise; + public abstract getEndpointCount(): Promise; + public abstract getEndpoint(name: string): Promise; public abstract hasEndpoint(name: string): Promise; diff --git a/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts b/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts index 02c2a5ff..8588359b 100644 --- a/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts +++ b/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts @@ -68,6 +68,11 @@ export class LowDbIndex extends AASIndex { return this.db.data.endpoints; } + public override async getEndpointCount(): Promise { + await this.promise; + return this.db.data.endpoints.length; + } + public override async getEndpoint(name: string): Promise { await this.promise; const endpoint = this.db.data.endpoints.find(endpoint => endpoint.name === name); diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts index 3646c612..f5ce28b0 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts @@ -57,16 +57,26 @@ export class MySqlIndex extends AASIndex { public override async getCount(endpoint?: string): Promise { if (endpoint === undefined) { - return ( - await (await this.connection).query('SELECT COUNT(*) FROM `documents` AS count;') - )[0][0].count; + const result = await ( + await this.connection + ).query('SELECT COUNT(*) FROM `documents` AS count;'); + + return result[0][0]['COUNT(*)']; } - return ( - await ( - await this.connection - ).query('SELECT COUNT(*) FROM `documents` WHERE endpoint = ? AS count;', [endpoint]) - )[0][0].count; + const result = await ( + await this.connection + ).query('SELECT COUNT(*) FROM `documents` WHERE endpoint = ? AS count;', [endpoint]); + + return result[0][0]['COUNT(*)']; + } + + public override async getEndpointCount(): Promise { + const result = await ( + await this.connection + ).query('SELECT COUNT(*) FROM `endpoints` AS count;'); + + return result[0][0]['COUNT(*)']; } public override async getEndpoints(): Promise { diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts index 7641a627..03261e91 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts @@ -34,5 +34,5 @@ export interface MySqlElement extends RowDataPacket { } export interface DocumentCount extends RowDataPacket { - count: number; + 'COUNT(*)': number; } diff --git a/projects/aas-server/src/app/aas-provider/aas-provider.ts b/projects/aas-server/src/app/aas-provider/aas-provider.ts index f5681424..d924a37f 100644 --- a/projects/aas-server/src/app/aas-provider/aas-provider.ts +++ b/projects/aas-server/src/app/aas-provider/aas-provider.ts @@ -27,7 +27,7 @@ import { import { ImageProcessing } from '../image-processing.js'; import { AASIndex } from '../aas-index/aas-index.js'; -import { ScanResultType, ScanResult, ScanEndpointResult } from './scan-result.js'; +import { ScanResultKind, ScanResult, ScanEndpointResult } from './scan-result.js'; import { Logger } from '../logging/logger.js'; import { Parallel } from './parallel.js'; import { ScanEndpointData } from './worker-data.js'; @@ -78,6 +78,13 @@ export class AASProvider { return this.index.getEndpoints(); } + /** + * Gets the number of registered AAS endpoints. + */ + public getEndpointCount(): Promise { + return this.index.getEndpointCount(); + } + /** * Gets a page of documents from the specified cursor. * @param cursor The cursor. @@ -95,12 +102,12 @@ export class AASProvider { } /** - * The total count of AAS documents. - * @param filter A filter expression. + * The total count of AAS documents over all endpoints or a specified endpoint. + * @param endpoint The endpoint name. * @returns The total count of documents. */ - public getDocumentCountAsync(filter?: string): Promise { - return this.index.getCount(filter); + public getCountAsync(endpoint?: string): Promise { + return this.index.getCount(endpoint); } /** @@ -462,12 +469,7 @@ export class AASProvider { continue; } - setTimeout( - this.scanEndpoint, - this.computeTimeout(endpoint.schedule), - this.taskHandler.createTaskId(), - endpoint, - ); + setTimeout(this.scanEndpoint, 0, this.taskHandler.createTaskId(), endpoint); } } catch (error) { this.logger.error(error); @@ -503,24 +505,30 @@ export class AASProvider { this.parallel.execute(data); }; - private parallelOnMessage = async (result: ScanEndpointResult) => { + private parallelOnMessage = async (result: ScanResult) => { try { - switch (result.type) { - case ScanResultType.Update: - await this.onUpdate(result); - break; - case ScanResultType.Add: - await this.onAdded(result); - break; - case ScanResultType.Remove: - await this.onRemoved(result); - break; + if (this.isScanEndpointResult(result)) { + switch (result.kind) { + case ScanResultKind.Update: + await this.onUpdate(result); + break; + case ScanResultKind.Add: + await this.onAdded(result); + break; + case ScanResultKind.Remove: + await this.onRemoved(result); + break; + } } } catch (error) { this.logger.error(error); } }; + private isScanEndpointResult(result: ScanResult): result is ScanEndpointResult { + return result.type === 'ScanEndpointResult'; + } + private parallelOnEnd = async (result: ScanResult) => { const task = this.taskHandler.get(result.taskId); if (!task || task.owner !== this) { diff --git a/projects/aas-server/src/app/aas-provider/parallel.ts b/projects/aas-server/src/app/aas-provider/parallel.ts index eefa940a..64f574bb 100644 --- a/projects/aas-server/src/app/aas-provider/parallel.ts +++ b/projects/aas-server/src/app/aas-provider/parallel.ts @@ -13,7 +13,7 @@ import fs from 'fs'; import path from 'path/posix'; import { noop } from 'aas-core'; -import { ScanResultType, ScanResult } from './scan-result.js'; +import { ScanResultKind, ScanResult } from './scan-result.js'; import { WorkerData } from './worker-data.js'; import { Logger } from '../logging/logger.js'; import { Variable } from '../variable.js'; @@ -53,8 +53,8 @@ class WorkerTask extends EventEmitter { private workerOnMessage = (value: Uint8Array) => { const result: ScanResult = JSON.parse(Buffer.from(value).toString()); - switch (result.type) { - case ScanResultType.End: + switch (result.kind) { + case ScanResultKind.End: this.emit('end', result, this); break; default: diff --git a/projects/aas-server/src/app/aas-provider/scan-result.ts b/projects/aas-server/src/app/aas-provider/scan-result.ts index d77abd00..d9a69cc8 100644 --- a/projects/aas-server/src/app/aas-provider/scan-result.ts +++ b/projects/aas-server/src/app/aas-provider/scan-result.ts @@ -8,7 +8,7 @@ import { AASDocument, Message, TemplateDescriptor, AASEndpoint } from 'aas-core'; -export enum ScanResultType { +export enum ScanResultKind { Add, Remove, Update, @@ -17,7 +17,8 @@ export enum ScanResultType { /** The result of an endpoint scan. */ export interface ScanResult { - type: ScanResultType; + type: 'ScanEndResult' | 'ScanEndpointResult' | 'ScanTemplatesResult'; + kind: ScanResultKind; taskId: number; start: number; messages?: Message[]; diff --git a/projects/aas-server/src/app/controller/documents-controller.ts b/projects/aas-server/src/app/controller/documents-controller.ts index fbb3dfb8..c9b10c20 100644 --- a/projects/aas-server/src/app/controller/documents-controller.ts +++ b/projects/aas-server/src/app/controller/documents-controller.ts @@ -7,7 +7,7 @@ *****************************************************************************/ import { inject, injectable } from 'tsyringe'; -import { Get, OperationId, Query, Route, Security, Tags } from 'tsoa'; +import { Get, OperationId, Path, Query, Route, Security, Tags } from 'tsoa'; import { Logger } from '../logging/logger.js'; import { AASController } from './aas-controller.js'; import { AuthService } from '../auth/auth-service.js'; @@ -55,17 +55,18 @@ export class DocumentsController extends AASController { } } + /** + * The total count of AAS documents over all endpoints or a specified endpoint. + * @param endpoint The endpoint name or `undefined`. + * @returns The total number of AAS documents. + */ @Get('count') @Security('bearerAuth', ['guest']) - @OperationId('getDocumentCount') - public async getDocumentCount(@Query() filter?: string): Promise { + @OperationId('getCount') + public async getCount(): Promise<{ count: number }> { try { - this.logger.start('getDocuments'); - if (filter) { - filter = decodeBase64Url(filter); - } - - return await this.aasProvider.getDocumentCountAsync(filter); + this.logger.start('getCount'); + return { count: await this.aasProvider.getCountAsync() }; } finally { this.logger.stop(); } @@ -79,7 +80,7 @@ export class DocumentsController extends AASController { @Get('{id}') @Security('bearerAuth', ['guest']) @OperationId('getDocument') - public async getDocument(id: string): Promise { + public async getDocument(@Path() id: string): Promise { try { this.logger.start('getDocument'); return await this.aasProvider.getDocumentAsync(decodeBase64Url(id)); diff --git a/projects/aas-server/src/app/controller/endpoints-controller.ts b/projects/aas-server/src/app/controller/endpoints-controller.ts index 36b0ee28..ff1114e9 100644 --- a/projects/aas-server/src/app/controller/endpoints-controller.ts +++ b/projects/aas-server/src/app/controller/endpoints-controller.ts @@ -15,6 +15,7 @@ import { AuthService } from '../auth/auth-service.js'; import { Logger } from '../logging/logger.js'; import { AASController } from './aas-controller.js'; import { Variable } from '../variable.js'; +import { decodeBase64Url } from '../convert.js'; @injectable() @Route('/api/v1/endpoints') @@ -38,13 +39,46 @@ export class EndpointsController extends AASController { @OperationId('getEndpoints') public async getEndpoints(): Promise { try { - this.logger.start('getWorkspaces'); + this.logger.start('getEndpoints'); return await this.aasProvider.getEndpoints(); } finally { this.logger.stop(); } } + /** + * Gets the number of registered endpoints. + * @returns The number of registered endpoints. + */ + @Get('count') + @Security('bearerAuth', ['guest']) + @OperationId('getCount') + public async getCount(): Promise<{ count: number }> { + try { + this.logger.start('getEndpointCount'); + return { count: await this.aasProvider.getEndpointCount() }; + } finally { + this.logger.stop(); + } + } + + /** + * The total count of AAS documents of the specified endpoint. + * @param endpoint The endpoint name or `undefined`. + * @returns The total number of AAS documents. + */ + @Get('{name}/documents/count') + @Security('bearerAuth', ['guest']) + @OperationId('getEndpointCount') + public async getEndpointCount(@Path() name: string): Promise<{ count: number }> { + try { + this.logger.start('getCount'); + return { count: await this.aasProvider.getCountAsync(decodeBase64Url(name)) }; + } finally { + this.logger.stop(); + } + } + /** * @summary Adds a new endpoint to the AASServer container configuration. * @param name The endpoint name. @@ -56,7 +90,7 @@ export class EndpointsController extends AASController { public addEndpoint(@Path() name: string, @Body() endpoint: AASEndpoint): Promise { try { this.logger.start('addEndpoint'); - return this.aasProvider.addEndpointAsync(name, endpoint); + return this.aasProvider.addEndpointAsync(decodeBase64Url(name), endpoint); } finally { this.logger.stop(); } @@ -71,8 +105,8 @@ export class EndpointsController extends AASController { @OperationId('deleteEndpoint') public deleteEndpoint(@Path() name: string): Promise { try { - this.logger.start('deleteEndpoint'); - return this.aasProvider.removeEndpointAsync(name); + this.logger.start('removeEndpoint'); + return this.aasProvider.removeEndpointAsync(decodeBase64Url(name)); } finally { this.logger.stop(); } diff --git a/projects/aas-server/src/app/endpoint-scan.ts b/projects/aas-server/src/app/endpoint-scan.ts index 5507f4f7..15ec37b1 100644 --- a/projects/aas-server/src/app/endpoint-scan.ts +++ b/projects/aas-server/src/app/endpoint-scan.ts @@ -11,7 +11,7 @@ import { parentPort } from 'worker_threads'; import { Logger } from './logging/logger.js'; import { AASDocument } from 'aas-core'; import { ScanEndpointData } from './aas-provider/worker-data.js'; -import { ScanEndpointResult, ScanResultType } from './aas-provider/scan-result.js'; +import { ScanEndpointResult, ScanResultKind } from './aas-provider/scan-result.js'; import { toUint8Array } from './convert.js'; import { AASResourceScanFactory } from './aas-provider/aas-resource-scan-factory.js'; import { Variable } from './variable.js'; @@ -57,8 +57,9 @@ export class EndpointScan { private postUpdate(document: AASDocument): void { const value: ScanEndpointResult = { + type: 'ScanEndpointResult', taskId: this.data.taskId, - type: ScanResultType.Update, + kind: ScanResultKind.Update, endpoint: this.data.endpoint, document: document, start: this.data.start, @@ -70,8 +71,9 @@ export class EndpointScan { private postRemove = (document: AASDocument): void => { const value: ScanEndpointResult = { + type: 'ScanEndpointResult', taskId: this.data.taskId, - type: ScanResultType.Remove, + kind: ScanResultKind.Remove, endpoint: this.data.endpoint, document: document, start: this.data.start, @@ -83,8 +85,9 @@ export class EndpointScan { private postAdd = (document: AASDocument): void => { const value: ScanEndpointResult = { + type: 'ScanEndpointResult', taskId: this.data.taskId, - type: ScanResultType.Add, + kind: ScanResultKind.Add, endpoint: this.data.endpoint, document: document, start: this.data.start, diff --git a/projects/aas-server/src/app/packages/xml-reader-v3.ts b/projects/aas-server/src/app/packages/xml-reader-v3.ts index 5da4daad..e931afe1 100644 --- a/projects/aas-server/src/app/packages/xml-reader-v3.ts +++ b/projects/aas-server/src/app/packages/xml-reader-v3.ts @@ -988,8 +988,8 @@ export class XmlReaderV3 extends AASReader { const values: aas.LangString[] = []; for (const child of this.selectNodes(expression, node)) { values.push({ - language: this.getTextContent('./aas:language', child), - text: this.getTextContent('./aas:text', child), + language: this.getTextContent('./aas:language', child, ''), + text: this.getTextContent('./aas:text', child, ''), }); } diff --git a/projects/aas-server/src/app/template/template-scan.ts b/projects/aas-server/src/app/template/template-scan.ts index fd32ca61..ac32c21c 100644 --- a/projects/aas-server/src/app/template/template-scan.ts +++ b/projects/aas-server/src/app/template/template-scan.ts @@ -17,7 +17,7 @@ import { Variable } from '../variable.js'; import { createJsonReader } from '../packages/create-json-reader.js'; import { createXmlReader } from '../packages/create-xml-reader.js'; import { AasxDirectory } from '../packages/file-system/aasx-directory.js'; -import { ScanResultType, ScanTemplatesResult } from '../aas-provider/scan-result.js'; +import { ScanResultKind, ScanTemplatesResult } from '../aas-provider/scan-result.js'; import { toUint8Array } from '../convert.js'; import { WorkerData } from '../aas-provider/worker-data.js'; @@ -49,8 +49,9 @@ export class TemplateScan { } const value: ScanTemplatesResult = { + type: 'ScanTemplatesResult', taskId: data.taskId, - type: ScanResultType.Update, + kind: ScanResultKind.Update, templates: templates, start: data.start, }; @@ -135,7 +136,12 @@ export class TemplateScan { source = new AasxDirectory(this.logger, this.fileStorage, this.endpoint); await source.openAsync(); const pkg = source.createPackage(file); - const submodel = (await pkg.getEnvironmentAsync()).submodels[0]; + const env = await pkg.getEnvironmentAsync(); + if (env.submodels.length === 0) { + return undefined; + } + + const submodel = env.submodels[0]; return { modelType: submodel.modelType, idShort: submodel.idShort, diff --git a/projects/aas-server/src/app/template/template-storage.ts b/projects/aas-server/src/app/template/template-storage.ts index 80084086..07b80eff 100644 --- a/projects/aas-server/src/app/template/template-storage.ts +++ b/projects/aas-server/src/app/template/template-storage.ts @@ -17,7 +17,7 @@ import { createJsonReader } from '../packages/create-json-reader.js'; import { createXmlReader } from '../packages/create-xml-reader.js'; import { AasxDirectory } from '../packages/file-system/aasx-directory.js'; import { ScanTemplatesData } from '../aas-provider/worker-data.js'; -import { ScanResult, ScanResultType, ScanTemplatesResult } from '../aas-provider/scan-result.js'; +import { ScanResult, ScanTemplatesResult } from '../aas-provider/scan-result.js'; import { Parallel } from '../aas-provider/parallel.js'; import { TaskHandler } from '../aas-provider/task-handler.js'; @@ -135,6 +135,6 @@ export class TemplateStorage { }; private isScanTemplatesResult(result: ScanResult): result is ScanTemplatesResult { - return result.type === ScanResultType.Update; + return result.type === 'ScanTemplatesResult'; } } diff --git a/projects/aas-server/src/app/worker-app.ts b/projects/aas-server/src/app/worker-app.ts index 1d8bcf93..63c920a3 100644 --- a/projects/aas-server/src/app/worker-app.ts +++ b/projects/aas-server/src/app/worker-app.ts @@ -9,7 +9,7 @@ import { inject, singleton } from 'tsyringe'; import { parentPort } from 'worker_threads'; import { Logger } from './logging/logger.js'; -import { ScanResult, ScanResultType } from './aas-provider/scan-result.js'; +import { ScanResult, ScanResultKind } from './aas-provider/scan-result.js'; import { toUint8Array } from './convert.js'; import { EndpointScan } from './endpoint-scan.js'; import { TemplateScan } from './template/template-scan.js'; @@ -49,8 +49,9 @@ export class WorkerApp { private createEndResult(data: WorkerData): ScanResult { return { + type: 'ScanEndResult', taskId: data.taskId, - type: ScanResultType.End, + kind: ScanResultKind.End, start: data.start, messages: this.logger.getMessages(), }; diff --git a/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts b/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts index 7dbdfe6e..bb250a22 100644 --- a/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts +++ b/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts @@ -39,7 +39,7 @@ describe('MySqlIndex', () => { it('returns the total number of documents', async () => { const result: DocumentCount = { constructor: { name: 'RowDataPacket' }, - count: 42, + 'COUNT(*)': 42, }; connection.query.mockResolvedValue([[result], []]); @@ -50,7 +50,7 @@ describe('MySqlIndex', () => { it('returns the total number of documents of the specified Endpoint', async () => { const result: DocumentCount = { constructor: { name: 'RowDataPacket' }, - count: 42, + 'COUNT(*)': 42, }; connection.query.mockResolvedValue([[result], []]); diff --git a/projects/aas-server/src/test/controller/documents-controller.spec.ts b/projects/aas-server/src/test/controller/documents-controller.spec.ts index d9d46a91..d2434742 100644 --- a/projects/aas-server/src/test/controller/documents-controller.spec.ts +++ b/projects/aas-server/src/test/controller/documents-controller.spec.ts @@ -12,7 +12,7 @@ import { describe, beforeEach, it, expect, jest } from '@jest/globals'; import express, { Express, json, urlencoded } from 'express'; import morgan from 'morgan'; import request from 'supertest'; -import { AASCursor, AASPage } from 'aas-core'; +import { AASCursor, AASPagedResult } from 'aas-core'; import { Logger } from '../../app/logging/logger.js'; import { AuthService } from '../../app/auth/auth-service.js'; @@ -90,7 +90,7 @@ describe('DocumentsController', function () { }); it('getDocuments: /api/v1/documents?cursor=&filter=', async function () { - const page: AASPage = { previous: null, documents: [sampleDocument], next: null }; + const page: AASPagedResult = { previous: null, documents: [sampleDocument], next: null }; aasProvider.getDocumentsAsync.mockResolvedValue(page); const cursor = encodeBase64Url(JSON.stringify({ previous: null, limit: 10 } as AASCursor)); const filter = encodeBase64Url('#prop:Name=Value'); diff --git a/projects/aas-server/src/test/template/template-storage.spec.ts b/projects/aas-server/src/test/template/template-storage.spec.ts index 635c5f18..1b55338d 100644 --- a/projects/aas-server/src/test/template/template-storage.spec.ts +++ b/projects/aas-server/src/test/template/template-storage.spec.ts @@ -17,7 +17,7 @@ import { FileStorageProvider } from '../../app/file-storage/file-storage-provide import { Variable } from '../../app/variable.js'; import { TaskHandler } from '../../app/aas-provider/task-handler.js'; import { Parallel } from '../../app/aas-provider/parallel.js'; -import { ScanResultType, ScanTemplatesResult } from '../../app/aas-provider/scan-result.js'; +import { ScanResultKind, ScanTemplatesResult } from '../../app/aas-provider/scan-result.js'; describe('TemplateStorage', function () { let templateStorage: TemplateStorage; @@ -37,8 +37,9 @@ describe('TemplateStorage', function () { parallel.on.mockImplementation((eventName, handler) => { if (eventName === 'message') { const result: ScanTemplatesResult = { + type: 'ScanTemplatesResult', taskId: 1, - type: ScanResultType.Update, + kind: ScanResultKind.Update, start: 0, templates: [ { diff --git a/projects/aasportal-index/schema.sql b/projects/aasportal-index/schema.sql index 5bf4d17f..6b95a995 100644 --- a/projects/aasportal-index/schema.sql +++ b/projects/aasportal-index/schema.sql @@ -6,7 +6,7 @@ CREATE TABLE endpoints ( type VARCHAR(32) NOT NULL, version VARCHAR(8), headers VARCHAR(255), - schedule VARCHAR(255), + schedule VARCHAR(255) ); CREATE TABLE documents ( From 28cdcd9b09119194e80f14e41a58973750ad390a Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Fri, 8 Nov 2024 20:52:39 +0100 Subject: [PATCH 14/76] fix: bug fixing --- .../aas-lib/src/lib/index-change.service.ts | 8 +-- .../add-endpoint-form.component.html | 58 +++++++++---------- .../src/app/start/favorites.service.ts | 4 +- .../src/app/start/start-api.service.ts | 14 ++++- .../src/app/start/start.component.html | 4 +- .../src/app/start/start.component.ts | 8 ++- .../aas-portal/src/app/start/start.store.ts | 12 +++- .../aas-portal/src/assets/i18n/de-de.json | 14 ++++- .../aas-portal/src/assets/i18n/en-us.json | 14 ++++- .../aas-server/src/app/aas-index/aas-index.ts | 2 + .../src/app/aas-index/lowdb/lowdb-index.ts | 11 ++++ .../src/app/aas-index/mysql/mysql-index.ts | 42 ++++++++++---- .../src/app/aas-provider/aas-provider.ts | 16 ++++- .../app/controller/endpoints-controller.ts | 31 +++++++--- 14 files changed, 168 insertions(+), 70 deletions(-) diff --git a/projects/aas-lib/src/lib/index-change.service.ts b/projects/aas-lib/src/lib/index-change.service.ts index 3c02c789..8504d565 100644 --- a/projects/aas-lib/src/lib/index-change.service.ts +++ b/projects/aas-lib/src/lib/index-change.service.ts @@ -119,11 +119,11 @@ export class IndexChangeService { } private documentAdded(): void { - this.state.update(state => ({ ...state, addedDocuments: state.documentCount + 1 })); + this.state.update(state => ({ ...state, documentCount: state.documentCount + 1 })); } private documentRemoved(): void { - this.state.update(state => ({ ...state, removedDocuments: state.documentCount - 1 })); + this.state.update(state => ({ ...state, documentCount: state.documentCount - 1 })); } private documentUpdate(): void { @@ -131,10 +131,10 @@ export class IndexChangeService { } private endpointAdded(): void { - this.state.update(state => ({ ...state, addedEndpoints: state.endpointCount + 1 })); + this.state.update(state => ({ ...state, endpointCount: state.endpointCount + 1 })); } private endpointRemoved(): void { - this.state.update(state => ({ ...state, removedEndpoints: state.endpointCount - 1 })); + this.state.update(state => ({ ...state, endpointCount: state.endpointCount - 1 })); } } diff --git a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html index c00578c0..e68ec699 100644 --- a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html +++ b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html @@ -10,7 +10,7 @@

- CAPTION_ADD_ENDPOINT + AddEndpointForm.CAPTION_ADD_ENDPOINT

@@ -42,44 +42,42 @@

(input)="inputValue()"> @if (selectedItem().type === 'AAS_API') { -
-
- - -
-
- - -
-
- - -
- @if (schedule() === 'every') { -
- - AddEndpointForm.HOURS - - AddEndpointForm.MINUTES + +
+
+ + +
+
+ + +
+ @if (schedule() === 'every') { +
+ + AddEndpointForm.HOURS + + AddEndpointForm.MINUTES +
+ }
- } -
+ +

Headers
- - - + + diff --git a/projects/aas-portal/src/app/start/favorites.service.ts b/projects/aas-portal/src/app/start/favorites.service.ts index c13c8397..26cedb39 100644 --- a/projects/aas-portal/src/app/start/favorites.service.ts +++ b/projects/aas-portal/src/app/start/favorites.service.ts @@ -67,7 +67,7 @@ export class FavoritesService { } } - return lists; + return [...lists]; }), mergeMap(lists => { return this.auth.setCookie('.Favorites', JSON.stringify(lists)).pipe( @@ -94,7 +94,7 @@ export class FavoritesService { lists[i] = list; - return lists; + return [...lists]; }), mergeMap(lists => { return this.auth.setCookie('.Favorites', JSON.stringify(lists)).pipe( diff --git a/projects/aas-portal/src/app/start/start-api.service.ts b/projects/aas-portal/src/app/start/start-api.service.ts index 843be450..5487ec21 100644 --- a/projects/aas-portal/src/app/start/start-api.service.ts +++ b/projects/aas-portal/src/app/start/start-api.service.ts @@ -28,15 +28,23 @@ export class StartApiService { } /** - * Adds a new endpoint to the AASServer configuration. - * @param endpoint The AAS container endpoint. + * Adds a new endpoint. + * @param endpoint The AAS endpoint. */ public addEndpoint(endpoint: AASEndpoint): Observable { return this.http.post(`/api/v1/endpoints/${encodeBase64Url(endpoint.name)}`, endpoint); } /** - * Removes the specified endpoint from the AASServer configuration. + * Updates an existing endpoint. + * @param endpoint The AAS endpoint. + */ + public updateEndpoint(endpoint: AASEndpoint): Observable { + return this.http.put(`/api/v1/endpoints/${encodeBase64Url(endpoint.name)}`, endpoint); + } + + /** + * Removes the specified endpoint. * @param name The name of the endpoint. */ public removeEndpoint(name: string): Observable { diff --git a/projects/aas-portal/src/app/start/start.component.html b/projects/aas-portal/src/app/start/start.component.html index c5d14f8f..df294b50 100644 --- a/projects/aas-portal/src/app/start/start.component.html +++ b/projects/aas-portal/src/app/start/start.component.html @@ -21,7 +21,7 @@ [value]="activeFavorites()" (change)="setActiveFavorites(selectFavorites.value)"> @for (option of favoritesLists(); track option; let i = $index) { @if (i === 0) { - + } @else { } @@ -108,4 +108,4 @@ [placeholder]="'PLACEHOLDER_FILTER' | translate" (change)="setFilter(textInput.value)" (keydown.enter)="textInput.blur()"> - + \ No newline at end of file diff --git a/projects/aas-portal/src/app/start/start.component.ts b/projects/aas-portal/src/app/start/start.component.ts index 2c371555..0e4f191a 100644 --- a/projects/aas-portal/src/app/start/start.component.ts +++ b/projects/aas-portal/src/app/start/start.component.ts @@ -7,6 +7,7 @@ *****************************************************************************/ import { Router } from '@angular/router'; +import { NgClass } from '@angular/common'; import { AfterViewInit, ChangeDetectionStrategy, @@ -45,14 +46,13 @@ import { StartApiService } from './start-api.service'; import { FavoritesService } from './favorites.service'; import { FavoritesFormComponent } from './favorites-form/favorites-form.component'; import { StartStore } from './start.store'; -import { AsyncPipe, NgClass } from '@angular/common'; @Component({ selector: 'fhg-start', templateUrl: './start.component.html', styleUrls: ['./start.component.scss'], standalone: true, - imports: [AASTableComponent, NgClass, AsyncPipe, TranslateModule, NgbModule], + imports: [AASTableComponent, NgClass, TranslateModule, NgbModule], changeDetection: ChangeDetectionStrategy.OnPush, }) export class StartComponent implements OnDestroy, AfterViewInit { @@ -160,7 +160,9 @@ export class StartComponent implements OnDestroy, AfterViewInit { }), mergeMap(modalRef => from>(modalRef.result)), mergeMap(result => { - if (!result) return EMPTY; + if (result === undefined) { + return EMPTY; + } return this.api.addEndpoint(result); }), diff --git a/projects/aas-portal/src/app/start/start.store.ts b/projects/aas-portal/src/app/start/start.store.ts index 2db55b42..ea5c308f 100644 --- a/projects/aas-portal/src/app/start/start.store.ts +++ b/projects/aas-portal/src/app/start/start.store.ts @@ -15,7 +15,6 @@ export class StartStore { private readonly _limit = signal(10); private readonly _previous = signal(null); private readonly _next = signal(null); - private _totalCount = 0; private readonly _documents = signal([], { equal: (a, b) => equalArray(a, b) }); private readonly _activeFavorites = signal(''); @@ -81,16 +80,25 @@ export class StartStore { public setFilter(filter: string): void { this._filterText.set(filter); + if (!this._activeFavorites()) { + this.getFirstPage(); + } } public getFirstPage(filter?: string, limit?: number): void { + if (!filter) { + if (!this._activeFavorites()) { + filter = this._filterText(); + } + } + this.api .getPage( { previous: null, limit: limit ?? this._limit(), }, - filter ?? this._filterText(), + filter, this.translate.currentLang, ) .pipe(mergeMap(page => this.setPageAndLoadContents(page, limit, filter))) diff --git a/projects/aas-portal/src/assets/i18n/de-de.json b/projects/aas-portal/src/assets/i18n/de-de.json index 0d4c7912..3be80f72 100644 --- a/projects/aas-portal/src/assets/i18n/de-de.json +++ b/projects/aas-portal/src/assets/i18n/de-de.json @@ -14,7 +14,6 @@ "CAPTION_CREATE_WORKSPACE": "Gruppieren", "CAPTION_EDIT_WORKSPACE": "Gruppe bearbeiten", "CAPTION_REMOVE_WORKSPACE": "Gruppe löschen", - "CAPTION_ADD_ENDPOINT": "AAS-Endpunkt hinzufügen", "CAPTION_REMOVE_ENDPOINT": "AAS-Endpunkt entfernen", "CAPTION_NEW_ELEMENT": "Neu hinzufügen", "CAPTION_EDIT_ELEMENT": "Bearbeiten", @@ -147,7 +146,6 @@ "ERROR_INVALID_CONTAINER_URL": "'{0}' adressiert eine ungülig oder nicht unterstützte VWS-Ressoure.", "ERROR_FAVORITES_LIST_NAME_USED_SEVERAL_TIMES": "'{0}' ist mehrfach verwendet.", "ERROR_INVALID_EMPTY_FAVORITES_LIST_NAME": "Ungültiger leerer Name.", - "FAVORITES": "Favoriten", "INFO_NEW_PASSWORD_SENT": "Ein neues Passwort wurde an '{0}' gesendet", "INFO_DOWNLOAD_FILE_SUCCESS": "{0} wurde erfolgreich heruntergeladen.", "INFO_UPLOAD_AASX_FILE_SUCCESS": "{0} wurde erfolgreich hochgeladen.", @@ -174,7 +172,11 @@ "OPTION_BAR_HORIZONTAL_CHART": "Balkendiagramm horizontal", "TEXT_ADD_FAVORITE": "1 Favorit hinzufügen ({0}).", "TEXT_ADD_FAVORITES": "{0} Favoriten hinzufügen ({1}).", + "Start": { + "FAVORITES": "Alle Verwaltungsschalen" + }, "AddEndpointForm": { + "CAPTION_ADD_ENDPOINT": "AAS-Endpunkt hinzufügen", "FileSystem": "Dateisystem", "AAS_API": "AAS API", "WebDAV": "WebDAV", @@ -187,8 +189,14 @@ "PLACEHOLDER_URL_OPCUA": "opc.tcp://", "PLACEHOLDER_URL_WEBDAV": "http(s)://", "ADVANCED_SETTINGS": "Erweiterte Einstellungen", + "SCHEDULE": "Endpunkt durchsuchen", + "ONCE": "einmalig", + "EVERY": "zyklisch", "MINUTES": "Minuten", - "HOURS": "Stunden" + "HOURS": "Stunden", + "HEADERS": "HTTP-Header-Felder", + "HEADER": "Feld", + "VALUE": "Wert" }, "CustomerFeedback": { "OverallRating": "Gesamtbewertung", diff --git a/projects/aas-portal/src/assets/i18n/en-us.json b/projects/aas-portal/src/assets/i18n/en-us.json index fc18c5bd..e3a17e17 100644 --- a/projects/aas-portal/src/assets/i18n/en-us.json +++ b/projects/aas-portal/src/assets/i18n/en-us.json @@ -14,7 +14,6 @@ "CAPTION_CREATE_WORKSPACE": "Group", "CAPTION_EDIT_WORKSPACE": "Edit Group", "CAPTION_REMOVE_WORKSPACE": "Remove Group", - "CAPTION_ADD_ENDPOINT": "Add AAS Endpoint", "CAPTION_REMOVE_ENDPOINT": "Remove AAS Endpoint", "CAPTION_NEW_ELEMENT": "Insert New", "CAPTION_EDIT_ELEMENT": "Edit", @@ -149,7 +148,6 @@ "ERROR_INVALID_CONTAINER_URL": "'{0}' addresses an invalid or not supported AAS resource.", "ERROR_FAVORITES_LIST_NAME_USED_SEVERAL_TIMES": "'{0}' is used several times.", "ERROR_INVALID_EMPTY_FAVORITES_LIST_NAME": "Invalid empty name.", - "FAVORITES": "Favorites", "INFO_NEW_PASSWORD_SENT": "A new password was sent to '{0}'.", "INFO_DOWNLOAD_FILE_SUCCESS": "{0} was downloaded successfully.", "INFO_UPLOAD_AASX_FILE_SUCCESS": "{0} was uploaded successfully.", @@ -175,7 +173,11 @@ "OPTION_BAR_HORIZONTAL_CHART": "Horizontal bar chart", "TEXT_ADD_FAVORITE": "Add 1 favorite ({0}).", "TEXT_ADD_FAVORITES": "Add {0} favorites ({1}).", + "Start": { + "FAVORITES": "All shells" + }, "AddEndpointForm": { + "CAPTION_ADD_ENDPOINT": "Add AAS Endpoint", "FileSystem": "File system", "AAS_API": "AAS API", "WebDAV": "WebDAV", @@ -188,8 +190,14 @@ "PLACEHOLDER_URL_OPCUA": "opc.tcp://", "PLACEHOLDER_URL_WEBDAV": "http(s)://", "ADVANCED_SETTINGS": "Advanced settings", + "SCHEDULE": "Search endpoint", + "ONCE": "once", + "EVERY": "cyclic", "MINUTES": "Minutes", - "HOURS": "Hours" + "HOURS": "Hours", + "HEADERS": "HTTP headers", + "HEADER": "Header", + "VALUE": "Value" }, "CustomerFeedback": { "OverallRating": "Overall rating", diff --git a/projects/aas-server/src/app/aas-index/aas-index.ts b/projects/aas-server/src/app/aas-index/aas-index.ts index 0012420d..9a820a3a 100644 --- a/projects/aas-server/src/app/aas-index/aas-index.ts +++ b/projects/aas-server/src/app/aas-index/aas-index.ts @@ -40,6 +40,8 @@ export abstract class AASIndex { public abstract addEndpoint(endpoint: AASEndpoint): Promise; + public abstract updateEndpoint(endpoint: AASEndpoint): Promise; + public abstract removeEndpoint(endpointName: string): Promise; public abstract getDocuments(cursor: AASCursor, query?: string, language?: string): Promise; diff --git a/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts b/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts index 8588359b..51a94358 100644 --- a/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts +++ b/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts @@ -102,6 +102,17 @@ export class LowDbIndex extends AASIndex { await this.db.write(); } + public override async updateEndpoint(endpoint: AASEndpoint): Promise { + await this.promise; + const index = this.db.data.endpoints.findIndex(item => item.name === endpoint.name); + if (index < 0) { + throw new Error(`An endpoint with the name ${name} does not exist.`); + } + + this.db.data.endpoints[index] = endpoint; + await this.db.write(); + } + public override async removeEndpoint(endpointName: string): Promise { await this.promise; const index = this.db.data.endpoints.findIndex(endpoint => endpoint.name === endpointName); diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts index f5ce28b0..54614a04 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts @@ -80,16 +80,24 @@ export class MySqlIndex extends AASIndex { } public override async getEndpoints(): Promise { - return (await (await this.connection).query('SELECT * FROM `endpoints`;'))[0].map( - row => - ({ - name: row.name, - url: row.url, - type: row.type, - version: row.version, - headers: row.headers ? JSON.parse(row.headers) : undefined, - }) as AASEndpoint, - ); + return (await (await this.connection).query('SELECT * FROM `endpoints`;'))[0].map(row => { + const endpoint: AASEndpoint = { + name: row.name, + url: row.url, + type: row.type, + version: row.version, + }; + + if (row.headers) { + endpoint.headers = JSON.parse(row.headers); + } + + if (row.schedule) { + endpoint.schedule = JSON.parse(row.schedule); + } + + return endpoint; + }); } public override async getEndpoint(name: string): Promise { @@ -142,10 +150,24 @@ export class MySqlIndex extends AASIndex { endpoint.type, endpoint.version, endpoint.headers ? JSON.stringify(endpoint.headers) : undefined, + endpoint.schedule ? JSON.stringify(endpoint.schedule) : undefined, ], ); } + public override async updateEndpoint(endpoint: AASEndpoint): Promise { + await ( + await this.connection + ).query('UPDATE `documents` SET url = ?, type = ?, version = ?, headers = ? WHERE name = ?;', [ + endpoint.url, + endpoint.type, + endpoint.version, + endpoint.headers ? JSON.stringify(endpoint.headers) : undefined, + endpoint.schedule ? JSON.stringify(endpoint.schedule) : undefined, + endpoint.name, + ]); + } + public override async removeEndpoint(endpointName: string): Promise { const connection = await this.connection; try { diff --git a/projects/aas-server/src/app/aas-provider/aas-provider.ts b/projects/aas-server/src/app/aas-provider/aas-provider.ts index d924a37f..d75a7c47 100644 --- a/projects/aas-server/src/app/aas-provider/aas-provider.ts +++ b/projects/aas-server/src/app/aas-provider/aas-provider.ts @@ -220,7 +220,7 @@ export class AASProvider { /** * Adds a new endpoint. * @param endpointName The endpoint name. - * @param url The endpoint URL. + * @param endpoint The endpoint to update. */ public async addEndpointAsync(endpointName: string, endpoint: AASEndpoint): Promise { if (endpointName !== endpoint.name) { @@ -240,6 +240,20 @@ export class AASProvider { setTimeout(this.scanEndpoint, 0, this.taskHandler.createTaskId(), endpoint); } + /** + * Updates an existing endpoint. + * @param endpointName The endpoint name. + * @param endpoint The endpoint to update. + */ + public async updateEndpointAsync(endpointName: string, endpoint: AASEndpoint): Promise { + if (endpointName !== endpoint.name) { + await this.index.removeEndpoint(endpointName); + await this.index.addEndpoint(endpoint); + } else { + await this.index.updateEndpoint(endpoint); + } + } + /** * Removes the endpoint with the specified name. * @param endpointName The name of the registry to remove. diff --git a/projects/aas-server/src/app/controller/endpoints-controller.ts b/projects/aas-server/src/app/controller/endpoints-controller.ts index ff1114e9..ab21259f 100644 --- a/projects/aas-server/src/app/controller/endpoints-controller.ts +++ b/projects/aas-server/src/app/controller/endpoints-controller.ts @@ -7,7 +7,7 @@ *****************************************************************************/ import { inject, injectable } from 'tsyringe'; -import { Body, Delete, Get, OperationId, Path, Post, Route, Security, Tags } from 'tsoa'; +import { Body, Delete, Get, OperationId, Path, Post, Put, Route, Security, Tags } from 'tsoa'; import { AASEndpoint } from 'aas-core'; import { AASProvider } from '../aas-provider/aas-provider.js'; @@ -47,7 +47,7 @@ export class EndpointsController extends AASController { } /** - * Gets the number of registered endpoints. + * @summary Gets the number of registered endpoints. * @returns The number of registered endpoints. */ @Get('count') @@ -63,7 +63,7 @@ export class EndpointsController extends AASController { } /** - * The total count of AAS documents of the specified endpoint. + * @summary The total count of AAS documents of the specified endpoint. * @param endpoint The endpoint name or `undefined`. * @returns The total number of AAS documents. */ @@ -87,10 +87,27 @@ export class EndpointsController extends AASController { @Post('{name}') @Security('bearerAuth', ['editor']) @OperationId('addEndpoint') - public addEndpoint(@Path() name: string, @Body() endpoint: AASEndpoint): Promise { + public async addEndpoint(@Path() name: string, @Body() endpoint: AASEndpoint): Promise { try { this.logger.start('addEndpoint'); - return this.aasProvider.addEndpointAsync(decodeBase64Url(name), endpoint); + await this.aasProvider.addEndpointAsync(decodeBase64Url(name), endpoint); + } finally { + this.logger.stop(); + } + } + + /** + * @summary Updates an existing endpoint. + * @param name The old endpoint name. + * @param endpoint The endpoint to update. + */ + @Put('{name}') + @Security('bearerAuth', ['editor']) + @OperationId('updateEndpoint') + public async updateEndpoint(@Path() name: string, @Body() endpoint: AASEndpoint): Promise { + try { + this.logger.start('addEndpoint'); + await this.aasProvider.updateEndpointAsync(decodeBase64Url(name), endpoint); } finally { this.logger.stop(); } @@ -103,10 +120,10 @@ export class EndpointsController extends AASController { @Delete('{name}') @Security('bearerAuth', ['editor']) @OperationId('deleteEndpoint') - public deleteEndpoint(@Path() name: string): Promise { + public async deleteEndpoint(@Path() name: string): Promise { try { this.logger.start('removeEndpoint'); - return this.aasProvider.removeEndpointAsync(decodeBase64Url(name)); + await this.aasProvider.removeEndpointAsync(decodeBase64Url(name)); } finally { this.logger.stop(); } From 425abc75f428d7bf54ee1024cd619e4b956a9227 Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Sat, 9 Nov 2024 09:39:29 +0100 Subject: [PATCH 15/76] fix: update AASIndex implementations --- .../aas-server/src/app/aas-index/aas-index.ts | 2 +- .../src/app/aas-index/lowdb/lowdb-index.ts | 14 ++- .../src/app/aas-index/mysql/mysql-index.ts | 115 +++++++++++------- .../src/app/aas-provider/aas-provider.ts | 7 +- .../test/aas-index/mysql/mysql-index.spec.ts | 20 ++- 5 files changed, 103 insertions(+), 55 deletions(-) diff --git a/projects/aas-server/src/app/aas-index/aas-index.ts b/projects/aas-server/src/app/aas-index/aas-index.ts index 9a820a3a..5c46e816 100644 --- a/projects/aas-server/src/app/aas-index/aas-index.ts +++ b/projects/aas-server/src/app/aas-index/aas-index.ts @@ -40,7 +40,7 @@ export abstract class AASIndex { public abstract addEndpoint(endpoint: AASEndpoint): Promise; - public abstract updateEndpoint(endpoint: AASEndpoint): Promise; + public abstract updateEndpoint(endpoint: AASEndpoint, name?: string): Promise; public abstract removeEndpoint(endpointName: string): Promise; diff --git a/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts b/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts index 51a94358..f3480066 100644 --- a/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts +++ b/projects/aas-server/src/app/aas-index/lowdb/lowdb-index.ts @@ -102,13 +102,25 @@ export class LowDbIndex extends AASIndex { await this.db.write(); } - public override async updateEndpoint(endpoint: AASEndpoint): Promise { + public override async updateEndpoint(endpoint: AASEndpoint, name?: string): Promise { await this.promise; const index = this.db.data.endpoints.findIndex(item => item.name === endpoint.name); if (index < 0) { throw new Error(`An endpoint with the name ${name} does not exist.`); } + if (name !== undefined && name !== endpoint.name) { + if (this.db.data.endpoints.some(item => item.name === name)) { + throw new ApplicationError( + `An endpoint with the name "${name}" already exists.`, + ERRORS.RegistryAlreadyExists, + endpoint.name, + ); + } + + this.removeDocuments(endpoint.name); + } + this.db.data.endpoints[index] = endpoint; await this.db.write(); } diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts index 54614a04..5a69bb71 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts @@ -56,31 +56,31 @@ export class MySqlIndex extends AASIndex { } public override async getCount(endpoint?: string): Promise { + const connection = await this.connection; if (endpoint === undefined) { - const result = await ( - await this.connection - ).query('SELECT COUNT(*) FROM `documents` AS count;'); + const result = await connection.query('SELECT COUNT(*) FROM `documents` AS count;'); return result[0][0]['COUNT(*)']; } - const result = await ( - await this.connection - ).query('SELECT COUNT(*) FROM `documents` WHERE endpoint = ? AS count;', [endpoint]); + const result = await connection.query( + 'SELECT COUNT(*) FROM `documents` WHERE endpoint = ? AS count;', + [endpoint], + ); return result[0][0]['COUNT(*)']; } public override async getEndpointCount(): Promise { - const result = await ( - await this.connection - ).query('SELECT COUNT(*) FROM `endpoints` AS count;'); - + const connection = await this.connection; + const result = await connection.query('SELECT COUNT(*) FROM `endpoints` AS count;'); return result[0][0]['COUNT(*)']; } public override async getEndpoints(): Promise { - return (await (await this.connection).query('SELECT * FROM `endpoints`;'))[0].map(row => { + const connection = await this.connection; + const result = await connection.query('SELECT * FROM `endpoints`;'); + return result[0].map(row => { const endpoint: AASEndpoint = { name: row.name, url: row.url, @@ -101,10 +101,8 @@ export class MySqlIndex extends AASIndex { } public override async getEndpoint(name: string): Promise { - const [results] = await ( - await this.connection - ).query('SELECT * FROM `endpoints` WHERE name = ?;', [name]); - + const connection = await this.connection; + const [results] = await connection.query('SELECT * FROM `endpoints` WHERE name = ?;', [name]); if (results.length === 0) { throw new Error(`An endpoint with the name "${name}" does not exist.`); } @@ -132,18 +130,15 @@ export class MySqlIndex extends AASIndex { } public override async hasEndpoint(name: string): Promise { - const [results] = await ( - await this.connection - ).query('SELECT * FROM `endpoints` WHERE name = ?;', [name]); - + const connection = await this.connection; + const [results] = await connection.query('SELECT * FROM `endpoints` WHERE name = ?;', [name]); return results.length > 0; } public override async addEndpoint(endpoint: AASEndpoint): Promise { - await ( - await this.connection - ).query( - 'INSERT INTO `endpoints` (name, url, type, version, headers) VALUES (?, ?, ?, ?, ?);', + const connection = await this.connection; + await connection.query( + 'INSERT INTO `endpoints` (name, url, type, version, headers, schedule) VALUES (?, ?, ?, ?, ?, ?);', [ endpoint.name, endpoint.url, @@ -155,17 +150,43 @@ export class MySqlIndex extends AASIndex { ); } - public override async updateEndpoint(endpoint: AASEndpoint): Promise { - await ( - await this.connection - ).query('UPDATE `documents` SET url = ?, type = ?, version = ?, headers = ? WHERE name = ?;', [ - endpoint.url, - endpoint.type, - endpoint.version, - endpoint.headers ? JSON.stringify(endpoint.headers) : undefined, - endpoint.schedule ? JSON.stringify(endpoint.schedule) : undefined, - endpoint.name, - ]); + public override async updateEndpoint(endpoint: AASEndpoint, name?: string): Promise { + const connection = await this.connection; + if (name === undefined || endpoint.name === name) { + await connection.query( + 'UPDATE `documents` SET url = ?, type = ?, version = ?, headers = ? schedule = ? WHERE name = ?;', + [ + endpoint.url, + endpoint.type, + endpoint.version, + endpoint.headers ? JSON.stringify(endpoint.headers) : undefined, + endpoint.schedule ? JSON.stringify(endpoint.schedule) : undefined, + endpoint.name, + ], + ); + } else { + try { + await connection.beginTransaction(); + await connection.query('DELETE FROM `endpoints` WHERE name = ?;', [endpoint.name]); + this.removeDocuments(endpoint.name); + await connection.query( + 'INSERT INTO `endpoints` (name, url, type, version, headers) VALUES (?, ?, ?, ?, ?);', + [ + endpoint.name, + endpoint.url, + endpoint.type, + endpoint.version, + endpoint.headers ? JSON.stringify(endpoint.headers) : undefined, + endpoint.schedule ? JSON.stringify(endpoint.schedule) : undefined, + ], + ); + + await connection.commit(); + } catch (error) { + await connection.rollback(); + throw error; + } + } } public override async removeEndpoint(endpointName: string): Promise { @@ -173,9 +194,9 @@ export class MySqlIndex extends AASIndex { try { await connection.beginTransaction(); - const result = await ( - await this.connection - ).query('DELETE FROM `endpoints` WHERE name = ?;', [endpointName]); + const result = await connection.query('DELETE FROM `endpoints` WHERE name = ?;', [ + endpointName, + ]); this.removeDocuments(endpointName); @@ -506,13 +527,11 @@ export class MySqlIndex extends AASIndex { } private async selectEndpointDocument(endpoint: string, id: string): Promise { - const [results] = await ( - await this.connection - ).query('SELECT * FROM `documents` WHERE endpoint = ? AND (id = ? OR assetId = ?)', [ - endpoint, - id, - id, - ]); + const connection = await this.connection; + const [results] = await connection.query( + 'SELECT * FROM `documents` WHERE endpoint = ? AND (id = ? OR assetId = ?)', + [endpoint, id, id], + ); if (results.length === 0) { return undefined; @@ -522,9 +541,11 @@ export class MySqlIndex extends AASIndex { } private async selectDocument(id: string): Promise { - const [results] = await ( - await this.connection - ).query('SELECT * FROM `documents` WHERE (id = ? OR assetId = ?)', [id, id]); + const connection = await this.connection; + const [results] = await connection.query( + 'SELECT * FROM `documents` WHERE (id = ? OR assetId = ?)', + [id, id], + ); if (results.length === 0) { return undefined; diff --git a/projects/aas-server/src/app/aas-provider/aas-provider.ts b/projects/aas-server/src/app/aas-provider/aas-provider.ts index d75a7c47..50d9c456 100644 --- a/projects/aas-server/src/app/aas-provider/aas-provider.ts +++ b/projects/aas-server/src/app/aas-provider/aas-provider.ts @@ -246,11 +246,10 @@ export class AASProvider { * @param endpoint The endpoint to update. */ public async updateEndpointAsync(endpointName: string, endpoint: AASEndpoint): Promise { - if (endpointName !== endpoint.name) { - await this.index.removeEndpoint(endpointName); - await this.index.addEndpoint(endpoint); - } else { + if (endpointName === endpoint.name) { await this.index.updateEndpoint(endpoint); + } else { + await this.index.updateEndpoint(endpoint, endpointName); } } diff --git a/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts b/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts index bb250a22..86976c10 100644 --- a/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts +++ b/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts @@ -141,8 +141,24 @@ describe('MySqlIndex', () => { await expect(index.addEndpoint(endpoint)).resolves.toEqual(void 0); expect(connection.query).toHaveBeenLastCalledWith( - 'INSERT INTO `endpoints` (name, url, type, version, headers) VALUES (?, ?, ?, ?, ?);', - [endpoint.name, endpoint.url, endpoint.type, undefined, undefined], + 'INSERT INTO `endpoints` (name, url, type, version, headers, schedule) VALUES (?, ?, ?, ?, ?, ?);', + [endpoint.name, endpoint.url, endpoint.type, undefined, undefined, undefined], + ); + }); + }); + + describe('updateEndpoint', () => { + it('updates an existing Endpoint', async () => { + const endpoint: AASEndpoint = { + name: 'Endpoint 1', + url: 'http://endpoint1.com', + type: 'AAS_API', + }; + + await expect(index.updateEndpoint(endpoint)).resolves.toEqual(void 0); + expect(connection.query).toHaveBeenLastCalledWith( + 'UPDATE `documents` SET url = ?, type = ?, version = ?, headers = ? schedule = ? WHERE name = ?;', + [endpoint.url, endpoint.type, undefined, undefined, undefined, endpoint.name], ); }); }); From 979a070831c2a4e1b9d294e86bb6db3856508f9c Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Sat, 9 Nov 2024 16:48:52 +0100 Subject: [PATCH 16/76] fix: UpdateEndpointForm --- projects/aas-core/src/lib/types.ts | 2 +- .../add-endpoint-form.component.html | 14 +- .../add-endpoint-form.component.ts | 4 +- .../src/app/start/start.component.html | 7 +- .../src/app/start/start.component.ts | 21 ++ .../update-endpoint-form.component.html | 117 ++++++++ .../update-endpoint-form.component.scss | 15 + .../update-endpoint-form.component.ts | 280 ++++++++++++++++++ .../aas-portal/src/assets/i18n/de-de.json | 36 ++- .../aas-portal/src/assets/i18n/en-us.json | 36 ++- .../update-endpoint-form.component.spec.ts | 39 +++ .../src/app/aas-index/mysql/mysql-index.ts | 2 +- .../src/app/aas-provider/aas-provider.ts | 2 +- .../test/aas-index/mysql/mysql-index.spec.ts | 2 +- 14 files changed, 552 insertions(+), 25 deletions(-) create mode 100644 projects/aas-portal/src/app/start/update-endpoint-form/update-endpoint-form.component.html create mode 100644 projects/aas-portal/src/app/start/update-endpoint-form/update-endpoint-form.component.scss create mode 100644 projects/aas-portal/src/app/start/update-endpoint-form/update-endpoint-form.component.ts create mode 100644 projects/aas-portal/src/test/start/update-endpoint-form.component.spec.ts diff --git a/projects/aas-core/src/lib/types.ts b/projects/aas-core/src/lib/types.ts index c62a6b74..7ae8512c 100644 --- a/projects/aas-core/src/lib/types.ts +++ b/projects/aas-core/src/lib/types.ts @@ -45,7 +45,7 @@ export type AASAbbreviation = | 'SME' | 'SML'; -export type AASEndpointScheduleType = 'never' | 'once' | 'every' | 'daily' | 'weekly'; +export type AASEndpointScheduleType = 'manual' | 'once' | 'every' | 'daily' | 'weekly'; /** The schedule type. */ export interface AASEndpointSchedule { diff --git a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html index e68ec699..066aaec0 100644 --- a/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html +++ b/projects/aas-portal/src/app/start/add-endpoint-form/add-endpoint-form.component.html @@ -10,7 +10,7 @@

- AddEndpointForm.CAPTION_ADD_ENDPOINT + AddEndpointForm.CAPTION

@@ -49,6 +49,11 @@

+
+ + +
@@ -71,13 +76,14 @@

}

-
+

Headers
#HeaderValueAddEndpointForm.HEADERAddEndpointForm.VALUE
- - + + 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 index 5ce9166e..a4cc43f8 100644 --- 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 @@ -136,8 +136,8 @@ export class AddEndpointFormComponent { } switch (this.schedule()) { - case 'never': - endpoint.schedule = { type: 'never' }; + case 'manual': + endpoint.schedule = { type: 'manual' }; break; case 'once': endpoint.schedule = { type: 'once' }; diff --git a/projects/aas-portal/src/app/start/start.component.html b/projects/aas-portal/src/app/start/start.component.html index df294b50..06afb416 100644 --- a/projects/aas-portal/src/app/start/start.component.html +++ b/projects/aas-portal/src/app/start/start.component.html @@ -57,9 +57,10 @@ diff --git a/projects/aas-portal/src/app/start/start.component.ts b/projects/aas-portal/src/app/start/start.component.ts index 0e4f191a..e50c2951 100644 --- a/projects/aas-portal/src/app/start/start.component.ts +++ b/projects/aas-portal/src/app/start/start.component.ts @@ -46,6 +46,7 @@ import { StartApiService } from './start-api.service'; import { FavoritesService } from './favorites.service'; import { FavoritesFormComponent } from './favorites-form/favorites-form.component'; import { StartStore } from './start.store'; +import { UpdateEndpointFormComponent } from './update-endpoint-form/update-endpoint-form.component'; @Component({ selector: 'fhg-start', @@ -170,6 +171,26 @@ export class StartComponent implements OnDestroy, AfterViewInit { ); } + public updateEndpoint(): Observable { + return this.auth.ensureAuthorized('editor').pipe( + mergeMap(() => this.api.getEndpoints()), + map(endpoints => { + const modalRef = this.modal.open(UpdateEndpointFormComponent, { backdrop: 'static' }); + modalRef.componentInstance.initialize(endpoints); + return modalRef; + }), + mergeMap(modalRef => from>(modalRef.result)), + mergeMap(result => { + if (result === undefined) { + return EMPTY; + } + + return this.api.updateEndpoint(result); + }), + catchError(error => this.notify.error(error)), + ); + } + public removeEndpoint(): Observable { return this.auth.ensureAuthorized('editor').pipe( mergeMap(() => this.api.getEndpoints()), diff --git a/projects/aas-portal/src/app/start/update-endpoint-form/update-endpoint-form.component.html b/projects/aas-portal/src/app/start/update-endpoint-form/update-endpoint-form.component.html new file mode 100644 index 00000000..62072667 --- /dev/null +++ b/projects/aas-portal/src/app/start/update-endpoint-form/update-endpoint-form.component.html @@ -0,0 +1,117 @@ + + +
+
+

+ + UpdateEndpointForm.CAPTION +

+ +
+
+ @for (message of messages(); track message) { + +
+
{{ message }}
+
+ + } + + + +
+ +
+ @for (item of items(); track item) { + + } +
+ +
+ @if (selectedItem().type === 'AAS_API') { + +
+
+ + +
+
+ + +
+
+ + +
+ @if (schedule() === 'every') { +
+ + UpdateEndpointForm.HOURS + + UpdateEndpointForm.MINUTES +
+ } +
+ +
+
#AddEndpointForm.HEADERAddEndpointForm.VALUEAddEndpointForm.HEADERAddEndpointForm.VALUE
+ + + + + + + + + @for (header of headers(); track header.id) { + + + @if (header === selectedHeader()) { + + + } @else { + + + } + } + +
#UpdateEndpointForm.HEADERUpdateEndpointForm.VALUE
{{header.id}} + + + + +
{{header.name}}
+ 		+
{{header.value}}
+
+
+ } +
+
+ + +
+ \ No newline at end of file diff --git a/projects/aas-portal/src/app/start/update-endpoint-form/update-endpoint-form.component.scss b/projects/aas-portal/src/app/start/update-endpoint-form/update-endpoint-form.component.scss new file mode 100644 index 00000000..cd7fe036 --- /dev/null +++ b/projects/aas-portal/src/app/start/update-endpoint-form/update-endpoint-form.component.scss @@ -0,0 +1,15 @@ +/****************************************************************************** + * + * Copyright (c) 2019-2024 Fraunhofer IOSB-INA Lemgo, + * eine rechtlich nicht selbstaendige Einrichtung der Fraunhofer-Gesellschaft + * zur Foerderung der angewandten Forschung e.V. + * + *****************************************************************************/ + +.start-3 { + left: 3%!important; +} + +.start-10 { + left: 10%!important; +} \ No newline at end of file diff --git a/projects/aas-portal/src/app/start/update-endpoint-form/update-endpoint-form.component.ts b/projects/aas-portal/src/app/start/update-endpoint-form/update-endpoint-form.component.ts new file mode 100644 index 00000000..f85e6a8c --- /dev/null +++ b/projects/aas-portal/src/app/start/update-endpoint-form/update-endpoint-form.component.ts @@ -0,0 +1,280 @@ +/****************************************************************************** + * + * Copyright (c) 2019-2024 Fraunhofer IOSB-INA Lemgo, + * eine rechtlich nicht selbstaendige Einrichtung der Fraunhofer-Gesellschaft + * zur Foerderung der angewandten Forschung e.V. + * + *****************************************************************************/ + +import cloneDeep from 'lodash-es/cloneDeep'; +import { ChangeDetectionStrategy, Component, computed, effect, signal } from '@angular/core'; +import { FormsModule } from '@angular/forms'; +import { NgbActiveModal, NgbDropdownModule, NgbToast } from '@ng-bootstrap/ng-bootstrap'; +import { TranslateModule, TranslateService } from '@ngx-translate/core'; +import { AASEndpoint, AASEndpointScheduleType, AASEndpointType, stringFormat } from 'aas-core'; + +export interface HeaderItem { + id: string; + name: string; + value: string; +} + +export interface EndpointItem { + type: AASEndpointType; + placeholder: string; +} + +@Component({ + selector: 'fhg-update-endpoint', + templateUrl: './update-endpoint-form.component.html', + styleUrls: ['./update-endpoint-form.component.scss'], + standalone: true, + imports: [NgbToast, NgbDropdownModule, TranslateModule, FormsModule], + changeDetection: ChangeDetectionStrategy.OnPush, +}) +export class UpdateEndpointFormComponent { + private readonly _messages = signal([]); + private _selectedItemIndex = signal(0); + private readonly _endpoints = signal([]); + private readonly _selectedHeaderIndex = signal(-1); + private readonly _headers = signal([{ id: '1', name: '', value: '' }]); + private readonly _items = signal([ + { + type: 'AAS_API', + placeholder: 'UpdateEndpointForm.PLACEHOLDER_URL_HTTP', + }, + { + type: 'OPC_UA', + placeholder: 'UpdateEndpointForm.PLACEHOLDER_URL_OPCUA', + }, + { + type: 'WebDAV', + placeholder: 'UpdateEndpointForm.PLACEHOLDER_URL_WEBDAV', + }, + { + type: 'FileSystem', + placeholder: 'UpdateEndpointForm.PLACEHOLDER_URL_FILE', + }, + ]); + + public constructor( + private modal: NgbActiveModal, + private translate: TranslateService, + ) { + effect( + () => { + const endpoint = this.endpoint(); + this.schedule.set(endpoint.schedule?.type || 'every'); + + if (endpoint.headers) { + const items: HeaderItem[] = []; + let i = 1; + for (const name in endpoint.headers) { + items.push({ id: String(i++), name, value: endpoint.headers[name] }); + } + + this._headers.set(items); + } + }, + { allowSignalWrites: true }, + ); + } + + public readonly endpoints = this._endpoints.asReadonly(); + + public readonly endpoint = signal({ + name: '', + url: '', + type: 'AAS_API', + }); + + public readonly messages = this._messages.asReadonly(); + + public readonly items = this._items.asReadonly(); + + public readonly selectedItem = computed(() => this._items()[this._selectedItemIndex()]); + + public readonly schedule = signal('every'); + + public readonly minutes = signal(0); + + public readonly hours = signal(1); + + public readonly headers = this._headers.asReadonly(); + + public readonly selectedHeader = computed(() => + this._selectedHeaderIndex() < 0 ? undefined : this._headers()[this._selectedHeaderIndex()], + ); + + public initialize(endpoints: AASEndpoint[]): void { + if (endpoints.length > 0) { + this._endpoints.set(endpoints); + this.endpoint.set(endpoints[0]); + } + } + + public selectItem(value: EndpointItem): void { + this._selectedItemIndex.set(this._items().indexOf(value)); + this.clearMessages(); + } + + public selectHeader(value: HeaderItem): void { + this._selectedHeaderIndex.update(state => { + const index = this._headers().indexOf(value); + if (state >= 0 && index === state) { + this.updateHeaders(); + return -1; + } + + return index; + }); + + this.clearMessages(); + } + + public inputValue(): void { + this.clearMessages(); + } + + public submit(): void { + const selectedItem = this.selectedItem(); + if (selectedItem === undefined) { + return; + } + + this.clearMessages(); + const endpoint = cloneDeep(this.endpoint()); + const url = this.validateUrl(endpoint.url.trim(), selectedItem.type); + if (url === undefined) { + return; + } + + const version = url.searchParams.get('version'); + url.search = ''; + if (version) { + endpoint.version = version; + } else if (selectedItem.type === 'AAS_API') { + endpoint.version = 'v3'; + } + + endpoint.url = url.toString(); + + switch (this.schedule()) { + case 'manual': + endpoint.schedule = { type: 'manual' }; + break; + case 'once': + endpoint.schedule = { type: 'once' }; + break; + default: + endpoint.schedule = { type: 'every', values: [(this.hours() * 60 + this.minutes()) * 60000] }; + break; + } + + const headers = this.headers().filter(header => header.name && header.value); + if (headers.length > 0) { + endpoint.headers = {}; + headers.forEach(header => (endpoint.headers![header.name] = header.value)); + } + + this.modal.close(endpoint); + } + + public cancel(): void { + this.modal.close(); + } + + private clearMessages(): void { + if (this._messages.length > 0) { + this._messages.set([]); + } + } + + private validateUrl(value: string, type: AASEndpointType): URL | undefined { + try { + const url = new URL(value); + switch (type) { + case 'AAS_API': + this.validateAASApiEndpoint(url); + break; + case 'FileSystem': + this.validateFileSystemEndpoint(url); + break; + case 'OPC_UA': + this.validateOpcuaEndpoint(url); + break; + case 'WebDAV': + this.validateWebDAVEndpoint(url); + break; + } + + return url; + } catch (error) { + this._messages.update(messages => [...messages, this.createMessage('ERROR_INVALID_URL', value)]); + return undefined; + } + } + + private createMessage(id: string, ...args: unknown[]): string { + return stringFormat(this.translate.instant(id), args); + } + + private validateAASApiEndpoint(url: URL): void { + if (url.protocol !== 'http:' && url.protocol !== 'https:') { + throw new Error('Protocol "http:" or "https:" expected.'); + } + + if (!url.hostname) { + throw new Error('Empty host name.'); + } + } + + 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.hostname) { + throw new Error('Empty host name.'); + } + } + + private validateWebDAVEndpoint(url: URL): void { + if (url.protocol !== 'http:' && url.protocol !== 'https:') { + throw new Error('Protocol "http:" or "https:" expected.'); + } + + if (!url.hostname) { + throw new Error('Empty host name.'); + } + } + + private updateHeaders(): void { + this._headers.update(state => { + let index = 1; + const items: HeaderItem[] = []; + for (const item of state) { + if (item.name || item.value) { + items.push({ ...item, id: String(index++) }); + } + } + + items.push({ id: String(index++), name: '', value: '' }); + return items; + }); + } +} diff --git a/projects/aas-portal/src/assets/i18n/de-de.json b/projects/aas-portal/src/assets/i18n/de-de.json index 3be80f72..0205250f 100644 --- a/projects/aas-portal/src/assets/i18n/de-de.json +++ b/projects/aas-portal/src/assets/i18n/de-de.json @@ -40,12 +40,9 @@ "CMD_UPDATE_PROFILE": "Profil", "CMD_RESET_PASSWORD": "Passwort vergessen?", "CMD_OPERATION_CALL": "Aufrufen", - "CMD_ADD_ENDPOINT": "Hinzufügen...", "CMD_CREATE_WORKSPACE": "Gruppieren...", "CMD_EDIT_WORKSPACE": "Gruppe bearbeiten...", "CMD_REMOVE_WORKSPACE": "Gruppierung aufheben...", - "CMD_REMOVE_ENDPOINT": "Entfernen...", - "CMD_RESET_CONFIGURATION": "Zurücksetzen...", "CMD_TOGGLE_MESSAGES": "Meldungen", "CMD_TOGGLE_PACKAGES": "Packages", "CMD_DELETE_USER": "Benutzerkonto löschen...", @@ -173,10 +170,14 @@ "TEXT_ADD_FAVORITE": "1 Favorit hinzufügen ({0}).", "TEXT_ADD_FAVORITES": "{0} Favoriten hinzufügen ({1}).", "Start": { - "FAVORITES": "Alle Verwaltungsschalen" - }, + "FAVORITES": "Alle Verwaltungsschalen", + "ADD_ENDPOINT": "Hinzufügen...", + "UPDATE_ENDPOINT": "Bearbeiten...", + "REMOVE_ENDPOINT": "Entfernen...", + "RESET": "Zurücksetzen..." + }, "AddEndpointForm": { - "CAPTION_ADD_ENDPOINT": "AAS-Endpunkt hinzufügen", + "CAPTION": "AAS-Endpunkt hinzufügen", "FileSystem": "Dateisystem", "AAS_API": "AAS API", "WebDAV": "WebDAV", @@ -190,6 +191,29 @@ "PLACEHOLDER_URL_WEBDAV": "http(s)://", "ADVANCED_SETTINGS": "Erweiterte Einstellungen", "SCHEDULE": "Endpunkt durchsuchen", + "MANUAL": "manuell", + "ONCE": "einmalig", + "EVERY": "zyklisch", + "MINUTES": "Minuten", + "HOURS": "Stunden", + "HEADERS": "HTTP-Header-Felder", + "HEADER": "Feld", + "VALUE": "Wert" + }, + "UpdateEndpointForm": { + "CAPTION": "AAS-Endpunkt bearbeiten", + "ENDPOINTS": "Endpunkte", + "FileSystem": "Dateisystem", + "AAS_API": "AAS API", + "WebDAV": "WebDAV", + "OPC_UA": "OPC UA", + "URL": "URL", + "PLACEHOLDER_URL_FILE": "file:///", + "PLACEHOLDER_URL_HTTP": "http(s)://", + "PLACEHOLDER_URL_OPCUA": "opc.tcp://", + "PLACEHOLDER_URL_WEBDAV": "http(s)://", + "SCHEDULE": "Endpunkt durchsuchen", + "MANUAL": "manuell", "ONCE": "einmalig", "EVERY": "zyklisch", "MINUTES": "Minuten", diff --git a/projects/aas-portal/src/assets/i18n/en-us.json b/projects/aas-portal/src/assets/i18n/en-us.json index e3a17e17..d728911a 100644 --- a/projects/aas-portal/src/assets/i18n/en-us.json +++ b/projects/aas-portal/src/assets/i18n/en-us.json @@ -43,9 +43,6 @@ "CMD_CREATE_WORKSPACE": "Group...", "CMD_EDIT_WORKSPACE": "Edit group...", "CMD_REMOVE_WORKSPACE": "Ungroup...", - "CMD_ADD_ENDPOINT": "Add...", - "CMD_REMOVE_ENDPOINT": "Remove...", - "CMD_RESET_CONFIGURATION": "Reset...", "CMD_TOGGLE_MESSAGES": "Messages", "CMD_TOGGLE_PACKAGES": "Packages", "CMD_DELETE_USER": "Delete user account...", @@ -174,10 +171,14 @@ "TEXT_ADD_FAVORITE": "Add 1 favorite ({0}).", "TEXT_ADD_FAVORITES": "Add {0} favorites ({1}).", "Start": { - "FAVORITES": "All shells" + "FAVORITES": "All shells", + "ADD_ENDPOINT": "Add...", + "UPDATE_ENDPOINT": "Edit...", + "REMOVE_ENDPOINT": "Remove...", + "RESET": "Reset..." }, "AddEndpointForm": { - "CAPTION_ADD_ENDPOINT": "Add AAS Endpoint", + "CAPTION": "Add AAS Endpoint", "FileSystem": "File system", "AAS_API": "AAS API", "WebDAV": "WebDAV", @@ -191,6 +192,29 @@ "PLACEHOLDER_URL_WEBDAV": "http(s)://", "ADVANCED_SETTINGS": "Advanced settings", "SCHEDULE": "Search endpoint", + "MANUAL": "manual", + "ONCE": "once", + "EVERY": "cyclic", + "MINUTES": "Minutes", + "HOURS": "Hours", + "HEADERS": "HTTP headers", + "HEADER": "Header", + "VALUE": "Value" + }, + "UpdateEndpointForm": { + "CAPTION": "Update AAS Endpoint", + "ENDPOINTS": "Endpoints", + "FileSystem": "File system", + "AAS_API": "AAS API", + "WebDAV": "WebDAV", + "OPC_UA": "OPC UA", + "URL": "URL", + "PLACEHOLDER_URL_FILE": "file:///", + "PLACEHOLDER_URL_HTTP": "http(s)://", + "PLACEHOLDER_URL_OPCUA": "opc.tcp://", + "PLACEHOLDER_URL_WEBDAV": "http(s)://", + "SCHEDULE": "Search endpoint", + "MANUAL": "manual", "ONCE": "once", "EVERY": "cyclic", "MINUTES": "Minutes", @@ -228,4 +252,4 @@ "ENDPOINTS": "Endpoints", "SHELLS": "Shells" } -} +} \ No newline at end of file diff --git a/projects/aas-portal/src/test/start/update-endpoint-form.component.spec.ts b/projects/aas-portal/src/test/start/update-endpoint-form.component.spec.ts new file mode 100644 index 00000000..5acda88c --- /dev/null +++ b/projects/aas-portal/src/test/start/update-endpoint-form.component.spec.ts @@ -0,0 +1,39 @@ +/****************************************************************************** + * + * Copyright (c) 2019-2024 Fraunhofer IOSB-INA Lemgo, + * eine rechtlich nicht selbstaendige Einrichtung der Fraunhofer-Gesellschaft + * zur Foerderung der angewandten Forschung e.V. + * + *****************************************************************************/ + +import { ComponentFixture, TestBed } from '@angular/core/testing'; +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; +import { TranslateFakeLoader, TranslateLoader, TranslateModule } from '@ngx-translate/core'; +import { UpdateEndpointFormComponent } from '../../app/start/update-endpoint-form/update-endpoint-form.component'; + +describe('UpdateEndpointFormComponent', () => { + let component: UpdateEndpointFormComponent; + let fixture: ComponentFixture; + + beforeEach(() => { + TestBed.configureTestingModule({ + providers: [NgbActiveModal], + imports: [ + TranslateModule.forRoot({ + loader: { + provide: TranslateLoader, + useClass: TranslateFakeLoader, + }, + }), + ], + }); + + fixture = TestBed.createComponent(UpdateEndpointFormComponent); + component = fixture.componentInstance; + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); +}); diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts index 5a69bb71..d67b4350 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts @@ -154,7 +154,7 @@ export class MySqlIndex extends AASIndex { const connection = await this.connection; if (name === undefined || endpoint.name === name) { await connection.query( - 'UPDATE `documents` SET url = ?, type = ?, version = ?, headers = ? schedule = ? WHERE name = ?;', + 'UPDATE `endpoints` SET url = ?, type = ?, version = ?, headers = ?, schedule = ? WHERE name = ?;', [ endpoint.url, endpoint.type, diff --git a/projects/aas-server/src/app/aas-provider/aas-provider.ts b/projects/aas-server/src/app/aas-provider/aas-provider.ts index 50d9c456..4f909999 100644 --- a/projects/aas-server/src/app/aas-provider/aas-provider.ts +++ b/projects/aas-server/src/app/aas-provider/aas-provider.ts @@ -478,7 +478,7 @@ export class AASProvider { private startScan = async (): Promise => { try { for (const endpoint of await this.index.getEndpoints()) { - if (endpoint.schedule?.type === 'never') { + if (endpoint.schedule?.type === 'manual') { continue; } diff --git a/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts b/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts index 86976c10..c7fac5a2 100644 --- a/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts +++ b/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts @@ -157,7 +157,7 @@ describe('MySqlIndex', () => { await expect(index.updateEndpoint(endpoint)).resolves.toEqual(void 0); expect(connection.query).toHaveBeenLastCalledWith( - 'UPDATE `documents` SET url = ?, type = ?, version = ?, headers = ? schedule = ? WHERE name = ?;', + 'UPDATE `endpoints` SET url = ?, type = ?, version = ?, headers = ?, schedule = ? WHERE name = ?;', [endpoint.url, endpoint.type, undefined, undefined, undefined, endpoint.name], ); }); From c1dab605705ee90cd1e672653058cfd10a1faf38 Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Sun, 10 Nov 2024 18:54:10 +0100 Subject: [PATCH 17/76] fix: manual start endpoint scan --- .../src/lib/aas-table/aas-table-row.ts | 2 +- .../lib/aas-table/aas-table.component.html | 10 ++-- .../src/app/aas-index/mysql/mysql-index.ts | 44 +++++++------- .../src/app/aas-index/mysql/mysql-types.ts | 16 ++++-- .../src/app/aas-provider/aas-provider.ts | 57 ++++++++++++++----- .../src/app/aas-provider/scan-result.ts | 1 - .../src/app/aas-provider/task-handler.ts | 32 +++++++++-- .../src/app/aas-provider/worker-data.ts | 1 - .../app/controller/endpoints-controller.ts | 16 ++++++ projects/aas-server/src/app/endpoint-scan.ts | 3 - .../src/app/template/template-scan.ts | 1 - .../src/app/template/template-storage.ts | 19 ++++--- projects/aas-server/src/app/worker-app.ts | 1 - .../test/aas-index/mysql/mysql-index.spec.ts | 39 +++++++++++-- .../test/template/template-storage.spec.ts | 17 +++--- projects/aasportal-index/schema.sql | 2 - 16 files changed, 178 insertions(+), 83 deletions(-) diff --git a/projects/aas-lib/src/lib/aas-table/aas-table-row.ts b/projects/aas-lib/src/lib/aas-table/aas-table-row.ts index 2036b5d5..a552d6ae 100644 --- a/projects/aas-lib/src/lib/aas-table/aas-table-row.ts +++ b/projects/aas-lib/src/lib/aas-table/aas-table-row.ts @@ -37,7 +37,7 @@ export class AASTableRow extends TreeNode { } public get thumbnail(): string { - return this.element.thumbnail ?? '/assets/resources/aas.32.png'; + return this.element.thumbnail || '/assets/resources/aas.32.png'; } public get endpoint(): string { diff --git a/projects/aas-lib/src/lib/aas-table/aas-table.component.html b/projects/aas-lib/src/lib/aas-table/aas-table.component.html index 047144a8..29f3bc43 100644 --- a/projects/aas-lib/src/lib/aas-table/aas-table.component.html +++ b/projects/aas-lib/src/lib/aas-table/aas-table.component.html @@ -37,7 +37,7 @@ @switch (row.state) { @case ('unloaded') {
- +
@@ -46,7 +46,7 @@ } @case ('unavailable') {
- +
@@ -55,7 +55,7 @@ } @default {
- +
} } @@ -77,8 +77,8 @@ - +
COLUMN_NAME
diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts index d67b4350..a4e3a531 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-index.ts @@ -85,9 +85,12 @@ export class MySqlIndex extends AASIndex { name: row.name, url: row.url, type: row.type, - version: row.version, }; + if (row.version) { + endpoint.version = row.version; + } + if (row.headers) { endpoint.headers = JSON.parse(row.headers); } @@ -270,17 +273,8 @@ export class MySqlIndex extends AASIndex { const uuid = result[0][0].uuid; await connection.query( - 'UPDATE `documents` SET address = ?, crc32 = ?, idShort = ?, onlineReady = ?, readonly = ?, timestamp = ?, thumbnail = ? WHERE uuid = ?;', - [ - document.address, - document.crc32, - document.idShort, - !!document.onlineReady, - document.readonly, - document.timestamp, - document.thumbnail, - uuid, - ], + 'UPDATE `documents` SET address = ?, crc32 = ?, idShort = ?, timestamp = ?, thumbnail = ? WHERE uuid = ?;', + [document.address, document.crc32, document.idShort, document.timestamp, document.thumbnail, uuid], ); if (document.content) { @@ -301,7 +295,7 @@ export class MySqlIndex extends AASIndex { await connection.beginTransaction(); const uuid = v4(); await connection.query( - 'INSERT INTO `documents` (uuid, address, crc32, endpoint, id, idShort, assetId, onlineReady, readonly, thumbnail, timestamp) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?);', + 'INSERT INTO `documents` (uuid, address, crc32, endpoint, id, idShort, assetId, thumbnail, timestamp) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?);', [ uuid, document.address, @@ -309,10 +303,8 @@ export class MySqlIndex extends AASIndex { document.endpoint, document.id, document.idShort, - document.assetId, - !!document.onlineReady, - document.readonly, - document.thumbnail ?? '', + document.assetId || null, + document.thumbnail || null, BigInt(document.timestamp), ], ); @@ -582,19 +574,27 @@ export class MySqlIndex extends AASIndex { } private toDocument(result: MySqlDocument): AASDocument { - return { + const document: AASDocument = { address: result.address, crc32: result.crc32, endpoint: result.endpoint, id: result.id, idShort: result.idShort, - assetId: result.assetId, - readonly: result.readonly ? true : false, timestamp: Number(result.timestamp), content: null, - onlineReady: result.onlineReady ? true : false, - thumbnail: result.thumbnail, + onlineReady: true, + readonly: true, }; + + if (result.assetId) { + document.assetId = result.assetId; + } + + if (result.thumbnail) { + document.thumbnail = result.thumbnail; + } + + return document; } private async initialize(): Promise { diff --git a/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts b/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts index 03261e91..b02c71c3 100644 --- a/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts +++ b/projects/aas-server/src/app/aas-index/mysql/mysql-types.ts @@ -7,19 +7,25 @@ *****************************************************************************/ import { RowDataPacket } from 'mysql2/promise'; -import { AASDocument, AASEndpointType } from 'aas-core'; +import { AASEndpointType } from 'aas-core'; export interface MySqlEndpoint extends RowDataPacket { name: string; url: string; type: AASEndpointType; - version?: string; - headers?: string; - schedule?: string; + version: string | null; + headers: string | null; + schedule: string | null; } -export interface MySqlDocument extends AASDocument, RowDataPacket { +export interface MySqlDocument extends RowDataPacket { uuid: string; + address: string; + crc32: number; + idShort: string; + assetId: string | null; + thumbnail: string | null; + timestamp: number; } export interface MySqlElement extends RowDataPacket { diff --git a/projects/aas-server/src/app/aas-provider/aas-provider.ts b/projects/aas-server/src/app/aas-provider/aas-provider.ts index 4f909999..6d0dc0b2 100644 --- a/projects/aas-server/src/app/aas-provider/aas-provider.ts +++ b/projects/aas-server/src/app/aas-provider/aas-provider.ts @@ -38,7 +38,7 @@ import { AASResourceFactory } from '../packages/aas-resource-factory.js'; import { Variable } from '../variable.js'; import { WSServer } from '../ws-server.js'; import { ERRORS } from '../errors.js'; -import { TaskHandler } from './task-handler.js'; +import { Task, TaskHandler } from './task-handler.js'; import { HierarchicalStructure } from './hierarchical-structure.js'; import { AASCache } from './aas-cache.js'; @@ -237,7 +237,8 @@ export class AASProvider { } as AASServerMessage, }); - setTimeout(this.scanEndpoint, 0, this.taskHandler.createTaskId(), endpoint); + const task = this.taskHandler.createTask(endpointName, this, 'ScanEndpoint'); + setTimeout(this.scanEndpoint, 0, task, endpoint); } /** @@ -261,6 +262,11 @@ export class AASProvider { const endpoint = await this.index.getEndpoint(endpointName); if (endpoint) { await this.index.removeEndpoint(endpoint.name); + const task = this.taskHandler.find(endpointName, 'ScanEndpoint'); + if (task) { + this.taskHandler.delete(task.id); + } + this.logger.info(`Endpoint ${endpoint.name} (${endpoint.url}) removed.`); this.wsServer.notify('IndexChange', { type: 'AASServerMessage', @@ -429,6 +435,27 @@ export class AASProvider { return nodes; } + /** Starts a scan of the AAS endpoint with the specified name. + * @param name The name of the endpoint. + */ + public async startEndpointScan(name: string): Promise { + const endpoint = await this.index.getEndpoint(name); + const task = this.taskHandler.find(name, 'ScanEndpoint'); + if (task === undefined) { + throw new Error(``); + } + + if (endpoint.schedule?.type !== 'manual') { + throw new Error(`Endpoint ${name} is not configured for the manual start of a scan.`); + } + + if (task.state === 'inProgress') { + throw new Error(`Scanning endpoint ${name} is already in progress.`); + } + + setTimeout(this.scanEndpoint, 0, task, endpoint); + } + private async restart(): Promise { this.resetRequested = false; await this.index.reset(); @@ -482,14 +509,16 @@ export class AASProvider { continue; } - setTimeout(this.scanEndpoint, 0, this.taskHandler.createTaskId(), endpoint); + const task = this.taskHandler.createTask(endpoint.name, this, 'ScanEndpoint'); + this.taskHandler.set(task); + setTimeout(this.scanEndpoint, 0, task, endpoint); } } catch (error) { this.logger.error(error); } }; - private computeTimeout(schedule: AASEndpointSchedule | undefined, start?: number): number { + private computeTimeout(schedule: AASEndpointSchedule | undefined, start: number, end: number): number { if (schedule === undefined) { return this.variable.SCAN_ENDPOINT_TIMEOUT; } @@ -498,7 +527,7 @@ export class AASProvider { if (schedule.type === 'every') { const values = schedule.values; if (values && values.length > 0 && typeof values[0] === 'number') { - const timeout = Date.now() - start - values[0]; + const timeout = end - start - values[0]; return timeout >= 0 ? timeout : values[0]; } } @@ -506,15 +535,15 @@ export class AASProvider { return this.variable.SCAN_ENDPOINT_TIMEOUT; } - private scanEndpoint = async (taskId: number, endpoint: AASEndpoint) => { + private scanEndpoint = async (task: Task, endpoint: AASEndpoint) => { const data: ScanEndpointData = { type: 'ScanEndpointData', - taskId, + taskId: task.id, endpoint, - start: Date.now(), }; - this.taskHandler.set(taskId, { endpointName: endpoint.name, owner: this, type: 'ScanEndpoint' }); + task.state = 'inProgress'; + task.start = Date.now(); this.parallel.execute(data); }; @@ -544,21 +573,21 @@ export class AASProvider { private parallelOnEnd = async (result: ScanResult) => { const task = this.taskHandler.get(result.taskId); - if (!task || task.owner !== this) { + if (task === undefined || task.owner !== this) { return; } - this.taskHandler.delete(result.taskId); if ((await this.index.hasEndpoint(task.endpointName)) === true) { const endpoint = await this.index.getEndpoint(task.endpointName); - - if (endpoint.schedule?.type === 'once') { + if (endpoint.schedule?.type === 'once' || endpoint.schedule?.type === 'manual') { return; } + task.state === 'idle'; + task.end = Date.now(); setTimeout( this.scanEndpoint, - this.computeTimeout(endpoint.schedule, result.start), + this.computeTimeout(endpoint.schedule, task.start, task.end), result.taskId, endpoint, ); diff --git a/projects/aas-server/src/app/aas-provider/scan-result.ts b/projects/aas-server/src/app/aas-provider/scan-result.ts index d9a69cc8..25295ad2 100644 --- a/projects/aas-server/src/app/aas-provider/scan-result.ts +++ b/projects/aas-server/src/app/aas-provider/scan-result.ts @@ -20,7 +20,6 @@ export interface ScanResult { type: 'ScanEndResult' | 'ScanEndpointResult' | 'ScanTemplatesResult'; kind: ScanResultKind; taskId: number; - start: number; messages?: Message[]; } diff --git a/projects/aas-server/src/app/aas-provider/task-handler.ts b/projects/aas-server/src/app/aas-provider/task-handler.ts index 760ec767..b4d8d84d 100644 --- a/projects/aas-server/src/app/aas-provider/task-handler.ts +++ b/projects/aas-server/src/app/aas-provider/task-handler.ts @@ -9,9 +9,13 @@ import { singleton } from 'tsyringe'; export interface Task { + id: number; endpointName: string; owner: object; type: 'ScanEndpoint' | 'ScanTemplates'; + state: 'idle' | 'inProgress'; + start: number; + end: number; } @singleton() @@ -28,8 +32,8 @@ export class TaskHandler { return this.tasks.get(taskId); } - public set(taskId: number, task: Task) { - this.tasks.set(taskId, task); + public set(task: Task) { + this.tasks.set(task.id, task); } public empty(owner: object, name?: string): boolean { @@ -42,9 +46,27 @@ export class TaskHandler { return true; } - public createTaskId(): number { - const taskId = this.nextTaskId; + public createTask(endpointName: string, owner: object, type: 'ScanEndpoint' | 'ScanTemplates'): Task { + const id = this.nextTaskId; ++this.nextTaskId; - return taskId; + return { + id, + type, + endpointName, + owner, + state: 'idle', + start: 0, + end: 0, + }; + } + + public find(endpointName: string, type: 'ScanEndpoint' | 'ScanTemplates'): Task | undefined { + for (const task of this.tasks.values()) { + if (task.endpointName === endpointName && type === task.type) { + return task; + } + } + + return undefined; } } diff --git a/projects/aas-server/src/app/aas-provider/worker-data.ts b/projects/aas-server/src/app/aas-provider/worker-data.ts index a2f2592b..47bff72f 100644 --- a/projects/aas-server/src/app/aas-provider/worker-data.ts +++ b/projects/aas-server/src/app/aas-provider/worker-data.ts @@ -11,7 +11,6 @@ import { AASEndpoint } from 'aas-core'; export interface WorkerData { taskId: number; type: 'ScanEndpointData' | 'ScanTemplatesData'; - start: number; } export interface ScanEndpointData extends WorkerData { diff --git a/projects/aas-server/src/app/controller/endpoints-controller.ts b/projects/aas-server/src/app/controller/endpoints-controller.ts index ab21259f..e55a31f7 100644 --- a/projects/aas-server/src/app/controller/endpoints-controller.ts +++ b/projects/aas-server/src/app/controller/endpoints-controller.ts @@ -143,4 +143,20 @@ export class EndpointsController extends AASController { this.logger.stop(); } } + + /** + * @summary Starts a scan of the AAS endpoint with the specified name. + * @param name The endpoint name. + */ + @Post('{name}/scan') + @Security('bearerAuth', ['editor']) + @OperationId('reset') + public async startEndpointScan(@Path() name: string): Promise { + try { + this.logger.start('startEndpointScan'); + await this.aasProvider.startEndpointScan(decodeBase64Url(name)); + } finally { + this.logger.stop(); + } + } } diff --git a/projects/aas-server/src/app/endpoint-scan.ts b/projects/aas-server/src/app/endpoint-scan.ts index 15ec37b1..2bf686c5 100644 --- a/projects/aas-server/src/app/endpoint-scan.ts +++ b/projects/aas-server/src/app/endpoint-scan.ts @@ -62,7 +62,6 @@ export class EndpointScan { kind: ScanResultKind.Update, endpoint: this.data.endpoint, document: document, - start: this.data.start, }; const array = toUint8Array(value); @@ -76,7 +75,6 @@ export class EndpointScan { kind: ScanResultKind.Remove, endpoint: this.data.endpoint, document: document, - start: this.data.start, }; const array = toUint8Array(value); @@ -90,7 +88,6 @@ export class EndpointScan { kind: ScanResultKind.Add, endpoint: this.data.endpoint, document: document, - start: this.data.start, }; const array = toUint8Array(value); diff --git a/projects/aas-server/src/app/template/template-scan.ts b/projects/aas-server/src/app/template/template-scan.ts index ac32c21c..f482e96c 100644 --- a/projects/aas-server/src/app/template/template-scan.ts +++ b/projects/aas-server/src/app/template/template-scan.ts @@ -53,7 +53,6 @@ export class TemplateScan { taskId: data.taskId, kind: ScanResultKind.Update, templates: templates, - start: data.start, }; const array = toUint8Array(value); diff --git a/projects/aas-server/src/app/template/template-storage.ts b/projects/aas-server/src/app/template/template-storage.ts index 07b80eff..b62a9380 100644 --- a/projects/aas-server/src/app/template/template-storage.ts +++ b/projects/aas-server/src/app/template/template-storage.ts @@ -19,7 +19,7 @@ import { AasxDirectory } from '../packages/file-system/aasx-directory.js'; import { ScanTemplatesData } from '../aas-provider/worker-data.js'; import { ScanResult, ScanTemplatesResult } from '../aas-provider/scan-result.js'; import { Parallel } from '../aas-provider/parallel.js'; -import { TaskHandler } from '../aas-provider/task-handler.js'; +import { Task, TaskHandler } from '../aas-provider/task-handler.js'; @singleton() export class TemplateStorage { @@ -72,17 +72,19 @@ export class TemplateStorage { } private startScan = () => { - this.scanTemplates(this.taskHandler.createTaskId()); + const task = this.taskHandler.createTask('TemplateStorage', this, 'ScanTemplates'); + this.taskHandler.set(task); + this.scanTemplates(task); }; - private scanTemplates = async (taskId: number) => { + private scanTemplates = async (task: Task) => { const data: ScanTemplatesData = { type: 'ScanTemplatesData', - taskId, - start: Date.now(), + taskId: task.id, }; - this.taskHandler.set(taskId, { endpointName: 'TemplateStorage', owner: this, type: 'ScanTemplates' }); + task.start = Date.now(); + task.state = 'inProgress'; this.parallel.execute(data); }; @@ -120,11 +122,12 @@ export class TemplateStorage { private parallelOnEnd = (result: ScanResult) => { const task = this.taskHandler.get(result.taskId); - if (!task || task.owner !== this) { + if (task === undefined || task.owner !== this) { return; } - this.taskHandler.delete(result.taskId); + task.state = 'idle'; + task.end = Date.now(); setTimeout(this.scanTemplates, this.timeout, result.taskId); if (result.messages) { diff --git a/projects/aas-server/src/app/worker-app.ts b/projects/aas-server/src/app/worker-app.ts index 63c920a3..04bb22b7 100644 --- a/projects/aas-server/src/app/worker-app.ts +++ b/projects/aas-server/src/app/worker-app.ts @@ -52,7 +52,6 @@ export class WorkerApp { type: 'ScanEndResult', taskId: data.taskId, kind: ScanResultKind.End, - start: data.start, messages: this.logger.getMessages(), }; } diff --git a/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts b/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts index c7fac5a2..ffe78f0d 100644 --- a/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts +++ b/projects/aas-server/src/test/aas-index/mysql/mysql-index.spec.ts @@ -69,19 +69,35 @@ describe('MySqlIndex', () => { name: 'Endpoint 1', url: 'http://endpoint1.com', type: 'AAS_API', + version: 'v3', + headers: null, + schedule: null, }, { constructor: { name: 'RowDataPacket' }, name: 'Endpoint 2', url: 'http://endpoint2.com', type: 'AAS_API', + version: 'v3', + headers: null, + schedule: null, }, ]; connection.query.mockResolvedValue([result, []]); await expect(index.getEndpoints()).resolves.toEqual([ - { name: 'Endpoint 1', url: 'http://endpoint1.com', type: 'AAS_API' }, - { name: 'Endpoint 2', url: 'http://endpoint2.com', type: 'AAS_API' }, + { + name: 'Endpoint 1', + url: 'http://endpoint1.com', + type: 'AAS_API', + version: 'v3', + }, + { + name: 'Endpoint 2', + url: 'http://endpoint2.com', + type: 'AAS_API', + version: 'v3', + }, ]); expect(connection.query).toBeCalledWith('SELECT * FROM `endpoints`;'); @@ -95,12 +111,20 @@ describe('MySqlIndex', () => { name: 'Endpoint 1', url: 'http://endpoint1.com', type: 'AAS_API', + version: 'v3', + headers: null, + schedule: null, }; connection.query.mockResolvedValue([[result], []]); const actual = await index.getEndpoint('Endpoint 1'); expect(connection.query).toBeCalledWith('SELECT * FROM `endpoints` WHERE name = ?;', ['Endpoint 1']); - expect(actual).toEqual({ name: 'Endpoint 1', url: 'http://endpoint1.com', type: 'AAS_API' }); + expect(actual).toEqual({ + name: 'Endpoint 1', + url: 'http://endpoint1.com', + type: 'AAS_API', + version: 'v3', + }); }); it('throws an error if endpoint does not exist', async () => { @@ -117,6 +141,9 @@ describe('MySqlIndex', () => { name: 'Endpoint 1', url: 'http://endpoint1.com', type: 'AAS_API', + version: 'v3', + headers: null, + schedule: null, }; connection.query.mockResolvedValue([[result], []]); @@ -247,7 +274,8 @@ describe('MySqlIndex', () => { address: '', crc32: 0, idShort: 'Shell 1', - readonly: false, + assetId: null, + thumbnail: null, timestamp: 0, id: 'http://document1/aas', endpoint: 'Endpoint 1', @@ -258,7 +286,8 @@ describe('MySqlIndex', () => { address: '', crc32: 0, idShort: 'Shell 2', - readonly: false, + assetId: null, + thumbnail: null, timestamp: 0, id: 'http://document2/aas', endpoint: 'Endpoint 1', diff --git a/projects/aas-server/src/test/template/template-storage.spec.ts b/projects/aas-server/src/test/template/template-storage.spec.ts index 1b55338d..4855d616 100644 --- a/projects/aas-server/src/test/template/template-storage.spec.ts +++ b/projects/aas-server/src/test/template/template-storage.spec.ts @@ -19,7 +19,7 @@ import { TaskHandler } from '../../app/aas-provider/task-handler.js'; import { Parallel } from '../../app/aas-provider/parallel.js'; import { ScanResultKind, ScanTemplatesResult } from '../../app/aas-provider/scan-result.js'; -describe('TemplateStorage', function () { +describe('TemplateStorage', () => { let templateStorage: TemplateStorage; let logger: jest.Mocked; let fileStorage: jest.Mocked; @@ -27,7 +27,7 @@ describe('TemplateStorage', function () { let variable: jest.Mocked; let parallel: jest.Mocked; - beforeEach(function () { + beforeEach(() => { logger = createSpyObj(['error']); fileStorageProvider = createSpyObj(['get']); fileStorage = createSpyObj(['exists', 'readDir', 'readFile']); @@ -40,7 +40,6 @@ describe('TemplateStorage', function () { type: 'ScanTemplatesResult', taskId: 1, kind: ScanResultKind.Update, - start: 0, templates: [ { idShort: 'aSubmodel', @@ -61,12 +60,12 @@ describe('TemplateStorage', function () { templateStorage = new TemplateStorage(logger, variable, fileStorageProvider, parallel, new TaskHandler()); }); - it('should create', function () { + it('should create', () => { expect(templateStorage).toBeTruthy(); }); - describe('getTemplatesAsync', function () { - it('gets all available templates', async function () { + describe('getTemplatesAsync', () => { + it('gets all available templates', async () => { await expect(templateStorage.getTemplatesAsync()).resolves.toEqual([ { idShort: 'aSubmodel', @@ -79,10 +78,10 @@ describe('TemplateStorage', function () { }); }); - describe('readTemplateAsync', function () { + describe('readTemplateAsync', () => { let submodel: aas.Submodel; - beforeEach(function () { + beforeEach(() => { submodel = { id: 'http://aas/submodel', idShort: 'aSubmodel', @@ -91,7 +90,7 @@ describe('TemplateStorage', function () { }; }); - it('reads the template with the address "submodel.json"', async function () { + it('reads the template with the address "submodel.json"', async () => { fileStorage.readFile.mockResolvedValue(Buffer.from(JSON.stringify(submodel))); await expect(templateStorage.readTemplateAsync('submodel.json')).resolves.toEqual(submodel); expect(fileStorage.readFile).toHaveBeenCalledWith('/templates/submodel.json'); diff --git a/projects/aasportal-index/schema.sql b/projects/aasportal-index/schema.sql index 6b95a995..37589a1b 100644 --- a/projects/aasportal-index/schema.sql +++ b/projects/aasportal-index/schema.sql @@ -17,8 +17,6 @@ CREATE TABLE documents ( id VARCHAR(255), idShort VARCHAR(100), assetId VARCHAR(255), - onlineReady BOOL, - readonly BOOL, thumbnail VARCHAR(7167), timestamp LONG ); From 76c6a104a95905efd858f941707930b98352d8f1 Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Mon, 11 Nov 2024 14:51:48 +0100 Subject: [PATCH 18/76] fix: testing EndpointsController --- .../app/controller/endpoints-controller.ts | 10 +-- .../controller/endpoints-controller.spec.ts | 68 ++++++++++++++++--- 2 files changed, 65 insertions(+), 13 deletions(-) diff --git a/projects/aas-server/src/app/controller/endpoints-controller.ts b/projects/aas-server/src/app/controller/endpoints-controller.ts index e55a31f7..e0e1d3fa 100644 --- a/projects/aas-server/src/app/controller/endpoints-controller.ts +++ b/projects/aas-server/src/app/controller/endpoints-controller.ts @@ -69,8 +69,8 @@ export class EndpointsController extends AASController { */ @Get('{name}/documents/count') @Security('bearerAuth', ['guest']) - @OperationId('getEndpointCount') - public async getEndpointCount(@Path() name: string): Promise<{ count: number }> { + @OperationId('getDocumentCount') + public async getDocumentCount(@Path() name: string): Promise<{ count: number }> { try { this.logger.start('getCount'); return { count: await this.aasProvider.getCountAsync(decodeBase64Url(name)) }; @@ -130,7 +130,7 @@ export class EndpointsController extends AASController { } /** - * @summary Resets the AASServer container configuration. + * @summary Resets the AAS endpoint configuration. */ @Delete('') @Security('bearerAuth', ['editor']) @@ -148,9 +148,9 @@ export class EndpointsController extends AASController { * @summary Starts a scan of the AAS endpoint with the specified name. * @param name The endpoint name. */ - @Post('{name}/scan') + @Put('{name}/scan') @Security('bearerAuth', ['editor']) - @OperationId('reset') + @OperationId('startEndpointScan') public async startEndpointScan(@Path() name: string): Promise { try { this.logger.start('startEndpointScan'); diff --git a/projects/aas-server/src/test/controller/endpoints-controller.spec.ts b/projects/aas-server/src/test/controller/endpoints-controller.spec.ts index 74539cc7..a4d45df6 100644 --- a/projects/aas-server/src/test/controller/endpoints-controller.spec.ts +++ b/projects/aas-server/src/test/controller/endpoints-controller.spec.ts @@ -46,9 +46,13 @@ describe('EndpointsController', function () { aasProvider = createSpyObj([ 'getEndpoints', + 'getEndpointCount', 'addEndpointAsync', + 'updateEndpointAsync', 'removeEndpointAsync', + 'getCountAsync', 'resetAsync', + 'startEndpointScan', ]); authentication = createSpyObj(['checkAsync']); @@ -70,7 +74,7 @@ describe('EndpointsController', function () { app.use(errorHandler); }); - it('getEndpoints: /api/v1/endpoints', async function () { + it('GET: /api/v1/endpoints', async () => { const endpoints: AASEndpoint = { name: 'Test', url: 'http://localhost:1234', @@ -79,18 +83,36 @@ describe('EndpointsController', function () { aasProvider.getEndpoints.mockResolvedValue([endpoints]); const response = await request(app).get('/api/v1/endpoints').set('Authorization', `Bearer ${getToken()}`); - expect(response.statusCode).toBe(200); expect(response.body).toEqual([endpoints]); expect(aasProvider.getEndpoints).toHaveBeenCalled(); }); - it('POST: /api/v1/endpoints/:name', async function () { + it('GET: /api/v1/endpoints/count', async () => { + aasProvider.getEndpointCount.mockResolvedValue(42); + const response = await request(app).get('/api/v1/endpoints/count').set('Authorization', `Bearer ${getToken()}`); + expect(response.statusCode).toBe(200); + expect(response.body).toEqual({ count: 42 }); + expect(aasProvider.getEndpointCount).toHaveBeenCalled(); + }); + + it('GET: /api/v1/endpoints/{name}/documents/count', async () => { + aasProvider.getCountAsync.mockResolvedValue(42); + const response = await request(app) + .get('/api/v1/endpoints/U2FtcGxlcw/documents/count') + .set('Authorization', `Bearer ${getToken()}`); + + expect(response.statusCode).toBe(200); + expect(response.body).toEqual({ count: 42 }); + expect(aasProvider.getCountAsync).toHaveBeenCalledWith('Samples'); + }); + + it('POST: /api/v1/endpoints/{name}', async () => { const endpoint: AASEndpoint = { name: 'Samples', url: 'file:///assets/samples', type: 'FileSystem' }; aasProvider.addEndpointAsync.mockResolvedValue(); auth.hasUserAsync.mockResolvedValue(true); const response = await request(app) - .post('/api/v1/endpoints/samples') + .post('/api/v1/endpoints/U2FtcGxlcw') .set('Authorization', `Bearer ${getToken('John')}`) .send(endpoint); @@ -98,18 +120,37 @@ describe('EndpointsController', function () { expect(aasProvider.addEndpointAsync).toHaveBeenCalled(); }); - it('DELETE: /api/v1/endpoints/:name', async function () { + it('PUT: /api/v1/endpoints/{name}', async () => { + const endpoint: AASEndpoint = { + name: 'Samples', + url: 'file:///assets/samples', + type: 'FileSystem', + schedule: { type: 'manual' }, + }; + + aasProvider.updateEndpointAsync.mockResolvedValue(); + auth.hasUserAsync.mockResolvedValue(true); + const response = await request(app) + .put('/api/v1/endpoints/U2FtcGxlcw') + .set('Authorization', `Bearer ${getToken('John')}`) + .send(endpoint); + + expect(response.statusCode).toBe(204); + expect(aasProvider.updateEndpointAsync).toHaveBeenCalledWith('Samples', endpoint); + }); + + it('DELETE: /api/v1/endpoints/{name}', async () => { aasProvider.removeEndpointAsync.mockReturnValue(new Promise(resolve => resolve())); auth.hasUserAsync.mockReturnValue(new Promise(resolve => resolve(true))); const response = await request(app) - .delete('/api/v1/endpoints/samples') + .delete('/api/v1/endpoints/U2FtcGxlcw') .set('Authorization', `Bearer ${getToken('John')}`); expect(response.statusCode).toBe(204); - expect(aasProvider.removeEndpointAsync).toHaveBeenCalled(); + expect(aasProvider.removeEndpointAsync).toHaveBeenCalledWith('Samples'); }); - it('reset: /api/v1/endpoints', async function () { + it('DELETE: /api/v1/endpoints', async () => { auth.hasUserAsync.mockReturnValue(new Promise(resolve => resolve(true))); aasProvider.resetAsync.mockReturnValue(new Promise(resolve => resolve())); const response = await request(app) @@ -119,4 +160,15 @@ describe('EndpointsController', function () { expect(response.statusCode).toBe(204); expect(aasProvider.resetAsync).toHaveBeenCalled(); }); + + it('PUT: /api/v1/endpoints/{name}/scan', async () => { + auth.hasUserAsync.mockReturnValue(new Promise(resolve => resolve(true))); + aasProvider.startEndpointScan.mockReturnValue(new Promise(resolve => resolve())); + const response = await request(app) + .put('/api/v1/endpoints/U2FtcGxlcw/scan') + .set('Authorization', `Bearer ${getToken('John')}`); + + expect(response.statusCode).toBe(204); + expect(aasProvider.startEndpointScan).toHaveBeenCalledWith('Samples'); + }); }); From 8dc15203861b1d6bdd6b5be330ade8d0a45defae Mon Sep 17 00:00:00 2001 From: Ralf Aron Date: Tue, 12 Nov 2024 17:49:01 +0100 Subject: [PATCH 19/76] fix: bug fixing --- package-lock.json | 1 + .../src/app/start/start.component.html | 4 ++-- .../aas-portal/src/assets/i18n/de-de.json | 5 +++-- .../aas-portal/src/assets/i18n/en-us.json | 5 +++-- .../aas-server/src/app/aas-index/aas-index.ts | 2 +- .../src/app/aas-index/lowdb/lowdb-index.ts | 20 +++++++++++-------- .../src/app/aas-index/mysql/mysql-index.ts | 16 +++++++-------- 7 files changed, 30 insertions(+), 23 deletions(-) diff --git a/package-lock.json b/package-lock.json index ad67e2cd..e09d0fd3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -31537,6 +31537,7 @@ "dependencies": { "@babel/polyfill": "^7.4.4", "@xmldom/xmldom": "^0.8.10", + "axios": "^1.7.7", "bcryptjs": "^2.4.3", "chalk": "^2.4.1", "cors": "^2.8.5", diff --git a/projects/aas-portal/src/app/start/start.component.html b/projects/aas-portal/src/app/start/start.component.html index 06afb416..84b39526 100644 --- a/projects/aas-portal/src/app/start/start.component.html +++ b/projects/aas-portal/src/app/start/start.component.html @@ -53,8 +53,8 @@ }
-