@openneuro/app 4.20.4 → 4.20.6-alpha.2

package/src/scripts/dataset/download/__tests__/download-link.spec.jsx

@@ -1,18 +1,18 @@
-import React from 'react'
-import { render } from '@testing-library/react'
-import DownloadLink from '../download-link.jsx'
-import { MockedProvider } from '@apollo/client/testing'
-import { vi } from 'vitest'
+import React from "react"
+import { render } from "@testing-library/react"
+import DownloadLink from "../download-link.jsx"
+import { MockedProvider } from "@apollo/client/testing"
+import { vi } from "vitest"
 
-vi.mock('../../../config.ts')
+vi.mock("../../../config.ts")
 
 const defProps = {
-  datasetId: 'ds000001',
-  snapshotTag: '1.0.0',
+  datasetId: "ds000001",
+  snapshotTag: "1.0.0",
 }
 
-describe('dataset/download/DownloadLink', () => {
-  it('renders successfully', () => {
+describe("dataset/download/DownloadLink", () => {
+  it("renders successfully", () => {
     const { asFragment } = render(
       <MockedProvider>
         <DownloadLink {...defProps} />

package/src/scripts/dataset/download/__tests__/download-native.spec.js

@@ -1,16 +1,16 @@
-import { openFileTree } from '../download-native.js'
+import { openFileTree } from "../download-native.js"
 
-vi.mock('../../../config.ts')
+vi.mock("../../../config.ts")
 
-describe('dataset/download - native file API method', () => {
-  describe('openFileTree', () => {
-    it('iterates over directory to correct depth', async () => {
+describe("dataset/download - native file API method", () => {
+  describe("openFileTree", () => {
+    it("iterates over directory to correct depth", async () => {
       const mockDirectoryHandle = {}
-      const mockFile = Symbol('mockFile')
+      const mockFile = Symbol("mockFile")
       mockDirectoryHandle.getDirectoryHandle = vi.fn(() => mockDirectoryHandle)
       mockDirectoryHandle.getFileHandle = vi.fn(() => mockFile)
       expect(
-        await openFileTree(mockDirectoryHandle, 'sub-01/anat/something.nii.gz'),
+        await openFileTree(mockDirectoryHandle, "sub-01/anat/something.nii.gz"),
       ).toBe(mockFile)
       expect(mockDirectoryHandle.getDirectoryHandle).toHaveBeenCalledTimes(2)
     })

package/src/scripts/dataset/download/__tests__/shell-example.spec.jsx

@@ -1,9 +1,9 @@
-import React from 'react'
-import { render } from '@testing-library/react'
-import ShellExample from '../shell-example.jsx'
+import React from "react"
+import { render } from "@testing-library/react"
+import ShellExample from "../shell-example.jsx"
 
-describe('dataset/download/ShellExample', () => {
-  it('renders successfully', () => {
+describe("dataset/download/ShellExample", () => {
+  it("renders successfully", () => {
     const { asFragment } = render(<ShellExample />)
     expect(asFragment()).toMatchSnapshot()
   })

package/src/scripts/dataset/download/download-command-line.jsx

@@ -1,10 +1,11 @@
-import React from 'react'
-import PropTypes from 'prop-types'
-import ShellExample from './shell-example.jsx'
+import React from "react"
+import PropTypes from "prop-types"
+import ShellExample from "./shell-example.jsx"
 
 export const DownloadSampleCommand = ({ datasetId, snapshotTag }) => (
   <ShellExample role="figure">
-    openneuro download {snapshotTag ? `--snapshot ${snapshotTag}` : '--draft'}{' '}
+    openneuro download {snapshotTag ? `--snapshot ${snapshotTag}` : "--draft"}
+    {" "}
     {datasetId} {datasetId}
     -download/
   </ShellExample>
@@ -19,9 +20,10 @@ const DownloadCommandLine = ({ datasetId, snapshotTag }) => (
   <div>
     <h4>Download with Node.js</h4>
     <p>
-      Using{' '}
-      <a href="https://www.npmjs.com/package/@openneuro/cli">@openneuro/cli</a>{' '}
-      you can download this dataset from the command line using{' '}
+      Using{" "}
+      <a href="https://www.npmjs.com/package/@openneuro/cli">@openneuro/cli</a>
+      {" "}
+      you can download this dataset from the command line using{" "}
       <a href="https://nodejs.org/en/download/">Node.js</a>. This method is good
       for larger datasets or unstable connections, but has known issues on
       Windows.

package/src/scripts/dataset/download/download-datalad.jsx

@@ -1,12 +1,12 @@
-import React from 'react'
-import PropTypes from 'prop-types'
-import { getConfig, config } from '../../config'
-import ShellExample from './shell-example.jsx'
+import React from "react"
+import PropTypes from "prop-types"
+import { config, getConfig } from "../../config"
+import ShellExample from "./shell-example.jsx"
 import {
   getUnexpiredProfile,
   hasEditPermissions,
-} from '../../authentication/profile'
-import { useCookies } from 'react-cookie'
+} from "../../authentication/profile"
+import { useCookies } from "react-cookie"
 
 const DownloadDataladExample = ({
   datasetId,
@@ -17,8 +17,8 @@ const DownloadDataladExample = ({
   const [cookies] = useCookies()
   const profile = getUnexpiredProfile(cookies)
   const isAdmin = profile?.admin
-  const hasEdit =
-    hasEditPermissions(datasetPermissions, profile?.sub) || isAdmin
+  const hasEdit = hasEditPermissions(datasetPermissions, profile?.sub) ||
+    isAdmin
   return (
     <>
       <ShellExample>
@@ -51,9 +51,9 @@ const DownloadDataladInstructions = ({
   <div>
     <h4>Download with DataLad</h4>
     <p>
-      Public datasets can be downloaded with{' '}
-      <a href="https://www.datalad.org">DataLad</a> or{' '}
-      <a href="https://git-annex.branchable.com/">Git Annex</a> from{' '}
+      Public datasets can be downloaded with{" "}
+      <a href="https://www.datalad.org">DataLad</a> or{" "}
+      <a href="https://git-annex.branchable.com/">Git Annex</a> from{" "}
       <a href={`https://github.com/${githubOrganization}/${datasetId}`}>
         GitHub.
       </a>
@@ -65,10 +65,10 @@ const DownloadDataladInstructions = ({
       datasetPermissions={datasetPermissions}
     />
     <p>
-      Check out{' '}
+      Check out{" "}
       <a href="https://handbook.datalad.org/en/latest/usecases/openneuro.html">
         getting started with DataLad
-      </a>{' '}
+      </a>{" "}
       for more on how to use this download method.
     </p>
   </div>
@@ -81,13 +81,15 @@ DownloadDataladInstructions.propTypes = {
   datasetPermissions: PropTypes.object,
 }
 
-const DownloadDatalad = props =>
+const DownloadDatalad = (props) =>
   // TODO - don't depend on async config
-  getConfig().hasOwnProperty('github') ? (
-    <DownloadDataladInstructions
-      {...props}
-      githubOrganization={getConfig().github}
-    />
-  ) : null
+  getConfig().hasOwnProperty("github")
+    ? (
+      <DownloadDataladInstructions
+        {...props}
+        githubOrganization={getConfig().github}
+      />
+    )
+    : null
 
 export default DownloadDatalad

package/src/scripts/dataset/download/download-derivative-datalad.tsx

@@ -1,5 +1,5 @@
-import React from 'react'
-import ShellExample from './shell-example.jsx'
+import React from "react"
+import ShellExample from "./shell-example.jsx"
 
 interface DownloadDataLadDerivativesProps {
   url: string

package/src/scripts/dataset/download/download-derivative-s3.tsx

@@ -1,5 +1,5 @@
-import React from 'react'
-import ShellExample from './shell-example.jsx'
+import React from "react"
+import ShellExample from "./shell-example.jsx"
 
 interface DownloadS3DerivativesProps {
   name: string

package/src/scripts/dataset/download/download-link.jsx

@@ -1,9 +1,9 @@
-import React from 'react'
-import PropTypes from 'prop-types'
-import { downloadNative } from './download-native.js'
-import { useApolloClient } from '@apollo/client'
-import { Button } from '@openneuro/components/button'
-import { Link } from 'react-router-dom'
+import React from "react"
+import PropTypes from "prop-types"
+import { downloadNative } from "./download-native.js"
+import { useApolloClient } from "@apollo/client"
+import { Button } from "@openneuro/components/button"
+import { Link } from "react-router-dom"
 
 const DownloadLink = ({ datasetId, snapshotTag }) => {
   const client = useApolloClient()

package/src/scripts/dataset/download/download-native.js

@@ -1,16 +1,16 @@
-import { trackDownload } from './track-download.js'
+import { trackDownload } from "./track-download.js"
 import {
+  downloadAbortToast,
+  downloadCompleteToast,
   downloadToast,
-  downloadToastUpdate,
   downloadToastDone,
-  downloadAbortToast,
+  downloadToastUpdate,
   nativeErrorToast,
   permissionsToast,
-  downloadCompleteToast,
   requestFailureToast,
-} from './native-file-toast.jsx'
-import { apm } from '../../apm.js'
-import { downloadDataset } from './download-query'
+} from "./native-file-toast.jsx"
+import { apm } from "../../apm.js"
+import { downloadDataset } from "./download-query"
 
 /**
  * Given a file, create any missing parent directories, obtain directory handle, and return the file handle within that
@@ -20,7 +20,7 @@ import { downloadDataset } from './download-query'
 export const openFileTree = async (initialDirectoryHandle, path) => {
   let directoryHandle = initialDirectoryHandle
   // Get list of any parent directories
-  const pathTokens = path.split('/')
+  const pathTokens = path.split("/")
   const dirTokens = pathTokens.slice(0, -1)
   const filename = pathTokens.slice(-1)
   if (dirTokens.length > 0) {
@@ -36,7 +36,7 @@ export const openFileTree = async (initialDirectoryHandle, path) => {
 class DownloadAbortError extends Error {
   constructor(message) {
     super(message)
-    this.name = 'DownloadAbortError'
+    this.name = "DownloadAbortError"
   }
 }
 
@@ -47,7 +47,7 @@ let downloadCanceled
  */
 const downloadTree = async (
   { datasetId, snapshotTag, client, apmTransaction, dirHandle, toastId },
-  path = '',
+  path = "",
   tree = null,
 ) => {
   const filesToDownload = await downloadDataset(client)({
@@ -74,7 +74,7 @@ const downloadTree = async (
     } else {
       // Regular file
       if (downloadCanceled) {
-        throw new DownloadAbortError('Download canceled by user request')
+        throw new DownloadAbortError("Download canceled by user request")
       }
       const fileHandle = await openFileTree(
         dirHandle,
@@ -119,15 +119,16 @@ export const downloadNative = (datasetId, snapshotTag, client) => async () => {
   } catch (err) {
     apm.captureError(err)
   }
-  const apmTransaction =
-    apm && apm.startTransaction(`download:${datasetId}`, 'download')
-  if (apmTransaction)
+  const apmTransaction = apm &&
+    apm.startTransaction(`download:${datasetId}`, "download")
+  if (apmTransaction) {
     apmTransaction.addLabels({ datasetId, snapshot: snapshotTag })
+  }
   downloadCanceled = false
   let toastId
   try {
-    const apmSelect =
-      apmTransaction && apmTransaction.startSpan('showDirectoryPicker')
+    const apmSelect = apmTransaction &&
+      apmTransaction.startSpan("showDirectoryPicker")
     // Open user selected directory
     const dirHandle = await window.showDirectoryPicker()
     toastId = downloadToast(
@@ -147,11 +148,11 @@ export const downloadNative = (datasetId, snapshotTag, client) => async () => {
     })
     downloadCompleteToast(dirHandle.name)
   } catch (err) {
-    if (err.name === 'AbortError') {
+    if (err.name === "AbortError") {
       return
-    } else if (err.name === 'DownloadAbortError') {
+    } else if (err.name === "DownloadAbortError") {
       downloadAbortToast()
-    } else if (err.name === 'NotAllowedError') {
+    } else if (err.name === "NotAllowedError") {
       permissionsToast()
     } else {
       // Some unknown issue occurred (out of disk space, disk caught fire, etc...)

package/src/scripts/dataset/download/download-query.js

@@ -1,8 +1,7 @@
-import { datasets } from '@openneuro/client'
+import { datasets } from "@openneuro/client"
 
 export const downloadDataset =
-  client =>
-  async ({ datasetId, snapshotTag, tree = null }) => {
+  (client) => async ({ datasetId, snapshotTag, tree = null }) => {
     if (snapshotTag) {
       const { data } = await client.query({
         query: datasets.downloadSnapshot,

package/src/scripts/dataset/download/download-s3.jsx

@@ -1,7 +1,7 @@
-import React from 'react'
-import PropTypes from 'prop-types'
-import ShellExample from './shell-example.jsx'
-import { getConfig } from '../../config'
+import React from "react"
+import PropTypes from "prop-types"
+import ShellExample from "./shell-example.jsx"
+import { getConfig } from "../../config"
 
 export const DownloadSampleS3 = ({ datasetId, s3Bucket }) => (
   <ShellExample>
@@ -37,10 +37,10 @@ DownloadS3Instructions.propTypes = {
   s3Bucket: PropTypes.string,
 }
 
-const DownloadS3 = props =>
+const DownloadS3 = (props) =>
   // TODO - don't depend on async config
-  getConfig().hasOwnProperty('publicBucket') ? (
-    <DownloadS3Instructions {...props} s3Bucket={getConfig().publicBucket} />
-  ) : null
+  getConfig().hasOwnProperty("publicBucket")
+    ? <DownloadS3Instructions {...props} s3Bucket={getConfig().publicBucket} />
+    : null
 
 export default DownloadS3

package/src/scripts/dataset/download/download-script.tsx

@@ -1,18 +1,18 @@
 /**
  * Generate a download script for this dataset
  */
-import React from 'react'
-import { useLazyQuery, gql } from '@apollo/client'
+import React from "react"
+import { gql, useLazyQuery } from "@apollo/client"
 
 function inlineDownload(filename, data): void {
-  const element = document.createElement('a')
+  const element = document.createElement("a")
   element.setAttribute(
-    'href',
-    'data:text/x-shellscript;charset=utf-8,' + encodeURIComponent(data),
+    "href",
+    "data:text/x-shellscript;charset=utf-8," + encodeURIComponent(data),
   )
-  element.setAttribute('download', filename)
+  element.setAttribute("download", filename)
 
-  element.style.display = 'none'
+  element.style.display = "none"
   document.body.appendChild(element)
 
   element.click()
@@ -21,7 +21,7 @@ function inlineDownload(filename, data): void {
 }
 
 function generateDownloadScript(data): string {
-  let script = '#!/bin/sh\n'
+  let script = "#!/bin/sh\n"
   for (const f of data.snapshot.downloadFiles) {
     script += `curl --create-dirs ${f.urls[0]} -o ${f.filename}\n`
   }
@@ -57,7 +57,7 @@ export const DownloadScript = ({
       datasetId: datasetId,
       tag: snapshotTag,
     },
-    errorPolicy: 'all',
+    errorPolicy: "all",
   })
   if (data) {
     const script = generateDownloadScript(data)
@@ -74,17 +74,20 @@ export const DownloadScript = ({
           Node.js.
         </p>
         <p>
-          {loading ? (
-            'Loading...'
-          ) : (
-            <a
-              href="#"
-              onClick={(): void => {
-                void getDownload()
-              }}>
-              Download shell script
-            </a>
-          )}
+          {loading
+            ? (
+              "Loading..."
+            )
+            : (
+              <a
+                href="#"
+                onClick={(): void => {
+                  void getDownload()
+                }}
+              >
+                Download shell script
+              </a>
+            )}
         </p>
       </div>
     )

package/src/scripts/dataset/download/native-file-toast.jsx

@@ -1,6 +1,6 @@
-import React from 'react'
-import { toast } from 'react-toastify'
-import ToastContent from '../../common/partials/toast-content.jsx'
+import React from "react"
+import { toast } from "react-toastify"
+import ToastContent from "../../common/partials/toast-content.jsx"
 
 /**
  * Write failures due to permissions (most likely)
@@ -41,12 +41,12 @@ export const nativeErrorToast = () => {
   )
 }
 
-export const requestFailureToast = filename => {
+export const requestFailureToast = (filename) => {
   toast.error(
     <ToastContent title="Download Error" body="A file failed to download">
       <p>
-        {filename} failed. Retry your download to reattempt downloading this
-        file.
+        {filename}{" "}
+        failed. Retry your download to reattempt downloading this file.
       </p>
     </ToastContent>,
   )
@@ -56,11 +56,13 @@ export const requestFailureToast = filename => {
  * Let the user know their download is done
  * @param {string} dirName
  */
-export const downloadCompleteToast = dirName => {
+export const downloadCompleteToast = (dirName) => {
   toast.success(
     <ToastContent
       title="Download Complete"
-      body={`See "${dirName}" directory for downloaded files`}></ToastContent>,
+      body={`See "${dirName}" directory for downloaded files`}
+    >
+    </ToastContent>,
     { autoClose: false },
   )
 }
@@ -76,7 +78,7 @@ export const downloadToast = (dirName, datasetId, snapshotId, onClose) => {
     ? `${datasetId} snapshot ${snapshotId} to local folder ${dirName}`
     : `${datasetId} to local folder ${dirName}`
   return toast(
-    <ToastContent title={'Downloading'} body={downloadMessage}></ToastContent>,
+    <ToastContent title={"Downloading"} body={downloadMessage}></ToastContent>,
     {
       progress: 0,
       hideProgressBar: false,
@@ -97,7 +99,7 @@ export const downloadToastUpdate = (
     : `${datasetId} to local folder ${dirName}`
   toast.update(toastId, {
     render: (
-      <ToastContent title={'Downloading'} body={downloadMessage}>
+      <ToastContent title={"Downloading"} body={downloadMessage}>
         {downloadPath}
       </ToastContent>
     ),
@@ -105,4 +107,4 @@ export const downloadToastUpdate = (
   })
 }
 
-export const downloadToastDone = toastId => toast.done(toastId)
+export const downloadToastDone = (toastId) => toast.done(toastId)

package/src/scripts/dataset/download/shell-example.jsx

@@ -1,4 +1,4 @@
-import styled from '@emotion/styled'
+import styled from "@emotion/styled"
 
 const ShellExample = styled.pre`
   max-width: 80em;

package/src/scripts/dataset/download/track-download.js

@@ -1,15 +1,15 @@
-import { event } from '../../utils/gtag'
-import { trackAnalytics } from '../../utils/datalad'
+import { event } from "../../utils/gtag"
+import { trackAnalytics } from "../../utils/datalad"
 
 export const trackDownload = (client, datasetId, snapshotTag) => {
   event({
-    category: 'Download',
-    action: 'Started web download',
+    category: "Download",
+    action: "Started web download",
     label: snapshotTag ? `${datasetId}:${snapshotTag}` : datasetId,
   })
   trackAnalytics(client, datasetId, {
     snapshot: true,
     tag: snapshotTag,
-    type: 'downloads',
+    type: "downloads",
   })
 }