Merge pull request #40355 from appsmithorg/feat/reactive-actions-run-behaviour

feat: Replacing execute on load toggle with run behaviour in all actions / jsactions

Author: yatinappsmith

app/client/cypress/e2e/Regression/ClientSide/ActionExecution/FrameworkFunctions_ShowCloseModalFunctions_spec.ts

@@ -46,7 +46,7 @@ describe(
         cy.wrap(jsObjectName).as("jsObjectName");
       });
 
-      apiPage.clickSettingIcon(true);
+      apiPage.clickSettingIcon("On page load");
 
       EditorNavigation.SelectEntityByName("Button1", EntityType.Widget);
       propPane.ToggleJSMode("onClick", true);

app/client/cypress/e2e/Regression/ClientSide/BugTests/Bug14987_spec.js

@@ -32,7 +32,7 @@ describe(
       pluginActionForm.toolbar.toggleSettings();
 
       cy.get(".label-icon-wrapper")
-        .contains("Run the query on page load")
+        .contains("Run behavior")
         .parent()
         .then(($el) => {
           cy.window().then((win) => {

app/client/cypress/e2e/Regression/ClientSide/BugTests/Bug20275_Spec.js

@@ -30,7 +30,7 @@ describe(
         prettify: false,
       });
 
-      jsEditor.EnableDisableAsyncFuncSettings("myFun1", true);
+      jsEditor.EnableDisableAsyncFuncSettings("myFun1", "On page load");
 
       ee.DragDropWidgetNVerify(WIDGET.TEXT, 200, 600);
       EditorNavigation.SelectEntityByName("Text1", EntityType.Widget);

app/client/cypress/e2e/Regression/ClientSide/JSObject/JSObject_Tests_spec.ts

@@ -33,7 +33,7 @@ describe("Validate JSObj", {}, () => {
         shouldCreateNewJSObj: true,
       },
     );
-    jsEditor.EnableDisableAsyncFuncSettings("myFun1");
+    jsEditor.EnableDisableAsyncFuncSettings("myFun1", "On page load");
 
     // Add new JSObject
     PageList.AddNewPage("New blank page");

app/client/cypress/e2e/Regression/ClientSide/PublishedApps/PublishedModeToastToggle_Spec.ts

@@ -22,14 +22,14 @@ describe.skip(
         _.dataManager.dsValues[_.dataManager.defaultEnviorment].mockApiUrl,
         "Correct_users",
       );
-      _.apiPage.ToggleOnPageLoadRun(true);
+      _.apiPage.ToggleOnPageLoadRun("On page load");
       _.apiPage.CreateAndFillApi(
         _.dataManager.dsValues[
           _.dataManager.defaultEnviorment
         ].mockApiUrl.replace("mock-api", "mock-api2err"),
         "Incorrect_users",
       );
-      _.apiPage.ToggleOnPageLoadRun(true);
+      _.apiPage.ToggleOnPageLoadRun("On page load");
       _.jsEditor.CreateJSObject(
         `export default {
         async myFun1 () {

app/client/cypress/e2e/Regression/ClientSide/SetProperty/SetOptions_Spec.ts

@@ -209,7 +209,7 @@ describe(
 
     it("3. Update 'setOptions' property - during onPage load", () => {
       EditorNavigation.SelectEntityByName("JSObject1", EntityType.JSObject);
-      jsEditor.EnableDisableAsyncFuncSettings("myFun1", true); //for on page load execution
+      jsEditor.EnableDisableAsyncFuncSettings("myFun1", "On page load"); //for on page load execution
       deployMode.DeployApp();
       agHelper
         .GetText(
@@ -268,7 +268,7 @@ describe(
         ])}, () => {showAlert('unable to run API')});
       }
     }`);
-      jsEditor.EnableDisableAsyncFuncSettings("myFunc1", true); //for on page load execution, since sync function is updated to async
+      jsEditor.EnableDisableAsyncFuncSettings("myFunc1", "On page load"); //for on page load execution, since sync function is updated to async
       deployMode.DeployApp();
       agHelper.WaitForCondition(
         agHelper
@@ -313,7 +313,7 @@ describe(
         Select3.setOptions(Select1.options.concat(Select2.options));
       }
     }`);
-      jsEditor.EnableDisableAsyncFuncSettings("myFunc1", true); //for on page load execution, since sync function is updated to async
+      jsEditor.EnableDisableAsyncFuncSettings("myFunc1", "On page load"); //for on page load execution, since sync function is updated to async
       EditorNavigation.SelectEntityByName("Input1", EntityType.Widget);
       propPane.UpdatePropertyFieldValue("Default value", "{{Select3.options}}");
       deployMode.DeployApp();
@@ -355,7 +355,7 @@ describe(
         setTimeout(() => {Select1.setOptions(localValue)}, 1000);
       }
     }`);
-      jsEditor.EnableDisableAsyncFuncSettings("myFun1", false); //for on page load execution
+      jsEditor.EnableDisableAsyncFuncSettings("myFun1", "Manual"); //for on page load execution
       deployMode.DeployApp();
       agHelper
         .GetText(

app/client/cypress/e2e/Regression/ClientSide/SetProperty/WidgetPropertySetters2_spec.ts

@@ -177,7 +177,7 @@ describe(
       }`,
         false,
       );
-      jsEditor.EnableDisableAsyncFuncSettings("myFun1", true);
+      jsEditor.EnableDisableAsyncFuncSettings("myFun1", "On page load");
       deployMode.DeployApp(locators._widgetInDeployed(draggableWidgets.BUTTON)); //Asserting before setTimeout JS function execution, button is visible
       agHelper.Sleep(2000); //waiting for settimeout to execute
       agHelper.AssertElementAbsence(
@@ -236,7 +236,7 @@ describe(
       }`,
         false,
       );
-      jsEditor.EnableDisableAsyncFuncSettings("myFun1", false);
+      jsEditor.EnableDisableAsyncFuncSettings("myFun1", "Manual");
       deployMode.DeployApp();
       agHelper.AssertElementVisibility(
         locators._widgetInDeployed(draggableWidgets.INPUT_V2), //Asserting before setTimeout JS function execution, Input is visible

app/client/cypress/e2e/Regression/ServerSide/ApiTests/API_MultiPart_Spec.ts

@@ -142,7 +142,7 @@ describe(
 
       EditorNavigation.SelectEntityByName("MultipartAPI", EntityType.Api);
 
-      apiPage.ToggleOnPageLoadRun(false); //Bug 12476
+      apiPage.ToggleOnPageLoadRun("Manual"); //Bug 12476
       EditorNavigation.SelectEntityByName("Page2", EntityType.Page);
       deployMode.DeployApp(locators._buttonByText("Select Files"));
       agHelper.ClickButton("Select Files");

app/client/cypress/e2e/Regression/ServerSide/Datasources/Oracle_Spec.ts

@@ -467,7 +467,7 @@ describe(
     });
 
     it("7. Tc #2365  - Query settings tab validations", () => {
-      apiPage.ToggleOnPageLoadRun(false); // All above cases validated for onpage load run with confirmation dialog set to false
+      apiPage.ToggleOnPageLoadRun("Manual"); // All above cases validated for onpage load run with confirmation dialog set to false
       pluginActionForm.toolbar.toggleSettings();
       apiPage.ToggleConfirmBeforeRunning(true);
       deployMode.DeployApp();

app/client/cypress/e2e/Regression/ServerSide/Datasources/Snowflake_Basic_Spec.ts

@@ -165,7 +165,7 @@ describe.skip(
         "Select",
       );
       agHelper.RenameQuery("TemplateSelectQuery");
-      apiPage.ToggleOnPageLoadRun(true);
+      apiPage.ToggleOnPageLoadRun("On page load");
       pluginActionForm.toolbar.toggleSettings();
       apiPage.ToggleConfirmBeforeRunning(true);
       agHelper.RefreshPage();

app/client/cypress/e2e/Regression/ServerSide/JsFunctionExecution/JSFunctionExecution_spec.ts

@@ -17,7 +17,7 @@ import PageList from "../../../../support/Pages/PageList";
 
 interface IFunctionSettingData {
   name: string;
-  onPageLoad: boolean;
+  runBehaviour: "On page load" | "Manual";
   confirmBeforeExecute: boolean;
   // uses the "async" keyword
   isMarkedAsync: boolean;
@@ -35,31 +35,31 @@ describe(
     const FUNCTIONS_SETTINGS_DEFAULT_DATA: IFunctionSettingData[] = [
       {
         name: "getId",
-        onPageLoad: true,
+        runBehaviour: "On page load",
         confirmBeforeExecute: false,
         isMarkedAsync: true,
       },
       {
         name: "zip",
-        onPageLoad: true,
+        runBehaviour: "On page load",
         confirmBeforeExecute: true,
         isMarkedAsync: false,
       },
       {
         name: "base",
-        onPageLoad: false,
+        runBehaviour: "Manual",
         confirmBeforeExecute: false,
         isMarkedAsync: true,
       },
       {
         name: "assert",
-        onPageLoad: false,
+        runBehaviour: "Manual",
         confirmBeforeExecute: false,
         isMarkedAsync: false,
       },
       {
         name: "test",
-        onPageLoad: true,
+        runBehaviour: "On page load",
         confirmBeforeExecute: true,
         isMarkedAsync: true,
       },
@@ -359,7 +359,7 @@ describe(
       // Number of functions set to run on page load and should also confirm before execute
       onPageLoadAndConfirmExecuteFunctionsLength =
         FUNCTIONS_SETTINGS_DEFAULT_DATA.filter(
-          (func) => func.onPageLoad && func.confirmBeforeExecute,
+          (func) => func.runBehaviour && func.confirmBeforeExecute,
         ).length;
 
       getJSObject = (data: IFunctionSettingData[]) => {
@@ -404,7 +404,7 @@ describe(
         (functionSetting) => {
           jsEditor.EnableDisableAsyncFuncSettings(
             functionSetting.name,
-            functionSetting.onPageLoad,
+            functionSetting.runBehaviour,
           );
         },
       );
@@ -425,31 +425,31 @@ describe(
       const FUNCTIONS_SETTINGS_RENAMED_DATA: IFunctionSettingData[] = [
         {
           name: "newGetId",
-          onPageLoad: true,
+          runBehaviour: "On page load",
           confirmBeforeExecute: false,
           isMarkedAsync: false,
         },
         {
           name: "zip1",
-          onPageLoad: true,
+          runBehaviour: "On page load",
           confirmBeforeExecute: true,
           isMarkedAsync: true,
         },
         {
           name: "base",
-          onPageLoad: false,
+          runBehaviour: "Manual",
           confirmBeforeExecute: false,
           isMarkedAsync: true,
         },
         {
           name: "newAssert",
-          onPageLoad: true,
+          runBehaviour: "On page load",
           confirmBeforeExecute: false,
           isMarkedAsync: false,
         },
         {
           name: "test",
-          onPageLoad: true,
+          runBehaviour: "On page load",
           confirmBeforeExecute: true,
           isMarkedAsync: true,
         },
@@ -500,12 +500,12 @@ return "yes";`;
       });
 
       // Enable all settings
-      jsEditor.EnableDisableAsyncFuncSettings("asyncToSync", true);
+      jsEditor.EnableDisableAsyncFuncSettings("asyncToSync", "On page load");
 
       // Modify js object
       jsEditor.EditJSObj(syncJSCode, false);
       agHelper.RefreshPage();
-      jsEditor.VerifyAsyncFuncSettings("asyncToSync", true);
+      jsEditor.VerifyAsyncFuncSettings("asyncToSync", "On page load");
       agHelper.ActionContextMenuWithInPane({
         action: "Delete",
         entityType: entityItems.JSObject,

app/client/cypress/e2e/Regression/ServerSide/JsFunctionExecution/SetTimeout_spec.ts

@@ -227,7 +227,7 @@ describe(
           prettify: true,
         },
       );
-      jsEditor.EnableDisableAsyncFuncSettings("myFun1", true);
+      jsEditor.EnableDisableAsyncFuncSettings("myFun1", "On page load");
       deployMode.DeployApp();
       agHelper.Sleep(1000); //DeployApp already waiting 2000ms hence reducing it here to equate to 3000 timeout
       agHelper.AssertContains("Success!");

app/client/cypress/e2e/Regression/ServerSide/OnLoadTests/APIOnLoad_Spec.ts

@@ -50,7 +50,7 @@ describe(
           "PageLoadApi2",
         );
       });
-      apiPage.ToggleOnPageLoadRun(true);
+      apiPage.ToggleOnPageLoadRun("On page load");
       EditorNavigation.SelectEntityByName("Table1", EntityType.Widget, {}, [
         "Container3",
       ]);

app/client/cypress/e2e/Regression/ServerSide/OnLoadTests/JSOnLoad2_Spec.ts

@@ -94,7 +94,7 @@ describe(
         },
       );
 
-      jsEditor.EnableDisableAsyncFuncSettings("astros", true);
+      jsEditor.EnableDisableAsyncFuncSettings("astros", "On page load");
 
       EditorNavigation.SelectEntityByName("Page1", EntityType.Page);
       agHelper.RefreshPage();

app/client/cypress/e2e/Regression/ServerSide/OnLoadTests/JSOnLoad4_Spec.ts

@@ -34,12 +34,12 @@ describe(
         },
       );
 
-      jsEditor.VerifyAsyncFuncSettings("myFun1", false);
-      jsEditor.VerifyAsyncFuncSettings("myFun2", false);
-      jsEditor.VerifyAsyncFuncSettings("myFun3", false);
-      jsEditor.VerifyAsyncFuncSettings("myFun4", false);
-      jsEditor.VerifyAsyncFuncSettings("myFun5", false);
-      jsEditor.VerifyAsyncFuncSettings("myFun6", false);
+      jsEditor.VerifyAsyncFuncSettings("myFun1", "Manual");
+      jsEditor.VerifyAsyncFuncSettings("myFun2", "Manual");
+      jsEditor.VerifyAsyncFuncSettings("myFun3", "Manual");
+      jsEditor.VerifyAsyncFuncSettings("myFun4", "Manual");
+      jsEditor.VerifyAsyncFuncSettings("myFun5", "Manual");
+      jsEditor.VerifyAsyncFuncSettings("myFun6", "Manual");
 
       VerifyFunctionDropdown([
         "myFun1",

app/client/cypress/e2e/Regression/ServerSide/Params/PassingParams_Spec.ts

@@ -76,7 +76,7 @@ describe(
       propPane.EnterJSContext("Table data", "{{ParamsTest.data}}");
 
       EditorNavigation.SelectEntityByName("ParamsTest", EntityType.Query);
-      apiPage.ToggleOnPageLoadRun(false); //Bug 12476
+      apiPage.ToggleOnPageLoadRun("Manual"); //Bug 12476
 
       deployMode.DeployApp(locators._buttonByText("Submit"));
       agHelper.SelectDropDown("7");