Merge branch 'master' into pr/riqts/4263

Author: EskiMojo14

.github/workflows/publish.yml

@@ -22,7 +22,7 @@ jobs:
       contents: read
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: '20.x'
           registry-url: 'https://registry.npmjs.org'

.github/workflows/test-codegen.yml

@@ -16,12 +16,13 @@ jobs:
       codegen: ${{ steps.filter.outputs.codegen }}
     steps:
       - uses: actions/checkout@v4
-      - uses: dorny/paths-filter@v2
+      - uses: dorny/paths-filter@v3
         id: filter
         with:
           filters: |
             codegen:
               - 'packages/rtk-query-codegen-openapi/**'
+              - 'yarn.lock'
 
   build:
     needs: changes
@@ -36,7 +37,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
           cache: 'yarn'

.github/workflows/tests.yml

@@ -12,14 +12,15 @@ jobs:
       toolkit: ${{ steps.filter.outputs.toolkit }}
     steps:
       - uses: actions/checkout@v4
-      - uses: dorny/paths-filter@v2
+      - uses: dorny/paths-filter@v3
         id: filter
         with:
           filters: |
             toolkit:
               - 'packages/toolkit/**'
               - 'examples/publish-ci/**'
               - '.github/workflows/tests.yml'
+              - 'yarn.lock'
 
   build:
     needs: changes
