Add attributeForwardingDetailsQuery to GetOwnAttributesSharedWithPeerRequest (#825)

* feat: add attributeForwardingDetails query to GetOwnAttributesSharedWithPeer

* test: query

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Author: Milena-Czierlinski

packages/consumption/src/modules/attributes/AttributesController.ts

@@ -1574,15 +1574,27 @@ export class AttributesController extends ConsumptionBaseController {
         return docs.map((doc) => AttributeForwardingDetails.from(doc));
     }
 
-    public async getAttributesExchangedWithPeer(peer: CoreAddress, query: any, hideTechnical = false, onlyLatestVersions = true): Promise<LocalAttribute[]> {
-        const attributesForwardedToPeer = await this.getAttributesForwardedToPeer(peer, query, hideTechnical, onlyLatestVersions);
+    public async getAttributesExchangedWithPeer(
+        peer: CoreAddress,
+        query: any,
+        attributeForwardingDetailsQuery?: any,
+        hideTechnical = false,
+        onlyLatestVersions = true
+    ): Promise<LocalAttribute[]> {
+        const attributesForwardedToPeer = await this.getAttributesForwardedToPeer(peer, query, attributeForwardingDetailsQuery, hideTechnical, onlyLatestVersions);
         const attributesWithPeer = await this.getAttributesWithPeer(peer, query, hideTechnical, onlyLatestVersions);
 
         return [...attributesForwardedToPeer, ...attributesWithPeer];
     }
 
-    public async getAttributesForwardedToPeer(peer: CoreAddress, query: any, hideTechnical = false, onlyLatestVersions = true): Promise<LocalAttribute[]> {
-        const forwardingDetailsDocs = await this.forwardingDetails.find({ peer: peer.toString() });
+    public async getAttributesForwardedToPeer(
+        peer: CoreAddress,
+        query: any,
+        attributeForwardingDetailsQuery?: any,
+        hideTechnical = false,
+        onlyLatestVersions = true
+    ): Promise<LocalAttribute[]> {
+        const forwardingDetailsDocs = await this.forwardingDetails.find({ ...attributeForwardingDetailsQuery, peer: peer.toString() });
         const forwardingDetails = forwardingDetailsDocs.map((doc) => AttributeForwardingDetails.from(doc));
 
         const attributeIds = [...new Set(forwardingDetails.map((details) => details.attributeId.toString()))];

packages/runtime/src/useCases/common/Schemas.ts

@@ -13815,6 +13815,9 @@ export const GetOwnAttributesSharedWithPeerRequest: any = {
                 "query": {
                     "$ref": "#/definitions/GetOwnAttributesSharedWithPeerRequestQuery"
                 },
+                "attributeForwardingDetailsQuery": {
+                    "$ref": "#/definitions/GetOwnAttributesSharedWithPeerRequestAttributeForwardingDetailsQuery"
+                },
                 "hideTechnical": {
                     "type": "boolean"
                 },
@@ -13989,6 +13992,77 @@ export const GetOwnAttributesSharedWithPeerRequest: any = {
                 }
             },
             "additionalProperties": false
+        },
+        "GetOwnAttributesSharedWithPeerRequestAttributeForwardingDetailsQuery": {
+            "type": "object",
+            "properties": {
+                "sourceReference": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ]
+                },
+                "sharedAt": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ]
+                },
+                "deletionInfo": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ]
+                },
+                "deletionInfo.deletionStatus": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ]
+                },
+                "deletionInfo.deletionDate": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ]
+                }
+            },
+            "additionalProperties": false
         }
     }
 }

packages/runtime/src/useCases/consumption/attributes/DeleteSharedAttributesForRejectedOrRevokedRelationship.ts

@@ -51,6 +51,7 @@ export class DeleteSharedAttributesForRejectedOrRevokedRelationshipUseCase exten
         const forwardedAttributes = (await this.attributesController.getAttributesForwardedToPeer(
             relationship.peer.address,
             { "@type": { $in: ["OwnIdentityAttribute", "OwnRelationshipAttribute", "PeerRelationshipAttribute"] } },
+            {},
             undefined,
             false
         )) as (OwnIdentityAttribute | OwnRelationshipAttribute | PeerRelationshipAttribute)[];

packages/runtime/src/useCases/consumption/attributes/GetOwnAttributesSharedWithPeer.ts

@@ -7,10 +7,12 @@ import { AddressString, SchemaRepository, SchemaValidator, UseCase } from "../..
 import { flattenObject } from "../../common/flattenObject";
 import { AttributeMapper } from "./AttributeMapper";
 import { GetAttributesRequestQuery, GetAttributesUseCase } from "./GetAttributes";
