Add FavoriteInfo to Photo and Video models

extensions/data-transfer/portability-data-transfer-google/src/main/java/org/datatransferproject/datatransfer/google/mediaModels/GoogleMediaItem.java

@@ -30,6 +30,7 @@
 import java.util.Optional;
 import org.datatransferproject.types.common.models.photos.PhotoModel;
 import org.datatransferproject.types.common.models.videos.VideoModel;
+import org.datatransferproject.types.common.models.FavoriteInfo;
 import org.apache.tika.Tika;
 import com.google.common.base.Strings;
 
@@ -68,6 +69,9 @@ public class GoogleMediaItem implements Serializable {
   //  services use to display the photos timeline, instead of uploadTime.
   private Date uploadedTime;
 
+  @JsonProperty("favoriteInfo")
+  private FavoriteInfo favoriteInfo;
+
   public boolean isPhoto() {
     return this.getMediaMetadata().getPhoto() != null;
   }
@@ -99,7 +103,8 @@ public static VideoModel convertToVideoModel(
         mediaItem.getId(),
         albumId.orElse(null),
         false /*inTempStore*/,
-        getCreationTime(mediaItem));
+        getCreationTime(mediaItem),
+        new FavoriteInfo(getFavorite(mediaItem), getLastUpdateTime(mediaItem)));
   }
 
   public static PhotoModel convertToPhotoModel (
@@ -115,7 +120,8 @@ public static PhotoModel convertToPhotoModel (
         albumId.orElse(null),
         false  /*inTempStore*/,
         null  /*sha1*/,
-        getCreationTime(mediaItem));
+        getCreationTime(mediaItem),
+        new FavoriteInfo(getFavorite(mediaItem), getLastUpdateTime(mediaItem)));
   }
 
   /**
@@ -235,4 +241,16 @@ public Date getUploadedTime() {
   public void setUploadedTime(Date date) {
     this.uploadedTime = date;
   }
-}
+
+  public void setFavoriteInfo(FavoriteInfo favoriteInfo) {
+    this.favoriteInfo = favoriteInfo;
+  }
+  public static boolean getFavorite(GoogleMediaItem mediaItem)  {
+    return mediaItem.favoriteInfo != null && mediaItem.favoriteInfo.getFavorited();
+  }
+
+  public static Date getLastUpdateTime(GoogleMediaItem mediaItem) throws ParseException  {
+    return (mediaItem.favoriteInfo == null  || mediaItem.favoriteInfo.getLastUpdateTime() == null)
+        ? getCreationTime(mediaItem) : mediaItem.favoriteInfo.getLastUpdateTime();
+  }
+}

extensions/data-transfer/portability-data-transfer-google/src/test/java/org/datatransferproject/datatransfer/google/mediaModels/GoogleMediaItemTest.java

@@ -16,6 +16,7 @@
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Optional;
+import org.datatransferproject.types.common.models.FavoriteInfo;
 import org.datatransferproject.types.common.models.photos.PhotoModel;
 import org.datatransferproject.types.common.models.videos.VideoModel;
 import org.junit.Test;
@@ -188,6 +189,75 @@ public void getUploadTime_photoModel() throws ParseException {
         photoModel.getUploadedTime(), GoogleMediaItem.parseIso8601DateTime(fakePhotosApiTimestamp));
   }
 
+  @Test
+  public void getFavoriteStateAndTime_favoriteInfoUnset_videoModel() throws ParseException {
+    String fakePhotosApiTimestamp = "2023-10-02T22:33:38Z";
+    GoogleMediaItem videoMediaItem = getVideoMediaItem();
+    MediaMetadata metadata = new MediaMetadata();
+    metadata.setVideo(new Video());
+    // CreationTime in GoogleMediaItem is populated as uploadTime in our common models.
+    metadata.setCreationTime(fakePhotosApiTimestamp);
+    videoMediaItem.setMediaMetadata(metadata);
+
+    VideoModel videoModel = GoogleMediaItem.convertToVideoModel(Optional.empty(), videoMediaItem);
+
+    assertEquals(
+        videoModel.getUploadedTime(), GoogleMediaItem.parseIso8601DateTime(fakePhotosApiTimestamp));
+  }
+
+  @Test
+  public void getFavoriteStateAndTime_favoriteInfoUnset_photoModel() throws ParseException {
+    String fakePhotosApiTimestamp = "2014-10-02T15:01:23.045123456Z";
+
+    GoogleMediaItem photoMediaItem = getPhotoMediaItem();
+    MediaMetadata metadata = new MediaMetadata();
+    metadata.setPhoto(new Photo());
+    // CreationTime in GoogleMediaItem is populated as uploadTime in our common models.
+    metadata.setCreationTime(fakePhotosApiTimestamp);
+    photoMediaItem.setMediaMetadata(metadata);
+
+    PhotoModel photoModel = GoogleMediaItem.convertToPhotoModel(Optional.empty(), photoMediaItem);
+
+    assertEquals(
+        photoModel.getUploadedTime(), GoogleMediaItem.parseIso8601DateTime(fakePhotosApiTimestamp));
+  }
+
+  @Test
+  public void getFavoriteStateAndTime_favoriteInfoset_videoModel() throws ParseException {
+    Date favoriteTimestamp = GoogleMediaItem.parseIso8601DateTime("2023-10-02T22:33:38Z");
+    GoogleMediaItem videoMediaItem = getVideoMediaItem();
+    MediaMetadata metadata = new MediaMetadata();
+    metadata.setVideo(new Video());
+    metadata.setCreationTime("2022-10-02T22:33:38Z");
+    videoMediaItem.setMediaMetadata(metadata);
+    videoMediaItem.setFavoriteInfo(new FavoriteInfo(true, favoriteTimestamp));
+    VideoModel videoModel = GoogleMediaItem.convertToVideoModel(Optional.empty(), videoMediaItem);
+
+    assertEquals(
+        videoModel.getFavoriteInfo().getLastUpdateTime(), favoriteTimestamp);
+    assertEquals(
+        videoModel.getFavoriteInfo().getFavorited(), true);
+  }
+
+  @Test
+  public void getFavoriteStateAndTime_favoriteInfoSet_photoModel() throws ParseException {
+    Date favoriteTimestamp = GoogleMediaItem.parseIso8601DateTime("2023-10-02T22:33:38Z");
+
+    GoogleMediaItem photoMediaItem = getPhotoMediaItem();
+    MediaMetadata metadata = new MediaMetadata();
+    metadata.setPhoto(new Photo());
+    metadata.setCreationTime("2022-10-02T22:33:38Z");
+    photoMediaItem.setFavoriteInfo(new FavoriteInfo(true, favoriteTimestamp));
+    photoMediaItem.setMediaMetadata(metadata);
+
+    PhotoModel photoModel = GoogleMediaItem.convertToPhotoModel(Optional.empty(), photoMediaItem);
+
+    assertEquals(
+        photoModel.getFavoriteInfo().getLastUpdateTime(), favoriteTimestamp);
+    assertEquals(
+        photoModel.getFavoriteInfo().getFavorited(), true);
+  }
+
   public static GoogleMediaItem getPhotoMediaItem() {
     MediaMetadata photoMetadata = new MediaMetadata();
     photoMetadata.setPhoto(new Photo());
@@ -217,4 +287,4 @@ public static GoogleMediaItem getVideoMediaItem() {
     videoMediaItem.setMediaMetadata(videoMetadata);
     return videoMediaItem;
   }
-}
+}

portability-types-common/src/main/java/org/datatransferproject/types/common/models/FavoriteInfo.java

@@ -0,0 +1,52 @@
+package org.datatransferproject.types.common.models;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.io.Serializable;
+import java.util.Date;
+
+/** FavoriteInfo about a {@code MediaItem}. */
+public class FavoriteInfo implements Serializable {
+
+  @JsonProperty("favorite")
+  private boolean favorited;
+
+  /* the most recent time when the favorite state was changed or set. For new items, this field
+   * might be set to the item creation time.
+  */
+  @JsonProperty("lastUpdateTime")
+  private Date lastUpdateTime;
+
+  public FavoriteInfo(){
+  }
+
+  public FavoriteInfo(boolean favorited, Date lastUpdateTime)
+  {
+    this.favorited = favorited;
+    this.lastUpdateTime = lastUpdateTime;
+  }
+
+  /* Expected possibly true IFF lastUpdatedTime field is populated.  */
+  public boolean getFavorited() {
+    return favorited;
+  }
+
+  public Date getLastUpdateTime() {
+    return lastUpdateTime;
+  }
+
+  public void setFavorited(boolean favorited) {
+    this.favorited = favorited;
+  }
+
+  public void setLastUpdateTime(Date lastUpdateTime) {
+    this.lastUpdateTime = lastUpdateTime;
+  }
+
+  public static FavoriteInfo unknown() {
+    return new FavoriteInfo(false /*favorited*/, null /*lastUpdateTime*/);
+  }
+
+  public static FavoriteInfo unfavoritedAt(Date lastUpdateTime) {
+    return new FavoriteInfo(false /*favorited*/, lastUpdateTime );
+  }
+}