@@ -37,7 +38,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Use node ${{ matrix.node }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
           cache: 'yarn'
@@ -55,7 +56,7 @@ jobs:
       - name: Pack
         run: yarn pack
 
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v4
         with:
           name: package
           path: packages/toolkit/package.tgz
@@ -73,15 +74,15 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Use node ${{ matrix.node }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
           cache: 'yarn'
 
       - name: Install deps
         run: yarn install
 
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4
         with:
           name: package
           path: packages/toolkit
@@ -111,7 +112,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Use node ${{ matrix.node }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
           cache: 'yarn'
@@ -122,7 +123,7 @@ jobs:
       - name: Install TypeScript ${{ matrix.ts }}
         run: yarn add typescript@${{ matrix.ts }}
 
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4
         with:
           name: package
           path: packages/toolkit
@@ -164,13 +165,13 @@ jobs:
       run:
         working-directory: ./examples/publish-ci/${{ matrix.example }}
     env:
-      YARN_ENABLE_IMMUTABLE_INSTALLS: 'false'
+      YARN_ENABLE_IMMUTABLE_INSTALLS: false
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
 
       - name: Use node ${{ matrix.node }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
           cache: 'yarn'
@@ -181,7 +182,7 @@ jobs:
       - name: Remove existing RTK
         run: yarn remove @reduxjs/toolkit
 
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4
         with:
           name: package
           path: ./examples/publish-ci/${{ matrix.example }}
@@ -197,13 +198,15 @@ jobs:
 
       - name: Set up JDK 17 for React Native build
         if: matrix.example == 'react-native' || matrix.example == 'expo'
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v4
         with:
           java-version: '17.x'
           distribution: 'temurin'
 
       - name: Build example
-        run: NODE_OPTIONS=--openssl-legacy-provider yarn build
+        env:
+          NODE_OPTIONS: --openssl-legacy-provider
+        run: yarn build
 
       - name: Run test step
         run: yarn test
@@ -222,15 +225,15 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Use node ${{ matrix.node }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
           cache: 'yarn'
 
       - name: Install deps
         run: yarn install
 
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4
         with:
           name: package
           path: packages/toolkit

docs/api/autoBatchEnhancer.mdx

@@ -99,7 +99,7 @@ Any action that is tagged with `action.meta[SHOULD_AUTOBATCH] = true` will be tr
 
 - `{type: 'raf'}`: queues using `requestAnimationFrame` (default)
 - `{type: 'tick'}`: queues using `queueMicrotask`
-- `{type: 'timer, timeout: number}`: queues using `setTimeout`
+- `{type: 'timer', timeout: number}`: queues using `setTimeout`
 - `{type: 'callback', queueNotification: (notify: () => void) => void}`: lets you provide your own callback, such as a debounced or throttled function
 
 The default behavior is to queue the notifications using `requestAnimationFrame`.

docs/rtk-query/internal/buildMiddleware/invalidationByTags.mdx

@@ -0,0 +1,123 @@
+# invalidationByTags
+
+## Overview
+
+`InvalidationByTagsHandler` is a handler instantiated during the (BuildMiddleware) step of the build. The handler acts as a (Middleware) and executes each step in response to matching of internal asyncThunk actions.
+
+The matchers used for a "invalidation sequence" are these two cases:
+
+```ts no-transpile
+const isThunkActionWithTags = isAnyOf(
+  isFulfilled(mutationThunk),
+  isRejectedWithValue(mutationThunk),
+)
+
+const isQueryEnd = isAnyOf(
+  isFulfilled(mutationThunk, queryThunk),
+  isRejected(mutationThunk, queryThunk),
+)
+```
+
+## Triggers
+
+The handler has 3 core conditionals that trigger a sequence:
+
+_Conditional 1 AND 3 are identical in process except the tags are calculated from the payload rather than from the action and endpointDefinition_
+
+1. Mutation trigger
+2. Query trigger
+3. Manual invalidation via `api.util.invalidateTags` trigger
+
+```ts no-transpile
+const handler: ApiMiddlewareInternalHandler = (action, mwApi) => {
+  if (isThunkActionWithTags(action)) {
+    invalidateTags(
+      calculateProvidedByThunk(
+        action,
+        'invalidatesTags',
+        endpointDefinitions,
+        assertTagType,
+      ),
+      mwApi,
+    )
+  } else if (isQueryEnd(action)) {
+    invalidateTags([], mwApi)
+  } else if (api.util.invalidateTags.match(action)) {
+    invalidateTags(
+      calculateProvidedBy(
+        action.payload,
+        undefined,
+        undefined,
+        undefined,
+        undefined,
+        assertTagType,
+      ),
+      mwApi,
+    )
+  }
+}
+```
+
+## Core Sequence
+
+1. `invalidateTags()` initiates:
+   1. invalidateTags function is called with a list of tags generated from the action metadata
+   2. in the case of a [queryThunk] resolution an empty set of tags is always provided
+2. The tags calculated are added to the list of pending tags to invalidate (see [delayed](#Delayed))
+3. (optional: 'Delayed') the invalidateTags function is ended if the `apiSlice.invalidationBehaviour` is set to "delayed" and there are any pending thunks/queries running in that `apiSlice`
+4. Pending tags are reset to an empty list, if there are no tags the function ends here
+5. Selects all `{ endpointName, originalArgs, queryCacheKey }` combinations that would be invalidated by a specific set of tags.
+6. Iterates through queryCacheKeys selected and performs one of two actions if the query exists\*
+   1. removes cached query result - via the `removeQueryResult` action - if no subscription is active
+   2. if the query is "uninitialized" it initiates a `refetchQuery` action
+
+```js no-transpile
+const toInvalidate = api.util.selectInvalidatedBy(rootState, tags)
+context.batch(() => {
+  const valuesArray = Array.from(toInvalidate.values())
+  for (const { queryCacheKey } of valuesArray) {
+    const querySubState = state.queries[queryCacheKey]
+    const subscriptionSubState =
+      internalState.currentSubscriptions[queryCacheKey] ?? {}
+    if (querySubState) {
+      if (countObjectKeys(subscriptionSubState) === 0) {
+        mwApi.dispatch(
+          removeQueryResult({
+            queryCacheKey,
+          }),
+        )
+      } else if (querySubState.status !== 'uninitialized' /* uninitialized */) {
+        mwApi.dispatch(refetchQuery(querySubState, queryCacheKey))
+      }
+    }
+  }
+})
+```
+
+:::note
+Step 6 is performed within a `context.batch()` call.
+:::
+
+### Delayed
+
+RTKQ now has internal logic to delay tag invalidation briefly, to allow multiple invalidations to get handled together. This is controlled by a new `invalidationBehavior: 'immediate' | 'delayed'` flag on `createApi`. The new default behavior is `'delayed'`. Set it to `'immediate'` to revert to the behavior in RTK 1.9.
+
+The `'delayed'` behaviour enables a check inside `invalidationByTags` that will cause any invalidation that is triggered while a query/mutation is still pending to batch the invalidation until no query/mutation is running.
+
+```ts no-transpile
+function invalidateTags(
+  newTags: readonly FullTagDescription<string>[],
+  mwApi: SubMiddlewareApi,
+) {
+  const rootState = mwApi.getState()
+  const state = rootState[reducerPath]
+
+  pendingTagInvalidations.push(...newTags)
+
+  if (
+    state.config.invalidationBehavior === 'delayed' &&
+    hasPendingRequests(state)
+  ) {
+    return
+  }
+```