Feature/BBC-51-Add-Commands-to-API
BBC-51: Add commands -

The request example:

{
    "Type": "CreateBoard",
    "Parameters": {
        "X": "8",
        "Y": "13",
        "Name": "Amazing device",
        "Description": "An exciting hardware project"
    }
}

The normal response example:

{
  "Boards": {
    "6637eeec-cab5-44c0-9a79-41661acbfe94": {
      "Name": "Amazing device",
      "SixeX": 8,
      "SixeY": 13,
      "svg": "<svg version=\"1.1\" width=\"180\" height=\"280\" ... r\n</svg>"
    }
  },
  "Error": null
}

The abnormal response example:

{
  "Boards": {},
  "Error": "The command is not consistent: CREATE BOARD Name = \"Amazing device\" X =  Y = 13 Description = \"An exciting hardware project\" User = \"\""
}

As described here.

Install-Package Swashbuckle.AspNetCore
Install-Package Microsoft.AspNetCore.OpenApi

It was forgotten to remove the Azure-related dependence during #1

the API must provide:

• Possibility to send particular command in the text form
• Possibility to send particular command in JSon form
• Possibility to send text-based script with command sequence
• Possibility to send the command batch in JSon form

1. Add storage template (in-memory storage is good for the beginning);
2. Add core behavior implementation assembly;
3. Use DI to add these things.

The ideal structure looks like this:

• Root level (public root level interfaces and exporting functionality)
• Common (public interfaces that can be shared between assemblies);
• Commands (public command implementations);
• Implementations (Internal scripts and batch processing implementations).

Helpful info:

• Working with HTML Forms
• ASP.NET Core Blazor event handling
• ASP.NET Core Razor components
• ASP.NET Core Blazor data binding

To make DI reusable in different contexts, for instance, in tests.

It must be different things:

• Drawing Engine
• Language Parser
• Command Processor who operates with the Drawing Engine and returns the Images processed regarding Commands from the Language Parser

Implement Single-Window principle

Commit prefix: BBC-72: UX - Move Board Creating to Editor -

Description: .Net Code Coverage Badge

Coverlet integration with MSBuild

BBC-55: Add .Net Code Coverage Badge -

It also requires some optimization of the command processing infrastructure to avoid code duplication.

How to:

• Swagger ASP.NET Core Minimal API include XML comments files
• ASP.NET Core 7 Minimal API - Swagger doesn't start
• Include Descriptions from XML Comments

Currently, we use In-Memory DB.
Now we must implement DB-usage parts logic.

An HTML page at the address /test.htm shows a sample default scheme.
In the future, it can contain some test commands to the API.

Annotations for CI part

• The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2, actions/setup-dotnet@v1. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
• The following actions uses node12 which is deprecated and will be forced to run on node16: actions/setup-dotnet@v1. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/

Annotations for CD part

• The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2, actions/setup-dotnet@v1, aws-actions/configure-aws-credentials@v1. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
• The set-output command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
• The "--output" option isn't supported when building a solution. Specifying a solution-level output path results in all projects copying outputs to the same directory, which can lead to inconsistent builds.
• The "--output" option isn't supported when building a solution. Specifying a solution-level output path results in all projects copying outputs to the same directory, which can lead to inconsistent builds.

The command must look like:

• ADD LINE X1 = 2 Y1 = 2 X2 = 5
• ADD LINE X1 = 2 Y1 = 2 Y2 = 6

The last parameter must be calculated:

• To avoid ambiguity
• To make clear the orthogonal nature of lines

We must do two things:

• To make the consistency checking parameter virtual;
• To implement the command initially;
• To override the consistency checking parameter for this command to provide the calculatable last parameter.

Removing the Docker-related features from the project.
One more part was removed by #13

It must be a Command layer that interacts with the board itself.
The command API must represent a scripting language for the CAD API.

It must be able to serialize and deserialize commands.

It is not very convenient to use this format of parameters:

command.Parameters["X"].Value

Every particular command can have its parameters based on the current implementation.

A natural approach:

AWS recommended approach: How to load .NET configuration from AWS Secrets Manager

MS article on secrets: Safe storage of app secrets in development in ASP.NET Core

3rd party approach:

Secure secrets storage for ASP.NET Core with AWS Secrets Manager (Part 1)

Secure secrets storage for ASP.NET Core with AWS Secrets Manager (Part 2)

-=242=- of ASP.NET Core in Action

builder.Configuration.AddUserSecrets();

` internal interface ISvgElement
{
IEnumerable SVG { get; }

    string ToString();
}

`

As described here

The site needs a form for the user to add new boards and modify the metadata of existing boards.

• The Modify Metadata must be on the Schema Editor Page;
• The Add button must be on the Board List page.

Commit prefix: BBC-68: Add Create Board Functionality to Site -

https://learn.microsoft.com/en-us/aspnet/core/blazor/forms/?view=aspnetcore-7.0

https://learn.microsoft.com/en-us/aspnet/core/blazor/components/data-binding?view=aspnetcore-7.0

Move static and helper methods and properties to the dedicated class

Task conditions:

• We must request the board list regarding User Id
• We must receive only Ids and Metadata of boards

Implementation conditions:

• Add Description property to the board
• Ensure the board class has the user Id
• Create combined key {UserId - BoardUd}
• Create the API method for board listing by User Id
• Create the API method for the particular board retrieving by Board Id

Commits prefix:

• BBC-61: Add Board List -

https://dotnet.microsoft.com/en-us/learn/aspnet/blazor-tutorial/modify
https://learn.microsoft.com/en-us/aspnet/core/blazor/call-web-api?view=aspnetcore-7.0&pivots=server
https://learn.microsoft.com/en-us/aspnet/core/blazor/javascript-interoperability/?view=aspnetcore-7.0

Interesting:
used: https://stackoverflow.com/questions/70770653/blazor-server-periodic-update-of-images-using-a-timer
used: https://stackoverflow.com/questions/76014055/blazor-server-button-refresh-while-waiting

git log --oneline --graph -10
https://trailhead.salesforce.com/content/learn/modules/git-and-git-hub-basics/work-with-your-history-in-git

We need to aggregate logically linked batches together