Remove access to non-public Suite and Spec members via Env#topSuite

src/core/Env.js

@@ -554,7 +554,7 @@ getJasmineRequireObj().Env = function(j$) {
      * @return {Suite} the root suite
      */
     this.topSuite = function() {
-      return j$.deprecatingSuiteProxy(topSuite, null, this);
+      return topSuite.buildMetadata(null);
     };
 
     /**

src/core/Spec.js

@@ -1,19 +1,9 @@
 getJasmineRequireObj().Spec = function(j$) {
-  /**
-   * @interface Spec
-   * @see Configuration#specFilter
-   */
   function Spec(attrs) {
     this.expectationFactory = attrs.expectationFactory;
     this.asyncExpectationFactory = attrs.asyncExpectationFactory;
     this.resultCallback = attrs.resultCallback || function() {};
     this.id = attrs.id;
-    /**
-     * The description passed to the {@link it} that created this spec.
-     * @name Spec#description
-     * @readonly
-     * @type {string}
-     */
     this.description = attrs.description || '';
     this.queueableFn = attrs.queueableFn;
     this.beforeAndAfterFns =
@@ -205,12 +195,6 @@ getJasmineRequireObj().Spec = function(j$) {
     return 'passed';
   };
 
-  /**
-   * The full description including all ancestors of this spec.
-   * @name Spec#getFullName
-   * @function
-   * @returns {string}
-   */
   Spec.prototype.getFullName = function() {
     return this.getSpecName(this);
   };
@@ -243,6 +227,30 @@ getJasmineRequireObj().Spec = function(j$) {
     );
   };
 
+  /**
+   * @interface Spec
+   * @see Configuration#specFilter
+   */
+  Spec.prototype.buildMetadata = function() {
+    return {
+      /**
+       * The description passed to the {@link it} that created this spec.
+       * @name Spec#description
+       * @readonly
+       * @type {string}
+       */
+      description: this.description,
+
+      /**
+       * The full description including all ancestors of this spec.
+       * @name Spec#getFullName
+       * @function
+       * @returns {string}
+       */
+      getFullName: this.getFullName.bind(this)
+    };
+  };
+
   return Spec;
 };
 

src/core/Suite.js

