Merge branch 'feat-sort-assets-in-VERIFIED-tab-by-uploaded_at' into v240104-capture-cam-ionic-launch

Author: sultanmyrza

src/app/features/home/capture-tab/capture-tab.component.ts

@@ -95,7 +95,9 @@ export class CaptureTabComponent implements OnInit {
   );
 
   readonly captures$ = this.proofs$.pipe(
-    map(proofs => proofs.sort((a, b) => b.timestamp - a.timestamp))
+    map(proofs =>
+      proofs.sort((a, b) => b.uploadedAtOrTimestamp - a.uploadedAtOrTimestamp)
+    )
   );
 
   readonly networkConnected$ = this.networkService.connected$;

src/app/shared/dia-backend/asset/dia-backend-asset-repository.service.ts

@@ -357,6 +357,7 @@ export interface DiaBackendAsset extends Tuple {
   readonly caption: string;
   readonly post_creation_workflow_id: string;
   readonly mint_workflow_id: string;
+  readonly uploaded_at: string;
 }
 
 export interface OwnerAddresses extends Tuple {

src/app/shared/dia-backend/asset/downloading/dia-backend-downloading.service.ts

@@ -81,6 +81,7 @@ export class DiaBackendAssetDownloadingService {
     });
     proof.diaBackendAssetId = diaBackendAsset.id;
     proof.caption = diaBackendAsset.caption;
+    proof.uploadedAt = diaBackendAsset.uploaded_at;
     if (diaBackendAsset.signed_metadata) proof.setSignatureVersion();
     return this.proofRepository.add(proof, OnConflictStrategy.REPLACE);
   }

src/app/shared/dia-backend/asset/uploading/dia-backend-asset-uploading.service.ts

@@ -145,6 +145,7 @@ export class DiaBackendAssetUploadingService {
       }),
       map(diaBackendAsset => {
         proof.diaBackendAssetId = diaBackendAsset.id;
+        proof.uploadedAt = diaBackendAsset.uploaded_at;
         return proof;
       }),
       retryWhen(err$ =>

src/app/shared/repositories/proof/proof.spec.ts

@@ -287,6 +287,43 @@ describe('Proof utils', () => {
     const expected = `{\n  "asset_mime_type": "${ASSET1_MIMETYPE}",\n  "caption": "",\n  "created_at": ${TIMESTAMP},\n  "device_name": "${DEVICE_NAME_VALUE1}",\n  "information": {\n    "device.device_name": "${DEVICE_NAME_VALUE2}",\n    "device.humidity": 0.8,\n    "geolocation.geolocation_latitude": ${GEOLOCATION_LATITUDE2},\n    "geolocation.geolocation_longitude": ${GEOLOCATION_LONGITUDE2}\n  },\n  "location_latitude": ${GEOLOCATION_LATITUDE1},\n  "location_longitude": ${GEOLOCATION_LONGITUDE1},\n  "proof_hash": "${ASSET1_SHA256SUM}",\n  "recorder": "Capture",\n  "spec_version": "2.0.0"\n}`;
     expect(getSerializedSortedProofMetadata(ProofMetadata)).toEqual(expected);
   });
+
+  describe('uploadedAtOrTimestamp', () => {
+    it('should return timestamp in milliseconds when uploadedAt is undefined', async () => {
+      proof = await Proof.from(mediaStore, ASSETS, TRUTH, SIGNATURES_VALID);
+      expect(proof.uploadedAtOrTimestamp).toEqual(TRUTH.timestamp);
+    });
+
+    it('should return uploadedAt in milliseconds when uploadedAt is defined', async () => {
+      const date = '2023-12-21T01:15:17Z'; // sample returned by API
+      const dateInMilliseconds = Date.parse(date);
+
+      proof = await Proof.from(mediaStore, ASSETS, TRUTH, SIGNATURES_VALID);
+      proof.uploadedAt = date;
+
+      expect(proof.uploadedAtOrTimestamp).toEqual(dateInMilliseconds);
+    });
+
+    it('should return timestamp in milliseconds when uploadedAt is not a valid date', async () => {
+      proof = await Proof.from(mediaStore, ASSETS, TRUTH, SIGNATURES_VALID);
+      proof.uploadedAt = 'invalid date';
+      expect(proof.uploadedAtOrTimestamp).toEqual(TRUTH.timestamp);
+    });
+
+    it('should return timestamp in milliseconds when its in seconds', async () => {
+      const timestamp = 1627545600; // 29th July 2021 12:00:00 GMT
+      const timestampInMilliseconds = timestamp * 1000;
+
+      proof = await Proof.from(
+        mediaStore,
+        ASSETS,
+        { ...TRUTH, timestamp },
+        SIGNATURES_VALID
+      );
+
+      expect(proof.uploadedAtOrTimestamp).toEqual(timestampInMilliseconds);
+    });
+  });
 });
 
 const ASSET1_MIMETYPE: MimeType = 'image/png';

