Merge branch 'feature/duplicate-errors-clean' into develop

ovcharenko-di · Dec 2, 2020 · 6b31a15 · 6b31a15
2 parents d05cde2 + df6616b
commit 6b31a15
Show file tree

Hide file tree

Showing 30 changed files with 558 additions and 312 deletions.
diff --git a/.bsl-language-server.json b/.bsl-language-server.json
@@ -4,7 +4,7 @@
       "parameters": {
         "Typo": {
             "minWordLength": 3,
-            "userWordsToIgnore": "Логгер"
+            "userWordsToIgnore": "Логгер,Трекеры"
         }
       }
     }

diff --git a/README.md b/README.md
@@ -26,6 +26,8 @@
 - Сохранение запросов информации об ошибках, которые направляет клиентское приложение.
 - Распаковка поступающих отчетов об ошибках.
 - Автоматическая регистрация ошибок в баг-трекере (Jira, Redmine).
+- Отображение Ид задачи из баг-трекера прямо в окне 1С, если такая ошибка уже была зарегистрирована там ранее.
+- Запрет повторной регистрации одной и той же ошибки.
 - Отправка сообщений с информацией об ошибке в точку обмена RabbitMQ.
 - Отправка сообщений с информацией об ошибке в Sentry.
 
@@ -40,7 +42,7 @@
 - перейти в каталог проекта в командной строке
 - выполнить команду `'docker build -t <tag> .'`, где:
   - `<tag>` - метка образа, задается произвольно
-- выполнить команду `'docker run --name <name> -v <localPath>:<dockerPath> -p <port>:5000 <tag>'`, где:
+- выполнить команду `'docker run -d --name <name> -v <localPath>:<dockerPath> -p <port>:5000 <tag>'`, где:
   - `<name>` - имя контейнера, задается произвольно
   - `<localPath>` - локальный каталог, в котором будут храниться данные приложения
   - `<dockerPath>` - каталог внутри контейнера, в который изначально записываются данные приложения (устанавливается в `appsettings.json`)
@@ -94,7 +96,6 @@ URL, по которому доступно приложение, надо ук
 
 ## Ограничения
 
-- на данный момент приложение не умеет гибко управлять процессом регистрации ошибок. Например, на любой запрос о регистрации ошибки приложение отвечает, что ее **необходимо** регистрировать. Это значит, что если 10 пользователей столкнутся с одной и той же ошибкой, то в вашем баг-трекере может появиться 10 тикетов.
 - ошибки регистрируются в баг-трекере от имени владельца API-ключа, а не от лица пользователя информационной базы.
 - веб-интерфейс пока почти полностью состоит из заглушек.
 - какие-либо ограничения доступа на уровне веб-приложения отсутствуют. Любой, кто сможет открыть веб-интерфейс, сможет просматривать всю информацию.
@@ -108,7 +109,6 @@ URL, по которому доступно приложение, надо ук
 - поддержка СППР ред. 1 и 2 в качестве баг-трекера
 - гибкая настройка параметров регистрации ошибок
   - определение необходимости регистрации ошибки
