@distrohelena/canton-typescript-sdk 0.1.28 → 0.1.30

package/dist/cjs/debugger/replay/ledger-replay-session-loader.js

@@ -0,0 +1,569 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LedgerReplaySessionLoader = void 0;
+const replay_phase_js_1 = require("../session/replay-phase.js");
+const replay_scope_js_1 = require("../session/replay-scope.js");
+const replay_source_location_js_1 = require("../session/replay-source-location.js");
+const replay_session_metadata_js_1 = require("../session/replay-session-metadata.js");
+const replay_stack_frame_js_1 = require("../session/replay-stack-frame.js");
+const replay_state_delta_js_1 = require("../session/replay-state-delta.js");
+const replay_step_js_1 = require("../session/replay-step.js");
+const replay_value_preview_js_1 = require("../session/replay-value-preview.js");
+const source_mapping_precision_js_1 = require("../source/source-mapping-precision.js");
+const replay_ledger_value_normalizer_js_1 = require("./replay-ledger-value-normalizer.js");
+class LedgerReplaySessionLoader {
+    dependencies;
+    constructor(dependencies) {
+        this.dependencies = dependencies;
+    }
+    async loadOrThrowAsync(request) {
+        const snapshot = await this.dependencies.updateLoader.loadOrThrowAsync(request.offset);
+        const environment = await this.dependencies.environmentBuilder.buildOrThrowAsync(snapshot);
+        const definition = this.dependencies.definitionResolver.resolveEntrypointDefinitionOrThrow(snapshot.entrypoint);
+        const traceSteps = [];
+        const evaluation = this.dependencies.evaluator.evaluateReplayEntrypointOrThrow(definition.definition, {
+            ...environment,
+            observedCreateContractIds: snapshot.events.flatMap((event) => event.event?.oneofKind === "created"
+                && event.event.created?.contractId !== undefined
+                ? [event.event.created.contractId]
+                : []),
+            entrypoint: {
+                ...environment.entrypoint,
+                argument: definition.entrypointArgumentRecordId === undefined
+                    ? environment.entrypoint.argument
+                    : (0, replay_ledger_value_normalizer_js_1.attachReplayRecordId)(environment.entrypoint.argument, definition.entrypointArgumentRecordId),
+            },
+            definitionResolver: this.dependencies.definitionResolver,
+            entrypointExpression: definition.replayExpression,
+            entrypointBindingMode: definition.replayBindingMode,
+        }, {
+            onStep: (step) => {
+                traceSteps.push(step);
+            },
+        });
+        this.dependencies.determinismValidator.validateOrThrow(snapshot, evaluation.effects);
+        const sessionId = this.dependencies.sessionIdFactory?.() ?? crypto.randomUUID();
+        const projectedSteps = this.projectReplaySteps(traceSteps, environment);
+        const steps = projectedSteps.map((item) => item.step);
+        return {
+            sessionId,
+            metadata: new replay_session_metadata_js_1.ReplaySessionMetadata({
+                sessionId,
+                offset: snapshot.offset,
+                stepCount: steps.length,
+            }),
+            steps,
+            scopesByStep: projectedSteps.map((item) => item.scopes),
+            currentStepIndex: 0,
+        };
+    }
+    projectReplaySteps(traceSteps, environment) {
+        const rawSteps = this.projectRawReplaySteps(traceSteps, environment);
+        if (this.dependencies.sourceMapper === undefined) {
+            return rawSteps;
+        }
+        return this.projectNavigableReplaySteps(rawSteps);
+    }
+    projectRawReplaySteps(traceSteps, environment) {
+        const activeFrames = [];
+        const frameScopes = new Map();
+        const frameExpressionDepth = new Map();
+        const frameCallDepth = new Map();
+        const contractTypeById = this.createContractTypeIndex(environment.contracts);
+        let eventOrdinal = 0;
+        return traceSteps.map((traceStep, stepIndex) => {
+            this.rememberFrameScope(frameScopes, traceStep, contractTypeById);
+            this.prepareStackForStep(traceStep, activeFrames, frameExpressionDepth, frameCallDepth);
+            const stackFrames = activeFrames.map((frame) => new replay_stack_frame_js_1.ReplayStackFrame({
+                frameId: frame.frameId,
+                name: frame.name,
+            }));
+            const scopes = stackFrames.map((frame) => this.cloneScope(frameScopes.get(frame.frameId ?? "") ?? new replay_scope_js_1.ReplayScope({
+                frameId: frame.frameId,
+                name: frame.name,
+                variables: [],
+            })));
+            const currentScope = scopes.find((scope) => scope.frameId === traceStep.frame.frameId);
+            const projectedStep = new replay_step_js_1.ReplayStep({
+                stepId: `step-${stepIndex}`,
+                stepIndex,
+                phase: this.toReplayPhase(traceStep),
+                stackFrames,
+                scopes,
+                locals: currentScope?.variables ?? [],
+                arguments: traceStep.stateEffect?.argument === undefined
+                    ? []
+                    : [traceStep.stateEffect.argument],
+                valuePreview: this.createValuePreview(traceStep),
+                stateDelta: traceStep.stateEffect === undefined
+                    ? undefined
+                    : this.createStateDelta(traceStep.stateEffect, eventOrdinal),
+                sourceLocation: this.createSourceLocation(traceStep),
+            });
+            if (traceStep.stateEffect !== undefined) {
+                this.rememberStateEffectContractType(traceStep.stateEffect, contractTypeById);
+                eventOrdinal += 1;
+            }
+            this.finalizeStackForStep(traceStep, activeFrames, frameExpressionDepth, frameCallDepth);
+            return {
+                step: projectedStep,
+                scopes,
+                traceStep,
+            };
+        });
+    }
+    projectNavigableReplaySteps(rawSteps) {
+        const navigableSteps = [];
+        let previousVisibleExpressionKey;
+        for (const rawStep of rawSteps) {
+            const { step, traceStep } = rawStep;
+            if (step.phase === replay_phase_js_1.ReplayPhase.stateEffect) {
+                previousVisibleExpressionKey = undefined;
+                navigableSteps.push(rawStep);
+                continue;
+            }
+            if (step.sourceLocation?.precision
+                !== source_mapping_precision_js_1.SourceMappingPrecision.exact) {
+                continue;
+            }
+            if (step.phase === replay_phase_js_1.ReplayPhase.call
+                || step.phase === replay_phase_js_1.ReplayPhase.return) {
+                if (!this.shouldRetainDefinitionTransition(step, traceStep)) {
+                    continue;
+                }
+                previousVisibleExpressionKey = undefined;
+                navigableSteps.push(rawStep);
+                continue;
+            }
+            if (traceStep.kind !== "enterExpression"
+                && traceStep.kind !== "exitExpression") {
+                continue;
+            }
+            const previousStep = navigableSteps.at(-1)?.step;
+            if (!this.shouldRetainExpressionStep(step, traceStep, previousStep)) {
+                continue;
+            }
+            const visibleExpressionKey = this.createVisibleExpressionKey(step);
+            if (visibleExpressionKey === previousVisibleExpressionKey) {
+                continue;
+            }
+            previousVisibleExpressionKey = visibleExpressionKey;
+            navigableSteps.push(rawStep);
+        }
+        return navigableSteps.map((item, stepIndex) => ({
+            ...item,
+            step: new replay_step_js_1.ReplayStep({
+                stepId: item.step.stepId,
+                stepIndex,
+                phase: item.step.phase,
+                stackFrames: item.step.stackFrames,
+                scopes: item.step.scopes,
+                locals: item.step.locals,
+                arguments: item.step.arguments,
+                sourceLocation: item.step.sourceLocation,
+                valuePreview: item.step.valuePreview,
+                stateDelta: item.step.stateDelta,
+            }),
+        }));
+    }
+    createSourceLocationKey(source) {
+        return [
+            source.path,
+            source.startLine,
+            source.startColumn,
+            source.endLine,
+            source.endColumn,
+        ].join(":");
+    }
+    createVisibleExpressionKey(step) {
+        const source = step.sourceLocation;
+        return [
+            source === undefined
+                ? "no-source"
+                : [
+                    source.path,
+                    source.startLine,
+                    source.endLine,
+                ].join(":"),
+            step.stackFrames.map((frame) => frame.frameId ?? frame.name ?? "?").join(">"),
+            JSON.stringify(step.locals),
+        ].join("|");
+    }
+    shouldRetainDefinitionTransition(step, traceStep) {
+        return this.isMeaningfulDefinitionExpression(traceStep.frame.definition.expression)
+            || this.hasVisibleLocalsChange(undefined, step);
+    }
+    shouldRetainExpressionStep(step, traceStep, previousStep) {
+        if (this.hasVisibleLocalsChange(previousStep, step)) {
+            return true;
+        }
+        return this.isMeaningfulDebuggerExpression(traceStep.expression);
+    }
+    hasVisibleLocalsChange(previousStep, currentStep) {
+        return JSON.stringify(previousStep?.locals ?? [])
+            !== JSON.stringify(currentStep.locals);
+    }
+    isMeaningfulDebuggerExpression(expression) {
+        if (expression.application !== undefined
+            || expression.letExpression !== undefined
+            || expression.caseExpression !== undefined
+            || expression.updateExpression !== undefined
+            || expression.lambda !== undefined) {
+            return true;
+        }
+        if (expression.valueReference !== undefined
+            && this.dependencies.sourceMapper !== undefined) {
+            try {
+                const referencedDefinition = this.dependencies.sourceMapper.getValueDefinitionOrThrow(expression.valueReference.packageId, expression.valueReference.moduleName, expression.valueReference.definitionName);
+                return this.isMeaningfulDefinitionExpression(referencedDefinition.expression);
+            }
+            catch {
+                return false;
+            }
+        }
+        return false;
+    }
+    isMeaningfulDefinitionExpression(expression) {
+        return (expression.application !== undefined
+            || expression.letExpression !== undefined
+            || expression.caseExpression !== undefined
+            || expression.updateExpression !== undefined
+            || expression.lambda !== undefined);
+    }
+    toReplayPhase(traceStep) {
+        switch (traceStep.kind) {
+            case "stateEffect":
+                return replay_phase_js_1.ReplayPhase.stateEffect;
+            case "call":
+                return replay_phase_js_1.ReplayPhase.call;
+            case "return":
+                return replay_phase_js_1.ReplayPhase.return;
+            case "enterExpression":
+                return replay_phase_js_1.ReplayPhase.enterExpression;
+            case "exitExpression":
+                return replay_phase_js_1.ReplayPhase.exitExpression;
+            default:
+                return replay_phase_js_1.ReplayPhase.enterExpression;
+        }
+    }
+    createValuePreview(traceStep) {
+        if (traceStep.stateEffect !== undefined) {
+            const display = traceStep.stateEffect.contractId
+                ?? traceStep.stateEffect.choice
+                ?? traceStep.stateEffect.kind;
+            return new replay_value_preview_js_1.ReplayValuePreview({
+                kind: traceStep.stateEffect.kind,
+                display,
+            });
+        }
+        if (traceStep.value === undefined) {
+            return undefined;
+        }
+        return new replay_value_preview_js_1.ReplayValuePreview({
+            kind: traceStep.value.kind,
+            display: this.stringifyRuntimeValue(traceStep.value),
+        });
+    }
+    createStateDelta(effect, eventOrdinal) {
+        const common = {
+            kind: effect.kind,
+            eventOrdinal,
+            comparisonKey: `event-${eventOrdinal}`,
+        };
+        switch (effect.kind) {
+            case "create":
+                return new replay_state_delta_js_1.ReplayStateDelta({
+                    ...common,
+                    createdContractId: effect.contractId,
+                    templateId: effect.templateId,
+                    payload: effect.payload,
+                });
+            case "exercise":
+                return new replay_state_delta_js_1.ReplayStateDelta({
+                    ...common,
+                    targetContractId: effect.contractId,
+                    templateId: effect.templateId,
+                    choice: effect.choice,
+                    choiceArgument: effect.argument,
+                    payload: effect.payload,
+                });
+            case "archive":
+                return new replay_state_delta_js_1.ReplayStateDelta({
+                    ...common,
+                    targetContractId: effect.contractId,
+                    templateId: effect.templateId,
+                });
+            default:
+                return new replay_state_delta_js_1.ReplayStateDelta(common);
+        }
+    }
+    stringifyRuntimeValue(value) {
+        if ("value" in value && typeof value.value === "string") {
+            return value.value.length > 0 ? value.value : "\"\"";
+        }
+        if ("value" in value) {
+            try {
+                const serialized = JSON.stringify(value.value);
+                if (typeof serialized === "string" && serialized.length > 0) {
+                    return serialized;
+                }
+            }
+            catch {
+                // Fall through to a lossy scalar representation when preview
+                // values are not JSON-serializable.
+            }
+            if (value.value === undefined) {
+                return "undefined";
+            }
+            if (value.value === null) {
+                return "null";
+            }
+            return String(value.value);
+        }
+        return typeof value.kind === "string" ? value.kind : "value";
+    }
+    rememberFrameScope(frameScopes, traceStep, contractTypeById) {
+        const frameName = this.resolveFrameName(traceStep);
+        frameScopes.set(traceStep.frame.frameId, new replay_scope_js_1.ReplayScope({
+            frameId: traceStep.frame.frameId,
+            name: frameName,
+            variables: traceStep.locals.map((local) => ({
+                name: local.name,
+                kind: local.value.kind,
+                value: this.stringifyRuntimeValue(local.value),
+                contractType: this.resolveRuntimeValueContractType(local.value, contractTypeById),
+            })),
+        }));
+    }
+    createContractTypeIndex(contracts) {
+        const index = new Map();
+        for (const [contractId, contract] of contracts.entries()) {
+            const contractType = this.formatTemplateType(contract.templateId);
+            if (contractType !== undefined) {
+                index.set(contractId, contractType);
+            }
+        }
+        return index;
+    }
+    rememberStateEffectContractType(effect, contractTypeById) {
+        if (effect.kind !== "create" || effect.contractId === undefined) {
+            return;
+        }
+        const contractType = this.formatTemplateType(effect.templateId);
+        if (contractType !== undefined) {
+            contractTypeById.set(effect.contractId, contractType);
+        }
+    }
+    resolveRuntimeValueContractType(value, contractTypeById) {
+        if (value.kind === "contractId"
+            && "value" in value
+            && typeof value.value === "string") {
+            return contractTypeById.get(value.value);
+        }
+        if (value.kind === "contractId[]"
+            && "value" in value
+            && Array.isArray(value.value)) {
+            for (const contractId of value.value) {
+                if (typeof contractId !== "string") {
+                    continue;
+                }
+                const contractType = contractTypeById.get(contractId);
+                if (contractType !== undefined) {
+                    return contractType;
+                }
+            }
+        }
+        return undefined;
+    }
+    formatTemplateType(templateId) {
+        if (templateId?.moduleName !== undefined
+            && templateId.entityName !== undefined) {
+            return `${templateId.moduleName}:${templateId.entityName}`;
+        }
+        return templateId?.entityName;
+    }
+    prepareStackForStep(traceStep, activeFrames, frameExpressionDepth, frameCallDepth) {
+        const frame = new replay_stack_frame_js_1.ReplayStackFrame({
+            frameId: traceStep.frame.frameId,
+            name: this.resolveFrameName(traceStep),
+        });
+        if (traceStep.kind === "call") {
+            this.pushFrameIfMissing(activeFrames, frame);
+            frameCallDepth.set(traceStep.frame.frameId, (frameCallDepth.get(traceStep.frame.frameId) ?? 0) + 1);
+            return;
+        }
+        this.pushFrameIfMissing(activeFrames, frame);
+        if (traceStep.kind === "enterExpression") {
+            frameExpressionDepth.set(traceStep.frame.frameId, (frameExpressionDepth.get(traceStep.frame.frameId) ?? 0) + 1);
+        }
+    }
+    finalizeStackForStep(traceStep, activeFrames, frameExpressionDepth, frameCallDepth) {
+        if (traceStep.kind === "exitExpression") {
+            const nextDepth = (frameExpressionDepth.get(traceStep.frame.frameId) ?? 1) - 1;
+            if (nextDepth <= 0) {
+                frameExpressionDepth.delete(traceStep.frame.frameId);
+                if ((frameCallDepth.get(traceStep.frame.frameId) ?? 0) === 0) {
+                    this.popFrameIfTop(activeFrames, traceStep.frame.frameId);
+                }
+            }
+            else {
+                frameExpressionDepth.set(traceStep.frame.frameId, nextDepth);
+            }
+            return;
+        }
+        if (traceStep.kind === "return") {
+            const nextCallDepth = (frameCallDepth.get(traceStep.frame.frameId) ?? 1) - 1;
+            if (nextCallDepth <= 0) {
+                frameCallDepth.delete(traceStep.frame.frameId);
+            }
+            else {
+                frameCallDepth.set(traceStep.frame.frameId, nextCallDepth);
+            }
+            this.popFrameIfTop(activeFrames, traceStep.frame.frameId);
+        }
+    }
+    pushFrameIfMissing(activeFrames, frame) {
+        const activeIndex = activeFrames.findIndex((candidate) => candidate.frameId === frame.frameId);
+        if (activeIndex >= 0) {
+            activeFrames.splice(activeIndex + 1);
+            return;
+        }
+        activeFrames.push(frame);
+    }
+    popFrameIfTop(activeFrames, frameId) {
+        if (activeFrames.at(-1)?.frameId === frameId) {
+            activeFrames.pop();
+        }
+    }
+    cloneScope(scope) {
+        return new replay_scope_js_1.ReplayScope({
+            frameId: scope.frameId,
+            name: scope.name,
+            variables: [...scope.variables],
+        });
+    }
+    resolveFrameName(traceStep) {
+        const definitionName = traceStep.frame.definition.name;
+        const generatedHelper = this.isGeneratedHelperDefinitionName(definitionName);
+        if (this.dependencies.sourceMapper === undefined) {
+            return generatedHelper
+                ? this.formatGeneratedHelperLabel(definitionName)
+                : definitionName;
+        }
+        try {
+            const source = this.dependencies.sourceMapper.getDefinitionSourceOrThrow(traceStep.frame.packageId, traceStep.frame.moduleName, definitionName);
+            const label = this.formatExecutableFrameLabel(source);
+            if (label !== undefined) {
+                return generatedHelper
+                    ? this.formatGeneratedHelperLabel(label)
+                    : label;
+            }
+        }
+        catch {
+            // Fall through to source-span and effect-based resolution when the
+            // current frame definition has no executable metadata of its own.
+        }
+        const sourceLocation = this.createSourceLocation(traceStep);
+        if (sourceLocation?.path !== undefined
+            && sourceLocation.startLine !== undefined
+            && sourceLocation.startColumn !== undefined) {
+            const enclosingSource = this.dependencies.sourceMapper.findExecutableSourceAt(sourceLocation.path, sourceLocation.startLine, sourceLocation.startColumn);
+            const label = enclosingSource === undefined
+                ? undefined
+                : this.formatExecutableFrameLabel(enclosingSource);
+            if (label !== undefined) {
+                return generatedHelper
+                    ? this.formatGeneratedHelperLabel(label)
+                    : label;
+            }
+        }
+        const effectLabel = this.formatReplayEffectFrameLabel(traceStep.stateEffect);
+        if (effectLabel !== undefined) {
+            return generatedHelper
+                ? this.formatGeneratedHelperLabel(effectLabel)
+                : effectLabel;
+        }
+        return generatedHelper
+            ? this.formatGeneratedHelperLabel(definitionName)
+            : definitionName;
+    }
+    isGeneratedHelperDefinitionName(definitionName) {
+        return /^\$+/.test(definitionName);
+    }
+    formatGeneratedHelperLabel(context) {
+        return `generated helper from ${context}`;
+    }
+    formatExecutableFrameLabel(source) {
+        if (source.entrypointKind === "exercise"
+            && source.templateName !== undefined
+            && source.choiceName !== undefined) {
+            return `${source.templateName}.${source.choiceName}`;
+        }
+        if (source.entrypointKind === "create"
+            && source.templateName !== undefined) {
+            return `${source.templateName}.create`;
+        }
+        return undefined;
+    }
+    formatReplayEffectFrameLabel(effect) {
+        if (effect?.templateId?.entityName === undefined) {
+            return undefined;
+        }
+        if (effect.kind === "create") {
+            return `${effect.templateId.entityName}.create`;
+        }
+        if (effect.kind === "exercise"
+            && effect.choice !== undefined) {
+            return `${effect.templateId.entityName}.${effect.choice}`;
+        }
+        return undefined;
+    }
+    createSourceLocation(traceStep) {
+        if (this.dependencies.sourceMapper === undefined) {
+            return undefined;
+        }
+        try {
+            const compilerExpressionSource = this.dependencies.sourceMapper.getExpressionSource(traceStep.expression);
+            if (compilerExpressionSource !== undefined) {
+                return new replay_source_location_js_1.ReplaySourceLocation({
+                    path: compilerExpressionSource.path,
+                    startLine: compilerExpressionSource.startLine + 1,
+                    startColumn: compilerExpressionSource.startColumn + 1,
+                    endLine: compilerExpressionSource.endLine + 1,
+                    endColumn: compilerExpressionSource.endColumn + 1,
+                    precision: source_mapping_precision_js_1.SourceMappingPrecision.exact,
+                });
+            }
+            const expressionSource = traceStep.expression.sourceLocation;
+            if (expressionSource !== undefined) {
+                const packageId = expressionSource.packageId ?? traceStep.frame.packageId;
+                const moduleName = expressionSource.moduleName ?? traceStep.frame.moduleName;
+                const moduleSource = this.dependencies.sourceMapper.getModuleSourceOrThrow(packageId, moduleName);
+                return new replay_source_location_js_1.ReplaySourceLocation({
+                    path: moduleSource.path,
+                    startLine: expressionSource.startLine + 1,
+                    startColumn: expressionSource.startColumn + 1,
+                    endLine: expressionSource.endLine + 1,
+                    endColumn: expressionSource.endColumn + 1,
+                    precision: source_mapping_precision_js_1.SourceMappingPrecision.exact,
+                });
+            }
+            if (traceStep.stateEffect === undefined) {
+                return undefined;
+            }
+            const source = this.dependencies.sourceMapper.getDefinitionSourceOrThrow(traceStep.frame.packageId, traceStep.frame.moduleName, traceStep.frame.definition.name);
+            return new replay_source_location_js_1.ReplaySourceLocation({
+                path: source.path,
+                startLine: source.startLine,
+                startColumn: source.startColumn,
+                endLine: source.endLine,
+                endColumn: source.endColumn,
+                precision: source.precision,
+            });
+        }
+        catch {
+            return undefined;
+        }
+    }
+}
+exports.LedgerReplaySessionLoader = LedgerReplaySessionLoader;