openproject/frontend/app/components/wp-edit-form/work-package-changeset.ts

// -- copyright
// OpenProject is a project management system.
// Copyright (C) 2012-2015 the OpenProject Foundation (OPF)
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License version 3.
//
// OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
// Copyright (C) 2006-2013 Jean-Philippe Lang
// Copyright (C) 2010-2013 the ChiliProject Team
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//
// See doc/COPYRIGHT.rdoc for more details.
// ++

import {
  WorkPackageResource,
  WorkPackageResourceInterface
} from '../api/api-v3/hal-resources/work-package-resource.service';
import {FormResourceInterface} from '../api/api-v3/hal-resources/form-resource.service';
import {$injectFields} from '../angular/angular-injector-bridge.functions';
import {debugLog} from '../../helpers/debug_output';
import {SchemaCacheService} from '../schemas/schema-cache.service';
import {WorkPackageCacheService} from '../work-packages/work-package-cache.service';
import {WorkPackageCreateService} from '../wp-create/wp-create.service';
import {input} from 'reactivestates';
import {WorkPackageNotificationService} from '../wp-edit/wp-notification.service';
import {WorkPackageEditingService} from './work-package-editing-service';
import {ErrorResource} from '../api/api-v3/hal-resources/error-resource.service';
import {HalResource} from '../api/api-v3/hal-resources/hal-resource.service';
import {CollectionResource} from '../api/api-v3/hal-resources/collection-resource.service';

export class WorkPackageChangeset {
  // Injections
  public $q:ng.IQService;
  public wpNotificationsService:WorkPackageNotificationService;
  public schemaCacheService:SchemaCacheService;
  public wpCacheService:WorkPackageCacheService;
  public wpCreate:WorkPackageCreateService;
  public wpEditing:WorkPackageEditingService;

  // The changeset to be applied to the work package
  private changes:{[attribute:string]:any} = {};
  public inFlight:boolean = false;

  // The current work package form
  public wpForm = input<FormResourceInterface>();

  // The current editing resource
  public resource:WorkPackageResourceInterface|null;

  constructor(public workPackage:WorkPackageResourceInterface, form?:FormResourceInterface) {
    $injectFields(
      this, 'wpNotificationsService', '$q', 'schemaCacheService',
      'wpCacheService', 'wpCreate', 'wpEditing'
    );

    // New work packages have no schema set yet, so update the form immediately to get one
    if (form !== undefined) {
      this.wpForm.putValue(form);
    }
  }

  public reset(key:string) {
    delete this.changes[key];
    this.buildResource();
  }

  public clear() {
    this.changes = {};
    this.wpForm.clear();
  }

  public get empty() {
    return _.isEmpty(this.changes);
  }

  /**
   * Retrieve the editing value for the given attribute
   *
   * @param {string} key The attribute to read
   * @return {any} Either the value from the overriden change, or the default value
   */
  public value(key:string) {
    if (this.isOverridden(key)) {
      return this.changes[key];
    } else {
      return this.workPackage[key];
    }
  }

  public setValue(key:string, val:any) {
    this.changes[key] = val;

    // Update the form for fields that may alter the form itself
    // when the work package is new. Otherwise, the save request afterwards
    // will update the form automatically.
    if (this.workPackage.isNew && (key === 'project' || key === 'type')) {
      this.updateForm();
    }
  }

  /**
   * Return whether a change value exist for the given attribute key.
   * @param {string} key
   * @return {boolean}
   */
  public isOverridden(key:string) {
    return this.changes.hasOwnProperty(key);
  }

  public getForm():Promise<FormResourceInterface> {
    this.wpForm.putFromPromiseIfPristine(() => {
      return this.updateForm();
    });


    if (this.wpForm.hasValue()) {
      return Promise.resolve(this.wpForm.value!);
    } else {
      return new Promise((resolve, ) => this.wpForm.valuesPromise().then(resolve));
    }
  }

  /**
   * Update the form resource from the API.
   * @return {angular.IPromise<any>}
   */
  public updateForm():ng.IPromise<FormResourceInterface> {
    let payload = this.buildPayloadFromChanges();
    var deferred = this.$q.defer<FormResourceInterface>();

    this.workPackage.$links.update(payload)
      .then((form:FormResourceInterface) => {
        this.wpForm.putValue(form);
        this.buildResource();

        deferred.resolve(form);
      })
      .catch((error:any) => {
        this.wpForm.clear();
        this.wpNotificationsService.handleErrorResponse(error, this.workPackage);
        deferred.reject(error);
      });

    return deferred.promise;
  }


