Merge pull request #716 from magiclabs/ariflo-PDEEXP-237-warn-univers…

…al-wallet-devs-of-doom-2

Warn developers of Coming Deprecation of Universal Wallet API Keys

packages/@magic-sdk/provider/src/core/sdk-exceptions.ts

@@ -204,8 +204,12 @@ export function createDeprecationWarning(options: {
 }) {
   const { method, removalVersions, useInstead } = options;
 
+  const preventDisruptionLanguage = 'to prevent disruption of the wallet service';
+
   const removalVersion = removalVersions[SDKEnvironment.sdkName];
-  const useInsteadSuffix = useInstead ? ` Use \`${useInstead}\` instead.` : '';
+  const useInsteadSuffix = useInstead
+    ? ` Use \`${useInstead}\` instead ${useInstead.includes('Dedicated Wallet') ? preventDisruptionLanguage : ''}.`
+    : '';
   const message = `\`${method}\` will be removed from \`${SDKEnvironment.sdkName}\` in version \`${removalVersion}\`.${useInsteadSuffix}`;
 
   return new MagicSDKWarning(SDKWarningCode.DeprecationNotice, message);

packages/@magic-sdk/provider/src/core/view-controller.ts

@@ -10,7 +10,7 @@ import { createPromise } from '../util/promise-tools';
 import { getItem, setItem } from '../util/storage';
 import { createJwt } from '../util/web-crypto';
 import { SDKEnvironment } from './sdk-environment';
-import { createModalNotReadyError } from './sdk-exceptions';
+import { createDeprecationWarning, createModalNotReadyError } from './sdk-exceptions';
 import {
   clearDeviceShares,
   encryptAndPersistDeviceShare,
@@ -34,6 +34,13 @@ interface StandardizedMagicRequest {
   deviceShare?: string;
 }
 
+export const UniversalWalletRemovalVersions = {
+  'magic-sdk': 'v23.0.0',
+  '@magic-sdk/react-native': 'v14.0.0',
+  '@magic-sdk/react-native-bare': 'v24.0.0',
+  '@magic-sdk/react-native-expo': 'v24.0.0',
+};
+
 /**
  * Get the originating payload from a batch request using the specified `id`.
  */
@@ -259,5 +266,15 @@ export abstract class ViewController {
     this.on(MagicIncomingWindowMessage.MAGIC_SHOW_OVERLAY, () => {
       this.showOverlay();
     });
+
+    this.on(MagicIncomingWindowMessage.MAGIC_SEND_PRODUCT_TYPE, (event: MagicMessageEvent) => {
+      if (event.data.response.result.product_type === 'connect') {
+        createDeprecationWarning({
+          method: 'Usage of Universal Wallet API Keys',
+          removalVersions: UniversalWalletRemovalVersions,
+          useInstead: 'Dedicated Wallet API Key',
+        }).log();
+      }
+    });
   }
 }

packages/@magic-sdk/provider/test/constants.ts

@@ -10,4 +10,5 @@ export const MSG_TYPES = (parameters = ENCODED_QUERY_PARAMS) => ({
   MAGIC_HIDE_OVERLAY: `MAGIC_HIDE_OVERLAY-${parameters}`,
   MAGIC_HANDLE_REQUEST: `MAGIC_HANDLE_REQUEST-${parameters}`,
   MAGIC_HANDLE_EVENT: `MAGIC_HANDLE_EVENT-${parameters}`,
+  MAGIC_SEND_PRODUCT_TYPE: `MAGIC_SEND_PRODUCT_TYPE-${parameters}`,
 });

packages/@magic-sdk/provider/test/spec/core/sdk-exceptions/warning-factories.spec.ts

@@ -115,6 +115,27 @@ test('Creates a `DEPRECATION_NOTICE` warning with `useInstead` suffix', async ()
   warningAssertions(
     warning,
     'DEPRECATION_NOTICE',
-    '`test()` will be removed from `magic-sdk` in version `v999`. Use `test2()` instead.',
+    '`test()` will be removed from `magic-sdk` in version `v999`. Use `test2()` instead .',
+  );
+});
+
+test('Creates a `DEPRECATION_NOTICE` warning with `useInstead` containing "Dedicated Wallet" suffix', async () => {
+  mockSDKEnvironmentConstant({ sdkName: 'magic-sdk' });
+
+  const { createDeprecationWarning } = require('../../../../src/core/sdk-exceptions');
+  const warning = createDeprecationWarning({
+    method: 'test()',
+    removalVersions: {
+      'magic-sdk': 'v999',
+      '@magic-sdk/react-native-bare': 'v888',
+      '@magic-sdk/react-native-expo': 'v777',
+    },
+    useInstead: 'Dedicated Wallet',
+  });
+
+  warningAssertions(
+    warning,
+    'DEPRECATION_NOTICE',
+    '`test()` will be removed from `magic-sdk` in version `v999`. Use `Dedicated Wallet` instead to prevent disruption of the wallet service.',
   );
 });

