Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(tests): refactor memory leak tests and add some more tests #2497

Merged
merged 5 commits into from
Apr 16, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 80 additions & 9 deletions tests/vanilla/memoryleaks.test.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,85 @@
import LeakDetector from 'jest-leak-detector'
import { expect, it } from 'vitest'
import { describe, expect, it } from 'vitest'
import { atom, createStore } from 'jotai/vanilla'
import type { Atom, PrimitiveAtom } from 'jotai/vanilla'

it('should not have memory leaks with an atom', async () => {
const store = createStore()
let detector: LeakDetector
;(() => {
describe('test memory leaks (get & set only)', () => {
it('one atom', async () => {
const store = createStore()
let objAtom: PrimitiveAtom<object> | undefined = atom({})
const detector = new LeakDetector(store.get(objAtom))
objAtom = undefined
expect(await detector.isLeaking()).toBe(false)
})

it('two atoms', async () => {
const store = createStore()
let objAtom: PrimitiveAtom<object> | undefined = atom({})
const detector1 = new LeakDetector(store.get(objAtom))
let derivedAtom: Atom<object> | undefined = atom((get) => ({
obj: objAtom && get(objAtom),
}))
const detector2 = new LeakDetector(store.get(derivedAtom))
objAtom = undefined
derivedAtom = undefined
expect(await detector1.isLeaking()).toBe(false)
expect(await detector2.isLeaking()).toBe(false)
})

// TODO we will revisit this
it.skip('with a long-lived base atom', async () => {
const store = createStore()
const objAtom = atom({})
let derivedAtom: Atom<object> | undefined = atom((get) => ({
obj: get(objAtom),
}))
const detector = new LeakDetector(store.get(derivedAtom))
derivedAtom = undefined
expect(await detector.isLeaking()).toBe(false)
})
})

describe('test memory leaks (with subscribe)', () => {
it('one atom', async () => {
const store = createStore()
let objAtom: PrimitiveAtom<object> | undefined = atom({})
const detector = new LeakDetector(store.get(objAtom))
let unsub: (() => void) | undefined = store.sub(objAtom, () => {})
unsub()
unsub = undefined
objAtom = undefined
expect(await detector.isLeaking()).toBe(false)
})

it('two atoms', async () => {
const store = createStore()
let objAtom: PrimitiveAtom<object> | undefined = atom({})
const detector1 = new LeakDetector(store.get(objAtom))
let derivedAtom: Atom<object> | undefined = atom((get) => ({
obj: objAtom && get(objAtom),
}))
const detector2 = new LeakDetector(store.get(derivedAtom))
let unsub: (() => void) | undefined = store.sub(objAtom, () => {})
unsub()
unsub = undefined
objAtom = undefined
derivedAtom = undefined
expect(await detector1.isLeaking()).toBe(false)
expect(await detector2.isLeaking()).toBe(false)
})

// TODO we will revisit this
it.skip('with a long-lived base atom', async () => {
const store = createStore()
const objAtom = atom({})
detector = new LeakDetector(store.get(objAtom))
})()
const isLeaking = await detector.isLeaking()
expect(isLeaking).toBe(false)
let derivedAtom: Atom<object> | undefined = atom((get) => ({
obj: get(objAtom),
}))
const detector = new LeakDetector(store.get(derivedAtom))
let unsub: (() => void) | undefined = store.sub(objAtom, () => {})
unsub()
unsub = undefined
derivedAtom = undefined
expect(await detector.isLeaking()).toBe(false)
})
})
Loading