histsdk/scripts/Capture-TagExtendedProperties.ps1

<#
.SYNOPSIS
    Captures the native AVEVA client's GetTagExtendedPropertiesFromName (GetTepByNm) wire traffic
    (HCAL roadmap R1.5) so the WCF op name, the string-handle format, the tagNames request buffer,
    and the extended-property response buffer can be decoded instead of guessed.

.DESCRIPTION
    Drives the .NET-Framework NativeTraceHarness's tag scenario with --retrieve-extended-properties,
    which flips TagQueryArgs.RetrieveTagExtendedPropertyInfo and then calls
    TagQuery.GetTagExtendedPropertyInfo(start, count, out TagExtendedPropertyGroupList, out err) —
    the managed method that issues the GetTepByNm op. An IL-rewritten copy of aahClientManaged.dll
    logs every MDAS body (ClientMessageEncoder.WriteMessage + ReadMessage), the same pipeline that
    produced every other proven request/response shape.

    Decode with scripts/decode-tag-properties-capture.py: locate the WCF.WriteMessage.Body whose op
    is aa/Retr/GetTepByNm -> that is the request (string handle + tagNames buffer + sequence). The
    paired WCF.ReadMessage.Body is the extended-property response buffer.

.NOTES
    Read-only metadata call; no data is written. Artifacts are diagnostic and gitignored.
    Sanitize before copying anything into docs/ -- never commit raw capture NDJSON, credentials,
    hostnames, or customer tag names. SysTimeSec is a built-in system tag (safe to name).
#>
[CmdletBinding()]
param(
    [string]$ServerName = "localhost",
    [int]$TcpPort = 32568,
    # A tag (or wildcard) to query extended properties for. SysTimeSec is a built-in system tag
    # present on every Historian; override with a real tag that carries extended properties for a
    # richer response decode.
    [string]$Tag = "SysTimeSec",
    [string]$Configuration = "Debug"
)

$ErrorActionPreference = "Stop"
$repoRoot = Split-Path -Parent $PSScriptRoot
Set-Location $repoRoot

$reProj      = Join-Path $repoRoot "tools\AVEVA.Historian.ReverseEngineering\AVEVA.Historian.ReverseEngineering.csproj"
$harnessProj = Join-Path $repoRoot "tools\AVEVA.Historian.NativeTraceHarness\AVEVA.Historian.NativeTraceHarness.csproj"
$instrProj   = Join-Path $repoRoot "tools\AVEVA.Historian.ReverseInstrumentation\AVEVA.Historian.ReverseInstrumentation.csproj"

$captureDir  = Join-Path $repoRoot "artifacts\reverse-engineering\instrumented-wcf-tag-extended-properties"
$currentCopy = Join-Path $captureDir "current-copy"
$instrDll    = Join-Path $captureDir "aahClientManaged.dll"
$capturePath = Join-Path $captureDir "tag-extended-properties-capture-latest.ndjson"

Write-Host "== Building tooling ($Configuration) ==" -ForegroundColor Cyan
dotnet build $reProj      -c $Configuration --nologo -v q | Out-Null
dotnet build $instrProj   -c $Configuration --nologo -v q | Out-Null
dotnet build $harnessProj -c $Configuration --nologo -v q | Out-Null

$instrSourceDll = Get-ChildItem -Recurse (Join-Path $repoRoot "tools\AVEVA.Historian.ReverseInstrumentation\bin\$Configuration") `
    -Filter "AVEVA.Historian.ReverseInstrumentation.dll" | Select-Object -First 1 -ExpandProperty FullName
if (-not $instrSourceDll) { throw "ReverseInstrumentation.dll not found under bin\$Configuration." }

Write-Host "== Instrumenting WriteMessage + ReadMessage ==" -ForegroundColor Cyan
New-Item -ItemType Directory -Force -Path $captureDir | Out-Null
# Chain via a distinct intermediate file (reading+writing the same path drops the second hook on
# the mixed-mode native image). Final dll carries both hooks: WCF.WriteMessage.Body + WCF.ReadMessage.Body.
$writeOnly = Join-Path $captureDir "aahClientManaged.write.dll"
dotnet run --no-build -c $Configuration --project $reProj -- `
    instrument-wcf-writemessage (Join-Path $repoRoot "current\aahClientManaged.dll") $writeOnly | Out-Null
dotnet run --no-build -c $Configuration --project $reProj -- `
    instrument-wcf-readmessage $writeOnly $instrDll | Out-Null

Write-Host "== Staging current-copy ==" -ForegroundColor Cyan
robocopy (Join-Path $repoRoot "current") $currentCopy /MIR /NJH /NJS /NDL /NP /NC /NS | Out-Null
Copy-Item -Force $instrDll (Join-Path $currentCopy "aahClientManaged.dll")
Copy-Item -Force $instrSourceDll (Join-Path $currentCopy "AVEVA.Historian.ReverseInstrumentation.dll")

$harnessDll = Join-Path $currentCopy "aahClientManaged.dll"
if (Test-Path $capturePath) { Remove-Item -Force $capturePath }
$env:AVEVA_HISTORIAN_RE_CAPTURE = $capturePath

Write-Host "== Capturing tag-extended-properties ==" -ForegroundColor Green
$harnessArgs = @(
    "--scenario", "tag-extended-properties",
    "--server-name", $ServerName,
    "--tcp-port", "$TcpPort",
    "--tag", $Tag,
    "--current-dir", $currentCopy,
    "--managed-dll-path", $harnessDll
)

$harnessJson = $null
try {
    $prevEap = $ErrorActionPreference
    $ErrorActionPreference = "Continue"
    $harnessJson = & dotnet run --no-build -c $Configuration --project $harnessProj -- @harnessArgs 2>&1
} catch {
    Write-Host "   (tag-extended-properties raised: $($_.Exception.Message))" -ForegroundColor Yellow
} finally {
    $ErrorActionPreference = $prevEap
}

Remove-Item Env:\AVEVA_HISTORIAN_RE_CAPTURE -ErrorAction SilentlyContinue

$recCount = if (Test-Path $capturePath) { (Get-Content $capturePath | Where-Object { $_.Trim() }).Count } else { 0 }
Write-Host "`n== Capture summary ==" -ForegroundColor Cyan
Write-Host "   -> $recCount records -> $capturePath"
Write-Host "Harness output (TagExtendedProperties Success / Groups):" -ForegroundColor Cyan
$harnessJson | Select-Object -Last 24
Write-Host "`nDecode with: python scripts\decode-tag-properties-capture.py" -ForegroundColor Cyan