Как протестировать приватную функцию?

Question

[tostershmoster]

есть такая функция

private createMark(marginFromBegin: number, settings: ISettings): HTMLElement {
  const mark = createElement('span', 'range-slider__scale-mark');

  if (settings.isVertical) {
    mark.className += ' range-slider__scale-mark_vertical';
    mark.style.marginTop = `${marginFromBegin}px`;
  } else {
    mark.style.marginLeft = `${marginFromBegin}px`;
  }

  return mark;
}

пишу к ней тест

import { ISettings } from '../RangeSlider/types';
import Scale from './Scale';

let settings: ISettings;

beforeEach(() => {
  settings = {
    min: 0,
    max: 1500,
    isTwoRunners: true,
    isScaleVisible: true,
    isVertical: false,
    isTooltipsVisible: true,
    valueFrom: 1000,
    valueTo: 1490,
    step: 10,
  };
});

function getPrivateMethod(methodName: string, marginFromBegin: number, settings: ISettings) {
  const scaleProto = Scale.prototype as any;
  const instance = Object.create(scaleProto);
  return () => scaleProto.constructor[methodName].call(instance, marginFromBegin, settings);
}

describe('private createMark method', () => {
  test('should return html element', () => {
    settings.isVertical = true;
    const result = getPrivateMethod('createMark', 100, settings);

    console.log(result);

    expect(result).not.toBeNull();
  });
});

Ожидаю что в result будет html элемент mark который возвращает функция createMark,
но console.log вместо этого выводит [Function]

Comments

[Lynn «Кофеман»]

Ну так вы не вызвали метод.

А вообще можно просто создать экземпляр класса и вызвать его метод через obj["createMark"](100, settings)

Отдельно непонятно почему это метод, если в нём нет this

[tostershmoster]

Ну так вы не вызвали метод.

Это разве не вызов?
scaleProto.constructor[methodName].call(instance, marginFromBegin, settings);

А вообще можно просто создать экземпляр класса и вызвать его метод через..

А мне eslint подчёркивал такую запись с сообщением
["createMark"] is better written in dot notation.eslint (dot-notation)
а в dot-notation это не работает. почему?

Отдельно непонятно почему это метод, если в нём нет this

Там был this в условии if (this.settings.isVertical), но мне не понятно как передать this.settings при тестировании в этот метод, поэтому добавил settings параметром. А что разве не может быть метода без this?

в класс Scale при инициализации settings не передаются, они получаются одним из метов в процессе, т.к. до этого могут быть изменены

[Alexandroppolus]

Это разве не вызов?

нет. getPrivateMethod возвращает стрелочную функцию, которую надо вызвать

А что разве не может быть метода без this?

обычно такое имеет смысл, только если ты замыслил в дальнейшем наследоваться от класса и переопределять метод у потомка.

[Lynn «Кофеман»]

tostershmoster,

> но мне не понятно как передать this.settings при тестировании в этот метод

Ну вот вы передали instance первым параметром в call. Это и есть this внутри метода.

[tostershmoster]

Lynn «Кофеман», а если так вызывать

obj["createMark"](100, settings);

то как this передать?

[Lynn «Кофеман»]

tostershmoster, obj и есть this.

[tostershmoster]

Lynn «Кофеман»,
а какой вариант лучше
scale['createMark'](marginFromBegin)

или

function getPrivateMethod(methodName: string, marginFromBegin: number, settings: ISettings) {
  const scaleProto = Scale.prototype as any;
  const instance = Object.create(scaleProto); // instance == this
  instance.settings = settings;
  return scaleProto[methodName].call(instance, marginFromBegin); 
}
getPrivateMethod('createMark', marginFromBegin, settings);

и в чём между ними разница. есть ли какие-нибудь плюсы/минусы?

[Lynn «Кофеман»]

tostershmoster, разница в 6 строках непонятно зачем нужной функции.

[tostershmoster]

Lynn «Кофеман», тогда будем считать первый коммент решением) напишите ответом, отмечу решением

[tostershmoster]

Alexandroppolus,

обычно такое имеет смысл, только если ты замыслил в дальнейшем наследоваться от класса и переопределять метод у потомка.

ну а если там будет this, разве нельзя будет отнаследоваться и переопределить?

[Alexandroppolus]

tostershmoster,

ну а если там будет this, разве нельзя будет отнаследоваться и переопределить?

как раз можно. Я может непонятно выразился. В общем, именно с такой перспективой стоит держать в классе метод, который не использует this. Главное, что к нему обращаются через this (через ссылку на экземпляр, т.е. он "экземплярный"). На этом основана куча паттернов - фабричный метод, шаблонный метод и т.д.

Ну и, конечно, бывает, что код меняется. Сегодня метод не использует this, завтра будет использовать. Если он экземплярный, то не придется нигде менять его вызовы.

Answer 1

[Alexandroppolus]

scaleProto.constructor[methodName]

метод статический что ли?
тогда просто вынеси его в утилсы

Comments

[tostershmoster]

что значит вынести в утилсы? В общий модуль?

[Alexandroppolus]

tostershmoster, нет. Просто отдельная функция. Обычно делается файл utils.ts со всякими вспомогательными функциями, который лежит рядом с файлом класса. Иногда - даже подпапка utils, в которой есть свой index.ts и отдельные файлы для вспомогательных функций и классов

[tostershmoster]

Что вы имеете ввиду под

Просто отдельная функция.

Вот у меня есть файл common.ts в котором находятся вспомогательные функции которые используются в разных классах. Я это имел ввиду под общим модулем.

отдельные файлы для вспомогательных функций и классов

каждая функция в отдельном файле

[Alexandroppolus]

tostershmoster, я говорил про отдельный файл в папке с компонентом. Например, у нас на проекте, для каждого компонента есть своя отдельная одноименная ему папка. То есть, допустим, папка Scale, а в ней файлы Scale.tsx, index.ts (в котором делается реэкспорт из Scale.tsx), и тут же, например, utils.ts, в котором всякие вспомогательные функции для Scale. Они не реэкспортятся наружу, используются только строго внутри папки Scale. То есть для всего остального кода они как бы приватные, но в то же время к ним можно написать тесты тоже внутри папки Scale. Ещё один плюс - эти функции не загромождают компонент или класс Scale, его код от этого становится понятнее.