Skip to content

Commit

Permalink
Improve name validation
Browse files Browse the repository at this point in the history
  • Loading branch information
serjonya-trili committed Oct 9, 2024
1 parent 3cd745d commit 59e435e
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
18 changes: 17 additions & 1 deletion packages/state/src/hooks/labels.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {
} from "@umami/core";
import { MAINNET } from "@umami/tezos";

import { useGetNextAvailableAccountLabels, useValidateName } from "./labels";
import { PROHIBITED_CHARACTERS, useGetNextAvailableAccountLabels, useValidateName } from "./labels";
import { contactsActions, multisigsActions, networksActions } from "../slices";
import { type UmamiStore, makeStore } from "../store";
import { addTestAccounts, renderHook } from "../testUtils";
Expand All @@ -22,6 +22,22 @@ beforeEach(() => {

describe("labelsHooks", () => {
describe("useValidateName", () => {
it.each(PROHIBITED_CHARACTERS)("fails if name contains `%s` special character", char => {
const {
result: { current: validateName },
} = renderHook(() => useValidateName(), { store });

expect(validateName(`Some ${char} name`)).toEqual("Name contains special character(s)");
});

it("fails if name exceeds 256 characters", () => {
const {
result: { current: validateName },
} = renderHook(() => useValidateName(), { store });

expect(validateName("a".repeat(257))).toEqual("Name should not exceed 256 characters");
});

describe.each([
{ testCase: "with trailing whitespaces", withWhitespaces: true },
{ testCase: "without trailing whitespaces", withWhitespaces: false },
Expand Down
8 changes: 8 additions & 0 deletions packages/state/src/hooks/labels.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
import { useAllContacts } from "./contacts";
import { useAllAccounts } from "./getAccountData";

export const PROHIBITED_CHARACTERS = ["<", ">", '"', "'", "&", "/", "\\", "\t", "\n", "\r", "`"];

/** Hook for validating name for account or contact. */
export const useValidateName = (oldName?: string | undefined) => {
const isUniqueLabel = useIsUniqueLabel();

return (name: string) => {
const trimmedName = name.trim();
if (trimmedName.length > 256) {
return "Name should not exceed 256 characters";
}
if (PROHIBITED_CHARACTERS.some(char => trimmedName.includes(char))) {
return "Name contains special character(s)";
}
if (trimmedName.length === 0) {
return "Name should not be empty";
}
Expand Down

0 comments on commit 59e435e

Please sign in to comment.