Add support for API without group info (#1232)

2023-09-08 10:20:57 +08:00 · 2023-09-08 10:20:57 +08:00 · 33aa9aa319
--- a/powershell/plugins/sdk-generate.ts
+++ b/powershell/plugins/sdk-generate.ts
@ -42,6 +42,10 @@ async function generateMethodGroups(project: Project) {
  const interfacePath = join(join(resources, 'templates'), 'methodGroupInterface.ejs');
  const extensionPath = join(join(resources, 'templates'), 'extensions.ejs');
  for (const operationGroup of values(project.state.model.operationGroups)) {
+    if (operationGroup.$key === '') {
+      // for operations with no operation group, they will be added in the client class directly.
+      continue;
+    }
    // generate method group class
    const key = operationGroup.$key === 'Operations' ? '' : operationGroup.$key;
    const content = await ejs.renderFile(path, { methodGroup: operationGroup, project: project });
--- a/powershell/resources/templates/azureMethod.ejs
+++ b/powershell/resources/templates/azureMethod.ejs
@ -1,5 +1,5 @@
 <%if(!method.extensions || !method.extensions['x-ms-long-running-operation']) {-%>
-<%- include('method', {method: method}) %>
+<%- include('method', {method: method, clientPrefix: clientPrefix}) %>
 <%} else {-%>
-<%- include('longRunningOperationMethod', {method: method}) %>
+<%- include('longRunningOperationMethod', {method: method, clientPrefix: clientPrefix}) %>
 <%};-%>
--- a/powershell/resources/templates/azureMethodGroup.ejs
+++ b/powershell/resources/templates/azureMethodGroup.ejs
@ -40,7 +40,7 @@ namespace <%- project.namespace %>
        public <%-client%> Client { get; private set; }

 <% methodGroup.operations.forEach(function(method){ -%>
-<%- include('azureMethod', {method: method}) -%>
+<%- include('azureMethod', {method: method, clientPrefix: '.Client'}) -%>
 <% }); -%>
    }
 }
--- a/powershell/resources/templates/azureServiceClient.ejs
+++ b/powershell/resources/templates/azureServiceClient.ejs
@ -75,6 +75,13 @@ namespace <%- project.namespace %>
 <% } -%>
            DeserializationSettings.Converters.Add(new Microsoft.Rest.Azure.CloudErrorJsonConverter());
 <%# ToDo: Add method whose group is empty, and need to check in which case the group is empty.-%>
+<% var methodGroupWithoutKey = (project.state.model.operationGroups || []).filter(op => op.$key == '')
+if (methodGroupWithoutKey.length > 0) {
+    var methodGroup = methodGroupWithoutKey[0]
+    methodGroup.operations.forEach(function(method){
+-%>
+<%- include('azureMethod', {method: method, clientPrefix: ''}) -%>
+<% });} -%>
        }
    }
 }
--- a/powershell/resources/templates/longRunningOperationMethod.ejs
+++ b/powershell/resources/templates/longRunningOperationMethod.ejs
@ -39,5 +39,5 @@
        {
                // Send Request
                <%-method.language.default.responseType%> _response = await Begin<%-method.language.default.name%>WithHttpMessagesAsync(<%-method.language.default.asyncMethodInvocationArgsWithCustomerHeaders%>).ConfigureAwait(false);
-                return await this.Client.<%-(method.requests[0].protocol.http.method == 'put' || method.requests[0].protocol.http.method == 'patch')?'GetPutOrPatch':(method.requests[0].protocol.http.method == 'post' || method.requests[0].protocol.http.method == 'delete')?'GetPostOrDelete':''%>OperationResultAsync(_response, customHeaders, cancellationToken).ConfigureAwait(false);
+                return await this<%-clientPrefix%>.<%-(method.requests[0].protocol.http.method == 'put' || method.requests[0].protocol.http.method == 'patch')?'GetPutOrPatch':(method.requests[0].protocol.http.method == 'post' || method.requests[0].protocol.http.method == 'delete')?'GetPostOrDelete':''%>OperationResultAsync(_response, customHeaders, cancellationToken).ConfigureAwait(false);
        }
