[ACR] uploadBlob updates (Azure#25189)

Author: timovv

sdk/containerregistry/container-registry/review/container-registry.api.md

@@ -276,7 +276,7 @@ export interface OciDescriptor {
     annotations?: OciAnnotations;
     digest: string;
     mediaType: string;
-    size: number;
+    sizeInBytes: number;
     urls?: string[];
 }
 
@@ -343,6 +343,7 @@ export interface UploadBlobOptions extends OperationOptions {
 // @public
 export interface UploadBlobResult {
     digest: string;
+    sizeInBytes: number;
 }
 
 // @public

sdk/containerregistry/container-registry/samples-dev/uploadImage.ts

@@ -33,13 +33,13 @@ async function main() {
     schemaVersion: 2,
     config: {
       digest: uploadConfigResult.digest,
-      size: config.byteLength,
+      sizeInBytes: config.byteLength,
       mediaType: "application/vnd.oci.image.config.v1+json",
     },
     layers: [
       {
         digest: uploadLayerResult.digest,
-        size: layer.byteLength,
+        sizeInBytes: layer.byteLength,
         mediaType: "application/vnd.oci.image.layer.v1.tar",
       },
     ],

sdk/containerregistry/container-registry/samples-dev/uploadManifest.ts

@@ -44,13 +44,13 @@ async function main() {
     config: {
       mediaType: "application/vnd.oci.image.config.v1+json",
       digest: configDigest,
-      size: config.byteLength,
+      sizeInBytes: config.byteLength,
     },
     layers: [
       {
         mediaType: "application/vnd.oci.image.layer.v1.tar",
         digest: layerDigest,
-        size: layer.byteLength,
+        sizeInBytes: layer.byteLength,
         annotations: {
           title: "artifact.txt",
         },

sdk/containerregistry/container-registry/src/blob/containerRegistryBlobClient.ts

@@ -359,13 +359,18 @@ export class ContainerRegistryBlobClient {
         const chunks = readChunksFromStream(blobStream, CHUNK_SIZE);
         const hash = crypto.createHash("sha256");
 
+        let bytesUploaded = 0;
+
         for await (const chunk of chunks) {
           hash.write(chunk);
           const result = await this.client.containerRegistryBlob.uploadChunk(
             location,
             chunk,
             updatedOptions
           );
+
+          bytesUploaded += chunk.byteLength;
+
           assertHasProperty(result, "location");
           location = result.location.substring(1);
         }
@@ -382,7 +387,7 @@ export class ContainerRegistryBlobClient {
           );
         }
 
-        return { digest };
+        return { digest, sizeInBytes: bytesUploaded };
       }
     );
   }

sdk/containerregistry/container-registry/src/blob/models.ts

@@ -26,6 +26,11 @@ export interface UploadBlobResult {
    * The digest of the uploaded blob.
    */
   digest: string;
+
+  /**
+   * The size of the uploaded blob in bytes.
+   */
+  sizeInBytes: number;
 }
 
 /**
@@ -93,7 +98,7 @@ export interface OciDescriptor {
   /** Layer media type */
   mediaType: string;
   /** Layer size */
-  size: number;
+  sizeInBytes: number;
   /** Layer digest */
   digest: string;
   /** Specifies a list of URIs from which this object may be downloaded. */

sdk/containerregistry/container-registry/src/generated/models/index.ts

@@ -204,3 +204,13 @@ directive:
       }
     };
 ```
+
+# Rename Descriptor.size to sizeInBytes
+
+```yaml
+directive:
+  from: swagger-document
+  where: $.definitions.Descriptor
+  transform: >
+    $.properties.size["x-ms-client-name"] = "sizeInBytes";
+```

sdk/containerregistry/container-registry/src/generated/models/mappers.ts

@@ -67,13 +67,13 @@ versionsToTest(serviceVersions, {}, (serviceVersion, onVersions): void => {
       config: {
         mediaType: "application/vnd.oci.image.config.v1+json",
         digest: "sha256:d25b42d3dbad5361ed2d909624d899e7254a822c9a632b582ebd3a44f9b0dbc8",
-        size: 171,
+        sizeInBytes: 171,
       },
       layers: [
         {
           mediaType: "application/vnd.oci.image.layer.v1.tar",
           digest: "sha256:654b93f61054e4ce90ed203bb8d556a6200d5f906cf3eca0620738d6dc18cbed",
-          size: 28,
+          sizeInBytes: 28,
           annotations: {
             title: "artifact.txt",
           },
@@ -225,11 +225,12 @@ versionsToTest(serviceVersions, {}, (serviceVersion, onVersions): void => {
       const blob = fs.createReadStream(
         "test/data/oci-artifact/654b93f61054e4ce90ed203bb8d556a6200d5f906cf3eca0620738d6dc18cbed"
       );
-      const { digest } = await client.uploadBlob(blob);
+      const { digest, sizeInBytes } = await client.uploadBlob(blob);
       const downloadResult = await client.downloadBlob(
         "sha256:654b93f61054e4ce90ed203bb8d556a6200d5f906cf3eca0620738d6dc18cbed"
       );
       assert.equal(digest, downloadResult.digest);
+      assert.equal(sizeInBytes, 28);
     });
 
     it("can upload blob from a buffer", async () => {
@@ -246,8 +247,10 @@ versionsToTest(serviceVersions, {}, (serviceVersion, onVersions): void => {
       }
 
       // 64 MiB plus extra offset to have a smaller chunk at the end
-      const bigBlob = Buffer.alloc(64 * 1024 * 1024 + 321, 0x00);
-      const { digest } = await client.uploadBlob(Readable.from(bigBlob));
+      const bufferSize = 64 * 1024 * 1024 + 321;
+      const bigBlob = Buffer.alloc(bufferSize, 0x00);
+      const { digest, sizeInBytes } = await client.uploadBlob(Readable.from(bigBlob));
+      assert.equal(sizeInBytes, bufferSize);
       await client.deleteBlob(digest);
     });
 
@@ -263,8 +266,11 @@ versionsToTest(serviceVersions, {}, (serviceVersion, onVersions): void => {
       }
 
       // 64 MiB exactly
-      const bigBlob = Buffer.alloc(64 * 1024 * 1024, 0x00);
-      const { digest } = await client.uploadBlob(Readable.from(bigBlob));
+      const bufferSize = 64 * 1024 * 1024;
+
+      const bigBlob = Buffer.alloc(bufferSize, 0x00);
+      const { digest, sizeInBytes } = await client.uploadBlob(Readable.from(bigBlob));
+      assert.equal(sizeInBytes, bufferSize);
       await client.deleteBlob(digest);
     });
   });