b5e3af7b85
* Refactor activity serialization process
Refactored the activity serialization process in Elsa workflow API. The changes include addition, modification and deletion of code blocks across various files to accommodate the restructuring. The changes focus primarily on the handling of composite root activities and their serialization. The utility of configuration options for serializer is also implemented.
* Stash
* Add IgnoreChildActivitiesConverter and improve activity JSON conversion
A new JSON converter, IgnoreChildActivitiesConverter, has been introduced to handle specific serialization scenarios. On top of this, improvements have been made to the existing ActivityJsonConverter. This includes more robust handling of synthetic properties and the ability to ignore child activities during serialization. In DiagramDesignerWrapper, an addition has been made to facilitate the handling of embedded activities.
* "Implement activity port tracking in workflow system"
Modified several components of the workflow system to include activity port tracking for better visibility and control over workflow structures. In addition, unnecessary files were deleted, new ones were introduced, and changes were made to existing files to incorporate the new functionality. Notably, IActivityResolver interface now includes GetActivityPortsAsync method to allow retrieving activity ports. This enhances the ability to track actions in complex workflows.
* Add specialized converter check in activity serialization
The commit introduces a check for specialized JSON converters in two serialization methods inside `ActivityJsonConverter.cs` and `ActivityNodeConverter.cs`. If a specialized converter exists for a particular activity type, the serializer now uses it to serialize the activity, enhancing the serialization process's flexibility.
* Ignore serialization of ConfigureSerializerOptions
Added JsonIgnore attribute to the ConfigureSerializerOptions in the ActivityDescriptor class. This will prevent it from being included during the JSON serialization process, ensuring that it is not unnecessarily processed or exposed in serialized data formats.
* Refactor method to find WorkflowDefinition instead of WorkflowGraph
The method FindWorkflowGraphAsync was revised to find WorkflowDefinition rather than WorkflowGraph, reflecting its new purpose in the code. This change has also affected the related variables and logic where this function was called. The rationale for this revision is that the WorkflowGraph is a dynamic entity that should be computed at runtime, and hence cannot be reliably retrieved for static inspection.
* Update API endpoint and simplify request handling in workflow
The API endpoint for fetching workflow definitions graph has been changed from "/workflow-definitions/{definitionId}/graph" to "/workflow-definitions/subgraph/{id}". Similarly, the request handling has been simplified by removing version options and directly passing "Id" to the "FindWorkflowGraphAsync" method.
* Update import statements and remove unused dependencies
Some import/using statements have been adjusted to remove the 'Contracts' suffix in contexts where it's not necessary. A few unused dependencies have also been removed. These changes clean up the code and ensure proper functionality in the Elsa workflows system.
* Update .editorconfig settings
The .editorconfig settings have been revised to enforce inheritance of settings from higher directories. Additionally, the parameter 'file_header_template' has been removed. This update optimizes the configuration settings for better coding standards across C# files.
* Remove App_Data folder from Elsa.Server.Web.csproj
The App_Data folder reference has been removed from the Elsa.Server.Web project file. This change is included as the folder no longer seems necessary for the operation of the project.
* Remove unused namespace in ServiceProviderExtensions.cs
The Elsa.Workflows.Runtime.Options namespace, previously imported in the ServiceProviderExtensions file within the Elsa.Testing.Shared project, has been removed as it is not utilized. This cleanup enhances readability and maintains cleaner code.
* Implement GetActivityPortsAsync method in various classes
Added the implementation of GetActivityPortsAsync method in WorkplaceDefinitionActivityPortResolver, SendHttpRequestActivityPortResolver, OutboundActivityPortResolver, and SwitchActivityPortResolver classes. Changes also include adding inheritdoc comments for these methods, making GetActivityPortsInternal method private and static, and removing unneeded white spaces.
* Remove GetActivitiesAsync method from activity resolvers
The GetActivitiesAsync method has been removed from various activity resolver classes including WorkflowDefinitionActivityPortResolver, SendHttpRequestActivityPortResolver, OutboundActivityPortResolver, and SwitchActivityPortResolver. The corresponding interface IActivityResolver has also been updated to reflect this change. This simplifies the structure by focusing only on the activity ports.
* Simplify workflow definition serialization
Removed the cloning of serializer options and the exclusion of composite activities from being serialized in the workflow definition model. This simplification results in cleaner code with less redundancy and unnecessary operations.
* Refactor workflow definition endpoints, optimize response handling
Major refactor of workflow definition endpoints in the Elsa.Workflows.Api module. Unnecessary serialization processes have been removed. Response handling was also streamlined to use the SendOkAsync method, optimizing resource usage and increasing application performance. Commit also includes removal of some unused namespaces.
* Remove IncludeCompositeRoot property from Models
The IncludeCompositeRoot property has been removed from the Models in the GetByDefinitionId, GetById, and GetManyById endpoints. These changes simplify the code as the property was commented out and not used in current workflow logic.
* Simplify workflow definition publishing process
This commit simplifies the workflow definition publishing process in the Elsa.Workflows.Api module. The code associated with checking if a workflow definition is already published and publishing it if not has been reduced for increased readability and maintainability.
* Refactor code in workflow publish endpoint
Removed unused import for better code clarity and simplified variable declaration for publishing result. The refactoring is carried out to improve code readability and maintainability in the workflow definition publishing endpoint.
* Refactor ActivityPort in Elsa.Workflows module
This commit simplifies the code in the ActivityPort class, part of the Elsa.Workflows module. It includes a significant rework of the comments for better clarity and understanding. Effort has been made to make the code more readable and easier to maintain in this refactor.
* Refactor serialization methods and improve Synthetic Properties handling
This commit refactors the activity serialization methods and improves the handling of synthetic properties. The changes remove the IgnoreChildActivitiesConverter and move synthetic property writing to a separate helper class, SyntheticPropertiesWriter. Various refinements have been made to different converter classes to better handle activity serialization. Furthermore, a function's name was improved from "FindWorkflowGraphAsync" to "GetWorkflowDefinitionAsync" to more accurately reflects its purpose.
* Add ActivityWriter to help serialize workflow activities
This commit introduces a new class ActivityWriter, that handles the serialization of workflow activities to JSON. Other classes such as ActivityNodeConverter and ActivityJsonConverter have been refactored to utilize this new helper. The codebase is now more DRY, avoids duplicate code and increases code maintainability.
* Refactor Json serialization for ignoring specialized converters
Removed 'IActivityRegistry' from 'JsonIgnoreCompositeRootConverter'. Instead, added an 'ignoreSpecializedConverters' argument to the 'WriteActivity' method in 'ActivityWriter'. This adjustment facilitates managing specialized converter behavior more efficiently during JSON serialization.
* Update ActivityNode serialization description
The comments for the ActivityNodeConverter class have been modified to clarify the serialization process. It now explicitly states that it includes descendant nodes based on the specified depth rather than just immediate child nodes. The parameter 'depth' description has been updated to 'the number of levels of descendants to include'.
* Refine workflow serializer and update activity writer parameters
The WorkflowSerializer clone operation has been simplified to directly call GetOptions from the API Serializer. Furthermore, an unnecessary comment was removed. In the ActivityWriter, an additional parameter was introduced for controlling whether to ignore the availability of converters that can handle IActivity objects. A superfluous front slash was removed from the class description comment.
* Add WorkflowJsonStructureTests and related JSON files
This commit introduces the WorkflowJsonStructureTests class which includes tests for the structure of the workflow definition in JSON format. In addition, main.json and sub.json files, containing mock data for testing, were added to the `WorkflowJsonStructures` scenario within the Elsa Workflows Component Tests. Updates to the project file ensure these new files are included correctly.
* Update WorkflowJsonStructureTests with subgraph test
This commit introduces a new test case named 'Requesting_Subgraph_Returns_ExpectedSubgraph' in the WorkflowJsonStructureTests file. It also refactors 'Workflow_ContainingWorkflowActivity_ShouldNotIncludeChildrenOfWorkflowActivity' test to make use of constants for IDs. These changes increase the coverage and maintainability of the code.
* Update max line length in .editorconfig
This commit increases the max line length to 420 characters in the .editorconfig. Additionally, it removes the redundant 'resharper_csharp_max_line_length' setting.
* Replace ActivityNodeConverter with RootActivityNodeConverter
The commit involves a change in serialization strategy for ActivityNode in the Elsa Workflows modules. The ActivityNodeConverter has been replaced with a RootActivityNodeConverter, which changes the approach from serializing the ActivityNode type and its descendants based on specified depth to serializing the ActivityNode type without its children, with activity children now serialized as properties. Corresponding alterations have also been made in the test cases.
* Remove IActivityRegistry parameter from classes
The IActivityRegistry parameter was removed from WorkflowDefinitionActivityProvider and JsonIgnoreCompositeRootConverterFactory classes, simplifying their constructors. This change also affected Elsa.Workflows.ComponentTests where the node access through "root" was adjusted for these updates.
236 lines
9.3 KiB
INI
236 lines
9.3 KiB
INI
# Remove the line below if you want to inherit .editorconfig settings from higher directories
|
|
root = true
|
|
|
|
# C# files
|
|
[*.cs]
|
|
|
|
#### Core EditorConfig Options ####
|
|
|
|
# Indentation and spacing
|
|
indent_size = 4
|
|
indent_style = space
|
|
tab_width = 4
|
|
|
|
# New line preferences
|
|
end_of_line = crlf
|
|
insert_final_newline = false
|
|
max_line_length = 420
|
|
|
|
#### .NET Coding Conventions ####
|
|
|
|
# Organize usings
|
|
dotnet_separate_import_directive_groups = false
|
|
dotnet_sort_system_directives_first = true
|
|
|
|
# this. and Me. preferences
|
|
dotnet_style_qualification_for_event = false
|
|
dotnet_style_qualification_for_field = false
|
|
dotnet_style_qualification_for_method = false
|
|
dotnet_style_qualification_for_property = false
|
|
|
|
# Language keywords vs BCL types preferences
|
|
dotnet_style_predefined_type_for_locals_parameters_members = true
|
|
dotnet_style_predefined_type_for_member_access = true
|
|
|
|
# Parentheses preferences
|
|
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity
|
|
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity
|
|
dotnet_style_parentheses_in_other_operators = never_if_unnecessary
|
|
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity
|
|
|
|
# Modifier preferences
|
|
dotnet_style_require_accessibility_modifiers = for_non_interface_members
|
|
|
|
# Expression-level preferences
|
|
dotnet_style_coalesce_expression = true
|
|
dotnet_style_collection_initializer = true
|
|
dotnet_style_explicit_tuple_names = true
|
|
dotnet_style_namespace_match_folder = true
|
|
dotnet_style_null_propagation = true
|
|
dotnet_style_object_initializer = true
|
|
dotnet_style_operator_placement_when_wrapping = beginning_of_line
|
|
dotnet_style_prefer_auto_properties = true
|
|
dotnet_style_prefer_compound_assignment = true
|
|
dotnet_style_prefer_conditional_expression_over_assignment = true
|
|
dotnet_style_prefer_conditional_expression_over_return = true
|
|
dotnet_style_prefer_foreach_explicit_cast_in_source = when_strongly_typed
|
|
dotnet_style_prefer_inferred_anonymous_type_member_names = true
|
|
dotnet_style_prefer_inferred_tuple_names = true
|
|
dotnet_style_prefer_is_null_check_over_reference_equality_method = true
|
|
dotnet_style_prefer_simplified_boolean_expressions = true
|
|
dotnet_style_prefer_simplified_interpolation = true
|
|
|
|
# Field preferences
|
|
dotnet_style_readonly_field = true
|
|
|
|
# Parameter preferences
|
|
dotnet_code_quality_unused_parameters = all
|
|
|
|
# Suppression preferences
|
|
dotnet_remove_unnecessary_suppression_exclusions = none
|
|
|
|
# New line preferences
|
|
dotnet_style_allow_multiple_blank_lines_experimental = true
|
|
dotnet_style_allow_statement_immediately_after_block_experimental = true
|
|
|
|
#### C# Coding Conventions ####
|
|
|
|
# var preferences
|
|
csharp_style_var_elsewhere = false
|
|
csharp_style_var_for_built_in_types = false
|
|
csharp_style_var_when_type_is_apparent = false
|
|
|
|
# Expression-bodied members
|
|
csharp_style_expression_bodied_accessors = true
|
|
csharp_style_expression_bodied_constructors = false
|
|
csharp_style_expression_bodied_indexers = true
|
|
csharp_style_expression_bodied_lambdas = true
|
|
csharp_style_expression_bodied_local_functions = false
|
|
csharp_style_expression_bodied_methods = false
|
|
csharp_style_expression_bodied_operators = false
|
|
csharp_style_expression_bodied_properties = true
|
|
|
|
# Pattern matching preferences
|
|
csharp_style_pattern_matching_over_as_with_null_check = true
|
|
csharp_style_pattern_matching_over_is_with_cast_check = true
|
|
csharp_style_prefer_extended_property_pattern = true
|
|
csharp_style_prefer_not_pattern = true
|
|
csharp_style_prefer_pattern_matching = true
|
|
csharp_style_prefer_switch_expression = true
|
|
|
|
# Null-checking preferences
|
|
csharp_style_conditional_delegate_call = true
|
|
|
|
# Modifier preferences
|
|
csharp_prefer_static_local_function = true
|
|
csharp_preferred_modifier_order = public,private,protected,internal,file,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,required,volatile,async
|
|
csharp_style_prefer_readonly_struct = true
|
|
csharp_style_prefer_readonly_struct_member = true
|
|
|
|
# Code-block preferences
|
|
csharp_prefer_braces = true
|
|
csharp_prefer_simple_using_statement = true
|
|
csharp_style_namespace_declarations = file_scoped:warning
|
|
csharp_style_prefer_method_group_conversion = true
|
|
csharp_style_prefer_primary_constructors = true
|
|
csharp_style_prefer_top_level_statements = true
|
|
|
|
# Expression-level preferences
|
|
csharp_prefer_simple_default_expression = true
|
|
csharp_style_deconstructed_variable_declaration = true
|
|
csharp_style_implicit_object_creation_when_type_is_apparent = true
|
|
csharp_style_inlined_variable_declaration = true
|
|
csharp_style_prefer_index_operator = true
|
|
csharp_style_prefer_local_over_anonymous_function = true
|
|
csharp_style_prefer_null_check_over_type_check = true
|
|
csharp_style_prefer_range_operator = true
|
|
csharp_style_prefer_tuple_swap = true
|
|
csharp_style_prefer_utf8_string_literals = true
|
|
csharp_style_throw_expression = true
|
|
csharp_style_unused_value_assignment_preference = discard_variable
|
|
csharp_style_unused_value_expression_statement_preference = discard_variable
|
|
|
|
# 'using' directive preferences
|
|
csharp_using_directive_placement = outside_namespace
|
|
|
|
# New line preferences
|
|
csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true
|
|
csharp_style_allow_blank_line_after_token_in_arrow_expression_clause_experimental = true
|
|
csharp_style_allow_blank_line_after_token_in_conditional_expression_experimental = true
|
|
csharp_style_allow_blank_lines_between_consecutive_braces_experimental = true
|
|
csharp_style_allow_embedded_statements_on_same_line_experimental = true
|
|
|
|
#### C# Formatting Rules ####
|
|
|
|
# New line preferences
|
|
csharp_new_line_before_catch = true
|
|
csharp_new_line_before_else = true
|
|
csharp_new_line_before_finally = true
|
|
csharp_new_line_before_members_in_anonymous_types = true
|
|
csharp_new_line_before_members_in_object_initializers = true
|
|
csharp_new_line_before_open_brace = all
|
|
csharp_new_line_between_query_expression_clauses = true
|
|
|
|
# Indentation preferences
|
|
csharp_indent_block_contents = true
|
|
csharp_indent_braces = false
|
|
csharp_indent_case_contents = true
|
|
csharp_indent_case_contents_when_block = true
|
|
csharp_indent_labels = one_less_than_current
|
|
csharp_indent_switch_labels = true
|
|
|
|
# Space preferences
|
|
csharp_space_after_cast = false
|
|
csharp_space_after_colon_in_inheritance_clause = true
|
|
csharp_space_after_comma = true
|
|
csharp_space_after_dot = false
|
|
csharp_space_after_keywords_in_control_flow_statements = true
|
|
csharp_space_after_semicolon_in_for_statement = true
|
|
csharp_space_around_binary_operators = before_and_after
|
|
csharp_space_around_declaration_statements = false
|
|
csharp_space_before_colon_in_inheritance_clause = true
|
|
csharp_space_before_comma = false
|
|
csharp_space_before_dot = false
|
|
csharp_space_before_open_square_brackets = false
|
|
csharp_space_before_semicolon_in_for_statement = false
|
|
csharp_space_between_empty_square_brackets = false
|
|
csharp_space_between_method_call_empty_parameter_list_parentheses = false
|
|
csharp_space_between_method_call_name_and_opening_parenthesis = false
|
|
csharp_space_between_method_call_parameter_list_parentheses = false
|
|
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
|
|
csharp_space_between_method_declaration_name_and_open_parenthesis = false
|
|
csharp_space_between_method_declaration_parameter_list_parentheses = false
|
|
csharp_space_between_parentheses = false
|
|
csharp_space_between_square_brackets = false
|
|
|
|
# Wrapping preferences
|
|
csharp_preserve_single_line_blocks = true
|
|
csharp_preserve_single_line_statements = true
|
|
|
|
#### Naming styles ####
|
|
|
|
# Naming rules
|
|
|
|
dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
|
|
dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
|
|
dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
|
|
|
|
dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
|
|
dotnet_naming_rule.types_should_be_pascal_case.symbols = types
|
|
dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
|
|
|
|
dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
|
|
dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
|
|
dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
|
|
|
|
# Symbol specifications
|
|
|
|
dotnet_naming_symbols.interface.applicable_kinds = interface
|
|
dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
|
|
dotnet_naming_symbols.interface.required_modifiers =
|
|
|
|
dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
|
|
dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
|
|
dotnet_naming_symbols.types.required_modifiers =
|
|
|
|
dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
|
|
dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
|
|
dotnet_naming_symbols.non_field_members.required_modifiers =
|
|
|
|
# Naming styles
|
|
|
|
dotnet_naming_style.pascal_case.required_prefix =
|
|
dotnet_naming_style.pascal_case.required_suffix =
|
|
dotnet_naming_style.pascal_case.word_separator =
|
|
dotnet_naming_style.pascal_case.capitalization = pascal_case
|
|
|
|
dotnet_naming_style.begins_with_i.required_prefix = I
|
|
dotnet_naming_style.begins_with_i.required_suffix =
|
|
dotnet_naming_style.begins_with_i.word_separator =
|
|
dotnet_naming_style.begins_with_i.capitalization = pascal_case
|
|
|
|
# ReSharper properties
|
|
resharper_max_array_initializer_elements_on_line = 50
|
|
resharper_max_initializer_elements_on_line = 1
|
|
resharper_wrap_array_initializer_style = chop_if_long
|