Rename: ready -> checkIsReadyForRequest and isReady -> isReadyForRequest

Author: romin-halltari

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

@@ -196,6 +196,6 @@ export class SDKBase {
    * has completed loading and is ready for requests.
    */
   public async preload() {
-    await this.overlay.ready;
+    await this.overlay.checkIsReadyForRequest;
   }
 }

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

@@ -90,8 +90,8 @@ async function persistMagicEventRefreshToken(event: MagicMessageEvent) {
 }
 
 export abstract class ViewController {
-  private isReady = false;
-  public ready: Promise<void>;
+  private isReadyForRequest = false;
+  public checkIsReadyForRequest: Promise<void>;
   protected readonly messageHandlers = new Set<(event: MagicMessageEvent) => any>();
 
   /**
@@ -102,7 +102,7 @@ export abstract class ViewController {
    * relevant iframe context.
    */
   constructor(protected readonly endpoint: string, protected readonly parameters: string) {
-    this.ready = this.waitForReady();
+    this.checkIsReadyForRequest = this.waitForReady();
     this.listen();
   }
 
@@ -134,12 +134,12 @@ export abstract class ViewController {
   ): Promise<JsonRpcResponse<ResultType> | JsonRpcResponse<ResultType>[]> {
     return createPromise(async (resolve, reject) => {
       if (SDKEnvironment.platform !== 'react-native') {
-        await this.ready;
-      } else if (!this.isReady) {
-        // On a mobile environment, `this.ready` never resolves if the app was
-        // initially opened without internet connection. That is why we reject
-        // the promise without waiting and just let them call it again when
-        // internet connection is re-established.
+        await this.checkIsReadyForRequest;
+      } else if (!this.isReadyForRequest) {
+        // On a mobile environment, `this.checkIsReadyForRequest` never resolves
+        // if the app was initially opened without internet connection. That is
+        // why we reject the promise without waiting and just let them call it
+        // again when internet connection is re-established.
         const error: JsonRpcError = {
           code: RPCErrorCode.InternalError,
           message: 'Connection to Magic SDK not ready. Please check your internet connection.',
@@ -211,7 +211,7 @@ export abstract class ViewController {
     return new Promise<void>((resolve) => {
       this.on(MagicIncomingWindowMessage.MAGIC_OVERLAY_READY, () => {
         resolve();
-        this.isReady = true;
+        this.isReadyForRequest = true;
       });
     });
   }

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

@@ -61,7 +61,7 @@ function stubViewController(viewController: any, events: [MagicIncomingWindowMes
   const postSpy = jest.fn();
 
   viewController.on = onSpy;
-  viewController.ready = Promise.resolve();
+  viewController.checkIsReadyForRequest = Promise.resolve();
   viewController._post = postSpy;
 
   return { handlerSpy, onSpy, postSpy };
@@ -213,7 +213,7 @@ test('does not wait for ready and throws error when platform is react-native', a
   const { handlerSpy, onSpy } = stubViewController(viewController, [
     [MagicIncomingWindowMessage.MAGIC_HANDLE_RESPONSE, eventWithRt],
   ]);
-  viewController.ready = new Promise(() => null);
+  viewController.checkIsReadyForRequest = new Promise(() => null);
 
   const payload = requestPayload();
 
@@ -239,8 +239,8 @@ test('does not call web crypto api if platform is not web', async () => {
   ]);
   const payload = requestPayload();
 
-  // @ts-ignore isReady is private
-  viewController.isReady = true;
+  // @ts-ignore isReadyForRequest is private
+  viewController.isReadyForRequest = true;
 
   const response = await viewController.post(MagicOutgoingWindowMessage.MAGIC_HANDLE_REQUEST, payload);