Merge pull request #639 from aryaemami59/v5-final-type-changes

reduxjs · Nov 21, 2023 · a39a97a · a39a97a
2 parents 6315862 + fda51ea
commit a39a97a
Show file tree

Hide file tree

Showing 29 changed files with 2,835 additions and 503 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,7 +12,7 @@ typescript_test/common.js
 flow_test/should_fail/flow-typed/index.js.flow
 flow_test/should_pass/flow-typed/index.js.flow
 reselect-builds/
-
+trace
 
 typesversions
 .cache
@@ -24,4 +24,4 @@ typesversions
 !.yarn/sdks
 !.yarn/versions
 .pnp.*
-*.tgz
+*.tgz
diff --git a/package.json b/package.json
@@ -27,9 +27,11 @@
     "format": "prettier --write \"{src,test}/**/*.{js,ts}\" \"docs/**/*.md\"",
     "lint": "eslint src test",
     "prepack": "yarn build",
-    "bench": "vitest --run bench",
+    "bench": "vitest --run bench --mode production",
     "test": "node --expose-gc ./node_modules/vitest/dist/cli-wrapper.js run",
     "test:cov": "vitest run --coverage",
+    "type-check": "vitest --run typecheck",
+    "type-check:trace": "vitest --run typecheck && tsc --noEmit -p typescript_test/tsconfig.json --generateTrace trace && npx @typescript/analyze-trace trace && rimraf trace",
     "test:typescript": "tsc --noEmit -p typescript_test/tsconfig.json"
   },
   "keywords": [
@@ -54,6 +56,7 @@
     "@typescript-eslint/eslint-plugin": "5.1.0",
     "@typescript-eslint/eslint-plugin-tslint": "5.1.0",
     "@typescript-eslint/parser": "5.1.0",
+    "@typescript/analyze-trace": "^0.10.1",
     "eslint": "^8.0.1",
     "eslint-plugin-react": "^7.26.1",
     "eslint-plugin-typescript": "0.14.0",

diff --git a/src/autotrackMemoize/autotrackMemoize.ts b/src/autotrackMemoize/autotrackMemoize.ts
@@ -5,7 +5,11 @@ import {
   createCacheKeyComparator,
   defaultEqualityCheck
 } from '@internal/defaultMemoize'
-import type { AnyFunction } from '@internal/types'
+import type {
+  AnyFunction,
+  DefaultMemoizeFields,
+  Simplify
+} from '@internal/types'
 import { createCache } from './autotracking'
 
 /**
@@ -55,7 +59,7 @@ import { createCache } from './autotracking'
  * ```ts
  * import { unstable_autotrackMemoize as autotrackMemoize, createSelectorCreator } from 'reselect'
  *
- * const createSelectorAutotrack = createSelectorCreator(autotrackMemoize)
+ * const createSelectorAutotrack = createSelectorCreator({ memoize: autotrackMemoize })
  *
  * const selectTodoIds = createSelectorAutotrack(
  *   [(state: RootState) => state.todos],
@@ -95,7 +99,9 @@ export function autotrackMemoize<Func extends AnyFunction>(func: Func) {
     return cache.value
   }
 
-  memoized.clearCache = () => cache.clear()
+  memoized.clearCache = () => {
+    return cache.clear()
+  }
 
-  return memoized as Func & { clearCache: () => void }
+  return memoized as Func & Simplify<DefaultMemoizeFields>
 }
diff --git a/src/createSelectorCreator.ts b/src/createSelectorCreator.ts
@@ -1,4 +1,3 @@
-import type { OutputSelector, Selector, SelectorArray } from 'reselect'
 import { defaultMemoize } from './defaultMemoize'
 
 import type {
@@ -9,6 +8,11 @@ import type {
   GetParamsFromSelectors,
   GetStateFromSelectors,
   InterruptRecursion,
+  OutputSelector,
+  Selector,
+  SelectorArray,
+  SetRequired,
+  Simplify,
   StabilityCheckFrequency,
   UnknownMemoizer
 } from './types'
@@ -82,7 +86,7 @@ export interface CreateSelectorFunction<
     ...createSelectorArgs: [
       ...inputSelectors: InputSelectors,
       combiner: Combiner<InputSelectors, Result>,
-      createSelectorOptions: Partial<
+      createSelectorOptions: Simplify<
         CreateSelectorOptions<
           MemoizeFunction,
           ArgsMemoizeFunction,
@@ -122,7 +126,7 @@ export interface CreateSelectorFunction<
   >(
     inputSelectors: [...InputSelectors],
     combiner: Combiner<InputSelectors, Result>,
-    createSelectorOptions?: Partial<
+    createSelectorOptions?: Simplify<
       CreateSelectorOptions<
         MemoizeFunction,
         ArgsMemoizeFunction,
@@ -220,11 +224,16 @@ export function createSelectorCreator<
   MemoizeFunction extends UnknownMemoizer,
   ArgsMemoizeFunction extends UnknownMemoizer = typeof defaultMemoize
 >(
-  options: CreateSelectorOptions<
-    typeof defaultMemoize,
-    typeof defaultMemoize,
-    MemoizeFunction,
-    ArgsMemoizeFunction
+  options: Simplify<
+    SetRequired<
+      CreateSelectorOptions<
+        typeof defaultMemoize,
+        typeof defaultMemoize,
+        MemoizeFunction,
+        ArgsMemoizeFunction
+      >,
+      'memoize'
+    >
   >
 ): CreateSelectorFunction<MemoizeFunction, ArgsMemoizeFunction>
 
@@ -276,27 +285,29 @@ export function createSelectorCreator<
   ArgsMemoizeFunction extends UnknownMemoizer,
   MemoizeOrOptions extends
     | MemoizeFunction
-    | CreateSelectorOptions<MemoizeFunction, ArgsMemoizeFunction>
+    | SetRequired<
+        CreateSelectorOptions<MemoizeFunction, ArgsMemoizeFunction>,
+        'memoize'
+      >
 >(
   memoizeOrOptions: MemoizeOrOptions,
-  ...memoizeOptionsFromArgs: MemoizeOrOptions extends CreateSelectorOptions<
-    MemoizeFunction,
-    ArgsMemoizeFunction
+  ...memoizeOptionsFromArgs: MemoizeOrOptions extends SetRequired<
+    CreateSelectorOptions<MemoizeFunction, ArgsMemoizeFunction>,
+    'memoize'
   >
     ? never
     : DropFirstParameter<MemoizeFunction>
 ) {
   /** options initially passed into `createSelectorCreator`. */
-  const createSelectorCreatorOptions: CreateSelectorOptions<
-    MemoizeFunction,
-    ArgsMemoizeFunction
-  > =
-    typeof memoizeOrOptions === 'function'
-      ? {
-          memoize: memoizeOrOptions as MemoizeFunction,
-          memoizeOptions: memoizeOptionsFromArgs
-        }
-      : memoizeOrOptions
+  const createSelectorCreatorOptions: SetRequired<
+    CreateSelectorOptions<MemoizeFunction, ArgsMemoizeFunction>,
+    'memoize'
+  > = typeof memoizeOrOptions === 'function'
+    ? {
+        memoize: memoizeOrOptions as MemoizeFunction,
+        memoizeOptions: memoizeOptionsFromArgs
+      }
+    : memoizeOrOptions
 
   const createSelector = <
     InputSelectors extends SelectorArray,
@@ -307,41 +318,36 @@ export function createSelectorCreator<
     ...createSelectorArgs: [
       ...inputSelectors: [...InputSelectors],
       combiner: Combiner<InputSelectors, Result>,
-      createSelectorOptions?: Partial<
-        CreateSelectorOptions<
-          MemoizeFunction,
-          ArgsMemoizeFunction,
-          OverrideMemoizeFunction,
-          OverrideArgsMemoizeFunction
-        >
+      createSelectorOptions?: CreateSelectorOptions<
+        MemoizeFunction,
+        ArgsMemoizeFunction,
+        OverrideMemoizeFunction,
+        OverrideArgsMemoizeFunction
       >
     ]
   ) => {
     let recomputations = 0
+    let dependencyRecomputations = 0
     let lastResult: Result
 
-    // Due to the intricacies of rest params, we can't do an optional arg after `...funcs`.
+    // Due to the intricacies of rest params, we can't do an optional arg after `...createSelectorArgs`.
     // So, start by declaring the default value here.
     // (And yes, the words 'memoize' and 'options' appear too many times in this next sequence.)
-    let directlyPassedOptions: Partial<
-      CreateSelectorOptions<
-        MemoizeFunction,
-        ArgsMemoizeFunction,
-        OverrideMemoizeFunction,
-        OverrideArgsMemoizeFunction
-      >
+    let directlyPassedOptions: CreateSelectorOptions<
+      MemoizeFunction,
+      ArgsMemoizeFunction,
+      OverrideMemoizeFunction,
+      OverrideArgsMemoizeFunction
     > = {}
 
     // Normally, the result func or "combiner" is the last arg
     let resultFunc = createSelectorArgs.pop() as
       | Combiner<InputSelectors, Result>
-      | Partial<
-          CreateSelectorOptions<
-            MemoizeFunction,
-            ArgsMemoizeFunction,
-            OverrideMemoizeFunction,
-            OverrideArgsMemoizeFunction
-          >
+      | CreateSelectorOptions<
+          MemoizeFunction,
+          ArgsMemoizeFunction,
+          OverrideMemoizeFunction,
+          OverrideArgsMemoizeFunction
         >
 
     // If the result func is actually an _object_, assume it's our options object
@@ -395,6 +401,7 @@ export function createSelectorCreator<
 
     // If a selector is called with the exact same arguments we don't need to traverse our dependencies again.
     const selector = argsMemoize(function dependenciesChecker() {
+      dependencyRecomputations++
       /** Return values of input selectors which the `resultFunc` takes as arguments. */
       const inputSelectorResults = collectInputSelectorResults(
         dependencies,
@@ -436,6 +443,8 @@ export function createSelectorCreator<
       resultFunc,
       memoizedResultFunc,
       dependencies,
+      dependencyRecomputations: () => dependencyRecomputations,
+      resetDependencyRecomputations: () => (dependencyRecomputations = 0),
       lastResult: () => lastResult,
       recomputations: () => recomputations,
       resetRecomputations: () => (recomputations = 0),