Appending to files in Node.js - Performance & Optimization

Performance: Appending to files

MEDIUM IMPACT

This affects how fast data is written to disk and how the Node.js event loop handles file I/O operations.

Appending data to a file in a Node.js application

Node.js

import { appendFile } from 'fs/promises';
const data = 'New log entry\n';
await appendFile('log.txt', data);

This uses asynchronous file appending, allowing other operations to run while writing to disk.

📈 Performance GainNon-blocking I/O keeps event loop free, improving app responsiveness

Appending data to a file in a Node.js application

Node.js

const fs = require('fs');
const data = 'New log entry\n';
fs.appendFileSync('log.txt', data);

This blocks the Node.js event loop until the file write completes, causing delays in handling other tasks.

📉 Performance CostBlocks event loop for the duration of file write, increasing response time

Performance Comparison

Pattern	DOM Operations	Reflows	Paint Cost	Verdict
Synchronous appendFileSync	N/A	N/A	N/A	[X] Bad
Asynchronous appendFile (Promise)	N/A	N/A	N/A	[OK] Good

Rendering Pipeline

Appending to files in Node.js does not affect browser rendering but impacts server responsiveness and throughput.

→Event Loop

→File System I/O

⚠️ BottleneckSynchronous file operations block the event loop, delaying other tasks.

Optimization Tips

1Avoid synchronous file operations in Node.js to prevent blocking the event loop.

2Use fs.promises.appendFile or callback-based fs.appendFile for non-blocking file writes.

3Batch multiple appends if possible to reduce the number of file system calls.

Performance Quiz - 3 Questions

What is the main performance drawback of using fs.appendFileSync in Node.js?

A It uses more memory than asynchronous methods.

B It blocks the event loop, delaying other operations.

C It causes the file to be corrupted.

D It increases network latency.

DevTools: Node.js Inspector (Debugger)

How to check: Run your Node.js app with --inspect flag, open Chrome DevTools, and record CPU profile while appending files synchronously and asynchronously.

What to look for: Look for blocking operations in the event loop timeline; synchronous file writes show long blocking periods.

Practice

1. What does appending to a file mean in Node.js?

easy

A. Adding new content to the end of the existing file without removing old content

B. Replacing the entire file content with new data

C. Deleting the file before writing new content

D. Reading the file content without changing it

Solution

1. Step 1: Understand the meaning of appending

   Appending means adding data to the end of existing content without deleting it.

2. Step 2: Compare with other file operations

   Replacing or deleting would remove old content, which is not appending.

3. Final Answer:

   Adding new content to the end of the existing file without removing old content -> Option A

4. Quick Check:

   Appending = add to end [OK]

Hint: Appending means add at the end, not replace [OK]

Common Mistakes:

• Confusing append with overwrite
• Thinking append deletes old content
• Mixing append with read operation

2. Which of these is the correct way to append text to a file using Node.js 'fs/promises' module?

easy

A. await fs.appendFile('file.txt', 'Hello World');

B. await fs.writeFile('file.txt', 'Hello World');

C. await fs.readFile('file.txt', 'Hello World');

D. await fs.deleteFile('file.txt', 'Hello World');

Solution

1. Step 1: Identify the correct method for appending

   The method to add content at the end is 'appendFile' in 'fs/promises'.

2. Step 2: Check the syntax

   Using 'await fs.appendFile(filename, data)' is the correct syntax.

3. Final Answer:

   await fs.appendFile('file.txt', 'Hello World'); -> Option A

4. Quick Check:

   appendFile appends text [OK]

Hint: Use appendFile, not writeFile, to add content [OK]

Common Mistakes:

• Using writeFile which overwrites
• Using readFile or deleteFile which don't append
• Forgetting to await the promise

3. What will be the content of 'log.txt' after running this code if 'log.txt' initially contains "Start\n"?

import { appendFile } from 'fs/promises';
await appendFile('log.txt', 'Entry1\n');
await appendFile('log.txt', 'Entry2');

medium

A. StartEntry1\nEntry2

B. Entry1\nEntry2

C. Start\nEntry1Entry2

D. Start\nEntry1\nEntry2

Solution

1. Step 1: Understand initial file content

   The file starts with "Start\n", so it ends with a newline.

2. Step 2: Analyze each append operation

   First append adds "Entry1\n" after existing content, second adds "Entry2" after that.

3. Step 3: Combine all content

   Resulting content is "Start\nEntry1\nEntry2" exactly as appended.

4. Final Answer:

   Start\nEntry1\nEntry2 -> Option D

5. Quick Check:

   Appending adds text at end preserving old content [OK]

Hint: Appending adds text exactly where called, watch newlines [OK]

Common Mistakes:

• Assuming append overwrites
• Ignoring newlines in appended text
• Thinking append removes initial content

4. Identify the error in this code snippet that tries to append text to a file:

import fs from 'fs/promises';
fs.appendFile('data.txt', 'New line');
console.log('Appended');

medium

A. Wrong method name, should be writeFile instead of appendFile

B. File path 'data.txt' is invalid without full path

C. Missing await before fs.appendFile causing asynchronous issue

D. Console.log should be inside a callback function

Solution

1. Step 1: Check usage of async function

   fs.appendFile returns a promise and should be awaited or handled.

2. Step 2: Identify missing await

   Without await, appendFile runs asynchronously and may not finish before console.log.

3. Final Answer:

   Missing await before fs.appendFile causing asynchronous issue -> Option C

4. Quick Check:

   Async fs calls need await or then [OK]

Hint: Always await async fs.promises methods [OK]

Common Mistakes:

• Forgetting await on async file operations
• Confusing appendFile with writeFile
• Assuming console.log waits for append

5. You want to append multiple log entries to a file, each on a new line, using Node.js 'fs/promises'. Which approach correctly ensures each entry is on its own line?

hard

A. Use readFile to read, then append entries in memory, then writeFile

B. Use appendFile with '\n' at the end of each entry string

C. Use appendFile without '\n' and rely on file system to add new lines

D. Use writeFile to overwrite file with all entries joined by '\n'

Solution

1. Step 1: Understand appending multiple entries

   Appending adds text exactly as given, so newlines must be included explicitly.

2. Step 2: Choose method to add new lines

   Adding '\n' at the end of each entry ensures each appears on its own line.

3. Step 3: Compare other options

   writeFile overwrites, appendFile without '\n' joins lines, readFile + writeFile is inefficient.

4. Final Answer:

   Use appendFile with '\n' at the end of each entry string -> Option B

5. Quick Check:

   Newline needed to separate appended lines [OK]

Hint: Add '\n' explicitly to each appended string [OK]

Common Mistakes:

• Forgetting to add newline characters
• Using writeFile which overwrites content
• Assuming file system adds newlines automatically