Skip to content
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

If 1701 masked input fixes #3390

Draft
wants to merge 29 commits into
base: master
Choose a base branch
from
Draft

If 1701 masked input fixes #3390

wants to merge 29 commits into from

Conversation

lossir
Copy link
Member

@lossir lossir commented Mar 26, 2024

Баги от лица пользователя описаны в задаче IF-17011. Всего их 6.
Здесь описаны технические проблемы, которые вызывали эти баги.

Проблема 1

Старый код, отвечающий за подсветку маски.
Плюс его в поддержке IE11 и старых версий других браузеров.
Минусы - сложность; влияние на вёрстку; специфичное тестирование.

Проблема 2

Использование setTimeout для обработки события onUnexpectedInput.


Решение 1

После отказа от поддержки IE11, эту логику получилось сделать "проще", хоть и многословнее.
Новый код минимально влияет на вёрстку, благодаря чему MaskedInput тестируется как обычный Input.

Всё работает с помощью градиента и стилей background-clip2 и -webkit-text-fill-color3.

Также символ подчеркивания снова реализовали через специальный шрифт, как это было в старых версиях пакета.
Но теперь шрифт лежит на сервере статики, что позволило избежать сложностей, которые он создавал раньше4.

Решение 2

setTimeout удалось заменить на синхронный код.

Ссылки

Песочница с новыми стялими
https://codepen.io/lossir/pen/ExrewOx

Чек-лист перед запросом ревью

  1. Добавлены тесты на все изменения
    ⬜ unit-тесты для логики
    ⬜ скриншоты для верстки и кросс-браузерности
    ⬜ нерелевантно

  2. Добавлена (обновлена) документация
    ⬜ styleguidist для пропов и примеров использования компонентов
    ⬜ jsdoc для утилит и хелперов
    ⬜ комментарии для неочевидных мест в коде
    ⬜ прочие инструкции (README.md, contributing.md и др.)
    ⬜ нерелевантно

  3. Изменения корректно типизированы
    ⬜ без использования any (см. PR 2856)
    ⬜ нерелевантно

  4. Прочее
    ⬜ все тесты и линтеры на CI проходят
    ⬜ в коде нет лишних изменений
    ⬜ заголовок PR кратко и доступно отражает суть изменений (он попадет в changelog)

Footnotes

  1. https://yt.skbkontur.ru/issue/IF-1701

  2. https://caniuse.com/background-clip-text

  3. https://caniuse.com/mdn-css_properties_-webkit-text-fill-color

  4. https://github.com/skbkontur/retail-ui/issues/2181

inputRef.current &&
(inputRef.current.selectAll = () => {
setTimeout(() => {
inputRef.current?.setSelectionRange(0, 999);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Мы здесь явно патчим инпут и переопределяем selectAll. Выглядит сомнительно, но на вскидку не могу предложить вариант лучше.
  2. Магическая константа. Маловероятно, но что если текст в инпуте окажется больше? Может есть смысл использовать Number.MAX_SAFE_INTEGER?

}
}

function handleMouseUp() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Обсуждали голосом handleMouseUp и handleKeyUp. Они нужны потому что в imask есть рассинхрон между изменением выделенного значения и реальным значением в итоге. Текст всегда дописывается в начало.

На мой взгляд лучше оставлять максимально нативное поведение и кастомное поведение этих обработчиков в будущем может выстрелить в каком-то другом месте. Появится баг и его будет очень сложно исправить сохраняя текущее поведение.

И второй момент:
Нужно в конце вызывать onMouseUp, onKeyUp из пропов. Иначе у нас будут в контракте обработчики, которые не работают.

expect(input).toHaveValue('+7 890 123 45 ');
});

it('prefix on focus', () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

А что не так с этими тестами? Я их добавлял потому что встречал баги с этим поведением.

Я бы наоборот еще добавил тестов, например, на то что при передаче значения не по маске у нас не вызывается onValueChange. Как это работало раньше. Или явно зафиксировать тестом новое поведение, если оно изменилось

children: React.ReactElement;
};

export type MaskedShadows = [string, string];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MaskedShadows не используется

spanRef.current.shadowRoot &&
(spanRef.current.shadowRoot.innerHTML = `
<style> * { font: ${style.font}; } </style>
${val}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

На сколько безопасно писать в spanRef.innerHtml?

Это потенциальная уязвимость. В маске может оказаться html со скриптом.
Может лучше писать val через .textContent?

}
const { selectionStart, selectionEnd } = imaskRef.current.element;

const nearest = imaskRef.current.maskRef.masked.nearestInputPos(999, 'LEFT');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Может быть тут тоже лучше использовать Number.MAX_SAFE_INTEGER

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants