From 1f69722bdd030c212bf8a8848ddaa8408a89b3b4 Mon Sep 17 00:00:00 2001
From: Jorge Martin Espinosa <jorgem@element.io>
Date: Fri, 5 Jul 2024 15:15:18 +0200
Subject: [PATCH] Remove Showkase processor not found warning from Danger
 (#3148)

Instead create a new rule to check if the package name is included in `ComposablePreviewProvider`.
---
 .../kotlin/base/ComposablePreviewProvider.kt  | 20 +++++----
 tools/danger/dangerfile.js                    | 44 ++++++++++++++-----
 2 files changed, 43 insertions(+), 21 deletions(-)

diff --git a/tests/uitests/src/test/kotlin/base/ComposablePreviewProvider.kt b/tests/uitests/src/test/kotlin/base/ComposablePreviewProvider.kt
index a35d863671..5267ca6ba9 100644
--- a/tests/uitests/src/test/kotlin/base/ComposablePreviewProvider.kt
+++ b/tests/uitests/src/test/kotlin/base/ComposablePreviewProvider.kt
@@ -23,18 +23,20 @@ import sergio.sastre.composable.preview.scanner.android.AndroidComposablePreview
 import sergio.sastre.composable.preview.scanner.android.AndroidPreviewInfo
 import sergio.sastre.composable.preview.scanner.core.preview.ComposablePreview
 
+// Make sure we don't import Compound previews by mistake
+private val PACKAGE_TREES = arrayOf(
+    "io.element.android.features",
+    "io.element.android.libraries",
+    "io.element.android.services",
+    "io.element.android.appicon",
+    "io.element.android.appnav",
+    "io.element.android.x",
+)
+
 object ComposablePreviewProvider : TestParameter.TestParameterValuesProvider {
     private val values: List<IndexedValue<ComposablePreview<AndroidPreviewInfo>>> by lazy {
         AndroidComposablePreviewScanner()
-            .scanPackageTrees(
-                "io.element.android.features",
-                "io.element.android.libraries",
-                "io.element.android.services",
-                "io.element.android.appicon",
-                "io.element.android.appnav",
-                "io.element.android.x",
-                // Make sure we don't import Compound previews by mistake
-            )
+            .scanPackageTrees(*PACKAGE_TREES)
             .getPreviews()
             .withIndex()
             .toList()
diff --git a/tools/danger/dangerfile.js b/tools/danger/dangerfile.js
index 024e661c67..ae8c4cf002 100644
--- a/tools/danger/dangerfile.js
+++ b/tools/danger/dangerfile.js
@@ -125,19 +125,39 @@ const filesWithPreviews = editedFiles.filter(file => file.endsWith(".kt")).filte
     return previewAnnotations.some((ann) => content.includes(ann));
 })
 
-const buildFilesWithMissingProcessor = filesWithPreviews.map(file => {
-    let parent = path.dirname(file);
-    while (fs.statSync(path.join(parent, 'build.gradle.kts'), {throwIfNoEntry: false}) === undefined) {
-        parent = path.dirname(parent);
-    }
-    return path.join(parent, 'build.gradle.kts');
-}).filter((value, index, array) => array.indexOf(value) === index).filter(buildFile => {
-    const content = fs.readFileSync(buildFile);
-    return !content.includes('ksp(libs.showkase.processor)');
-})
+const composablePreviewProviderContents = fs.readFileSync('tests/uitests/src/test/kotlin/base/ComposablePreviewProvider.kt');
+const packageTreesRegex = /private val PACKAGE_TREES = arrayOf\(([\w\W]+?)\n\)/gm;
+const packageTreesMatch = packageTreesRegex.exec(composablePreviewProviderContents)[1];
+const scannedPreviewPackageTrees = packageTreesMatch
+    .replaceAll("\"", "")
+    .replaceAll(",", "")
+    .split('\n').map((line) => line.trim())
+    .filter((line) => line.length > 0);
 
-if (buildFilesWithMissingProcessor.length > 0) {
-    warn("You have made changes to a file containing a `@Preview` annotated function but its module doesn't include the showkase processor. Missing processor in: " + buildFilesWithMissingProcessor.join(", "))
+const previewPackagesNotIncludedInScreenshotTests = filesWithPreviews.map((file) => {
+    const content = fs.readFileSync(file);
+    const packageRegex = /package\s+([a-zA-Z0-9.]+)/;
+    const packageMatch = packageRegex.exec(content);
+
+    if (!packageMatch || packageMatch.length != 2) {
+        return null;
+    }
+
+    return packageMatch[1];
+
+
+}).filter((package) => {
+    if (!package) {
+        return false;
+    }
+    if (!scannedPreviewPackageTrees.some((prefix) => package.includes(prefix))) {
+        return true;
+    }
+});
+
+if (previewPackagesNotIncludedInScreenshotTests.length > 0) {
+    const packagesList = previewPackagesNotIncludedInScreenshotTests.map((p) => '- `' + p + '`').join("\n");
+    warn("You have made changes to a file containing a `@Preview` annotated function but its package name prefix is not included in the `ComposablePreviewProvider`.\nPackages missing in `tests/uitests/src/test/kotlin/base/ComposablePreviewProvider.kt`: \n" + packagesList);
 }
 
 // Check for pngs on resources