--- a/powershell/resources/templates/method.ejs
+++ b/powershell/resources/templates/method.ejs
@ -61,5 +61,5 @@
        {
 <%# ToDo: add support for method.Flavor, currently assume it is RestCall -%>

-<%- include('methodBodyRestCall', {method: method}) -%>
+<%- include('methodBodyRestCall', {method: method, clientPrefix: clientPrefix}) -%>
        }
--- a/powershell/resources/templates/methodBodyRestCall.ejs
+++ b/powershell/resources/templates/methodBodyRestCall.ejs
@ -36,7 +36,7 @@ if (method.extensions && method.extensions['x-ms-request-id']) {
 <% });-%>
 <%  if(method.parameters) { method.parameters.filter(p => (p.schema.type != 'constant' && p.language.default.name != '$host') || p.language.default.name == 'ApiVersion').forEach(function (parameter) {-%>
 <%# ToDo: add check IsNullable with required -%>
-<% var prefix = parameter.implementation == 'Client' ? 'this.Client.' : ''-%>
+<% var prefix = parameter.implementation == 'Client' ? `this${clientPrefix}.` : ''-%>
 <% if ( !(parameter.extensions && parameter.extensions['x-ms-parameter-grouping']) && parameter.required && !project.helper.IsValueType(parameter.schema.type) && !project.helper.IsEnum(parameter.schema) && !project.helper.IsConstantEnumParameter(parameter)) {-%>
            if (<%-prefix%><%-parameter.language.default.name%> == null)
            {
@ -98,18 +98,18 @@ if (method.extensions && method.extensions['x-ms-request-id']) {
            _url = _url.Replace("{nextLink}", nextPageLink);
 <% }else{%>
 <%# ToDo: may need to support AbsoluteUrl -%>
-            var _baseUrl = this.Client.BaseUri.AbsoluteUri;
+            var _baseUrl = this<%-clientPrefix%>.BaseUri.AbsoluteUri;
 <%# ToDo: buildurl, currently only added simple cases, besides we need to handle skip url encoding -%>
            var _url = new System.Uri(new System.Uri(_baseUrl + (_baseUrl.EndsWith("/") ? "" : "/")), "<%-method.requests[0].protocol.http.path.substring(1)%>").ToString();
 <%if (method.parameters) { method.parameters.filter(p => p.protocol.http.in == 'path').forEach(function (pathParameter) {
-var prefix = pathParameter.implementation == 'Client' ? 'this.Client.' : '';
+var prefix = pathParameter.implementation == 'Client' ? `this${clientPrefix}.` : '';
 -%>
-            _url = _url.Replace("{<%-pathParameter.language.default.serializedName%>}", <%-project.helper.PathParameterString(pathParameter)%>);
+            _url = _url.Replace("{<%-pathParameter.language.default.serializedName%>}", <%-project.helper.PathParameterString(pathParameter, clientPrefix)%>);
 <% });}-%>
 <% }%>
            System.Collections.Generic.List<string> _queryParameters = new System.Collections.Generic.List<string>();
 <%if (method.parameters && !method.language.default.pageable?.nextPageOperation) { method.parameters.filter(p => p.protocol.http.in == 'query').forEach(function (queryParameter) { -%>
-<% var prefix = queryParameter.implementation == 'Client' ? 'this.Client.' : ''-%>
+<% var prefix = queryParameter.implementation == 'Client' ? `this${clientPrefix}.` : ''-%>
 <% if (queryParameter.extensions && queryParameter.extensions['x-ms-odata']) {-%>
            if (<%-queryParameter.language.default.name%> != null)
            {
@ -122,7 +122,7 @@ var prefix = pathParameter.implementation == 'Client' ? 'this.Client.' : '';
 <% } else {-%>
            if (<%-prefix%><%-queryParameter.language.default.name%> != null)
            {
-                _queryParameters.Add(string.Format("<%-queryParameter.language.default.serializedName%>={0}", <%-project.helper.PathParameterString(queryParameter)%>));
+                _queryParameters.Add(string.Format("<%-queryParameter.language.default.serializedName%>={0}", <%-project.helper.PathParameterString(queryParameter, clientPrefix)%>));
            }
 <% }-%>
 <% });}-%>
@ -137,20 +137,20 @@ var prefix = pathParameter.implementation == 'Client' ? 'this.Client.' : '';
            _httpRequest.RequestUri = new System.Uri(_url);
            // Set Headers
 <%# ToDo: Add headers except for following default ones -%>
-            if (this.Client.GenerateClientRequestId != null && this.Client.GenerateClientRequestId.Value)
+            if (this<%-clientPrefix%>.GenerateClientRequestId != null && this<%-clientPrefix%>.GenerateClientRequestId.Value)
            {
                _httpRequest.Headers.TryAddWithoutValidation("<%-clientRequestId%>", System.Guid.NewGuid().ToString());
            }
-            if (this.Client.AcceptLanguage != null)
+            if (this<%-clientPrefix%>.AcceptLanguage != null)
            {
                if (_httpRequest.Headers.Contains("accept-language"))
                {
                    _httpRequest.Headers.Remove("accept-language");
                }
-                _httpRequest.Headers.TryAddWithoutValidation("accept-language", this.Client.AcceptLanguage);
+                _httpRequest.Headers.TryAddWithoutValidation("accept-language", this<%-clientPrefix%>.AcceptLanguage);
            }
 <% (method.parameters || []).filter(p => p.protocol.http.in == 'header').forEach(function(parameter) {
-var prefix = parameter.implementation == 'Client' ? 'this.Client.' : ''-%>
+var prefix = parameter.implementation == 'Client' ? `this${clientPrefix}.` : ''-%>
            if (<%-prefix%><%-parameter.language.default.name%> != null)
            {
                if (_httpRequest.Headers.Contains("<%-parameter.language.default.serializedName%>"))
@ -192,22 +192,22 @@ var prefix = parameter.implementation == 'Client' ? 'this.Client.' : ''-%>
 <% } else if (!project.helper.IsValueType(parameter.schema.type) && !project.helper.IsEnum(parameter.schema) && !project.helper.IsConstantEnumParameter(parameter)) {-%>
            if(<%-parameter.language.default.name%> != null)
            {
-                _requestContent = Microsoft.Rest.Serialization.SafeJsonConvert.SerializeObject(<%-parameter.language.default.name%>, <%-project.helper.GetSerializationSettings(parameter.schema, 'this.Client')%>);
+                _requestContent = Microsoft.Rest.Serialization.SafeJsonConvert.SerializeObject(<%-parameter.language.default.name%>, <%-project.helper.GetSerializationSettings(parameter.schema, `this${clientPrefix}`)%>);
                _httpRequest.Content = new System.Net.Http.StringContent(_requestContent, System.Text.Encoding.UTF8);
                _httpRequest.Content.Headers.ContentType =System.Net.Http.Headers.MediaTypeHeaderValue.Parse("application/json; charset=utf-8");
            }
 <% } else { -%>
-            _requestContent = Microsoft.Rest.Serialization.SafeJsonConvert.SerializeObject(<%-parameter.language.default.name%>, <%-project.helper.GetSerializationSettings(parameter.schema, 'this.Client')%>);
+            _requestContent = Microsoft.Rest.Serialization.SafeJsonConvert.SerializeObject(<%-parameter.language.default.name%>, <%-project.helper.GetSerializationSettings(parameter.schema, `this${clientPrefix}`)%>);
            _httpRequest.Content = new System.Net.Http.StringContent(_requestContent, System.Text.Encoding.UTF8);
            _httpRequest.Content.Headers.ContentType =System.Net.Http.Headers.MediaTypeHeaderValue.Parse("application/json; charset=utf-8");
 <% } -%>
 <% });-%>
 <%# ToDo: Need to confirm in which case Settings.AddCredentials is false -%>
            // Set Credentials
-            if (this.Client.Credentials != null)
+            if (this<%-clientPrefix%>.Credentials != null)
            {
                cancellationToken.ThrowIfCancellationRequested();
-                await this.Client.Credentials.ProcessHttpRequestAsync(_httpRequest, cancellationToken).ConfigureAwait(false);
+                await this<%-clientPrefix%>.Credentials.ProcessHttpRequestAsync(_httpRequest, cancellationToken).ConfigureAwait(false);
            }
            // Send Request
            if (_shouldTrace)
@ -216,7 +216,7 @@ var prefix = parameter.implementation == 'Client' ? 'this.Client.' : ''-%>
            }
            cancellationToken.ThrowIfCancellationRequested();
 <% var responseHeadersRead = method.requests[0].protocol.http.method === 'head' || method.language.default.returnType == 'System.IO.Stream' ? 'System.Net.Http.HttpCompletionOption.ResponseHeadersRead, ': '' -%>
-            _httpResponse = await this.Client.HttpClient.SendAsync(_httpRequest, <%-responseHeadersRead%>cancellationToken).ConfigureAwait(false);
+            _httpResponse = await this<%-clientPrefix%>.HttpClient.SendAsync(_httpRequest, <%-responseHeadersRead%>cancellationToken).ConfigureAwait(false);
            if (_shouldTrace)
            {
                Microsoft.Rest.ServiceClientTracing.ReceiveResponse(_invocationId, _httpResponse);
@ -235,7 +235,7 @@ var prefix = parameter.implementation == 'Client' ? 'this.Client.' : ''-%>
 <%# ToDo: Need to add support for primary type -%>
                    _responseContent = await _httpResponse.Content.ReadAsStringAsync().ConfigureAwait(false);
 <%var errorClass = !project.helper.IsCloudErrorException(method) ? method.exceptions[0].schema.language.default.name : 'CloudError'-%>
-                    <%-errorClass%> _errorBody =  Microsoft.Rest.Serialization.SafeJsonConvert.DeserializeObject<<%-errorClass%>>(_responseContent, this.Client.DeserializationSettings);
+                    <%-errorClass%> _errorBody =  Microsoft.Rest.Serialization.SafeJsonConvert.DeserializeObject<<%-errorClass%>>(_responseContent, this<%-clientPrefix%>.DeserializationSettings);
                    if (_errorBody != null)
                    {
 <% if(project.helper.IsCloudErrorException(method)) { -%>
@ -295,7 +295,7 @@ if(resp.schema.type === 'choice' || (resp.schema.type === 'sealed-choice' && (re
 var deserializeType =  method.language.default.deserializeType ? method.language.default.deserializeType : respSchema.language.csharp.fullname;
 const postfix = (project.helper.IsValueType(respSchema.type) || project.helper.IsEnum(resp.schema)) ? '?' : '';
 -%>
-                    _result.Body = Microsoft.Rest.Serialization.SafeJsonConvert.DeserializeObject<<%-deserializeType + postfix%>>(_responseContent, <%-project.helper.GetDeserializationSettings(respSchema, 'this.Client')%>);
+                    _result.Body = Microsoft.Rest.Serialization.SafeJsonConvert.DeserializeObject<<%-deserializeType + postfix%>>(_responseContent, <%-project.helper.GetDeserializationSettings(respSchema, `this${clientPrefix}`)%>);
                }
                catch (Newtonsoft.Json.JsonException ex)
                {
@ -314,7 +314,7 @@ const postfix = (project.helper.IsValueType(respSchema.type) || project.helper.I
 <% if (method.language.default.returnTypeHeader.name !== '') { -%>
            try
            {
-                _result.Headers = _httpResponse.GetHeadersAsJson().ToObject<<%-method.language.default.returnTypeHeader.name%>>(Newtonsoft.Json.JsonSerializer.Create(this.Client.DeserializationSettings));
+                _result.Headers = _httpResponse.GetHeadersAsJson().ToObject<<%-method.language.default.returnTypeHeader.name%>>(Newtonsoft.Json.JsonSerializer.Create(this<%-clientPrefix%>.DeserializationSettings));
            }
            catch (Newtonsoft.Json.JsonException ex)
            {
--- a/powershell/resources/templates/methodGroupInterface.ejs
+++ b/powershell/resources/templates/methodGroupInterface.ejs
@ -13,65 +13,6 @@ namespace <%- project.namespace %>
    /// </summary>
    public partial interface I<%- typeName%>
    {
-<% methodGroup.operations.forEach(function(method){ -%>
-<%# ToDo: support for ExcludeFromInterface -%>
-<% if(method.language.default.description) {-%>
-        /// <summary>
-        /// <%= method.language.default.description%>
-<%# ToDo: support for  ExternalDocsUrl -%>
-        /// </summary>
-        /// <remarks>
-        /// <%= method.language.default.description%>
-        /// </remarks>
-<% };-%>
-<% if(!method.language.default.pageable?.nextPageOperation) {-%>
-<% method.parameters.filter(p=>p.implementation != 'Client' && !project.helper.IsConstantParameter(p)).forEach(function(parameter){-%>
-        /// <param name='<%-parameter.language.default.name%>'>
-        /// <%= parameter.language.default.description%>
-        /// </param>
-<% }); -%>
-<% (method.requests[0].parameters || []).filter(p=>p.protocol.http.in == 'body' && !project.helper.IsConstantEnumParameter(p)).forEach(function(parameter){-%>
-<%if(parameter.extensions && parameter.extensions['x-ms-client-flatten'] ) {-%>
-<%project.helper.GetAllPublicVirtualProperties(parameter.schema.language.default.virtualProperties).filter(p => !project.helper.IsConstantEnumProperty(p)).forEach(function(vp) {-%>
-        /// <param name='<%-vp.property.language.default.name%>'>
-        /// <%= vp.property.language.default.description%>
-        /// </param>
-<%});-%>
-<%} else {-%>
-        /// <param name='<%-parameter.language.default.name%>'>
-        /// <%= parameter.language.default.description%>
-        /// </param>
-<%}-%>
-<% });-%>
-<% };-%>
-<% if(method.language.default.pageable?.nextPageOperation) {-%>
-        /// <param name='nextPageLink'>
-        /// The NextLink from the previous successful call to List operation.
-        /// </param>
-<% } -%>
-        /// <param name='customHeaders'>
-        /// The headers that will be added to request.
-        /// </param>
-        /// <param name='cancellationToken'>
-        /// The cancellation token.
-        /// </param>
-<%# ToDo: Need to figure out whether we could hand code the exception here -%>
-        /// <exception cref="Microsoft.Rest.Azure.CloudException">
-        /// Thrown when the operation returned an invalid status code
-        /// </exception>
-<% if ((method.responses || []).filter(r => r.schema).length > 0) {-%>
-        /// <exception cref="Microsoft.Rest.SerializationException">
-        /// Thrown when unable to deserialize the response
-        /// </exception>
-<% }; -%>
-<% if (method.parameters.filter(p => p.required && p.nullable).length > 0 || (method.requests[0].parameters || []).filter(p => p.required && p.nullable).length > 0) {-%>
-        /// <exception cref="Microsoft.Rest.ValidationException">
-        /// Thrown when a required parameter is null
-        /// </exception>
-<% }; -%>
-<%# ToDo: support GetObsoleteAttribute, deprecated message?-%>
-        System.Threading.Tasks.Task<<%-method.language.default.responseType %>> <%- method.language.default.name%>WithHttpMessagesAsync(<%-method.language.default.asyncMethodParameterDeclarationWithCustomHeader%>);
-
-<% }); -%>
+<%- include('methodGroupInterfaceBody', {methodGroup: methodGroup}) -%>
    }
 }
--- a/powershell/resources/templates/methodGroupInterfaceBody.ejs
+++ b/powershell/resources/templates/methodGroupInterfaceBody.ejs
@ -0,0 +1,60 @@
+<% methodGroup.operations.forEach(function(method){ -%>
+<%# ToDo: support for ExcludeFromInterface -%>
+<% if(method.language.default.description) {-%>
+        /// <summary>
+        /// <%= method.language.default.description%>
+<%# ToDo: support for  ExternalDocsUrl -%>
+        /// </summary>
+        /// <remarks>
+        /// <%= method.language.default.description%>
+        /// </remarks>
+<% };-%>
+<% if(!method.language.default.pageable?.nextPageOperation) {-%>
+<% method.parameters.filter(p=>p.implementation != 'Client' && !project.helper.IsConstantParameter(p)).forEach(function(parameter){-%>
+        /// <param name='<%-parameter.language.default.name%>'>
+        /// <%= parameter.language.default.description%>
+        /// </param>
+<% }); -%>
+<% (method.requests[0].parameters || []).filter(p=>p.protocol.http.in == 'body' && !project.helper.IsConstantEnumParameter(p)).forEach(function(parameter){-%>
+<%if(parameter.extensions && parameter.extensions['x-ms-client-flatten'] ) {-%>
+<%project.helper.GetAllPublicVirtualProperties(parameter.schema.language.default.virtualProperties).filter(p => !project.helper.IsConstantEnumProperty(p)).forEach(function(vp) {-%>
+        /// <param name='<%-vp.property.language.default.name%>'>
+        /// <%= vp.property.language.default.description%>
+        /// </param>
+<%});-%>
+<%} else {-%>
+        /// <param name='<%-parameter.language.default.name%>'>
+        /// <%= parameter.language.default.description%>
+        /// </param>
+<%}-%>
+<% });-%>
+<% };-%>
+<% if(method.language.default.pageable?.nextPageOperation) {-%>
+        /// <param name='nextPageLink'>
+        /// The NextLink from the previous successful call to List operation.
+        /// </param>
+<% } -%>
+        /// <param name='customHeaders'>
+        /// The headers that will be added to request.
+        /// </param>
+        /// <param name='cancellationToken'>
+        /// The cancellation token.
+        /// </param>
+<%# ToDo: Need to figure out whether we could hand code the exception here -%>
+        /// <exception cref="Microsoft.Rest.Azure.CloudException">
+        /// Thrown when the operation returned an invalid status code
+        /// </exception>
+<% if ((method.responses || []).filter(r => r.schema).length > 0) {-%>
+        /// <exception cref="Microsoft.Rest.SerializationException">
+        /// Thrown when unable to deserialize the response
+        /// </exception>
+<% }; -%>
+<% if (method.parameters.filter(p => p.required && p.nullable).length > 0 || (method.requests[0].parameters || []).filter(p => p.required && p.nullable).length > 0) {-%>
+        /// <exception cref="Microsoft.Rest.ValidationException">
+        /// Thrown when a required parameter is null
+        /// </exception>
+<% }; -%>
+<%# ToDo: support GetObsoleteAttribute, deprecated message?-%>
+        System.Threading.Tasks.Task<<%-method.language.default.responseType %>> <%- method.language.default.name%>WithHttpMessagesAsync(<%-method.language.default.asyncMethodParameterDeclarationWithCustomHeader%>);
+
+<% }); -%>
--- a/powershell/resources/templates/serviceClientInterface.ejs
+++ b/powershell/resources/templates/serviceClientInterface.ejs
@ -51,5 +51,11 @@ namespace <%- project.namespace %>

 <% }); -%>
 <%# ToDo: Add method whose group is empty, and need to check in which case the group is empty.-%>
+<% var methodGroupWithoutKey = (project.state.model.operationGroups || []).filter(op => op.$key == '')
+if (methodGroupWithoutKey.length > 0) {
+    var methodGroup = methodGroupWithoutKey[0]
+-%>
+<%- include('methodGroupInterfaceBody', {methodGroup: methodGroup}) -%>
+<% } -%>
    }
 }
--- a/powershell/sdk/utility.ts
+++ b/powershell/sdk/utility.ts
@ -183,16 +183,16 @@ export class Helper {
    // }
    return false;
  }
-  public PathParameterString(parameter: Parameter): string {
+  public PathParameterString(parameter: Parameter, clientPrefix: string): string {
    if (!['path', 'query'].includes(parameter.protocol.http?.in)) {
      return '';
    }
-    const prefix = parameter.implementation === 'Client' ? 'this.Client.' : '';
+    const prefix = parameter.implementation === 'Client' ? `this${clientPrefix}.` : '';
    let res = '';
    if (this.isKindOfString(parameter.schema, parameter.required)) {
      res = `${prefix}${parameter.language.default.name}`;
    } else {
-      let serializationSettings = 'this.Client.SerializationSettings';
+      let serializationSettings = `this${clientPrefix}.SerializationSettings`;
      if (this.IsValueType(parameter.schema.type)) {
        if (parameter.schema.type === SchemaType.Date) {
          serializationSettings = 'new Microsoft.Rest.Serialization.DateJsonConverter()';