Skip to content

Обращение к API бэкенда в команде ls -r #37

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

Merged
merged 2 commits into from
May 1, 2025

Conversation

EvilBeaver
Copy link
Member

@EvilBeaver EvilBeaver commented Apr 29, 2025

Добавлено получение удаленных версий из API oscript.io

Summary by CodeRabbit

  • Новое
    • Улучшен механизм получения списка доступных версий: теперь сначала используется API, а при недоступности — резервный способ через парсинг HTML.
  • Рефакторинг
    • Процесс получения списка версий разделён на отдельные методы для API и HTML, что повысило стабильность и читаемость.

@EvilBeaver EvilBeaver requested a review from nixel2007 April 29, 2025 20:50
Copy link

coderabbitai bot commented Apr 29, 2025

Walkthrough

Внесены изменения в функцию получения списка доступных к установке версий: теперь сначала выполняется попытка получить версии через новый API-эндпоинт (api/archive). Если API возвращает успешный ответ, используется полученный список версий. В случае неудачи выполняется парсинг HTML-страницы загрузок как резервный вариант. Для этого добавлены две новые вспомогательные функции: одна для получения версий через API, другая — для разбора HTML. Также обновлена процедура добавления строк для псевдонимов версий, добавлен комментарий TODO.

Changes

Файл Краткое описание изменений
src/core/Классы/ВерсииOneScript.os Рефакторинг функции получения списка версий: добавлены функции для получения версий через API и парсинг HTML, обновлён вызов.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ВерсииOneScript
    participant API
    participant HTML

    Client->>ВерсииOneScript: ПолучитьСписокДоступныхКУстановкеВерсий()
    ВерсииOneScript->>API: ПолучитьВерсииПоAPI()
    API-->>ВерсииOneScript: Ответ (успех/ошибка)
    alt API ответ успешен
        ВерсииOneScript-->>Client: Список версий из API
    else API ошибка
        ВерсииOneScript->>HTML: ПолучитьВерсииРазборомHTML()
        HTML-->>ВерсииOneScript: Список версий из HTML
        ВерсииOneScript-->>Client: Список версий из HTML
    end
Loading

Poem

В коде свежий ветер перемен,
Версии теперь найдём мы вмиг:
Сначала спросим API —
А если нет, то HTML подмиг.
Пусть выбор будет шире,
И пусть не спит наш кролик в мире!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 59b5e34 and 93e7498.