src/app/shared/repositories/proof/proof.ts

@@ -32,6 +32,13 @@ export class Proof {
    */
   caption = '';
 
+  /**
+   * The timestamp when the asset is uploaded to the backend, in the format "2023-12-21T01:15:17Z".
+   * By default, it is undefined. Once the asset is successfully uploaded, the uploadedAt property
+   * will be set to the timestamp provided by the backend.
+   */
+  uploadedAt?: string = undefined;
+
   isCollected = false;
 
   signatures: Signatures = {};
@@ -47,6 +54,32 @@ export class Proof {
    */
   cameraSource: CameraSource = CameraSource.Camera;
 
+  /**
+   * Used to sort the assets in the VERIFIED tab either by timestamp or uploadedAt (if available).
+   */
+  get uploadedAtOrTimestamp() {
+    const MILLISECONDS_PER_SECOND = 1000;
+    const LENGTH_IN_MILLISECONDS = 13;
+
+    // convert timestamp to milliseconds if needed
+    const proofTimestampInMilliseconds =
+      this.timestamp.toString().length === LENGTH_IN_MILLISECONDS
+        ? this.timestamp
+        : this.timestamp * MILLISECONDS_PER_SECOND;
+
+    const serverTimestampInMilliseconds = Date.parse(this.uploadedAt ?? '');
+    return serverTimestampInMilliseconds || proofTimestampInMilliseconds;
+  }
+
+  /**
+   * The timestamp when the proof was first created or captured. Different from uploadedAt
+   * The timestamp is generated using Date.now() and is represented in milliseconds.
+   *
+   * Note: After restoring or syncing with the backend assets, the timestamp will be in seconds.
+   * For more details, refer to https://github.com/numbersprotocol/storage-backend/issues/976
+   *
+   * Note: Milliseconds are 13 digits long, while seconds are 10 digits long.
+   */
   get timestamp() {
     return this.truth.timestamp;
   }
@@ -127,6 +160,7 @@ export class Proof {
     proof.setIndexedAssets(indexedProofView.indexedAssets);
     proof.diaBackendAssetId = indexedProofView.diaBackendAssetId;
     proof.caption = indexedProofView.caption ?? '';
+    proof.uploadedAt = indexedProofView.uploadedAt;
     proof.isCollected = indexedProofView.isCollected ?? false;
     proof.signatureVersion = indexedProofView.signatureVersion;
     proof.integritySha = indexedProofView.integritySha;
@@ -298,6 +332,7 @@ export class Proof {
       signatureVersion: this.signatureVersion,
       diaBackendAssetId: this.diaBackendAssetId,
       caption: this.caption,
+      uploadedAt: this.uploadedAt,
       isCollected: this.isCollected,
       integritySha: this.integritySha,
       cameraSource: this.cameraSource,
@@ -433,6 +468,7 @@ export interface IndexedProofView extends Tuple {
   readonly signatureVersion?: string;
   readonly diaBackendAssetId?: string;
   readonly caption?: string;
+  readonly uploadedAt?: string;
   readonly isCollected?: boolean;
   readonly integritySha?: string;
   readonly cameraSource: CameraSource;