MINOR [GEN-799]: add option to disable manual trigger using scheduleT…

…ype (#17031) * fix: raise for triggering system app * added scheduleType ScheduledOrManual
open-metadata · Jul 24, 2024 · 89b8b95 · 89b8b95
1 parent 0cb41f1
commit 89b8b95
Show file tree

Hide file tree

Showing 11 changed files with 67 additions and 9 deletions.
diff --git a/bootstrap/sql/migrations/native/1.5.0/mysql/postDataMigrationSQLScript.sql b/bootstrap/sql/migrations/native/1.5.0/mysql/postDataMigrationSQLScript.sql
@@ -22,4 +22,13 @@ WHERE name IN (
     'columnValuesSumToBeBetween',
     'columnValuesToBeBetween',
     'tableRowCountToBeBetween'
-);
+);
+
+-- Update schedule type for applications
+UPDATE installed_apps
+SET json = JSON_MERGE_PATCH(json, '{"scheduleType": "ScheduledOrManual"}')
+WHERE JSON_UNQUOTE(json->'$.scheduleType') = 'Scheduled';
+
+-- recreate all scheduled apps
+DELETE FROM apps_marketplace
+WHERE JSON_UNQUOTE(json->'$.scheduleType') = 'Scheduled';
diff --git a/bootstrap/sql/migrations/native/1.5.0/postgres/postDataMigrationSQLScript.sql b/bootstrap/sql/migrations/native/1.5.0/postgres/postDataMigrationSQLScript.sql
@@ -23,3 +23,11 @@ WHERE name IN (
     'tableRowCountToBeBetween'
 );
 
+-- Update schedule type for applications
+UPDATE installed_apps
+SET json = json || '{"scheduleType": "ScheduledOrManual"}'
+WHERE json->>'scheduleType' = 'Scheduled';
+
+-- recreate all scheduled apps
+DELETE FROM apps_marketplace
+WHERE json->>'scheduleType' = 'Scheduled';
diff --git a/...tadata-service/src/main/java/org/openmetadata/service/apps/AbstractNativeApplication.java b/...tadata-service/src/main/java/org/openmetadata/service/apps/AbstractNativeApplication.java
@@ -2,7 +2,7 @@
 
 import static org.openmetadata.service.apps.scheduler.AbstractOmAppJobListener.JOB_LISTENER_NAME;
 import static org.openmetadata.service.apps.scheduler.AppScheduler.APP_NAME;
-import static org.openmetadata.service.exception.CatalogExceptionMessage.LIVE_APP_SCHEDULE_ERR;
+import static org.openmetadata.service.exception.CatalogExceptionMessage.NO_MANUAL_TRIGGER_ERR;
 
 import java.util.List;
 import lombok.Getter;
