Releases: NitorCreations/nflow
Releases · NitorCreations/nflow
v4.0.0
Highlights
- Rename com.nitorcreations.nflow package to io.nflow
- Require Java 8 (e.g. Java 7 is not supported anymore)
- Wake up parent workflow only if it is in expected state
Details
- nflow-engine:
- Add human-readable toString method to all DTO classes
- When waking up parent workflow, expected states can be defined. If the state is not as expected, parent workflow is not woken up.
- nflow-jetty:
- Use nFlow Explorer version 1.2.3
v3.3.0
Highlights
- Fixes to nflow-rest-api CORS header filter
- Fixes to query workflow instances service
Details
- nflow-engine:
- Filter query workflow instances result by executor group
- Query workflow instances returns latest instances first
- nflow-rest-api:
- CorsHeaderContainerResponseFilter is applied to nFlow REST API resources only
- CorsHeaderContainerResponseFilter can be disabled via configuration (nflow.rest.cors.enabled=false)
- Allowed CORS headers can be configured by setting nflow.rest.allow.headers
- nflow-jetty:
- Use nFlow Explorer version 1.2.1
v3.2.0
Highlights
- Support for not saving an action when workflow instance is processed
- Support for limiting the number of actions returned when getting workflow instance via REST API
- Add StateExecution.getVariable(name, type, default) method
Details
- nflow-engine:
- Support for not saving an action when workflow instance is processed by calling StateExecution.setCreateAction(false)
- Add StateExecution.getVariable(name, type, default) method. Also change StateExecution.getVariable(name, type) so that it returns null when variable is not set instead of throwing a NullPointerException.
- Adding a new workflow instance wakes the dispatcher thread if it is sleeping and the queue is not full
- Set nflow_executor.active and nflow_executor_expires when inserting new executor to database, do not accept null values for these columns anymore
- nflow-rest-api:
- Support for limiting the number of actions returned when getting workflow instance via REST API. The latest actions are returned first.
- Other:
- Fix or suppress all FindBugs warnings
v3.1.1
v3.1.0
Highlights
- Log stack traces of executors that may be stuck
- Oracle fixes
Details
- nflow-engine:
- Log stack traces for executor threads that may be stuck (nflow.executor.stuckThreadThreshold.seconds)
- Mark node not running on graceful shutdown
- Do not use batch updates when using Oracle database
- Do not set nflow.db.username and nflow.db.password properties in nflow-engine.properties because they override database type specific properties
- Lower log levels of some log entries that are not that important
- nflow-jetty:
- Use nFlow Explorer version 1.2.0
- source:
- Add package level javadocs
v3.0.0
Highlights
- Easier to embed nflow-rest-api to applications
- Production use support features for nflow-jetty
Details
- nflow-engine:
- Independent workflows can be created in state methods (StateExecution.addWorkflows())
- Added service for checking database connection status (HealthCheckService)
- Support for MySQL database 5.7.x
- fixed: workflow instance recovery functionality (broken by version 2.0.0)
- fixed: Oracle database schema
- nflow-rest-api:
- breaking change: Prefixed operation paths by "/nflow" (e.g. /v1/statistics -> /nflow/v1/statistics)
- Support for Jersey JAX-RS implementation
- breaking change: Moved exception mappers to nflow-jetty (BadRequestExceptionMapper, CustomValidationExceptionMapper, NotFoundExceptionMapper)
- Improved Swagger documentation
- nflow-jetty:
- New configuration properties:
- nflow.jetty.accesslog.directory: access log directory (default "log")
- nflow.swagger.basepath: Swagger basepath for services (default "/api")
- nflow.external.config: location for external configuration (default undefined)
- Added metrics and health check endpoints from Dropwizard to /metrics -context
- New configuration properties:
- nflow-metrics:
- breaking change: No longer defines MetricRegistry bean (must be injected from outside)
- Added database check feature for health checks (DatabaseConnectionHealthCheck)
v2.0.0
Highlights
- Support for child workflows
- WorkflowExecutorListeners are now implemened as a listener chain. The listeners may now skip the actual execution of a state method. Useful e.g. for locking.
- Support for archiving old, finished workflow instances
Details
- Increase nflow_executor.host length to 253 characters in database. It can now contain a full DNS name.
- When a database is created, nFlow writes a log message about it
- Experimental support for Oracle database
- Added new Maven module for performance tests
- Added WorkflowInstanceAction.id
- Final state methods cannot return value anymore
- Remove deprecated fields: WorkflowInstanceAction.workflowId, WorkflowInstanceService.updateWorkflowInstanceAfterExecution, WorkflowInstance.processing, WorkflowInstance.owner, WorkflowState.getName()
- Small bug fixes and enhancements
v1.3.0
Highlights
- Introduced workflow instance status, which indicates the execution state (created, inProgress, executing, paused, stopped, finished, manual) of workflow instance
- Added REST API services for pausing, resuming and stopping workflow instances
- Restructured workflow definition statistics to return workflow instance status counts for workflow instance states
Details
- nflow-engine:
- Use more optimal SQL when polling workflows when database supports update returning syntax
- Only rollback poll operation when no workflows could be allocated for executing (when multiple pollers compete for same workflows)
- Allow configuring executor queue length with nflow.dispatcher.executor.queue.size
- nflow.transition.delay.waiterror.ms parameter was splitted to nflow.transition.delay.error.min.ms and nflow.transition.delay.error.max.ms
- Add field
nflow_instance_action.typethat contains type of action:- stateExecution - for actions created with normal execution. This is also set for old actions created before this feature.
- stateExecutionFailed - for actions where execution failed due thrown exception or retry count was exceeded.
- externalChange - for changes created externally via API.
- recovery - to indicate that the workflow instance was recovered after some executor died.
- Use more optimal SQL when updating workflows when database supports updateable cte syntax
- Automatically abbreviate state text for workflow instance and workflow instance action based on field size in database
- Added WorkflowInstance.status (created, in_progress, executing, manual, finished, paused, stopped) for workflow instances
- Removed WorkflowInstance.processing which is now replaced by WorkflowInstance.status
- Workflow instance state text is now always set to a meaningful value when the instance is updated
- Make most configuration properties required and remove the default values from the source code
- Added missing default values to the configuration files
- Improved workflow definition statistics query performance and results
- Retry processing of a workflow instance that has unknown state after some delay (one hour by default, configurable)
- Move workflow instance to error state when a state processing method returns an invalid next state
- nflow-rest-api:
- Added support for user-provided action description when updating a workflow instance
- Added missing configuration options with default values
- Added support for Action.type
- Added service to pause, resume and stop the execution of the workflow instance
- Make most configuration properties required and remove the default values from the source code
- Added missing default values to the configuration files
- Moved workflow definitions statistics to /statistics/workflow/{workflow-definition-type} and return statistics per workflow state and status
- nflow-jetty:
- added missing configuration options with default values
- Make most configuration properties required and remove the default values from the source code
- Added missing default values to the configuration files
- Use nFlow Explorer version 0.0.7
v1.2.0
Highlights
- nFlow explorer (user interface) beta-version added
- workflow definitions are persisted, and persisted undeployed definitions are returned by REST API
- services for querying executor group and workflow definition statistics
Details
- nflow-engine:
- workflow initial state must be of type "start"
- workflow error state must be of final ("end" or "manual")
- workflow instance cannot be externally updated (WorkflowInstanceService.updateWorkflowInstance), when being processed by nFlow executor
- persists workflow definitions to database during startup (nflow_workflow_definition-table required)
- internal components annotated by @nflow (required e.g. for injecting application datasource to nflow)
- does not start anymore, if transactions are not enabled
- defining contradictory failure transitions using permit() no longer allowed
- bug fixes:
- theoretical problem in optimistic locking of instance polling
- binary backoff integer overflow when calculating next activation after 15 retries
- nflow-rest-api:
- return http code 404, when the requested object is not found
- /v1/workflow-definition (GET)
- returns persisted workflow definition, if the definition exists (or has existed) within the executor group, but is not deployed to the queried nFlow installation
- /v1/workflow-definition/{type}/statistics (GET)
- new resource for retrieving counts of workflow instances in different states
- /v1/workflow-instance, /v1/workflow-instance/{type} (GET)
- returns new workflow instance fields: started, created, modified, retries and actions[n].executor_id
- added query parameter limit search result size (maxResults)
- /v1/workflow-instance (PUT)
- returns http code 409, if the instance is currently being processed by nFlow executor
- bug fix: updating only next activation without state change works now
- /v1/statistics (GET)
- new resource for retrieving workflow instance queue size and lag from target activation times
- nflow-jetty:
- added nflow-explorer user interface beta-version
- search, manage and visualize workflow instances
- visualize workflow definitions
- visualize and monitor instance statistics per definition
- Swagger runtime dependency removed: service descriptions are generated in compile time to nflow-rest-api -module and served by nflow-jetty
- tuned web contexts
- /api/v1/: nFlow REST API version 1
- /doc/: nFlow REST API Swagger descriptions
- /explorer/: nflow-explorer user interface
- added nflow-explorer user interface beta-version
v1.1.0
- nflow-engine
- added executor_id to table nflow_workflow_action and exposed executor_ids in WorkflowInstanceService
- exposed workflow executors through WorkflowExecutorService
- state handling logic changes:
- stop in non-final state puts workflow to error state
- process error state handler method after exceeding max retries, unless workflow instance was already in error state
- fix: obey maxRetries when NextAction.retryAfter(...) is used
- final state handler methods should return void instead of NextAction (in 2.0.0 returning NextAction will throw exception)
- expose new fields through StateExecution: workflow instance id, workflow instance external id
- insert WorkflowInstanceAction for each recovered WorkflowInstance
- deprecated (removed in 2.0.0):
- WorkflowState.getName() (use name() instead)
- workflow instance "owner" (new term: "executor group")
- WorkflowInstanceAction.workflowId (new field: workflowInstanceId)
- internal:
- renamed WorkflowExecutor->WorkflowStateProcessor, WorkflowExecutorFactory->WorkflowStateProcessorFactory
- use configured value for workflow dispatcher awaitTermination
- nflow-rest-api
- added filter for adding CORS headers
- exposed state variables in REST API
- exposed workflow executors through REST API
- store requestData under key "requestData" (previously: "req")
- nflow-jetty
- enabled transactions using DataSourceTransactionManager
- swagger-tuning:
- nFlow branding (titles, favicons, links, etc)
- configure basepath through swagger.basepath.* -properties