Skip to content

Commit 30b2a07

Browse files
author
vp
committed
feat(pipeline): replace Constants with PipelineConstants for logging consistency
1 parent cebbf5e commit 30b2a07

4 files changed

Lines changed: 12 additions & 13 deletions

File tree

src/Common.Utilities/Pipeline/Behaviors/PipelineTimingBehavior.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public async ValueTask<Result> ExecuteAsync(
4141

4242
logger.LogDebug(
4343
"[{LogKey}] pipeline timing finished (pipeline={PipelineName}, executionId={ExecutionId}, success={Success}) -> took {DurationMs}ms",
44-
Constants.LogKey,
44+
PipelineConstants.LogKey,
4545
context.Pipeline.Name,
4646
context.Pipeline.ExecutionId,
4747
result.IsSuccess,
@@ -53,7 +53,7 @@ public async ValueTask<Result> ExecuteAsync(
5353
{
5454
logger.LogWarning(
5555
"[{LogKey}] pipeline timing failed (pipeline={PipelineName}, executionId={ExecutionId}) -> took {DurationMs}ms",
56-
Constants.LogKey,
56+
PipelineConstants.LogKey,
5757
context.Pipeline.Name,
5858
context.Pipeline.ExecutionId,
5959
stopwatch.Elapsed.TotalMilliseconds);

src/Common.Utilities/Pipeline/Execution/PipelineRuntime.cs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ private async Task<PipelineRunResult> ExecuteCoreAsync(
135135
context.Pipeline.TotalStepCount = definition.Steps.Count;
136136

137137
tracker.MarkRunning(executionId, context, state.Result);
138-
PipelineTypedLogger.LogPipelineStarted(this.logger, Constants.LogKey, definition.Name, executionId, correlationId);
138+
PipelineTypedLogger.LogPipelineStarted(this.logger, PipelineConstants.LogKey, definition.Name, executionId, correlationId);
139139

140140
var hooks = this.ResolveHooks(serviceProvider, definition);
141141
var behaviors = this.ResolveBehaviors(serviceProvider, definition);
@@ -166,7 +166,7 @@ private async Task<PipelineRunResult> ExecuteCoreAsync(
166166
}
167167
catch (Exception ex)
168168
{
169-
PipelineTypedLogger.LogPipelineException(this.logger, Constants.LogKey, definition.Name, executionId, ex);
169+
PipelineTypedLogger.LogPipelineException(this.logger, PipelineConstants.LogKey, definition.Name, executionId, ex);
170170
state.Result = this.AppendException(state.Result, ex);
171171
state.Status = PipelineExecutionStatus.Failed;
172172
}
@@ -185,7 +185,7 @@ private async Task<PipelineRunResult> ExecuteCoreAsync(
185185
}
186186

187187
tracker.MarkFinished(executionId, context, state.Status, state.Result);
188-
PipelineTypedLogger.LogPipelineFinished(this.logger, Constants.LogKey, definition.Name, executionId, state.Status, context.Pipeline.Duration?.TotalMilliseconds ?? 0);
188+
PipelineTypedLogger.LogPipelineFinished(this.logger, PipelineConstants.LogKey, definition.Name, executionId, state.Status, context.Pipeline.Duration?.TotalMilliseconds ?? 0);
189189
}
190190

191191
return new PipelineRunResult(state.Result, state.Status);
@@ -214,7 +214,7 @@ private async ValueTask<Result> ExecuteStepsCoreAsync(
214214

215215
// The engine owns the canonical current-step tracking and step-level logging.
216216
context.Pipeline.CurrentStepName = stepDefinition.Name;
217-
PipelineTypedLogger.LogStepStarted(this.logger, Constants.LogKey, definition.Name, stepDefinition.Name, context.Pipeline.ExecutionId);
217+
PipelineTypedLogger.LogStepStarted(this.logger, PipelineConstants.LogKey, definition.Name, stepDefinition.Name, context.Pipeline.ExecutionId);
218218
await this.InvokeHooksAsync(hooks, context, (hook, ctx, ct) => hook.OnStepStartingAsync(ctx, stepDefinition, ct), cancellationToken);
219219

220220
var stopwatch = Stopwatch.StartNew();
@@ -225,7 +225,7 @@ private async ValueTask<Result> ExecuteStepsCoreAsync(
225225
carriedResult = control.Result;
226226
state.Result = carriedResult;
227227

228-
PipelineTypedLogger.LogStepFinished(this.logger, Constants.LogKey, definition.Name, stepDefinition.Name, context.Pipeline.ExecutionId, control.Outcome, stopwatch.Elapsed.TotalMilliseconds);
228+
PipelineTypedLogger.LogStepFinished(this.logger, PipelineConstants.LogKey, definition.Name, stepDefinition.Name, context.Pipeline.ExecutionId, control.Outcome, stopwatch.Elapsed.TotalMilliseconds);
229229
tracker.MarkRunning(context.Pipeline.ExecutionId, context, carriedResult);
230230
await this.InvokeHooksAsync(hooks, context, (hook, ctx, ct) => hook.OnStepCompletedAsync(ctx, stepDefinition, control, ct), cancellationToken);
231231

@@ -235,7 +235,7 @@ private async ValueTask<Result> ExecuteStepsCoreAsync(
235235
// Retry stays on the same step and reuses the returned result/context state.
236236
if (attempts <= options.MaxRetryAttemptsPerStep)
237237
{
238-
PipelineTypedLogger.LogStepRetrying(this.logger, Constants.LogKey, definition.Name, stepDefinition.Name, context.Pipeline.ExecutionId, attempts, options.MaxRetryAttemptsPerStep, control.Message);
238+
PipelineTypedLogger.LogStepRetrying(this.logger, PipelineConstants.LogKey, definition.Name, stepDefinition.Name, context.Pipeline.ExecutionId, attempts, options.MaxRetryAttemptsPerStep, control.Message);
239239
continue;
240240
}
241241

@@ -299,7 +299,7 @@ private async ValueTask<PipelineControl> ExecuteStepAsync(
299299
}
300300
catch (Exception ex)
301301
{
302-
PipelineTypedLogger.LogStepException(this.logger, Constants.LogKey, context.Pipeline.Name, stepDefinition.Name, context.Pipeline.ExecutionId, ex);
302+
PipelineTypedLogger.LogStepException(this.logger, PipelineConstants.LogKey, context.Pipeline.Name, stepDefinition.Name, context.Pipeline.ExecutionId, ex);
303303
return PipelineControl.Continue(this.AppendException(result, ex));
304304
}
305305
}
@@ -352,7 +352,7 @@ private async ValueTask InvokeHooksAsync(
352352
}
353353
catch (Exception ex)
354354
{
355-
PipelineTypedLogger.LogHookFailure(this.logger, Constants.LogKey, context.Pipeline.Name, context.Pipeline.ExecutionId, ex);
355+
PipelineTypedLogger.LogHookFailure(this.logger, PipelineConstants.LogKey, context.Pipeline.Name, context.Pipeline.ExecutionId, ex);
356356
}
357357
}
358358
}
@@ -368,7 +368,7 @@ private async Task InvokeCompletionCallbackAsync(
368368
}
369369
catch (Exception ex)
370370
{
371-
PipelineTypedLogger.LogCompletionCallbackFailed(this.logger, Constants.LogKey, pipelineName, completion.ExecutionId, ex);
371+
PipelineTypedLogger.LogCompletionCallbackFailed(this.logger, PipelineConstants.LogKey, pipelineName, completion.ExecutionId, ex);
372372
}
373373
}
374374

src/Common.Utilities/Pipeline/Constants.cs renamed to src/Common.Utilities/Pipeline/PipelineConstants.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ namespace BridgingIT.DevKit.Common;
88
/// <summary>
99
/// Provides constants used by the pipeline feature.
1010
/// </summary>
11-
public static class Constants
11+
public static class PipelineConstants
1212
{
1313
/// <summary>
1414
/// Gets the structured log key used by internal pipeline logging.

tests/Common.UnitTests/Utilities/Pipeline/PipelineRegistrationTests.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,5 +116,4 @@ protected override void Configure(IPipelineDefinitionBuilder builder)
116116
builder.AddStep(() => { });
117117
}
118118
}
119-
120119
}

0 commit comments

Comments
 (0)