packages/@magic-sdk/provider/test/spec/core/view-controller/listen.spec.ts

@@ -1,11 +1,18 @@
 import browserEnv from '@ikscodes/browser-env';
 import { createViewController } from '../../../factories';
 import { MSG_TYPES } from '../../../constants';
+import { createDeprecationWarning } from '../../../../src/core/sdk-exceptions';
+import { UniversalWalletRemovalVersions } from '../../../../src/core/view-controller';
 
 beforeEach(() => {
   browserEnv();
 });
 
+jest.mock('../../../../src/core/sdk-exceptions', () => ({
+  ...jest.requireActual('../../../../src/core/sdk-exceptions'),
+  createDeprecationWarning: jest.fn(),
+}));
+
 test('Receive MAGIC_HIDE_OVERLAY, call `hideOverlay`', (done) => {
   const overlay = createViewController('');
   const hideOverlayStub = jest.fn();
@@ -31,3 +38,32 @@ test('Receive MAGIC_SHOW_OVERLAY, call `showOverlay`', (done) => {
     done();
   }, 0);
 });
+
+test('Receive MAGIC_SEND_PRODUCT_TYPE with product_type "connect", call `createDeprecationWarning`', (done) => {
+  const overlay = createViewController('');
+
+  // Cast the imported function to its mocked version
+  const mockCreateDeprecationWarning = createDeprecationWarning as jest.Mock;
+
+  // Mock the return value
+  mockCreateDeprecationWarning.mockReturnValue({
+    log: jest.fn(),
+  });
+
+  window.postMessage(
+    {
+      msgType: MSG_TYPES().MAGIC_SEND_PRODUCT_TYPE,
+      response: { result: { product_type: 'connect' } },
+    },
+    '*',
+  );
+
+  setTimeout(() => {
+    expect(mockCreateDeprecationWarning).toBeCalledWith({
+      method: 'Usage of Universal Wallet API Keys',
+      removalVersions: UniversalWalletRemovalVersions,
+      useInstead: 'Dedicated Wallet API Key',
+    });
+    done();
+  }, 0);
+});

packages/@magic-sdk/provider/test/spec/core/view-controller/on.spec.ts

@@ -9,7 +9,7 @@ beforeEach(() => {
 /**
  * We start with 3 listeners whenever a `ViewController` is created.
  */
-const baselineListeners = 3;
+const baselineListeners = 4;
 
 test('Adds the event listener callback to the internal state', () => {
   const viewController = createViewController();

packages/@magic-sdk/types/src/core/json-rpc-types.ts

@@ -32,6 +32,7 @@ export interface JsonRpcResponsePayload<ResultType = any> {
   id: string | number | null;
   result?: ResultType | null;
   error?: JsonRpcError | null;
+  product_type?: 'magic' | 'connect';
 }
 
 export interface UserInfo {

packages/@magic-sdk/types/src/core/message-types.ts

@@ -7,6 +7,7 @@ export enum MagicIncomingWindowMessage {
   MAGIC_HIDE_OVERLAY = 'MAGIC_HIDE_OVERLAY',
   MAGIC_HANDLE_EVENT = 'MAGIC_HANDLE_EVENT',
   MAGIC_MG_BOX_SEND_RECEIPT = 'MAGIC_MG_BOX_SEND_RECEIPT',
+  MAGIC_SEND_PRODUCT_TYPE = 'MAGIC_SEND_PRODUCT_TYPE',
 }
 
 export enum MagicOutgoingWindowMessage {