src/third_party/devtools/test/unittests/front_end/common/Progress.ts

// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

const {assert} = chai;

import {default as Progress, CompositeProgress, ProgressProxy} from '../../../../front_end/common/Progress.js';

class MockProgressIndicator implements Progress {
  private isCanceledInternal = false;
  private totalWork = 0;
  private workCompleted = 0;
  private title!: string|undefined;

  get getTitle(): string|undefined {
    return this.title;
  }

  get getWorkCompleted(): number {
    return this.workCompleted;
  }

  get getTotalWork(): number {
    return this.totalWork;
  }

  isCanceled() {
    return this.isCanceledInternal;
  }

  done() {
    return 'progress indicator: done';
  }

  setTotalWork(totalWork: number) {
    this.totalWork = totalWork;
  }

  setWorked(worked: number, title: string) {
    this.workCompleted = worked;
    if (typeof title !== 'undefined') {
      this.title = title;
    }
  }

  setTitle(title: string) {
    this.title = title;
  }

  // Test methods.
  cancel() {
    this.isCanceledInternal = true;
  }
}

describe('Composite Progress Bar', () => {
  it('works correctly with a single subprogress', () => {
    const indicator = new MockProgressIndicator();
    const composite = new CompositeProgress(indicator);
    const subProgress = composite.createSubProgress();

    assert.equal(indicator.getTitle, undefined);
    assert.equal(indicator.getWorkCompleted, 0);
    assert.equal(indicator.getTotalWork, 1);

    subProgress.setTitle('cuckooing');
    subProgress.setWorked(10);
    assert.equal(indicator.getTitle, 'cuckooing');
    assert.equal(indicator.getWorkCompleted, 0);
    assert.equal(indicator.getTotalWork, 1);

    subProgress.setTotalWork(100);
    assert.equal(indicator.getTitle, 'cuckooing');
    assert.equal(indicator.getWorkCompleted, 0.1);
    assert.equal(indicator.getTotalWork, 1);

    subProgress.setWorked(20, 'meowing');
    assert.equal(indicator.getTitle, 'meowing');
    assert.equal(indicator.getWorkCompleted, 0.2);
    assert.equal(indicator.getTotalWork, 1);

    subProgress.done();
    assert.equal(indicator.getTitle, 'meowing');
    assert.equal(indicator.getWorkCompleted, 1);
    assert.equal(indicator.getTotalWork, 1);
  });

  it('works correctly with multiple subprogresses', () => {
    const indicator = new MockProgressIndicator();
    const composite = new CompositeProgress(indicator);
    // Creates a sub progress with the default weight of 1
    const subProgress1 = composite.createSubProgress();
    // Creates a sub progress with the weight of 3
    const subProgress2 = composite.createSubProgress(3);

    assert.equal(indicator.getTitle, undefined);
    assert.equal(indicator.getWorkCompleted, 0);
    assert.equal(indicator.getTotalWork, 1);

    subProgress1.setTitle('cuckooing');
    subProgress1.setTotalWork(100);
    subProgress1.setWorked(20);
    assert.equal(indicator.getTitle, 'cuckooing');
    assert.equal(indicator.getWorkCompleted, 0.05);
    assert.equal(indicator.getTotalWork, 1);

    subProgress2.setWorked(10);
    assert.equal(indicator.getTitle, 'cuckooing');
    assert.equal(indicator.getWorkCompleted, 0.05);
    assert.equal(indicator.getTotalWork, 1);

    subProgress2.setTotalWork(10);
    subProgress2.setWorked(3, 'barking');
    assert.equal(indicator.getTitle, 'barking');
    assert.equal(indicator.getWorkCompleted, 0.275);
    assert.equal(indicator.getTotalWork, 1);

    subProgress1.setWorked(50, 'meowing');
    subProgress2.setWorked(5);
    assert.equal(indicator.getTitle, 'meowing');
    assert.equal(indicator.getWorkCompleted, 0.5);
    assert.equal(indicator.getTotalWork, 1);

    subProgress2.done();
    assert.equal(indicator.getTitle, 'meowing');
    assert.equal(indicator.getWorkCompleted, 0.875);
    assert.equal(indicator.getTotalWork, 1);

    subProgress1.done();
    assert.equal(indicator.getTitle, 'meowing');
    assert.equal(indicator.getWorkCompleted, 1);
    assert.equal(indicator.getTotalWork, 1);
  });

  it('returns the correct cancellation status', () => {
    const indicator = new MockProgressIndicator();
    const composite = new CompositeProgress(indicator);
    const subProgress = composite.createSubProgress();

    assert.isFalse(subProgress.isCanceled(), 'progress should not be canceled');
    indicator.cancel();
    assert.isTrue(subProgress.isCanceled(), 'progress should be canceled');
  });

  it('works correctly with nested subprogresses', () => {
    const indicator = new MockProgressIndicator();
    const composite0 = new CompositeProgress(indicator);
    const subProgress01 = composite0.createSubProgress();
    const composite1 = new CompositeProgress(subProgress01);
    const subProgress11 = composite1.createSubProgress(10);  // Weight should have no effect

    assert.equal(indicator.getTitle, undefined);
    assert.equal(indicator.getWorkCompleted, 0);
    assert.equal(indicator.getTotalWork, 1);

    subProgress11.setWorked(10);
    assert.equal(indicator.getTitle, undefined);
    assert.equal(indicator.getWorkCompleted, 0);
    assert.equal(indicator.getTotalWork, 1);

    subProgress11.setTotalWork(100);
    assert.equal(indicator.getTitle, undefined);
    assert.equal(indicator.getWorkCompleted, 0.1);
    assert.equal(indicator.getTotalWork, 1);

    subProgress11.setWorked(50, 'meowing');
    assert.equal(indicator.getTitle, 'meowing');
    assert.equal(indicator.getWorkCompleted, 0.5);
    assert.equal(indicator.getTotalWork, 1);

    assert.isFalse(subProgress11.isCanceled(), 'progress should not be canceled');
    indicator.cancel();
    assert.isTrue(subProgress11.isCanceled(), 'progress should be canceled');

    subProgress11.done();
    assert.equal(indicator.getTitle, 'meowing');
    assert.equal(indicator.getWorkCompleted, 1);
    assert.equal(indicator.getTotalWork, 1);
  });

  it('can set sub progress to be worked', () => {
    const indicator = new MockProgressIndicator();
    const composite = new CompositeProgress(indicator);
    const subProgress = composite.createSubProgress();

    assert.equal(indicator.getTitle, undefined);
    assert.equal(indicator.getWorkCompleted, 0);
    assert.equal(indicator.getTotalWork, 1);
    assert.equal(subProgress._worked, 0);

    subProgress.worked();

    assert.equal(indicator.getTitle, undefined);
    assert.equal(indicator.getWorkCompleted, 0);
    assert.equal(indicator.getTotalWork, 1);
    assert.equal(subProgress._worked, 1);
  });

  it('returns the correct cancellation status for a progress proxy with no delegate', () => {
    const progressProxy = new ProgressProxy();
    assert.isFalse(progressProxy.isCanceled());
  });

  it('returns the correct cancellation status for a progress proxy with delegate', () => {
    const indicator = new MockProgressIndicator();
    const composite = new CompositeProgress(indicator);
    const subProgress = composite.createSubProgress();
    const progressProxy = new ProgressProxy(subProgress);

    assert.isFalse(progressProxy.isCanceled(), 'progress should not be canceled');
    indicator.cancel();
    assert.isTrue(progressProxy.isCanceled(), 'progress should be canceled');
  });

  it('returns the correct title for a progress proxy with no delegate', () => {
    const indicator = new MockProgressIndicator();
    const progressProxy = new ProgressProxy();

    progressProxy.setTitle('test proxy');
    assert.isUndefined(indicator.getTitle);
  });

  it('returns the correct title for a progress proxy with delegate', () => {
    const indicator = new MockProgressIndicator();
    const composite = new CompositeProgress(indicator);
    const subProgress = composite.createSubProgress();
    const progressProxy = new ProgressProxy(subProgress);

    progressProxy.setTitle('test proxy');
    assert.equal(indicator.getTitle, 'test proxy');
  });

  it('marks a progress proxy as done', () => {
    const indicator = new MockProgressIndicator();
    const composite = new CompositeProgress(indicator);
    const subProgress = composite.createSubProgress();
    const progressProxy = new ProgressProxy(subProgress);

    progressProxy.setTotalWork(1);
    progressProxy.done();
    assert.equal(subProgress._worked, 1);
  });

  it('able to set worked with title for a progress proxy', () => {
    const indicator = new MockProgressIndicator();
    const composite = new CompositeProgress(indicator);
    const subProgress = composite.createSubProgress();
    const progressProxy = new ProgressProxy(subProgress);

    progressProxy.setWorked(1, 'test proxy');
    assert.equal(subProgress._worked, 1);
    assert.equal(indicator.getTitle, 'test proxy');
  });

  it('able to set worked without title for a progress proxy', () => {
    const indicator = new MockProgressIndicator();
    const composite = new CompositeProgress(indicator);
    const subProgress = composite.createSubProgress();
    const progressProxy = new ProgressProxy(subProgress);

    progressProxy.worked(1);
    assert.equal(subProgress._worked, 1);
  });
});