10685800115

Committed 03 Sep 2024 03:16PM UTC coverage: 97.42% (-0.05%) from 97.466%

Build # 10685800115

Build Type

Pull #464

github

Committed by

ErykKul

Commit Message

merged develop

Pull Request Pull Request #464: Feature/417 File upload integration

Run Details

1277 of 1330 branches covered (96.02%)

Branch coverage included in aggregate %.

30 of 30 new or added lines in 3 files covered. (100.0%)

1 existing line in 1 file now uncovered.

3405 of 3476 relevant lines covered (97.96%)

9535.63 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

97.94

/src/sections/upload-dataset-files/UploadDatasetFiles.tsx

import { useEffect, useState } from 'react'
import { useTranslation } from 'react-i18next'
import { md5 } from 'js-md5'
import { Semaphore } from 'async-mutex'
import { useNavigate } from 'react-router-dom'
import { FileRepository } from '../../files/domain/repositories/FileRepository'
import { useLoading } from '../loading/LoadingContext'
import { useDataset } from '../dataset/DatasetContext'
import { PageNotFound } from '../page-not-found/PageNotFound'
import { BreadcrumbsGenerator } from '../shared/hierarchy/BreadcrumbsGenerator'
import { FileUploader } from './FileUploader'
import { FileUploadState, FileUploadTools } from '../../files/domain/models/FileUploadState'
import { uploadFile } from '../../files/domain/useCases/uploadFile'
import { UploadedFiles } from './uploaded-files-list/UploadedFiles'
import { addUploadedFiles } from '../../files/domain/useCases/addUploadedFiles'
import { Route } from '../Route.enum'

interface UploadDatasetFilesProps {
  fileRepository: FileRepository
}

export const UploadDatasetFiles = ({ fileRepository: fileRepository }: UploadDatasetFilesProps) => {
  const { setIsLoading } = useLoading()
  const { dataset, isLoading } = useDataset()
  const { t } = useTranslation('uploadDatasetFiles')
  const [fileUploaderState, setState] = useState(FileUploadTools.createNewState([]))
  const [uploadingToCancelMap, setUploadingToCancelMap] = useState(new Map<string, () => void>())
  const navigate = useNavigate()

  const limit = 6
  const semaphore = new Semaphore(limit)

  const fileUploadFailed = (file: File) => {
    setUploadingToCancelMap((x) => {
      x.delete(FileUploadTools.key(file))
      return x
    })
    semaphore.release(1)
  }

  const fileUploadFinished = (file: File) => {
    const hash = md5.create()
    const reader = file.stream().getReader()
    reader
      .read()
      .then(async function updateHash({ done, value }) {
        if (done) {
          FileUploadTools.checksum(file, hash.hex(), fileUploaderState)
        } else {
          hash.update(value)
          await updateHash(await reader.read())
        }
      })
      .finally(() => {
        setUploadingToCancelMap((x) => {
          x.delete(FileUploadTools.key(file))
          return x
        })
        semaphore.release(1)
      })
  }

  const canUpload = (file: File) =>
    !uploadingToCancelMap.has(FileUploadTools.key(file)) &&
    !FileUploadTools.get(file, fileUploaderState).failed &&
    !FileUploadTools.get(file, fileUploaderState).done

  const uploadOneFile = (file: File) => {
    // sanity check: should not happen
    /* istanbul ignore next */
    if (!canUpload(file)) {
      return
    }
    const key = FileUploadTools.key(file)
    setState(FileUploadTools.showProgressBar(file, fileUploaderState))
    const cancel = uploadFile(
      fileRepository,
      dataset?.persistentId as string,
      file,
      () => {
        setState(FileUploadTools.done(file, fileUploaderState))
        fileUploadFinished(file)
      },
      () => {
        setState(FileUploadTools.failed(file, fileUploaderState))
        fileUploadFailed(file)
      },
      (now) => setState(FileUploadTools.progress(file, now, fileUploaderState)),
      (storageId) => setState(FileUploadTools.storageId(file, storageId, fileUploaderState))
    )
    setUploadingToCancelMap((x) => x.set(key, cancel))
  }

  const upload = async (file: File) => {
    await semaphore.acquire(1)
    uploadOneFile(file)
  }

  const cleanup = (file: File) => {
    const key = FileUploadTools.key(file)
    const cancel = uploadingToCancelMap.get(key)
    if (cancel) {
      cancel()
    }
    setUploadingToCancelMap((x) => {
      x.delete(key)
      return x
    })
  }

  const cancelUpload = (file: File) => {
    cleanup(file)
    setState(FileUploadTools.removed(file, fileUploaderState))
  }

  const updateFiles = (fileUploadState: FileUploadState[]) => {
    setState((x) => {
      fileUploadState.forEach((file) => {
        x.state.set(file.key, file)
      })
      return { state: x.state, uploaded: x.uploaded }
    })
  }

  const cleanFileState = (file: File) => {
    cleanup(file)
    setState(FileUploadTools.delete(file, fileUploaderState))
  }

  const cleanAllState = () => {
    setState((x) => {
      Array.from(x.state.values()).forEach((fileUploadState) => {
        fileUploadState.removed = true
      })
      return { state: x.state, uploaded: x.uploaded }
    })
  }

  const addFiles = (state: FileUploadState[]) => {
    setIsLoading(true)
    const done = () => {
      setIsLoading(false)
      navigate(`${Route.DATASETS}?persistentId=${dataset?.persistentId as string}&version=:draft`)
    }
    const uploadedFiles = FileUploadTools.mapToUploadedFilesDTOs(state)
    addUploadedFiles(fileRepository, dataset?.persistentId as string, uploadedFiles, done)
    cleanAllState()
  }

  const saveDisabled = () =>
    Array.from(fileUploaderState.state.values()).some((x) => !(x.failed || x.done || x.removed))

  useEffect(() => {
    setIsLoading(isLoading)
  }, [isLoading, setIsLoading])

  if (isLoading) {
    return <p>Temporary Loading until having shape of skeleton</p>
  }

  return (
    <>
      {!dataset ? (
        <PageNotFound />
      ) : (
        <>
          <BreadcrumbsGenerator
            hierarchy={dataset.hierarchy}
            withActionItem
            actionItemText={t('breadcrumbActionItem')}
          />
          <article>
            <FileUploader
              upload={upload}
              cancelTitle={t('cancel')}
              info={t('info')}
              selectText={t('select')}
              fileUploaderState={fileUploaderState}
              cancelUpload={cancelUpload}
              cleanFileState={cleanFileState}
            />
            <UploadedFiles
              fileUploadState={fileUploaderState.uploaded}
              cancelTitle={t('delete')}
              saveDisabled={saveDisabled()}
              updateFiles={updateFiles}
              cleanup={cleanAllState}
              addFiles={addFiles}
            />
          </article>
        </>
      )}
    </>
  )
}

