Skip to content

Commit

Permalink
fix(editor): Prevent duplicate values in preview for SQL editor (#9129)
Browse files Browse the repository at this point in the history
  • Loading branch information
elsmr authored Apr 22, 2024
1 parent 6c63cd9 commit 5acbfb4
Show file tree
Hide file tree
Showing 6 changed files with 236 additions and 198 deletions.
15 changes: 7 additions & 8 deletions packages/editor-ui/src/components/ExpressionEdit.vue
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,10 @@
{{ $locale.baseText('expressionEdit.resultOfItem1') }}
</div>
<div :class="{ 'ph-no-capture': redactValues }">
<ExpressionEditorModalOutput
<ExpressionOutput
ref="expressionResult"
:segments="segments"
:extensions="theme"
data-test-id="expression-modal-output"
/>
</div>
Expand All @@ -82,7 +83,6 @@
import { defineComponent } from 'vue';
import { mapStores } from 'pinia';
import ExpressionEditorModalInput from '@/components/ExpressionEditorModal/ExpressionEditorModalInput.vue';
import ExpressionEditorModalOutput from '@/components/ExpressionEditorModal/ExpressionEditorModalOutput.vue';
import VariableSelector from '@/components/VariableSelector.vue';
import type { IVariableItemSelected } from '@/Interface';
Expand All @@ -96,12 +96,14 @@ import { createExpressionTelemetryPayload } from '@/utils/telemetryUtils';
import { useDebounce } from '@/composables/useDebounce';
import type { Segment } from '@/types/expressions';
import ExpressionOutput from './InlineExpressionEditor/ExpressionOutput.vue';
import { outputTheme } from './ExpressionEditorModal/theme';
export default defineComponent({
name: 'ExpressionEdit',
components: {
ExpressionEditorModalInput,
ExpressionEditorModalOutput,
ExpressionOutput,
VariableSelector,
},
props: {
Expand Down Expand Up @@ -149,6 +151,7 @@ export default defineComponent({
latestValue: '',
segments: [] as Segment[],
expressionsDocsUrl: EXPRESSIONS_DOCS_URL,
theme: outputTheme(),
};
},
computed: {
Expand All @@ -160,11 +163,7 @@ export default defineComponent({
this.latestValue = this.modelValue;
const resolvedExpressionValue =
(
this.$refs.expressionResult as {
getValue: () => string;
}
)?.getValue() || '';
(this.$refs.expressionResult as InstanceType<typeof ExpressionOutput>)?.getValue() || '';
void this.externalHooks.run('expressionEdit.dialogVisibleChanged', {
dialogVisible: newValue,
parameter: this.parameter,
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
<script setup lang="ts">
import { EditorState, type Extension } from '@codemirror/state';
import { EditorView } from '@codemirror/view';
import { useI18n } from '@/composables/useI18n';
import { highlighter } from '@/plugins/codemirror/resolvableHighlighter';
import type { Plaintext, Resolved, Segment } from '@/types/expressions';
import { computed, onBeforeUnmount, onMounted, ref, watch } from 'vue';
import { forceParse } from '@/utils/forceParse';
interface ExpressionOutputProps {
segments: Segment[];
extensions?: Extension[];
}
const props = withDefaults(defineProps<ExpressionOutputProps>(), { extensions: () => [] });
const i18n = useI18n();
const editor = ref<EditorView | null>(null);
const root = ref<HTMLElement | null>(null);
const resolvedExpression = computed(() => {
if (props.segments.length === 0) {
return i18n.baseText('parameterInput.emptyString');
}
return props.segments.reduce(
(acc, segment) => {
// skip duplicate segments
if (acc.cursor >= segment.to) return acc;
acc.resolved += segment.kind === 'resolvable' ? String(segment.resolved) : segment.plaintext;
acc.cursor = segment.to;
return acc;
},
{ resolved: '', cursor: 0 },
).resolved;
});
const plaintextSegments = computed<Plaintext[]>(() => {
return props.segments.filter((s): s is Plaintext => s.kind === 'plaintext');
});
const resolvedSegments = computed<Resolved[]>(() => {
if (props.segments.length === 0) {
const emptyExpression = resolvedExpression.value;
const emptySegment: Resolved = {
from: 0,
to: emptyExpression.length,
kind: 'resolvable',
error: null,
resolvable: '',
resolved: emptyExpression,
state: 'pending',
};
return [emptySegment];
}
let cursor = 0;
return props.segments
.map((segment) => {
segment.from = cursor;
cursor +=
segment.kind === 'plaintext'
? segment.plaintext.length
: segment.resolved
? (segment.resolved as string | number | boolean).toString().length
: 0;
segment.to = cursor;
return segment;
})
.filter((segment): segment is Resolved => segment.kind === 'resolvable');
});
watch(
() => props.segments,
() => {
if (!editor.value) return;
editor.value.dispatch({
changes: { from: 0, to: editor.value.state.doc.length, insert: resolvedExpression.value },
});
highlighter.addColor(editor.value as EditorView, resolvedSegments.value);
highlighter.removeColor(editor.value as EditorView, plaintextSegments.value);
},
);
onMounted(() => {
editor.value = new EditorView({
parent: root.value as HTMLElement,
state: EditorState.create({
doc: resolvedExpression.value,
extensions: [
EditorState.readOnly.of(true),
EditorView.lineWrapping,
EditorView.editable.of(false),
EditorView.domEventHandlers({ scroll: forceParse }),
...props.extensions,
],
}),
});
});
onBeforeUnmount(() => {
editor.value?.destroy();
});
defineExpose({ getValue: () => '=' + resolvedExpression.value });
</script>

<template>
<div ref="root" data-test-id="expression-output"></div>
</template>
Loading

0 comments on commit 5acbfb4

Please sign in to comment.