replace wildcard re-exports with individual exports (#12508)

Author: phryneas

.api-reports/api-report-react.api.md

@@ -1,6 +1,6 @@
 {
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (CJS)": 42554,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production) (CJS)": 37874,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\"": 32871,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production)": 27681
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (CJS)": 42953,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production) (CJS)": 38255,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\"": 32954,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production)": 27724
 }

.size-limits.json

@@ -1,5 +1,6 @@
 import { dirname, join, relative, resolve, sep } from "node:path";
 
+import type { TSESTree as AST } from "@typescript-eslint/types";
 import { ESLintUtils } from "@typescript-eslint/utils";
 import { $ } from "zx";
 
@@ -41,37 +42,81 @@ function findNearestEntryPointFolder(filename: string) {
 
 export const importFromExport = ESLintUtils.RuleCreator.withoutDocs({
   create(context) {
+    function rule(node: AST.ImportDeclaration | AST.ExportNamedDeclaration) {
+      if (!node.source || !node.source.value.startsWith(".")) {
+        return;
+      }
+      const resolvedTarget = resolve(
+        dirname(context.physicalFilename),
+        node.source.value
+      );
+      if (resolvedTarget in entryPoints) {
+        context.report({
+          node: node.source,
+          messageId: "importFromExport",
+          fix(fixer) {
+            return fixer.replaceTextRange(
+              node.source.range,
+              `"${entryPoints[resolvedTarget]}"`
+            );
+          },
+        });
+      }
+    }
     return {
-      ImportDeclaration(node) {
-        if (!node.source.value.startsWith(".")) {
+      ImportDeclaration: rule,
+      // TODO: enable this in a separate PR for easier review
+      // ExportNamedDeclaration: rule,
+    };
+  },
+  meta: {
+    messages: {
+      importFromExport:
+        "Don't use relative imports to import from official entrypoints.",
+    },
+    type: "problem",
+    schema: [],
+    fixable: "code",
+  },
+  defaultOptions: [],
+});
+
+export const noDuplicateExports = ESLintUtils.RuleCreator.withoutDocs({
+  create(context) {
+    const seenExports = new Map<string, AST.ExportNamedDeclaration>();
+    return {
+      ExportNamedDeclaration(node) {
+        if (!node.source) {
           return;
         }
-        const resolvedTarget = resolve(
-          dirname(context.physicalFilename),
-          node.source.value
-        );
-        if (resolvedTarget in entryPoints) {
+        const name = node.source.value + ":" + node.exportKind;
+        const alreadySeen = seenExports.get(name);
+        if (alreadySeen) {
           context.report({
-            node: node.source,
-            messageId: "importFromExport",
-            fix(fixer) {
-              return fixer.replaceTextRange(
-                node.source.range,
-                `"${entryPoints[resolvedTarget]}"`
-              );
+            node: node,
+            messageId: "noDuplicateExports",
+            *fix(fixer) {
+              for (const specifier of node.specifiers) {
+                yield fixer.insertTextBefore(
+                  alreadySeen.specifiers[0],
+                  context.sourceCode.getText(specifier) + ","
+                );
+              }
+              yield fixer.remove(node);
             },
           });
         }
+        seenExports.set(name, node);
       },
     };
   },
   meta: {
     messages: {
-      importFromExport:
-        "Don't use relative imports to import from official entrypoints.",
+      noDuplicateExports:
+        "Don't use multiple exports statements with the same source.",
     },
-    type: "problem",
     schema: [],
+    type: "problem",
     fixable: "code",
   },
   defaultOptions: [],

eslint-local-rules/import-from-export.ts

@@ -2,6 +2,7 @@ import { rule as forbidActInDisabledActEnvironment } from "./forbid-act-in-disab
 import {
   importFromExport,
   importFromInsideOtherExport,
+  noDuplicateExports,
   noInternalImportOfficialExport,
 } from "./import-from-export.ts";
 import { rule as requireDisableActEnvironment } from "./require-disable-act-environment.ts";
@@ -14,4 +15,5 @@ export default {
   "import-from-export": importFromExport,
   "import-from-inside-other-export": importFromInsideOtherExport,
   "no-internal-import-official-export": noInternalImportOfficialExport,
+  "no-duplicate-exports": noDuplicateExports,
 };

eslint-local-rules/index.mjs

@@ -106,6 +106,7 @@ export default [
           ].map((file) => path.resolve(__dirname, file)),
         },
       ],
+      "local-rules/no-duplicate-exports": "error",
     },
   },
   ...fixupConfigRules(compat.extends("plugin:react-hooks/recommended")).map(
@@ -139,7 +140,6 @@ export default [
 
     rules: {
       "react-compiler/react-compiler": "error",
-
       "@typescript-eslint/consistent-type-imports": [
         "error",
         {
@@ -177,6 +177,7 @@ export default [
           message:
             "Please only use the namespace import syntax (`import * as React from 'react'`) for React imports!",
         },
+        "ExportAllDeclaration",
       ],
 
       "import/consistent-type-specifier-style": ["error", "prefer-top-level"],

eslint.config.mjs

@@ -47,4 +47,19 @@ export { Policies } from "./inmemory/policies.js";
 export type { FragmentRegistryAPI } from "./inmemory/fragmentRegistry.js";
 export { createFragmentRegistry } from "./inmemory/fragmentRegistry.js";
 
-export type * from "./inmemory/types.js";
+export type {
+  ApolloReducerConfig,
+  DiffQueryAgainstStoreOptions,
+  IdGetter,
+  IdGetterObj,
+  InMemoryCacheConfig,
+  MergeInfo,
+  MergeTree,
+  NormalizedCache,
+  NormalizedCacheObject,
+  OptimisticStoreItem,
+  ReadMergeModifyContext,
+  ReadQueryOptions,
+  StoreObject,
+  StoreValue,
+} from "./inmemory/types.js";

src/cache/index.ts

@@ -22,7 +22,35 @@ export type {
   WatchQueryOptions,
 } from "./watchQueryOptions.js";
 export { isNetworkRequestSettled, NetworkStatus } from "./networkStatus.js";
-export type * from "./types.js";
+export type {
+  ApolloQueryResult,
+  DefaultContext,
+  ErrorLike,
+  InternalRefetchQueriesInclude,
+  InternalRefetchQueriesMap,
+  InternalRefetchQueriesOptions,
+  InternalRefetchQueriesResult,
+  InternalRefetchQueryDescriptor,
+  MethodKeys,
+  MutateResult,
+  MutationQueryReducer,
+  MutationQueryReducersMap,
+  MutationUpdaterFn,
+  MutationUpdaterFunction,
+  OnQueryUpdated,
+  OperationVariables,
+  PureQueryOptions,
+  QueryListener,
+  QueryResult,
+  RefetchQueriesInclude,
+  RefetchQueriesOptions,
+  RefetchQueriesPromiseResults,
+  RefetchQueriesResult,
+  RefetchQueryDescriptor,
+  Resolvers,
+  SubscribeResult,
+  TypedDocumentNode,
+} from "./types.js";
 export type { FragmentMatcher, Resolver } from "./LocalState.js";
 export {
   CombinedGraphQLErrors,
@@ -34,6 +62,7 @@ export {
 /* Cache */
 
 export type {
+  Cache,
   DataProxy,
   FieldFunctionOptions,
   FieldMergeFunction,
@@ -50,7 +79,7 @@ export type {
   WatchFragmentOptions,
   WatchFragmentResult,
 } from "../cache/index.js";
-export type { Cache } from "../cache/index.js";
+
 export {
   ApolloCache,
   defaultDataIdFromObject,
@@ -59,12 +88,67 @@ export {
   MissingFieldError,
 } from "../cache/index.js";
 
-export type * from "../cache/inmemory/types.js";
+export type {
+  ApolloReducerConfig,
+  DiffQueryAgainstStoreOptions,
+  IdGetter,
+  IdGetterObj,
+  MergeInfo,
+  MergeTree,
+  NormalizedCache,
+  NormalizedCacheObject,
+  OptimisticStoreItem,
+  ReadMergeModifyContext,
+  ReadQueryOptions,
+  StoreValue,
+} from "../cache/inmemory/types.js";
 
 /* Link */
 
-export * from "../link/core/index.js";
-export * from "../link/http/index.js";
+export {
+  ApolloLink,
+  concat,
+  empty,
+  execute,
+  from,
+  split,
+} from "../link/core/index.js";
+export type {
+  ApolloPayloadResult,
+  DocumentNode,
+  ExecutionPatchIncrementalResult,
+  ExecutionPatchInitialResult,
+  ExecutionPatchResult,
+  FetchResult,
+  GraphQLRequest,
+  IncrementalPayload,
+  NextLink,
+  Operation,
+  Path,
+  RequestHandler,
+  SingleExecutionResult,
+} from "../link/core/index.js";
+
+export {
+  checkFetcher,
+  createHttpLink,
+  createSignalIfSupported,
+  defaultPrinter,
+  fallbackHttpConfig,
+  HttpLink,
+  parseAndCheckHttpResponse,
+  rewriteURIForGET,
+  selectHttpOptionsAndBody,
+  // TODO remove: needed by @apollo/client/link/batch-http but not public
+  selectHttpOptionsAndBodyInternal,
+  selectURI,
+  serializeFetchParameter,
+} from "../link/http/index.js";
+export type {
+  ClientParseError,
+  HttpOptions,
+  UriFunction,
+} from "../link/http/index.js";
 
 /* Masking */
 export type {

src/core/index.ts

@@ -1,2 +1,3 @@
+// eslint-disable-next-line no-restricted-syntax
 export * from "@apollo/client/core";
 export { Observable } from "rxjs";

src/index.ts

@@ -1 +1 @@
-export * from "./batchHttpLink.js";
+export { BatchHttpLink } from "./batchHttpLink.js";

src/link/batch-http/index.ts

@@ -1 +1,2 @@
-export * from "./batchLink.js";
+export type { BatchableRequest, BatchHandler } from "./batchLink.js";
+export { BatchLink, OperationBatcher } from "./batchLink.js";