tests_utils_array.test.js

import {describe, test, assert} from 'vitest';
import {stringToUint8Array} from '../../src/utils/string.js';
import {
  toStringId,
  getArrayFromStringId,
  arrayMap,
  arrayContains,
  arraySortEquals,
  arrayEquals,
  parseMultipart,
  buildMultipart
} from '../../src/utils/array.js';

/**
 * Tests for the 'utils/array' file.
 */
/** @module tests/utils */

describe('utils', () => {

  /**
   * Tests for {@link toStringId}.
   *
   * @function module:tests/utils~tostringid
   */
  test('toStringId', () => {
    // test #00: all dims
    const i00 = [1, 2, 3];
    const i00strId = '#0-1_#1-2_#2-3';
    assert.equal(toStringId(i00), i00strId, 'toStringId #00');
    assert.ok(arrayEquals(getArrayFromStringId(i00strId), i00),
      'getFromStringId #00');

    // test #01: 2 dims
    const i01 = [0, 2, 3];
    const i01strId = '#1-2_#2-3';
    assert.equal(toStringId(i01, [1, 2]), i01strId, 'toStringId #01');
    assert.ok(arrayEquals(getArrayFromStringId(i01strId), i01),
      'getFromStringId #01');

    // test #01: 1 dim -> X
    const i02 = [1, 0, 0];
    const i02strId = '#0-1';
    assert.equal(toStringId(i02, [0]), i02strId, 'toStringId #02');
    assert.ok(arrayEquals(getArrayFromStringId(i02strId), i02),
      'getFromStringId #02');

    // test #03: 1 dim -> Y
    const i03 = [0, 2, 0];
    const i03strId = '#1-2';
    assert.equal(toStringId(i03, [1]), i03strId, 'toStringId #03');
    assert.ok(arrayEquals(getArrayFromStringId(i03strId), i03),
      'getFromStringId #03');

    // test #04: 1 dim -> Z
    const i04 = [0, 0, 3];
    const i04strId = '#2-3';
    assert.equal(toStringId(i04, [2]), i04strId, 'toStringId #04');
    assert.ok(arrayEquals(getArrayFromStringId(i04strId), i04),
      'getFromStringId #04');

    // test #05: 4 dims
    const i05 = [1, 2, 3, 4];
    const i05strId = '#0-1_#1-2_#2-3_#3-4';
    assert.equal(toStringId(i05), i05strId, 'toStringId #05');
    assert.ok(arrayEquals(getArrayFromStringId(i05strId), i05),
      'getFromStringId #05');

    // test #06: 5 dims
    const i06 = [0, 0, 0, 0, 1];
    const i06strId = '#4-1';
    assert.equal(toStringId(i06, [4]), i06strId, 'toStringId #06');
    assert.ok(arrayEquals(getArrayFromStringId(i06strId), i06),
      'getFromStringId #06');

    // error case
    const i10 = [0, 0, 0];
    assert.throws(function () {
      toStringId(i10, [3]);
    },
    Error,
    'Non valid dimension for toStringId',
    'toStringId error');
  });

  /**
   * Tests for {@link arrayMap}.
   *
   * @function module:tests/utils~arraymap
   */
  test('arrayMap', () => {
    // basic case
    const arr000 = [0, 1, 2, 3];
    const arr001 = [1, 2, 3, 4];
    const res00 = arrayMap(arr000, arr001, Math.min);
    const theoRes00 = [0, 1, 2, 3];
    assert.deepEqual(res00, theoRes00, 'test #00');

    // smaller second array
    const arr010 = [0, 1, 2, 3];
    const arr011 = [1, 2, 3];
    const res01 = arrayMap(arr010, arr011, Math.min);
    const theoRes01 = [0, 1, 2, 3];
    assert.deepEqual(res01, theoRes01, 'test #01');

    // smaller first array
    const arr020 = [0, 1, 2];
    const arr021 = [1, 2, 3, 4];
    const res02 = arrayMap(arr020, arr021, Math.min);
    const theoRes02 = [0, 1, 2, 4];
    assert.deepEqual(res02, theoRes02, 'test #02');

    // undefined in second array
    const arr100 = [0, 1, 2];
    const arr101 = [1, undefined, 3];
    const res10 = arrayMap(arr100, arr101, Math.min);
    const theoRes10 = [0, 1, 2];
    assert.deepEqual(res10, theoRes10, 'test #10');

    // undefined in first array
    const arr110 = [0, undefined, 2];
    const arr111 = [1, 2, 3];
    const res11 = arrayMap(arr110, arr111, Math.min);
    const theoRes11 = [0, 2, 2];
    assert.deepEqual(res11, theoRes11, 'test #11');

    // undefined in both arrays
    const arr120 = [0, undefined, 2];
    const arr121 = [1, undefined, 3];
    const res12 = arrayMap(arr120, arr121, Math.min);
    const theoRes12 = [0, undefined, 2];
    assert.deepEqual(res12, theoRes12, 'test #12');
  });

  /**
   * Tests for {@link arrayContains}.
   *
   * @function module:tests/utils~arraycontains
   */
  test('arrayContains', () => {
    let arr00;
    let arrTest000;
    assert.notOk(arrayContains(arr00, arrTest000), 'contains test #000');
    const arrTest001 = null;
    assert.notOk(arrayContains(arr00, arrTest001), 'contains test #001');
    const arrTest002 = [];
    assert.notOk(arrayContains(arr00, arrTest002), 'contains test #002');
    const arrTest003 = [''];
    assert.notOk(arrayContains(arr00, arrTest003), 'contains test #003');
    const arrTest004 = ['a'];
    assert.notOk(arrayContains(arr00, arrTest004), 'contains test #004');

    const arr10 = null;
    let arrTest100;
    assert.notOk(arrayContains(arr10, arrTest100), 'contains test #100');
    const arrTest101 = null;
    assert.notOk(arrayContains(arr10, arrTest101), 'contains test #101');
    const arrTest102 = [];
    assert.notOk(arrayContains(arr10, arrTest102), 'contains test #102');
    const arrTest103 = [''];
    assert.notOk(arrayContains(arr10, arrTest103), 'contains test #103');
    const arrTest104 = ['a'];
    assert.notOk(arrayContains(arr10, arrTest104), 'contains test #104');

    const arr20 = [];
    let arrTest200;
    assert.notOk(arrayContains(arr20, arrTest200), 'contains test #200');
    const arrTest201 = null;
    assert.notOk(arrayContains(arr20, arrTest201), 'contains test #201');
    const arrTest202 = [];
    assert.notOk(arrayContains(arr20, arrTest202), 'contains test #202');
    const arrTest203 = [''];
    assert.notOk(arrayContains(arr20, arrTest203), 'contains test #203');
    const arrTest204 = ['a'];
    assert.notOk(arrayContains(arr20, arrTest204), 'contains test #204');

    const arr30 = ['a', 'b', 'c'];
    const arrTest300 = ['a'];
    assert.ok(arrayContains(arr30, arrTest300), 'contains test #300');
    const arrTest301 = ['a', 'b'];
    assert.ok(arrayContains(arr30, arrTest301), 'contains test #301');
    const arrTest302 = ['b', 'a'];
    assert.ok(arrayContains(arr30, arrTest302), 'contains test #302');
    const arrTest303 = ['a', 'b', 'c'];
    assert.ok(arrayContains(arr30, arrTest303), 'contains test #303');
    let arrTest310;
    assert.notOk(arrayContains(arr30, arrTest310), 'contains test #310');
    const arrTest311 = null;
    assert.notOk(arrayContains(arr30, arrTest311), 'contains test #311');
    const arrTest312 = [];
    assert.notOk(arrayContains(arr30, arrTest312), 'contains test #312');
    const arrTest313 = [''];
    assert.notOk(arrayContains(arr30, arrTest313), 'contains test #313');
    const arrTest320 = ['d'];
    assert.notOk(arrayContains(arr30, arrTest320), 'contains test #320');
    const arrTest321 = ['a', 'd'];
    assert.notOk(arrayContains(arr30, arrTest321), 'contains test #321');
    const arrTest322 = ['d', 'a'];
    assert.notOk(arrayContains(arr30, arrTest322), 'contains test #322');
    const arrTest323 = [0, 'a'];
    assert.notOk(arrayContains(arr30, arrTest323), 'contains test #323');
    const arrTest324 = ['a', 'b', 'c', 0];
    assert.notOk(arrayContains(arr30, arrTest324), 'contains test #324');
  });

  /**
   * Tests for {@link arraySortEquals}.
   *
   * @function module:tests/utils~arraysortequals
   */
  test('arraySortEquals', () => {
    // null
    assert.notOk(arraySortEquals(null, null), '2 null arrays');
    assert.notOk(arraySortEquals(null, [1, 2, 3]), 'left null array');
    assert.notOk(arraySortEquals([1, 2, 3], null), 'right null array');

    // undefined
    assert.notOk(arraySortEquals(undefined, undefined),
      '2 undefined arrays');
    assert.notOk(arraySortEquals(undefined, [1, 2, 3]),
      'left undefined arrays');
    assert.notOk(arraySortEquals([1, 2, 3], undefined),
      'right undefined arrays');

    // empty
    assert.notOk(arraySortEquals([1], []), 'right empty array');
    assert.notOk(arraySortEquals([], [1]), 'left empty array');
    assert.ok(arraySortEquals([], []), '2 empty arrays');

    // simple arrays
    const arr00 = [1, 2, 3];
    assert.ok(arraySortEquals(arr00, arr00), 'array equal #0');
    const arr01 = [3, 2, 1];
    assert.ok(arraySortEquals(arr00, arr01), 'array equal #1');
    const arr02 = [1, 2, 3, 4];
    assert.notOk(arraySortEquals(arr00, arr02), 'array equal #2');
    const arr03 = [1, 'a', null, undefined];
    assert.ok(arraySortEquals(arr03, arr03), 'array equal #3');

    // array of object
    const arr10 = [{a: 0}];
    const arr11 = [{a: 0}];
    assert.notOk(arraySortEquals(arr10, arr11),
      'array of object equal #0');
    const obj = {a: 0};
    const arr12 = [obj];
    const arr13 = [obj];
    assert.ok(arraySortEquals(arr12, arr13),
      'array of object equal #1');
  });

  // test data
  let multipart01 = 'preamble\r\n';
  multipart01 += '--boundary\r\n';
  multipart01 += '\r\n';
  multipart01 += '--boundary--';

  // (inspired from https://github.com/jmhmd/parse-multipart-data/blob/master/src/multipart.ts)
  let str10 = '------WebKitFormBoundaryvef1fLxmoUdYZWXp\r\n';
  str10 +=
    'Content-Disposition: form-data; name="uploads[]"; filename="A.txt"\r\n';
  str10 += 'Content-Type: text/plain\r\n';
  str10 += '\r\n';
  str10 += '@11X111Y\r\n';
  str10 += '111Z\rCCCC\nCCCC\r\nCCCCC@\r\n';
  str10 += '\r\n';
  str10 += '------WebKitFormBoundaryvef1fLxmoUdYZWXp\r\n';
  str10 +=
    'Content-Disposition: form-data; name="uploads[]"; filename="B.txt"\r\n';
  str10 += 'Content-Type: text/plain\r\n';
  str10 += '\r\n';
  str10 += '@22X222Y\r\n';
  str10 += '222Z\r222W\n2220\r\n';
  str10 += '666@\r\n';
  str10 += '\r\n';
  str10 += '------WebKitFormBoundaryvef1fLxmoUdYZWXp\r\n';
  str10 += 'Content-Disposition: form-data; name="input1"\r\n';
  str10 += '\r\n';
  str10 += 'value1\r\n';
  str10 += '\r\n';
  str10 += '------WebKitFormBoundaryvef1fLxmoUdYZWXp--\r\n';

  /* eslint-disable @stylistic/js/array-element-newline */
  const multipart10 = {
    str: str10,
    parts: [
      {
        'Content-Disposition': 'form-data; name="uploads[]"; filename="A.txt"',
        'Content-Type': 'text/plain',
        data: new Uint8Array([
          64, 49, 49, 88, 49, 49, 49, 89, 13, 10,
          49, 49, 49, 90, 13, 67, 67, 67, 67, 10, 67, 67, 67, 67, 13, 10,
          67, 67, 67, 67, 67, 64, 13, 10
        ])
      },
      {
        'Content-Disposition': 'form-data; name="uploads[]"; filename="B.txt"',
        'Content-Type': 'text/plain',
        data: new Uint8Array([
          64, 50, 50, 88, 50, 50, 50, 89, 13, 10,
          50, 50, 50, 90, 13, 50, 50, 50, 87, 10, 50, 50, 50, 48, 13, 10,
          54, 54, 54, 64, 13, 10
        ])
      },
      {
        'Content-Disposition': 'form-data; name="input1"',
        data: new Uint8Array([
          118, 97, 108, 117, 101, 49, 13, 10
        ])
      }
    ]
  };
  /* eslint-enable @stylistic/js/array-element-newline */

  // with preamble and epilogue
  let str11 = 'preamble\r\n';
  str11 += str10;
  str11 += 'epilogue\r\n';
  const multipart11 = {
    str: str11
  };

  const compareMultipartObjects = function (obj0, obj1) {
    if (obj0.length !== obj1.length) {
      return false;
    }
    for (let i = 0; i < obj0.length; ++i) {
      const keys = Object.keys(obj0[i]);
      for (let k = 0; k < keys.length; ++k) {
        const key = keys[k];
        if (key !== 'data') {
          if (obj0[i][key] !== obj1[i][key]) {
            return false;
          }
        } else {
          for (let j = 0; j < obj0[i].data.length; ++j) {
            if (obj0[i].data[j] !== obj1[i].data[j]) {
              return false;
            }
          }
        }
      }
    }
    return true;
  };

  const compareBuffers = function (buf1, buf2) {
    if (buf1.byteLength !== buf2.byteLength) {
      console.log('compareBuffers: length', buf1.byteLength, buf2.byteLength);
      return false;
    }
    const dv1 = new Int8Array(buf1);
    const dv2 = new Int8Array(buf2);
    for (let i = 0; i !== buf1.byteLength; i++) {
      if (dv1[i] !== dv2[i]) {
        console.log('compareBuffers: buffer', i, dv1[i], dv2[i]);
        return false;
      }
    }
    return true;
  };

  /**
   * Tests for {@link parseMultipart}.
   *
   * @function module:tests/utils~parse-multipart
   */
  test('Parse multipart - #DWV-REQ-IO-02-002 Load DICOM multipart URL',
    () => {
      // empty
      const res00 = parseMultipart(new Uint8Array(0).buffer);
      assert.equal(res00.length, 0, 'Empty multipart length');

      // empty part
      const u8Test01 = stringToUint8Array(multipart01);
      const res01 = parseMultipart(u8Test01.buffer);
      assert.equal(res01.length, 1, 'Empty multipart part length');
      const keys01 = Object.keys(res01);
      assert.equal(keys01.length, 1, 'Empty multipart part keys length');
      assert.ok(typeof res01[0].data !== 'undefined',
        'Empty multipart part has data');
      assert.equal(res01[0].data.length, 0, 'Empty multipart part data length');

      // test #10
      // parse multipart
      const u8Test10 = stringToUint8Array(multipart10.str);
      const resMulti10 = parseMultipart(u8Test10.buffer);
      assert.ok(compareMultipartObjects(resMulti10, multipart10.parts),
        'Compare multipart object #10');
      // build multipart
      const resBuff10 = buildMultipart(multipart10.parts,
        '----WebKitFormBoundaryvef1fLxmoUdYZWXp');
      assert.ok(compareBuffers(resBuff10, u8Test10),
        'Compare multipart buffer #10');

      // test #11: with preamble and epilogue
      const u8Test11 = stringToUint8Array(multipart11.str);
      const resMulti11 = parseMultipart(u8Test11.buffer);
      assert.ok(compareMultipartObjects(resMulti11, multipart10.parts),
        'Compare multipart object #11');
    }
  );

});