123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631 |
- /* eslint-disable @typescript-eslint/ban-ts-comment */
- /* eslint no-console: "off", no-restricted-syntax: "off" */
- import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
- import assert from 'node:assert'
- import fs from 'node:fs'
- import path from 'node:path'
- import prettierBytes from '@transloadit/prettier-bytes'
- import type { Body, Meta } from '@uppy/utils/lib/UppyFile'
- import type { Locale } from '@uppy/utils/lib/Translator'
- import Core from './index.ts'
- import UIPlugin from './UIPlugin.ts'
- import BasePlugin, {
- type DefinePluginOpts,
- type PluginOpts,
- } from './BasePlugin.ts'
- import { debugLogger } from './loggers.ts'
- import AcquirerPlugin1 from './mocks/acquirerPlugin1.ts'
- import AcquirerPlugin2 from './mocks/acquirerPlugin2.ts'
- import InvalidPlugin from './mocks/invalidPlugin.ts'
- import InvalidPluginWithoutId from './mocks/invalidPluginWithoutId.ts'
- import InvalidPluginWithoutType from './mocks/invalidPluginWithoutType.ts'
- // @ts-expect-error trying to import a file from outside the package
- import DeepFrozenStore from '../../../../e2e/cypress/fixtures/DeepFrozenStore.mjs'
- import type { State } from './Uppy.ts'
- // eslint-disable-next-line no-restricted-globals
- const sampleImage = fs.readFileSync(
- path.join(__dirname, '../../../../e2e/cypress/fixtures/images/image.jpg'),
- )
- // @ts-expect-error type object can be second argument
- const testImage = new File([sampleImage], { type: 'image/jpeg' })
- describe('src/Core', () => {
- const RealCreateObjectUrl = globalThis.URL.createObjectURL
- beforeEach(() => {
- globalThis.URL.createObjectURL = vi.fn().mockReturnValue('newUrl')
- })
- afterEach(() => {
- globalThis.URL.createObjectURL = RealCreateObjectUrl
- })
- it('should expose a class', () => {
- const core = new Core()
- expect(core.constructor.name).toEqual('Uppy')
- })
- it('should have a string `id` option that defaults to "uppy"', () => {
- const core = new Core()
- expect(core.getID()).toEqual('uppy')
- const core2 = new Core({ id: 'profile' })
- expect(core2.getID()).toEqual('profile')
- })
- describe('plugins', () => {
- it('should add a plugin to the plugin stack', () => {
- const core = new Core()
- core.use(AcquirerPlugin1)
- expect(
- // @ts-expect-error untyped
- Object.keys(core[Symbol.for('uppy test: getPlugins')]('acquirer'))
- .length,
- ).toEqual(1)
- })
- it('should be able to .use() without passing generics again', () => {
- {
- interface TestOpts extends PluginOpts {
- foo?: string
- bar: string
- }
- class TestPlugin<M extends Meta, B extends Body> extends BasePlugin<
- TestOpts,
- M,
- B
- > {
- foo: string
- bar: string
- constructor(uppy: Core<M, B>, opts: TestOpts) {
- super(uppy, opts)
- this.id = 'Test'
- this.type = 'acquirer'
- this.foo = this.opts.foo ?? 'defaultFoo'
- this.bar = this.opts.bar
- }
- }
- // @ts-expect-error missing mandatory option foo
- new Core().use(TestPlugin)
- new Core().use(TestPlugin, { foo: '', bar: '' })
- // @ts-expect-error boolean not allowed
- new Core().use(TestPlugin, { bar: false })
- // @ts-expect-error missing option
- new Core().use(TestPlugin, { foo: '' })
- }
- {
- interface TestOpts extends PluginOpts {
- foo?: string
- bar?: string
- }
- const defaultOptions = {
- foo: 'defaultFoo',
- }
- class TestPlugin<M extends Meta, B extends Body> extends BasePlugin<
- DefinePluginOpts<TestOpts, keyof typeof defaultOptions>,
- M,
- B
- > {
- constructor(uppy: Core<M, B>, opts?: TestOpts) {
- super(uppy, { ...defaultOptions, ...opts })
- this.id = this.opts.id ?? 'Test'
- this.type = 'acquirer'
- }
- }
- new Core().use(TestPlugin)
- new Core().use(TestPlugin, { foo: '', bar: '' })
- new Core().use(TestPlugin, { foo: '' })
- new Core().use(TestPlugin, { bar: '' })
- // @ts-expect-error boolean not allowed
- new Core().use(TestPlugin, { foo: false })
- }
- })
- it('should prevent the same plugin from being added more than once', () => {
- const core = new Core()
- core.use(AcquirerPlugin1)
- expect(() => {
- core.use(AcquirerPlugin1)
- }).toThrowErrorMatchingSnapshot()
- })
- it('should not be able to add an invalid plugin', () => {
- const core = new Core()
- expect(() => {
- // @ts-expect-error expected
- core.use(InvalidPlugin)
- }).toThrowErrorMatchingSnapshot()
- })
- it('should not be able to add a plugin that has no id', () => {
- const core = new Core()
- expect(() =>
- core.use(InvalidPluginWithoutId),
- ).toThrowErrorMatchingSnapshot()
- })
- it('should not be able to add a plugin that has no type', () => {
- const core = new Core()
- expect(() =>
- core.use(InvalidPluginWithoutType),
- ).toThrowErrorMatchingSnapshot()
- })
- it('should return the plugin that matches the specified name', () => {
- const core = new Core()
- expect(core.getPlugin('foo')).toEqual(undefined)
- core.use(AcquirerPlugin1)
- const plugin = core.getPlugin('TestSelector1')
- expect(plugin!.id).toEqual('TestSelector1')
- expect(plugin instanceof UIPlugin)
- })
- it('should call the specified method on all the plugins', () => {
- const core = new Core()
- core.use(AcquirerPlugin1)
- core.use(AcquirerPlugin2)
- core.iteratePlugins((plugin) => {
- // @ts-ignore
- plugin.run('hello')
- })
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.run.mock
- .calls.length,
- ).toEqual(1)
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.run.mock
- .calls[0],
- ).toEqual(['hello'])
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[1].mocks.run.mock
- .calls.length,
- ).toEqual(1)
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[1].mocks.run.mock
- .calls[0],
- ).toEqual(['hello'])
- })
- it('should uninstall and the remove the specified plugin', () => {
- const core = new Core()
- core.use(AcquirerPlugin1)
- core.use(AcquirerPlugin2)
- expect(
- // @ts-ignore
- Object.keys(core[Symbol.for('uppy test: getPlugins')]('acquirer'))
- .length,
- ).toEqual(2)
- const plugin = core.getPlugin('TestSelector1')
- core.removePlugin(plugin!)
- expect(
- // @ts-ignore
- Object.keys(core[Symbol.for('uppy test: getPlugins')]('acquirer'))
- .length,
- ).toEqual(1)
- // @ts-ignore
- expect(plugin.mocks.uninstall.mock.calls.length).toEqual(1)
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.run.mock
- .calls.length,
- ).toEqual(0)
- })
- })
- describe('state', () => {
- it('should update all the plugins with the new state when the updateAll method is called', () => {
- const core = new Core()
- core.use(AcquirerPlugin1)
- core.use(AcquirerPlugin2)
- core.updateAll({ foo: 'bar' })
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.update
- .mock.calls.length,
- ).toEqual(1)
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.update
- .mock.calls[0],
- ).toEqual([{ foo: 'bar' }])
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[1].mocks.update
- .mock.calls.length,
- ).toEqual(1)
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[1].mocks.update
- .mock.calls[0],
- ).toEqual([{ foo: 'bar' }])
- })
- it('should update the state', () => {
- const core = new Core()
- const stateUpdateEventMock = vi.fn()
- core.on('state-update', stateUpdateEventMock)
- core.use(AcquirerPlugin1)
- core.use(AcquirerPlugin2)
- core.setState({ foo: 'bar', bee: 'boo' })
- core.setState({ foo: 'baar' })
- const newState = {
- bee: 'boo',
- capabilities: {
- individualCancellation: true,
- uploadProgress: true,
- resumableUploads: false,
- },
- files: {},
- currentUploads: {},
- error: null,
- allowNewUpload: true,
- foo: 'baar',
- info: [],
- meta: {},
- plugins: {},
- totalProgress: 0,
- recoveredState: null,
- }
- expect(core.getState()).toEqual(newState)
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[0].mocks.update
- .mock.calls[1],
- ).toEqual([newState])
- expect(
- // @ts-ignore
- core[Symbol.for('uppy test: getPlugins')]('acquirer')[1].mocks.update
- .mock.calls[1],
- ).toEqual([newState])
- expect(stateUpdateEventMock.mock.calls.length).toEqual(2)
- // current state
- expect(stateUpdateEventMock.mock.calls[1][0]).toEqual({
- bee: 'boo',
- capabilities: {
- individualCancellation: true,
- uploadProgress: true,
- resumableUploads: false,
- },
- files: {},
- currentUploads: {},
- error: null,
- allowNewUpload: true,
- foo: 'bar',
- info: [],
- meta: {},
- plugins: {},
- totalProgress: 0,
- recoveredState: null,
- })
- // new state
- expect(stateUpdateEventMock.mock.calls[1][1]).toEqual({
- bee: 'boo',
- capabilities: {
- individualCancellation: true,
- uploadProgress: true,
- resumableUploads: false,
- },
- files: {},
- currentUploads: {},
- error: null,
- allowNewUpload: true,
- foo: 'baar',
- info: [],
- meta: {},
- plugins: {},
- totalProgress: 0,
- recoveredState: null,
- })
- })
- it('should get the state', () => {
- const core = new Core()
- core.setState({ foo: 'bar' })
- expect(core.getState()).toMatchObject({ foo: 'bar' })
- })
- })
- it('should cancel all when the `cancelAll` method is called', () => {
- // use DeepFrozenStore in some tests to make sure we are not mutating things
- const core = new Core({
- store: DeepFrozenStore(),
- })
- // const corePauseEventMock = vi.fn()
- const coreCancelEventMock = vi.fn()
- const coreStateUpdateEventMock = vi.fn()
- core.on('cancel-all', coreCancelEventMock)
- core.on('state-update', coreStateUpdateEventMock)
- core.setState({ foo: 'bar', totalProgress: 30 })
- core.cancelAll()
- expect(coreCancelEventMock).toHaveBeenCalledWith(
- undefined,
- undefined,
- undefined,
- undefined,
- undefined,
- undefined,
- )
- expect(coreStateUpdateEventMock.mock.calls.length).toEqual(2)
- expect(coreStateUpdateEventMock.mock.calls[1][1]).toEqual({
- capabilities: {
- individualCancellation: true,
- uploadProgress: true,
- resumableUploads: false,
- },
- files: {},
- currentUploads: {},
- allowNewUpload: true,
- error: null,
- foo: 'bar',
- info: [],
- meta: {},
- plugins: {},
- totalProgress: 0,
- recoveredState: null,
- })
- })
- it('should clear all uploads and files on cancelAll()', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileIDs = Object.keys(core.getState().files)
- // @ts-ignore
- const id = core[Symbol.for('uppy test: createUpload')](fileIDs)
- expect(core.getState().currentUploads[id]).toBeDefined()
- expect(Object.keys(core.getState().files).length).toEqual(2)
- core.cancelAll()
- expect(core.getState().currentUploads[id]).toBeUndefined()
- expect(Object.keys(core.getState().files).length).toEqual(0)
- })
- it('should allow remove all uploads when individualCancellation is disabled', () => {
- const core = new Core()
- const { capabilities } = core.getState()
- core.setState({
- capabilities: {
- ...capabilities,
- individualCancellation: false,
- },
- })
- core.addFile({
- source: 'vi',
- name: 'foo1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileIDs = Object.keys(core.getState().files)
- // @ts-ignore
- const id = core[Symbol.for('uppy test: createUpload')](fileIDs)
- expect(core.getState().currentUploads[id]).toBeDefined()
- expect(Object.keys(core.getState().files).length).toEqual(2)
- core.removeFiles(fileIDs)
- expect(core.getState().currentUploads[id]).toBeUndefined()
- expect(Object.keys(core.getState().files).length).toEqual(0)
- })
- it('should disallow remove one upload when individualCancellation is disabled', () => {
- const core = new Core()
- const { capabilities } = core.getState()
- core.setState({
- capabilities: {
- ...capabilities,
- individualCancellation: false,
- },
- })
- core.addFile({
- source: 'vi',
- name: 'foo1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileIDs = Object.keys(core.getState().files)
- // @ts-ignore
- const id = core[Symbol.for('uppy test: createUpload')](fileIDs)
- expect(core.getState().currentUploads[id]).toBeDefined()
- expect(Object.keys(core.getState().files).length).toEqual(2)
- assert.throws(
- () => core.removeFile(fileIDs[0]),
- /individualCancellation is disabled/,
- )
- expect(core.getState().currentUploads[id]).toBeDefined()
- expect(Object.keys(core.getState().files).length).toEqual(2)
- })
- it('should allow remove one upload when individualCancellation is enabled', () => {
- const core = new Core()
- const { capabilities } = core.getState()
- core.setState({
- capabilities: {
- ...capabilities,
- individualCancellation: true,
- },
- })
- core.addFile({
- source: 'vi',
- name: 'foo1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileIDs = Object.keys(core.getState().files)
- // @ts-ignore
- const id = core[Symbol.for('uppy test: createUpload')](fileIDs)
- expect(core.getState().currentUploads[id]).toBeDefined()
- expect(Object.keys(core.getState().files).length).toEqual(2)
- core.removeFile(fileIDs[0])
- expect(core.getState().currentUploads[id]).toBeDefined()
- expect(Object.keys(core.getState().files).length).toEqual(1)
- })
- it('should close, reset and uninstall when the close method is called', () => {
- // use DeepFrozenStore in some tests to make sure we are not mutating things
- const core = new Core({
- store: DeepFrozenStore(),
- })
- core.use(AcquirerPlugin1)
- const coreCancelEventMock = vi.fn()
- const coreStateUpdateEventMock = vi.fn()
- // @ts-ignore
- const plugin = core[Symbol.for('uppy test: getPlugins')]('acquirer')[0]
- core.on('cancel-all', coreCancelEventMock)
- core.on('state-update', coreStateUpdateEventMock)
- core.destroy()
- expect(coreCancelEventMock).toHaveBeenCalledWith(
- undefined,
- undefined,
- undefined,
- undefined,
- undefined,
- undefined,
- )
- expect(coreStateUpdateEventMock.mock.calls.length).toEqual(1)
- expect(coreStateUpdateEventMock.mock.calls[0][1]).toEqual({
- capabilities: {
- individualCancellation: true,
- uploadProgress: true,
- resumableUploads: false,
- },
- files: {},
- currentUploads: {},
- allowNewUpload: true,
- error: null,
- info: [],
- meta: {},
- plugins: {},
- totalProgress: 0,
- recoveredState: null,
- })
- expect(plugin.mocks.uninstall.mock.calls.length).toEqual(1)
- const pluginIteration = vi.fn()
- core.iteratePlugins(pluginIteration)
- expect(pluginIteration.mock.calls.length).toEqual(0)
- })
- describe('upload hooks', () => {
- it('should add data returned from upload hooks to the .upload() result', () => {
- const core = new Core()
- core.addPreProcessor((_, uploadID) => {
- core.addResultData(uploadID, { pre: 'ok' })
- })
- core.addPostProcessor((_, uploadID) => {
- core.addResultData(uploadID, { post: 'ok' })
- })
- core.addUploader((_, uploadID) => {
- core.addResultData(uploadID, { upload: 'ok' })
- })
- return core.upload().then((result) => {
- if (result) {
- expect(result.pre).toBe('ok')
- expect(result.upload).toBe('ok')
- expect(result.post).toBe('ok')
- }
- })
- })
- })
- describe('preprocessors', () => {
- it('should add and remove preprocessor', () => {
- const core = new Core()
- const preprocessor = () => {}
- expect(core.removePreProcessor(preprocessor)).toBe(false)
- core.addPreProcessor(preprocessor)
- expect(core.removePreProcessor(preprocessor)).toBe(true)
- expect(core.removePreProcessor(preprocessor)).toBe(false)
- })
- it('should execute all the preprocessors when uploading a file', () => {
- const core = new Core()
- const preprocessor1 = vi.fn()
- const preprocessor2 = vi.fn()
- core.addPreProcessor(preprocessor1)
- core.addPreProcessor(preprocessor2)
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- return core.upload().then(() => {
- const fileId = Object.keys(core.getState().files)[0]
- expect(preprocessor1.mock.calls.length).toEqual(1)
- expect(preprocessor1.mock.calls[0][0].length).toEqual(1)
- expect(preprocessor1.mock.calls[0][0][0]).toEqual(fileId)
- expect(preprocessor2.mock.calls[0][0].length).toEqual(1)
- expect(preprocessor2.mock.calls[0][0][0]).toEqual(fileId)
- })
- })
- it('should not pass removed file IDs to next step', async () => {
- const core = new Core()
- const uploader = vi.fn()
- core.addPreProcessor((fileIDs) => {
- core.removeFile(fileIDs[0])
- })
- core.addUploader(uploader)
- core.addFile({
- source: 'vi',
- name: 'rmd.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'kept.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- await core.upload()
- expect(uploader.mock.calls.length).toEqual(1)
- expect(uploader.mock.calls[0][0].length).toEqual(1)
- expect(core.getFile(uploader.mock.calls[0][0][0]).name).toEqual(
- 'kept.jpg',
- )
- })
- it('should update the file progress state when preprocess-progress event is fired', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- const file = core.getFile(fileId)
- core.emit('preprocess-progress', file, {
- mode: 'determinate',
- message: 'something',
- value: 0,
- })
- expect(core.getFile(fileId).progress).toEqual({
- percentage: 0,
- bytesUploaded: false,
- bytesTotal: 17175,
- uploadComplete: false,
- uploadStarted: null,
- preprocess: { mode: 'determinate', message: 'something', value: 0 },
- })
- })
- it('should update the file progress state when preprocess-complete event is fired', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileID = Object.keys(core.getState().files)[0]
- const file = core.getFile(fileID)
- core.emit('preprocess-complete', file, {
- mode: 'determinate',
- message: 'something',
- value: 0,
- })
- expect(core.getFile(fileID).progress).toEqual({
- percentage: 0,
- bytesUploaded: false,
- bytesTotal: 17175,
- uploadComplete: false,
- uploadStarted: null,
- })
- })
- })
- describe('postprocessors', () => {
- it('should add and remove postprocessor', () => {
- const core = new Core()
- const postprocessor = () => {}
- expect(core.removePostProcessor(postprocessor)).toBe(false)
- core.addPostProcessor(postprocessor)
- expect(core.removePostProcessor(postprocessor)).toBe(true)
- expect(core.removePostProcessor(postprocessor)).toBe(false)
- })
- it('should execute all the postprocessors when uploading a file', () => {
- const core = new Core()
- const postprocessor1 = vi.fn()
- const postprocessor2 = vi.fn()
- core.addPostProcessor(postprocessor1)
- core.addPostProcessor(postprocessor2)
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- return core.upload().then(() => {
- expect(postprocessor1.mock.calls.length).toEqual(1)
- // const lastModifiedTime = new Date()
- // const fileId = 'foojpg' + lastModifiedTime.getTime()
- const fileId = 'uppy-foo/jpg-1e-image'
- expect(postprocessor1.mock.calls[0][0].length).toEqual(1)
- expect(postprocessor1.mock.calls[0][0][0].substring(0, 17)).toEqual(
- fileId.substring(0, 17),
- )
- expect(postprocessor2.mock.calls[0][0].length).toEqual(1)
- expect(postprocessor2.mock.calls[0][0][0].substring(0, 17)).toEqual(
- fileId.substring(0, 17),
- )
- })
- })
- it('should update the file progress state when postprocess-progress event is fired', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- const file = core.getFile(fileId)
- core.emit('postprocess-progress', file, {
- mode: 'determinate',
- message: 'something',
- value: 0,
- })
- expect(core.getFile(fileId).progress).toEqual({
- percentage: 0,
- bytesUploaded: false,
- bytesTotal: 17175,
- uploadComplete: false,
- uploadStarted: null,
- postprocess: { mode: 'determinate', message: 'something', value: 0 },
- })
- })
- it('should update the file progress state when postprocess-complete event is fired', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- const file = core.getFile(fileId)
- core.emit('postprocess-complete', file, {
- mode: 'determinate',
- message: 'something',
- value: 0,
- })
- expect(core.getFile(fileId).progress).toEqual({
- percentage: 0,
- bytesUploaded: false,
- bytesTotal: 17175,
- uploadComplete: false,
- uploadStarted: null,
- })
- })
- it('should report an error if post-processing a file fails', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- const file = core.getFile(fileId)
- core.emit('error', new Error('foooooo'), file)
- expect(core.getState().error).toEqual('foooooo')
- expect(core.upload()).resolves.toMatchObject({
- failed: [{ name: 'foo.jpg' }],
- })
- })
- })
- describe('uploaders', () => {
- it('should add and remove uploader', () => {
- const core = new Core()
- const uploader = () => {}
- expect(core.removeUploader(uploader)).toBe(false)
- core.addUploader(uploader)
- expect(core.removeUploader(uploader)).toBe(true)
- expect(core.removeUploader(uploader)).toBe(false)
- })
- })
- describe('adding a file', () => {
- it('should call onBeforeFileAdded if it was specified in the options when initialising the class', () => {
- const onBeforeFileAdded = vi.fn()
- const core = new Core({
- // need to capture a snapshot of files, because files will change in the next tick, thus failing the expect below
- onBeforeFileAdded: (file, files) =>
- onBeforeFileAdded(file, { ...files }),
- })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- expect(onBeforeFileAdded.mock.calls.length).toEqual(1)
- expect(onBeforeFileAdded.mock.calls[0][0].name).toEqual('foo.jpg')
- expect(onBeforeFileAdded.mock.calls[0][1]).toEqual({})
- })
- it('should allow uploading duplicate file if explicitly allowed in onBeforeFileAdded', async () => {
- const core = new Core({ onBeforeFileAdded: () => true })
- const sameFileBlob = testImage
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: sameFileBlob,
- })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: sameFileBlob,
- })
- })
- it('should add a file', () => {
- const fileData = testImage
- const fileAddedEventMock = vi.fn()
- const core = new Core()
- core.on('file-added', fileAddedEventMock)
- const fileId = core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: fileData,
- })
- const newFile = {
- extension: 'jpg',
- id: fileId,
- isRemote: false,
- meta: { name: 'foo.jpg', type: 'image/jpeg' },
- name: 'foo.jpg',
- preview: undefined,
- data: fileData,
- isGhost: false,
- progress: {
- bytesTotal: 17175,
- bytesUploaded: false,
- percentage: 0,
- uploadComplete: false,
- uploadStarted: null,
- },
- remote: undefined,
- size: 17175,
- source: 'vi',
- type: 'image/jpeg',
- }
- expect(core.getFile(fileId)).toEqual(newFile)
- expect(fileAddedEventMock.mock.calls[0][0]).toEqual(newFile)
- })
- it('should add a file from a File object', () => {
- const fileData = testImage
- const core = new Core()
- const fileId = core.addFile(fileData)
- expect(core.getFile(fileId).id).toEqual(fileId)
- })
- it('should not allow a file that does not meet the restrictions', () => {
- const core = new Core({
- restrictions: {
- allowedFileTypes: ['image/gif', 'video/webm'],
- },
- })
- expect(() => {
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- }).toThrow('You can only upload: image/gif, video/webm')
- expect(() => {
- core.addFile({
- source: 'vi',
- name: 'foo.webm',
- type: 'video/webm; codecs="vp8, opus"',
- // @ts-ignore
- data: new File([sampleImage], {
- type: 'video/webm; codecs="vp8, opus"',
- }),
- })
- }).not.toThrow()
- })
- it('should not allow a dupicate file, a file with the same id', () => {
- const core = new Core()
- const sameFileBlob = testImage
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: sameFileBlob,
- })
- expect(() => {
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: sameFileBlob,
- meta: {
- notARelativePath: 'folder/a',
- },
- })
- }).toThrow("Cannot add the duplicate file 'foo.jpg', it already exists")
- expect(core.getFiles().length).toEqual(1)
- })
- it('should allow a duplicate file if its relativePath is different, thus the id is different', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- meta: {
- relativePath: 'folder/a',
- },
- })
- expect(core.getFiles().length).toEqual(2)
- })
- it('should not allow a file if onBeforeFileAdded returned false', () => {
- const core = new Core({
- onBeforeFileAdded: (file) => {
- if (file.source === 'vi') {
- return false
- }
- return undefined
- },
- })
- expect(() => {
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- }).toThrow(
- 'Cannot add the file because onBeforeFileAdded returned false.',
- )
- expect(core.getFiles().length).toEqual(0)
- })
- describe('with allowMultipleUploadBatches: false', () => {
- it('allows no new files after upload', async () => {
- const core = new Core({ allowMultipleUploadBatches: false })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- await core.upload()
- expect(() => {
- core.addFile({
- source: 'vi',
- name: '123.foo',
- type: 'image/jpeg',
- data: testImage,
- })
- }).toThrow(/Cannot add more files/)
- })
- it('allows no new files after upload with legacy allowMultipleUploads option', async () => {
- const core = new Core({ allowMultipleUploads: false })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- await core.upload()
- expect(() => {
- core.addFile({
- source: 'vi',
- name: '123.foo',
- type: 'image/jpeg',
- data: testImage,
- })
- }).toThrow(/Cannot add more files/)
- })
- it('does not allow new files after the removeFile() if some file is still present', async () => {
- const core = new Core({ allowMultipleUploadBatches: false })
- // adding 2 files
- const fileId1 = core.addFile({
- source: 'vi',
- name: '1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: '2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- // removing 1 file
- core.removeFile(fileId1)
- await expect(core.upload()).resolves.toBeDefined()
- })
- it('allows new files after the last removeFile()', async () => {
- const core = new Core({ allowMultipleUploadBatches: false })
- // adding 2 files
- const fileId1 = core.addFile({
- source: 'vi',
- name: '1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId2 = core.addFile({
- source: 'vi',
- name: '2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- // removing 2 files
- core.removeFile(fileId1)
- core.removeFile(fileId2)
- await expect(core.upload()).resolves.toBeDefined()
- })
- })
- it('does not dedupe different files', async () => {
- const core = new Core()
- const data = new Blob([sampleImage], { type: 'image/jpeg' })
- // @ts-ignore
- data.lastModified = 1562770350937
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data,
- })
- core.addFile({
- source: 'vi',
- name: 'foo푸.jpg',
- type: 'image/jpeg',
- data,
- })
- expect(core.getFiles()).toHaveLength(2)
- expect(
- core.getFile('uppy-foo/jpg-1e-image/jpeg-17175-1562770350937'),
- ).toBeDefined()
- expect(
- core.getFile('uppy-foo//jpg-1l3o-1e-image/jpeg-17175-1562770350937'),
- ).toBeDefined()
- })
- })
- describe('uploading a file', () => {
- it('should return a { successful, failed } pair containing file objects', () => {
- const core = new Core()
- core.addUploader(() => Promise.resolve())
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'bar.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- return expect(core.upload()).resolves.toMatchObject({
- successful: [{ name: 'foo.jpg' }, { name: 'bar.jpg' }],
- failed: [],
- })
- })
- it('should return files with errors in the { failed } key', () => {
- // use DeepFrozenStore in some tests to make sure we are not mutating things
- const core = new Core({
- store: DeepFrozenStore(),
- })
- core.addUploader((fileIDs) => {
- fileIDs.forEach((fileID) => {
- const file = core.getFile(fileID)
- if (/bar/.test(file.name)) {
- // @ts-ignore
- core.emit(
- 'upload-error',
- file,
- new Error('This is bar and I do not like bar'),
- )
- }
- })
- return Promise.resolve()
- })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'bar.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- return expect(core.upload()).resolves.toMatchObject({
- successful: [{ name: 'foo.jpg' }],
- failed: [
- { name: 'bar.jpg', error: 'This is bar and I do not like bar' },
- ],
- })
- })
- it('should only upload files that are not already assigned to another upload id', () => {
- const core = new Core()
- // @ts-ignore
- core.store.state.currentUploads = {
- // @ts-ignore
- upload1: {
- fileIDs: [
- 'uppy-file1/jpg-1e-image/jpeg',
- 'uppy-file2/jpg-1e-image/jpeg',
- 'uppy-file3/jpg-1e-image/jpeg',
- ],
- },
- // @ts-ignore
- upload2: {
- fileIDs: [
- 'uppy-file4/jpg-1e-image/jpeg',
- 'uppy-file5/jpg-1e-image/jpeg',
- 'uppy-file6/jpg-1e-image/jpeg',
- ],
- },
- }
- core.addUploader(() => Promise.resolve())
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- // @ts-ignore
- data: new Uint8Array(),
- })
- core.addFile({
- source: 'vi',
- name: 'bar.jpg',
- type: 'image/jpeg',
- // @ts-ignore
- data: new Uint8Array(),
- })
- core.addFile({
- source: 'file3',
- name: 'file3.jpg',
- type: 'image/jpeg',
- // @ts-ignore
- data: new Uint8Array(),
- })
- // uploadID is random, we don't want randomness in the snapshot
- return expect(
- core
- .upload()
- .then((r) =>
- typeof r!.uploadID === 'string' && r!.uploadID.length === 21 ?
- { ...r, uploadID: 'cjd09qwxb000dlql4tp4doz8h' }
- : r,
- ),
- ).resolves.toMatchSnapshot()
- })
- it('should not upload if onBeforeUpload returned false', () => {
- const core = new Core({
- onBeforeUpload: (files) => {
- for (const fileId in files) {
- if (files[fileId].name === '123.foo') {
- return false
- }
- }
- return files
- },
- })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'bar.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: '123.foo',
- type: 'image/jpeg',
- data: testImage,
- })
- return core.upload().catch((err) => {
- expect(err).toMatchObject(
- new Error(
- 'Not starting the upload because onBeforeUpload returned false',
- ),
- )
- })
- })
- it('only allows a single upload() batch when allowMultipleUploadBatches: false', async () => {
- const core = new Core({ allowMultipleUploadBatches: false })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'bar.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- await expect(core.upload()).resolves.toBeDefined()
- await expect(core.upload()).rejects.toThrow(
- /Cannot create a new upload: already uploading\./,
- )
- })
- it('allows new files again with allowMultipleUploadBatches: false after cancelAll() was called', async () => {
- const core = new Core({ allowMultipleUploadBatches: false })
- core.addFile({
- source: 'vi',
- name: 'bar.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- await expect(core.upload()).resolves.toBeDefined()
- core.cancelAll()
- core.addFile({
- source: 'vi',
- name: '123.foo',
- type: 'image/jpeg',
- data: testImage,
- })
- await expect(core.upload()).resolves.toBeDefined()
- })
- })
- describe('removing a file', () => {
- it('should remove the file', () => {
- const fileRemovedEventMock = vi.fn()
- const core = new Core()
- core.on('file-removed', fileRemovedEventMock)
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- expect(core.getFiles().length).toEqual(1)
- core.setState({
- totalProgress: 50,
- })
- const file = core.getFile(fileId)
- core.removeFile(fileId)
- expect(core.getFiles().length).toEqual(0)
- expect(fileRemovedEventMock.mock.calls[0][0]).toEqual(file)
- expect(core.getState().totalProgress).toEqual(0)
- })
- })
- describe('retries', () => {
- it('should start a new upload with failed files', async () => {
- const onUpload = vi.fn()
- const onRetryAll = vi.fn()
- const core = new Core()
- core.on('upload', onUpload)
- core.on('retry-all', onRetryAll)
- const id = core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.setFileState(id, {
- error: 'something went wrong',
- })
- await core.retryAll()
- expect(onRetryAll).toHaveBeenCalled()
- expect(onUpload).toHaveBeenCalled()
- })
- it('should not start a new upload if there are no failed files', async () => {
- const onUpload = vi.fn()
- const core = new Core()
- core.on('upload', onUpload)
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- await core.retryAll()
- expect(onUpload).not.toHaveBeenCalled()
- })
- })
- describe('restoring a file', () => {
- it.skip('should restore a file')
- it.skip("should fail to restore a file if it doesn't exist")
- })
- describe('get a file', () => {
- it('should get the specified file', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- expect(core.getFile(fileId).name).toEqual('foo.jpg')
- expect(core.getFile('non existent file')).toEqual(undefined)
- })
- })
- describe('getFiles', () => {
- it('should return an empty array if there are no files', () => {
- const core = new Core()
- expect(core.getFiles()).toEqual([])
- })
- it('should return all files as an array', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'empty.dat',
- type: 'application/octet-stream',
- // @ts-ignore
- data: new File([new Uint8Array(1000)], {
- type: 'application/octet-stream',
- }),
- })
- expect(core.getFiles()).toHaveLength(2)
- expect(
- core
- .getFiles()
- .map((file) => file.name)
- .sort(),
- ).toEqual(['empty.dat', 'foo.jpg'])
- })
- })
- describe('setOptions', () => {
- it('should change options on the fly', () => {
- const core = new Core()
- core.setOptions({
- id: 'lolUppy',
- autoProceed: true,
- allowMultipleUploadBatches: true,
- })
- expect(core.opts.id).toEqual('lolUppy')
- expect(core.opts.autoProceed).toEqual(true)
- expect(core.opts.allowMultipleUploadBatches).toEqual(true)
- })
- it('should change locale on the fly', () => {
- const core = new Core()
- expect(core.i18n('cancel')).toEqual('Cancel')
- core.setOptions({
- locale: {
- strings: {
- cancel: 'Отмена',
- },
- },
- })
- expect(core.i18n('cancel')).toEqual('Отмена')
- expect(core.i18n('logOut')).toEqual('Log out')
- })
- it('should change meta on the fly', () => {
- const core = new Core<{ foo: string; beep: string }, any>({
- meta: { foo: 'bar', beep: '' },
- })
- expect(core.getState().meta).toMatchObject({
- foo: 'bar',
- })
- core.setOptions({
- meta: {
- beep: 'boop',
- },
- })
- expect(core.getState().meta).toMatchObject({
- foo: 'bar',
- beep: 'boop',
- })
- })
- it('should change restrictions on the fly', () => {
- const fr_FR: Locale<0 | 1> = {
- strings: {
- youCanOnlyUploadFileTypes:
- 'Vous pouvez seulement téléverser: %{types}',
- },
- pluralize(n) {
- if (n <= 1) {
- return 0
- }
- return 1
- },
- }
- const core = new Core({
- restrictions: {
- allowedFileTypes: ['image/jpeg'],
- maxNumberOfFiles: 2,
- },
- })
- try {
- core.addFile({
- source: 'vi',
- name: 'foo1.png',
- type: 'image/png',
- // @ts-ignore
- data: new File([sampleImage], { type: 'image/png' }),
- })
- } catch (err) {
- expect(err).toMatchObject(new Error('You can only upload: image/jpeg'))
- }
- core.setOptions({
- locale: fr_FR,
- })
- try {
- core.addFile({
- source: 'vi',
- name: 'foo1.png',
- type: 'image/png',
- // @ts-ignore
- data: new File([sampleImage], { type: 'image/png' }),
- })
- } catch (err) {
- expect(err).toMatchObject(
- new Error('Vous pouvez seulement téléverser: image/jpeg'),
- )
- }
- core.setOptions({
- locale: fr_FR,
- restrictions: {
- allowedFileTypes: ['image/png'],
- },
- })
- expect(core.opts.restrictions.allowedFileTypes).toMatchObject([
- 'image/png',
- ])
- expect(() => {
- core.addFile({
- source: 'vi',
- name: 'foo1.png',
- type: 'image/png',
- // @ts-ignore
- data: new File([sampleImage], { type: 'image/png' }),
- })
- }).not.toThrow()
- expect(core.getFiles().length).toEqual(1)
- })
- })
- describe('meta data', () => {
- it('should set meta data by calling setMeta', () => {
- // use DeepFrozenStore in some tests to make sure we are not mutating things
- const core = new Core<
- {
- foo: string
- boo: string
- foo2: string
- bur: string
- },
- any
- >({
- store: DeepFrozenStore(),
- // @ts-ignore
- meta: { foo2: 'bar2' },
- })
- core.setMeta({ foo: 'bar', bur: 'mur' })
- core.setMeta({ boo: 'moo', bur: 'fur' })
- expect(core.getState().meta).toEqual({
- foo: 'bar',
- foo2: 'bar2',
- boo: 'moo',
- bur: 'fur',
- })
- })
- it('should update meta data for a file by calling updateMeta', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- core.setFileMeta(fileId, { foo: 'bar', bur: 'mur' })
- core.setFileMeta(fileId, { boo: 'moo', bur: 'fur' })
- expect(core.getFile(fileId).meta).toEqual({
- name: 'foo.jpg',
- type: 'image/jpeg',
- foo: 'bar',
- bur: 'fur',
- boo: 'moo',
- })
- })
- it('should merge meta data when add file', () => {
- const core = new Core({
- meta: { foo2: 'bar2' },
- })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- meta: {
- // @ts-ignore
- resize: 5000,
- },
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- expect(core.getFile(fileId).meta).toEqual({
- name: 'foo.jpg',
- type: 'image/jpeg',
- foo2: 'bar2',
- resize: 5000,
- })
- })
- })
- describe('progress', () => {
- it('should calculate the progress of a file upload', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const fileId = Object.keys(core.getState().files)[0]
- const file = core.getFile(fileId)
- // @ts-ignore
- core.emit('upload-progress', file, {
- bytesUploaded: 12345,
- bytesTotal: 17175,
- })
- expect(core.getFile(fileId).progress).toEqual({
- percentage: 72,
- bytesUploaded: 12345,
- bytesTotal: 17175,
- uploadComplete: false,
- uploadStarted: null,
- })
- // @ts-ignore
- core.emit('upload-progress', file, {
- bytesUploaded: 17175,
- bytesTotal: 17175,
- })
- core.calculateProgress.flush()
- expect(core.getFile(fileId).progress).toEqual({
- percentage: 100,
- bytesUploaded: 17175,
- bytesTotal: 17175,
- uploadComplete: false,
- uploadStarted: null,
- })
- })
- it('should work with unsized files', async () => {
- const core = new Core()
- let proceedUpload
- let finishUpload
- const promise = new Promise((resolve) => {
- proceedUpload = resolve
- })
- const finishPromise = new Promise((resolve) => {
- finishUpload = resolve
- })
- core.addUploader(async ([id]) => {
- core.emit('upload-start', [core.getFile(id)])
- await promise
- // @ts-ignore deprecated
- core.emit('upload-progress', core.getFile(id), {
- bytesTotal: 3456,
- bytesUploaded: 1234,
- })
- await finishPromise
- // @ts-ignore deprecated
- core.emit('upload-success', core.getFile(id), { uploadURL: 'lol' })
- })
- core.addFile({
- source: 'instagram',
- name: 'foo.jpg',
- type: 'image/jpeg',
- // @ts-ignore
- data: {},
- })
- core.calculateTotalProgress()
- const uploadPromise = core.upload()
- await Promise.all([
- new Promise((resolve) => core.once('upload-start', resolve)),
- ])
- expect(core.getFiles()[0].size).toBeNull()
- expect(core.getFiles()[0].progress).toMatchObject({
- bytesUploaded: 0,
- // null indicates unsized
- bytesTotal: null,
- percentage: 0,
- })
- // @ts-ignore
- proceedUpload()
- // wait for progress event
- await promise
- expect(core.getFiles()[0].size).toBeNull()
- expect(core.getFiles()[0].progress).toMatchObject({
- bytesUploaded: 1234,
- bytesTotal: 3456,
- percentage: 36,
- })
- expect(core.getState().totalProgress).toBe(36)
- // @ts-ignore
- finishUpload()
- // wait for success event
- await finishPromise
- expect(core.getFiles()[0].size).toBe(3456)
- expect(core.getFiles()[0].progress).toMatchObject({
- bytesUploaded: 3456,
- bytesTotal: 3456,
- percentage: 100,
- })
- await uploadPromise
- core.destroy()
- })
- it('should estimate progress for unsized files', () => {
- const core = new Core()
- core.once('file-added', (file) => {
- core.emit('upload-start', [file])
- // @ts-ignore
- core.emit('upload-progress', file, {
- bytesTotal: 3456,
- bytesUploaded: 1234,
- })
- })
- core.addFile({
- source: 'instagram',
- name: 'foo.jpg',
- type: 'image/jpeg',
- // @ts-ignore
- data: {},
- })
- core.once('file-added', (file) => {
- core.emit('upload-start', [file])
- core.emit('upload-progress', file, {
- // @ts-ignore
- bytesTotal: null,
- // @ts-ignore
- bytesUploaded: null,
- })
- })
- core.addFile({
- source: 'instagram',
- name: 'bar.jpg',
- type: 'image/jpeg',
- // @ts-ignore
- data: {},
- })
- core.calculateTotalProgress()
- // foo.jpg at 35%, bar.jpg at 0%
- expect(core.getState().totalProgress).toBe(18)
- core.destroy()
- })
- it('should calculate the total progress of all file uploads', () => {
- // use DeepFrozenStore in some tests to make sure we are not mutating things
- const core = new Core({
- store: DeepFrozenStore(),
- })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const [file1, file2] = core.getFiles()
- core.setFileState(file1.id, {
- // @ts-ignore suddenly dates??
- progress: { ...file1.progress, uploadStarted: new Date() },
- })
- core.setFileState(file2.id, {
- // @ts-ignore suddenly dates??
- progress: { ...file2.progress, uploadStarted: new Date() },
- })
- // @ts-ignore test does not care about missing properties
- core.emit('upload-progress', core.getFile(file1.id), {
- bytesUploaded: 12345,
- bytesTotal: 17175,
- })
- // @ts-ignore test does not care about missing properties
- core.emit('upload-progress', core.getFile(file2.id), {
- bytesUploaded: 10201,
- bytesTotal: 17175,
- })
- core.calculateTotalProgress()
- core.calculateProgress.flush()
- expect(core.getState().totalProgress).toEqual(66)
- })
- it('should reset the progress', () => {
- const resetProgressEvent = vi.fn()
- const core = new Core()
- core.on('reset-progress', resetProgressEvent)
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- const [file1, file2] = core.getFiles()
- core.setFileState(file1.id, {
- // @ts-ignore suddenly dates??
- progress: { ...file1.progress, uploadStarted: new Date() },
- })
- core.setFileState(file2.id, {
- // @ts-ignore suddenly dates??
- progress: { ...file2.progress, uploadStarted: new Date() },
- })
- // @ts-ignore test does not care about missing properties
- core.emit('upload-progress', core.getFile(file1.id), {
- bytesUploaded: 12345,
- bytesTotal: 17175,
- })
- // @ts-ignore test does not care about missing properties
- core.emit('upload-progress', core.getFile(file2.id), {
- bytesUploaded: 10201,
- bytesTotal: 17175,
- })
- core.calculateTotalProgress()
- core.calculateProgress.flush()
- expect(core.getState().totalProgress).toEqual(66)
- core.resetProgress()
- expect(core.getFile(file1.id).progress).toEqual({
- percentage: 0,
- bytesUploaded: false,
- bytesTotal: 17175,
- uploadComplete: false,
- uploadStarted: null,
- })
- expect(core.getFile(file2.id).progress).toEqual({
- percentage: 0,
- bytesUploaded: false,
- bytesTotal: 17175,
- uploadComplete: false,
- uploadStarted: null,
- })
- expect(core.getState().totalProgress).toEqual(0)
- expect(core.getState().allowNewUpload).toEqual(true)
- expect(core.getState().error).toEqual(null)
- expect(core.getState().recoveredState).toEqual(null)
- expect(resetProgressEvent.mock.calls.length).toEqual(1)
- })
- })
- describe('checkRestrictions', () => {
- it('should enforce the maxNumberOfFiles rule', () => {
- const core = new Core({
- restrictions: {
- maxNumberOfFiles: 1,
- },
- })
- // add 2 files
- core.addFile({
- source: 'vi',
- name: 'foo1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- try {
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- throw new Error('should have thrown')
- } catch (err) {
- expect(err).toMatchObject(new Error('You can only upload 1 file'))
- expect(core.getState().info[0].message).toEqual(
- 'You can only upload 1 file',
- )
- }
- })
- it('should not enforce the maxNumberOfFiles rule for ghost files', () => {
- const core = new Core({
- restrictions: {
- maxNumberOfFiles: 1,
- },
- })
- expect(() => {
- // add 1 ghost file
- const fileId1 = core.addFile({
- source: 'vi',
- name: 'foo1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- core.setFileState(fileId1, { isGhost: true })
- // add another file
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- }).not.toThrowError()
- })
- it.skip('should enforce the minNumberOfFiles rule')
- it('should enforce the allowedFileTypes rule', () => {
- const core = new Core({
- restrictions: {
- allowedFileTypes: ['image/gif', 'image/png'],
- },
- })
- try {
- core.addFile({
- source: 'vi',
- name: 'foo2.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- throw new Error('should have thrown')
- } catch (err) {
- expect(err).toMatchObject(
- new Error('You can only upload: image/gif, image/png'),
- )
- expect(core.getState().info[0].message).toEqual(
- 'You can only upload: image/gif, image/png',
- )
- }
- })
- it('should throw if allowedFileTypes is not an array', () => {
- try {
- const core = new Core({
- restrictions: {
- // @ts-ignore
- allowedFileTypes: 'image/gif',
- },
- })
- core.log('hi')
- } catch (err) {
- expect(err).toMatchObject(
- new Error('`restrictions.allowedFileTypes` must be an array'),
- )
- }
- })
- it('should enforce the allowedFileTypes rule with file extensions', () => {
- const core = new Core({
- restrictions: {
- allowedFileTypes: ['.gif', '.jpg', '.jpeg'],
- },
- })
- try {
- core.addFile({
- source: 'vi',
- name: 'foo2.png',
- type: '',
- data: testImage,
- })
- throw new Error('should have thrown')
- } catch (err) {
- expect(err).toMatchObject(
- new Error('You can only upload: .gif, .jpg, .jpeg'),
- )
- expect(core.getState().info[0].message).toEqual(
- 'You can only upload: .gif, .jpg, .jpeg',
- )
- }
- expect(() =>
- core.addFile({
- source: 'vi',
- name: 'foo2.JPG',
- type: '',
- data: testImage,
- }),
- ).not.toThrow()
- })
- it('should enforce the maxFileSize rule', () => {
- const core = new Core({
- restrictions: {
- maxFileSize: 1234,
- },
- })
- try {
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- throw new Error('should have thrown')
- } catch (err) {
- expect(err).toMatchObject(
- new Error('foo.jpg exceeds maximum allowed size of 1.2 KB'),
- )
- expect(core.getState().info[0].message).toEqual(
- 'foo.jpg exceeds maximum allowed size of 1.2 KB',
- )
- }
- })
- it('should enforce the minFileSize rule', () => {
- const core = new Core({
- restrictions: {
- minFileSize: 1073741824,
- },
- })
- try {
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- throw new Error('should have thrown')
- } catch (err) {
- expect(err).toMatchObject(
- new Error('This file is smaller than the allowed size of 1 GB'),
- )
- expect(core.getState().info[0].message).toEqual(
- 'This file is smaller than the allowed size of 1 GB',
- )
- }
- })
- it('should enforce the maxTotalFileSize rule', () => {
- const core = new Core({
- restrictions: {
- maxTotalFileSize: 34000,
- },
- })
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- expect(() => {
- core.addFile({
- source: 'vi',
- name: 'foo1.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- }).toThrowError(
- new Error('foo1.jpg exceeds maximum allowed size of 33 KB'),
- )
- })
- it('should check if a file validateRestrictions', () => {
- const core = new Core({
- restrictions: {
- minFileSize: 300000,
- },
- })
- const core2 = new Core({
- restrictions: {
- allowedFileTypes: ['image/png'],
- },
- })
- const newFile = {
- source: 'vi',
- name: 'foo1.jpg',
- extension: 'jpg',
- type: 'image/jpeg',
- data: testImage,
- isFolder: false,
- mimeType: 'image/jpeg',
- modifiedDate: '2016-04-13T15:11:31.204Z',
- size: 270733,
- }
- // @ts-ignore
- const validateRestrictions1 = core.validateRestrictions(newFile)
- // @ts-ignore
- const validateRestrictions2 = core2.validateRestrictions(newFile)
- expect(validateRestrictions1!.message).toEqual(
- 'This file is smaller than the allowed size of 293 KB',
- )
- expect(validateRestrictions2!.message).toEqual(
- 'You can only upload: image/png',
- )
- })
- it('should emit `restriction-failed` event when some rule is violated', () => {
- const maxFileSize = 100
- const core = new Core({
- restrictions: {
- maxFileSize,
- },
- })
- const restrictionsViolatedEventMock = vi.fn()
- const file = {
- source: 'vi',
- type: 'image/jpeg',
- name: 'test.jpg',
- data: new Blob([new Uint8Array(2 * maxFileSize)]),
- }
- const errorMessage = core.i18n('exceedsSize', {
- file: file.name,
- size: prettierBytes(maxFileSize),
- })
- try {
- core.on('restriction-failed', restrictionsViolatedEventMock)
- core.addFile(file)
- } catch {
- // Ignore errors
- }
- expect(restrictionsViolatedEventMock.mock.calls.length).toEqual(1)
- expect(restrictionsViolatedEventMock.mock.calls[0][0].name).toEqual(
- file.name,
- )
- expect(restrictionsViolatedEventMock.mock.calls[0][1].message).toEqual(
- errorMessage,
- )
- })
- })
- describe('actions', () => {
- it('should update the state when receiving the error event', () => {
- const core = new Core()
- core.emit('error', new Error('foooooo'))
- expect(core.getState().error).toEqual('foooooo')
- })
- it('should update the state when receiving the upload-error event', () => {
- const core = new Core()
- core.setState({
- files: {
- // @ts-ignore
- fileId: {
- id: 'fileId',
- name: 'filename',
- },
- },
- })
- // @ts-ignore test does not care about missing properties
- core.emit(
- 'upload-error',
- core.getFile('fileId'),
- new Error('this is the error'),
- )
- expect(core.getState().info).toEqual([
- {
- message: 'Failed to upload filename',
- details: 'this is the error',
- type: 'error',
- },
- ])
- })
- it('should reset the error state when receiving the upload event', () => {
- const core = new Core()
- // @ts-ignore test does not care about missing properties
- core.emit('error', { foo: 'bar' })
- // @ts-ignore test does not care about missing properties
- core.emit('upload')
- expect(core.getState().error).toEqual(null)
- })
- })
- describe('updateOnlineStatus', () => {
- const RealNavigatorOnline = globalThis.window.navigator.onLine
- function mockNavigatorOnline(status: boolean) {
- Object.defineProperty(globalThis.window.navigator, 'onLine', {
- value: status,
- writable: true,
- })
- }
- afterEach(() => {
- // @ts-ignore readonly but whatever
- globalThis.window.navigator.onLine = RealNavigatorOnline
- })
- it('should emit the correct event based on whether there is a network connection', () => {
- const onlineEventMock = vi.fn()
- const offlineEventMock = vi.fn()
- const backOnlineEventMock = vi.fn()
- const core = new Core()
- // @ts-ignore untyped
- core.on('is-offline', offlineEventMock)
- // @ts-ignore untyped
- core.on('is-online', onlineEventMock)
- // @ts-ignore untyped
- core.on('back-online', backOnlineEventMock)
- mockNavigatorOnline(true)
- core.updateOnlineStatus()
- expect(onlineEventMock.mock.calls.length).toEqual(1)
- expect(offlineEventMock.mock.calls.length).toEqual(0)
- expect(backOnlineEventMock.mock.calls.length).toEqual(0)
- mockNavigatorOnline(false)
- core.updateOnlineStatus()
- expect(onlineEventMock.mock.calls.length).toEqual(1)
- expect(offlineEventMock.mock.calls.length).toEqual(1)
- expect(backOnlineEventMock.mock.calls.length).toEqual(0)
- mockNavigatorOnline(true)
- core.updateOnlineStatus()
- expect(onlineEventMock.mock.calls.length).toEqual(2)
- expect(offlineEventMock.mock.calls.length).toEqual(1)
- expect(backOnlineEventMock.mock.calls.length).toEqual(1)
- })
- })
- describe('info', () => {
- it('should set a string based message to be displayed infinitely', () => {
- const infoVisibleEvent = vi.fn()
- const core = new Core()
- core.on('info-visible', infoVisibleEvent)
- core.info('This is the message', 'info', 0)
- expect(core.getState().info).toEqual([
- {
- type: 'info',
- message: 'This is the message',
- details: null,
- },
- ])
- expect(infoVisibleEvent.mock.calls.length).toEqual(1)
- })
- it('should set a object based message to be displayed infinitely', () => {
- const infoVisibleEvent = vi.fn()
- const core = new Core()
- core.on('info-visible', infoVisibleEvent)
- core.info(
- {
- message: 'This is the message',
- details: {
- foo: 'bar',
- },
- },
- 'warning',
- 0,
- )
- expect(core.getState().info).toEqual([
- {
- type: 'warning',
- message: 'This is the message',
- details: {
- foo: 'bar',
- },
- },
- ])
- expect(infoVisibleEvent.mock.calls.length).toEqual(1)
- })
- it('should set an info message to be displayed for a period of time before hiding', (done) => {
- const infoVisibleEvent = vi.fn()
- const infoHiddenEvent = vi.fn()
- const core = new Core()
- core.on('info-visible', infoVisibleEvent)
- core.on('info-hidden', infoHiddenEvent)
- core.info('This is the message', 'info', 100)
- expect(infoHiddenEvent.mock.calls.length).toEqual(0)
- setTimeout(() => {
- expect(infoHiddenEvent.mock.calls.length).toEqual(1)
- expect(core.getState().info).toEqual([])
- // @ts-ignore
- done()
- }, 110)
- })
- it('should hide an info message', () => {
- const infoVisibleEvent = vi.fn()
- const infoHiddenEvent = vi.fn()
- const core = new Core()
- core.on('info-visible', infoVisibleEvent)
- core.on('info-hidden', infoHiddenEvent)
- core.info('This is the message', 'info', 0)
- expect(infoHiddenEvent.mock.calls.length).toEqual(0)
- core.hideInfo()
- expect(infoHiddenEvent.mock.calls.length).toEqual(1)
- expect(core.getState().info).toEqual([])
- })
- it('should support multiple messages', () => {
- const infoVisibleEvent = vi.fn()
- const infoHiddenEvent = vi.fn()
- const core = new Core()
- core.on('info-visible', infoVisibleEvent)
- core.on('info-hidden', infoHiddenEvent)
- core.info('This is the message', 'info', 0)
- core.info('But this is another one', 'info', 0)
- expect(infoHiddenEvent.mock.calls.length).toEqual(0)
- expect(core.getState().info).toEqual([
- {
- type: 'info',
- message: 'This is the message',
- details: null,
- },
- {
- type: 'info',
- message: 'But this is another one',
- details: null,
- },
- ])
- core.hideInfo()
- expect(core.getState().info).toEqual([
- {
- type: 'info',
- message: 'But this is another one',
- details: null,
- },
- ])
- core.hideInfo()
- expect(infoHiddenEvent.mock.calls.length).toEqual(2)
- expect(core.getState().info).toEqual([])
- })
- })
- describe('createUpload', () => {
- it('should assign the specified files to a new upload', () => {
- const core = new Core()
- core.addFile({
- source: 'vi',
- name: 'foo.jpg',
- type: 'image/jpeg',
- data: testImage,
- })
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
- // @ts-ignore accessing private method
- core[Symbol.for('uppy test: createUpload')](
- Object.keys(core.getState().files),
- )
- const uploadId = Object.keys(core.getState().currentUploads)[0]
- const currentUploadsState: State<any, any>['currentUploads'] = {}
- currentUploadsState[uploadId] = {
- fileIDs: Object.keys(core.getState().files),
- step: 0,
- result: {},
- }
- expect(core.getState().currentUploads).toEqual(currentUploadsState)
- })
- })
- describe('i18n', () => {
- it('merges in custom locale strings', () => {
- const core = new Core({
- locale: {
- strings: {
- test: 'beep boop',
- },
- pluralize: () => 0,
- },
- })
- expect(core.i18n('exceedsSize')).toBe(
- '%{file} exceeds maximum allowed size of %{size}',
- )
- expect(core.i18n('test')).toBe('beep boop')
- })
- })
- describe('default restrictions', () => {
- it('should be merged with supplied restrictions', () => {
- const core = new Core({
- restrictions: {
- maxNumberOfFiles: 3,
- },
- })
- expect(core.opts.restrictions.maxNumberOfFiles).toBe(3)
- expect(core.opts.restrictions.minNumberOfFiles).toBe(null)
- })
- })
- describe('log', () => {
- it('should log via provided logger function', () => {
- const myTestLogger = {
- debug: vi.fn(),
- warn: vi.fn(),
- error: vi.fn(),
- }
- const core = new Core({
- logger: myTestLogger,
- })
- core.log('test test')
- core.log('test test', 'error')
- core.log('test test', 'error')
- core.log('test test', 'warning')
- // logger.debug should have been called 1 time above,
- // but we call log in Core’s constructor to output VERSION, hence +1 here
- // @ts-ignore
- expect(core.opts.logger.debug.mock.calls.length).toBe(2)
- // @ts-ignore
- expect(core.opts.logger.error.mock.calls.length).toBe(2)
- // @ts-ignore
- expect(core.opts.logger.warn.mock.calls.length).toBe(1)
- })
- it('should log via provided logger function, even if debug: true', () => {
- const myTestLogger = {
- debug: vi.fn(),
- warn: vi.fn(),
- error: vi.fn(),
- }
- const core = new Core({
- logger: myTestLogger,
- debug: true,
- })
- core.log('test test')
- core.log('test test', 'error')
- core.log('test test', 'error')
- core.log('test test', 'warning')
- // logger.debug should have been called 1 time above,
- // but we call log in Core’s constructor to output VERSION, hence +1 here
- // @ts-ignore
- expect(core.opts.logger.debug.mock.calls.length).toBe(2)
- // @ts-ignore
- expect(core.opts.logger.error.mock.calls.length).toBe(2)
- // logger.warn should have been called 1 time above,
- // but we warn in Core when using both logger and debug: true, hence +1 here
- // @ts-ignore
- expect(core.opts.logger.warn.mock.calls.length).toBe(2)
- })
- it('should log to console when logger: Uppy.debugLogger or debug: true is set', () => {
- console.debug = vi.fn()
- console.error = vi.fn()
- const core = new Core({
- logger: debugLogger,
- })
- core.log('test test')
- core.log('beep boop')
- core.log('beep beep', 'error')
- // console.debug debug should have been called 2 times above,
- // ibut we call log n Core’ constructor to output VERSION, hence +1 here
- // @ts-ignore
- expect(console.debug.mock.calls.length).toBe(3)
- // @ts-ignore
- expect(console.error.mock.calls.length).toBe(1)
- // @ts-ignore
- console.debug.mockClear()
- // @ts-ignore
- console.error.mockClear()
- const core2 = new Core({
- debug: true,
- })
- core2.log('test test')
- core2.log('beep boop')
- core2.log('beep beep', 'error')
- // console.debug debug should have been called 2 times here,
- // but we call log in Core constructor to output VERSION, hence +1 here
- // @ts-ignore
- expect(console.debug.mock.calls.length).toBe(3)
- // @ts-ignore
- expect(console.error.mock.calls.length).toBe(1)
- })
- it('should only log errors to console when logger is not set', () => {
- console.debug = vi.fn()
- console.error = vi.fn()
- const core = new Core()
- core.log('test test')
- core.log('beep boop')
- core.log('beep beep', 'error')
- // @ts-ignore
- expect(console.debug.mock.calls.length).toBe(0)
- // @ts-ignore
- expect(console.error.mock.calls.length).toBe(1)
- })
- })
- })
|