Joseph Doherty
eacdd2d453
Proto comments (comment-only, no wire change): - mxaccess_worker.proto GatewayHello.max_frame_bytes: every worker->gateway frame must serialize within the negotiated max; reply builders truncate (IPC-23). - mxaccess_gateway.proto DrainEventsReply: count-cap + byte-cap, drain-until-empty caller contract (IPC-23). - mxaccess_gateway.proto ReplayGap.oldest_available_sequence: empty-ring value is highest-observed+1, oldest-1 resume formula stays valid (GWC-25 deferred amendment). Regen wave: Contracts/Generated (C# XML doc), rust vendored protos (byte-copy), Go bindings (worker binding was genuinely stale - lacked MaxFrameBytes entirely), Python worker _pb2 (real descriptor delta), Java aggregates (javadoc, zero protobuf-version churn under the pinned toolchain), client descriptor set. IPC-24: pinned Java toolchain regenerates with no gencode-version churn, so the unconditional churn-revert step in ci.yml is a fossil - deleted it; git diff is now a true message-level drift gate for the single-file Java aggregates. IPC-25: pin protoc-gen-go v1.36.11 / protoc-gen-go-grpc 1.6.2 in the Go generate script (+ fix a latent pwsh-7 parse bug); add Check 4 to check-codegen.ps1 (regenerate Go+Python bindings, fail on diff, tool-missing fails not skips); add the pinned-generator installs to the portable CI job. IPC-32: relabel check-codegen banners 1/4..4/4 (folded into the Check 4 edit). Docs: ClientProtoGeneration.md, Contracts.md, GatewayTesting.md, build.gradle checkGeneratedClean caveat. Tracking: IPC-23/24/25/32 -> Done, GWC-25 proto note resolved, change-log 2026-08-07.
102 lines
4.9 KiB
PowerShell
102 lines
4.9 KiB
PowerShell
Set-StrictMode -Version Latest
|
|
$ErrorActionPreference = 'Stop'
|
|
|
|
# Pinned generator baseline. The committed Go bindings stamp these plugin versions in their
|
|
# headers (protoc-gen-go v1.36.11 / protoc-gen-go-grpc v1.6.2). Plugin-version drift rewrites
|
|
# those header stamps, so a regeneration on an off-pin machine would churn the tree and make
|
|
# check-codegen Check 4 false-fail (or mask real drift under churn). Assert the exact versions
|
|
# so a regen is deterministic. protoc itself is warn-only (source_code_info is normalized out of
|
|
# the committed bindings), matching publish-client-proto-inputs.ps1.
|
|
$PinnedProtocGenGoVersion = 'protoc-gen-go v1.36.11'
|
|
$PinnedProtocGenGoGrpcVersion = 'protoc-gen-go-grpc 1.6.2'
|
|
$PinnedProtocVersion = 'libprotoc 34.1'
|
|
|
|
$repoRoot = Resolve-Path (Join-Path $PSScriptRoot '..\..')
|
|
$protoRoot = Join-Path $repoRoot 'src\ZB.MOM.WW.MxGateway.Contracts\Protos'
|
|
$outputRoot = Join-Path $PSScriptRoot 'internal\generated'
|
|
$modulePath = 'gitea.dohertylan.com/dohertj2/mxaccessgw/clients/go/internal/generated'
|
|
|
|
function Resolve-Tool {
|
|
# Resolve a codegen tool from PATH first (portable), then the documented Windows fallbacks,
|
|
# instead of the previous hard-coded per-machine paths. See docs/ToolchainLinks.md.
|
|
param(
|
|
[string[]]$Names,
|
|
[string[]]$FallbackPaths
|
|
)
|
|
|
|
foreach ($name in $Names) {
|
|
$cmd = Get-Command $name -ErrorAction SilentlyContinue
|
|
if ($null -ne $cmd) {
|
|
return $cmd.Source
|
|
}
|
|
}
|
|
|
|
foreach ($fallback in $FallbackPaths) {
|
|
if ($fallback -and (Test-Path $fallback)) {
|
|
return $fallback
|
|
}
|
|
}
|
|
|
|
throw "Could not find $($Names -join '/') on PATH. See docs/ToolchainLinks.md."
|
|
}
|
|
|
|
$wingetProtoc = if ($env:LOCALAPPDATA) {
|
|
Join-Path $env:LOCALAPPDATA 'Microsoft\WinGet\Packages\Google.Protobuf_Microsoft.Winget.Source_8wekyb3d8bbwe\bin\protoc.exe'
|
|
} else { $null }
|
|
$goBin = if ($env:USERPROFILE) { Join-Path $env:USERPROFILE 'go\bin' } elseif ($env:HOME) { Join-Path $env:HOME 'go/bin' } else { $null }
|
|
|
|
$protoc = Resolve-Tool -Names @('protoc', 'protoc.exe') -FallbackPaths @($wingetProtoc)
|
|
$protocGenGo = Resolve-Tool -Names @('protoc-gen-go', 'protoc-gen-go.exe') -FallbackPaths @(($(if ($goBin) { Join-Path $goBin 'protoc-gen-go.exe' })), ($(if ($goBin) { Join-Path $goBin 'protoc-gen-go' })))
|
|
$protocGenGoGrpc = Resolve-Tool -Names @('protoc-gen-go-grpc', 'protoc-gen-go-grpc.exe') -FallbackPaths @(($(if ($goBin) { Join-Path $goBin 'protoc-gen-go-grpc.exe' })), ($(if ($goBin) { Join-Path $goBin 'protoc-gen-go-grpc' })))
|
|
|
|
# Assert the pinned plugin versions before generating so Check 4 cannot false-fail (or mask drift)
|
|
# on an off-pin machine. protoc is warn-only.
|
|
$protocGenGoVersion = (& $protocGenGo --version 2>&1 | Out-String).Trim()
|
|
if ($protocGenGoVersion -ne $PinnedProtocGenGoVersion) {
|
|
throw "protoc-gen-go reports '$protocGenGoVersion', but regeneration is pinned to '$PinnedProtocGenGoVersion'. " +
|
|
"Install the pin: go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.36.11"
|
|
}
|
|
$protocGenGoGrpcVersion = (& $protocGenGoGrpc --version 2>&1 | Out-String).Trim()
|
|
if ($protocGenGoGrpcVersion -ne $PinnedProtocGenGoGrpcVersion) {
|
|
throw "protoc-gen-go-grpc reports '$protocGenGoGrpcVersion', but regeneration is pinned to '$PinnedProtocGenGoGrpcVersion'. " +
|
|
"Install the pin: go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.6.2"
|
|
}
|
|
$protocVersion = (& $protoc --version 2>&1 | Out-String).Trim()
|
|
if ($protocVersion -ne $PinnedProtocVersion) {
|
|
Write-Warning "protoc reports '$protocVersion', pin is '$PinnedProtocVersion'. Descriptor comments are normalized out of the committed Go bindings, so patch drift is tolerated; keep CI on the pin."
|
|
}
|
|
|
|
# protoc discovers the plugins on PATH; prepend the directories the resolved plugins live in.
|
|
$env:Path = (Split-Path $protocGenGo -Parent) + [System.IO.Path]::PathSeparator + (Split-Path $protocGenGoGrpc -Parent) + [System.IO.Path]::PathSeparator + $env:Path
|
|
|
|
New-Item -ItemType Directory -Path $outputRoot -Force | Out-Null
|
|
Get-ChildItem -Path $outputRoot -Filter '*.pb.go' -File | Remove-Item
|
|
|
|
& $protoc `
|
|
--proto_path=$protoRoot `
|
|
--go_out=$outputRoot `
|
|
--go_opt=paths=source_relative `
|
|
"--go_opt=Mmxaccess_gateway.proto=$modulePath;generated" `
|
|
"--go_opt=Mmxaccess_worker.proto=$modulePath;generated" `
|
|
"--go_opt=Mgalaxy_repository.proto=$modulePath;generated" `
|
|
mxaccess_gateway.proto `
|
|
mxaccess_worker.proto `
|
|
galaxy_repository.proto
|
|
|
|
if ($LASTEXITCODE -ne 0) {
|
|
throw "protoc (go) failed with exit code $LASTEXITCODE."
|
|
}
|
|
|
|
& $protoc `
|
|
--proto_path=$protoRoot `
|
|
--go-grpc_out=$outputRoot `
|
|
--go-grpc_opt=paths=source_relative `
|
|
"--go-grpc_opt=Mmxaccess_gateway.proto=$modulePath;generated" `
|
|
"--go-grpc_opt=Mgalaxy_repository.proto=$modulePath;generated" `
|
|
mxaccess_gateway.proto `
|
|
galaxy_repository.proto
|
|
|
|
if ($LASTEXITCODE -ne 0) {
|
|
throw "protoc (go-grpc) failed with exit code $LASTEXITCODE."
|
|
}
|