Motivation

Currently, there is zero coverage for ~/ImageTransformation code.

Proposed solution

Cover at least a happy path by tests.

Additional context

https://docs.microsoft.com/en-us/aspnet/core/test/middleware

Motivation

https://kontent.ai/learn/docs/webhooks/webhooks/net details a new webhook experience.

However, this library appears to still use X-KC-Signature HTTP header for the webhook signature validator.

It appears the new HTTP Header is "X-Kontent-ai-Signature".

Proposed solution

Create a new signature validator and differentiate the current one as "legacy" perhaps?

Brief bug description

Deserializing webhook payloads via WebhookModel does not work with various payloads. As an example, the following payload as the result of a publish event is fine:

{
    "data": {
        "items": [
            {
                "id": "46763b84-ac6d-4347-b18a-41f8ece0badd",
                "codename": "test_publish_published_webhook",
                "language": "default",
                "type": "publish_test",
                "collection": "default"
            }
        ],
        "taxonomies": []
    },
    "message": {
        "id": "ce7bd31a-411e-4a54-af1c-7fa46bb7c1f5",
        "project_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
        "type": "content_item_variant",
        "operation": "publish",
        "api_name": "delivery_production",
        "created_timestamp": "2022-04-12T16:02:27.0593617Z",
        "webhook_url": "https://routing.azurewebsites.net/api/KontentWebhook"
    }
}

whereas the payload for a workflow event change does not:

{
    "data": {
        "items": [
            {
                "item": {
                    "id": "66d00376-ee1d-4ed1-9a3c-a88110e65190"
                },
                "language": {
                    "id": "00000000-0000-0000-0000-000000000000"
                },
                "transition_from": {
                    "id": "fe59bae0-ead6-4145-9ea8-acb398218338"
                },
                "transition_to": {
                    "id": "02907d8d-2639-432a-9ea7-633f9e3e050e"
                }
            }
        ]
    },
    "message": {
        "id": "a94ff0a8-39cb-4975-9b65-ba7ba7305693",
        "project_id": "513fdcd0-795a-01d5-a3d4-97bb0ad9c331",
        "type": "content_item_variant",
        "operation": "change_workflow_step",
        "api_name": "content_management",
        "created_timestamp": "2022-04-12T13:39:34.4449999Z",
        "webhook_url": "https://45d3-84-67-20-182.ngrok.io/webhooks/webhooks"
    }
}

There are two issues with the above:

1. language is defined as "language":{"id": "00000000-0000-0000-0000-000000000000"}, but in the c# class is a string and causes a JSON exception when deserializing: The JSON value could not be converted to System.String. Path: $.data.items[0].language | LineNumber: 0 | BytePositionInLine: 84.
2. transition_from and transition_to are not covered in the class. (This for me is less of a problem as they are ignored)

Also of interest are that the language element in both of the above messages are different; the publish event uses a codename, whereas the workflow change uses a reference identifier.

Repro steps

Replicated in LINQPad 7, using .NET 6, System.Text.Json, and Kentico.Kontent.AspNetCore 0.12.0-beta3

void Main()
{
	"publish".Dump();
	var model = System.Text.Json.JsonSerializer.Deserialize<WebhookModel>(publishJson);

	model.Dump();

	model = System.Text.Json.JsonSerializer.Deserialize<WebhookModel>(workflowJson);

	model.Dump();
}

// You can define other methods, fields, classes and namespaces here
string publishJson = "{\"data\":{\"items\":[{\"id\":\"46763b84-ac6d-4347-b18a-41f8ece0badd\",\"codename\":\"test_publish_published_webhook\",\"language\":\"default\",\"type\":\"publish_test\",\"collection\":\"default\"}],\"taxonomies\":[]},\"message\":{\"id\":\"ce7bd31a-411e-4a54-af1c-7fa46bb7c1f5\",\"project_id\":\"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\"type\":\"content_item_variant\",\"operation\":\"publish\",\"api_name\":\"delivery_production\",\"created_timestamp\":\"2022-04-12T16:02:27.0593617Z\",\"webhook_url\":\"https://routing.azurewebsites.net/api/KontentWebhook\"}}";
string workflowJson = "{\"data\":{\"items\":[{\"item\":{\"id\":\"66d00376-ee1d-4ed1-9a3c-a88110e65190\"},\"language\":{\"id\":\"00000000-0000-0000-0000-000000000000\"}}]},\"message\":{\"id\":\"a94ff0a8-39cb-4975-9b65-ba7ba7305693\",\"project_id\":\"aaaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa\",\"type\":\"content_item_variant\",\"operation\":\"change_workflow_step\",\"api_name\":\"content_management\",\"created_timestamp\":\"2022-04-12T13:39:34.4449999Z\",\"webhook_url\":\"https://45d3-84-67-20-182.ngrok.io/webhooks/webhooks\"}}";

Expected behavior

Model should be consistent and should deserialize correctly

Test environment

• .NET 6, macos and Windows (arm64)
• Kentico.Kontent.AspNetCore 0.12.0-beta3

Screenshots

Add links to screenshots, if possible.

Motivation

• Create a PoC of automatic building, testing, and deploying using GH Actions to verify the possibility of migrating from AppVeyor.

Acceptance Criteria

