Merge pull request #63 from Azure-Samples/brecon/ga

Merge eShop/main 5/24

Author: BrennanConroy

.github/dependabot.yml

@@ -9,7 +9,7 @@ updates:
     registries:
       - public-nuget
     schedule:
-      interval: daily
+      interval: weekly
     open-pull-requests-limit: 15
     groups:
       Aspire:

Directory.Packages.props

@@ -3,11 +3,13 @@
     <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
     <CentralPackageTransitivePinningEnabled>true</CentralPackageTransitivePinningEnabled>
     <AspnetVersion>8.0.5</AspnetVersion>
-    <MicrosoftExtensionsVersion>8.4.0</MicrosoftExtensionsVersion>
-    <EfVersion>8.0.4</EfVersion>
-    <AspireVersion>8.0.0-preview.7.24251.11</AspireVersion>
+    <MicrosoftExtensionsVersion>8.5.0</MicrosoftExtensionsVersion>
+    <EfVersion>8.0.5</EfVersion>
+    <AspireVersion>8.0.0</AspireVersion>
+    <AspireUnstablePackagesVersion>8.0.0-preview.8.24258.2</AspireUnstablePackagesVersion>
     <GrpcVersion>2.62.0</GrpcVersion>
     <DuendeVersion>7.0.4</DuendeVersion>
+    <ApiVersioningVersion>8.1.0</ApiVersioningVersion>
   </PropertyGroup>
   <ItemGroup>
     <!-- Version together with Aspire -->
@@ -23,10 +25,13 @@
     <PackageVersion Include="Aspire.Npgsql" Version="$(AspireVersion)" />
     <PackageVersion Include="Aspire.Npgsql.EntityFrameworkCore.PostgreSQL" Version="$(AspireVersion)" />
     <PackageVersion Include="Aspire.StackExchange.Redis" Version="$(AspireVersion)" />
-    <PackageVersion Include="Aspire.Azure.AI.OpenAI" Version="$(AspireVersion)" />
+    <PackageVersion Include="Aspire.Azure.AI.OpenAI" Version="$(AspireUnstablePackagesVersion)" />
     <PackageVersion Include="Microsoft.Extensions.ServiceDiscovery" Version="$(AspireVersion)" />
     <PackageVersion Include="Microsoft.Extensions.ServiceDiscovery.Yarp" Version="$(AspireVersion)" />
     <!-- Version together with ASP.NET -->
+    <PackageVersion Include="Asp.Versioning.Http" Version="$(ApiVersioningVersion)" />
+    <PackageVersion Include="Asp.Versioning.Http.Client" Version="$(ApiVersioningVersion)" />
+    <PackageVersion Include="Asp.Versioning.Mvc.ApiExplorer" Version="$(ApiVersioningVersion)" />
     <PackageVersion Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="$(AspnetVersion)" />
     <PackageVersion Include="Microsoft.AspNetCore.Authentication.OpenIdConnect" Version="$(AspnetVersion)" />
     <PackageVersion Include="Microsoft.AspNetCore.Components.QuickGrid" Version="$(AspnetVersion)" />
@@ -39,7 +44,7 @@
     <PackageVersion Include="Microsoft.Extensions.Identity.Stores" Version="$(AspnetVersion)" />
     <PackageVersion Include="Microsoft.Extensions.Http.Resilience" Version="$(MicrosoftExtensionsVersion)" />
     <!-- Version together with EF -->
-    <PackageVersion Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="8.0.2" />
+    <PackageVersion Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="8.0.4" />
     <PackageVersion Include="Microsoft.EntityFrameworkCore.Tools" Version="$(EfVersion)" />
     <PackageVersion Include="NSubstitute" Version="5.1.0" />
     <PackageVersion Include="NSubstitute.Analyzers.CSharp" Version="1.0.17" />
@@ -53,6 +58,7 @@
     <PackageVersion Include="AspNetCore.HealthChecks.Uris" Version="8.0.1" />
     <!-- AI -->
     <PackageVersion Include="Microsoft.SemanticKernel" Version="1.13.0" />
+    <PackageVersion Include="Microsoft.SemanticKernel.Connectors.Onnx" Version="1.10.0-alpha" />
     <!-- Open Telemetry -->
     <PackageVersion Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.8.1" />
     <PackageVersion Include="OpenTelemetry.Extensions.Hosting" Version="1.8.1" />
@@ -78,11 +84,11 @@
     <PackageVersion Include="FluentValidation.AspNetCore" Version="11.3.0" />
     <PackageVersion Include="MediatR" Version="12.2.0" />
     <PackageVersion Include="Microsoft.Web.LibraryManager.Build" Version="2.1.175" />
