Add support for change feed schema V3, V4 and V5 (Azure#21270)

Author: EmmaZhu

sdk/storage/storage-blob-changefeed/recordings/node/change_feed_event_schema_test/recording_event_schema_v1_test.js

@@ -13,6 +13,9 @@ import { StoragePipelineOptions } from '@azure/storage-blob';
 import { StorageSharedKeyCredential } from '@azure/storage-blob';
 import { TokenCredential } from '@azure/core-http';
 
+// @public
+export type AccessTier = "P4" | "P6" | "P10" | "P15" | "P20" | "P30" | "P40" | "P50" | "P60" | "P70" | "P80" | "Hot" | "Cool" | "Archive";
+
 // @public
 export class BlobChangeFeedClient {
     constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions);
@@ -29,20 +32,33 @@ export interface BlobChangeFeedEvent {
     eventType: BlobChangeFeedEventType;
     id: string;
     metadataVersion: string;
+    schemaVersion?: number;
     subject: string;
     topic: string;
 }
 
 // @public
 export interface BlobChangeFeedEventData {
     api: string;
+    blobAccessTier?: AccessTier;
     blobType: BlobType;
+    blobVersion?: string;
     clientRequestId: string;
+    containerVersion?: string;
     contentLength: number;
+    contentOffset?: number;
     contentType: string;
+    destinationUrl?: string;
     etag: string;
+    isRecursive?: boolean;
+    longRunningOperationInfo?: BlobOperationResult;
+    previousInfo?: ChangeFeedEventPreviousInfo;
     requestId: string;
     sequencer: string;
+    snapshot?: string;
+    sourceUrl?: string;
+    updatedBlobProperties?: UpdatedBlobProperties;
+    updatedBlobTags?: BlobTagsChange;
     url: string;
 }
 
@@ -54,7 +70,7 @@ export class BlobChangeFeedEventPage {
 }
 
 // @public
-export type BlobChangeFeedEventType = "UnspecifiedEventType" | "BlobCreated" | "BlobDeleted" | "BlobPropertiesUpdated" | "BlobSnapshotCreated" | "Control" | "BlobTierChanged" | "BlobAsyncOperationInitiated" | "BlobMetadataUpdated";
+export type BlobChangeFeedEventType = "UnspecifiedEventType" | "BlobCreated" | "BlobDeleted" | "BlobPropertiesUpdated" | "BlobSnapshotCreated" | "Control" | "BlobTierChanged" | "BlobAsyncOperationInitiated" | "BlobMetadataUpdated" | "RestorePointMarkerCreated";
 
 // @public
 export interface BlobChangeFeedListChangesOptions extends CommonOptions {
@@ -63,12 +79,43 @@ export interface BlobChangeFeedListChangesOptions extends CommonOptions {
     start?: Date;
 }
 
+// @public
+export interface BlobOperationResult {
+    copyId?: string;
+    destinationAccessTier?: AccessTier;
+    isAsync: boolean;
+}
+
+// @public
+export interface BlobPropertyChange {
+    newValue: string;
+    oldValue: string;
+    propertyName: string;
+}
+
+// @public
+export interface BlobTagsChange {
+    newTags: Record<string, string>;
+    oldTags: Record<string, string>;
+}
+
 // @public
 export type BlobType = "BlockBlob" | "AppendBlob" | "PageBlob";
 
+// @public
+export interface ChangeFeedEventPreviousInfo {
+    isBlobSoftDeleted: boolean;
+    newBlobVersion?: string;
+    oldBlobVersion?: string;
+    previousTier?: AccessTier;
+    softDeleteSnapshot?: string;
+}
+
 // @public
 export function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline;
 
+// @public
+export type UpdatedBlobProperties = Record<string, BlobPropertyChange>;
 
 // (No @packageDocumentation comment for this package)
 

sdk/storage/storage-blob-changefeed/recordings/node/change_feed_event_schema_test/recording_event_schema_v3_test.js

@@ -6,6 +6,7 @@ import { BlobChangeFeedEvent } from "./models/BlobChangeFeedEvent";
 import { CommonOptions } from "@azure/storage-blob";
 import { AbortSignalLike } from "@azure/core-http";
 import { AvroParseOptions } from "../../storage-internal-avro/src/AvroReader";
+import { rawEventToBlobChangeFeedEvent } from "./utils/utils.common";
 
 /**
  * Options to configure {@link Chunk.getChange} operation.
@@ -66,14 +67,7 @@ export class Chunk {
         return undefined;
       }
 
-      if (eventRaw.eventTime) {
-        eventRaw.eventTime = new Date(eventRaw.eventTime);
-      }
-      if (eventRaw.eTag) {
-        eventRaw.etag = eventRaw.eTag;
-        delete eventRaw.eTag;
-      }
-      return eventRaw as BlobChangeFeedEvent;
+      return rawEventToBlobChangeFeedEvent(eventRaw);
     }
   }
 }

sdk/storage/storage-blob-changefeed/recordings/node/change_feed_event_schema_test/recording_event_schema_v4_test.js

@@ -15,7 +15,8 @@ export type BlobChangeFeedEventType =
   | "Control"
   | "BlobTierChanged"
   | "BlobAsyncOperationInitiated"
-  | "BlobMetadataUpdated";
+  | "BlobMetadataUpdated"
+  | "RestorePointMarkerCreated";
 
 /**
  * Change feed event record. Contains response data for the {@link BlobChangeFeedClient.listChanges} operation.
@@ -57,6 +58,11 @@ export interface BlobChangeFeedEvent {
    */
   dataVersion?: string;
 
+  /**
+   * The schema version of the data object. The publisher defines the schema version.
+   */
+  schemaVersion?: number;
+
   /**
    * The schema version of the event metadata. Event Grid defines the schema of the top-level properties. Event Grid provides this value.
    */
@@ -68,6 +74,104 @@ export interface BlobChangeFeedEvent {
  */
 export type BlobType = "BlockBlob" | "AppendBlob" | "PageBlob";
 
+/**
+ * The AccessTier.
+ */
+export type AccessTier =
+  | "P4"
+  | "P6"
+  | "P10"
+  | "P15"
+  | "P20"
+  | "P30"
+  | "P40"
+  | "P50"
+  | "P60"
+  | "P70"
+  | "P80"
+  | "Hot"
+  | "Cool"
+  | "Archive";
+
+/**
+ * A blob property that was updated.
+ */
+export interface BlobPropertyChange {
+  /**
+   * The name of the property that was updated.
+   */
+  propertyName: string;
+  /**
+   * The previous value of the property.
+   */
+  oldValue: string;
+  /**
+   * The new value of the property.
+   */
+  newValue: string;
+}
+/**
+ * Blob properties that were updated during an event.
+ */
+export type UpdatedBlobProperties = Record<string, BlobPropertyChange>;
+/**
+ * Previous info for Change Feed Event.
+ */
+export interface ChangeFeedEventPreviousInfo {
+  /**
+   * Soft delete snapshot.
+   */
+  softDeleteSnapshot?: string;
+  /**
+   * If the blob was soft deleted.
+   */
+  isBlobSoftDeleted: boolean;
+  /**
+   * Blob version.
+   */
+  newBlobVersion?: string;
+  /**
+   * Last version.
+   */
+  oldBlobVersion?: string;
+  /**
+   * Previous Access Tier
+   */
+  previousTier?: AccessTier;
+}
+
+/**
+ * ChangeFeedEvent AsyncOperationInfo
+ */
+export interface BlobOperationResult {
+  /**
+   * Destination access tier.
+   */
+  destinationAccessTier?: AccessTier;
+  /**
+   * If the operation was async.
+   */
+  isAsync: boolean;
+  /**
+   * Copy Id.
+   */
+  copyId?: string;
+}
+
+/**
+ * Blob tags that were updated as part of the change feed event.
+ */
+export interface BlobTagsChange {
+  /**
+   * Previous Tags.
+   */
+  oldTags: Record<string, string>;
+  /**
+   * New Tags.
+   */
+  newTags: Record<string, string>;
+}
+
 /**
  * Change feed Blob storage event data.
  */
@@ -106,6 +210,13 @@ export interface BlobChangeFeedEventData {
    */
   contentLength: number;
 
+  /**
+   * The offset in bytes of a write operation taken at the point where the event-triggering application completed
+   * writing to the file.
+   * Appears only for events triggered on blob storage accounts that have a hierarchical namespace.
+   */
+  contentOffset?: number;
+
   /**
    * The type of blob.
    */
@@ -117,9 +228,68 @@ export interface BlobChangeFeedEventData {
    */
   url: string;
 
+  /**
+   * The url of the file that will exist after the operation completes. For example, if a file is renamed,
+   * the destinationUrl property contains the url of the new file name.
+   * Appears only for events triggered on blob storage accounts that have a hierarchical namespace.
+   */
+  destinationUrl?: string;
+
+  /**
+   * The url of the file that exists prior to the operation. For example, if a file is renamed, the sourceUrl
+   * contains the url of the original file name prior to the rename operation.
+   * Appears only for events triggered on blob storage accounts that have a hierarchical namespace.
+   */
+  sourceUrl?: string;
+
+  /**
+   * True to perform the operation on all child directories; otherwise False.
+   * Appears only for events triggered on blob storage accounts that have a hierarchical namespace.
+   */
+  isRecursive?: boolean;
+
   /**
    * An opaque string value representing the logical sequence of events for any particular blob name.
    * Users can use standard string comparison to understand the relative sequence of two events on the same blob name.
    */
   sequencer: string;
+
+  /**
+   * Previous info for the blob.
+   */
+  previousInfo?: ChangeFeedEventPreviousInfo;
+
+  /**
+   * Blob properties that were updated during this event.
+   */
+  updatedBlobProperties?: UpdatedBlobProperties;
+
+  /**
+   * Blob tags that were updated during this event.
+   */
+  updatedBlobTags?: BlobTagsChange;
+
+  /**
+   * The Snapshot associated with the event.
+   */
+  snapshot?: string;
+
+  /**
+   * Version of the blob.
+   */
+  blobVersion?: string;
+
+  /**
+   * Version of the container the blob is in.
+   */
+  containerVersion?: string;
+
+  /**
+   * Access Tier of the blob.
+   */
+  blobAccessTier?: AccessTier;
+  /**
+   * AsyncOperationInfo
+   */
+  longRunningOperationInfo?: BlobOperationResult;
 }