3dd492a77f
The data plane answers a broken inbound method with the generic "Script compilation failed for this method"; the Roslyn diagnostic reached only the central log, and the known-bad cache could not be observed or reset per method. - InboundScriptExecutor keeps the diagnostics with each known-bad record and exposes GetCompileState(name, currentScript): IsCompiled / IsKnownBad / LastCompileError, judged against the current script text (a record for older text is reported as not compiled yet). - Management: ValidateApiMethodCommand (compile the stored script, return ApiMethodCompileResult, register nothing, cache untouched) and RecompileApiMethodCommand (CompileAndRegister without re-sending the entity, drops the node's ApiMethodCache row, audited "Recompile"). Both Designer, like UpdateApiMethod; dispatched through the shared ApiMethodCompileOperations. GetApiMethod keeps the entity fields top-level and adds isCompiled, isKnownBad, lastCompileError and compileStateNode. Compile state is per central node and every result names the node. - CLI: api-method validate --id, api-method recompile --id. - Central UI: the API-method edit page shows the saved script's compile state and last error, with Validate and Recompile actions (same operations, same Designer gate, fresh DI scope). - RequiredRoleMatrixTests entries; ManagementSurfaceParityTests covers the new CLI leaves; ApiMethodCompileDiagnosticsTests + an executor CompileState test. - Docs: CLI README, Component-CLI/ManagementService/InboundAPI, components/*. Claude-Session: https://claude.ai/code/session_01GT67AEHd2Acv1YPwGfXEoV
176 lines
9.1 KiB
C#
176 lines
9.1 KiB
C#
using System.CommandLine;
|
|
using System.CommandLine.Parsing;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Messages.Management;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.CLI.Commands;
|
|
|
|
public static class ApiMethodCommands
|
|
{
|
|
/// <summary>
|
|
/// Builds the <c>api-method</c> CLI command group with subcommands for managing inbound API methods.
|
|
/// </summary>
|
|
/// <param name="urlOption">Global option for the management URL.</param>
|
|
/// <param name="formatOption">Global option for the output format.</param>
|
|
/// <param name="usernameOption">Global option for the authentication username.</param>
|
|
/// <param name="passwordOption">Global option for the authentication password.</param>
|
|
/// <returns>The configured <c>api-method</c> command with all subcommands registered.</returns>
|
|
public static Command Build(Option<string> urlOption, Option<string> formatOption, Option<string> usernameOption, Option<string> passwordOption)
|
|
{
|
|
var command = new Command("api-method") { Description = "Manage inbound API methods" };
|
|
|
|
command.Add(BuildList(urlOption, formatOption, usernameOption, passwordOption));
|
|
command.Add(BuildGet(urlOption, formatOption, usernameOption, passwordOption));
|
|
command.Add(BuildCreate(urlOption, formatOption, usernameOption, passwordOption));
|
|
command.Add(BuildUpdate(urlOption, formatOption, usernameOption, passwordOption));
|
|
command.Add(BuildDelete(urlOption, formatOption, usernameOption, passwordOption));
|
|
command.Add(BuildValidate(urlOption, formatOption, usernameOption, passwordOption));
|
|
command.Add(BuildRecompile(urlOption, formatOption, usernameOption, passwordOption));
|
|
|
|
return command;
|
|
}
|
|
|
|
private static Command BuildList(Option<string> urlOption, Option<string> formatOption, Option<string> usernameOption, Option<string> passwordOption)
|
|
{
|
|
var cmd = new Command("list") { Description = "List all API methods" };
|
|
cmd.SetAction(async (ParseResult result) =>
|
|
{
|
|
return await CommandHelpers.ExecuteCommandAsync(
|
|
result, urlOption, formatOption, usernameOption, passwordOption, new ListApiMethodsCommand());
|
|
});
|
|
return cmd;
|
|
}
|
|
|
|
private static Command BuildGet(Option<string> urlOption, Option<string> formatOption, Option<string> usernameOption, Option<string> passwordOption)
|
|
{
|
|
var idOption = new Option<int>("--id") { Description = "API method ID", Required = true };
|
|
var cmd = new Command("get") { Description = "Get an API method by ID" };
|
|
cmd.Add(idOption);
|
|
cmd.SetAction(async (ParseResult result) =>
|
|
{
|
|
var id = result.GetValue(idOption);
|
|
return await CommandHelpers.ExecuteCommandAsync(
|
|
result, urlOption, formatOption, usernameOption, passwordOption, new GetApiMethodCommand(id));
|
|
});
|
|
return cmd;
|
|
}
|
|
|
|
private static Command BuildValidate(Option<string> urlOption, Option<string> formatOption, Option<string> usernameOption, Option<string> passwordOption)
|
|
{
|
|
var idOption = new Option<int>("--id") { Description = "API method ID", Required = true };
|
|
var cmd = new Command("validate")
|
|
{
|
|
Description = "Compile an API method's stored script on the central node and show the compile errors (nothing is registered)"
|
|
};
|
|
cmd.Add(idOption);
|
|
cmd.SetAction(async (ParseResult result) =>
|
|
{
|
|
var id = result.GetValue(idOption);
|
|
return await CommandHelpers.ExecuteCommandAsync(
|
|
result, urlOption, formatOption, usernameOption, passwordOption, new ValidateApiMethodCommand(id));
|
|
});
|
|
return cmd;
|
|
}
|
|
|
|
private static Command BuildRecompile(Option<string> urlOption, Option<string> formatOption, Option<string> usernameOption, Option<string> passwordOption)
|
|
{
|
|
var idOption = new Option<int>("--id") { Description = "API method ID", Required = true };
|
|
var cmd = new Command("recompile")
|
|
{
|
|
Description = "Recompile and re-register an API method's stored script on the central node, clearing a stale compile failure"
|
|
};
|
|
cmd.Add(idOption);
|
|
cmd.SetAction(async (ParseResult result) =>
|
|
{
|
|
var id = result.GetValue(idOption);
|
|
return await CommandHelpers.ExecuteCommandAsync(
|
|
result, urlOption, formatOption, usernameOption, passwordOption, new RecompileApiMethodCommand(id));
|
|
});
|
|
return cmd;
|
|
}
|
|
|
|
private static Command BuildCreate(Option<string> urlOption, Option<string> formatOption, Option<string> usernameOption, Option<string> passwordOption)
|
|
{
|
|
var nameOption = new Option<string>("--name") { Description = "Method name", Required = true };
|
|
var scriptOption = new Option<string>("--script") { Description = "Script code", Required = true };
|
|
var timeoutOption = new Option<int>("--timeout") { Description = "Timeout in seconds" };
|
|
timeoutOption.DefaultValueFactory = _ => 30;
|
|
var parametersOption = new Option<string?>("--parameters") { Description = "Parameter definitions JSON" };
|
|
var returnDefOption = new Option<string?>("--return-def") { Description = "Return type definition" };
|
|
var traceAllCallsOption = new Option<bool>("--trace-all-calls")
|
|
{
|
|
Description = "Trace every production call to this method for the Flow Debugger (adds 7-10 audit rows per call; low-volume integration methods only)"
|
|
};
|
|
|
|
var cmd = new Command("create") { Description = "Create an API method" };
|
|
cmd.Add(nameOption);
|
|
cmd.Add(scriptOption);
|
|
cmd.Add(timeoutOption);
|
|
cmd.Add(parametersOption);
|
|
cmd.Add(returnDefOption);
|
|
cmd.Add(traceAllCallsOption);
|
|
cmd.SetAction(async (ParseResult result) =>
|
|
{
|
|
var name = result.GetValue(nameOption)!;
|
|
var script = result.GetValue(scriptOption)!;
|
|
var timeout = result.GetValue(timeoutOption);
|
|
var parameters = result.GetValue(parametersOption);
|
|
var returnDef = result.GetValue(returnDefOption);
|
|
var traceAllCalls = result.GetValue(traceAllCallsOption);
|
|
return await CommandHelpers.ExecuteCommandAsync(
|
|
result, urlOption, formatOption, usernameOption, passwordOption,
|
|
new CreateApiMethodCommand(name, script, timeout, parameters, returnDef, traceAllCalls));
|
|
});
|
|
return cmd;
|
|
}
|
|
|
|
private static Command BuildUpdate(Option<string> urlOption, Option<string> formatOption, Option<string> usernameOption, Option<string> passwordOption)
|
|
{
|
|
var idOption = new Option<int>("--id") { Description = "API method ID", Required = true };
|
|
var scriptOption = new Option<string>("--script") { Description = "Script code", Required = true };
|
|
var timeoutOption = new Option<int>("--timeout") { Description = "Timeout in seconds" };
|
|
timeoutOption.DefaultValueFactory = _ => 30;
|
|
var parametersOption = new Option<string?>("--parameters") { Description = "Parameter definitions JSON" };
|
|
var returnDefOption = new Option<string?>("--return-def") { Description = "Return type definition" };
|
|
// bool? so an update that omits the flag leaves the stored value unchanged.
|
|
var traceAllCallsOption = new Option<bool?>("--trace-all-calls")
|
|
{
|
|
Description = "Trace every production call to this method for the Flow Debugger (true/false; omitted = unchanged; adds 7-10 audit rows per call)"
|
|
};
|
|
|
|
var cmd = new Command("update") { Description = "Update an API method" };
|
|
cmd.Add(idOption);
|
|
cmd.Add(scriptOption);
|
|
cmd.Add(timeoutOption);
|
|
cmd.Add(parametersOption);
|
|
cmd.Add(returnDefOption);
|
|
cmd.Add(traceAllCallsOption);
|
|
cmd.SetAction(async (ParseResult result) =>
|
|
{
|
|
var id = result.GetValue(idOption);
|
|
var script = result.GetValue(scriptOption)!;
|
|
var timeout = result.GetValue(timeoutOption);
|
|
var parameters = result.GetValue(parametersOption);
|
|
var returnDef = result.GetValue(returnDefOption);
|
|
var traceAllCalls = result.GetValue(traceAllCallsOption);
|
|
return await CommandHelpers.ExecuteCommandAsync(
|
|
result, urlOption, formatOption, usernameOption, passwordOption,
|
|
new UpdateApiMethodCommand(id, script, timeout, parameters, returnDef, traceAllCalls));
|
|
});
|
|
return cmd;
|
|
}
|
|
|
|
private static Command BuildDelete(Option<string> urlOption, Option<string> formatOption, Option<string> usernameOption, Option<string> passwordOption)
|
|
{
|
|
var idOption = new Option<int>("--id") { Description = "API method ID", Required = true };
|
|
var cmd = new Command("delete") { Description = "Delete an API method" };
|
|
cmd.Add(idOption);
|
|
cmd.SetAction(async (ParseResult result) =>
|
|
{
|
|
var id = result.GetValue(idOption);
|
|
return await CommandHelpers.ExecuteCommandAsync(
|
|
result, urlOption, formatOption, usernameOption, passwordOption, new DeleteApiMethodCommand(id));
|
|
});
|
|
return cmd;
|
|
}
|
|
}
|