fix(rpc): add a custom toJSON to help jest's expect library (#3489)

microsoft · Aug 16, 2020 · d516f81 · d516f81
1 parent f983432
commit d516f81
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/src/rpc/client/channelOwner.ts b/src/rpc/client/channelOwner.ts
@@ -106,6 +106,17 @@ export abstract class ChannelOwner<T extends Channel = Channel, Initializer = {}
       throw e;
     }
   }
+
+  private toJSON() {
+    // Jest's expect library tries to print objects sometimes.
+    // RPC objects can contain links to lots of other objects,
+    // which can cause jest to crash. Let's help it out
+    // by just returning the important values.
+    return {
+      _type: this._type,
+      _guid: this._guid,
+    };
+  }
 }
 
 const debugLogger = new DebugLoggerSink();

diff --git a/utils/doclint/check_public_api/JSBuilder.js b/utils/doclint/check_public_api/JSBuilder.js
@@ -234,6 +234,8 @@ function checkSources(sources) {
         continue;
       if (name.startsWith('_'))
         continue;
+      if (member.valueDeclaration && ts.getCombinedModifierFlags(member.valueDeclaration) & ts.ModifierFlags.Private)
+        continue;
       if (EventEmitter.prototype.hasOwnProperty(name))
         continue;
       const memberType = checker.getTypeOfSymbolAtLocation(member, member.valueDeclaration);