@@ -90,13 +90,13 @@ public void install() {
   @Override
   public void triggerOnDemand() {
     // Validate Native Application
-    if (app.getScheduleType().equals(ScheduleType.Scheduled)) {
+    if (app.getScheduleType().equals(ScheduleType.ScheduledOrManual)) {
       AppRuntime runtime = getAppRuntime(app);
       validateServerExecutableApp(runtime);
       // Trigger the application
       AppScheduler.getInstance().triggerOnDemandApplication(app);
     } else {
-      throw new IllegalArgumentException(LIVE_APP_SCHEDULE_ERR);
+      throw new IllegalArgumentException(NO_MANUAL_TRIGGER_ERR);
     }
   }
 

diff --git a/...ata-service/src/main/java/org/openmetadata/service/exception/CatalogExceptionMessage.java b/...ata-service/src/main/java/org/openmetadata/service/exception/CatalogExceptionMessage.java
@@ -99,7 +99,7 @@ public final class CatalogExceptionMessage {
   public static final String TOKEN_EXPIRY_ERROR =
       "Email Verification Token %s is expired. Please issue a new request for email verification.";
   public static final String INVALID_BOT_USER = "Revoke Token can only be applied to Bot Users.";
-  public static final String LIVE_APP_SCHEDULE_ERR = "Live Application cannot scheduled.";
+  public static final String NO_MANUAL_TRIGGER_ERR = "App does not support manual trigger.";
   public static final String INVALID_APP_TYPE = "Application Type is not valid.";
 
   private CatalogExceptionMessage() {}

diff --git a/...ervice/src/main/resources/json/data/appMarketPlaceDefinition/DataInsightsApplication.json b/...ervice/src/main/resources/json/data/appMarketPlaceDefinition/DataInsightsApplication.json
@@ -9,7 +9,7 @@
   "developerUrl": "https://www.getcollate.io",
   "privacyPolicyUrl": "https://www.getcollate.io",
   "supportEmail": "support@getcollate.io",
-  "scheduleType": "Scheduled",
+  "scheduleType": "ScheduledOrManual",
   "permission": "All",
   "className": "org.openmetadata.service.apps.bundles.insights.DataInsightsApp",
   "runtime": {

diff --git a/.../src/main/resources/json/data/appMarketPlaceDefinition/DataInsightsReportApplication.json b/.../src/main/resources/json/data/appMarketPlaceDefinition/DataInsightsReportApplication.json
@@ -9,7 +9,7 @@
   "developerUrl": "https://www.getcollate.io",
   "privacyPolicyUrl": "https://www.getcollate.io",
   "supportEmail": "support@getcollate.io",
-  "scheduleType": "Scheduled",
+  "scheduleType": "ScheduledOrManual",
   "permission": "All",
   "className": "org.openmetadata.service.apps.bundles.insights.DataInsightsReportApp",
   "runtime": {

diff --git a/...vice/src/main/resources/json/data/appMarketPlaceDefinition/SearchIndexingApplication.json b/...vice/src/main/resources/json/data/appMarketPlaceDefinition/SearchIndexingApplication.json
@@ -9,7 +9,7 @@
   "developerUrl": "https://www.getcollate.io",
   "privacyPolicyUrl": "https://www.getcollate.io",
   "supportEmail": "support@getcollate.io",
-  "scheduleType": "Scheduled",
+  "scheduleType": "ScheduledOrManual",
   "permission": "All",
   "className": "org.openmetadata.service.apps.bundles.searchIndex.SearchIndexApp",
   "runtime": {

diff --git a/...adata-service/src/test/java/org/openmetadata/service/resources/apps/AppsResourceTest.java b/...adata-service/src/test/java/org/openmetadata/service/resources/apps/AppsResourceTest.java
@@ -108,6 +108,14 @@ void post_trigger_app_200() throws HttpResponseException, InterruptedException {
     }
   }
 
+  @Test
+  void post_trigger_no_trigger_app_400() {
+    assertResponseContains(
+        () -> postTriggerApp("ExampleAppNoTrigger", ADMIN_AUTH_HEADERS),
+        BAD_REQUEST,
+        "App does not support manual trigger.");
+  }
+
   @Override
   public void validateCreatedEntity(
       App createdEntity, CreateApp request, Map<String, String> authHeaders)

diff --git a/openmetadata-service/src/test/resources/json/data/app/ExampleAppNoTrigger.json b/openmetadata-service/src/test/resources/json/data/app/ExampleAppNoTrigger.json
@@ -0,0 +1,9 @@
+{
+  "name": "ExampleAppNoTrigger",
+  "displayName": "Example App No Trigger",
+  "appConfiguration": {},
+  "appSchedule": {
+    "scheduleTimeline": "Custom",
+    "cronExpression": "0 0 1/1 * *"
+  }
+}
diff --git a/...ta-service/src/test/resources/json/data/appMarketPlaceDefinition/ExampleAppNoTrigger.json b/...ta-service/src/test/resources/json/data/appMarketPlaceDefinition/ExampleAppNoTrigger.json
@@ -0,0 +1,20 @@
+{
+  "name": "ExampleAppNoTrigger",
+  "displayName": "Example App No Trigger",
+  "description": "An example app without manual trigger.",
+  "features": "Dont try this at home.",
+  "appType": "internal",
+  "appScreenshots": [
+  ],
+  "developer": "ACME Labs",
+  "developerUrl": "https://www.example.com",
+  "privacyPolicyUrl": "https://www.example.com",
+  "supportEmail": "use@example.com",
+  "scheduleType": "Scheduled",
+  "permission": "All",
+  "className": "org.openmetadata.service.apps.bundles.searchIndex.SearchIndexApp",
+  "runtime": {
+    "enabled": true
+  },
+  "appConfiguration": {}
+}
diff --git a/openmetadata-spec/src/main/resources/json/schema/entity/applications/app.json b/openmetadata-spec/src/main/resources/json/schema/entity/applications/app.json
@@ -13,14 +13,18 @@
       "type": "string",
       "enum": [
         "Live",
-        "Scheduled"
+        "Scheduled",
+        "ScheduledOrManual"
       ],
       "javaEnums": [
         {
           "name": "Live"
         },
         {
           "name": "Scheduled"
+        },
+        {
+          "name": "ScheduledOrManual"
         }
       ]
     },