portability-types-common/src/main/java/org/datatransferproject/types/common/models/photos/PhotoModel.java

@@ -26,6 +26,7 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import org.datatransferproject.types.common.DownloadableFile;
+import org.datatransferproject.types.common.models.FavoriteInfo;
 
 public class PhotoModel implements DownloadableFile {
 
@@ -42,6 +43,8 @@ public class PhotoModel implements DownloadableFile {
   //  services use to display the photos timeline, instead of uploadTime.
   private Date uploadedTime;
 
+  private FavoriteInfo favoriteInfo;
+
   @JsonCreator
   public PhotoModel(
       @JsonProperty("title") String title,
@@ -52,7 +55,8 @@ public PhotoModel(
       @JsonProperty("albumId") String albumId,
       @JsonProperty("inTempStore") boolean inTempStore,
       @Nullable @JsonProperty("sha1") String sha1,
-      @JsonProperty("uploadedTime") Date uploadedTime) {
+      @JsonProperty("uploadedTime") Date uploadedTime,
+      @JsonProperty("favoriteInfo") FavoriteInfo favoriteInfo) {
     this.title = title;
     this.fetchableUrl = fetchableUrl;
     this.description = description;
@@ -65,6 +69,7 @@ public PhotoModel(
     this.inTempStore = inTempStore;
     this.sha1 = sha1;
     this.uploadedTime = uploadedTime;
+    this.favoriteInfo = favoriteInfo;
   }
 
   public PhotoModel(
@@ -85,7 +90,8 @@ public PhotoModel(
         albumId,
         inTempStore,
         /* sha1= */ null,
-        uploadedTime);
+        uploadedTime,
+        FavoriteInfo.unfavoritedAt(uploadedTime));
   }
 
   public PhotoModel(
@@ -95,7 +101,7 @@ public PhotoModel(
       String mediaType,
       String dataId,
       String albumId,
-      boolean inTempStore) {
+      boolean inTempStore){
     this(
         title,
         fetchableUrl,
@@ -105,7 +111,9 @@ public PhotoModel(
         albumId,
         inTempStore,
         /* sha1= */ null,
-        /* uploadedTime= */ null);
+        /* uploadedTime= */ null,
+        FavoriteInfo.unknown());
+
   }
 
   public PhotoModel(
@@ -126,9 +134,34 @@ public PhotoModel(
         albumId,
         inTempStore,
         sha1,
-        /*uploadedTime=*/ null);
+        /*uploadedTime=*/ null,
+        FavoriteInfo.unknown());
+  }
+
+  public PhotoModel(
+      String title,
+      String fetchableUrl,
+      String description,
+      String mediaType,
+      String dataId,
+      String albumId,
+      boolean inTempStore,
+      String sha1,
+      Date uploadedTime){
+    this(
+        title,
+        fetchableUrl,
+        description,
+        mediaType,
+        dataId,
+        albumId,
+        inTempStore,
+        sha1,
+        uploadedTime,
+        FavoriteInfo.unfavoritedAt(uploadedTime));
   }
 
+
   // TODO(zacsh) convert all callers to ImportableItem#getName() which is an interface guarantee of this class's
   // being a DownloadableItem. Then delete this method.
   public String getTitle() {
@@ -179,6 +212,11 @@ public String getSha1() {
     return sha1;
   }
 
+  public FavoriteInfo getFavoriteInfo()
+  {
+    return favoriteInfo;
+  }
+
   // remove all forbidden characters
   public void cleanTitle(String forbiddenCharacters, char replacementCharacter, int maxLength) {
     title = title.chars()
@@ -216,13 +254,13 @@ public boolean equals(Object o) {
     if (o == null || getClass() != o.getClass()) return false;
     PhotoModel that = (PhotoModel) o;
     return Objects.equal(getTitle(), that.getTitle()) &&
-            Objects.equal(getFetchableUrl(), that.getFetchableUrl()) &&
-            Objects.equal(getDescription(), that.getDescription()) &&
-            Objects.equal(getMediaType(), that.getMediaType()) &&
-            Objects.equal(getDataId(), that.getDataId()) &&
-            Objects.equal(getAlbumId(), that.getAlbumId()) &&
-            Objects.equal(getSha1(), that.getSha1()) &&
-            Objects.equal(getUploadedTime(), that.getUploadedTime());
+        Objects.equal(getFetchableUrl(), that.getFetchableUrl()) &&
+        Objects.equal(getDescription(), that.getDescription()) &&
+        Objects.equal(getMediaType(), that.getMediaType()) &&
+        Objects.equal(getDataId(), that.getDataId()) &&
+        Objects.equal(getAlbumId(), that.getAlbumId()) &&
+        Objects.equal(getSha1(), that.getSha1()) &&
+        Objects.equal(getUploadedTime(), that.getUploadedTime());
   }
 
   @Override
@@ -249,4 +287,4 @@ public String getIdempotentId() {
   public String getName() {
     return getTitle();
   }
-}
+}