@@ -1,24 +1,8 @@
 getJasmineRequireObj().Suite = function(j$) {
-  /**
-   * @interface Suite
-   * @see Env#topSuite
-   */
   function Suite(attrs) {
     this.env = attrs.env;
     this.id = attrs.id;
-    /**
-     * The parent of this suite, or null if this is the top suite.
-     * @name Suite#parentSuite
-     * @readonly
-     * @type {Suite}
-     */
     this.parentSuite = attrs.parentSuite;
-    /**
-     * The description passed to the {@link describe} that created this suite.
-     * @name Suite#description
-     * @readonly
-     * @type {string}
-     */
     this.description = attrs.description;
     this.expectationFactory = attrs.expectationFactory;
     this.asyncExpectationFactory = attrs.asyncExpectationFactory;
@@ -29,14 +13,7 @@ getJasmineRequireObj().Suite = function(j$) {
     this.afterFns = [];
     this.beforeAllFns = [];
     this.afterAllFns = [];
-
     this.timer = attrs.timer || new j$.Timer();
-
-    /**
-     * The suite's children.
-     * @name Suite#children
-     * @type {Array.<(Spec|Suite)>}
-     */
     this.children = [];
 
     /**
@@ -74,12 +51,6 @@ getJasmineRequireObj().Suite = function(j$) {
     return this.asyncExpectationFactory(actual, this);
   };
 
-  /**
-   * The full description including all ancestors of this suite.
-   * @name Suite#getFullName
-   * @function
-   * @returns {string}
-   */
   Suite.prototype.getFullName = function() {
     var fullName = [];
     for (
@@ -214,6 +185,49 @@ getJasmineRequireObj().Suite = function(j$) {
     );
   };
 
+  Suite.prototype.buildMetadata = function(parentMetadata) {
+    /**
+     * @interface Suite
+     * @see Env#topSuite
+     */
+    var result = {
+      /**
+       * The parent of this suite, or null if this is the top suite.
+       * @name Suite#parentSuite
+       * @readonly
+       * @type {Suite}
+       */
+      parentSuite: parentMetadata,
+
+      /**
+       * The description passed to the {@link describe} that created this suite.
+       * @name Suite#description
+       * @readonly
+       * @type {string}
+       */
+      description: this.description,
+
+      /**
+       * The full description including all ancestors of this suite.
+       * @name Suite#getFullName
+       * @function
+       * @returns {string}
+       */
+      getFullName: this.getFullName.bind(this)
+    };
+
+    /**
+     * The suite's children.
+     * @name Suite#children
+     * @type {Array.<(Spec|Suite)>}
+     */
+    result.children = this.children.map(function(child) {
+      return child.buildMetadata(result);
+    });
+
+    return result;
+  };
+
   function isFailure(args) {
     return !args[0];
   }

src/core/deprecatingSpecProxy.js

@@ -1,70 +0,0 @@
-/* eslint-disable compat/compat */
-// TODO: Remove this in the next major release.
-getJasmineRequireObj().deprecatingSpecProxy = function(j$) {
-  function isMember(target, prop) {
-    return (
-      Object.keys(target).indexOf(prop) !== -1 ||
-      Object.keys(j$.Spec.prototype).indexOf(prop) !== -1
-    );
-  }
-
-  function isAllowedMember(prop) {
-    return prop === 'description' || prop === 'getFullName';
-  }
-
-  function msg(member) {
-    var memberName = member.toString().replace(/^Symbol\((.+)\)$/, '$1');
-    return (
-      'Access to private Spec members (in this case `' +
-      memberName +
-      '`) via Env#topSuite is not supported and will break in ' +
-      'a future release. See <https://jasmine.github.io/api/edge/Spec.html> ' +
-      'for correct usage.'
-    );
-  }
-
-  try {
-    new Proxy({}, {});
-  } catch (e) {
-    // Environment does not support Poxy.
-    return function(spec) {
-      return spec;
-    };
-  }
-
-  function DeprecatingSpecProxyHandler(env) {
-    this._env = env;
-  }
-
-  DeprecatingSpecProxyHandler.prototype.get = function(target, prop, receiver) {
-    this._maybeDeprecate(target, prop);
-
-    if (prop === 'getFullName') {
-      // getFullName calls a private method. Re-bind 'this' to avoid a bogus
-      // deprecation warning.
-      return target.getFullName.bind(target);
-    } else {
-      return target[prop];
-    }
-  };
-
-  DeprecatingSpecProxyHandler.prototype.set = function(target, prop, value) {
-    this._maybeDeprecate(target, prop);
-    return (target[prop] = value);
-  };
-
-  DeprecatingSpecProxyHandler.prototype._maybeDeprecate = function(
-    target,
-    prop
-  ) {
-    if (isMember(target, prop) && !isAllowedMember(prop)) {
-      this._env.deprecated(msg(prop));
-    }
-  };
-
-  function deprecatingSpecProxy(spec, env) {
-    return new Proxy(spec, new DeprecatingSpecProxyHandler(env));
-  }
-
-  return deprecatingSpecProxy;
-};

src/core/deprecatingSuiteProxy.js

@@ -1,98 +0,0 @@
-/* eslint-disable compat/compat */
-// TODO: Remove this in the next major release.
-getJasmineRequireObj().deprecatingSuiteProxy = function(j$) {
-  var allowedMembers = [
-    'children',
-    'description',
-    'parentSuite',
-    'getFullName'
-  ];
-
-  function isMember(target, prop) {
-    return (
-      Object.keys(target).indexOf(prop) !== -1 ||
-      Object.keys(j$.Suite.prototype).indexOf(prop) !== -1
-    );
-  }
-
-  function isAllowedMember(prop) {
-    return allowedMembers.indexOf(prop) !== -1;
-  }
-
-  function msg(member) {
-    var memberName = member.toString().replace(/^Symbol\((.+)\)$/, '$1');
-    return (
-      'Access to private Suite members (in this case `' +
-      memberName +
-      '`) via Env#topSuite is not supported and will break in ' +
-      'a future release. See <https://jasmine.github.io/api/edge/Suite.html> ' +
-      'for correct usage.'
-    );
-  }
-  try {
-    new Proxy({}, {});
-  } catch (e) {
-    // Environment does not support Poxy.
-    return function(suite) {
-      return suite;
-    };
-  }
-
-  function DeprecatingSuiteProxyHandler(parentSuite, env) {
-    this._parentSuite = parentSuite;
-    this._env = env;
-  }
-
-  DeprecatingSuiteProxyHandler.prototype.get = function(
-    target,
-    prop,
-    receiver
-  ) {
-    if (prop === 'children') {
-      if (!this._children) {
-        this._children = target.children.map(
-          this._proxyForChild.bind(this, receiver)
-        );
-      }
-
-      return this._children;
-    } else if (prop === 'parentSuite') {
-      return this._parentSuite;
-    } else {
-      this._maybeDeprecate(target, prop);
-      return target[prop];
-    }
-  };
-
-  DeprecatingSuiteProxyHandler.prototype.set = function(target, prop, value) {
-    debugger;
-    this._maybeDeprecate(target, prop);
-    return (target[prop] = value);
-  };
-
-  DeprecatingSuiteProxyHandler.prototype._maybeDeprecate = function(
-    target,
-    prop
-  ) {
-    if (isMember(target, prop) && !isAllowedMember(prop)) {
-      this._env.deprecated(msg(prop));
-    }
-  };
-
-  DeprecatingSuiteProxyHandler.prototype._proxyForChild = function(
-    ownProxy,
-    child
-  ) {
-    if (child.children) {
-      return deprecatingSuiteProxy(child, ownProxy, this._env);
-    } else {
-      return j$.deprecatingSpecProxy(child, this._env);
-    }
-  };
-
-  function deprecatingSuiteProxy(suite, parentSuite, env) {
-    return new Proxy(suite, new DeprecatingSuiteProxyHandler(parentSuite, env));
-  }
-
-  return deprecatingSuiteProxy;
-};

src/core/requireCore.js

@@ -44,8 +44,6 @@ var getJasmineRequireObj = (function(jasmineGlobal) {
     j$.DelayedFunctionScheduler = jRequire.DelayedFunctionScheduler(j$);
     j$.Deprecator = jRequire.Deprecator(j$);
     j$.Env = jRequire.Env(j$);
-    j$.deprecatingSuiteProxy = jRequire.deprecatingSuiteProxy(j$);
-    j$.deprecatingSpecProxy = jRequire.deprecatingSpecProxy(j$);
     j$.StackTrace = jRequire.StackTrace(j$);
     j$.ExceptionFormatter = jRequire.ExceptionFormatter(j$);
     j$.ExpectationFilterChain = jRequire.ExpectationFilterChain();