Skip to content

Fix notes not cleared when changing pages #1686

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.

Sign up for GitHub

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 5 commits into from
Feb 3, 2025
Merged

Fix notes not cleared when changing pages #1686

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bed2ac0
Fix notes not cleared when changing pages
Georgi2704 Jan 23, 2025
2db85f8
Fixed some type issues, detail pages work in progress
Georgi2704 Jan 28, 2025
1e92cfd
Working build, added note detail page editor
Georgi2704 Jan 29, 2025
216012a
Added changeset
Georgi2704 Jan 29, 2025
67e077c
Make boolean parameters non-optional
Georgi2704 Feb 3, 2025
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
5 changes: 5 additions & 0 deletions .changeset/olive-carrots-change.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@orchestrator-ui/orchestrator-ui-components': minor
---

Fix notes not updating when changing pages, fix cancel button resetting note to older value
2 changes: 1 addition & 1 deletion apps/wfo-ui
Open in desktop
Submodule wfo-ui updated 3 files
+13 −16 package-lock.json
+1 −1 package.json
+57 −37 pages/_app.tsx
6 changes: 3 additions & 3 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

146 changes: 70 additions & 76 deletions packages/orchestrator-ui-components/src/components/WfoInlineNoteEdit/WfoInlineNoteEdit.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,50 +5,37 @@ import { EuiInlineEditText } from '@elastic/eui';

import { WfoToolTip } from '@/components';
import { useOrchestratorTheme } from '@/hooks';
import { useStartProcessMutation } from '@/rtk/endpoints/forms';
import type { Subscription } from '@/types';
import { INVISIBLE_CHARACTER } from '@/utils';

interface WfoInlineNoteEditProps {
value: Subscription['note'];
subscriptionId?: Subscription['subscriptionId'];
value: string;
onlyShowOnHover?: boolean;
triggerNoteModifyWorkflow?: (note: string) => void;
}