-    <PackageVersion Include="Polly" Version="8.3.1" />
-    <PackageVersion Include="Swashbuckle.AspNetCore" Version="6.5.0" />
+    <PackageVersion Include="Polly.Core" Version="8.4.0" />
+    <PackageVersion Include="Swashbuckle.AspNetCore" Version="6.6.1" />
     <PackageVersion Include="System.Reflection.TypeExtensions" Version="4.7.0" />
     <PackageVersion Include="xunit" Version="2.8.0" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.0" />
     <PackageVersion Include="Yarp.ReverseProxy" Version="2.1.0" />
   </ItemGroup>
-</Project>
+</Project>

README.md

@@ -1,6 +1,6 @@
-# eShop Reference Application - "Northern Mountains"
+# eShop Reference Application - "AdventureWorks"
 
-A reference .NET application implementing an eCommerce web site using a services-based architecture.
+A reference .NET application implementing an e-commerce website using a services-based architecture.
 
 ![eShop Reference Application architecture diagram](img/eshop_architecture.png)
 
@@ -11,18 +11,30 @@ A reference .NET application implementing an eCommerce web site using a services
 ### Prerequisites
 
 - Clone the eShop repository: https://github.com/Azure-Samples/eshopOnAzure
-- (Windows only) Install Visual Studio. Visual Studio contains tooling support for .NET Aspire that you will want to have. [Visual Studio 2022 version 17.10 Preview](https://visualstudio.microsoft.com/vs/preview/).
-  - During installation, ensure that the following are selected:
+- Install & start Docker Desktop: https://docs.docker.com/engine/install/
+
+#### Windows with Visual Studio
+- Install [Visual Studio 2022 version 17.10 or newer](https://visualstudio.microsoft.com/vs/).
+  - Select the following workloads:
     - `ASP.NET and web development` workload.
     - `.NET Aspire SDK` component in `Individual components`.
-- Install the latest [.NET 8 SDK](https://github.com/dotnet/installer#installers-and-binaries)
-- On Mac/Linux (or if not using Visual Studio), install the Aspire workload with the following commands:
+    - Optional: `.NET Multi-platform App UI development` to run client apps
+
+#### Mac, Linux, & Windows without Visual Studio
+- Install the latest [.NET 8 SDK](https://dot.net/download?cid=eshop)
+- Install the [.NET Aspire workload](https://learn.microsoft.com/dotnet/aspire/fundamentals/setup-tooling?tabs=dotnet-cli%2Cunix#install-net-aspire) with the following commands:
 ```powershell
 dotnet workload update
 dotnet workload install aspire
 dotnet restore eShop.Web.slnf
 ```
-- Install & start Docker Desktop:  https://docs.docker.com/engine/install/
+
+> Note: These commands may require `sudo`
+
+- Optional: Install [Visual Studio Code with C# Dev Kit](https://code.visualstudio.com/docs/csharp/get-started)
+- Optional: Install [.NET MAUI Workload](https://learn.microsoft.com/dotnet/maui/get-started/installation?tabs=visual-studio-code)
+
+> Note: When running on Mac with Apple Silicon (M series processor), Rosetta 2 for grpc-tools. 
 
 ### Running the solution
 
@@ -40,18 +52,34 @@ dotnet run --project src/eShop.AppHost/eShop.AppHost.csproj
 ```
 then look for lines like this in the console output in order to find the URL to open the Aspire dashboard:
 ```sh
-Now listening on: http://localhost:18848
+Login to the dashboard at: http://localhost:19888/login?t=uniquelogincodeforyou
 ```
 
-### Sample data
+> You may need to install ASP.NET Core HTTPS development certificates first, and then close all browser tabs. Learn more at https://aka.ms/aspnet/https-trust-dev-cert
 
-The sample catalog data is defined in [catalog.json](https://github.com/dotnet/eShop/blob/main/src/Catalog.API/Setup/catalog.json). Those product names, descriptions, and brand names are fictional and were generated using [GPT-35-Turbo](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/chatgpt), and the corresponding [product images](https://github.com/dotnet/eShop/tree/main/src/Catalog.API/Pics) were generated using [DALL·E 3](https://openai.com/dall-e-3).
+### Azure Open AI
+
+When using Azure OpenAI, inside *eShop.AppHost/appsettings.json*, add the following section:
+
+```json
+  "ConnectionStrings": {
+    "OpenAi": "Endpoint=xxx;Key=xxx;"
+  }
+```
+
+Replace the values with your own. Then, in the eShop.AppHost *Program.cs*, set this value to **true**
+
+```csharp
+bool useOpenAI = false;
+```
+
+Here's additional guidance on the [.NET Aspire OpenAI component](https://learn.microsoft.com/dotnet/aspire/azureai/azureai-openai-component?tabs=dotnet-cli). 
 
-## Use Azure Developer CLI
+### Use Azure Developer CLI
 
 You can use the [Azure Developer CLI](https://aka.ms/azd) to run this project on Azure with only a few commands. Follow the next instructions:
 
-- Install [azd](https://aka.ms/azure-dev/install).
+- Install the latest or update to the latest [Azure Developer CLI (azd)](https://aka.ms/azure-dev/install).
 - Log in `azd` (if you haven't done it before) to your Azure account:
 ```sh
 azd auth login
@@ -61,8 +89,8 @@ azd auth login
 azd init
 ```
 - During init:
-  - Select `Use code in the current directory`. Azd will automatically detect the Dotnet Aspire project.
-  - Confirm `.Net (Aspire)` and continue.
+  - Select `Use code in the current directory`. Azd will automatically detect the .NET Aspire project.
+  - Confirm `.NET (Aspire)` and continue.
   - Select which services to expose to the Internet (exposing `webapp` is enough to test the sample).
   - Finalize the initialization by giving a name to your environment.
 
@@ -79,7 +107,11 @@ Notes:
 
 ## Contributing
 
-For more information on contributing to this repo, please read [the contribution documentation](./CONTRIBUTING.md) and [the Code of Conduct](CODE-OF-CONDUCT.md).
+For more information on contributing to this repo, read [the contribution documentation](./CONTRIBUTING.md) and [the Code of Conduct](CODE-OF-CONDUCT.md).
+
+### Sample data
+
+The sample catalog data is defined in [catalog.json](https://github.com/dotnet/eShop/blob/main/src/Catalog.API/Setup/catalog.json). Those product names, descriptions, and brand names are fictional and were generated using [GPT-35-Turbo](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/chatgpt), and the corresponding [product images](https://github.com/dotnet/eShop/tree/main/src/Catalog.API/Pics) were generated using [DALL·E 3](https://openai.com/dall-e-3).
 
 ### Other eShops
 

src/Catalog.API/AIOptions.cs

@@ -5,28 +5,30 @@ namespace eShop.Catalog.API;
 
 public static class CatalogApi
 {
-    public static IEndpointRouteBuilder MapCatalogApi(this IEndpointRouteBuilder app)
+    public static IEndpointRouteBuilder MapCatalogApiV1(this IEndpointRouteBuilder app)
     {
+        var api = app.MapGroup("api/catalog").HasApiVersion(1.0);
+
         // Routes for querying catalog items.
-        app.MapGet("/items", GetAllItems);
-        app.MapGet("/items/by", GetItemsByIds);
-        app.MapGet("/items/{id:int}", GetItemById);
-        app.MapGet("/items/by/{name:minlength(1)}", GetItemsByName);
-        app.MapGet("/items/{catalogItemId:int}/pic", GetItemPictureById);
+        api.MapGet("/items", GetAllItems);
+        api.MapGet("/items/by", GetItemsByIds);
+        api.MapGet("/items/{id:int}", GetItemById);
+        api.MapGet("/items/by/{name:minlength(1)}", GetItemsByName);
+        api.MapGet("/items/{catalogItemId:int}/pic", GetItemPictureById);
 
         // Routes for resolving catalog items using AI.
-        app.MapGet("/items/withsemanticrelevance/{text:minlength(1)}",  GetItemsBySemanticRelevance);
+        api.MapGet("/items/withsemanticrelevance/{text:minlength(1)}", GetItemsBySemanticRelevance);
 
         // Routes for resolving catalog items by type and brand.
-        app.MapGet("/items/type/{typeId}/brand/{brandId?}", GetItemsByBrandAndTypeId);
-        app.MapGet("/items/type/all/brand/{brandId:int?}", GetItemsByBrandId);
-        app.MapGet("/catalogtypes", async (CatalogContext context) => await context.CatalogTypes.OrderBy(x => x.Type).ToListAsync());
-        app.MapGet("/catalogbrands", async (CatalogContext context) => await context.CatalogBrands.OrderBy(x => x.Brand).ToListAsync());
+        api.MapGet("/items/type/{typeId}/brand/{brandId?}", GetItemsByBrandAndTypeId);
+        api.MapGet("/items/type/all/brand/{brandId:int?}", GetItemsByBrandId);
+        api.MapGet("/catalogtypes", async (CatalogContext context) => await context.CatalogTypes.OrderBy(x => x.Type).ToListAsync());
+        api.MapGet("/catalogbrands", async (CatalogContext context) => await context.CatalogBrands.OrderBy(x => x.Brand).ToListAsync());
 
         // Routes for modifying catalog items.
-        app.MapPut("/items",  UpdateItem);
-        app.MapPost("/items", CreateItem);
-        app.MapDelete("/items/{id:int}", DeleteItemById);
+        api.MapPut("/items", UpdateItem);
+        api.MapPost("/items", CreateItem);
+        api.MapDelete("/items/{id:int}", DeleteItemById);
 
         return app;
     }
@@ -126,7 +128,7 @@ public static async Task<Results<BadRequest<string>, RedirectToRouteHttpResult,
 
         if (!services.CatalogAI.IsEnabled)
         {
-           return await GetItemsByName(paginationRequest, services, text);
+            return await GetItemsByName(paginationRequest, services, text);
         }
 
         // Create an embedding for the input search
@@ -250,7 +252,7 @@ public static async Task<Results<Created, NotFound<string>>> UpdateItem(
         {
             await services.Context.SaveChangesAsync();
         }
-        return TypedResults.Created($"/api/v1/catalog/items/{productToUpdate.Id}");
+        return TypedResults.Created($"/api/catalog/items/{productToUpdate.Id}");
     }
 
     public static async Task<Created> CreateItem(
@@ -275,7 +277,7 @@ public static async Task<Created> CreateItem(
         services.Context.CatalogItems.Add(item);
         await services.Context.SaveChangesAsync();
 
-        return TypedResults.Created($"/api/v1/catalog/items/{item.Id}");
+        return TypedResults.Created($"/api/catalog/items/{item.Id}");
     }
 
     public static async Task<Results<NoContent, NotFound>> DeleteItemById(

src/Catalog.API/Apis/CatalogApi.cs

@@ -3,6 +3,7 @@
   <PropertyGroup>
     <TargetFramework>net8.0</TargetFramework>
     <UserSecretsId>d1b521ec-3411-4d39-98c6-8509466ed471</UserSecretsId>
+    <NoWarn>$(NoWarn);SKEXP0001;SKEXP0010;SKEXP0070</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>
@@ -15,6 +16,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <PackageReference Include="Asp.Versioning.Http" />
     <PackageReference Include="Aspire.Npgsql.EntityFrameworkCore.PostgreSQL" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Tools">
       <PrivateAssets>all</PrivateAssets>
@@ -25,6 +27,8 @@
   <!-- AI -->
   <ItemGroup>
     <PackageReference Include="Aspire.Azure.AI.OpenAI" />
+    <PackageReference Include="Microsoft.SemanticKernel" />
+    <PackageReference Include="Microsoft.SemanticKernel.Connectors.Onnx" />
     <PackageReference Include="Pgvector" />
     <PackageReference Include="Pgvector.EntityFrameworkCore" />
   </ItemGroup>

src/Catalog.API/Catalog.API.csproj

@@ -1,10 +1,10 @@
 @Catalog.API_HostAddress = http://localhost:5222
+@ApiVersion = 1.0
 
-
-GET {{Catalog.API_HostAddress}}/api/v1/catalog/items
+GET {{Catalog.API_HostAddress}}/api/catalog/items?api-version={{ApiVersion}}
 
 ###
 
-GET {{Catalog.API_HostAddress}}/api/v1/catalog/items/type/1/brand/2
+GET {{Catalog.API_HostAddress}}/api/catalog/items/type/1/brand/2?api-version={{ApiVersion}}
 
 ###

src/Catalog.API/Catalog.API.http

@@ -1,5 +1,6 @@
 using eShop.Catalog.API.Services;
 using eShop.EventBusServiceBus;
+using Microsoft.SemanticKernel;
 
 public static class Extensions
 {
@@ -28,12 +29,15 @@ public static void AddApplicationServices(this IHostApplicationBuilder builder)
         builder.Services.AddOptions<CatalogOptions>()
             .BindConfiguration(nameof(CatalogOptions));
 
-        builder.Services.AddOptions<AIOptions>()
-            .BindConfiguration("AI");
-
-        if (!string.IsNullOrWhiteSpace(builder.Configuration.GetConnectionString("openai")))
+        if (builder.Configuration["AI:Onnx:EmbeddingModelPath"] is string modelPath &&
+            builder.Configuration["AI:Onnx:EmbeddingVocabPath"] is string vocabPath)
+        {
+            builder.Services.AddBertOnnxTextEmbeddingGeneration(modelPath, vocabPath);
+        }
+        else if (!string.IsNullOrWhiteSpace(builder.Configuration.GetConnectionString("openai")))
         {
             builder.AddAzureOpenAIClient("openai");
+            builder.Services.AddOpenAITextEmbeddingGeneration(builder.Configuration["AIOptions:OpenAI:EmbeddingName"] ?? "text-embedding-3-small");
         }
 
         builder.Services.AddSingleton<ICatalogAI, CatalogAI>();

src/Catalog.API/Extensions/Extensions.cs

@@ -1,4 +1,6 @@
-global using eShop.Catalog.API;
+global using Asp.Versioning;
+global using Asp.Versioning.Conventions;
+global using eShop.Catalog.API;
 global using eShop.Catalog.API.Infrastructure;
 global using eShop.Catalog.API.Infrastructure.EntityConfigurations;
 global using eShop.Catalog.API.Infrastructure.Exceptions;