+import { GetForwardingDetailsForAttributeUseCase } from "./GetForwardingDetailsForAttribute";
 
 export interface GetOwnAttributesSharedWithPeerRequest {
     peer: AddressString;
     query?: GetOwnAttributesSharedWithPeerRequestQuery;
+    attributeForwardingDetailsQuery?: GetOwnAttributesSharedWithPeerRequestAttributeForwardingDetailsQuery;
     hideTechnical?: boolean;
     /**
      * default: true
@@ -35,6 +37,14 @@ export interface GetOwnAttributesSharedWithPeerRequestQuery {
     "deletionInfo.deletionDate"?: string | string[];
 }
 
+export interface GetOwnAttributesSharedWithPeerRequestAttributeForwardingDetailsQuery {
+    sourceReference?: string | string[];
+    sharedAt?: string | string[];
+    deletionInfo?: string | string[];
+    "deletionInfo.deletionStatus"?: string | string[];
+    "deletionInfo.deletionDate"?: string | string[];
+}
+
 class Validator extends SchemaValidator<GetOwnAttributesSharedWithPeerRequest> {
     public constructor(@Inject schemaRepository: SchemaRepository) {
         super(schemaRepository.getSchema("GetOwnAttributesSharedWithPeerRequest"));
@@ -51,15 +61,18 @@ export class GetOwnAttributesSharedWithPeerUseCase extends UseCase<GetOwnAttribu
 
     protected async executeInternal(request: GetOwnAttributesSharedWithPeerRequest): Promise<Result<LocalAttributeDTO[]>> {
         const query: GetAttributesRequestQuery = request.query ?? {};
-
         const flattenedQuery = flattenObject(query);
         const dbQuery = GetAttributesUseCase.queryTranslator.parse(flattenedQuery);
+        dbQuery["@type"] = dbQuery["@type"] ?? { $in: ["OwnIdentityAttribute", "OwnRelationshipAttribute"] };
 
-        dbQuery["@type"] = { $in: ["OwnIdentityAttribute", "OwnRelationshipAttribute"] };
+        const attributeForwardingDetailsQuery = request.attributeForwardingDetailsQuery ?? {};
+        const flattenedAttributeForwardingDetailsQuery = flattenObject(attributeForwardingDetailsQuery);
+        const dbAttributeForwardingDetailsQuery = GetForwardingDetailsForAttributeUseCase.queryTranslator.parse(flattenedAttributeForwardingDetailsQuery);
 
         const attributes = await this.attributeController.getAttributesExchangedWithPeer(
             CoreAddress.from(request.peer),
             dbQuery,
+            dbAttributeForwardingDetailsQuery,
             request.hideTechnical,
             request.onlyLatestVersions
         );

packages/runtime/src/useCases/transport/relationships/GetAttributesForRelationship.ts

@@ -39,7 +39,7 @@ export class GetAttributesForRelationshipUseCase extends UseCase<GetAttributesFo
             return Result.fail(RuntimeErrors.general.recordNotFound(Relationship));
         }
 
-        const attributes = await this.attributesController.getAttributesExchangedWithPeer(relationship.peer.address, {}, request.hideTechnical, request.onlyLatestVersions);
+        const attributes = await this.attributesController.getAttributesExchangedWithPeer(relationship.peer.address, {}, {}, request.hideTechnical, request.onlyLatestVersions);
 
         return Result.ok(AttributeMapper.toAttributeDTOList(attributes));
     }

packages/runtime/test/consumption/attributes.test.ts

@@ -31,6 +31,7 @@ import {
     ForwardedAttributeDeletedByPeerEvent,
     GetAttributeUseCase,
     GetAttributesUseCase,
+    GetOwnAttributesSharedWithPeerRequest,
     GetOwnAttributesSharedWithPeerUseCase,
     GetOwnIdentityAttributesUseCase,
     GetPeerAttributesUseCase,
@@ -605,6 +606,31 @@ describe("get OwnIdentityAttributes, own Attributes shared with peer and peer At
             const ownAttributesSharedWithPeer = result.value;
             expect(ownAttributesSharedWithPeer).toStrictEqual([updatedServices1OwnGivenNameV1, services1OwnRelationshipAttributeV1, services1TechnicalOwnRelationshipAttribute]);
         });
+
+        test("should return an attribute if it matches the (AttributeForwardingDetails)Query", async function () {
+            const forwardingDetails = (await services1.consumption.attributes.getForwardingDetailsForAttribute({ attributeId: services1OwnGivenNameV1.id })).value;
+            const sharedAt = forwardingDetails[0].sharedAt;
+
+            const request: GetOwnAttributesSharedWithPeerRequest = {
+                peer: services2.address,
+                query: { "@type": "OwnIdentityAttribute" },
+                attributeForwardingDetailsQuery: { sharedAt }
+            };
+
+            const matchingAttributes = (await services1.consumption.attributes.getOwnAttributesSharedWithPeer(request)).value;
+            expect(matchingAttributes).toStrictEqual([services1OwnGivenNameV1]);
+        });
+
+        test("should not return an attribute if it doesn't match the (AttributeForwardingDetails)Query", async function () {
+            const request: GetOwnAttributesSharedWithPeerRequest = {
+                peer: services2.address,
+                query: { "@type": "OwnIdentityAttribute" },
+                attributeForwardingDetailsQuery: { sharedAt: "anotherTime" }
+            };
+
+            const matchingAttributes = (await services1.consumption.attributes.getOwnAttributesSharedWithPeer(request)).value;
+            expect(matchingAttributes).toHaveLength(0);
+        });
     });
 
     describe(GetPeerAttributesUseCase.name, () => {