tuneflow/test/skeleton_plugin.test.ts

Programmable, extensible music composition & arrangement

import { TrackType, TuneflowPipeline, Song, TuneflowPlugin } from '../src';
import type { ReadAPIs } from '../src';

const MOCK_READ_APIS: ReadAPIs = {
  readAudioBuffer: async () => null,
  readPluginSpec: async () => null,
  readFile: async () => null,
  resolvePath: async (path1, path2) => `${path1}/${path2}`,
  translateLabel: (label: any) => label,
  serializeSong: async () => 'serializedSong',
  serializeSongAsUint8Array: async () => new Uint8Array(),
  deserializeSong: async () => new Song(),
  deserializeSongFromUint8Array: async () => new Song(),
  getAvailableAudioPlugins: async () => [],
  getFilesInDirectory: async () => [],
};

describe('Skeleton Tuneflow', () => {
  class TestUtilsPlugin extends TuneflowPlugin {}

  class NoAccessCreateTrackPlugin extends TuneflowPlugin {
    static providerId(): string {
      return 'andantei';
    }

    static pluginId(): string {
      return 'test-skeleton';
    }

    static providerDisplayName(): string {
      return 'Andantei';
    }

    static pluginDisplayName(): string {
      return 'Test Skeleton';
    }

    // eslint-disable-next-line @typescript-eslint/no-unused-vars
    async run(song: Song, inputs: any[]): Promise<void> {
      song.createTrack({ type: TrackType.MIDI_TRACK });
    }
  }

  class CreateTrackPlugin extends NoAccessCreateTrackPlugin {}

  const testUtilsPlugin = new TestUtilsPlugin();
  let song = new Song();

  beforeEach(() => {
    song = new Song();
    // @ts-ignore
    song.setPluginContextInternal(testUtilsPlugin);
  });

  it('finishes correctly', async () => {
    song.setResolution(480);
    song.createTempoChange({
      ticks: 0,
      bpm: 120,
    });
    const track = song.createTrack({ type: TrackType.MIDI_TRACK });
    const clip = track.createMIDIClip({
      clipStartTick: 0,
    });
    clip.createNote({
      pitch: 64,
      velocity: 80,
      startTick: 0,
      endTick: 10,
    });
    const pipeline = new TuneflowPipeline();
    pipeline.setOriginalSong(song);
    // @ts-ignore
    TuneflowPipeline.cloneSongFnInternal = (song: Song) => song;
    // @ts-ignore
    TuneflowPipeline.materializeSongFnInternal = () => {};
    // @ts-ignore
    pipeline.readApisInternal = MOCK_READ_APIS;
    pipeline.addAsOrReplaceActivePlugin(new CreateTrackPlugin());
    expect(song.getTracks().length).toBe(1);
    const prepareResult: any = await pipeline.prepareRun();
    expect(prepareResult).toBeTruthy();
    await TuneflowPipeline.run(prepareResult.inputSong, prepareResult?.plugins, 'songId123');
    expect(song.getTracks().length).toBe(2);
  });
});