File

projects/netgrif-components-core/src/lib/task/services/finish-task.service.ts

Description

Service that handles the logic of finishing a task.

Extends

TaskHandlingService

Index

Methods

Constructor

constructor(_log: LoggerService, _taskResourceService: TaskResourceService, _snackBar: SnackBarService, _translate: TranslateService, _taskState: TaskRequestStateService, _taskDataService: TaskDataService, _callChain: CallChainService, _taskEvent: TaskEventService, _eventQueue: EventQueueService, _eventService: EventService, _changedFieldsService: ChangedFieldsService, _taskOperations: TaskOperations, _selectedCaseService: SelectedCaseService, _taskContentService: TaskContentService)
Parameters :
Name Type Optional
_log LoggerService No
_taskResourceService TaskResourceService No
_snackBar SnackBarService No
_translate TranslateService No
_taskState TaskRequestStateService No
_taskDataService TaskDataService No
_callChain CallChainService No
_taskEvent TaskEventService No
_eventQueue EventQueueService No
_eventService EventService No
_changedFieldsService ChangedFieldsService No
_taskOperations TaskOperations No
_selectedCaseService SelectedCaseService No
_taskContentService TaskContentService No

Methods

Protected completeActions
completeActions(afterAction: AfterAction, nextEvent: AfterAction, result: boolean, outcome?: TaskEventOutcome)

Completes all the action streams and sends the notification, with the provided result

Parameters :
Name Type Optional
afterAction AfterAction No
nextEvent AfterAction No
result boolean No
outcome TaskEventOutcome Yes
Returns : void
Protected performFinishRequest
performFinishRequest(afterAction: AfterAction, nextEvent: AfterAction)

Performs a finish request on the task currently stored in the taskContent service

Parameters :
Name Type Optional Description
afterAction AfterAction No

the action that should be performed after the request is processed

nextEvent AfterAction No

indicates to the event queue that the next event can be processed

Returns : void
Protected queueFinishTaskRequest
queueFinishTaskRequest(afterAction: AfterAction)

Sends the finish request to backend and notifies the user about the outcome of the operation via a snack bar message.

Doesn't send any requests if the loading indicator is in it's active state. Otherwise sets the indicator to the active state and disables it once the request response is received.

The argument can be used to chain operations together, or to execute code conditionally based on the success state of the finish request.

If the task held within the TaskContentService changes before a response is received, the response will be ignored and the afterAction will not be executed. otherwise false will be emitted

Parameters :
Name Type Optional Description
afterAction AfterAction No

if finish request completes successfully true will be emitted into this Subject, otherwise false will be emitted

Returns : void
Protected sendNotification
sendNotification(success: boolean, outcome?: TaskEventOutcome)

Publishes a finish notification to the TaskEventService

Parameters :
Name Type Optional Description
success boolean No

whether the finish operation was successful or not

outcome TaskEventOutcome Yes

TaskEventOutcome

Returns : void
Public validateDataAndFinish
validateDataAndFinish(afterAction: AfterAction)

Updates the task data to their current state from backend, checks the validity of the data and sends a finish request to backend.

Finish request is not sent if the task contains invalid data.

If an update to the data is already in progress waits for it's successful completion and sends the finish request after.

otherwise false will be emitted

Parameters :
Name Type Optional Default value Description
afterAction AfterAction No new AfterAction()

if finish request completes successfully true will be emitted into this Subject, otherwise false will be emitted

Returns : void
Protected isTaskPresent
isTaskPresent()
Inherited from TaskHandlingService
Returns : boolean

