Mob 36982 support android studio iguana (#105)

* [MOB-36982] Добавляет поддержку новой версии Android Studio * [MOB-36982] Добавляет поддержку новой версии Android Studio в build-скриптах * [MOB-36982] Добавляет документацию про поддержку новой версии Android Studio * [MOB-36982] Обновляет версии плагинов и их changelog * [MOB-36982] Исправляет замечания detekt * [MOB-36982] Немного исправляет документацию
hhru · Mar 4, 2024 · e45f1a1 · e45f1a1
1 parent 5678e28
commit e45f1a1
Show file tree

Hide file tree

Showing 17 changed files with 219 additions and 10 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -3,8 +3,8 @@ on: [pull_request, workflow_call]
 
 env:
   # Link for Linux zip file from https://developer.android.com/studio/archive
-  ANDROID_STUDIO_URL: https://redirector.gvt1.com/edgedl/android/studio/ide-zips/2023.1.1.26/android-studio-2023.1.1.26-linux.tar.gz
-  COMPILER_VERSION: 231.9392.1
+  ANDROID_STUDIO_URL: https://redirector.gvt1.com/edgedl/android/studio/ide-zips/2023.2.1.23/android-studio-2023.2.1.23-linux.tar.gz
+  COMPILER_VERSION: 232.10227.8
 
 jobs:
   build:

diff --git a/.github/workflows/release_build.yml b/.github/workflows/release_build.yml
@@ -7,8 +7,8 @@ on:
 
 env:
   # Link for Linux zip file from https://developer.android.com/studio/archive
-  ANDROID_STUDIO_URL: https://redirector.gvt1.com/edgedl/android/studio/ide-zips/2023.1.1.26/android-studio-2023.1.1.26-linux.tar.gz
-  COMPILER_VERSION: 231.9392.1
+  ANDROID_STUDIO_URL: https://redirector.gvt1.com/edgedl/android/studio/ide-zips/2023.2.1.23/android-studio-2023.2.1.23-linux.tar.gz
+  COMPILER_VERSION: 232.10227.8
 
 jobs:
   build:

diff --git a/docs/geminio/geminio_support_new_android_studio.md b/docs/geminio/geminio_support_new_android_studio.md
@@ -0,0 +1,177 @@
+# Обновление Geminio до новой версии Android Studio
+
+Плагин Geminio требует обновления для каждой версии Android Studio. Дело в том, что он основан на некоторых внутренних
+API Android Studio, которые иногда меняются, иногда переносятся из одного пакета в другой, а иногда остаются неизменными
+от версии к версии.
+
+Этот документ будет небольшой инструкцией для тех, кто хочет самостоятельно обновить плагин под новую версию IDE.
+
+> [!info]
+>
+> Важно! Инструкция актуальна для пользователей MacOs, на других операционных системах могут быть отличия.
+>
+
+## Первые шаги
+
+1. Установить новую версию Android Studio. Это можно сделать через
+   приложение [JetBrains Toolbox](https://www.jetbrains.com/toolbox-app/).
+
+2. Открываем окно `About` у новой версии.
+
+![Путь до окна `About` из главного меню - часть I](./img/about_android_studio_part_1.png)
+
+![Путь до окна `About` из главного меню - часть II](./img/about_android_studio_part_2.png)
+
+3. Из этого окна узнаем обновлённую версию билда Android Studio. Ищем строчку вида `AI-232.10227.8.2321.11479570`, из
+   неё
+   берём первые три цифры, разделённые точками (в данном случае - "232.10227.8").
+
+![Версия Android Studio](./img/android_studio_version.png)
+
+4. Идём в корневой файл `gradle.properties` и локально меняем старую версию компилятора и путь к локально установленной
+   Android Studio.
+
+```properties
+systemProp.androidStudioPath=/Users/p.strelchenko/Applications/Android\ Studio\ Iguana\ 2023.2.1.app/Contents
+systemProp.androidStudioCompilerVersion=232.10227.8
+```
+
+5. Пытаемся запустить плагин `Geminio`. Желательно заранее подготовить проект с шаблонами (обоих типов: и новых модулей,
+   и новых файлов).
+
+6. Если API никак не поменялось, то запуск пройдёт успешно, все шаблоны будут работать корректно.
+
+## Тестирование Geminio
+
+Что обязательно нужно перепроверить:
+
+- [ ] Создание новых файлов через geminio-шаблон.
+    - [ ] Если в проекте настроена VCS, то создание новых файлов должно предложить добавить новые файлы в VCS.
+- [ ] Добавление зависимостей в `dependencies` блок через geminio-шаблон.
+    - [ ] Проверяем дополнительно, что если зависимость уже есть в `dependencies` блоке, то она не добавится.
+- [ ] Создание новых модулей через geminio-шаблон.
+    - [ ] Geminio должен предложить добавить новый модуль в существующий application-модуль.
+
+## Если API не поменялось
+
+В самом простом случае первые же шаги инструкции сработают корректно. В этом случае нужно проделать следующие действия:
+
+0. Создаём новую ветку в репозитории
+
+1. Перепроверить, что плагины `Carnival` и `Garcon` тоже собираются корректно. Для этого можно запустить
+   специальный `Run configuration`, который называется `Build all plugins`.
+
+2. Вернуть обратно значение `systemProp.androidStudioPath`, локальное изменение коммитить нельзя.
+
+3. Вернуть обратно значение `systemProp.androidStudioCompilerVersion` и заменить все строки в проекте со старой версией
+   Android Studio на новую версию.
+
+4. Обновить URL для новой версии Android Studio в файлах `.github/build.yml` и `.github/release_build.yml`
+
+Для этого ищите свойство "ANDROID_STUDIO_URL". Ссылку на актуальный архив следует
+искать [на этой странице](https://developer.android.com/studio/archive). Ищем нужную версию, копируем ссылку
+на `Zip files -> Linux`, заменяем старую ссылку на новую.
+
+![Ссылки на архивы дистрибутивов Android Studio](./img/android_studio_archives.png)
+
+5. Обновляем версии плагинов
+
+У каждого плагина есть свой собственный файл `gradle.properties`. Обновите версию каждого плагина (ищите по
+строке `pluginVersion=`). Мы меняем минорную версию версию, когда добавляем поддержку новой Android Studio (вторая
+цифра).
+
+6. Дописываем changelog для каждого плагина
+
+У каждого плагина есть свой собственный файл `CHANGELOG.md`. Допишите, что поддержали новую версию Android Studio.
+
+7. Делаем PR из ветки в `master`-ветку.
+
+## Если изменилось API Android Studio
+
+Ситуация, когда при обновлении на новую версию Android Studio ломается использование внутренних API, к сожалению, не
+такая уж и редкая. Что может произойти?
+
+### Проект перестал компилироваться.
+
+1. Поменялся набор аргументов в вызываемых функциях.
+2. Поменялся порядок следования аргументов в вызываемых функциях.
+
+Это, обычно, исправляется легко: синхронизируем проект, чтобы убедиться, что подтянули свежие
+исходники из локальной Android Studio, смотрим на обновившуюся сигнатуру функции, исправляем.
+
+Например, класс `YamlUtils` не менялся с первого релиза `Geminio`, но в `Android Studio Iguana | 2023.2.1` обновилась
+версия библиотеки `snakeyaml`, поэтому потребовались изменения кода.
+
+Было:
+
+```kotlin
+val yaml = Yaml(
+    CustomClassLoaderConstructor(
+        T::class.java,
+        T::class.java.classLoader
+    )
+)
+```
+
+Стало:
+
+```kotlin
+val yaml = Yaml(
+    CustomClassLoaderConstructor(
+        T::class.java,
+        T::class.java.classLoader,
+        LoaderOptions(),
+    )
+)
+```
+
+3. Свойство, функция были перенесены в другой пакет.
+
+Такое тоже обычно исправляется просто: удаляем из `import` блока строку, вызывающую проблему, с помощью автоимпорта IDE
+исправляем ошибку.
+
+4. Используемый класс был перенесён в другой пакет.
+
+В истории Geminio было такое: до версии `Android Studio Chipmunk` класс `StudioWizardDialogBuilder` лежал в
+пакете `com.android.tools.idea.ui.wizard`, после этой версии класс перенесли в
+пакет `com.android.tools.idea.wizard.ui.StudioWizardDialogBuilder`.
+
+Чтобы сохранить обратную совместимость плагина `Geminio`, приходится делать интересные хаки компиляции:
+
+- Создавать модуль с stub-классами для Android Studio (ищи модуль `shared:core:android-studio-stubs`).
+- Подключать этот модуль через `compileOnly` к основному модулю плагинов.
+- В рантайме определять наличие класса по его FQCN (для примера смотри класс `StudioWizardDialogFactory`).
+
+### Проект крашится в рантайме
+
+В этом случае нужно разбирать каждую проблему отдельно. Иногда это получается просто, но чаще всего требуется
+дополнительное погружение в исходники Android Studio. В этом случае рекомендуется
+открывать [исходники Android-проектов](https://cs.android.com/) и искать по названию класса, который упал.
+
+Например, при обновлении на `Android Studio Iguana` перестали работать шаблоны новых модулей. IDE показала stacktrace:
+при вызове `com.android.tools.idea.npw.template.ProjectTemplateDataBuilder.build` произошёл `NullPointerException`.
+
+Пытаемся разобраться (скорее всего потребуется работа с дебаггером), в итоге находим ошибку: начиная
+с `Android Studio Iguana` требуется устанавливать свойство `agpVersion` в `ProjectTemplateDataBuilder`.
+
+```kotlin
+builder.agpVersion = AgpVersions.latestKnown
+```
+
+> А почему разбираемся не через исходники внутри IDE, тут же можно посмотреть и использования классов и переходы можно
+> осуществлять?
+
+Потому что при подключении локальной версии Android Studio исходники с документацией превращаются в декомпилированные
+исходники с потерей большой доли информации. По ним практически невозможно ни в чём разобраться. А если подключать "
+актуальную версию Android Studio" не локально, то можно столкнуться с тем, что исходники `Android Studio`, которую
+вы хотите поддержать, и исходники `Android Studio`, которую скачает `gradle-intellij-plugin`, окажутся
+**НЕ ЭКВИВАЛЕНТНЫ**. С другой стороны, вам может повезти и исходники будут похожи на правду.
+
+Как подключить нужную версию:
+
+- Заходим в файл `ExternalLibrariesExtension`.
+- Находим там `enum class PredefinedIdeProducts`.
+- По аналогии с другими элементами создаём описание нужной вам версии `Android Studio`.
+- Меняем свойство `val chosenIdeaVersion: Product = PredefinedIdeProducts.ANDROID_STUDIO_IGUANA.product`.
+- И добиваемся синхронизации проекта (компиляция и запуск необязательны, хотя бы синхронизация, чтобы получить доступ к
+  исходникам).
diff --git a/docs/geminio/img/about_android_studio_part_1.png b/docs/geminio/img/about_android_studio_part_1.png
diff --git a/docs/geminio/img/about_android_studio_part_2.png b/docs/geminio/img/about_android_studio_part_2.png
diff --git a/docs/geminio/img/android_studio_archives.png b/docs/geminio/img/android_studio_archives.png
diff --git a/docs/geminio/img/android_studio_version.png b/docs/geminio/img/android_studio_version.png
diff --git a/gradle.properties b/gradle.properties
@@ -11,7 +11,7 @@ systemProp.kotlinVersion=1.9.21
 systemProp.detektVersion=1.23.4
 
 systemProp.androidStudioPath=/Applications/Android Studio.app/Contents
-systemProp.androidStudioCompilerVersion=231.9392.1
+systemProp.androidStudioCompilerVersion=232.10227.8
 systemProp.androidStudioPluginsNames=org.jetbrains.android,org.jetbrains.kotlin,com.intellij.java,org.intellij.groovy,Git4Idea,org.intellij.intelliLang
 
 # Opt-out flag for bundling Kotlin standard library -> https://plugins.jetbrains.com/docs/intellij/kotlin.html#kotlin-standard-library

diff --git a/libraries/src/main/kotlin/ru/hh/plugins/ExternalLibrariesExtension.kt b/libraries/src/main/kotlin/ru/hh/plugins/ExternalLibrariesExtension.kt
@@ -74,7 +74,20 @@ abstract class ExternalLibrariesExtension @Inject constructor(private val provid
         ) : Product()
     }
 
-    enum class PredefinedIdeProducts(val product: Product.ICBasedIde) {
+    @Suppress("detekt.StringLiteralDuplication")
+    enum class PredefinedIdeProducts(val product: Product) {
+        ANDROID_STUDIO_IGUANA(
+            Product.ICBasedIde(
+                ideVersion = "232.10227.8",
+                pluginsNames = listOf(
+                    "android",
+                    "Kotlin",
+                    "java",
+                    "Groovy",
+                )
+            )
+        ),
+
         ANDROID_STUDIO_ARCTIC_FOX(
             Product.ICBasedIde(
                 ideVersion = "202.7660.26",

diff --git a/plugins/hh-carnival/CHANGELOG.md b/plugins/hh-carnival/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Carnival
 
+## [1.7.0]
+### Added
+- Support for Android Studio Iguana | 2023.2.1
+
 ## [1.6.0]
 ### Added
 - Support for Android Studio Hedgehog | 2023.1.1

diff --git a/plugins/hh-carnival/gradle.properties b/plugins/hh-carnival/gradle.properties
@@ -1,4 +1,4 @@
-pluginVersion=1.6.0
+pluginVersion=1.7.0
 
 pluginGroup=ru.hh.plugins
 pluginName=hh-carnival

diff --git a/plugins/hh-garcon/CHANGELOG.md b/plugins/hh-garcon/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Garcon
 
+## [1.6.0]
+### Added
+- Support for Android Studio Iguana | 2023.2.1
+
 ## [1.5.0]
 ### Added
 - Support for Android Studio Hedgehog | 2023.1.1

diff --git a/plugins/hh-garcon/gradle.properties b/plugins/hh-garcon/gradle.properties
@@ -1,4 +1,4 @@
-pluginVersion=1.5.0
+pluginVersion=1.6.0
 
 pluginGroup=ru.hh.plugins
 pluginName=hh-garcon

diff --git a/plugins/hh-geminio/CHANGELOG.md b/plugins/hh-geminio/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Geminio
 
+## [1.8.0]
+### Added
+- Support for Android Studio Iguana | 2023.2.1
+
 ## [1.7.0]
 ### Added
 - Support for Android Studio Hedgehog | 2023.1.1

diff --git a/plugins/hh-geminio/gradle.properties b/plugins/hh-geminio/gradle.properties
@@ -1,4 +1,4 @@
-pluginVersion=1.7.0
+pluginVersion=1.8.0
 
 pluginGroup=ru.hh.plugins
 pluginName=hh-geminio

diff --git a/...in/kotlin/ru/hh/plugins/geminio/services/templates/GeminioRecipeExecutorFactoryService.kt b/...in/kotlin/ru/hh/plugins/geminio/services/templates/GeminioRecipeExecutorFactoryService.kt
@@ -1,5 +1,6 @@
 package ru.hh.plugins.geminio.services.templates
 
+import com.android.tools.idea.gradle.plugin.AgpVersions
 import com.android.tools.idea.npw.template.ModuleTemplateDataBuilder
 import com.android.tools.idea.npw.template.ProjectTemplateDataBuilder
 import com.android.tools.idea.templates.recipe.DefaultRecipeExecutor
@@ -76,6 +77,10 @@ class GeminioRecipeExecutorFactoryService(
             .also { builder ->
                 builder.applicationPackage = packageName
                 builder.language = Language.Kotlin
+
+                // Starting from Android Studio Iguana this property is required
+                builder.agpVersion = AgpVersions.latestKnown
+
                 builder.setProjectDefaults(project)
             }
 

diff --git a/shared/core/utils/src/main/kotlin/ru/hh/plugins/utils/yaml/YamlUtils.kt b/shared/core/utils/src/main/kotlin/ru/hh/plugins/utils/yaml/YamlUtils.kt
@@ -1,5 +1,6 @@
 package ru.hh.plugins.utils.yaml
 
+import org.yaml.snakeyaml.LoaderOptions
 import org.yaml.snakeyaml.Yaml
 import org.yaml.snakeyaml.constructor.CustomClassLoaderConstructor
 import java.io.File
@@ -14,7 +15,8 @@ object YamlUtils {
             val yaml = Yaml(
                 CustomClassLoaderConstructor(
                     T::class.java,
-                    T::class.java.classLoader
+                    T::class.java.classLoader,
+                    LoaderOptions(),
                 )
             )