Protei/PromucFlow_constructor
2
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

fix: Added documentation around execute methods (#40105)

Browse Source 
## Description
Added fo


Fixes #`Issue Number`  
_or_  
Fixes `Issue URL`
> [!WARNING]  
> _If no issue exists, please create an issue first, and check with the
maintainers if the issue is valid._

## Automation

/ok-to-test tags=""

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!CAUTION]  
> If you modify the content in this section, you are likely to disrupt
the CI result for your PR.

<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Enhanced plugin operations with integrated performance metrics and
feature flag support for more robust execution.
- **Documentation**
- Upgraded internal descriptions to provide clearer guidelines for the
improved functionalities, ensuring better maintainability.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Co-authored-by: “sneha122” <“sneha@appsmith.com”>
This commit is contained in:
sneha122 2025-04-07 13:46:49 +05:30 committed by GitHub
parent 0780ca4ef7
commit b71196ed89
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 34 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
app/server/appsmith-interfaces/src/main/java/com/appsmith/external/plugins/PluginExecutor.java vendored
View File

@ -254,17 +254,23 @@ public interface PluginExecutor<C> extends ExtensionPoint, CrudTemplateService {
.tap(Micrometer.observation(observationRegistry));
}
// TODO: Following methods of executeParameterizedWithFlags, executeParameterizedWithMetricsAndFlags,
// triggerWithFlags are added to support feature flags in the plugin modules. Current implementation of
// featureFlagService is only available in server module and not available in any of the plugin modules due to
// dependencies on SessionUserService, OrganizationService etc. Hence, these methods are added to support feature
// flags in the plugin modules.
// Ideal solution would be to move featureFlagService and its dependencies to the shared interface module
// But this is a bigger change and will be done in future. Current change of passing flags was done to resolve
// release blocker
// https://github.com/appsmithorg/appsmith/issues/37714
// Once thorogh testing of shared drive support is done, we can remove this tech debt of passing feature flags like
// this.
/**
* TODO: Following methods of executeParameterizedWithFlags, executeParameterizedWithMetricsAndFlags,
* triggerWithFlags are added
* to support feature flags in the plugin modules. Current implementation of featureFlagService is only available in
* server module
* and not available in any of the plugin modules due to dependencies on SessionUserService, OrganizationService etc.
* Hence, these methods are added to support feature flags in the plugin modules.
* Ideal solution would be to move featureFlagService and its dependencies to the shared interface module
* But this is a bigger change and will be done in future. Current change of passing flags was done to resolve release blocker
* https://github.com/appsmithorg/appsmith/issues/37714
* Once thorogh testing of shared drive support is done, we can remove this tech debt of passing feature flags like this.
*/
/**
* If you are overriding this method in plugins, make sure to handle variable substitution and final execution
* in the plugin code itself. Variable substitution is handled by {@link #prepareConfigurationsForExecution}
*/
default Mono<ActionExecutionResult> executeParameterizedWithFlags(
C connection,
ExecuteActionDTO executeActionDTO,
@ -274,6 +280,23 @@ public interface PluginExecutor<C> extends ExtensionPoint, CrudTemplateService {
return this.executeParameterized(connection, executeActionDTO, datasourceConfiguration, actionConfiguration);
}
/**
* Appsmith Server calls this function for execution of the action.
* Default implementation which takes the variables that need to be substituted and then calls the plugin execute function
* <p>
* Plugins requiring their custom implementation of variable substitution should override this function and then are
* responsible both for variable substitution and final execution.
*
* @param connection : This is the connection that is established to the data source. This connection is according
* to the parameters in Datasource Configuration
* @param executeActionDTO : This is the data structure sent by the client during execute. This contains the params
* which would be used for substitution
* @param datasourceConfiguration : These are the configurations which have been used to create a Datasource from a Plugin
* @param actionConfiguration : These are the configurations which have been used to create an Action from a Datasource.
* @param observationRegistry : This is used for adding performance metrics to plugin modules
* @param featureFlagMap : This is used for adding feature flagging capabilities to plugin modules.
* @return ActionExecutionResult : This object is returned to the user which contains the result values from the execution.
*/
default Mono<ActionExecutionResult> executeParameterizedWithMetricsAndFlags(
C connection,
ExecuteActionDTO executeActionDTO,