Feat/excel (#45)

* add dependency adding dependency to parse the excel file in the node side * import file ability to import file - add extension - safeguard file type and size * user is able to upload json or excel * chore: extract logic into self contained function * associate model with version * test id generation * parse excel data * prevent UI crash on bad data * extract validation into self contained function * chore: add more tests for bad data * config: stop from opening browser on start * fix comma in sample db * handle corrupt files * error boundary around main components * jsdocs * increase id length * parse excel time string * feat: excel parsing * validate json db before import * chore: test event validator * feat: make function to clean convert strings * chore: test parser * chore: jsdocs * fix: bug on upload prevent bug where the component would prevent upload of same file twice
2026-08-16 21:03:29 +00:00 · 2021-11-24 22:07:31 +01:00
parent bf8170a947
commit 8c740b7111
22 changed files with 1222 additions and 169 deletions
@@ -0,0 +1,20 @@
+import { generateId } from '../generate_id.js';
+
+describe('generate a valid id', () => {
+  it('generates a 5 digit id', () => {
+    const id = generateId();
+    expect(id.length).toBe(5);
+  });
+});
+
+describe('generate 100', () => {
+  it('all ids are unique', () => {
+    let ids = [];
+    for (let i = 0; i < 100; i++) {
+      ids.push(generateId());
+    }
+
+    const unique = [...new Set(ids)];
+    expect(ids.length).toBe(unique.length);
+  });
+});
@@ -0,0 +1,507 @@
+import jest from 'jest-mock';
+import {
+  makeString,
+  parseExcelv1,
+  parseJsonv1,
+  validateEventv1,
+} from '../parser.js';
+import { dbModelv1 as dbModel } from '../../models/dataModel.js';
+import { describe } from 'jest-circus';
+
+describe('test json parser with valid def', () => {
+  const testData = {
+    events: [
+      {
+        title: 'Guest Welcoming',
+        subtitle: '',
+        presenter: '',
+        note: '',
+        timeStart: 31500000,
+        timeEnd: 32400000,
+        isPublic: false,
+        type: 'event',
+        revision: 0,
+        id: '4b31',
+      },
+      {
+        title: 'Good Morning',
+        subtitle: 'Days schedule',
+        presenter: 'Carlos Valente',
+        note: '',
+        timeStart: 32400000,
+        timeEnd: 36000000,
+        isPublic: true,
+        type: 'event',
+        revision: 0,
+        id: 'f24d',
+      },
+      {
+        title: 'Stage 2 setup',
+        subtitle: '',
+        presenter: '',
+        note: '',
+        timeStart: 32400000,
+        timeEnd: 37200000,
+        isPublic: false,
+        type: 'event',
+        revision: 0,
+        id: 'bbc5',
+      },
+      {
+        title: 'Working Procedures',
+        subtitle: '',
+        presenter: 'Filip Johansen',
+        note: '',
+        timeStart: 37200000,
+        timeEnd: 39000000,
+        isPublic: true,
+        type: 'event',
+        revision: 0,
+        id: '5b3e',
+      },
+      {
+        title: 'Lunch',
+        subtitle: '',
+        presenter: '',
+        note: '',
+        timeStart: 39600000,
+        timeEnd: 45000000,
+        isPublic: false,
+        type: 'event',
+        revision: 0,
+        id: '8e2c',
+      },
+      {
+        title: 'A day being carlos',
+        subtitle: 'My life in a song',
+        presenter: 'Carlos Valente',
+        note: '',
+        timeStart: 46800000,
+        timeEnd: 50400000,
+        isPublic: true,
+        type: 'event',
+        revision: 0,
+        id: '08e9',
+      },
+      {
+        title: 'Hamburgers and Cheese',
+        subtitle: '... and other life questions',
+        presenter: 'Filip Johansen',
+        note: '',
+        timeStart: 54000000,
+        timeEnd: 57600000,
+        isPublic: true,
+        type: 'event',
+        revision: 0,
+        id: 'e25a',
+      },
+    ],
+    event: {
+      title: 'This is a test definition',
+      url: 'www.carlosvalente.com',
+      publicInfo: 'WiFi: demoproject \nPassword: ontimeproject',
+      backstageInfo: 'WiFi: demobackstage\nPassword: ontimeproject',
+    },
+    settings: {
+      app: 'ontime',
+      version: 1,
+    },
+  };
+
+  let parseResponse;
+
+  beforeEach(async () => {
+    parseResponse = await parseJsonv1(testData);
+  });
+
+  it('has 7 events', () => {
+    const length = parseResponse?.events.length;
+    expect(length).toBe(7);
+  });
+
+  it('first event is as a match', () => {
+    const first = parseResponse?.events[0];
+    const expected = {
+      title: 'Guest Welcoming',
+      subtitle: '',
+      presenter: '',
+      note: '',
+      timeStart: 31500000,
+      timeEnd: 32400000,
+      isPublic: false,
+      type: 'event',
+      revision: 0,
+      id: '4b31',
+    };
+  });
+
+  it('loaded event settings', () => {
+    const eventTitle = parseResponse?.event?.title;
+    expect(eventTitle).toBe('This is a test definition');
+  });
+
+  it('endMessage to exist but be empty', () => {
+    const endMessage = parseResponse?.event?.endMessage;
+    expect(endMessage).toBeDefined();
+    expect(endMessage).toBe('');
+  });
+
+  it('settings are for right app and version', () => {
+    const settings = parseResponse?.settings;
+    expect(settings.app).toBe('ontime');
+    expect(settings.version).toBe(1);
+  });
+
+  it('missing settings', () => {
+    const settings = parseResponse?.settings;
+    expect(settings.osc_port).toBeUndefined();
+  });
+});
+
+describe('test parser edge cases', () => {
+  it('generates missing ids', async () => {
+    const testData = {
+      events: [
+        {
+          title: 'Test Event',
+          type: 'event',
+        },
+      ],
+    };
+
+    const parseResponse = await parseJsonv1(testData);
+    expect(parseResponse.events[0].id).toBeDefined();
+  });
+
+  it('detects duplicate Ids', async () => {
+    console.log = jest.fn();
+    const testData = {
+      events: [
+        {
+          title: 'Test Event 1',
+          type: 'event',
+          id: '1',
+        },
+        {
+          title: 'Test Event 2',
+          type: 'event',
+          id: '1',
+        },
+      ],
+    };
+
+    const parseResponse = await parseJsonv1(testData);
+    expect(console.log).toHaveBeenCalledWith(
+      'ERROR: ID colision on import, skipping'
+    );
+    expect(parseResponse?.events.length).toBe(1);
+  });
+
+  it('handles incomplete datasets', async () => {
+    console.log = jest.fn();
+    const testData = {
+      events: [
+        {
+          title: 'Test Event 1',
+          id: '1',
+        },
+        {
+          title: 'Test Event 2',
+          id: '1',
+        },
+      ],
+    };
+
+    const parseResponse = await parseJsonv1(testData);
+    expect(console.log).toHaveBeenCalledWith(
+      'ERROR: undefined event type, skipping'
+    );
+
+    expect(parseResponse?.events.length).toBe(0);
+  });
+
+  it('skips unknown app and version settings', async () => {
+    console.log = jest.fn();
+    const testData = {
+      settings: {
+        osc_port: 8888,
+      },
+    };
+
+    await parseJsonv1(testData);
+    expect(console.log).toHaveBeenCalledWith(
+      'ERROR: unknown app version, skipping'
+    );
+  });
+});
+
+describe('test corrupt data', () => {
+  it('handles some empty events', async () => {
+    const emptyEvents = {
+      events: [
+        {},
+        {},
+        {},
+        {
+          title: 'Test Event 1',
+          type: 'event',
+          id: '1',
+        },
+        {
+          title: 'Test Event 2',
+          type: 'event',
+          id: '2',
+        },
+        {},
+        {},
+        {},
+      ],
+      event: {
+        title: 'All about Carlos demo event',
+        url: 'www.carlosvalente.com',
+        publicInfo: 'WiFi: demoproject \nPassword: ontimeproject',
+        backstageInfo: 'WiFi: demobackstage\nPassword: ontimeproject',
+        endMessage: '',
+      },
+      settings: {
+        app: 'ontime',
+        version: 1,
+        serverPort: 4001,
+        oscInPort: 8888,
+        oscOutPort: 9999,
+        oscOutIP: '127.0.0.1',
+        oscEnabled: false,
+        lock: false,
+      },
+    };
+
+    const parsedDef = await parseJsonv1(emptyEvents);
+    expect(parsedDef.events.length).toBe(2);
+  });
+
+  it('handles all empty events', async () => {
+    const emptyEvents = {
+      events: [{}, {}, {}, {}, {}, {}, {}, {}],
+      event: {
+        title: 'All about Carlos demo event',
+        url: 'www.carlosvalente.com',
+        publicInfo: 'WiFi: demoproject \nPassword: ontimeproject',
+        backstageInfo: 'WiFi: demobackstage\nPassword: ontimeproject',
+        endMessage: '',
+      },
+      settings: {
+        app: 'ontime',
+        version: 1,
+        serverPort: 4001,
+        oscInPort: 8888,
+        oscOutPort: 9999,
+        oscOutIP: '127.0.0.1',
+        oscEnabled: false,
+        lock: false,
+      },
+    };
+
+    const parsedDef = await parseJsonv1(emptyEvents);
+    expect(parsedDef.events.length).toBe(0);
+  });
+
+  it('handles missing event data', async () => {
+    const emptyEventData = {
+      events: [{}, {}, {}, {}, {}, {}, {}, {}],
+      event: {},
+      settings: {
+        app: 'ontime',
+        version: 1,
+        serverPort: 4001,
+        oscInPort: 8888,
+        oscOutPort: 9999,
+        oscOutIP: '127.0.0.1',
+        oscEnabled: false,
+        lock: false,
+      },
+    };
+
+    const parsedDef = await parseJsonv1(emptyEventData);
+    expect(parsedDef.event).toStrictEqual(dbModel.event);
+  });
+
+  it('handles missing settings', async () => {
+    const missingSettings = {
+      events: [{}, {}, {}, {}, {}, {}, {}, {}],
+      event: {},
+      settings: {
+        app: 'ontime',
+        version: 1,
+      },
+    };
+
+    const parsedDef = await parseJsonv1(missingSettings);
+    expect(parsedDef.settings).toStrictEqual(dbModel.settings);
+  });
+
+  it('fails with invalid JSON', async () => {
+    console.log = jest.fn();
+    const invalidJSON = 'some random dataset';
+    const parsedDef = await parseJsonv1(invalidJSON);
+    expect(console.log).toHaveBeenCalledWith('ERROR: Invalid JSON format');
+    expect(parsedDef).toBe(-1);
+  });
+});
+
+describe('test event validator', () => {
+  it('validates a good object', () => {
+    const event = {
+      title: 'test',
+    };
+    const validated = validateEventv1(event);
+
+    expect(validated).toEqual(
+      expect.objectContaining({
+        title: expect.any(String),
+        subtitle: expect.any(String),
+        presenter: expect.any(String),
+        note: expect.any(String),
+        timeStart: expect.any(Number),
+        timeEnd: expect.any(Number),
+        isPublic: expect.any(Boolean),
+        revision: expect.any(Number),
+        type: expect.any(String),
+        id: expect.any(String),
+      })
+    );
+  });
+
+  it('fails an empty object', () => {
+    const event = {};
+    const validated = validateEventv1(event);
+    expect(validated).toEqual(null);
+  });
+
+  it('makes objects strings', () => {
+    const event = {
+      title: 2,
+      subtitle: true,
+      presenter: 3.2,
+      note: '1899-12-30T08:00:10.000Z',
+    };
+    const validated = validateEventv1(event);
+    expect(typeof validated.title).toEqual('string');
+    expect(typeof validated.subtitle).toEqual('string');
+    expect(typeof validated.presenter).toEqual('string');
+    expect(typeof validated.note).toEqual('string');
+  });
+
+  it('enforces numbers on times', () => {
+    const event = {
+      timeStart: false,
+      timeEnd: '2',
+    };
+    const validated = validateEventv1(event);
+    expect(typeof validated.timeStart).toEqual('number');
+    expect(validated.timeStart).toEqual(0);
+    expect(typeof validated.timeEnd).toEqual('number');
+    expect(validated.timeEnd).toEqual(0);
+  });
+
+  it('handles bad objects', () => {
+    const event = {
+      title: {},
+    };
+    const validated = validateEventv1(event);
+    expect(typeof validated.title).toEqual('string');
+  });
+});
+
+describe('test makeString function', () => {
+  it('converts variables to string', () => {
+    let val = 2;
+    let expected = '2';
+    let converted = makeString(val);
+    expect(converted).toBe(expected);
+
+    val = 2.22222222;
+    expected = '2.22222222';
+    converted = makeString(val);
+    expect(converted).toBe(expected);
+
+    val = ['testing'];
+    expected = 'testing';
+    converted = makeString(val);
+    expect(converted).toBe(expected);
+
+    val = { doing: 'testing' };
+    expected = 'testing';
+    converted = makeString(val, 'fallback');
+    expect(converted).toBe('fallback');
+  });
+});
+
+describe('test parseExcel function', () => {
+  it('parses the example file', async () => {
+    const testdata = [
+      ['Ontime ┬À Schedule Template'],
+      [],
+      ['Event Name', 'Test Event'],
+      ['Event URL', 'www.carlosvalente.com'],
+      [],
+      [],
+      [
+        'Time Start',
+        'Time End',
+        'Event Title',
+        'Presenter Name',
+        'Event Subtitle',
+        'Is Public? (x)',
+        'Notes',
+      ],
+      [
+        '1899-12-30T07:00:00.000Z',
+        '1899-12-30T08:00:10.000Z',
+        'Guest Welcome',
+        'Carlos',
+        'Getting things started',
+        'x',
+        'Ballyhoo',
+      ],
+      [
+        '1899-12-30T08:00:00.000Z',
+        '1899-12-30T08:30:00.000Z',
+        'A song from the hearth',
+        'Still Carlos',
+        'Derailing early',
+        '',
+        'Rainbow chase',
+      ],
+      [],
+    ];
+
+    const expectedParsedEvents = [
+      {
+        timeStart: 28800000,
+        timeEnd: 32410000,
+        title: 'Guest Welcome',
+        presenter: 'Carlos',
+        subtitle: 'Getting things started',
+        isPublic: true,
+        note: 'Ballyhoo',
+        type: 'event',
+      },
+      {
+        timeStart: 32400000,
+        timeEnd: 34200000,
+        title: 'A song from the hearth',
+        presenter: 'Still Carlos',
+        subtitle: 'Derailing early',
+        isPublic: false,
+        note: 'Rainbow chase',
+        type: 'event',
+      },
+    ];
+
+    const parsedData = await parseExcelv1(testdata);
+
+    expect(parsedData.events).toBeDefined();
+    expect(parsedData.events).toStrictEqual(expectedParsedEvents);
+    expect(parsedData.events).toStrictEqual(expectedParsedEvents);
+  });
+});
@@ -1,4 +1,5 @@
-import { stringFromMillis } from '../time.js';
+import { describe } from 'jest-circus';
+import { excelDateStringToMillis, stringFromMillis } from '../time.js';

 describe('test string to milis function', () => {
  it('test with null values', () => {
@@ -56,3 +57,21 @@ describe('test string to milis function', () => {
    expect(stringFromMillis(t.val)).toBe(t.result);
  });
 });
+
+describe('test excel date parser', () => {
+  it('parses the given dates correctly', () => {
+    const d1 = '1899-12-30T08:00:00.000Z';
+    const d2 = '1899-12-30T08:30:00.000Z';
+
+    const d1Millis = 28800000;
+    const d2Millis = 30600000;
+
+    expect(excelDateStringToMillis(d1)).toBe(d1Millis);
+    expect(excelDateStringToMillis(d2)).toBe(d2Millis);
+  });
+
+  it.only('handles an invalid date string', () => {
+    const s = 'hello';
+    expect(excelDateStringToMillis(s)).toBe(null);
+  });
+});