Механизм Feature Toggle

Feature toggle — техника разработки программных продуктов. Назначение Feature toggle — возможность подключения дополнительной функциональности в работающем приложении.

В Creatio Feature toggle использует непрерывную интеграцию, которая позволяет сохранить работоспособность приложения и скрыть функциональность на стадии разработки. В исходном коде приложения присутствует блок с дополнительной функциональностью и условный оператор, который определяет состояние подключения функциональности.

Понятие Feature toggle описано на Википедии.

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

Сведения о функциональности хранятся в базе данных приложения.

Таблицы базы данных, которые хранят информацию о функциональности:

• [Feature] — перечень функциональности, которая доступна для подключения/отключения. По умолчанию таблица пуста.
• [AdminUnitFeatureState] (колонка [FeatureState]) — информация о состоянии функциональности (подключена/отключена). Таблица [AdminUnitFeatureState] связывает таблицы [Feature] и [SysAdminUnit] базы данных. Таблица [SysAdminUnit] содержит информацию о пользователях и группах пользователей приложения.

Диаграмма взаимосвязи таблиц базы данных, которые хранят информацию о функциональности, представлена на рисунке ниже.

Основные колонки таблицы [Feature] базы данных приведены в таблице ниже.

Основные колонки таблицы [AdminUnitFeatureState] базы данных приведены в таблице ниже.

Подключить дополнительную функциональность 

Способы подключения дополнительной функциональности:

• Для текущего пользователя приложения.
• Для всех пользователей приложения.

Подключить функциональность для текущего пользователя приложения 

1. Перейдите на страницу Функциональность (Features), которая используется для точечного подключения функциональности.

   [Адрес приложения]/0/Nui/ViewModule.aspx#BaseSchemaModuleV2/FeaturesPage
   

   http://myсreatio.com/0/Nui/ViewModule.aspx#BaseSchemaModuleV2/FeaturesPage
   

2. Переключите соответствующий переключатель функциональности, которую планируется подключить.
3. Нажмите кнопку Сохранить изменения (Save changes).

Всплывающая подсказка отображает статус функциональности для группы пользователей, в которую входит текущий пользователь. Подключение функциональности для текущего пользователя не меняет ее статус для группы пользователей. Т. е. для текущего пользователя создается дополнительное правило приоритет которого выше, чем приоритет правила для группы пользователей, в которую входит текущий пользователь.

Пример страницы Функциональность (Features) приведен на рисунке ниже.

Подключить функциональность для всех пользователей приложения 

Чтобы подключить функциональность для всех пользователей приложения, выполните SQL-запрос к базе данных, который приведен ниже.

DECLARE @featureCode varchar(max) = 'NewEmailSettingsWithoutAutoSynchronization', @featureId uniqueidentifier;
set @featureId = (select top 1 Id from Feature where Code = @featureCode);
IF @featureId is null
    BEGIN
        insert into Feature
            (Name, Code)
        values
            (@featureCode, @featureCode);
        set @featureId = (select top 1 Id from Feature where Code = @featureCode);
    END;
delete from AdminUnitFeatureState where FeatureId = @featureId;
insert into AdminUnitFeatureState
    (SysAdminUnitId, FeatureState, FeatureId)
    values
        ('A29A3BA5-4B0D-DE11-9A51-005056C00008', 1, @featureId),
        ('720B771C-E7A7-4F31-9CFB-52CD21C3739F', 1, @featureId);

do $$
    DECLARE
        featureCode varchar(100) = 'EmailIntegrationV2';
        featureId UUID;
    BEGIN
        featureId = (select "Id" from "Feature" where "Code" = featureCode limit 1);
        IF featureId is null THEN
            insert into "Feature"
                ("Name", "Code")
            values
                (featureCode, featureCode);
            featureId = (select "Id" from "Feature" where "Code" = featureCode limit 1);
        end IF;
    delete from "AdminUnitFeatureState" where "FeatureId" = featureId;
    insert into "AdminUnitFeatureState"
        ("SysAdminUnitId", "FeatureState", "FeatureId")
        values
            ('A29A3BA5-4B0D-DE11-9A51-005056C00008', 1, featureId),
            ('720B771C-E7A7-4F31-9CFB-52CD21C3739F', 1, featureId);
end $$;

DECLARE
    existObject NUMBER := 0;
    v_featurecode VARCHAR2(50) := 'LoadAttachmentsInSameProcess';
    v_featureid VARCHAR2(38);
BEGIN
    SELECT COUNT(1) INTO existObject FROM "Feature" WHERE "Code" = v_featurecode;
    if existObject = 0 THEN 
        INSERT INTO "Feature" ("Name", "Code") VALUES (:v_featurecode, :v_featurecode);
    END IF; 
