Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(digitalTwin): correct race condition #398

Merged
merged 4 commits into from
Jan 30, 2025
Merged

fix(digitalTwin): correct race condition #398

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
34d606b
fix(digitalTwin): correct race condition
sebtiz13 Jan 29, 2025
2008b9e
fix(deviceServices): homogenize devices lock
sebtiz13 Jan 30, 2025
afa342a
test(assets): increase timeout for tests
sebtiz13 Jan 30, 2025
23562f8
fix(device): separate internal logic without lock
sebtiz13 Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
237 changes: 128 additions & 109 deletions lib/modules/asset/AssetService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,63 +143,65 @@ export class AssetService extends DigitalTwinService {
metadata: Metadata,
request: KuzzleRequest,
): Promise<KDocument<AssetContent>> {
const asset = await this.get(engineId, assetId, request);
const unknownMetadata = {};
for (const key in metadata) {
if (key in asset._source.metadata) {
asset._source.metadata[key] = metadata[key];
} else {
unknownMetadata[key] = metadata[key];
return lock(`asset:${engineId}:${assetId}`, async () => {
const asset = await this.get(engineId, assetId, request);
const unknownMetadata = {};
for (const key in metadata) {
if (key in asset._source.metadata) {
asset._source.metadata[key] = metadata[key];
} else {
unknownMetadata[key] = metadata[key];
}
}
}
// ? If metadata key is unknown on the asset we check that it exists in the assetModel mappings
if (Object.keys(unknownMetadata).length > 0) {
const assetModel = await ask<AskModelAssetGet>(
"ask:device-manager:model:asset:get",
{ engineGroup: engineId.split("-")[1], model: asset._source.model },
);
for (const key in unknownMetadata) {
if (key in assetModel.asset.metadataMappings) {
asset._source.metadata[key] = unknownMetadata[key];
// ? If metadata key is unknown on the asset we check that it exists in the assetModel mappings
if (Object.keys(unknownMetadata).length > 0) {
const assetModel = await ask<AskModelAssetGet>(
"ask:device-manager:model:asset:get",
{ engineGroup: engineId.split("-")[1], model: asset._source.model },
);
for (const key in unknownMetadata) {
if (key in assetModel.asset.metadataMappings) {
asset._source.metadata[key] = unknownMetadata[key];
}
}
}
}
const updatedPayload = await this.app.trigger<EventAssetUpdateBefore>(
"device-manager:asset:update:before",
{ asset, metadata },
);
const updatedPayload = await this.app.trigger<EventAssetUpdateBefore>(
"device-manager:asset:update:before",
{ asset, metadata },
);

const updatedAsset = await this.sdk.document.replace<AssetContent>(
engineId,
InternalCollection.ASSETS,
assetId,
updatedPayload.asset._source,
{ triggerEvents: true },
);
const updatedAsset = await this.sdk.document.replace<AssetContent>(
engineId,
InternalCollection.ASSETS,
assetId,
updatedPayload.asset._source,
{ triggerEvents: true },
);

await this.assetHistoryService.add<AssetHistoryEventMetadata>(engineId, [
{
asset: updatedAsset._source,
event: {
metadata: {
names: Object.keys(flattenObject(updatedPayload.metadata)),
await this.assetHistoryService.add<AssetHistoryEventMetadata>(engineId, [
{
asset: updatedAsset._source,
event: {
metadata: {
names: Object.keys(flattenObject(updatedPayload.metadata)),
},
name: "metadata",
},
name: "metadata",
id: updatedAsset._id,
timestamp: Date.now(),
},
id: updatedAsset._id,
timestamp: Date.now(),
},
]);
]);

await this.app.trigger<EventAssetUpdateAfter>(
"device-manager:asset:update:after",
{
asset: updatedAsset,
metadata: updatedPayload.metadata,
},
);
await this.app.trigger<EventAssetUpdateAfter>(
"device-manager:asset:update:after",
{
asset: updatedAsset,
metadata: updatedPayload.metadata,
},
);

return updatedAsset;
return updatedAsset;
});
}

/**
Expand All @@ -212,14 +214,22 @@ export class AssetService extends DigitalTwinService {
metadata: Metadata,
request: KuzzleRequest,
): Promise<KDocument<AssetContent>> {
const assetId = `${model}-${reference}`;
const assetId = AssetSerializer.id(model, reference);

return lock(`asset:${engineId}:${assetId}`, async () => {
const asset = await this.get(engineId, assetId, request).catch(
() => null,
);

if (!asset) {
return this.create(engineId, model, reference, metadata, request);
return this._create(
assetId,
engineId,
model,
reference,
metadata,
request,
);
}

const updatedPayload = await this.app.trigger<EventAssetUpdateBefore>(
Expand Down Expand Up @@ -266,80 +276,89 @@ export class AssetService extends DigitalTwinService {
});
}

/**
* Create an asset metadata
*/
public async create(
private async _create(
assetId: string,
engineId: string,
model: string,
reference: string,
metadata: JSONObject,
request: KuzzleRequest,
): Promise<KDocument<AssetContent>> {
const assetId = AssetSerializer.id(model, reference);

return lock(`asset:${engineId}:${assetId}`, async () => {
const engine = await this.getEngine(engineId);
const assetModel = await ask<AskModelAssetGet>(
"ask:device-manager:model:asset:get",
{ engineGroup: engine.group, model },
);
const engine = await this.getEngine(engineId);
const assetModel = await ask<AskModelAssetGet>(
"ask:device-manager:model:asset:get",
{ engineGroup: engine.group, model },
);

const assetMetadata = {};
for (const metadataName of Object.keys(
assetModel.asset.metadataMappings,
)) {
assetMetadata[metadataName] = null;
}
for (const [metadataName, metadataValue] of Object.entries(
assetModel.asset.defaultMetadata,
)) {
_.set(assetMetadata, metadataName, metadataValue);
}
const assetMetadata = {};
for (const metadataName of Object.keys(assetModel.asset.metadataMappings)) {
assetMetadata[metadataName] = null;
}
for (const [metadataName, metadataValue] of Object.entries(
assetModel.asset.defaultMetadata,
)) {
_.set(assetMetadata, metadataName, metadataValue);
}

const measures: Record<string, EmbeddedMeasure> = {};
const measures: Record<string, EmbeddedMeasure> = {};

for (const { name } of assetModel.asset.measures) {
measures[name] = null;
}
for (const { name } of assetModel.asset.measures) {
measures[name] = null;
}

const asset = await this.createDocument<AssetContent>(
request,
{
_id: assetId,
_source: {
groups: [],
lastMeasuredAt: null,
linkedDevices: [],
measures,
metadata: { ...assetMetadata, ...metadata },
model,
reference,
softTenant: [],
},
},
{
collection: InternalCollection.ASSETS,
engineId,
const asset = await this.createDocument<AssetContent>(
request,
{
_id: assetId,
_source: {
groups: [],
lastMeasuredAt: null,
linkedDevices: [],
measures,
metadata: { ...assetMetadata, ...metadata },
model,
reference,
softTenant: [],
},
);
},
{
collection: InternalCollection.ASSETS,
engineId,
},
);

await this.assetHistoryService.add<AssetHistoryEventMetadata>(engineId, [
{
asset: asset._source,
event: {
metadata: {
names: Object.keys(flattenObject(asset._source.metadata)),
},
name: "metadata",
await this.assetHistoryService.add<AssetHistoryEventMetadata>(engineId, [
{
asset: asset._source,
event: {
metadata: {
names: Object.keys(flattenObject(asset._source.metadata)),
},
id: asset._id,
timestamp: Date.now(),
name: "metadata",
},
]);
id: asset._id,
timestamp: Date.now(),
},
]);

return asset;
});
return asset;
}

/**
* Create an asset metadata
*/
public async create(
engineId: string,
model: string,
reference: string,
metadata: JSONObject,
request: KuzzleRequest,
): Promise<KDocument<AssetContent>> {
const assetId = AssetSerializer.id(model, reference);

return lock(`asset:${engineId}:${assetId}`, async () =>
this._create(assetId, engineId, model, reference, metadata, request),
);
}

/**
Expand Down
Loading
Loading