Skip to content

feat(vscode): Update assertions tokens metadata #4240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Feb 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions libs/designer-ui/src/lib/assertionsPanel/assertion.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ export interface AssertionProps {
onAssertionDelete: AssertionDeleteHandler;
onAssertionUpdate: AssertionUpdateHandler;
getTokenPicker: GetAssertionTokenPickerHandler;
tokenMapping: Record<string, ValueSegment>;
loadParameterValueFromString: (value: string) => ValueSegment[];
validationErrors?: Record<string, string | undefined>;
isInverted: boolean;
}
Expand All @@ -57,6 +59,8 @@ export function Assertion({
onAssertionDelete,
getTokenPicker,
onAssertionUpdate,
tokenMapping,
loadParameterValueFromString,
validationErrors,
isInverted,
}: AssertionProps): JSX.Element {
Expand Down Expand Up @@ -115,6 +119,8 @@ export function Assertion({
isExpanded={expanded}
getTokenPicker={getTokenPicker}
handleUpdate={handleUpdate}
tokenMapping={tokenMapping}
loadParameterValueFromString={loadParameterValueFromString}
validationErrors={validationErrors}
/>
</div>
Expand Down
8 changes: 6 additions & 2 deletions libs/designer-ui/src/lib/assertionsPanel/assertionField.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ export interface AssertionFieldProps {
isExpanded: boolean;
getTokenPicker: GetAssertionTokenPickerHandler;
handleUpdate: (newAssertion: Assertion) => void;
tokenMapping: Record<string, ValueSegment>;
loadParameterValueFromString: (value: string) => ValueSegment[];
validationErrors?: Record<string, string | undefined>;
}

Expand All @@ -64,6 +66,8 @@ export const AssertionField = ({
isExpanded,
getTokenPicker,
handleUpdate,
tokenMapping,
loadParameterValueFromString,
validationErrors,
}: AssertionFieldProps): JSX.Element => {
const intl = useIntl();
Expand Down Expand Up @@ -185,8 +189,8 @@ export const AssertionField = ({
labelId="condition-label"
tokenEditor={true}
value={[]}
tokenMapping={{}}
// errorDetails={{message: ?? ''}}
tokenMapping={tokenMapping}
loadParameterValueFromString={loadParameterValueFromString}
getTokenPicker={(
editorId: string,
labelId: string,
Expand Down
7 changes: 7 additions & 0 deletions libs/designer-ui/src/lib/assertionsPanel/assertions.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type { ValueSegment } from '../editor';
import { isHighContrastBlack } from '../utils';
import {
type AssertionUpdateHandler,
Expand All @@ -23,6 +24,8 @@ export interface AssertionsProps {
onAssertionUpdate: AssertionUpdateHandler;
onAssertionDelete: AssertionDeleteHandler;
getTokenPicker: GetAssertionTokenPickerHandler;
tokenMapping: Record<string, ValueSegment>;
loadParameterValueFromString: (value: string) => ValueSegment[];
validationErrors?: Record<string, Record<string, string | undefined>>;
}

Expand All @@ -33,6 +36,8 @@ export function Assertions({
onAssertionUpdate,
onAssertionDelete,
getTokenPicker,
tokenMapping,
loadParameterValueFromString,
validationErrors,
}: AssertionsProps): JSX.Element {
const intl = useIntl();
Expand Down Expand Up @@ -73,6 +78,8 @@ export function Assertions({
onAssertionDelete={onAssertionDelete}
onAssertionUpdate={onAssertionUpdate}
getTokenPicker={getTokenPicker}
tokenMapping={tokenMapping}
loadParameterValueFromString={loadParameterValueFromString}
validationErrors={parameterErrors}
isInverted={isInverted}
/>
Expand Down
59 changes: 59 additions & 0 deletions libs/designer/src/lib/core/utils/assertions.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
import { type ValueSegment, ValueSegmentType, GroupType, type GroupItems } from '@microsoft/designer-ui';
import { type AssertionDefintion, clone } from '@microsoft/utils-logic-apps';

/**
* Loads token metadata for the given operand using the provided token mapping.
* @param {ValueSegment[]} operand - The operand to load token metadata for.
* @param {Record<string, ValueSegment>} tokenMapping - The mapping of tokens to their corresponding metadata.
* @returns The operand with updated token metadata.
*/
const loadTokenMetaData = (operand: ValueSegment[], tokenMapping: Record<string, ValueSegment>) => {
return operand.map((segment: ValueSegment) => {
if (segment.type === ValueSegmentType.TOKEN && tokenMapping[segment.value]) {
const newToken = { ...segment.token, ...tokenMapping[segment.value].token };
return { ...segment, token: newToken };
}
return segment;
}) as ValueSegment[];
};

/**
* Recursively applies assertions to the items in a group.
* @param {GroupItems} items - The group items to apply assertions to.
* @param {Record<string, ValueSegment>} tokenMapping - The mapping of tokens to their corresponding values.
* @returns The updated group items with assertions applied.
*/
const recurseAssertions = (items: GroupItems, tokenMapping: Record<string, ValueSegment>): GroupItems => {
const newItems = clone(items);
if (newItems.type === GroupType.GROUP) {
newItems.items = newItems.items.map((item) => {
return recurseAssertions(item, tokenMapping);
});
return newItems;
} else {
newItems.operand1 = loadTokenMetaData(newItems.operand1, tokenMapping);
newItems.operand2 = loadTokenMetaData(newItems.operand2, tokenMapping);
return newItems;
}
};

/**
* Updates the token metadata in the assertions object.
* @param {Record<string, ValueSegment>} tokenMapping - The mapping of tokens to their corresponding value segments.
* @param {Record<string, AssertionDefintion>} assertions - The assertions object to update.
* @returns The updated assertions object.
*/
export const updateTokenMetadataInAssertions = (
tokenMapping: Record<string, ValueSegment>,
assertions: Record<string, AssertionDefintion>
) => {
const updatedAssertions = clone(assertions);
Object.keys(updatedAssertions).forEach((assertionKey) => {
const { items } = updatedAssertions[assertionKey].expression;
if (items) {
updatedAssertions[assertionKey].expression.items = recurseAssertions(items, tokenMapping);
}
});

return updatedAssertions;
};
35 changes: 31 additions & 4 deletions libs/designer/src/lib/ui/panel/assertionsPanel/assertionsPanel.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ import type { VariableDeclaration } from '../../../core/state/tokens/tokensSlice
import { useAssertions, useAssertionsValidationErrors } from '../../../core/state/unitTest/unitTestSelectors';
import { updateAssertions, updateAssertion } from '../../../core/state/unitTest/unitTestSlice';
import type { AppDispatch, RootState } from '../../../core/store';
import { updateTokenMetadataInAssertions } from '../../../core/utils/assertions';
import {
VariableBrandColor,
VariableIcon,
generateExpressionFromKey,
getTokenExpressionMethodFromKey,
getTokenValueFromToken,
loadParameterValueFromString,
toConditionViewModel,
} from '../../../core/utils/parameters/helper';
import { type TokenGroup, getExpressionTokenSections } from '../../../core/utils/tokens';
Expand All @@ -28,8 +30,8 @@ import {
ValueSegmentType,
} from '@microsoft/designer-ui';
import { getIntl } from '@microsoft/intl-logic-apps';
import { guid, type AssertionDefintion, aggregate, getPropertyValue, labelCase } from '@microsoft/utils-logic-apps';
import { useCallback, useMemo, useState } from 'react';
import { guid, type AssertionDefintion, aggregate, getPropertyValue, labelCase, isNullOrEmpty } from '@microsoft/utils-logic-apps';
import { useCallback, useEffect, useMemo, useState } from 'react';
import { useDispatch, useSelector } from 'react-redux';

const getVariableTokens = (variables: Record<string, VariableDeclaration[]>): OutputToken[] => {
Expand Down Expand Up @@ -180,13 +182,13 @@ const getTokenPicker = (

export const AssertionsPanel = (props: CommonPanelProps) => {
const workflowAssertions = useAssertions();
const [assertions, setAssertions] = useState<Record<string, AssertionDefintion>>(workflowAssertions);
const [assertions, setAssertions] = useState<Record<string, AssertionDefintion>>({});
const assertionsValidationErrors = useAssertionsValidationErrors();

const dispatch = useDispatch<AppDispatch>();
const [tokenMapping, setTokenMapping] = useState<Record<string, ValueSegment>>({});

const tokens = useTokens();

const onClose = () => {
props.toggleCollapse?.();
};
Expand Down Expand Up @@ -225,6 +227,29 @@ export const AssertionsPanel = (props: CommonPanelProps) => {
dispatch(updateAssertions({ assertions: newAssertions }));
};

useEffect(() => {
if (!isNullOrEmpty(tokenMapping)) {
setAssertions(updateTokenMetadataInAssertions(tokenMapping, workflowAssertions));
}
}, [tokenMapping, workflowAssertions]);

useEffect(() => {
const callback = async () => {
const mapping: Record<string, ValueSegment> = {};
for (const group of [...tokens.outputTokensWithValues, ...tokens.variableTokens]) {
for (const token of group.tokens) {
if (!token.value) {
continue;
}
mapping[token.value] = await getValueSegmentFromToken(token);
}
}
setTokenMapping(mapping);
};

callback();
}, [tokens]);

const onGetTokenPicker = useCallback(
(
editorId: string,
Expand Down Expand Up @@ -256,6 +281,8 @@ export const AssertionsPanel = (props: CommonPanelProps) => {
onAssertionDelete={onAssertionDelete}
onAssertionUpdate={onAssertionUpdate}
getTokenPicker={onGetTokenPicker}
tokenMapping={tokenMapping}
loadParameterValueFromString={(value: string) => loadParameterValueFromString(value)}
validationErrors={assertionsValidationErrors}
/>
);
Expand Down