Benchmark: Immer vs cloneDeep

HTML Preparation code:

<script src="https://cdn.jsdelivr.net/npm/immer@3.1.3/dist/immer.umd.min.js"></script>
<script src='https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.5/lodash.min.js'></script>
<script src="https://cdn.jsdelivr.net/npm/uuid@8.3.2/dist/umd/uuidv4.min.js"></script>

Script Preparation code:

state = {
    "id": "2206513",
    "type": "HOME_BLADDER_DIARY",
    "status": "STARTED",
    "cycles": [
        {
            "id": "2206514",
            "index": 1,
            "number": 1,
            "status": "COMPLETED",
            "eventIds": [
                "2206517",
                "2206533",
                "2206525"
            ],
            "patientEvaluation": "COMPLETE",
            "startDate": "2023-11-13T15:03:55.312+01:00",
            "finished": false
        },
        {
            "id": "2206515",
            "index": 2,
            "number": 2,
            "status": "STARTED",
            "eventIds": [
                "2206544",
                "2206547",
                "2206599",
                "2206550",
                "2206553",
                "2206541",
                "2206556",
                "2206559",
                "2206607"
            ],
            "patientEvaluation": null,
            "startDate": "2023-11-15T09:36:28.470Z",
            "finished": false
        }
    ],
    "medicalReason": null,
    "medication": null,
    "notes": null,
    "management": null,
    "amountOfFlows": null,
    "patientNotes": null,
    "usualWakeTime": "07:00",
    "usualSleepTime": "23:00",
    "catheterization": "NEVER",
    "amountOfCycles": 2,
    "volumeHidden": false,
    "forceConsecutiveCycles": true
}

Tests:

Immer
const result = immer.produce(state, draft => { draft.cycles[0].completed = 'POTATO' })
cloneDeep
const result = _.cloneDeep(state); result.cycles[0].completed = 'POTATO';

Rendered benchmark preparation results:

Suite status: <idle, ready to run>

Previous results

Test case name	Result
Immer
cloneDeep

Fastest: N/A

Slowest: N/A

Latest run results:

No previous run results

This benchmark does not have any results yet. Be the first one to run it!

Autogenerated LLM Summary (model llama3.2:3b, generated one year ago):

LLMs can make mistakes. Check important info.

Let's break down the provided JSON and explain what's being tested, the options compared, their pros and cons, and other considerations.

**Benchmark Definition**

The benchmark is designed to compare two methods of modifying an object: using `immer.produce` and `lodash.cloneDeep`.

**Immer vs CloneDeep Benchmark**

In this benchmark, we have two individual test cases:

1. **Immer**: The benchmark definition uses the `immer.produce` function from the Immer library to create a new copy of the original state object (`state`) with a modified `completed` property for the first cycle in the cycles array.
2. **cloneDeep**: The benchmark definition uses the `_.cloneDeep` function from Lodash to create a deep clone of the original `state` object, and then modifies the `completed` property of the first cycle.

**Options Compared**

The two options being compared are:

1. **Immer**: Immer is a library that provides a functional programming approach to working with immutable data structures. It creates a new copy of the original data structure when using `produce`.
2. **CloneDeep**: CloneDeep is a utility function from Lodash that creates a deep clone of an object.

**Pros and Cons**

Here are some pros and cons of each approach:

* **Immer**:
	+ Pros:
		- Immer provides a functional programming approach, which can be more predictable and easier to reason about.
		- It creates a new copy of the original data structure, which ensures immutability.
	+ Cons:
		- Creating a new copy of the entire object might not be necessary if only one property needs to be modified.
* **CloneDeep**:
	+ Pros:
		- CloneDeep is generally faster than creating a new copy with Immer.
		- It's a simple and lightweight solution that doesn't require any additional library dependencies.
	+ Cons:
		- CloneDeep creates a shallow clone of the object, which might not be suitable for complex data structures.
		- It modifies the original object, which can lead to unintended side effects if not carefully managed.

**Other Considerations**

When choosing between Immer and CloneDeep, consider the following factors:

* **Immutability**: If immutability is essential for your use case, Immer might be a better choice.
* **Performance**: If performance is critical, CloneDeep might be a faster option.
* **Data complexity**: If working with complex data structures, Immer's approach might be more suitable due to its ability to create new copies of entire objects.

**Library and Syntax**

In this benchmark, we're using the following libraries:

1. **Immer**: The Immer library provides a functional programming approach to working with immutable data structures.
2. **Lodash**: Lodash is a utility library that provides various functions for tasks such as cloning objects.

The syntax used in the benchmark definition is JavaScript and uses ES6+ features.

**Alternative Approaches**

If you're looking for alternative approaches, consider:

1. **Spread Operator**: You can use the spread operator (`{...state}`) to create a new copy of an object.
2. **Object.assign()**: This method creates a shallow copy of an object.
3. **Factory functions**: You can define factory functions that return new copies of objects or arrays.

These alternatives might not provide the same level of immutability and predictability as Immer, but they can be useful in certain situations.

Related benchmarks:

Immer vs cloneDeep (version: 0)

Comparing performance of: Immer vs cloneDeep

Created: 2 years ago by: Guest

Jump to the latest result

Immer

cloneDeep

Suite status: <idle, ready to run>

Fastest: N/A

Slowest: N/A

No previous run results

Autogenerated LLM Summary (model llama3.2:3b, generated one year ago):