  public save():ng.IPromise<WorkPackageResourceInterface> {
    const deferred = this.$q.defer<WorkPackageResourceInterface>();

    this.inFlight = true;
    const wasNew = this.workPackage.isNew;
    this.updateForm()
      .then((form) => {
        const payload = this.buildPayloadFromChanges();

        // Reject errors when occurring in form validation
        const errors = ErrorResource.fromFormResponse(form);
        if (errors !== null) {
          return deferred.reject(errors);
        }

        this.workPackage.$links.updateImmediately(payload)
          .then((savedWp:WorkPackageResourceInterface) => {
            // Initialize any potentially new HAL values
            this.workPackage.$initialize(savedWp);

            // Ensure the schema is loaded before updating
            this.schemaCacheService.ensureLoaded(this.workPackage).then(() => {
              this.workPackage.updateActivities();

              if (wasNew) {
                this.workPackage.overriddenSchema = undefined;
                this.workPackage.uploadAttachmentsAndReload();
                this.wpCreate.newWorkPackageCreated(this.workPackage);
              }

              this.wpCacheService.updateWorkPackage(this.workPackage);
              this.resource = null;
              this.clear();
              deferred.resolve(this.workPackage);
            });
          })
          .catch(error => {
            // Update the resource anyway
            this.buildResource();
            deferred.reject({
              errorsOnForm: false,
              error: error
            });
          });
      })
      .catch(deferred.reject);

    return deferred.promise.finally(() => this.inFlight = false);
  }

  /**
   * Merge the current changes into the payload resource.
   *
   * @param {FormResourceInterface} form
   * @return {any}
   */
  private mergeWithPayload(plainPayload:any) {
    // Fall back to the last known state of the work package should the form not be loaded.
    let reference = this.workPackage.$source;
    if (this.wpForm.hasValue()) {
      reference = this.wpForm.value!.payload.$source;
    }

    _.each(this.changes, (val:any, key:string) => {
      const fieldSchema = this.schema[key];
      if (!(typeof(fieldSchema) === 'object' && fieldSchema.writable === true)) {
        debugLog(`Trying to write ${key} but is not writable in schema`);
        return;
      }

      // Override in _links if it is a linked property
      if (reference._links[key]) {
        plainPayload._links[key] = this.getLinkedValue(val, fieldSchema);
      } else {
        plainPayload[key] = this.changes[key];
      }
    });

    return plainPayload;
  }

  /**
   * Create the payload from the current changes, and extend it with the current lock version.
   * -- This is the place to add additional logic when the lockVersion changed in between --
   */
  private buildPayloadFromChanges() {
    let payload;

    if (this.workPackage.isNew) {
      // If the work package is new, we need to pass the entire form payload
      // to let all default values be transmitted (type, status, etc.)
      if (this.wpForm.hasValue()) {
        payload = this.wpForm.value!.payload.$source;
      } else {
        payload = this.workPackage.$source;
      }
    } else {
      // Otherwise, simply use the bare minimum, which is the lock version.
      payload = this.minimalPayload;
    }

    return this.mergeWithPayload(payload);
  }

  private get minimalPayload() {
    return { lockVersion: this.workPackage.lockVersion, _links: {} };
  }

  /**
   * Extract the link(s) in the given changed value
   */
  private getLinkedValue(val:any, fieldSchema:op.FieldSchema) {
    var isArray = (fieldSchema.type || '').startsWith('[]');

    if (isArray) {
      var links:{ href:string }[] = [];

      if (val) {
        var elements = (val.forEach && val) || val.elements;

        elements.forEach((link:{ href:string }) => {
          if (link.href) {
            links.push({href: link.href});
          }
        });
      }

      return links;
    } else {
      return { href: _.get(val, 'href', null) };
    }
  }

  /**
   * Get the best schema currently available, either the default WP schema (must exist).
   * If loaded, return the form schema, which provides better information on writable status
   * and contains available values.
   */
  public get schema() {
    return this.wpForm.getValueOr(this.workPackage).schema;
  }

  public getSchemaName(attribute:string):string {
    if (this.schema.hasOwnProperty('date') && (attribute === 'startDate' || attribute === 'dueDate')) {
      return 'date';
    } else {
      return attribute;
    }
  }

  private buildResource() {
    if (this.empty) {
      this.resource = null;
      this.wpEditing.updateValue(this.workPackage.id, this);
      return;
    }

    const hasForm = this.wpForm.hasValue();
    let payload:any = this.workPackage.$plain();

    if (hasForm) {
      _.defaultsDeep(payload, this.wpForm.value!.payload.$source);
    }

    const resource = new WorkPackageResource(this.mergeWithPayload(payload), true);

    // Override the schema with the current form, if any.
    resource.overriddenSchema = this.schema;
    this.resource = (resource as WorkPackageResourceInterface);
    this.wpEditing.updateValue(this.workPackage.id, this);
  }
}