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.

Sign up for GitHub

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

V3: Option to have lazy DSC<> initialization. Option to exclude static model #46

Closed
wants to merge 2 commits into from
Closed

V3: Option to have lazy DSC<> initialization. Option to exclude static model #46

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dff6eba
V3: Option to have lazy DSC<> initialization. Option to exclude stati…
uffelauesen Aug 25, 2016
2205b5a
Review taken into account. Also adding implementation for ResolveBack…
uffelauesen Sep 15, 2017
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
113 changes: 113 additions & 0 deletions ODataConnectedService/src/CodeGeneration/V3CodeGenDescriptor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,67 @@ namespace Microsoft.OData.ConnectedService.CodeGeneration
{
internal class V3CodeGenDescriptor : BaseCodeGenDescriptor
{
const string loadServiceModelAssignment = "this.Format.LoadServiceModel = GeneratedEdmModel.GetInstance;";
const string dynamicModelLoader =
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For maintainability, can you please put a comment with a high-level description on how the class works/will be utilized?

@"private abstract class RuntimeEdmModel
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute(""System.Data.Services.Design"", ""1.0.0"")]
private static global::System.Collections.Generic.Dictionary<string, global::Microsoft.Data.Edm.IEdmModel> models = new global::System.Collections.Generic.Dictionary<string, global::Microsoft.Data.Edm.IEdmModel>(global::System.StringComparer.OrdinalIgnoreCase);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please split into multiple lines for readability.


[global::System.CodeDom.Compiler.GeneratedCodeAttribute(""System.Data.Services.Design"", ""1.0.0"")]
private static object modelsCacheLock = new object();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make this lock readonly as well.


[global::System.CodeDom.Compiler.GeneratedCodeAttribute(""System.Data.Services.Design"", ""1.0.0"")]
public static global::Microsoft.Data.Edm.IEdmModel LoadModel(global::System.Data.Services.Client.DataServiceContext context)
{
var metadataUri = context.GetMetadataUri();
global::Microsoft.Data.Edm.IEdmModel model = null;
if (!models.TryGetValue(metadataUri.AbsoluteUri, out model))
{
lock (modelsCacheLock)
{
if (!models.TryGetValue(metadataUri.AbsoluteUri, out model))
{
var request = (global::System.Net.HttpWebRequest)global::System.Net.WebRequest.Create(metadataUri);
request.Credentials = context.Credentials;

using (var response = request.EndGetResponse(request.BeginGetResponse(null, null)))
using (var stream = response.GetResponseStream())
using (var reader = global::System.Xml.XmlReader.Create(stream))
{
model = global::Microsoft.Data.Edm.Csdl.EdmxReader.Parse(reader);
models.Add(metadataUri.AbsoluteUri, model);
}
}
}
}
return model;
}
}";

const string collectionReplacer =
@"private $1 __$2 = null;

[global::System.CodeDom.Compiler.GeneratedCodeAttribute(""System.Data.Services.Design"", ""1.0.0"")]
private $1 _$2
{
get
{
if (__$2 == null && !__$2Initialized)
$2 = new $1(null, global::System.Data.Services.Client.TrackingMode.None);
return __$2;
}
set
{
__$2 = value;
__$2Initialized = true;
}
}

[global::System.CodeDom.Compiler.GeneratedCodeAttribute(""System.Data.Services.Design"", ""1.0.0"")]
bool __$2Initialized;
";

public V3CodeGenDescriptor(string metadataUri, ConnectedServiceHandlerContext context, Project project)
: base(metadataUri, context, project)
{
Expand Down Expand Up @@ -85,6 +146,58 @@ public async override Task AddGeneratedClientCode()
}
}

if (this.ServiceConfiguration.LazyInitializedEntityCollections || this.ServiceConfiguration.UseRuntimeModel)
{
await this.Context.Logger.WriteMessageAsync(LoggerMessageCategory.Information, "Cleaning proxy...");
string original = null;
using (var textReader = File.OpenText(tempFile))
{
original = await textReader.ReadToEndAsync();
}
string modified = null;

if (this.ServiceConfiguration.LazyInitializedEntityCollections)
{
string pattern = null;
if (generator.UseDataServiceCollection)
{
await this.Context.Logger.WriteMessageAsync(LoggerMessageCategory.Information, "Proxy - injecting lazy initialization of DataServiceCollections");
pattern = @"private (.+) _(.+) = new global::System.Data.Services.Client.DataServiceCollection\<(.+)\>\(null, global::System.Data.Services.Client.TrackingMode.None\);";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please split into multiple lines for readability.

}
else
{
await this.Context.Logger.WriteMessageAsync(LoggerMessageCategory.Information, "Proxy - injecting lazy initialization of ObservableCollections");
pattern = @"private (.+) _(.+) = new global::System.Collections.ObjectModel.Collection\<(.+)\>\(\);";
}
modified = Regex.Replace(original, pattern, collectionReplacer);
}
else
modified = original;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: please encapsulate this in { }, even for one-liners to be consistent with the style standard.


if (this.ServiceConfiguration.UseRuntimeModel)
{
await this.Context.Logger.WriteMessageAsync(LoggerMessageCategory.Information, "Proxy - removing static model");
int loadServiceModelAssignmentIndex = modified.IndexOf(loadServiceModelAssignment);
if (loadServiceModelAssignmentIndex >= 0)
{
modified = string.Concat(modified.Substring(0, loadServiceModelAssignmentIndex), "this.Format.LoadServiceModel = () => RuntimeEdmModel.LoadModel(this);", modified.Substring(loadServiceModelAssignmentIndex + loadServiceModelAssignment.Length));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please split into multiple lines for readability.

int classStart = modified.IndexOf("private abstract class GeneratedEdmModel");
int classEnd = modified.IndexOf("return global::System.Xml.XmlReader.Create(new global::System.IO.StringReader(edmxToParse));");
if (classStart >= 0 && classEnd > 0)
{
classEnd = modified.IndexOf('}', classEnd + 1);
classEnd = modified.IndexOf('}', classEnd + 1) + 1;
modified = string.Concat(modified.Substring(0, classStart), dynamicModelLoader, modified.Substring(classEnd));
}
}
}
await this.Context.Logger.WriteMessageAsync(LoggerMessageCategory.Information, "Proxy generation done. Writing output files...");
using (StreamWriter writer = File.CreateText(tempFile))
{
await writer.WriteAsync(modified);
}
}

string outputFile = Path.Combine(GetReferenceFileFolder(), this.GeneratedFileNamePrefix + ".cs");
await this.Context.HandlerHelper.AddFileAsync(tempFile, outputFile);
}
Expand Down
2 changes: 2 additions & 0 deletions ODataConnectedService/src/Models/ServiceConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ internal class ServiceConfiguration
public bool UseNameSpacePrefix { get; set; }
public string NamespacePrefix { get; set; }
public bool UseDataServiceCollection { get; set; }
public bool UseRuntimeModel { get; set; }
public bool LazyInitializedEntityCollections { get; set; }
}

internal class ServiceConfigurationV4 : ServiceConfiguration
Expand Down
4 changes: 4 additions & 0 deletions ODataConnectedService/src/ODataConnectedServiceWizard.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ public ODataConnectedServiceWizard(ConnectedServiceProviderContext context)
advancedSettingsViewModel.UseNamespacePrefix = serviceConfig.UseNameSpacePrefix;
advancedSettingsViewModel.NamespacePrefix = serviceConfig.NamespacePrefix;
advancedSettingsViewModel.UseDataServiceCollection = serviceConfig.UseDataServiceCollection;
advancedSettingsViewModel.UseRuntimeModel = serviceConfig.UseRuntimeModel;
advancedSettingsViewModel.LazyInitializedEntityCollections = serviceConfig.LazyInitializedEntityCollections;

if (serviceConfig.EdmxVersion == Common.Constants.EdmxVersion4)
{
Expand Down Expand Up @@ -130,6 +132,8 @@ private ServiceConfiguration CreateServiceConfiguration()
serviceConfiguration.Endpoint = ConfigODataEndpointViewModel.Endpoint;
serviceConfiguration.EdmxVersion = ConfigODataEndpointViewModel.EdmxVersion;
serviceConfiguration.UseDataServiceCollection = AdvancedSettingsViewModel.UseDataServiceCollection;
serviceConfiguration.UseRuntimeModel = AdvancedSettingsViewModel.UseRuntimeModel;
serviceConfiguration.LazyInitializedEntityCollections = AdvancedSettingsViewModel.LazyInitializedEntityCollections;
serviceConfiguration.GeneratedFileNamePrefix = AdvancedSettingsViewModel.GeneratedFileName;
serviceConfiguration.UseNameSpacePrefix = AdvancedSettingsViewModel.UseNamespacePrefix;
if (AdvancedSettingsViewModel.UseNamespacePrefix && !string.IsNullOrEmpty(AdvancedSettingsViewModel.NamespacePrefix))
Expand Down
4 changes: 4 additions & 0 deletions ODataConnectedService/src/ViewModels/AdvancedSettingsViewModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ internal class AdvancedSettingsViewModel : ConnectedServiceWizardPage
public bool IgnoreUnexpectedElementsAndAttributes { get; set; }
public string GeneratedFileName { get; set; }
public bool IncludeT4File { get; set; }
public bool UseRuntimeModel { get; set; }
public bool LazyInitializedEntityCollections { get; set; }

public AdvancedSettingsViewModel() : base()
{
Expand Down Expand Up @@ -51,6 +53,8 @@ private void ResetDataContext()
this.UseNamespacePrefix = false;
this.NamespacePrefix = null;
this.UseDataServiceCollection = true;
this.UseRuntimeModel = false;
this.LazyInitializedEntityCollections = true;
this.IgnoreUnexpectedElementsAndAttributes = false;
this.EnableNamingAlias = false;
this.GeneratedFileName = Common.Constants.DefaultReferenceFileName;
Expand Down
8 changes: 8 additions & 0 deletions ODataConnectedService/src/Views/AdvancedSettings.xaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@
HorizontalAlignment="Left" TextWrapping="Wrap" VerticalAlignment="Center" Width="250" Margin="20, 0, 0, 5"/>
<CheckBox x:Name="UseDSC" Content="Enable entity and property tracking" IsChecked="{Binding UseDataServiceCollection}"
HorizontalAlignment="Left" VerticalAlignment="Top" Margin="0, 5, 0, 0" />
<CheckBox x:Name="UseLazyDSC" Content="Lazy entity collection initialization" IsChecked="{Binding LazyInitializedEntityCollections}"
HorizontalAlignment="Left" VerticalAlignment="Top" Margin="0, 5, 0, 0" />
<CheckBox x:Name="ExcludeModel" IsChecked="{Binding UseRuntimeModel}"
HorizontalAlignment="Left" VerticalAlignment="Top" Margin="0, 5, 0, 0" >
<TextBlock TextWrapping="Wrap" Margin="0, 0, 40, 0">
Load model runtime (Produces smaller assembly, but will issue a request runtime for the metadata document.)
</TextBlock>
</CheckBox>
</StackPanel>
<StackPanel x:Name="AdvancedSettingsForv4" HorizontalAlignment="Left" Margin="10, 5, 0, 0" VerticalAlignment="Top">
<CheckBox x:Name="EnableCamelCase" Content="Use c# casing style" IsChecked="{Binding EnableNamingAlias}"
Expand Down