(core) - Remove deprecated operationName property from Operations (#1357

) * Remove deprecated operationName property from Operation * Add changeset * Bump bindings by minor to adopt new major @urql/core
urql-graphql · Feb 10, 2021 · 9a1f123 · 9a1f123
1 parent 97689ff
commit 9a1f123
Show file tree

Hide file tree

Showing 14 changed files with 15 additions and 113 deletions.
diff --git a/.changeset/plenty-carrots-prove.md b/.changeset/plenty-carrots-prove.md
@@ -0,0 +1,10 @@
+---
+'@urql/core': major
+'@urql/preact': minor
+'@urql/svelte': minor
+'@urql/vue': minor
+'urql': minor
+---
+
+Remove deprecated `operationName` property from `Operation`s. The new `Operation.kind` property is now preferred. If you're creating new operations you may also use the `makeOperation` utility instead.
+When upgrading `@urql/core` please ensure that your package manager didn't install any duplicates of it. You may deduplicate it manually using `npx yarn-deduplicate` (for Yarn) or `npm dedupe` (for npm).
diff --git a/exchanges/graphcache/src/operations/write.ts b/exchanges/graphcache/src/operations/write.ts
@@ -94,23 +94,23 @@ export const startWrite = (
 ) => {
   const operation = getMainOperation(request.query);
   const result: WriteResult = { data, dependencies: getCurrentDependencies() };
-  const operationName = store.rootFields[operation.operation];
+  const kind = store.rootFields[operation.operation];
 
   const ctx = makeContext(
     store,
     normalizeVariables(operation, request.variables),
     getFragments(request.query),
-    operationName,
-    operationName,
+    kind,
+    kind,
     !!isOptimistic,
     error
   );
 
   if (process.env.NODE_ENV !== 'production') {
-    pushDebugNode(operationName, operation);
+    pushDebugNode(kind, operation);
   }
 
-  writeSelection(ctx, operationName, getSelectionSet(operation), data);
+  writeSelection(ctx, kind, getSelectionSet(operation), data);
 
   if (process.env.NODE_ENV !== 'production') {
     popDebugNode();

diff --git a/exchanges/multipart-fetch/src/__snapshots__/multipartFetchExchange.test.ts.snap b/exchanges/multipart-fetch/src/__snapshots__/multipartFetchExchange.test.ts.snap
@@ -15,7 +15,6 @@ Object {
     },
     "key": 2,
     "kind": "query",
-    "operationName": "query",
     "query": Object {
       "__key": 3044551916,
       "definitions": Array [
@@ -185,7 +184,6 @@ Object {
     },
     "key": 2,
     "kind": "query",
-    "operationName": "query",
     "query": Object {
       "__key": 3044551916,
       "definitions": Array [
@@ -357,7 +355,6 @@ Object {
     },
     "key": 2,
     "kind": "query",
-    "operationName": "query",
     "query": Object {
       "__key": 3044551916,
       "definitions": Array [
@@ -531,7 +528,6 @@ Object {
     },
     "key": 3,
     "kind": "mutation",
-    "operationName": "mutation",
     "query": Object {
       "__key": 3781860981,
       "definitions": Array [
@@ -681,7 +677,6 @@ Object {
     },
     "key": 3,
     "kind": "mutation",
-    "operationName": "mutation",
     "query": Object {
       "__key": 1193185401,
       "definitions": Array [

diff --git a/exchanges/refocus/src/refocusExchange.test.ts b/exchanges/refocus/src/refocusExchange.test.ts
@@ -88,8 +88,5 @@ it(`attaches a listener and redispatches queries on call`, () => {
     key: 1,
     query: queryOne,
     kind: 'query',
-
-    // TODO: Remove this when the deprecated "operationName" property is removed
-    operationName: 'query',
   });
 });
diff --git a/packages/core/src/client.test.ts b/packages/core/src/client.test.ts
@@ -151,9 +151,6 @@ describe('synchronous methods', () => {
         context: expect.anything(),
         key: expect.any(Number),
         kind: 'query',
-
-        // TODO: Remove this when the deprecated `operationName` property is removed
-        operationName: 'query',
       },
     });
   });

diff --git a/packages/core/src/exchanges/__snapshots__/fetch.test.ts.snap b/packages/core/src/exchanges/__snapshots__/fetch.test.ts.snap
@@ -15,7 +15,6 @@ Object {
     },
     "key": 2,
     "kind": "query",
-    "operationName": "query",
     "query": Object {
       "__key": 3044551916,
       "definitions": Array [
@@ -185,7 +184,6 @@ Object {
     },
     "key": 2,
     "kind": "query",
-    "operationName": "query",
     "query": Object {
       "__key": 3044551916,
       "definitions": Array [
@@ -357,7 +355,6 @@ Object {
     },
     "key": 2,
     "kind": "query",
-    "operationName": "query",
     "query": Object {
       "__key": 3044551916,
       "definitions": Array [

diff --git a/packages/core/src/exchanges/__snapshots__/subscription.test.ts.snap b/packages/core/src/exchanges/__snapshots__/subscription.test.ts.snap
@@ -15,7 +15,6 @@ Object {
     },
     "key": 4,
     "kind": "subscription",
-    "operationName": "subscription",
     "query": Object {
       "__key": 2616620656,
       "definitions": Array [

diff --git a/packages/core/src/internal/__snapshots__/fetchSource.test.ts.snap b/packages/core/src/internal/__snapshots__/fetchSource.test.ts.snap
@@ -15,7 +15,6 @@ Object {
     },
     "key": 2,
     "kind": "query",
-    "operationName": "query",
     "query": Object {
       "__key": 3044551916,
       "definitions": Array [
@@ -175,7 +174,6 @@ Object {
     },
     "key": 2,
     "kind": "query",
-    "operationName": "query",
     "query": Object {
       "__key": 3044551916,
       "definitions": Array [
@@ -335,7 +333,6 @@ Object {
     },
     "key": 2,
     "kind": "query",
-    "operationName": "query",
     "query": Object {
       "__key": 3044551916,
       "definitions": Array [
@@ -499,7 +496,6 @@ Object {
     },
     "key": 2,
     "kind": "query",
-    "operationName": "query",
     "query": Object {
       "__key": 3044551916,
       "definitions": Array [
@@ -679,7 +675,6 @@ Object {
     },
     "key": 2,
     "kind": "query",
-    "operationName": "query",
     "query": Object {
       "__key": 3044551916,
       "definitions": Array [

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -57,9 +57,6 @@ export interface Operation<Data = any, Variables = any>
   extends GraphQLRequest<Data, Variables> {
   readonly kind: OperationType;
   context: OperationContext;
-
-  /** @deprecated use Operation.kind instead */
-  readonly operationName: OperationType;
 }
 
 /** Resulting data from an [operation]{@link Operation}. */

diff --git a/packages/core/src/utils/deprecation.test.ts b/packages/core/src/utils/deprecation.test.ts
diff --git a/packages/core/src/utils/deprecation.ts b/packages/core/src/utils/deprecation.ts
diff --git a/packages/core/src/utils/index.ts b/packages/core/src/utils/index.ts
@@ -6,7 +6,6 @@ export * from './stringifyVariables';
 export * from './maskTypename';
 export * from './withPromise';
 export * from './operation';
-export * from './deprecation';
 
 export const noop = () => {
   /* noop */

diff --git a/packages/core/src/utils/operation.ts b/packages/core/src/utils/operation.ts
@@ -4,16 +4,6 @@ import {
   OperationContext,
   OperationType,
 } from '../types';
-import { Warning, deprecationWarning } from './deprecation';
-
-// TODO: Remove when the deprecated `operationName` property is removed
-const DEPRECATED: Record<string, Warning> = {
-  operationName: {
-    key: 'Operation.operationName',
-    message:
-      'The "Operation.operationName" property has been deprecated and will be removed in a future release of urql. Use "Operation.kind" instead.',
-  },
-};
 
 function makeOperation<Data = any, Variables = object>(
   kind: OperationType,
@@ -36,12 +26,6 @@ function makeOperation(kind, request, context) {
     variables: request.variables,
     kind,
     context,
-
-    get operationName(): OperationType {
-      deprecationWarning(DEPRECATED.operationName);
-
-      return this.kind;
-    },
   };
 }
 

diff --git a/scripts/jest/setup.js b/scripts/jest/setup.js
@@ -17,13 +17,3 @@ global.console = {
 jest.spyOn(console, 'log');
 jest.spyOn(console, 'warn');
 jest.spyOn(console, 'error');
-
-jest.mock('../../packages/core/src/utils/deprecation.ts', () => ({
-  deprecationWarning({ message }) {
-    const error = new Error(`Deprecation Warnings are thrown in tests.\n${message}`);
-    if (!/jest-snapshot|pretty-format|jest-jasmine2/i.test(error.stack)) {
-      throw error;
-    }
-  },
-  _clearWarnings() {},
-}));