add content downloader (Azure#25348)

### Describe the problem that is addressed by this PR

Can now use the downloadStreaming and downloadTo, and delete recording
methods.

Author: ikumarapeli-msft

sdk/communication/communication-call-automation/review/communication-call-automation.api.md

@@ -4,13 +4,16 @@
 
 ```ts
 
+/// <reference types="node" />
+
 import { CommonClientOptions } from '@azure/core-client';
 import { CommunicationIdentifier } from '@azure/communication-common';
 import { CommunicationUserIdentifier } from '@azure/communication-common';
 import * as coreClient from '@azure/core-client';
 import { KeyCredential } from '@azure/core-auth';
 import { OperationOptions } from '@azure/core-client';
 import { PhoneNumberIdentifier } from '@azure/communication-common';
+import { PipelineResponse } from '@azure/core-rest-pipeline';
 import { TokenCredential } from '@azure/core-auth';
 
 // @public
@@ -205,7 +208,11 @@ export interface CallParticipant {
 // @public
 export class CallRecording {
     // Warning: (ae-forgotten-export) The symbol "CallRecordingImpl" needs to be exported by the entry point index.d.ts
-    constructor(callRecordingImpl: CallRecordingImpl);
+    // Warning: (ae-forgotten-export) The symbol "ContentDownloaderImpl" needs to be exported by the entry point index.d.ts
+    constructor(callRecordingImpl: CallRecordingImpl, contentDownloader: ContentDownloaderImpl);
+    deleteRecording(recordingLocation: string, options?: DeleteRecordingOptions): Promise<void>;
+    downloadStreaming(sourceLocation: string, options?: DownloadRecordingOptions): Promise<NodeJS.ReadableStream>;
+    downloadTo(sourceLocation: string, destinationPath: string, options?: DownloadRecordingOptions): Promise<void>;
     getRecordingState(recordingId: string, options?: GetRecordingPropertiesOptions): Promise<RecordingStateResult>;
     pauseRecording(recordingId: string, options?: PauseRecordingOptions): Promise<void>;
     resumeRecording(recordingId: string, options?: ResumeRecordingOptions): Promise<void>;
@@ -238,6 +245,15 @@ export interface CreateCallOptions extends OperationOptions {
 // @public
 export type CreateCallResult = CallResult;
 
+// @public
+export type DeleteRecordingOptions = OperationOptions;
+
+// @public
+export interface DownloadRecordingOptions extends OperationOptions {
+    length?: number;
+    offset?: number;
+}
+
 // @public
 export enum DtmfTone {
     // (undocumented)

sdk/communication/communication-call-automation/src/callAutomationClient.ts

@@ -37,6 +37,7 @@ import {
   phoneNumberIdentifierConverter,
   PhoneNumberIdentifierModelConverter,
 } from "./utli/converters";
+import { ContentDownloaderImpl } from "./contentDownloader";
 
 /**
  * Client options used to configure CallAutomation Client API requests.
@@ -63,6 +64,7 @@ export class CallAutomationClient {
   private readonly callAutomationApiClient: CallAutomationApiClient;
   private readonly callConnectionImpl: CallConnectionImpl;
   private readonly callRecordingImpl: CallRecordingImpl;
+  private readonly contentDownloaderImpl: ContentDownloaderImpl;
   private readonly callMediaImpl: CallMediaImpl;
   private readonly sourceIdentity?: CommunicationIdentifierModel;
 
@@ -127,6 +129,7 @@ export class CallAutomationClient {
     this.callConnectionImpl = new CallConnectionImpl(this.callAutomationApiClient);
     this.callMediaImpl = new CallMediaImpl(this.callAutomationApiClient);
     this.callRecordingImpl = new CallRecordingImpl(this.callAutomationApiClient);
+    this.contentDownloaderImpl = new ContentDownloaderImpl(this.callAutomationApiClient);
     this.sourceIdentity = options.sourceIdentity
       ? communicationIdentifierModelConverter(options.sourceIdentity)
       : undefined;
@@ -144,7 +147,7 @@ export class CallAutomationClient {
    * Initializes a new instance of CallRecording.
    */
   public getCallRecording(): CallRecording {
-    return new CallRecording(this.callRecordingImpl);
+    return new CallRecording(this.callRecordingImpl, this.contentDownloaderImpl);
   }
 
   /**

sdk/communication/communication-call-automation/src/callRecording.ts

@@ -9,17 +9,23 @@ import {
   PauseRecordingOptions,
   GetRecordingPropertiesOptions,
   ResumeRecordingOptions,
+  DeleteRecordingOptions,
+  DownloadRecordingOptions,
 } from "./models/options";
 import { communicationIdentifierModelConverter } from "./utli/converters";
+import { ContentDownloaderImpl } from "./contentDownloader";
+import * as fs from "fs";
 
 /**
  * CallRecording class represents call recording related APIs.
  */
 export class CallRecording {
   private readonly callRecordingImpl: CallRecordingImpl;
+  private readonly contentDownloader: ContentDownloaderImpl;
 
-  constructor(callRecordingImpl: CallRecordingImpl) {
+  constructor(callRecordingImpl: CallRecordingImpl, contentDownloader: ContentDownloaderImpl) {
     this.callRecordingImpl = callRecordingImpl;
+    this.contentDownloader = contentDownloader;
   }
 
   /**
@@ -111,4 +117,55 @@ export class CallRecording {
   ): Promise<void> {
     return this.callRecordingImpl.resumeRecording(recordingId, options);
   }
+
+  /**
+   * Deletes a recording.
+   * @param recordingLocation - The recording location uri. Required.
+   * @param options - Additional request options contains deleteRecording api options.
+   */
+  public async deleteRecording(
+    recordingLocation: string,
+    options: DeleteRecordingOptions = {}
+  ): Promise<void> {
+    await this.contentDownloader.deleteRecording(recordingLocation, options);
+  }
+
+  /**
+   * Returns a stream with a call recording.
+   * @param sourceLocation - The source location uri. Required.
+   * @param options - Additional request options contains downloadRecording api options.
+   */
+  public async downloadStreaming(
+    sourceLocation: string,
+    options: DownloadRecordingOptions = {}
+  ): Promise<NodeJS.ReadableStream> {
+    const result = this.contentDownloader.download(sourceLocation, options);
+    const recordingStream = (await result).readableStreamBody;
+    if (recordingStream) {
+      return recordingStream;
+    } else {
+      throw Error("failed to get stream");
+    }
+  }
+
+  /**
+   * Downloads a call recording file to the specified path.
+   * @param sourceLocation - The source location uri. Required.
+   * @param destinationPath - The destination path. Required.
+   * @param options - Additional request options contains downloadRecording api options.
+   */
+  public async downloadTo(
+    sourceLocation: string,
+    destinationPath: string,
+    options: DownloadRecordingOptions = {}
+  ): Promise<void> {
+    console.log(destinationPath);
+    const result = this.contentDownloader.download(sourceLocation, options);
+    const recordingStream = (await result).readableStreamBody;
+    if (recordingStream) {
+      recordingStream.pipe(fs.createWriteStream(destinationPath));
+    } else {
+      throw Error("failed to get stream");
+    }
+  }
 }

sdk/communication/communication-call-automation/src/contentDownloader.ts

@@ -0,0 +1,136 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { CallAutomationApiClient } from "./generated/src/callAutomationApiClient";
+import {
+  AddPipelineOptions,
+  createHttpHeaders,
+  createPipelineRequest,
+  PipelineRequest,
+  PipelineRequestOptions,
+  PipelineResponse,
+  SendRequest,
+} from "@azure/core-rest-pipeline";
+import { DeleteRecordingOptions, DownloadRecordingOptions } from "./models/options";
+
+/** Class containing ContentDownloading operations. */
+export class ContentDownloaderImpl {
+  private readonly client: CallAutomationApiClient;
+
+  /**
+   * Initialize a new instance of the class ContentDownloader class.
+   * @param client - Reference to the service client
+   */
+  constructor(client: CallAutomationApiClient) {
+    this.client = client;
+    this.addCustomSignUrlPolicy();
+  }
+
+  private addCustomSignUrlPolicy() {
+    const signUrlPolicy = {
+      name: "CustomSignUrlPolicy",
+      async sendRequest(request: PipelineRequest, next: SendRequest): Promise<PipelineResponse> {
+        if (request.headers.has("OriginalUrl")) {
+          request.url = `${request.headers.get("OriginalUrl")}`;
+          const originalRequest = new URL(request.url);
+          request.headers.set("Host", originalRequest.host);
+        }
+        return next(request);
+      },
+    };
+
+    const pipelineOptions: AddPipelineOptions = {};
+    pipelineOptions.afterPhase = "Sign";
+    this.client.pipeline.addPolicy(signUrlPolicy, pipelineOptions);
+  }
+
+  /**
+   * Deletes a recording.
+   * @param recordingLocation - The recording location uri. Required.
+   */
+  async deleteRecording(
+    recordingLocation: string,
+    options?: DeleteRecordingOptions
+  ): Promise<void> {
+    const fileLocation = new URL(recordingLocation);
+    const endpoint = new URL(this.client.endpoint);
+    const modifiedUrlForSigning = endpoint.origin + fileLocation.pathname;
+
+    const opt: PipelineRequestOptions = {
+      url: modifiedUrlForSigning,
+      method: "DELETE",
+      headers: createHttpHeaders(),
+      body: "",
+      abortSignal: options?.abortSignal,
+      tracingOptions: options?.tracingOptions,
+    };
+
+    opt.headers?.set("OriginalUrl", recordingLocation);
+    opt.headers?.set("x-ms-host", endpoint.host);
+    opt.headers?.set("accept", "application/json");
+
+    const req = createPipelineRequest(opt);
+
+    const results = await this.client.sendRequest(req);
+
+    if (results.status !== 200) {
+      if (results.bodyAsText) {
+        const jsonBody = JSON.parse(results.bodyAsText);
+        throw { status: jsonBody.status, message: jsonBody.message };
+      }
+      throw { status: results.status };
+    }
+  }
+
+  /**
+   * Returns a stream with a call recording.
+   * @param sourceLocation - The source location uri. Required.
+   * @param offset - Offset byte. Not required.
+   * @param length - how many bytes. Not required.
+   */
+  async download(
+    sourceLocation: string,
+    options: DownloadRecordingOptions
+  ): Promise<PipelineResponse> {
+    const fileLocation = new URL(sourceLocation);
+    const endpoint = new URL(this.client.endpoint);
+    const modifiedUrlForSigning = endpoint.origin + fileLocation.pathname;
+
+    const opt: PipelineRequestOptions = {
+      url: modifiedUrlForSigning,
+      method: "GET",
+      headers: createHttpHeaders(),
+      body: "",
+      streamResponseStatusCodes: new Set([200, 206]),
+      abortSignal: options.abortSignal,
+      tracingOptions: options?.tracingOptions,
+    };
+
+    if (options.length && !options.offset) {
+      throw Error("Download offset value must not be empty if length is set.");
+    } else if (options.length && options.offset) {
+      options.length = options.offset + options.length - 1;
+    }
+
+    let rangeHeader = "bytes=" + options.offset;
+    if (options.length) rangeHeader += "-" + options.length;
+
+    opt.headers?.set("OriginalUrl", sourceLocation);
+    opt.headers?.set("x-ms-host", endpoint.host);
+    opt.headers?.set("accept", "application/json");
+    opt.headers?.set("Range", rangeHeader);
+
+    const req = createPipelineRequest(opt);
+
+    const results = await this.client.sendRequest(req);
+
+    if (results.status !== 200 && results.status !== 206) {
+      if (results.bodyAsText) {
+        const jsonBody = JSON.parse(results.bodyAsText);
+        throw { status: jsonBody.status, message: jsonBody.message };
+      }
+      throw { status: results.status };
+    }
+    return results;
+  }
+}

sdk/communication/communication-call-automation/src/models/options.ts

@@ -169,3 +169,18 @@ export type GetRecordingPropertiesOptions = OperationOptions;
  * Options to resume recording.
  */
 export type ResumeRecordingOptions = OperationOptions;
+
+/**
+ * Options to delete recording.
+ */
+export type DeleteRecordingOptions = OperationOptions;
+
+/**
+ * Options to download recording.
+ */
+export interface DownloadRecordingOptions extends OperationOptions {
+  /** Offset byte to start download from. */
+  offset?: number;
+  /** Max content length in bytes. */
+  length?: number;
+}