chore(storage): Plumb finalize_time through attrs. (googleapis#11643)

* chore(storage): Plumb finalize_time through attrs.

* update emulator test to demonstrate finalize time is expected on non-appendable objects

* confirm that created time == finalized time for non-appendable objects

Author: cjc25

storage/client_test.go

@@ -939,6 +939,18 @@ func TestOpenWriterEmulated(t *testing.T) {
 		if diff := cmp.Diff(got, randomBytesToWrite); diff != "" {
 			t.Fatalf("checking written content: got(-),want(+):\n%s", diff)
 		}
+
+		o, err := veneerClient.Bucket(bucket).Object(want.Name).Attrs(ctx)
+		if err != nil {
+			t.Fatalf("getting object attrs: got %v; want ok", err)
+		}
+		if o.Finalized.IsZero() {
+			t.Errorf("expected valid finalize time: got %v; want non-zero", o.Finalized)
+		}
+		// For non-appendable objects, created and finalized times are equal.
+		if !o.Finalized.Equal(o.Created) {
+			t.Errorf("expected equal created and finalize times: created %v; finalized %v", o.Created, o.Finalized)
+		}
 	})
 }
 

storage/storage.go

@@ -1332,6 +1332,7 @@ func (o *ObjectAttrs) toProtoObject(b string) *storagepb.Object {
 		Acl:                 toProtoObjectACL(o.ACL),
 		Metadata:            o.Metadata,
 		CreateTime:          toProtoTimestamp(o.Created),
+		FinalizeTime:        toProtoTimestamp(o.Finalized),
 		CustomTime:          toProtoTimestamp(o.CustomTime),
 		DeleteTime:          toProtoTimestamp(o.Deleted),
 		RetentionExpireTime: toProtoTimestamp(o.RetentionExpirationTime),
@@ -1494,6 +1495,10 @@ type ObjectAttrs struct {
 	// Created is the time the object was created. This field is read-only.
 	Created time.Time
 
+	// Finalized is the time the object contents were finalized. This may differ
+	// from Created for appendable objects. This field is read-only.
+	Finalized time.Time
+
 	// Deleted is the time the object was deleted.
 	// If not deleted, it is the zero value. This field is read-only.
 	Deleted time.Time
@@ -1658,6 +1663,7 @@ func newObject(o *raw.Object) *ObjectAttrs {
 		CustomerKeySHA256:       sha256,
 		KMSKeyName:              o.KmsKeyName,
 		Created:                 convertTime(o.TimeCreated),
+		Finalized:               convertTime(o.TimeFinalized),
 		Deleted:                 convertTime(o.TimeDeleted),
 		Updated:                 convertTime(o.Updated),
 		Etag:                    o.Etag,
@@ -1697,6 +1703,7 @@ func newObjectFromProto(o *storagepb.Object) *ObjectAttrs {
 		CustomerKeySHA256: base64.StdEncoding.EncodeToString(o.GetCustomerEncryption().GetKeySha256Bytes()),
 		KMSKeyName:        o.GetKmsKey(),
 		Created:           convertProtoTime(o.GetCreateTime()),
+		Finalized:         convertProtoTime(o.GetFinalizeTime()),
 		Deleted:           convertProtoTime(o.GetDeleteTime()),
 		Updated:           convertProtoTime(o.GetUpdateTime()),
 		CustomTime:        convertProtoTime(o.GetCustomTime()),
@@ -1844,6 +1851,7 @@ var attrToFieldMap = map[string]string{
 	"CustomerKeySHA256":       "customerEncryption",
 	"KMSKeyName":              "kmsKeyName",
 	"Created":                 "timeCreated",
+	"Finalized":               "timeFinalized",
 	"Deleted":                 "timeDeleted",
 	"Updated":                 "updated",
 	"Etag":                    "etag",
@@ -1872,6 +1880,7 @@ var attrToProtoFieldMap = map[string]string{
 	"Deleted":                 "delete_time",
 	"ContentType":             "content_type",
 	"Created":                 "create_time",
+	"Finalized":               "finalize_time",
 	"CRC32C":                  "checksums.crc32c",
 	"MD5":                     "checksums.md5_hash",
 	"Updated":                 "update_time",

storage/storage_test.go

@@ -1805,13 +1805,15 @@ func TestRawObjectToObjectAttrs(t *testing.T) {
 				RetentionExpirationTime: "2019-03-31T19:33:36Z",
 				Size:                    1 << 20,
 				TimeCreated:             "2019-03-31T19:32:10Z",
+				TimeFinalized:           "2019-03-31T19:32:10Z",
 				TimeDeleted:             "2019-03-31T19:33:39Z",
 				TemporaryHold:           true,
 				ComponentCount:          2,
 			},
 			want: &ObjectAttrs{
 				Bucket:                  "Test",
 				Created:                 time.Date(2019, 3, 31, 19, 32, 10, 0, time.UTC),
+				Finalized:               time.Date(2019, 3, 31, 19, 32, 10, 0, time.UTC),
 				ContentLanguage:         "en-us",
 				ContentType:             "video/mpeg",
 				CustomTime:              time.Date(2020, 8, 25, 19, 33, 36, 0, time.UTC),
@@ -1843,6 +1845,7 @@ func TestObjectAttrsToRawObject(t *testing.T) {
 	in := &ObjectAttrs{
 		Bucket:                  "Test",
 		Created:                 time.Date(2019, 3, 31, 19, 32, 10, 0, time.UTC),
+		Finalized:               time.Date(2019, 3, 31, 19, 32, 10, 0, time.UTC),
 		ContentLanguage:         "en-us",
 		ContentType:             "video/mpeg",
 		Deleted:                 time.Date(2019, 3, 31, 19, 33, 39, 0, time.UTC),
@@ -1893,13 +1896,15 @@ func TestProtoObjectToObjectAttrs(t *testing.T) {
 				RetentionExpireTime: timestamppb.New(now),
 				Size:                1 << 20,
 				CreateTime:          timestamppb.New(now),
+				FinalizeTime:        timestamppb.New(now),
 				DeleteTime:          timestamppb.New(now),
 				TemporaryHold:       true,
 				ComponentCount:      2,
 			},
 			want: &ObjectAttrs{
 				Bucket:                  "Test",
 				Created:                 now,
+				Finalized:               now,
 				ContentLanguage:         "en-us",
 				ContentType:             "video/mpeg",
 				CustomTime:              now,
@@ -1940,11 +1945,13 @@ func TestObjectAttrsToProtoObject(t *testing.T) {
 		RetentionExpireTime: timestamppb.New(now),
 		Size:                1 << 20,
 		CreateTime:          timestamppb.New(now),
+		FinalizeTime:        timestamppb.New(now),
 		DeleteTime:          timestamppb.New(now),
 		TemporaryHold:       true,
 	}
 	in := &ObjectAttrs{
 		Created:                 now,
+		Finalized:               now,
 		ContentLanguage:         "en-us",
 		ContentType:             "video/mpeg",
 		CustomTime:              now,