mirror of
https://github.com/overleaf/overleaf.git
synced 2024-09-23 02:55:13 -04:00
c07aa9638b
[web] Count folders toward entity limit on frontend GitOrigin-RevId: ef07a61639f0dc516c83e4ed0f2fdc35e8b6d3fa
499 lines
14 KiB
JavaScript
499 lines
14 KiB
JavaScript
import { expect } from 'chai'
|
||
import * as sinon from 'sinon'
|
||
import { useEffect } from 'react'
|
||
import { screen, fireEvent, cleanup, waitFor } from '@testing-library/react'
|
||
import fetchMock from 'fetch-mock'
|
||
import PropTypes from 'prop-types'
|
||
|
||
import renderWithContext from '../../helpers/render-with-context'
|
||
import FileTreeModalCreateFile from '../../../../../../frontend/js/features/file-tree/components/modals/file-tree-modal-create-file'
|
||
import { useFileTreeActionable } from '../../../../../../frontend/js/features/file-tree/contexts/file-tree-actionable'
|
||
import { useFileTreeData } from '../../../../../../frontend/js/shared/context/file-tree-data-context'
|
||
|
||
describe('<FileTreeModalCreateFile/>', function () {
|
||
beforeEach(function () {
|
||
window.csrfToken = 'token'
|
||
})
|
||
|
||
afterEach(function () {
|
||
delete window.csrfToken
|
||
fetchMock.restore()
|
||
cleanup()
|
||
})
|
||
|
||
it('handles invalid file names', async function () {
|
||
renderWithContext(<OpenWithMode mode="doc" />)
|
||
|
||
const submitButton = screen.getByRole('button', { name: 'Create' })
|
||
|
||
const input = screen.getByLabelText('File Name')
|
||
expect(input.value).to.equal('name.tex')
|
||
expect(submitButton.disabled).to.be.false
|
||
expect(screen.queryAllByRole('alert')).to.be.empty
|
||
|
||
fireEvent.change(input, { target: { value: '' } })
|
||
expect(submitButton.disabled).to.be.true
|
||
screen.getByRole(
|
||
(role, element) =>
|
||
role === 'alert' && element.textContent.match(/File name is empty/)
|
||
)
|
||
|
||
await fireEvent.change(input, { target: { value: 'test.tex' } })
|
||
expect(submitButton.disabled).to.be.false
|
||
expect(screen.queryAllByRole('alert')).to.be.empty
|
||
|
||
await fireEvent.change(input, { target: { value: 'oops/i/did/it/again' } })
|
||
expect(submitButton.disabled).to.be.true
|
||
screen.getByRole(
|
||
(role, element) =>
|
||
role === 'alert' &&
|
||
element.textContent.match(/contains invalid characters/)
|
||
)
|
||
})
|
||
|
||
it('displays an error when the file limit is reached', async function () {
|
||
const rootFolder = [
|
||
{
|
||
_id: 'root-folder-id',
|
||
name: 'rootFolder',
|
||
docs: Array.from({ length: 10 }, (_, index) => ({
|
||
_id: `entity-${index}`,
|
||
})),
|
||
fileRefs: [],
|
||
folders: [],
|
||
},
|
||
]
|
||
|
||
renderWithContext(<OpenWithMode mode="doc" />, {
|
||
contextProps: { rootFolder },
|
||
})
|
||
|
||
screen.getByRole(
|
||
(role, element) =>
|
||
role === 'alert' &&
|
||
element.textContent.match(/This project has reached the \d+ file limit/)
|
||
)
|
||
})
|
||
|
||
it('displays a warning when the file limit is nearly reached', async function () {
|
||
const rootFolder = [
|
||
{
|
||
_id: 'root-folder-id',
|
||
name: 'rootFolder',
|
||
docs: Array.from({ length: 9 }, (_, index) => ({
|
||
_id: `entity-${index}`,
|
||
})),
|
||
fileRefs: [],
|
||
folders: [],
|
||
},
|
||
]
|
||
|
||
renderWithContext(<OpenWithMode mode="doc" />, {
|
||
contextProps: { rootFolder },
|
||
})
|
||
|
||
screen.getByText(/This project is approaching the file limit \(\d+\/\d+\)/)
|
||
})
|
||
|
||
it('counts files in nested folders', async function () {
|
||
const rootFolder = [
|
||
{
|
||
_id: 'root-folder-id',
|
||
name: 'rootFolder',
|
||
docs: [{ _id: 'doc-1' }],
|
||
fileRefs: [],
|
||
folders: [
|
||
{
|
||
docs: [{ _id: 'doc-2' }],
|
||
fileRefs: [],
|
||
folders: [
|
||
{
|
||
docs: [
|
||
{ _id: 'doc-3' },
|
||
{ _id: 'doc-4' },
|
||
{ _id: 'doc-5' },
|
||
{ _id: 'doc-6' },
|
||
{ _id: 'doc-7' },
|
||
],
|
||
fileRefs: [],
|
||
folders: [],
|
||
},
|
||
],
|
||
},
|
||
],
|
||
},
|
||
]
|
||
|
||
renderWithContext(<OpenWithMode mode="doc" />, {
|
||
contextProps: { rootFolder },
|
||
})
|
||
|
||
screen.getByText(/This project is approaching the file limit \(\d+\/\d+\)/)
|
||
})
|
||
|
||
it('counts folders toward the limit', async function () {
|
||
const rootFolder = [
|
||
{
|
||
_id: 'root-folder-id',
|
||
name: 'rootFolder',
|
||
docs: [{ _id: 'doc-1' }],
|
||
fileRefs: [],
|
||
folders: [
|
||
{ docs: [], fileRefs: [], folders: [] },
|
||
{ docs: [], fileRefs: [], folders: [] },
|
||
{ docs: [], fileRefs: [], folders: [] },
|
||
{ docs: [], fileRefs: [], folders: [] },
|
||
{ docs: [], fileRefs: [], folders: [] },
|
||
{ docs: [], fileRefs: [], folders: [] },
|
||
{ docs: [], fileRefs: [], folders: [] },
|
||
{ docs: [], fileRefs: [], folders: [] },
|
||
],
|
||
},
|
||
]
|
||
|
||
renderWithContext(<OpenWithMode mode="doc" />, {
|
||
contextProps: { rootFolder },
|
||
})
|
||
|
||
screen.getByText(/This project is approaching the file limit \(\d+\/\d+\)/)
|
||
})
|
||
|
||
it('creates a new file when the form is submitted', async function () {
|
||
fetchMock.post('express:/project/:projectId/doc', () => 204)
|
||
|
||
renderWithContext(<OpenWithMode mode="doc" />)
|
||
|
||
const input = screen.getByLabelText('File Name')
|
||
await fireEvent.change(input, { target: { value: 'test.tex' } })
|
||
|
||
const submitButton = screen.getByRole('button', { name: 'Create' })
|
||
|
||
await fireEvent.click(submitButton)
|
||
|
||
expect(
|
||
fetchMock.called('express:/project/:projectId/doc', {
|
||
body: {
|
||
parent_folder_id: 'root-folder-id',
|
||
name: 'test.tex',
|
||
},
|
||
})
|
||
).to.be.true
|
||
})
|
||
|
||
it('imports a new file from a project', async function () {
|
||
fetchMock
|
||
.get('path:/user/projects', {
|
||
projects: [
|
||
{
|
||
_id: 'test-project',
|
||
name: 'This Project',
|
||
},
|
||
{
|
||
_id: 'project-1',
|
||
name: 'Project One',
|
||
},
|
||
{
|
||
_id: 'project-2',
|
||
name: 'Project Two',
|
||
},
|
||
],
|
||
})
|
||
.get('express:/project/:projectId/entities', {
|
||
entities: [
|
||
{
|
||
path: '/foo.tex',
|
||
},
|
||
{
|
||
path: '/bar.tex',
|
||
},
|
||
],
|
||
})
|
||
.post('express:/project/:projectId/compile', {
|
||
status: 'success',
|
||
outputFiles: [
|
||
{
|
||
build: 'test',
|
||
path: 'baz.jpg',
|
||
},
|
||
{
|
||
build: 'test',
|
||
path: 'ball.jpg',
|
||
},
|
||
],
|
||
})
|
||
.post('express:/project/:projectId/linked_file', () => 204)
|
||
|
||
renderWithContext(<OpenWithMode mode="project" />)
|
||
|
||
// initial state, no project selected
|
||
const projectInput = screen.getByLabelText('Select a Project')
|
||
expect(projectInput.disabled).to.be.true
|
||
await waitFor(() => {
|
||
expect(projectInput.disabled).to.be.false
|
||
})
|
||
|
||
// the submit button should be disabled
|
||
const submitButton = screen.getByRole('button', { name: 'Create' })
|
||
expect(submitButton.disabled).to.be.true
|
||
|
||
// the source file selector should be disabled
|
||
const fileInput = screen.getByLabelText('Select a File')
|
||
expect(fileInput.disabled).to.be.true
|
||
// TODO: check for options length, excluding current project
|
||
|
||
// select a project
|
||
await fireEvent.change(projectInput, { target: { value: 'project-2' } }) // TODO: getByRole('option')?
|
||
|
||
// wait for the source file selector to be enabled
|
||
await waitFor(() => {
|
||
expect(fileInput.disabled).to.be.false
|
||
})
|
||
expect(screen.queryByLabelText('Select a File')).not.to.be.null
|
||
expect(screen.queryByLabelText('Select an Output File')).to.be.null
|
||
expect(submitButton.disabled).to.be.true
|
||
|
||
// TODO: check for fileInput options length, excluding current project
|
||
|
||
// click on the button to toggle between source and output files
|
||
const sourceTypeButton = screen.getByRole('button', {
|
||
// NOTE: When changing the label, update the other tests with this label as well.
|
||
name: 'select from output files',
|
||
})
|
||
await fireEvent.click(sourceTypeButton)
|
||
|
||
// wait for the output file selector to be enabled
|
||
const entityInput = screen.getByLabelText('Select an Output File')
|
||
await waitFor(() => {
|
||
expect(entityInput.disabled).to.be.false
|
||
})
|
||
expect(screen.queryByLabelText('Select a File')).to.be.null
|
||
expect(screen.queryByLabelText('Select an Output File')).not.to.be.null
|
||
expect(submitButton.disabled).to.be.true
|
||
|
||
// TODO: check for entityInput options length, excluding current project
|
||
await fireEvent.change(entityInput, { target: { value: 'ball.jpg' } }) // TODO: getByRole('option')?
|
||
|
||
await waitFor(() => {
|
||
expect(submitButton.disabled).to.be.false
|
||
})
|
||
await fireEvent.click(submitButton)
|
||
|
||
expect(
|
||
fetchMock.called('express:/project/:projectId/linked_file', {
|
||
body: {
|
||
name: 'ball.jpg',
|
||
provider: 'project_output_file',
|
||
parent_folder_id: 'root-folder-id',
|
||
data: {
|
||
source_project_id: 'project-2',
|
||
source_output_file_path: 'ball.jpg',
|
||
build_id: 'test',
|
||
},
|
||
},
|
||
})
|
||
).to.be.true
|
||
})
|
||
|
||
describe('when the output files feature is not available', function () {
|
||
const flagBefore = window.ExposedSettings.hasLinkedProjectOutputFileFeature
|
||
before(function () {
|
||
window.ExposedSettings.hasLinkedProjectOutputFileFeature = false
|
||
})
|
||
after(function () {
|
||
window.ExposedSettings.hasLinkedProjectOutputFileFeature = flagBefore
|
||
})
|
||
|
||
it('should not show the import from output file mode', async function () {
|
||
fetchMock.get('path:/user/projects', {
|
||
projects: [
|
||
{
|
||
_id: 'test-project',
|
||
name: 'This Project',
|
||
},
|
||
{
|
||
_id: 'project-1',
|
||
name: 'Project One',
|
||
},
|
||
{
|
||
_id: 'project-2',
|
||
name: 'Project Two',
|
||
},
|
||
],
|
||
})
|
||
|
||
renderWithContext(<OpenWithMode mode="project" />)
|
||
|
||
// should not show the toggle
|
||
expect(
|
||
screen.queryByRole('button', {
|
||
name: 'select from output files',
|
||
})
|
||
).to.be.null
|
||
})
|
||
})
|
||
|
||
it('import from a URL when the form is submitted', async function () {
|
||
fetchMock.post('express:/project/:projectId/linked_file', () => 204)
|
||
|
||
renderWithContext(<OpenWithMode mode="url" />)
|
||
|
||
const urlInput = screen.getByLabelText('URL to fetch the file from')
|
||
const nameInput = screen.getByLabelText('File Name In This Project')
|
||
|
||
await fireEvent.change(urlInput, {
|
||
target: { value: 'https://example.com/example.tex' },
|
||
})
|
||
|
||
// check that the name has updated automatically
|
||
expect(nameInput.value).to.equal('example.tex')
|
||
|
||
await fireEvent.change(nameInput, {
|
||
target: { value: 'test.tex' },
|
||
})
|
||
|
||
// check that the name can still be edited manually
|
||
expect(nameInput.value).to.equal('test.tex')
|
||
|
||
const submitButton = screen.getByRole('button', { name: 'Create' })
|
||
|
||
await fireEvent.click(submitButton)
|
||
|
||
expect(
|
||
fetchMock.called('express:/project/:projectId/linked_file', {
|
||
body: {
|
||
name: 'test.tex',
|
||
provider: 'url',
|
||
parent_folder_id: 'root-folder-id',
|
||
data: { url: 'https://example.com/example.tex' },
|
||
},
|
||
})
|
||
).to.be.true
|
||
})
|
||
|
||
it('uploads a dropped file', async function () {
|
||
const xhr = sinon.useFakeXMLHttpRequest()
|
||
const requests = []
|
||
xhr.onCreate = request => {
|
||
requests.push(request)
|
||
}
|
||
|
||
renderWithContext(<OpenWithMode mode="upload" />)
|
||
|
||
// the submit button should not be present
|
||
expect(screen.queryByRole('button', { name: 'Create' })).to.be.null
|
||
|
||
const dropzone = screen.getByLabelText('File Uploader')
|
||
|
||
expect(dropzone).not.to.be.null
|
||
|
||
fireEvent.drop(dropzone, {
|
||
dataTransfer: {
|
||
files: [new File(['test'], 'test.tex', { type: 'text/plain' })],
|
||
},
|
||
})
|
||
|
||
await waitFor(() => expect(requests).to.have.length(1))
|
||
|
||
const [request] = requests
|
||
expect(request.url).to.equal(
|
||
'/project/123abc/upload?folder_id=root-folder-id'
|
||
)
|
||
expect(request.method).to.equal('POST')
|
||
|
||
xhr.restore()
|
||
})
|
||
|
||
it('uploads a pasted file', async function () {
|
||
const xhr = sinon.useFakeXMLHttpRequest()
|
||
const requests = []
|
||
xhr.onCreate = request => {
|
||
requests.push(request)
|
||
}
|
||
|
||
renderWithContext(<OpenWithMode mode="upload" />)
|
||
|
||
// the submit button should not be present
|
||
expect(screen.queryByRole('button', { name: 'Create' })).to.be.null
|
||
|
||
const dropzone = screen.getByLabelText('File Uploader')
|
||
|
||
expect(dropzone).not.to.be.null
|
||
|
||
fireEvent.paste(dropzone, {
|
||
clipboardData: {
|
||
files: [new File(['test'], 'test.tex', { type: 'text/plain' })],
|
||
},
|
||
})
|
||
|
||
await waitFor(() => expect(requests).to.have.length(1))
|
||
|
||
const [request] = requests
|
||
expect(request.url).to.equal(
|
||
'/project/123abc/upload?folder_id=root-folder-id'
|
||
)
|
||
expect(request.method).to.equal('POST')
|
||
|
||
xhr.restore()
|
||
})
|
||
|
||
it('displays upload errors', async function () {
|
||
const xhr = sinon.useFakeXMLHttpRequest()
|
||
const requests = []
|
||
xhr.onCreate = request => {
|
||
requests.push(request)
|
||
}
|
||
|
||
renderWithContext(<OpenWithMode mode="upload" />)
|
||
|
||
// the submit button should not be present
|
||
expect(screen.queryByRole('button', { name: 'Create' })).to.be.null
|
||
|
||
const dropzone = screen.getByLabelText('File Uploader')
|
||
|
||
expect(dropzone).not.to.be.null
|
||
|
||
fireEvent.paste(dropzone, {
|
||
clipboardData: {
|
||
files: [new File(['test'], 'tes!t.tex', { type: 'text/plain' })],
|
||
},
|
||
})
|
||
|
||
await waitFor(() => expect(requests).to.have.length(1))
|
||
|
||
const [request] = requests
|
||
expect(request.url).to.equal(
|
||
'/project/123abc/upload?folder_id=root-folder-id'
|
||
)
|
||
expect(request.method).to.equal('POST')
|
||
|
||
request.respond(
|
||
422,
|
||
{ 'Content-Type': 'application/json' },
|
||
'{ "success": false, "error": "invalid_filename" }'
|
||
)
|
||
|
||
await screen.findByText(
|
||
`Upload failed: check that the file name doesn’t contain special characters, trailing/leading whitespace or more than 150 characters`
|
||
)
|
||
|
||
xhr.restore()
|
||
})
|
||
})
|
||
|
||
function OpenWithMode({ mode }) {
|
||
const { newFileCreateMode, startCreatingFile } = useFileTreeActionable()
|
||
|
||
const { fileCount } = useFileTreeData()
|
||
|
||
// eslint-disable-next-line react-hooks/exhaustive-deps
|
||
useEffect(() => startCreatingFile(mode), [])
|
||
|
||
if (!fileCount || !newFileCreateMode) {
|
||
return null
|
||
}
|
||
|
||
return <FileTreeModalCreateFile />
|
||
}
|
||
OpenWithMode.propTypes = {
|
||
mode: PropTypes.string.isRequired,
|
||
}
|