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

Use a Map for createTransformer memoization #331

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
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
42 changes: 21 additions & 21 deletions src/create-transformer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {
_isComputingDerivation,
IComputedValueOptions,
} from "mobx"
import { invariant, addHiddenProp } from "./utils"
import { invariant } from "./utils"

export type ITransformer<A, B> = (object: A) => B

Expand All @@ -15,8 +15,6 @@ export type ITransformerParams<A, B> = {
keepAlive?: boolean
} & Omit<IComputedValueOptions<B>, "name">

let memoizationId = 0

export function createTransformer<A, B>(
transformer: ITransformer<A, B>,
onCleanup?: (resultObject: B | undefined, sourceObject?: A) => void
Expand All @@ -43,8 +41,8 @@ export function createTransformer<A, B>(
"createTransformer expects a function that accepts one argument"
)

// Memoizes: object id -> reactive view that applies transformer to the object
let views: { [id: number]: IComputedValue<B> } = {}
// Memoizes: object -> reactive view that applies transformer to the object
const views = new Map<A, IComputedValue<B>>()
let onCleanup: Function | undefined = undefined
let keepAlive: boolean = false
let debugNameGenerator: Function | undefined = undefined
Expand All @@ -56,7 +54,7 @@ export function createTransformer<A, B>(
onCleanup = arg2
}

function createView(sourceIdentifier: number, sourceObject: A) {
function createView(sourceObject: A) {
let latestValue: B
let computedValueOptions = {}
if (typeof arg2 === "object") {
Expand All @@ -69,9 +67,12 @@ export function createTransformer<A, B>(
onCleanup = undefined
debugNameGenerator = undefined
}
const sourceType = typeof sourceObject
const prettifiedName = debugNameGenerator
? debugNameGenerator(sourceObject)
: `Transformer-${(<any>transformer).name}-${sourceIdentifier}`
: `Transformer-${(<any>transformer).name}-${
sourceType === "string" || sourceType === "number" ? sourceObject : "object"
}`
const expr = computed(
() => {
return (latestValue = transformer(sourceObject))
Expand All @@ -83,7 +84,7 @@ export function createTransformer<A, B>(
)
if (!keepAlive) {
const disposer = onBecomeUnobserved(expr, () => {
delete views[sourceIdentifier]
views.delete(sourceObject)
disposer()
if (onCleanup) onCleanup(latestValue, sourceObject)
})
Expand All @@ -93,8 +94,8 @@ export function createTransformer<A, B>(

let memoWarned = false
return (object: A) => {
const identifier = getMemoizationId(object)
let reactiveView = views[identifier]
checkTransformableObject(object)
let reactiveView = views.get(object)
if (reactiveView) return reactiveView.get()
if (!keepAlive && !_isComputingDerivation()) {
if (!memoWarned) {
Expand All @@ -109,25 +110,24 @@ export function createTransformer<A, B>(
return value
}
// Not in cache; create a reactive view
reactiveView = views[identifier] = createView(identifier, object)
reactiveView = createView(object)
views.set(object, reactiveView)
return reactiveView.get()
}
}

function getMemoizationId(object: any) {
function checkTransformableObject(object: any) {
const objectType = typeof object
if (objectType === "string") return `string:${object}`
if (objectType === "number") return `number:${object}`
if (object === null || (objectType !== "object" && objectType !== "function"))
if (
object === null ||
(objectType !== "object" &&
objectType !== "function" &&
objectType !== "string" &&
objectType !== "number")
)
throw new Error(
`[mobx-utils] transform expected an object, function, string or number, got: ${String(
object
)}`
)
let tid = object.$transformId
if (tid === undefined) {
tid = `memoizationId:${++memoizationId}`
addHiddenProp(object, "$transformId", tid)
}
return tid
}
4 changes: 2 additions & 2 deletions test/create-transformer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@ test("transform1", () => {
"name": "[email protected][..].title",
"observers": Array [
Object {
"name": "Transformer--memoizationId:3",
"name": "Transformer--object",
"observers": Array [
Object {
"name": "Transformer--memoizationId:1",
"name": "Transformer--object",
"observers": Array [
Object {
"name": "Autorun@2",
Expand Down