• The codebase is built and tested with every commit and PR (=> we know the status of the codebase)
• Failing tests will make the build fail and prevent any further steps (deployment)
• Artifacts are collected for every build Can be, it's easy but not necessary. We'll collect artifacts only for Releases.
• It's possible to create a "Release" from the master branch
  • The release will trigger a workflow that'll build the master branch and deploy the resulting NuGet package to NuGet.org
  • Symbol packages are also deployed (snupkg)
  • The NuGet package is correctly versioned (semver)
  • The version of the NuGet package can be defined as the tag version of the release
  • Allow pre-release suffixes
  • Upload artifacts to GH release, or this
  • Update release instructions in affected repos
  • Set status checks for protected branches
  • Exclude test projects from coverage

Optionally

• Define environments and require approval to proceed with deployment (when the build and tests pass ok) Gated builds work well.
• Try to replace Directory.Build.props with -p:NuspecProperties="Version=${{ steps.get_version.outputs.version-without-v }}
  • The combination of dotnet build -p:Version=1.2.3 and dotnet pack -p:PackageVersion=1.2.3 does the trick
• Try reporting without /p:CoverletOutputFormat=opencover doesn't work
• Deploy pre-releases to a different feed/unlisted? (eg. based on the event type prereleased) There is no switch in the NuGet CLI to publish a package as unlisted right now. It'd be an option to publish the package to MyGet for instance. Not going to explore this any further ATM.
• Add code coverage using coverlet collector + codecov + msdocs
• Create a reusable composite action Impossible due to actions/runner#646 (there is a workaround though)

Proposed solution

Versioning

• Employ Directory.build.props for defining the version or version patching (AssemblyInfo, *.csprojs)

Examples from AppVeyor:
<Project><PropertyGroup><Version>$($ENV:APPVEYOR_BUILD_VERSION)</Version></PropertyGroup></Project>" | out-file "Directory.build.props (before build)
And:

dotnet_csproj:
  patch: true
  file: '**\*.csproj'
  version: '{version}'
  version_prefix: '{version}'
  package_version: '{version}'
  assembly_version: '{version}'
  file_version: '{version}'
  informational_version: '{version}'

Coverage

$buildConfig = if ($ENV:CONFIGURATION -eq $null) { "Release" } else { $ENV:CONFIGURATION }

$buildFolder = if ($ENV:APPVEYOR_BUILD_FOLDER -eq $null) { $PSScriptRoot } else { $ENV:APPVEYOR_BUILD_FOLDER }

$openCover = 'C:\ProgramData\chocolatey\lib\opencover.portable\tools\OpenCover.Console.exe'

$target = '-target:C:\Program Files\dotnet\dotnet.exe'
$targetArgs = '-targetargs:"test -c:' + $buildConfig + ' --logger:trx;LogFileName=results.trx --filter FullyQualifiedName!~Benchmarks /p:DebugType=full"' 
$filter = '-filter:+[Kentico.Kontent.Delivery*]*-[*Tests]*-[*Benchmarks]*'
$output = '-output:' + $buildFolder + '\coverage.xml'
$register = if ($ENV:APPVEYOR -eq $true ) { '-register' } else { '-register:user' } # Magical parameter that breaks things

& $openCover $target $targetArgs $filter $register '-oldStyle' '-mergeoutput' $output

Remaining repos

• kontent-sample-app-net (special: packing x86+x64 website for further internal CI steps)
• kontent-generators-net (special: packing standalone apps for multiple platforms)

Outstanding tasks

• fix globally: warning NU5048: The 'PackageIconUrl'/'iconUrl' element is deprecated. Consider using the 'PackageIcon'/'icon' element instead. Learn more at https://aka.ms/deprecateIconUrl

Motivation

Webhooks in Kentico Kontent can only define one secret webhook key per URL. As such we have had to make multiple end point definitions in dev / test. In addition due to the issue of no distributed caching ability we have had to make multiple webhook endpoints to identify each node of a load balanced cluster.

This necessitates multiple webhook secrets to be defined in a configuration file.

Here is an example:

Proposed solution

We solved this by allowing multiple webhook secrets to be defined as follows:

       public async Task InvokeAsync(HttpContext httpContext, IOptions<ProjectOptionsBase> projectOptions)
        {
            var request = httpContext.Request;
            request.EnableBuffering();

            using var reader = new StreamReader(request.Body, Encoding.UTF8, true, 1024, true);
            var content = await reader.ReadToEndAsync();
            request.Body.Seek(0, SeekOrigin.Begin);

            // Iterates through all secrets to allow us to use multiple Kentico projects content.
            var generatedSignatures = new List<string>();
            foreach (var sig in projectOptions.Value.KenticoKontentWebhookSecrets)
                generatedSignatures.Add(GenerateHash(content, sig));

            var signature = request.Headers["X-KC-Signature"].FirstOrDefault();

            if (!generatedSignatures.Contains(signature))
            {
                httpContext.Response.StatusCode = 401;
                return;
            }

            await _next(httpContext);
        }

Easy fix would be to do the same thing, and make your WebhookOptions model be an array of strings so you could define them in a config file as follows:

  "KenticoKontentWebhookSecrets": [
    ".....", // Matt's ARRT.ORG Ngrok Dev Endpoint
    ".....", // Chris ARRT.ORG NGrok Dev Endpoint
    ".....", //cdevwww2hook.arrt.org
    "....." //tdevwww2hook.arrt.org
  ],

Motivation

Why is this feature required? What problems does it solve?
Until last week, we had only webhook, which now is legacy webhook. This webhook used the class DeliveryWebhookModel. We don't have a class for the new webhook which is using different naming for properties.

Proposed solution

An ideal solution for the above problems would be to create a class for the new webhook type so all the projects that use this webhook won't be required to create a new class in each project.