1	import { useEffect, useState } from 'react'
2	import { useTranslation } from 'react-i18next'
3	import { md5 } from 'js-md5'
4	import { Semaphore } from 'async-mutex'
5	import { useNavigate } from 'react-router-dom'
6	import { FileRepository } from '../../files/domain/repositories/FileRepository'
7	import { useLoading } from '../loading/LoadingContext'
8	import { useDataset } from '../dataset/DatasetContext'
9	import { PageNotFound } from '../page-not-found/PageNotFound'
10	import { BreadcrumbsGenerator } from '../shared/hierarchy/BreadcrumbsGenerator'
11	import { FileUploader } from './FileUploader'
12	import { FileUploadState, FileUploadTools } from '../../files/domain/models/FileUploadState'
13	import { uploadFile } from '../../files/domain/useCases/uploadFile'
14	import { UploadedFiles } from './uploaded-files-list/UploadedFiles'
15	import { addUploadedFiles } from '../../files/domain/useCases/addUploadedFiles'
16	import { Route } from '../Route.enum'
17
18	interface UploadDatasetFilesProps {
19	fileRepository: FileRepository
20	}
21
22	export const UploadDatasetFiles = ({ fileRepository: fileRepository }: UploadDatasetFilesProps) => {	1,508✔
23	const { setIsLoading } = useLoading()	1,508✔
24	const { dataset, isLoading } = useDataset()	1,508✔
25	const { t } = useTranslation('uploadDatasetFiles')	1,508✔
26	const [fileUploaderState, setState] = useState(FileUploadTools.createNewState([]))	1,489✔
27	const [uploadingToCancelMap, setUploadingToCancelMap] = useState(new Map<string, () => void>())	1,489✔
28	const navigate = useNavigate()	1,489✔
29
30	const limit = 6	1,489✔
31	const semaphore = new Semaphore(limit)	1,489✔
32
33	const fileUploadFailed = (file: File) => {	1,489✔
34	setUploadingToCancelMap((x) => {	25✔
35	x.delete(FileUploadTools.key(file))	25✔
36	return x	25✔
37	})
38	semaphore.release(1)	25✔
39	}
40
41	const fileUploadFinished = (file: File) => {	1,489✔
42	const hash = md5.create()	142✔
43	const reader = file.stream().getReader()	142✔
44	reader	142✔
45	.read()
46	.then(async function updateHash({ done, value }) {
47	if (done) {	284✔
48	FileUploadTools.checksum(file, hash.hex(), fileUploaderState)	142✔
49	} else {
50	hash.update(value)	142✔
51	await updateHash(await reader.read())	142✔
52	}
53	})
54	.finally(() => {
55	setUploadingToCancelMap((x) => {	142✔
56	x.delete(FileUploadTools.key(file))	79✔
57	return x	79✔
58	})
59	semaphore.release(1)	142✔
60	})
61	}
62
63	const canUpload = (file: File) =>	1,489✔
64	!uploadingToCancelMap.has(FileUploadTools.key(file)) &&	203✔
65	!FileUploadTools.get(file, fileUploaderState).failed &&
66	!FileUploadTools.get(file, fileUploaderState).done
67
68	const uploadOneFile = (file: File) => {	1,489✔
69	// sanity check: should not happen
70	/* istanbul ignore next */
71	if (!canUpload(file)) {	203!
UNCOV 72	return	×
73	}
74	const key = FileUploadTools.key(file)	203✔
75	setState(FileUploadTools.showProgressBar(file, fileUploaderState))	203✔
76	const cancel = uploadFile(	203✔
77	fileRepository,
78	dataset?.persistentId as string,
79	file,
80	() => {
81	setState(FileUploadTools.done(file, fileUploaderState))	142✔
82	fileUploadFinished(file)	142✔
83	},
84	() => {
85	setState(FileUploadTools.failed(file, fileUploaderState))	25✔
86	fileUploadFailed(file)	25✔
87	},
88	(now) => setState(FileUploadTools.progress(file, now, fileUploaderState)),	719✔
89	(storageId) => setState(FileUploadTools.storageId(file, storageId, fileUploaderState))	142✔
90	)
91	setUploadingToCancelMap((x) => x.set(key, cancel))	203✔
92	}
93
94	const upload = async (file: File) => {	1,489✔
95	await semaphore.acquire(1)	203✔
96	uploadOneFile(file)	203✔
97	}
98
99	const cleanup = (file: File) => {	1,489✔
100	const key = FileUploadTools.key(file)	92✔
101	const cancel = uploadingToCancelMap.get(key)	92✔
102	if (cancel) {	92✔
103	cancel()	14✔
104	}
105	setUploadingToCancelMap((x) => {	92✔
106	x.delete(key)	92✔
107	return x	92✔
108	})
109	}
110
111	const cancelUpload = (file: File) => {	1,489✔
112	cleanup(file)	14✔
113	setState(FileUploadTools.removed(file, fileUploaderState))	14✔
114	}
115
116	const updateFiles = (fileUploadState: FileUploadState[]) => {	1,489✔
117	setState((x) => {	210✔
118	fileUploadState.forEach((file) => {	210✔
119	x.state.set(file.key, file)	230✔
120	})
121	return { state: x.state, uploaded: x.uploaded }	210✔
122	})
123	}
124
125	const cleanFileState = (file: File) => {	1,489✔
126	cleanup(file)	78✔
127	setState(FileUploadTools.delete(file, fileUploaderState))	78✔
128	}
129
130	const cleanAllState = () => {	1,489✔
131	setState((x) => {	41✔
132	Array.from(x.state.values()).forEach((fileUploadState) => {	41✔
133	fileUploadState.removed = true	82✔
134	})
135	return { state: x.state, uploaded: x.uploaded }	41✔
136	})
137	}
138
139	const addFiles = (state: FileUploadState[]) => {	1,489✔
140	setIsLoading(true)	17✔
141	const done = () => {	17✔
142	setIsLoading(false)	15✔
143	navigate(`${Route.DATASETS}?persistentId=${dataset?.persistentId as string}&version=:draft`)	15✔
144	}
145	const uploadedFiles = FileUploadTools.mapToUploadedFilesDTOs(state)	17✔
146	addUploadedFiles(fileRepository, dataset?.persistentId as string, uploadedFiles, done)	17✔
147	cleanAllState()	17✔
148	}
149
150	const saveDisabled = () =>	1,489✔
151	Array.from(fileUploaderState.state.values()).some((x) => !(x.failed \|\| x.done \|\| x.removed))	1,249✔
152
153	useEffect(() => {	1,489✔
154	setIsLoading(isLoading)	378✔
155	}, [isLoading, setIsLoading])
156
157	if (isLoading) {	1,489✔
158	return <p>Temporary Loading until having shape of skeleton</p>	189✔
159	}
160
161	return (	1,300✔
162	<>
163	{!dataset ? (	1,300✔
164	<PageNotFound />
165	) : (
166	<>
167	<BreadcrumbsGenerator
168	hierarchy={dataset.hierarchy}
169	withActionItem
170	actionItemText={t('breadcrumbActionItem')}
171	/>
172	<article>
173	<FileUploader
174	upload={upload}
175	cancelTitle={t('cancel')}
176	info={t('info')}
177	selectText={t('select')}
178	fileUploaderState={fileUploaderState}
179	cancelUpload={cancelUpload}
180	cleanFileState={cleanFileState}
181	/>
182	<UploadedFiles
183	fileUploadState={fileUploaderState.uploaded}
184	cancelTitle={t('delete')}
185	saveDisabled={saveDisabled()}
186	updateFiles={updateFiles}
187	cleanup={cleanAllState}
188	addFiles={addFiles}
189	/>
190	</article>
191	</>
192	)}
193	</>
194	)
195	}	19✔

IQSS / dataverse-frontend / 10685800115

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous