Skip to content
Closed
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
4 changes: 4 additions & 0 deletions src/messages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ const messages = defineMessages({
id: 'authoring.alert.support.text',
defaultMessage: 'Support Page',
},
unknownError: {
id: 'authoring.alert.error.unknown',
defaultMessage: 'Unknown error',
},
});

export default messages;
26 changes: 8 additions & 18 deletions src/taxonomy/data/apiHooks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
import { useQuery, useMutation, useQueryClient } from '@tanstack/react-query';
import { camelCaseObject } from '@edx/frontend-platform';
import { getAuthenticatedHttpClient } from '@edx/frontend-platform/auth';
import { useIntl } from '@edx/frontend-platform/i18n';
import { apiUrls, ALL_TAXONOMIES, getApiErrorMessage } from './api';
import * as api from './api';
import type { QueryOptions, TagListData } from './types';
Expand Down Expand Up @@ -214,18 +213,13 @@ export const useSubTags = (taxonomyId: number, parentTagValue: string) => useQue

export const useCreateTag = (taxonomyId: number) => {
const queryClient = useQueryClient();
const intl = useIntl();

return useMutation({
mutationFn: async ({ value, parentTagValue }: { value: string, parentTagValue?: string }) => {
try {
await getAuthenticatedHttpClient().post(
apiUrls.createTag(taxonomyId),
{ tag: value, parent_tag_value: parentTagValue },
);
} catch (err) {
throw new Error(getApiErrorMessage(err, intl));
}
await getAuthenticatedHttpClient().post(
apiUrls.createTag(taxonomyId),
{ tag: value, parent_tag_value: parentTagValue },
);
},
onSuccess: () => {
queryClient.invalidateQueries({
Expand All @@ -246,14 +240,10 @@ export const useUpdateTag = (taxonomyId: number) => {

return useMutation({
mutationFn: async ({ value, originalValue }: { value: string, originalValue: string }) => {
try {
await getAuthenticatedHttpClient().patch(
apiUrls.updateTag(taxonomyId),
{ tag: originalValue, updated_tag_value: value },
);
} catch (err) {
throw new Error(getApiErrorMessage(err));
}
await getAuthenticatedHttpClient().patch(
apiUrls.updateTag(taxonomyId),
{ tag: originalValue, updated_tag_value: value },
);
},
onSuccess: () => {
queryClient.invalidateQueries({
Expand Down
2 changes: 1 addition & 1 deletion src/taxonomy/tag-list/OptionalExpandLink.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { ExpandLess, ExpandMore } from '@openedx/paragon/icons';
import { Row } from '@tanstack/react-table';
import { useIntl } from '@edx/frontend-platform/i18n';

import type { TreeRowData } from '../tree-table/types';
import type { TreeRowData } from '@src/taxonomy/tree-table/types';
import messages from './messages';

interface OptionalExpandLinkProps {
Expand Down
4 changes: 2 additions & 2 deletions src/taxonomy/tag-list/TagListTable.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import React, {
useEffect,
} from 'react';
import type { PaginationState } from '@tanstack/react-table';
import { useTagListData, useCreateTag, useUpdateTag } from '../data/apiHooks';
import { TableView } from '@src/taxonomy/tree-table';
import { useTagListData, useCreateTag, useUpdateTag } from '@src/taxonomy/data/apiHooks';
import { TagTree } from './tagTree';
import { TableView } from '../tree-table';
import type {
RowId,
TreeColumnDef,
Expand Down
25 changes: 25 additions & 0 deletions src/taxonomy/tag-list/UsageCountDisplay.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import {
Bubble,
} from '@openedx/paragon';
import type { Row } from '@tanstack/react-table';
import type {
TreeRowData,
} from '@src/taxonomy/tree-table/types';
import { TagListRowData } from './types';

const asTagListRowData = (row: Row<TreeRowData>): TagListRowData => (
row.original as unknown as TagListRowData
);

const UsageCountDisplay = ({ row }: { row: Row<TreeRowData> }) => {
const count = asTagListRowData(row).usageCount ?? 0;
return (
count > 0 && (
<Bubble expandable>
{count}
</Bubble>
)
);
};

export default UsageCountDisplay;
37 changes: 29 additions & 8 deletions src/taxonomy/tag-list/hooks.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
import { useReducer } from 'react';
import { useIntl } from '@edx/frontend-platform/i18n';

import { useCreateTag, useUpdateTag } from '../data/apiHooks';
import globalMessages from '@src/messages';
import { useCreateTag, useUpdateTag } from '@src/taxonomy/data/apiHooks';
import type { RowId } from '@src/taxonomy/tree-table/types';
import { TagTree } from './tagTree';
import { TagListTableError } from './errors';
import type { RowId } from '../tree-table/types';
import {
TABLE_MODES,
TRANSITION_TABLE,
Expand Down Expand Up @@ -163,6 +164,26 @@ const useEditActions = ({
return true;
};

const getErrorMessage = (error: any): string => {
let errorMessage: string = '';
if (error.name === 'AxiosError') {
const responseData = error.response?.data;
const tagError = Object.entries(responseData)?.find((errItem: [string, unknown]) => (
['tag', 'value', 'updated_tag_value'].includes(errItem[0].toLowerCase())
));

const errorMessages = tagError ? tagError[1] : (
(error as Error).message || intl.formatMessage(globalMessages.unknownError)
);
errorMessage = Array.isArray(errorMessages) ? errorMessages.join('; ') : String(errorMessages);
} else {
errorMessage = (error as Error).message || intl.formatMessage(globalMessages.unknownError);
}

errorMessage = errorMessage.replace(/\.$/, ''); // Remove trailing period for better message formatting
return errorMessage;
};

const handleCreateTag = async (value: string, parentTagValue?: string) => {
const trimmed = value.trim();

Expand All @@ -182,9 +203,9 @@ const useEditActions = ({
setIsCreatingTopTag(false);
setCreatingParentId(null);
} catch (error) {
const message = intl.formatMessage(messages.tagCreationErrorMessage, { errorMessage: (error as Error)?.message });
setDraftError((error as Error)?.message || intl.formatMessage(messages.tagCreationErrorMessage, { errorMessage: '' }));
setToast({ show: true, message });
const errorMessage = getErrorMessage(error);
setDraftError(errorMessage);
setToast({ show: true, message: intl.formatMessage(messages.tagCreationErrorMessage, { errorMessage }) });
}
};

Expand All @@ -211,9 +232,9 @@ const useEditActions = ({
message: intl.formatMessage(messages.tagUpdateSuccessMessage, { name: trimmed }),
});
} catch (error) {
const message = intl.formatMessage(messages.tagUpdateErrorMessage, { errorMessage: (error as Error)?.message });
setDraftError((error as Error)?.message || intl.formatMessage(messages.tagUpdateErrorMessage, { errorMessage: '' }));
setToast({ show: true, message });
const errorMessage = getErrorMessage(error);
setDraftError(errorMessage);
setToast({ show: true, message: intl.formatMessage(messages.tagUpdateErrorMessage, { errorMessage }) });
}
};

Expand Down
26 changes: 4 additions & 22 deletions src/taxonomy/tag-list/tagColumns.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import {
Bubble,
Icon,
IconButton,
IconButtonWithTooltip,
Expand All @@ -12,24 +11,18 @@ import {
import { FormattedMessage, useIntl } from '@edx/frontend-platform/i18n';
import type { Row } from '@tanstack/react-table';

import messages from './messages';
import type {
RowId,
TreeColumnDef,
TreeRowData,
} from '../tree-table/types';
} from '@src/taxonomy/tree-table/types';
import { TagListRowData } from './types';
import messages from './messages';
import OptionalExpandLink from './OptionalExpandLink';
import UsageCountDisplay from './UsageCountDisplay';

const EDITABLE_COLUMNS = ['value'];

interface TagListRowData extends TreeRowData {
depth: number;
childCount: number;
usageCount?: number;
isNew?: boolean;
isEditing?: boolean;
}

const asTagListRowData = (row: Row<TreeRowData>): TagListRowData => (
row.original as unknown as TagListRowData
);
Expand All @@ -49,17 +42,6 @@ interface GetColumnsArgs {
maxDepth: number;
}

const UsageCountDisplay = ({ row }: { row: Row<TreeRowData> }) => {
const count = asTagListRowData(row).usageCount ?? 0;
return (
count > 0 && (
<Bubble expandable>
{count}
</Bubble>
)
);
};

interface ActionsHeaderProps {
onStartDraft: () => void;
setDraftError: (error: string) => void;
Expand Down
2 changes: 1 addition & 1 deletion src/taxonomy/tag-list/tagTree.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { TagData } from '@src/taxonomy/data/types';
import { TagTreeError } from './errors';
import type { TagData } from '../data/types';

export interface TagTreeNode extends TagData {
subRows?: TagTreeNode[];
Expand Down
9 changes: 9 additions & 0 deletions src/taxonomy/tag-list/types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { TreeRowData } from '@src/taxonomy/tree-table/types';

export interface TagListRowData extends TreeRowData {
depth: number;
childCount: number;
usageCount?: number;
isNew?: boolean;
isEditing?: boolean;
}
3 changes: 1 addition & 2 deletions src/taxonomy/tree-table/CreateRow.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import React from 'react';
import { IntlProvider } from '@edx/frontend-platform/i18n';
import { fireEvent, render, screen } from '@testing-library/react';

import { CreateRow } from './CreateRow';
import CreateRow from './CreateRow';

const wrapper = ({ children }: { children: React.ReactNode }) => (
<IntlProvider locale="en" messages={{}}>{children}</IntlProvider>
Expand All @@ -15,7 +15,6 @@ const baseProps = () => ({
setIsCreatingTopRow: jest.fn(),
exitDraftWithoutSave: jest.fn(),
createRowMutation: { isPending: false },
columns: [{ id: 'value' }],
validate: jest.fn((value: string) => value.trim().length > 0),
});

Expand Down
Loading
Loading