-  - определение "дублей" ошибок
   - кастомизация сообщения, которое выводится пользователю
 - перевод приложения на библиотеку [entity](https://github.com/oscript-library/entity)
   - поддержка хранения данных во внешней БД

diff --git a/features/fixtures/data/errorInfoRequests.json b/features/fixtures/data/errorInfoRequests.json
@@ -1,7 +1,8 @@
 [
     {
-        "id": "7054dd5d-f0b8-491d-8dcc-18bc1d2cbc83",
-        "datetime": "2020-10-05T21:58:45Z",
+        "x_id": "7054dd5d-f0b8-491d-8dcc-18bc1d2cbc83",
+        "x_datetime": "2020-10-05T21:58:45Z",
+        "x_fingerprint": "1111-2222-33333333-4444",
         "configHash": "bd56b503adfc454b9fc84d7b0fea3e7900000000",
         "сonfigName": "Config1",
         "configVersion": "1.0.1.265",
@@ -15,8 +16,9 @@
         "systemcrash": ""
     },
     {
-        "id": "b4fe5366-193b-4f4b-8609-6a727b316ca5",
-        "datetime": "2020-10-06T11:20:33Z",
+        "x_id": "b4fe5366-193b-4f4b-8609-6a727b316ca5",
+        "x_datetime": "2020-10-06T11:20:33Z",
+        "x_fingerprint": "1111-2222-33333333-5555",
         "configHash": "ac83b503adfc454b9fc84d7b0fea3e7900000000",
         "сonfigName": "Config2",
         "configVersion": "1.0.1.265",
@@ -30,8 +32,9 @@
         "systemcrash": ""
     },
     {
-        "id": "2ac96a47-156b-40cf-8403-ea4e0287deba",
-        "datetime": "2020-10-06T11:29:17Z",
+        "x_id": "2ac96a47-156b-40cf-8403-ea4e0287deba",
+        "x_datetime": "2020-10-06T11:29:17Z",
+        "x_fingerprint": "1111-2222-33333333-6666",
         "configHash": "or96e421adfc454b9fc84d7b0fea3e7900000000",
         "сonfigName": "Config3",
         "configVersion": "1.0.1.265",

diff --git a/features/fixtures/data/errors.json b/features/fixtures/data/errors.json
@@ -1,6 +1,14 @@
 [
     {
         "id": "61001a5e-09d5-47b8-bf19-e7672eda10e5",
-        "datetime": "2020-10-05T21:58:45Z"
+        "datetime": "2020-10-05T21:58:45Z",
+        "fingerprint": "C0627D8FFA4A06A33D3BD77BAAED5667",
+        "external_id": "11331"
+    },
+    {
+        "id": "68359124-56e5-93aa-cd94-9531aa526f4",
+        "datetime": "2020-10-08T12:03:54Z",
+        "fingerprint": "B07F49C8154BA4E20BA3FAAD30507F25",
+        "external_id": ""
     }
 ]
diff --git a/features/fixtures/getInfoDuplicateRequest.json b/features/fixtures/getInfoDuplicateRequest.json
@@ -0,0 +1,13 @@
+{
+    "configHash": "ac83b503adfc454b9fc84d7b0fea3e7900000000",
+    "сonfigName": "Config2",
+    "configVersion": "1.0.1.265",
+    "appStackHash": "5E78AD0E93E8D3963841DFD479A597EF",
+    "clientStackHash": "84A1E9821497E377D0E1FB27C47CA522",
+    "serverStackHash": "",
+    "platformType": "Windows_x86_64",
+    "appName": "1CV8C",
+    "appVersion": "8.3.17.1549",
+    "configurationInterfaceLanguageCode": "ru",
+    "systemcrash": ""
+}
diff --git a/features/fixtures/getInfoDuplicateResponse.json b/features/fixtures/getInfoDuplicateResponse.json
@@ -0,0 +1,5 @@
+{
+    "needSendReport": false,
+    "userMessage": "Данная ошибка уже была зарегистрирована. Ид: 11331",
+    "dumpType": "0"
+}
diff --git a/features/fixtures/requestBodyGetInfo.json → features/fixtures/getInfoRequest.json b/features/fixtures/requestBodyGetInfo.json → features/fixtures/getInfoRequest.json
diff --git a/features/fixtures/getInfoResponse.json b/features/fixtures/getInfoResponse.json
@@ -0,0 +1,5 @@
+{
+    "needSendReport": true,
+    "userMessage": "Отчет об ошибке будет отправлен автоматически.",
+    "dumpType": "0"
+}
diff --git a/features/fixtures/responseBodyGetInfo.json b/features/fixtures/responseBodyGetInfo.json
diff --git a/features/fixtures/Ошибка_20201123003806.zip b/features/fixtures/Ошибка_20201123003806.zip
diff --git a/src/controllers/errorInfoRequests.os b/src/controllers/errorInfoRequests.os
@@ -1,8 +1,8 @@
 &HttpMethod("GET")
 Функция Index() Экспорт
 
-	ТаблицаЗапросовИнформацииОбОшибке = ЗапросыИнфоОбОшибке.ПолучитьСписок();
-	Возврат Представление(ТаблицаЗапросовИнформацииОбОшибке);
+	ЗапросыИнформацииОбОшибке = ЗапросыИнфоОбОшибке.ПолучитьСписок();
+	Возврат Представление(ЗапросыИнформацииОбОшибке);
 
 КонецФункции
 

diff --git a/src/controllers/errorReports.os b/src/controllers/errorReports.os
@@ -1,8 +1,8 @@
 &HttpMethod("GET")
 Функция Index() Экспорт
 
-	ТаблицаОшибок = ЗарегистрированныеОшибки.ПолучитьСписок();
-	Возврат Представление(ТаблицаОшибок);
+	СписокОтчетовОбОшибках = ОтчетыОбОшибках.ПолучитьСписок();
+	Возврат Представление(СписокОтчетовОбОшибках);
 
 КонецФункции
 

diff --git a/src/controllers/getInfo.os b/src/controllers/getInfo.os
@@ -1,5 +1,3 @@
-#использовать json
-
 &HttpMethod("POST")
 Функция Index() Экспорт
 
@@ -9,12 +7,7 @@
 	ТелоЗапросаТекст = ЧтениеТекста.Прочитать();
 	ЧтениеТекста.Закрыть();
 
-	ПарсерJSON = Новый ПарсерJSON;
-	ЗапросИнфоОбОшибке = ПарсерJSON.ПрочитатьJSON(ТелоЗапросаТекст);
-
-	ЗапросыИнфоОбОшибке.Записать(ЗапросИнфоОбОшибке);
-
-	Ответ = ЗапросыИнфоОбОшибке.СформироватьОтвет(ЗапросИнфоОбОшибке);
+	Ответ = ЗапросыИнфоОбОшибке.ОбработатьЗапрос(ТелоЗапросаТекст);
 
 	Возврат Содержимое(Ответ);
 

diff --git a/src/controllers/pushReport.os b/src/controllers/pushReport.os
@@ -7,21 +7,21 @@
 	ДанныеФормы = ЗапросHttp.ДанныеФормы;
 
 	Если ДанныеФормы = Неопределено Тогда
-		Возврат КодСостояния(200);
+		Возврат КодСостояния(400);
 	КонецЕсли;
 
 	ФайлыЗапроса = ДанныеФормы.Файлы;
 
 	Если ФайлыЗапроса = Неопределено Тогда
-		Возврат КодСостояния(200);
+		Возврат КодСостояния(400);
 	КонецЕсли;
 
 	Если ФайлыЗапроса.Количество() <> 1 Тогда
-		ВызватьИсключение("Количество файлов не равно одному");
+		Возврат КодСостояния(400);
 	КонецЕсли;
 
 	Попытка
-		ОбработкаОшибок.ОбработатьОтчетОбОшибке(ФайлыЗапроса[0]);
+		ОтчетыОбОшибках.ОбработатьОтчетОбОшибке(ФайлыЗапроса[0]);
 		Возврат КодСостояния(200);
 	Исключение
 		Сообщить(ПодробноеПредставлениеОшибки(ИнформацияОбОшибке()));

diff --git a/src/model/classes/ПровайдерИнтеграцииJira.os b/src/model/classes/ПровайдерИнтеграцииJira.os
@@ -70,7 +70,7 @@
 
 КонецФункции
 
-Процедура ЗарегистрироватьОшибку(ДанныеОтчетаОбОшибке) Экспорт
+Функция ЗарегистрироватьОшибку(ДанныеОтчетаОбОшибке) Экспорт
 
 	URLIssues = СтрШаблон("%1/issue", URL);
 
@@ -116,8 +116,13 @@
 		КонецЕсли;
 
 	КонецЕсли;
+
+	РезультатЗапросаJSON = РезультатЗапроса.JSON();
+	ИдЗадачиВТрекере = РезультатЗапросаJSON["id"];
 
-КонецПроцедуры
+	Возврат ИдЗадачиВТрекере;
+
+КонецФункции
 
 Процедура ПрикрепитьФайлКЗадаче(URL, ПрикрепляемыйФайл)
 
@@ -157,7 +162,7 @@
 	Issue.Вставить("issuetype", Новый Структура("id", ИдТипаЗадачи));
 	Issue.Вставить("summary", ТемаЗадачи);
 
-	Описание = ОбработкаОшибок.СформироватьОписаниеОшибки(ДанныеОтчетаОбОшибке);
+	Описание = ОтчетыОбОшибках.СформироватьОписаниеОшибки(ДанныеОтчетаОбОшибке);
 	Issue.Вставить("description", Описание);
 
 	ТелоЗапросаJSON = Новый Структура;

diff --git a/src/model/classes/ПровайдерИнтеграцииRabbitMQ.os b/src/model/classes/ПровайдерИнтеграцииRabbitMQ.os
@@ -60,7 +60,7 @@
 
 КонецФункции
 
-Процедура ЗарегистрироватьОшибку(ДанныеОтчетаОбОшибке) Экспорт
+Функция ЗарегистрироватьОшибку(ДанныеОтчетаОбОшибке) Экспорт
 
 	Соединение = Новый СоединениеRMQ;
 
@@ -85,12 +85,15 @@
 	КонецПопытки;
 
 	Соединение.Закрыть();
+
+	// Для провайдера RMQ не существует такого понятия как ИдЗадачиВТрекере
+	Возврат Неопределено;
 
-КонецПроцедуры
+КонецФункции
 
 Функция СформироватьТелоЗапроса(ДанныеОтчетаОбОшибке) Экспорт
 
-	Описание = ОбработкаОшибок.СформироватьТелоОписанияОшибкиJSON(ДанныеОтчетаОбОшибке);
+	Описание = ОтчетыОбОшибках.СформироватьТелоОписанияОшибкиJSON(ДанныеОтчетаОбОшибке);
 
 	ПарсерJSON = Новый ПарсерJSON();
 	Возврат ПарсерJSON.ЗаписатьJSON(Описание);

diff --git a/src/model/classes/ПровайдерИнтеграцииRedmine.os b/src/model/classes/ПровайдерИнтеграцииRedmine.os
@@ -92,7 +92,7 @@
 
 КонецФункции
 
-Процедура ЗарегистрироватьОшибку(ДанныеОтчетаОбОшибке) Экспорт
+Функция ЗарегистрироватьОшибку(ДанныеОтчетаОбОшибке) Экспорт
 
 	URLIssues = СтрШаблон("%1/issues.json", URLRedmine);
 
@@ -108,8 +108,13 @@
 	Если РезультатЗапроса.КодСостояния <> 201 Тогда
 		ВызватьИсключение("Не удалось зарегистрировать ошибку Redmine"); // TODO: сделать внятное сообщение
 	КонецЕсли;
+
+	РезультатЗапросаJSON = РезультатЗапроса.JSON();
+	ИдЗадачиВТрекере = РезультатЗапросаJSON["issue"]["id"];
 
-КонецПроцедуры
+	Возврат ИдЗадачиВТрекере;
+
+КонецФункции
 
 Функция СформироватьТелоЗапроса(ДанныеОтчетаОбОшибке) Экспорт
 
@@ -118,7 +123,7 @@
 	Issue.Вставить("tracker_id", ИдТрекера);
 	Issue.Вставить("subject", Тема);
 
-	Описание = ОбработкаОшибок.СформироватьОписаниеОшибки(ДанныеОтчетаОбОшибке);
+	Описание = ОтчетыОбОшибках.СформироватьОписаниеОшибки(ДанныеОтчетаОбОшибке);
 	Issue.Вставить("description", Описание);
 	Issue.Вставить("priority_id", ИдПриоритета);
 	Issue.Вставить("status_id", ИдСтатуса);
@@ -211,7 +216,7 @@
 
 	ПолноеИмяФайла = Файл.ПолноеИмя;
 
-	URL = СтрШаблон("%1/uploads.json?filename=", URLRedmine, ПолноеИмяФайла);
+	URL = СтрШаблон("%1/uploads.json?filename=%2", URLRedmine, ПолноеИмяФайла);
 	ПрикрепляемыйФайлДД = Новый ДвоичныеДанные(ПолноеИмяФайла);
 
 	Заголовки = Новый Соответствие;

diff --git a/src/model/classes/ПровайдерИнтеграцииSentry.os b/src/model/classes/ПровайдерИнтеграцииSentry.os
@@ -53,7 +53,7 @@
 
 КонецПроцедуры
 
-Процедура ЗарегистрироватьОшибку(ДанныеОтчетаОбОшибке) Экспорт
+Функция ЗарегистрироватьОшибку(ДанныеОтчетаОбОшибке) Экспорт
 
 	ТелоЗапроса = СформироватьТелоЗапроса(ДанныеОтчетаОбОшибке);
 
@@ -67,8 +67,11 @@
 	Если РезультатЗапроса.КодСостояния <> 200 Тогда
 		ВызватьИсключение("Не удалось отправить событие в Sentry"); // TODO: сделать внятное сообщение
 	КонецЕсли;
+
+	// В Sentry отправляется каждая ошибка
+	Возврат Неопределено;
 
-КонецПроцедуры
+КонецФункции
 
 Функция СформироватьТелоЗапроса(ДанныеОтчетаОбОшибке) Экспорт