📒 Files selected for processing (1)
  • src/core/Классы/ВерсииOneScript.os (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/core/Классы/ВерсииOneScript.os

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (3)
src/core/Классы/ВерсииOneScript.os (3)

220-227: Явно укажите использование HTTPS и уберите «пустые» аргументы

В конструкторе HTTPСоединение передаются пять позиционных аргументов, из которых четыре — пустые, что затрудняет понимание, какой именно параметр отвечает за SSL, порт и т.д.
Предлагаю явно проставить флаг Истина для использования HTTPS и заменить пустые значения параметрами-заглушками (Неопределено), либо воспользоваться именованными параметрами (если поддерживается), чтобы читаемость не страдала.

 Соединение = Новый HTTPСоединение(
-        ПараметрыOVM.АдресСайтаОСкрипт(),
-        ,
-        ,
-        ,
-        ,
-        Таймаут
+        ПараметрыOVM.АдресСайтаОСкрипт(), // Хост
+        ,                               // Порт
+        ,                               // БазовыйПуть
+        Истина,                         // ИспользоватьSSL
+        ,                               // ЗаголовкиПоУмолчанию
+        Таймаут
 );

339-343: Возможны дубликаты алиасов из-за отсутствия проверки уникальности

Поле presentation в JSON может совпадать с уже добавленным алиасом (например, latest). При повторном добавлении строка просто продублируется, что усложнит дальнейшую обработку. Рассмотрите вариант использовать Найти() перед Добавить() или перенести логику в ОбеспечитьСтрокуВерсииПоАлиасу.


381-384: Жёстко «захардкоженная» версия 1.0.9 — технический долг

Фильтр версии 1.0.9 реализован как временное решение (TODO). Рекомендуется:

  1. Переместить исключения версий в конфигурацию или константу.
  2. Добавить ссылку на задачу/issue в комментарий (уже сделано) и установить крайний срок её удаления.

Это уменьшит вероятность того, что хак останется навсегда.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c8192ae and 59b5e34.

📒 Files selected for processing (1)
  • src/core/Классы/ВерсииOneScript.os (3 hunks)

Comment on lines 323 to 333
Запрос = Новый HTTPЗапрос("api/archive");
Ответ = Соединение.Получить(Запрос);
HTTP_OK = 200;
Если Ответ.КодСостояния <> HTTP_OK Тогда
Возврат Неопределено;
КонецЕсли;

ЧтениеJSON = Новый ЧтениеJSON();
ЧтениеJSON.УстановитьСтроку(Ответ.ПолучитьТелоКакСтроку());

ДоступныеВерсии = Новый ТаблицаЗначений;
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Нет обработки ошибок разбора JSON – возможны необработанные исключения

Если API вернёт невалидный JSON, то ПрочитатьJSON выбросит исключение и команда рухнет. Лучше перехватить ошибку и вернуть Неопределено, чтобы сработал резервный сценарий парсинга HTML.

-    ЧтениеJSON = Новый ЧтениеJSON();
-    ЧтениеJSON.УстановитьСтроку(Ответ.ПолучитьТелоКакСтроку());
+    Попытка
+        ЧтениеJSON = Новый ЧтениеJSON();
+        ЧтениеJSON.УстановитьСтроку(Ответ.ПолучитьТелоКакСтроку());
+    Исключение
+        // Логируем, но не падаем – будет попытка резервного метода
+        Лог.Ошибка("Не удалось разобрать JSON об архиве версий: %1", ОписаниеОшибки());
+        Возврат Неопределено;
+    КонецПопытки;
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Запрос = Новый HTTPЗапрос("api/archive");
Ответ = Соединение.Получить(Запрос);
HTTP_OK = 200;
Если Ответ.КодСостояния <> HTTP_OK Тогда
Возврат Неопределено;
КонецЕсли;
ЧтениеJSON = Новый ЧтениеJSON();
ЧтениеJSON.УстановитьСтроку(Ответ.ПолучитьТелоКакСтроку());
ДоступныеВерсии = Новый ТаблицаЗначений;
Запрос = Новый HTTPЗапрос("api/archive");
Ответ = Соединение.Получить(Запрос);
HTTP_OK = 200;
Если Ответ.КодСостояния <> HTTP_OK Тогда
Возврат Неопределено;
КонецЕсли;
Попытка
ЧтениеJSON = Новый ЧтениеJSON();
ЧтениеJSON.УстановитьСтроку(Ответ.ПолучитьТелоКакСтроку());
Исключение
// Логируем, но не падаем – будет попытка резервного метода
Лог.Ошибка("Не удалось разобрать JSON об архиве версий: %1", ОписаниеОшибки());
Возврат Неопределено;
КонецПопытки;
ДоступныеВерсии = Новый ТаблицаЗначений;

@@ -365,6 +405,8 @@
СтрокаВерсии.Алиас = Алиас;
КонецЕсли;

Copy link
Member

Choose a reason for hiding this comment

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

Не совсем понятно, что надо добавлять. И можно ли на это заложиться уже сейчас, чтобы не делать две версии овм под новую структуру сайта?

Copy link
Member Author

@EvilBeaver EvilBeaver Apr 29, 2025

Choose a reason for hiding this comment

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

Сейчас в качестве урла для метаверсий в выхлопе команды ls -r пишется просто /downloads, а в новой версии будет работать линк /downloads/lts и /downoads/preview.

Но если сейчас это написать в ovm то эти линки приведут на 404

Copy link
Member Author

Choose a reason for hiding this comment

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

Что, наверное, не страшно, т.к. по этим линкам все равно вряд ли кто-то ходит...

@nixel2007 nixel2007 merged commit 6077692 into develop May 1, 2025
1 check passed
@EvilBeaver EvilBeaver deleted the feature/api-based branch May 1, 2025 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants