Upgrade Guide (Upgrading to 2019 R3 Beta)

Last Updated: September 2020

Upgrading from 2019 R2 to 2019 R3 Beta

If you have installed SnapDevelop 2019 R2 and SnapObjects 2.x, you can follow steps below to upgrade to SnapDevelop 2019 R3 and SnapObjects 3.x.

Upgrading the NuGet packages

In 2019 R3 beta, a number of APIs have been added or changed for SnapObjects and .NET DataStore. For details, see New or Changed APIs in 2019 R3. Therefore, it is necessary to upgrade to the following NuGet packages versions:

  • .NET DataStore 3.0.0-beta (DWNet.Data and DWNet.Data.AspNetCore)
  • PowerScript Migrator Framework 1.0.3-beta
  • SnapObjects 3.0.0-beta

Upgrading ASP.NET Core 2.x Projects to 3.x

If you want to upgrade your ASP .NET Core 2.x project to 3.x, follow the steps below:

Step 1: Remove the obsolete package reference to Microsoft.AspNetCore.Appin the <itemgroup> section of the project .csproj file.

For example, the following line in the .csproj file shall be removed:

<PackageReference Include="Microsoft.AspNetCore.App"/>

Step 2: Update the Program.cs file.

  1. Remove the using statement for the Microsoft.AspNetCore namespace, and add a using statement for the Microsoft.Extensions.Hosting namespace.
  2. Change from HostBuilder to WebHostBuilder.

For example, the following is the code in the Program.cs file of an ASP.NET Core 2.1 project:

using Microsoft.AspNetCore;
using Microsoft.Extensions.Hosting;

namespace WebApplication_2_1
{
    public class Program
    {
        public static void Main(string[] args)
        {
            CreateWebHostBuilder(args).Build().Run();
        }

        public static IWebHostBuilder CreateHostBuilder(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
            .UseStartup<Startup>();
    }
}

The following is the code in the program.cs file of an ASP.NET Core 3.1project:

using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;

namespace WebApplication62
{
    public class Program
    {
        public static void Main(string[] args)
        {
            CreateHostBuilder(args).Build().Run();
        }

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                });
    }
}

Step 3: Update the Startup.cs file.

  1. Replace IHostingEnvironment with IWebHostEnvironment and add a using statement for the Microsoft.Extensions.Hosting namespace.

  2. In ConfigureServices, call to services.AddControllers() instead of services.AddMvc().

  3. Update the Configure method following the sample below.

    The following is the code in the Configure method in the Startup.cs file of an ASP.NET Core 2.1 project:

    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            else
            {
                app.UseHsts();
            }

            // Adds middleware for redirecting HTTP Requests to HTTPS.
            // app.UseHttpsRedirection();

            app.UseResponseCompression();

            app.UseMvc();

            app.UseDataWindow();
        }

    The following is the code in the Configure method in the Startup.cs file of an ASP.NET Core 3.1 project:

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
 		if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

 		// Adds middleware for redirecting HTTP Requests to HTTPS.
            // app.UseHttpsRedirection();

            app.UseRouting();

            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });

            app.UseResponseCompression();

            app.UseDataWindow();
        }

    Note that the call to UseAuthorizationmust appear between the calls to UseRouting and UseEndpoints to be effective.

Step 4: Please refer to Migrate from ASP.NET Core 2.2 to 3.0 and Migrate from ASP.NET Core 3.0 to 3.1 for the further changes that you may need to implement on your project.

Upgrading from 2019 to 2019 R2

If you have installed SnapDevelop 2019 and SnapObjects 1.0, you can follow steps below to upgrade to SnapDevelop 2019 R2 and SnapObjects 2.0.

Step 1: Re-install NuGet packages.

  1. Upgrade the existing SnapObjects package to version 2.0.0.

  2. Remove the old packages first and then install the new packages, as the following NuGet packages have been renamed:

    PowerBuilder.Data is renamed to DWNet.Data.

    PowerBuilder.Data.AspNetCore is renamed to DWNet.Data.AspNetCore.

Step 2: Upgrade .NET DataStore.

  1. Remove the DataWindow SRD files and model files from the project, and then re-generate the data models for DataWindows using the DataWindow Converter tool.

  2. In non-ASP .NET Core project, change the method to load DataWindow from DataObjectFactory.LoadDataWindow() to DwModelManager.LoadDwModels().

    If using DataStore<T> to replace the original DataStores, then you don't need to use the DwModelManager.LoadDwModels().

  3. Make corresponding changes to DataObject, as now DataStore.Object returns an IDwMeta object, and it is no longer possible to access the DataWindow object properties related with UI (these properties as well as DataObject have been moved to PowerScript.Bridge).

Step 3: Install and use the new PowerScript.Bridge package.

When using the C# functions which is migrated from PowerScript or using DataObject which is moved from DwNet.Data to PowerScript.Bridge, you will need to add the PowerScript.Bridge namepspace.

Step 4: Compile the project and modify the script according to the error prompts.

There are a few method names or usages that have been changed.