-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use Chonky file browser with S3 data provided via GraphQL in the S3ObjectPicker component #4149
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
212 changes: 80 additions & 132 deletions
212
app/assets/js/components/Work/Tabs/Preservation/S3ObjectPicker.jsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,144 +1,92 @@ | ||
import useAcceptedMimeTypes from "@js/hooks/useAcceptedMimeTypes"; | ||
import { Button } from "@nulib/design-system"; | ||
import { | ||
LIST_INGEST_BUCKET_OBJECTS, | ||
} from "@js/components/Work/work.gql.js"; | ||
import React, { useState } from "react"; | ||
/** @jsx jsx */ | ||
import { css, jsx } from "@emotion/react"; | ||
import { useQuery } from "@apollo/client"; | ||
import { FaSpinner } from "react-icons/fa"; | ||
import { formatBytes } from "@js/services/helpers"; | ||
|
||
import Error from "@js/components/UI/Error"; | ||
import UIFormInput from "@js/components/UI/Form/Input.jsx"; | ||
|
||
const tableContainerCss = css` | ||
max-height: 30vh; | ||
overflow-y: auto; | ||
`; | ||
|
||
const fileRowCss = css` | ||
cursor: pointer; | ||
`; | ||
|
||
const selectedRowCss = css` | ||
background-color: #f0f8ff !important; | ||
`; | ||
import React, { useEffect, useRef, useState } from "react"; | ||
import S3ObjectProvider from './S3ObjectProvider'; | ||
import { styled } from '@stitches/react'; | ||
|
||
const colHeaders = ["File Key", "Size", "Mime Type"]; | ||
|
||
const S3ObjectPicker = ({ onFileSelect, fileSetRole, workTypeId, defaultPrefix = "" }) => { | ||
import { | ||
ChonkyActions, | ||
FileBrowser, | ||
FileList, | ||
FileNavbar, | ||
FileToolbar, | ||
} from "chonky"; | ||
import { ChonkyIconFA } from "chonky-icon-fontawesome"; | ||
|
||
const StyledFilePicker = styled('div', { | ||
"& .chonky-toolbarRight": { | ||
display: "none" | ||
} | ||
}); | ||
|
||
const S3ObjectPicker = ({ | ||
onFileSelect, | ||
fileSetRole, | ||
workTypeId, | ||
defaultPrefix = "", | ||
}) => { | ||
const [prefix, setPrefix] = useState(defaultPrefix); | ||
const [selectedFile, setSelectedFile] = useState(null); | ||
const [error, _setError] = useState(null); | ||
const [uploadProgress, setUploadProgress] = useState(0); | ||
const [isUploading, setIsUploading] = useState(false); | ||
|
||
const { isFileValid } = useAcceptedMimeTypes(); | ||
|
||
const { loading: queryLoading, error: queryError, data, refetch } = useQuery(LIST_INGEST_BUCKET_OBJECTS, { | ||
variables: { prefix } | ||
}); | ||
|
||
const handleClear = () => { | ||
setPrefix(defaultPrefix); | ||
refetch({ prefix: defaultPrefix }); | ||
}; | ||
|
||
const handlePrefixChange = async (e) => { | ||
const inputValue = e.target.value; | ||
const newPrefix = inputValue.startsWith(defaultPrefix) ? inputValue : defaultPrefix + inputValue; | ||
setPrefix(newPrefix); | ||
await refetch({ prefix: newPrefix }); | ||
}; | ||
|
||
const handleRefresh = async () => { | ||
await refetch({ prefix: prefix }); | ||
}; | ||
|
||
const handleFileClick = (fileSet) => { | ||
setSelectedFile(fileSet.key); | ||
onFileSelect(fileSet); | ||
// Reset upload progress and isUploading state when selecting an S3 object | ||
setUploadProgress(0); | ||
setIsUploading(false); | ||
}; | ||
const [error, setError] = useState(null); | ||
|
||
const fileBrowserRef = useRef(null); | ||
const providerRef = useRef(null); | ||
|
||
useEffect(() => { | ||
const fileSet = providerRef?.current?.findFileSetByUri(selectedFile); | ||
fileSet && onFileSelect && onFileSelect(fileSet); | ||
}, [selectedFile]); | ||
|
||
const handleFileAction = (action) => { | ||
switch (action.id) { | ||
case ChonkyActions.OpenFiles.id: | ||
const { targetFile } = action.payload; | ||
if (targetFile.isDir) { | ||
setPrefix(action.payload.targetFile.id); | ||
} | ||
break; | ||
|
||
case ChonkyActions.ChangeSelection.id: | ||
if ( | ||
action.payload.selection.size == 0 && | ||
files.find(({ id }) => selectedFile == id) | ||
) { | ||
fileBrowserRef.current.setFileSelection(new Set([selectedFile])); | ||
return; | ||
} | ||
|
||
const handleDragAndDrop = (file) => { | ||
// Simulating file upload process | ||
setIsUploading(true); | ||
setUploadProgress(0); | ||
const interval = setInterval(() => { | ||
setUploadProgress((prevProgress) => { | ||
if (prevProgress >= 100) { | ||
clearInterval(interval); | ||
setIsUploading(false); | ||
return 100; | ||
const selectedFiles = [...action.payload.selection]; | ||
const clicked = selectedFiles[selectedFiles.length - 1]; | ||
|
||
if (selectedFiles.length > 1) { | ||
// Reject multiselect | ||
fileBrowserRef.current.setFileSelection(new Set([clicked])); | ||
} else if ( | ||
clicked && | ||
clicked.match(/^s3:/) && | ||
selectedFile != clicked | ||
) { | ||
setSelectedFile(clicked); | ||
} | ||
return prevProgress + 10; | ||
}); | ||
}, 500); | ||
break; | ||
} | ||
}; | ||
|
||
if (queryLoading) return <FaSpinner className="spinner" />; | ||
if (queryError) return <Error error={queryError} />; | ||
|
||
return ( | ||
<div className="file-picker"> | ||
<div className="drag-drop-area" onDrop={handleDragAndDrop}> | ||
{/* Drag and drop area */} | ||
<p>Drag 'n' drop a file here, or click to select file</p> | ||
{isUploading && ( | ||
<div className="progress-bar"> | ||
<div className="progress" style={{ width: `${uploadProgress}%` }}></div> | ||
</div> | ||
)} | ||
</div> | ||
<UIFormInput | ||
placeholder="Enter prefix" | ||
name="prefixSearch" | ||
label="Prefix Search" | ||
onChange={handlePrefixChange} | ||
value={prefix} | ||
/> | ||
<div className="buttons mt-2"> | ||
<Button onClick={handleClear}>Clear</Button> | ||
<Button onClick={handleRefresh}>Refresh</Button> | ||
</div> | ||
<StyledFilePicker className="file-picker" data-testid="file-picker"> | ||
{error && <div className="error">{error}</div>} | ||
{data && data.ListIngestBucketObjects && ( | ||
<div className="table-container" css={tableContainerCss}> | ||
<table className="table is-striped is-fullwidth"> | ||
<thead> | ||
<tr> | ||
{colHeaders.map((col) => ( | ||
<th key={col}>{col}</th> | ||
))} | ||
</tr> | ||
</thead> | ||
<tbody> | ||
{data.ListIngestBucketObjects.filter(file => { | ||
const { isValid } = isFileValid(fileSetRole, workTypeId, file.mimeType); | ||
return isValid; | ||
}).map((fileSet, index) => ( | ||
<tr | ||
key={index} | ||
onClick={() => handleFileClick(fileSet)} | ||
className={selectedFile === fileSet.key ? "selected" : ""} | ||
css={[fileRowCss, selectedFile === fileSet.key && selectedRowCss]} | ||
> | ||
<td>{fileSet.key}</td> | ||
<td>{formatBytes(fileSet.size)}</td> | ||
<td>{fileSet.mimeType}</td> | ||
</tr> | ||
))} | ||
</tbody> | ||
</table> | ||
</div> | ||
)} | ||
</div> | ||
<S3ObjectProvider fileSetRole={fileSetRole} workTypeId={workTypeId} prefix={prefix} ref={providerRef}> | ||
<FileBrowser | ||
ref={fileBrowserRef} | ||
defaultFileViewActionId={ChonkyActions.EnableListView.id} | ||
onFileAction={handleFileAction} | ||
iconComponent={ChonkyIconFA} | ||
> | ||
<FileNavbar /> | ||
<FileToolbar /> | ||
<FileList/> | ||
</FileBrowser> | ||
</S3ObjectProvider> | ||
</StyledFilePicker> | ||
); | ||
}; | ||
|
||
export default S3ObjectPicker; | ||
export default S3ObjectPicker; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