Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature/set base url #2123

Merged
merged 6 commits into from
Jan 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed

- Fixed a bug in dotnet where default values for Enum properties with special characters would not match the model. [#2091](https://github.com/microsoft/kiota/issues/2091)
- Sets the base url to make use of request information easier in CSharp/Java/TypeScript/Go/Ruby. [#2061](https://github.com/microsoft/kiota/issues/2061)

## [0.10.0] - 2023-01-04

Expand Down
8 changes: 5 additions & 3 deletions src/Kiota.Builder/Writers/CSharp/CodeMethodWriter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -182,13 +182,15 @@ private void WriteRequestBuilderBody(CodeClass parentClass, CodeMethod codeEleme
private static void WriteApiConstructorBody(CodeClass parentClass, CodeMethod method, LanguageWriter writer)
{
var requestAdapterProperty = parentClass.GetPropertyOfKind(CodePropertyKind.RequestAdapter);
var backingStoreParameter = method.Parameters.FirstOrDefault(x => x.IsOfKind(CodeParameterKind.BackingStore));
var pathParametersProperty = parentClass.GetPropertyOfKind(CodePropertyKind.PathParameters);
var backingStoreParameter = method.Parameters.FirstOrDefault(static x => x.IsOfKind(CodeParameterKind.BackingStore));
var requestAdapterPropertyName = requestAdapterProperty.Name.ToFirstCharacterUpperCase();
WriteSerializationRegistration(method.SerializerModules, writer, "RegisterDefaultSerializer");
WriteSerializationRegistration(method.DeserializerModules, writer, "RegisterDefaultDeserializer");
if (!string.IsNullOrEmpty(method.BaseUrl)) {
writer.WriteLine($"if (string.IsNullOrEmpty({requestAdapterPropertyName}.BaseUrl)) {{");
writer.IncreaseIndent();
if(pathParametersProperty != null)
writer.WriteLine($"{pathParametersProperty.Name.ToFirstCharacterUpperCase()}.TryAdd(\"baseurl\", \"{method.BaseUrl}\");");
writer.StartBlock($"if (string.IsNullOrEmpty({requestAdapterPropertyName}.BaseUrl)) {{");
writer.WriteLine($"{requestAdapterPropertyName}.BaseUrl = \"{method.BaseUrl}\";");
writer.CloseBlock();
}
Expand Down
7 changes: 4 additions & 3 deletions src/Kiota.Builder/Writers/Go/CodeMethodWriter.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Linq;

using Kiota.Builder.CodeDOM;
Expand Down Expand Up @@ -394,13 +393,15 @@ private void WriteGetterBody(CodeMethod codeElement, LanguageWriter writer, Code
}
private void WriteApiConstructorBody(CodeClass parentClass, CodeMethod method, LanguageWriter writer) {
var requestAdapterProperty = parentClass.GetPropertyOfKind(CodePropertyKind.RequestAdapter);
var pathParametersProperty = parentClass.GetPropertyOfKind(CodePropertyKind.PathParameters);
var requestAdapterPropertyName = requestAdapterProperty.Name.ToFirstCharacterLowerCase();
var backingStoreParameter = method.Parameters.FirstOrDefault(x => x.IsOfKind(CodeParameterKind.BackingStore));
WriteSerializationRegistration(method.SerializerModules, writer, parentClass, "RegisterDefaultSerializer", "SerializationWriterFactory");
WriteSerializationRegistration(method.DeserializerModules, writer, parentClass, "RegisterDefaultDeserializer", "ParseNodeFactory");
if (!string.IsNullOrEmpty(method.BaseUrl)) {
writer.WriteLine($"if m.{requestAdapterPropertyName}.GetBaseUrl() == \"\" {{");
writer.IncreaseIndent();
if(pathParametersProperty != null)
writer.WriteLine($"m.{pathParametersProperty.Name.ToFirstCharacterLowerCase()}[\"baseurl\"] = \"{method.BaseUrl}\"");
writer.StartBlock($"if m.{requestAdapterPropertyName}.GetBaseUrl() == \"\" {{");
writer.WriteLine($"m.{requestAdapterPropertyName}.SetBaseUrl(\"{method.BaseUrl}\")");
writer.CloseBlock();
}
Expand Down
8 changes: 5 additions & 3 deletions src/Kiota.Builder/Writers/Java/CodeMethodWriter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -244,13 +244,15 @@ private static void WriteRequestBuilderConstructorCall(CodeMethod codeElement, L
}
private static void WriteApiConstructorBody(CodeClass parentClass, CodeMethod method, LanguageWriter writer) {
var requestAdapterProperty = parentClass.GetPropertyOfKind(CodePropertyKind.RequestAdapter);
var backingStoreParameter = method.Parameters.FirstOrDefault(x => x.IsOfKind(CodeParameterKind.BackingStore));
var pathParametersProperty = parentClass.GetPropertyOfKind(CodePropertyKind.PathParameters);
var backingStoreParameter = method.Parameters.FirstOrDefault(static x => x.IsOfKind(CodeParameterKind.BackingStore));
var requestAdapterPropertyName = requestAdapterProperty.Name.ToFirstCharacterLowerCase();
WriteSerializationRegistration(method.SerializerModules, writer, "registerDefaultSerializer");
WriteSerializationRegistration(method.DeserializerModules, writer, "registerDefaultDeserializer");
if(!string.IsNullOrEmpty(method.BaseUrl)) {
writer.WriteLine($"if ({requestAdapterPropertyName}.getBaseUrl() == null || {requestAdapterPropertyName}.getBaseUrl().isEmpty()) {{");
writer.IncreaseIndent();
if(pathParametersProperty != null)
writer.WriteLine($"{pathParametersProperty.Name.ToFirstCharacterLowerCase()}.put(\"baseurl\", \"{method.BaseUrl}\");");
writer.StartBlock($"if ({requestAdapterPropertyName}.getBaseUrl() == null || {requestAdapterPropertyName}.getBaseUrl().isEmpty()) {{");
writer.WriteLine($"{requestAdapterPropertyName}.setBaseUrl(\"{method.BaseUrl}\");");
writer.CloseBlock();
}
Expand Down
3 changes: 3 additions & 0 deletions src/Kiota.Builder/Writers/Ruby/CodeMethodWriter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -122,12 +122,15 @@ private void WriteRequestBuilderBody(CodeClass parentClass, CodeMethod codeEleme
}
private static void WriteApiConstructorBody(CodeClass parentClass, CodeMethod method, LanguageWriter writer) {
var requestAdapterProperty = parentClass.GetPropertyOfKind(CodePropertyKind.RequestAdapter);
var pathParametersProperty = parentClass.GetPropertyOfKind(CodePropertyKind.PathParameters);
var requestAdapterPropertyName = requestAdapterProperty.NamePrefix + requestAdapterProperty.Name.ToSnakeCase();
WriteSerializationRegistration(parentClass, method.SerializerModules, writer, "register_default_serializer");
WriteSerializationRegistration(parentClass, method.DeserializerModules, writer, "register_default_deserializer");
if (method.Parameters.FirstOrDefault(static x => x.IsOfKind(CodeParameterKind.RequestAdapter)) is CodeParameter requestAdapterParameter)
writer.WriteLine($"@{requestAdapterPropertyName} = {requestAdapterParameter.Name.ToSnakeCase()}");
if(!string.IsNullOrEmpty(method.BaseUrl)) {
if(pathParametersProperty != null)
writer.WriteLine($"@{pathParametersProperty.Name.ToSnakeCase()}['baseurl'] = '{method.BaseUrl}'");
writer.StartBlock($"if @{requestAdapterPropertyName}.get_base_url.nil? || @{requestAdapterPropertyName}.get_base_url.empty?");
writer.WriteLine($"@{requestAdapterPropertyName}.set_base_url('{method.BaseUrl}')");
writer.CloseBlock("end");
Expand Down
8 changes: 5 additions & 3 deletions src/Kiota.Builder/Writers/TypeScript/CodeMethodWriter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -120,13 +120,15 @@ private void WriteRequestBuilderWithParametersBody(CodeMethod codeElement, CodeC
}
private static void WriteApiConstructorBody(CodeClass parentClass, CodeMethod method, LanguageWriter writer) {
var requestAdapterProperty = parentClass.GetPropertyOfKind(CodePropertyKind.RequestAdapter);
var backingStoreParameter = method.Parameters.FirstOrDefault(x => x.IsOfKind(CodeParameterKind.BackingStore));
var pathParametersProperty = parentClass.GetPropertyOfKind(CodePropertyKind.PathParameters);
var backingStoreParameter = method.Parameters.FirstOrDefault(static x => x.IsOfKind(CodeParameterKind.BackingStore));
var requestAdapterPropertyName = requestAdapterProperty.Name.ToFirstCharacterLowerCase();
WriteSerializationRegistration(method.SerializerModules, writer, "registerDefaultSerializer");
WriteSerializationRegistration(method.DeserializerModules, writer, "registerDefaultDeserializer");
if(!string.IsNullOrEmpty(method.BaseUrl)) {
writer.WriteLine($"if ({requestAdapterPropertyName}.baseUrl === undefined || {requestAdapterPropertyName}.baseUrl === \"\") {{");
writer.IncreaseIndent();
if(pathParametersProperty != null)
writer.WriteLine($"this.{pathParametersProperty.Name.ToFirstCharacterLowerCase()}[\"baseurl\"] = \"{method.BaseUrl}\";");
writer.StartBlock($"if ({requestAdapterPropertyName}.baseUrl === undefined || {requestAdapterPropertyName}.baseUrl === \"\") {{");
writer.WriteLine($"{requestAdapterPropertyName}.baseUrl = \"{method.BaseUrl}\";");
writer.CloseBlock();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1109,14 +1109,23 @@ public void DoesNotWriteConstructorWithDefaultFromComposedType()
[Fact]
public void WritesApiConstructor() {
method.Kind = CodeMethodKind.ClientConstructor;
method.BaseUrl = "https://graph.microsoft.com/v1.0";
parentClass.AddProperty(new CodeProperty {
Name = "pathParameters",
Kind = CodePropertyKind.PathParameters,
Type = new CodeType {
Name = "Dictionary<string, string>",
IsExternal = true,
}
});
var coreProp = parentClass.AddProperty(new CodeProperty {
Name = "core",
Kind = CodePropertyKind.RequestAdapter,
Type = new CodeType {
Name = "RequestAdapter",
IsExternal = true,
}
}).First();
coreProp.Type = new CodeType {
Name = "RequestAdapter",
IsExternal = true,
};
method.AddParameter(new CodeParameter {
Name = "core",
Kind = CodeParameterKind.RequestAdapter,
Expand All @@ -1129,6 +1138,8 @@ public void WritesApiConstructor() {
Assert.Contains(parentClass.Name.ToFirstCharacterUpperCase(), result);
Assert.Contains("RegisterDefaultSerializer", result);
Assert.Contains("RegisterDefaultDeserializer", result);
Assert.Contains($"TryAdd(\"baseurl\", \"{method.BaseUrl}\")", result);
Assert.Contains($"BaseUrl = \"{method.BaseUrl}\"", result);
}
[Fact]
public void WritesApiConstructorWithBackingStore() {
Expand Down
19 changes: 15 additions & 4 deletions tests/Kiota.Builder.Tests/Writers/Go/CodeMethodWriterTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1474,14 +1474,23 @@ public void WritesInheritedConstructor() {
[Fact]
public void WritesApiConstructor() {
method.Kind = CodeMethodKind.ClientConstructor;
method.BaseUrl = "https://graph.microsoft.com/v1.0";
parentClass.AddProperty(new CodeProperty {
Name = "pathParameters",
Kind = CodePropertyKind.PathParameters,
Type = new CodeType {
Name = "Dictionary<string, string>",
IsExternal = true,
}
});
var coreProp = parentClass.AddProperty(new CodeProperty {
Name = "core",
Kind = CodePropertyKind.RequestAdapter,
Type = new CodeType {
Name = "HttpCore",
IsExternal = true,
}
}).First();
coreProp.Type = new CodeType {
Name = "HttpCore",
IsExternal = true,
};
method.AddParameter(new CodeParameter {
Name = "core",
Kind = CodeParameterKind.RequestAdapter,
Expand All @@ -1494,6 +1503,8 @@ public void WritesApiConstructor() {
Assert.Contains(parentClass.Name.ToFirstCharacterUpperCase(), result);
Assert.Contains("RegisterDefaultSerializer", result);
Assert.Contains("RegisterDefaultDeserializer", result);
Assert.Contains($"[\"baseurl\"] = \"{method.BaseUrl}\"", result);
Assert.Contains($"SetBaseUrl(\"{method.BaseUrl}\")", result);
}
[Fact]
public void WritesApiConstructorWithBackingStore() {
Expand Down
19 changes: 15 additions & 4 deletions tests/Kiota.Builder.Tests/Writers/Java/CodeMethodWriterTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1473,14 +1473,23 @@ public void WritesRawUrlConstructor() {
[Fact]
public void WritesApiConstructor() {
method.Kind = CodeMethodKind.ClientConstructor;
method.BaseUrl = "https://graph.microsoft.com/v1.0";
parentClass.AddProperty(new CodeProperty {
Name = "pathParameters",
Kind = CodePropertyKind.PathParameters,
Type = new CodeType {
Name = "Dictionary<string, string>",
IsExternal = true,
}
});
var coreProp = parentClass.AddProperty(new CodeProperty {
Name = "core",
Kind = CodePropertyKind.RequestAdapter,
Type = new CodeType {
Name = "HttpCore",
IsExternal = true,
}
}).First();
coreProp.Type = new CodeType {
Name = "HttpCore",
IsExternal = true,
};
method.AddParameter(new CodeParameter {
Name = "core",
Kind = CodeParameterKind.RequestAdapter,
Expand All @@ -1493,6 +1502,8 @@ public void WritesApiConstructor() {
Assert.Contains(parentClass.Name.ToFirstCharacterUpperCase(), result);
Assert.Contains("registerDefaultSerializer", result);
Assert.Contains("registerDefaultDeserializer", result);
Assert.Contains($"put(\"baseurl\", \"{method.BaseUrl}\")", result);
Assert.Contains($"setBaseUrl(\"{method.BaseUrl}\")", result);
}
[Fact]
public void WritesApiConstructorWithBackingStore() {
Expand Down
19 changes: 15 additions & 4 deletions tests/Kiota.Builder.Tests/Writers/Ruby/CodeMethodWriterTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -676,14 +676,23 @@ public void DoesNotWriteConstructorWithDefaultFromComposedType()
[Fact]
public void WritesApiConstructor() {
method.Kind = CodeMethodKind.ClientConstructor;
method.BaseUrl = "https://graph.microsoft.com/v1.0";
parentClass.AddProperty(new CodeProperty {
Name = "pathParameters",
Kind = CodePropertyKind.PathParameters,
Type = new CodeType {
Name = "Dictionary<string, string>",
IsExternal = true,
}
});
var coreProp = parentClass.AddProperty(new CodeProperty {
Name = "core",
Kind = CodePropertyKind.RequestAdapter,
Type = new CodeType {
Name = "HttpCore",
IsExternal = true,
}
}).First();
coreProp.Type = new CodeType {
Name = "HttpCore",
IsExternal = true,
};
method.AddParameter(new CodeParameter {
Name = "core",
Kind = CodeParameterKind.RequestAdapter,
Expand All @@ -692,6 +701,8 @@ public void WritesApiConstructor() {
writer.Write(method);
var result = tw.ToString();
Assert.Contains(coreProp.Name, result);
Assert.Contains($"['baseurl'] = '{method.BaseUrl}'", result);
Assert.Contains($"set_base_url('{method.BaseUrl}')", result);
}
[Fact]
public void WritesApiConstructorWithBackingStore() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -671,14 +671,23 @@ public void DoesNotWriteConstructorWithDefaultFromComposedType()
public void WritesApiConstructor() {
method.Kind = CodeMethodKind.ClientConstructor;
method.IsAsync = false;
method.BaseUrl = "https://graph.microsoft.com/v1.0";
parentClass.AddProperty(new CodeProperty {
Name = "pathParameters",
Kind = CodePropertyKind.PathParameters,
Type = new CodeType {
Name = "Dictionary<string, string>",
IsExternal = true,
}
});
var coreProp = parentClass.AddProperty(new CodeProperty {
Name = "core",
Kind = CodePropertyKind.RequestAdapter,
Type = new CodeType {
Name = "HttpCore",
IsExternal = true,
}
}).First();
coreProp.Type = new CodeType {
Name = "HttpCore",
IsExternal = true,
};
method.AddParameter(new CodeParameter {
Name = "core",
Kind = CodeParameterKind.RequestAdapter,
Expand All @@ -691,6 +700,8 @@ public void WritesApiConstructor() {
Assert.Contains("constructor", result);
Assert.Contains("registerDefaultSerializer", result);
Assert.Contains("registerDefaultDeserializer", result);
Assert.Contains($"[\"baseurl\"] = \"{method.BaseUrl}\"", result);
Assert.Contains($"baseUrl = \"{method.BaseUrl}\"", result);
}
[Fact]
public void WritesApiConstructorWithBackingStore() {
Expand Down