true if a {

Protected isTaskRelevant
isTaskRelevant(requestedTaskId: string)
Inherited from TaskHandlingService

Checks whether the current state of the TaskContentService and optionally if the SelectedCaseService, is still relevant to the task that was requested.

This method is useful if you use UnlimitedTaskContentService, or a similar implementation. It is possible for the currently "selected" task to change in-between a backend request was sent and the response was received. In that case the response is no longer relevant and should be discarded, otherwise an illegal task state could be achieved on frontend.

Parameters :
Name Type Optional Description
requestedTaskId string No

the stringId of the requested task

Returns : boolean

true if the requested task is still relevant to the state of the frontend. Returns false otherwise.

import {Inject, Injectable, Optional} from '@angular/core';
import {take} from 'rxjs/operators';
import {LoggerService} from '../../logger/services/logger.service';
import {TaskContentService} from '../../task-content/services/task-content.service';
import {TaskResourceService} from '../../resources/engine-endpoint/task-resource.service';
import {SnackBarService} from '../../snack-bar/services/snack-bar.service';
import {TranslateService} from '@ngx-translate/core';
import {TaskRequestStateService} from './task-request-state.service';
import {TaskDataService} from './task-data.service';
import {TaskHandlingService} from './task-handling-service';
import {NAE_TASK_OPERATIONS} from '../models/task-operations-injection-token';
import {TaskOperations} from '../interfaces/task-operations';
import {CallChainService} from '../../utility/call-chain/call-chain.service';
import {SelectedCaseService} from './selected-case.service';
import {createTaskEventNotification} from '../../task-content/model/task-event-notification';
import {TaskEvent} from '../../task-content/model/task-event';
import {TaskEventService} from '../../task-content/services/task-event.service';
import {FinishTaskEventOutcome} from '../../event/model/event-outcomes/task-outcomes/finish-task-event-outcome';
import {EventOutcomeMessageResource} from '../../resources/interface/message-resource';
import {EventQueueService} from '../../event-queue/services/event-queue.service';
import {QueuedEvent} from '../../event-queue/model/queued-event';
import {AfterAction} from '../../utility/call-chain/after-action';
import {ChangedFieldsService} from '../../changed-fields/services/changed-fields.service';
import {EventService} from '../../event/services/event.service';
import {ChangedFieldsMap} from '../../event/services/interfaces/changed-fields-map';
import {TaskEventOutcome} from '../../event/model/event-outcomes/task-outcomes/task-event-outcome';


/**
 * Service that handles the logic of finishing a task.
 */
@Injectable()
export class FinishTaskService extends TaskHandlingService {

    constructor(protected _log: LoggerService,
                protected _taskResourceService: TaskResourceService,
                protected _snackBar: SnackBarService,
                protected _translate: TranslateService,
                protected _taskState: TaskRequestStateService,
                protected _taskDataService: TaskDataService,
                protected _callChain: CallChainService,
                protected _taskEvent: TaskEventService,
                protected _eventQueue: EventQueueService,
                protected _eventService: EventService,
                protected _changedFieldsService: ChangedFieldsService,
                @Inject(NAE_TASK_OPERATIONS) protected _taskOperations: TaskOperations,
                @Optional() _selectedCaseService: SelectedCaseService,
                _taskContentService: TaskContentService) {
        super(_taskContentService, _selectedCaseService);
    }

    /**
     * Updates the task data to their current state from backend, checks the validity of the data and
     * sends a finish request to backend.
     *
     * Finish request is not sent if the task contains invalid data.
     *
     * If an update to the data is already in progress waits for it's successful completion and sends the finish request after.
     *
     * @param afterAction if finish request completes successfully `true` will be emitted into this Subject,
     * otherwise `false` will be emitted
     */
    public validateDataAndFinish(afterAction: AfterAction = new AfterAction()): void {
        if (this.dataIsEmpty()) {
            this._taskDataService.initializeTaskDataFields(this._callChain.create(() => {
                if (this._safeTask.dataSize <= 0 ||
                    (this._taskContentService.validateDynamicEnumField() && this._taskContentService.validateTaskData())) {
                    this.queueFinishTaskRequest(afterAction);
                }
            }));
        } else if (this._taskContentService.validateDynamicEnumField() && this._taskContentService.validateTaskData()) {
            const finishedTaskId = this._safeTask.stringId;
            this._taskDataService.updateTaskDataFields(this._callChain.create(success => {
                    if (success && this._taskState.isUpdating(finishedTaskId)) {
                        this._taskDataService.updateSuccess$.pipe(take(1)).subscribe(bool => {
                            if (bool) {
                                this.queueFinishTaskRequest(afterAction);
                            }
                        });
                    } else if (success) {
                        this.queueFinishTaskRequest(afterAction);
                    }
            }));
        }
    }

    /**
     * Sends the finish request to backend and notifies the user about the outcome of the operation via a snack bar message.
     *
     * Doesn't send any requests if the loading indicator is in it's active state.
     * Otherwise sets the indicator to the active state and disables it once the request response is received.
     *
     * The argument can be used to chain operations together,
     * or to execute code conditionally based on the success state of the finish request.
     *
     * If the task held within the {@link TaskContentService} changes before a response is received, the response will be ignored
     * and the `afterAction` will not be executed.
     * @param afterAction if finish request completes successfully `true` will be emitted into this Subject,
     * otherwise `false` will be emitted
     */
    protected queueFinishTaskRequest(afterAction: AfterAction): void {
        this._eventQueue.scheduleEvent(new QueuedEvent(
            () => true,
            nextEvent => {
                this.performFinishRequest(afterAction, nextEvent);
            }
        ));
    }

    /**
     * Performs a `finish` request on the task currently stored in the `taskContent` service
     * @param afterAction the action that should be performed after the request is processed
     * @param nextEvent indicates to the event queue that the next event can be processed
     */
    protected performFinishRequest(afterAction: AfterAction, nextEvent: AfterAction) {
        const finishedTaskId = this._safeTask.stringId;

        // this is probably no longer necessary because of the event queue
        if (this._taskState.isLoading(finishedTaskId)) {
            nextEvent.resolve(true);
            return;
        }

        this._taskState.startLoading(finishedTaskId);

        this._taskResourceService.finishTask(this._safeTask.stringId).pipe(take(1))
            .subscribe((outcomeResource: EventOutcomeMessageResource) => {
            this._taskState.stopLoading(finishedTaskId);
            if (!this.isTaskRelevant(finishedTaskId)) {
                this._log.debug('current task changed before the finish response could be received, discarding...');
                nextEvent.resolve(false);
                return;
            }

            if (outcomeResource.success) {
                this._taskContentService.updateStateData(outcomeResource.outcome as FinishTaskEventOutcome);
                const changedFieldsMap: ChangedFieldsMap = this._eventService
                    .parseChangedFieldsFromOutcomeTree(outcomeResource.outcome);
                if (!!changedFieldsMap) {
                    this._changedFieldsService.emitChangedFields(changedFieldsMap);
                }
                this._taskOperations.reload();
                this.completeActions(afterAction, nextEvent, true, outcomeResource.outcome as FinishTaskEventOutcome);
                this._taskOperations.close();
                this._snackBar.openSuccessSnackBar(outcomeResource.outcome.message === undefined
                    ? this._translate.instant('tasks.snackbar.finishTaskSuccess')
                    : outcomeResource.outcome.message);
            } else if (outcomeResource.error !== undefined) {
                if (outcomeResource.error !== '') {
                    this._snackBar.openErrorSnackBar(outcomeResource.error);
                }
                if (outcomeResource.outcome !== undefined) {
                    const changedFieldsMap = this._eventService.parseChangedFieldsFromOutcomeTree(outcomeResource.outcome);
                    this._changedFieldsService.emitChangedFields(changedFieldsMap);
                }
                this.completeActions(afterAction, nextEvent, false);
            }
        }, error => {
            this._taskState.stopLoading(finishedTaskId);
            this._log.debug('finishing task failed', error);

            if (!this.isTaskRelevant(finishedTaskId)) {
                this._log.debug('current task changed before the finish error could be received');
                nextEvent.resolve(false);
                return;
            }

            this._snackBar.openErrorSnackBar(`${this._translate.instant('tasks.snackbar.finishTask')}
             ${this._task.title} ${this._translate.instant('tasks.snackbar.failed')}`);
            this.completeActions(afterAction, nextEvent, false);
        });
    }

    /**
     * Completes all the action streams and sends the notification, with the provided result
     */
    protected completeActions(afterAction: AfterAction, nextEvent: AfterAction, result: boolean, outcome?: TaskEventOutcome) {
        this.sendNotification(result, outcome);
        afterAction.resolve(result);
        nextEvent.resolve(result);
    }

    /**
     * Publishes a finish notification to the {@link TaskEventService}
     * @param success whether the finish operation was successful or not
     * @param outcome TaskEventOutcome
     */
    protected sendNotification(success: boolean, outcome?: TaskEventOutcome): void {
        this._taskEvent.publishTaskEvent(createTaskEventNotification(this._safeTask, TaskEvent.FINISH, success, outcome));
    }

    /**
     * Checks data size
     * @return boolean whether the task contains data or not
     */
    private dataIsEmpty(): boolean {
        return this._safeTask.dataSize <= 0 || !this._safeTask.dataGroups || this._safeTask.dataGroups.length <= 0;
    }
}

result-matching ""

    No results matching ""