SELECT "Id" INTO v_featureid FROM "Feature" WHERE "Code" = v_featurecode AND rownum <= 1;
DELETE FROM "AdminUnitFeatureState" WHERE "FeatureId" = v_featureid;
INSERT INTO "AdminUnitFeatureState" ("SysAdminUnitId", "FeatureState", "FeatureId") 
    VALUES ('{A29A3BA5-4B0D-DE11-9A51-005056C00008}', 1, v_featureid);
END;
/

featureCode — переменная, которая содержит необходимое имя функциональности.

С помощью SQL-запроса Creatio позволяет подключить функциональность для группы пользователей и отключить функциональность для текущего пользователя и наоборот.

Чтобы отключить функциональность для всех пользователей приложения, выполните SQL-запрос к базе данных, в котором для колонки [FeatureState] таблицы [AdminUnitFeatureState] установите значение 0.

Реализовать пользовательскую функциональность 

1. Добавьте пользовательскую функциональность.

   1. Перейдите на страницу Функциональность (Features), которая используется для точечного подключения функциональности.

   2. Заполните свойства добавляемой функциональности:

      • Код функциональности (Feature code) — код пользовательской функциональности, которую планируется добавить (обязательное свойство).
      • Имя функциональности (Feature name) — имя пользовательской функциональности, которую планируется добавить.
      • Описание функциональности (Feature description) — описание пользовательской функциональности, которую планируется добавить.
      
   3. Нажмите кнопку Добавить функциональность (Create feature).

   В результате пользовательская функциональность добавлена в реестр страницы Функциональность (Features).

   

2. Реализуйте пользовательскую функциональность в исходном коде. Пользовательская функциональность определяется в блоке условного оператора, который проверяет состояние подключения функциональности (колонка [FeatureState] таблицы [AdminUnitFeatureState]).

   Варианты реализации пользовательской функциональности:

   • На front-end стороне. Для этого воспользуйтесь инструкцией, которая приведена в пункте Реализовать пользовательскую функциональность (front-end).
   • На back-end стороне. Для этого воспользуйтесь инструкцией, которая приведена в пункте Реализовать пользовательскую функциональность (back-end).

Реализовать пользовательскую функциональность (front-end) 

1. Создайте схему модели представления. Для этого воспользуйтесь инструкцией, которая приведена в статье Клиентский модуль.

2. В дизайнере модуля добавьте исходный код. Для этого используйте шаблон, который приведен ниже.

   Шаблон реализации пользовательской функциональности

   /* Метод, в котором определяется дополнительная функциональность. */
   someMethod: function() {
       /* Проверка подключения функциональности. */
       if (Terrasoft.Features.getIsEnabled("КодФункциональности")) {
           /* Реализация дополнительной функциональности. */
           ...
       }
       /* Реализация метода. */
       ...
   }
   

   Для удобства использования в базовой схеме BaseSchemaViewModel модели представления определен метод getIsFeatureEnabled. Поэтому можно заменить метод Terrasoft.Features.getIsEnabled на this.getIsFeatureEnabled("КодФункциональности").

3. На панели инструментов дизайнера модуля нажмите Сохранить (Save).

Чтобы пользовательская функциональность отобразилась в клиентском коде и загружалась браузером на front-end стороне, обновите страницу.

Реализовать пользовательскую функциональность (back-end) 

1. Создайте схему исходного кода. Для этого воспользуйтесь инструкцией, которая приведена в статье Исходный код.

2. В дизайнере исходного кода добавьте исходный код.

   Класс Terrasoft.Configuration.FeatureUtilities предоставляет набор расширяющих методов класса UserConnection, которые позволяют использовать функциональность Feature toggle в схемах исходного кода на back-end стороне приложения. Для этого используйте шаблон, который приведен ниже.

   Шаблон реализации пользовательской функциональности

   ...
   /* Пространство имен, в котором определена возможность переключения дополнительной функциональности. */
   using Terrasoft.Configuration;
   ...
   /* Метод, в котором будет определяться дополнительная функциональность. */
   public void AnyMethod() {
       /* Проверка, подключена ли функциональность. */
       if (UserConnection.GetIsFeatureEnabled("КодФункциональности")) {
           /* Реализация дополнительной функциональности. */
       }
       /* Реализация метода. */
       ...
   }
   

3. Установите состояние функциональности, вызвав метод SetFeatureState. Для этого используйте шаблон, который приведен ниже.

   Шаблон вызова метода SetFeatureState

   UserConnection.SetFeatureState("КодФункциональности", FeatureState);