Enable strict mode in tsconfig and fix type errors #11200

jerelmiller · 2023-09-07T17:19:47Z

Enables strict mode in our tsconfig.json and ensures our types/code are updated to handle the failures that arise from this change.

Checklist:

If this PR contains changes to the library itself (not necessary for e.g. docs updates), please include a changeset (see CONTRIBUTING.md)
If this PR is a new feature, please reference an issue where a consensus about the design was reached (not necessary for small changes)
Make sure all of the significant new logic is covered by tests

changeset-bot · 2023-09-07T17:19:51Z

🦋 Changeset detected

Latest commit: 94b07f9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@apollo/client	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

jerelmiller · 2023-09-07T17:20:40Z

src/utilities/common/filterInPlace.ts

@@ -1,14 +0,0 @@
-export function filterInPlace<T>(


This file isn't used anywhere, nor is it exported. Hooray for removing unused code 🎉

github-actions · 2023-09-13T12:21:21Z

size-limit report 📦

Path	Size
dist/apollo-client.min.cjs	37.08 KB (+0.01% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs"	43.51 KB (-0.07% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production)	42.01 KB (-0.04% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js"	32.61 KB (+0.03% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production)	31.27 KB (+0.01% 🔺)
import { ApolloProvider } from "dist/react/index.js"	1.22 KB (0%)
import { ApolloProvider } from "dist/react/index.js" (production)	1.21 KB (0%)
import { useQuery } from "dist/react/index.js"	4.28 KB (0%)
import { useQuery } from "dist/react/index.js" (production)	4.1 KB (0%)
import { useLazyQuery } from "dist/react/index.js"	4.59 KB (0%)
import { useLazyQuery } from "dist/react/index.js" (production)	4.41 KB (0%)
import { useMutation } from "dist/react/index.js"	2.55 KB (0%)
import { useMutation } from "dist/react/index.js" (production)	2.54 KB (0%)
import { useSubscription } from "dist/react/index.js"	2.24 KB (0%)
import { useSubscription } from "dist/react/index.js" (production)	2.2 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js"	4.62 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" (production)	4.05 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js"	4.14 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" (production)	3.56 KB (0%)
import { useReadQuery } from "dist/react/index.js"	3 KB (0%)
import { useReadQuery } from "dist/react/index.js" (production)	2.94 KB (0%)
import { useFragment } from "dist/react/index.js"	2.09 KB (0%)
import { useFragment } from "dist/react/index.js" (production)	2.04 KB (0%)

phryneas · 2023-09-13T12:33:24Z

src/cache/inmemory/fragmentRegistry.ts

  // FragmentRegistry constructor directly. This reserves the constructor for
  // future configuration of the FragmentRegistry.
  constructor(...fragments: DocumentNode[]) {
    this.resetCaches();
    if (fragments.length) {
-      this.register.apply(this, fragments);
+      this.register(...fragments);


This transpiles to the old code, but if we switch to a newer target we save a few bytes.

phryneas · 2023-09-13T12:34:48Z

src/cache/inmemory/entityStore.ts

@@ -778,20 +782,20 @@ class Stump extends Layer {
    return this;
  }

-  public merge() {
+  public merge(older: string | StoreObject, newer: string | StoreObject) {


This minifies even shorter than the old code.

phryneas · 2023-09-13T12:36:40Z

src/cache/inmemory/fragmentRegistry.ts

+  public register(...fragments: DocumentNode[]): this {
    const definitions = new Map<string, FragmentDefinitionNode>();
-    arrayLikeForEach.call(arguments, (doc: DocumentNode) => {
+    fragments.forEach((doc: DocumentNode) => {


2384d2383 < var arrayLikeForEach = Array.prototype.forEach; 2398a2398,2401 > var fragments = []; > for (var _i = 0; _i < arguments.length; _i++) { > fragments[_i] = arguments[_i]; > } 2400c2403 < arrayLikeForEach.call(arguments, function (doc) { --- > fragments.forEach(function (doc) {

This transpiles slightly longer, are we okay with that?

I'm ok with it.

phryneas · 2023-09-13T12:37:57Z

src/cache/inmemory/inMemoryCache.ts

+  private data!: EntityStore;
+  private optimisticData!: EntityStore;

  protected config: InMemoryCacheConfig;
  private watches = new Set<Cache.WatchOptions>();
  private addTypename: boolean;

-  private storeReader: StoreReader;
-  private storeWriter: StoreWriter;
+  private storeReader!: StoreReader;
+  private storeWriter!: StoreWriter;
  private addTypenameTransform = new DocumentTransform(addTypenameToDocument);

-  private maybeBroadcastWatch: OptimisticWrapperFunction<
+  private maybeBroadcastWatch!: OptimisticWrapperFunction<


All of these are set in functions that are directly called from the constructor.

src/core/ApolloClient.ts

phryneas · 2023-09-13T12:43:06Z

src/core/QueryInfo.ts

@@ -113,7 +114,7 @@ export class QueryInfo {
    // NetworkStatus.loading, but also possibly fetchMore, poll, refetch,
    // or setVariables.
    networkStatus?: NetworkStatus;
-    observableQuery?: ObservableQuery<any>;
+    observableQuery?: ObservableQuery<any, any>;


We are generally very inconsistent with the extends OperationVariables on TVariables, and I have to say I'm not too happy with OperationVariables, as it works with type-declared types, but not with interfaces (as those don't have an implicit index signature).
We might want to look into that - but not in this PR.

phryneas · 2023-09-13T12:56:26Z

src/core/QueryManager.ts

@@ -526,7 +530,7 @@ export class QueryManager<TStore> {
            // either a SingleExecutionResult or the final ExecutionPatchResult,
            // call the update function.
            if (isFinalResult) {
-              update(cache, result, {
+              update(cache as TCache, result, {


the TCache generic argument here is essentially an any-cast. I'm not super happy about that, but on the other hand, realistically all the generic arguments on markMutationResult are any-casts

phryneas · 2023-09-13T13:24:21Z

src/link/http/HttpLink.ts

 export class HttpLink extends ApolloLink {
-  public requester: RequestHandler;
  constructor(public options: HttpOptions = {}) {


requester appears in the whole code base only here and it doesn't seem to be set or read anywhere - it's also not there at runtime. I guess this can be removed?

phryneas · 2023-09-13T13:24:49Z

src/react/hoc/mutation-hoc.tsx

@@ -86,6 +86,7 @@ export function withMutation<

        return (
          <Mutation ignoreResults {...opts} mutation={document}>
+            {/* @ts-expect-error */}


not gonna fix types in the old HOCs...

phryneas · 2023-09-13T13:26:59Z

src/react/hooks/useMutation.ts

+            onError(
+              error,
+              clientOptions as MutationOptions<TData, OperationVariables>
+            );


We might want to look closer into these, but for now I'm just casting them around..

phryneas · 2023-09-13T13:52:52Z

This is ready for review now.

phryneas · 2023-09-13T16:19:17Z

src/utilities/common/__tests__/mergeDeep.ts

@@ -146,7 +146,7 @@ describe("mergeDeep", function () {
  });

  it("supports custom reconciler functions", function () {
-    const merger = new DeepMerger((target, source, key) => {
+    const merger = new DeepMerger(function (target, source, key) {


I'm a bit puzzled that this test worked... maybe that test needs deeper recursion?

phryneas · 2023-09-14T11:42:43Z

src/utilities/types/TODO.ts

@@ -0,0 +1,2 @@
+/** @internal */
+export type TODO = any;


I added this type for any-casts we want to remove in the future (e.g. in a separate PR, like in this case). As it is imported everywhere, we can easily use TS to track all of it's usages down and eliminate them.

phryneas · 2023-09-14T11:47:53Z

The base for this PR is now the Api-Extractor branch, so this PR can be reviewed, but not be merged before that other branch is merged.

phryneas · 2023-09-14T11:48:30Z

.api-reports/api-report.md

@@ -398,7 +398,7 @@ namespace Cache_2 {
    // (undocumented)
    interface BatchOptions<TCache extends ApolloCache<any>, TUpdateResult = void> {
        // (undocumented)
-        onWatchUpdated?: (this: TCache, watch: Cache_2.WatchOptions, diff: Cache_2.DiffResult<any>, lastDiff: Cache_2.DiffResult<any> | undefined) => any;
+        onWatchUpdated?: (this: TCache, watch: Cache_2.WatchOptions, diff: Cache_2.DiffResult<any>, lastDiff?: Cache_2.DiffResult<any> | undefined) => any;


This file sums up all the relevant changes to our external api. (The main entrypoint, that is)

phryneas

I've given this yet another full review, and I approve. @jerelmiller, please also give this another pass - and then let's get this in as soon as possible!

jerelmiller added 11 commits September 7, 2023 09:38

Enable strict mode in tsconfig.json

aca904f

Fix type issues in utilities/graphql/transform

0da3d3d

Use spread to push incoming objects in offsetLimitPagination

78ccf61

Fix type issues in writeToStore test

69d528a

Fix type issues in Concast

e503cbb

Remove unused filterInPlace utility

0fe49a0

Add this type to itAsync

e34d084

Add ! annotation to mockLink

962bd47

Fix assignment from unknown in error link

36129f8

Fix type issue in readFromStore

cea054e

Fix type issues in useQuery

bed3439

jerelmiller commented Sep 7, 2023

View reviewed changes

some progress

b568689

alessbell assigned alessbell, jerelmiller and phryneas Sep 12, 2023

more type fixes

6498326

phryneas force-pushed the enable-strict-mode branch from b49b269 to 6498326 Compare September 13, 2023 12:28

change addExportedVariables signature

b8c6eb6

phryneas force-pushed the enable-strict-mode branch from 0ce37f5 to 07ec4da Compare September 13, 2023 13:44

better typing

c3a761d

phryneas force-pushed the enable-strict-mode branch from 07ec4da to c3a761d Compare September 13, 2023 13:45

phryneas reviewed Sep 13, 2023

View reviewed changes

undo deprecation

9eb5e3e

phryneas requested a review from alessbell September 13, 2023 13:52

phryneas marked this pull request as ready for review September 13, 2023 13:52

Merge branch 'main' into enable-strict-mode

0966cc9

phryneas reviewed Sep 13, 2023

View reviewed changes

phryneas added 3 commits September 14, 2023 11:29

add api extractor

55a6351

add api reports

f909921

add workflow

e1e2fbb

phryneas mentioned this pull request Sep 14, 2023

Add API Extractor API reports as a CI check #11215

Merged

phryneas added 3 commits September 14, 2023 11:41

formatting

0426c84

package lock

be151b0

remove ensureResult for this PR, add TODO type

c83b042

phryneas force-pushed the enable-strict-mode branch from f2555fa to c83b042 Compare September 14, 2023 11:26

phryneas reviewed Sep 14, 2023

View reviewed changes

phryneas added 2 commits September 14, 2023 13:43

Merge branch 'pr/api-extractor' into enable-strict-mode

4aa485b

API updates for this PR

1e7c5c6

phryneas changed the base branch from main to pr/api-extractor September 14, 2023 11:47

phryneas reviewed Sep 14, 2023

View reviewed changes

Base automatically changed from pr/api-extractor to main September 14, 2023 16:27

Merge remote-tracking branch 'origin/main' into enable-strict-mode

c080309

phryneas approved these changes Nov 10, 2023

View reviewed changes

phryneas and others added 6 commits November 10, 2023 15:59

size-limit

0b2cf25

introduce IDE-only tsconfig.json

9303630

formatting

5e3fb70

fix path

04dcc0d

Merge pull request #11359 from apollographql/pr/enable-test-ts

2cb5c83

Add changeset

94b07f9

jerelmiller changed the title ~~[WIP] Enable strict mode and fix type errors~~ Enable strict mode in tsconfig and fix type errors Nov 10, 2023

jerelmiller merged commit ae5091a into main Nov 10, 2023
23 checks passed

jerelmiller deleted the enable-strict-mode branch November 10, 2023 19:26

This was referenced Nov 10, 2023

Version Packages #11350

Merged

Version Packages (alpha) #11353

Merged

github-actions bot locked as resolved and limited conversation to collaborators Dec 11, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable strict mode in tsconfig and fix type errors #11200

Enable strict mode in tsconfig and fix type errors #11200

jerelmiller commented Sep 7, 2023 •

edited

changeset-bot bot commented Sep 7, 2023 •

edited

jerelmiller Sep 7, 2023

github-actions bot commented Sep 13, 2023 •

edited

phryneas Sep 13, 2023

phryneas Sep 13, 2023

phryneas Sep 13, 2023

jerelmiller Nov 10, 2023

phryneas Sep 13, 2023

phryneas Sep 13, 2023

phryneas Sep 13, 2023

phryneas Sep 13, 2023

phryneas Sep 13, 2023

phryneas Sep 13, 2023

phryneas commented Sep 13, 2023

phryneas Sep 13, 2023

phryneas Sep 14, 2023

jerelmiller Nov 10, 2023

phryneas commented Sep 14, 2023

phryneas Sep 14, 2023

phryneas left a comment

Enable strict mode in tsconfig and fix type errors #11200

Enable strict mode in tsconfig and fix type errors #11200

Conversation

jerelmiller commented Sep 7, 2023 • edited

Checklist:

changeset-bot bot commented Sep 7, 2023 • edited

🦋 Changeset detected

Choose a reason for hiding this comment

github-actions bot commented Sep 13, 2023 • edited

size-limit report 📦

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phryneas commented Sep 13, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phryneas commented Sep 14, 2023

Choose a reason for hiding this comment

phryneas left a comment

Choose a reason for hiding this comment

jerelmiller commented Sep 7, 2023 •

edited

changeset-bot bot commented Sep 7, 2023 •

edited

github-actions bot commented Sep 13, 2023 •

edited