File uploads and streaming in Remix - Mini Project: Build & Apply

File uploads and streaming

📖 Scenario: You are building a simple Remix app that lets users upload a text file. The app will read the file content as a stream and display it on the page.

🎯 Goal: Create a Remix route that accepts a file upload, reads the file content using streaming, and shows the content on the page.

📋 What You'll Learn

Create a form with a file input named upload

Add a config variable maxFileSize to limit file size to 1MB

Use request.formData() and file.stream() to read the file content as a stream

Display the uploaded file content inside a <pre> tag on the page

💡 Why This Matters

🌍 Real World

File uploads are common in web apps for user profile pictures, documents, or data import. Streaming large files helps avoid memory issues.

💼 Career

Understanding file uploads and streaming is essential for backend and full-stack developers working with web frameworks like Remix.

1

Create the file upload form

Create a Remix route component with a form containing a file input named upload and a submit button labeled Upload.

Remix

export default function Upload() {
  return (
    
      {/* Your code here */}
    
  );
}

Hint

Use a <form> with method="post" and encType="multipart/form-data". Add a file input with name="upload" and a submit button.

2

Add max file size configuration

Add a constant variable called maxFileSize and set it to 1_000_000 (1 million bytes) to limit the file size.

Remix

const maxFileSize = 1_000_000;

export default function Upload() {
  return (
    
      
      Upload
    
  );
}

// Your code here

Hint

Declare const maxFileSize = 1_000_000; at the top of the file.

3

Read the uploaded file content as a stream

Add an action export async function that uses request.formData() to get the uploaded file from upload. Then read the file content as a stream using file.stream() and convert it to a string. Store the string in a variable called fileContent.

Remix

const maxFileSize = 1_000_000;

export async function action({ request }) {
  // Your code here
}

export default function Upload() {
  return (
    
      
      Upload
    
  );
}

Hint

Use request.formData() to get the file from upload. Use file.stream() and a reader to read chunks. Decode chunks to a string with TextDecoder.

4

Display the uploaded file content

Modify the default export component to accept a fileContent prop and display it inside a <pre> tag below the form. Also export a loader function that returns an empty string for fileContent initially.

Remix

export async function loader() {
  // Your code here
}

export default function Upload({ fileContent = '' }) {
  return (
    
      
        
        Upload
      
      {/* Your code here */}
    
  );
}

Hint

Export a loader that returns { fileContent: '' }. Update the component to accept fileContent prop and show it inside a <pre> tag below the form.

Practice

1. In Remix, which method is used to access uploaded files from a form submission?

easy

A. request.text()

B. request.json()

C. request.formData()

D. request.params()

Solution

1. Step 1: Understand how Remix handles form data

   Remix uses the request.formData() method to parse form submissions, including files.

2. Step 2: Identify the correct method for file uploads

   Files are included in form data, so request.formData() is the correct method to access them.

3. Final Answer:

   request.formData() -> Option C

4. Quick Check:

   File uploads use formData() = C [OK]

Hint: Files come from formData, not json or text [OK]

Common Mistakes:

• Using request.json() which is for JSON bodies
• Trying to get files from request.text()
• Assuming request.params() contains file data

2. Which of the following is the correct way to check if a form field contains a file in Remix?

easy

A. if (formData.get('file') === 'file')

B. if (formData.get('file') instanceof File)

C. if (typeof formData.get('file') === 'string')

D. if (formData.has('file'))

Solution

1. Step 1: Understand formData.get() returns

   The formData.get('file') returns the value of the field, which can be a File object for uploads.

2. Step 2: Check the type of the returned value

   To confirm it's a file, check if it is an instance of File using instanceof File.

3. Final Answer:

   if (formData.get('file') instanceof File) -> Option B

4. Quick Check:

   Check file type with instanceof File = B [OK]

Hint: Use instanceof File to detect uploaded files [OK]

Common Mistakes:

• Comparing to string 'file' instead of checking type
• Checking typeof as string which is incorrect for File objects
• Using formData.has() which only checks presence, not type

3. Given this Remix action code snippet, what will be logged if a user uploads a file named "photo.png"?

export async function action({ request }) {
  const formData = await request.formData();
  const file = formData.get('upload');
  console.log(file.name);
  return null;
}

medium

A. "photo.png"

B. "upload"

C. undefined

D. TypeError

Solution

1. Step 1: Extract file from formData

   The formData.get('upload') returns the uploaded File object with properties like name.

2. Step 2: Access the file name property

   Logging file.name outputs the original filename, which is "photo.png".

3. Final Answer:

   "photo.png" -> Option A

4. Quick Check:

   file.name logs filename = A [OK]

Hint: file.name holds the uploaded file's original name [OK]

Common Mistakes:

• Logging the form field name instead of file.name
• Assuming file is a string, causing undefined
• Not awaiting formData causing errors

4. What is wrong with this Remix action code for handling file uploads?

export async function action({ request }) {
  const formData = request.formData();
  const file = formData.get('file');
  if (file instanceof File) {
    // process file
  }
  return null;
}

medium

A. Missing await before request.formData()

B. Using 'file' instead of 'upload' as form field

C. Incorrect check for file type

D. No return statement in action

Solution

1. Step 1: Check for async formData call

   The request.formData() method returns a promise and must be awaited.

2. Step 2: Identify the missing await

   In the code, const formData = request.formData(); lacks await, so formData is a promise, not the data.

3. Final Answer:

   Missing await before request.formData() -> Option A

4. Quick Check:

   Always await formData() = A [OK]

Hint: Always await request.formData() to get data [OK]

Common Mistakes:

• Not awaiting request.formData() causing runtime errors
• Checking wrong form field name
• Incorrect instanceof check

5. You want to handle large file uploads efficiently in Remix by streaming the file data instead of loading it all at once. Which approach is best to implement this?

hard

A. Use request.formData() and read the entire file into memory

B. Use request.text() and split the file content manually

C. Use request.json() to parse the file as JSON stream

D. Use request.body.getReader() to stream the request body in chunks

Solution

1. Step 1: Understand streaming large uploads

   Loading large files fully into memory (like with formData) can cause performance issues.

2. Step 2: Use streaming APIs

   The request.body.getReader() method allows reading the request body in small chunks, enabling streaming.

3. Final Answer:

   Use request.body.getReader() to stream the request body in chunks -> Option D

4. Quick Check:

   Stream large files with getReader() = D [OK]

Hint: Stream large files with request.body.getReader() [OK]

Common Mistakes:

• Using formData() which loads entire file in memory
• Trying to parse file as JSON or text
• Manually splitting text which is inefficient