export const WfoInlineNoteEdit: FC<WfoInlineNoteEditProps> = ({
value,
subscriptionId,
onlyShowOnHover = false,
triggerNoteModifyWorkflow = () => {},
}) => {
const { theme } = useOrchestratorTheme();
const [note, setNote] = useState<string>(value ?? '');
const [note, setNote] = useState<string>(value);
const [isTooltipVisible, setIsTooltipVisible] = useState<boolean>(true);

const [startProcess] = useStartProcessMutation();
const triggerNoteModifyWorkflow = () => {
const noteModifyPayload = [
{ subscription_id: subscriptionId },
{ note },
];
startProcess({
workflowName: 'modify_note',
userInputs: noteModifyPayload,
});
};

const handleSave = () => {
triggerNoteModifyWorkflow();
triggerNoteModifyWorkflow(note);
setIsTooltipVisible(true);
};

const handleCancel = () => {
setNote(value ?? '');
setNote(value);
setIsTooltipVisible(true);
};

// This useEffect makes sure the note is updated when a new value property is passed in
// for example by a parent component that is update through a websocket event
useEffect(() => {
setNote(value ?? '');
setNote(value);
}, [value]);

return (
Expand All @@ -63,72 +50,79 @@ export const WfoInlineNoteEdit: FC<WfoInlineNoteEditProps> = ({
}}
>
<WfoToolTip
css={{ visibility: isTooltipVisible ? 'visible' : 'hidden' }}
css={{
visibility:
isTooltipVisible && note !== INVISIBLE_CHARACTER
? 'visible'
: 'hidden',
}}
tooltipContent={note}
>
<EuiInlineEditText
inputAriaLabel="Edit note"
value={note}
onChange={(e: ChangeEvent<HTMLInputElement>) => {
setNote(e.target.value);
}}
onCancel={handleCancel}
onSave={handleSave}
size={'s'}
css={{
width: theme.base * 16,
'.euiFlexItem:nth-of-type(2)': {
justifyContent: 'center',
},
'.euiButtonEmpty__content': {
justifyContent: 'left',
},
}}
readModeProps={{
onClick: () => setIsTooltipVisible(false),
title: '',
css: {
minWidth: '100%',
'.euiIcon': {
visibility: onlyShowOnHover
? 'hidden'
: 'visible',
<span>
<EuiInlineEditText
inputAriaLabel="Edit note"
value={note}
onChange={(e: ChangeEvent<HTMLInputElement>) => {
setNote(e.target.value);
}}
onCancel={handleCancel}
onSave={handleSave}
size={'s'}
css={{
width: theme.base * 16,
'.euiFlexItem:nth-of-type(2)': {
justifyContent: 'center',
},
},
}}
editModeProps={{
saveButtonProps: {
color: 'primary',
size: 'xs',
},
cancelButtonProps: {
color: 'danger',
size: 'xs',
},
inputProps: {
css: {
'.euiButtonEmpty__content': {
justifyContent: 'left',
height: '32px',
paddingLeft: '4px',
margin: '0',
width: '98%',
},
},
formRowProps: {
}}
readModeProps={{
onClick: () => setIsTooltipVisible(false),
title: '',
css: {
padding: 0,
margin: 0,
height: '32px',
'.euiFormRow__fieldWrapper': {
minHeight: '32px',
minWidth: '100%',
'.euiIcon': {
visibility: onlyShowOnHover
? 'hidden'
: 'visible',
},
},
}}
editModeProps={{
saveButtonProps: {
color: 'primary',
size: 'xs',
},
cancelButtonProps: {
color: 'danger',
size: 'xs',
},
inputProps: {
css: {
justifyContent: 'left',
height: '32px',
paddingLeft: '4px',
margin: '0',
width: '98%',
},
},
formRowProps: {
css: {
padding: 0,
margin: 0,
height: '32px',
'.euiFormRow__fieldWrapper': {
minHeight: '32px',
height: '32px',
padding: 0,
margin: 0,
},
},
},
},
}}
/>
}}
/>
</span>
</WfoToolTip>
</div>
);
Expand Down
55 changes: 55 additions & 0 deletions ...estrator-ui-components/src/components/WfoInlineNoteEdit/WfoSubscriptionDetailNoteEdit.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
import type { FC } from 'react';
import React from 'react';

import { WfoInlineNoteEdit } from '@/components';
import { useGetSubscriptionDetailQuery } from '@/rtk';
import { useStartProcessMutation } from '@/rtk/endpoints/forms';
import { useUpdateSubscriptionDetailNoteOptimisticMutation } from '@/rtk/endpoints/subscriptionListMutation';
import { SubscriptionDetail } from '@/types';
import { INVISIBLE_CHARACTER } from '@/utils';

interface WfoSubscriptionDetailNoteEditProps {
subscriptionId: SubscriptionDetail['subscriptionId'];
onlyShowOnHover?: boolean;
}

export const WfoSubscriptionDetailNoteEdit: FC<
WfoSubscriptionDetailNoteEditProps
> = ({ subscriptionId, onlyShowOnHover = false }) => {
const { data, endpointName } = useGetSubscriptionDetailQuery({
subscriptionId,
});

const selectedItem = data?.subscription ?? { note: '' };
const [startProcess] = useStartProcessMutation();
const [updateSub] = useUpdateSubscriptionDetailNoteOptimisticMutation();

const triggerNoteModifyWorkflow = (note: string) => {
const noteModifyPayload = [
{ subscription_id: subscriptionId },
{ note: note === INVISIBLE_CHARACTER ? '' : note },
];
startProcess({
workflowName: 'modify_note',
userInputs: noteModifyPayload,
});

updateSub({
queryName: endpointName ?? '',
subscriptionId: subscriptionId,
note: note,
});
};

return (
<WfoInlineNoteEdit
value={
selectedItem?.note?.trim()
? selectedItem.note
: INVISIBLE_CHARACTER
}
onlyShowOnHover={onlyShowOnHover}
triggerNoteModifyWorkflow={triggerNoteModifyWorkflow}
/>
);
};
64 changes: 64 additions & 0 deletions ...s/orchestrator-ui-components/src/components/WfoInlineNoteEdit/WfoSubscriptionNoteEdit.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
import type { FC } from 'react';
import React from 'react';

import { WfoInlineNoteEdit } from '@/components';
import { ApiResult, SubscriptionListResponse, UseQuery } from '@/rtk';
import { useStartProcessMutation } from '@/rtk/endpoints/forms';
import { useUpdateSubscriptionNoteOptimisticMutation } from '@/rtk/endpoints/subscriptionListMutation';
import { Subscription } from '@/types';
import { INVISIBLE_CHARACTER } from '@/utils';

interface WfoSubscriptionNoteEditProps {
subscriptionId: Subscription['subscriptionId'];
onlyShowOnHover?: boolean;
queryVariables: Record<string, unknown>;
useQuery: UseQuery<SubscriptionListResponse, Subscription>;
}

export const WfoSubscriptionNoteEdit: FC<WfoSubscriptionNoteEditProps> = ({
subscriptionId,
onlyShowOnHover = false,
queryVariables,
useQuery,
}) => {
const { selectedItem } = useQuery(queryVariables, {
selectFromResult: (result: ApiResult<SubscriptionListResponse>) => ({
selectedItem: result?.data?.subscriptions?.find(
(sub) => sub.subscriptionId === subscriptionId,
),
}),
});
const endpointName = useQuery().endpointName;
const [startProcess] = useStartProcessMutation();
const [updateSub] = useUpdateSubscriptionNoteOptimisticMutation();

const triggerNoteModifyWorkflow = (note: string) => {
const noteModifyPayload = [
{ subscription_id: subscriptionId },
{ note: note === INVISIBLE_CHARACTER ? '' : note },
];
startProcess({
workflowName: 'modify_note',
userInputs: noteModifyPayload,
});

updateSub({
queryName: endpointName ?? '',
subscriptionId: subscriptionId,
graphQlQueryVariables: queryVariables,
note: note,
});
};

return (
<WfoInlineNoteEdit
value={
selectedItem?.note?.trim()
? selectedItem.note
: INVISIBLE_CHARACTER
}
onlyShowOnHover={onlyShowOnHover}
triggerNoteModifyWorkflow={triggerNoteModifyWorkflow}
/>
);
};
2 changes: 2 additions & 0 deletions packages/orchestrator-ui-components/src/components/WfoInlineNoteEdit/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
export * from './WfoInlineNoteEdit';
export * from './WfoSubscriptionNoteEdit';
export * from './WfoSubscriptionDetailNoteEdit';
7 changes: 3 additions & 4 deletions ...omponents/WfoSubscription/WfoSubscriptionGeneralSections/WfoSubscriptionDetailSection.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
SubscriptionKeyValueBlock,
WfoCustomerDescriptionsField,
WfoInSyncField,
WfoInlineNoteEdit,
WfoSubscriptionDetailNoteEdit,
WfoSubscriptionStatusBadge,
} from '@/components';
import { SubscriptionDetail } from '@/types';
Expand Down Expand Up @@ -35,7 +35,6 @@ export const WfoSubscriptionDetailSection = ({
status,
customer,
customerDescriptions,
note,
} = subscriptionDetail;

const subscriptionDetailBlockData = [
Expand Down Expand Up @@ -102,9 +101,9 @@ export const WfoSubscriptionDetailSection = ({
{
key: t('note'),
value: (
<WfoInlineNoteEdit
<WfoSubscriptionDetailNoteEdit
subscriptionId={subscriptionId}
value={note}
onlyShowOnHover={true}
/>
),
},
Expand Down
Loading
Loading