refactor: replace UNSAFE_root with container

Author: mdjastrzebski

src/__tests__/render.test.tsx

@@ -204,22 +204,12 @@ test('returns host root', () => {
   expect(screen.root.props.testID).toBe('inner');
 });
 
-// test('returns composite UNSAFE_root', () => {
-//   render(<View testID="inner" />);
-
-//   expect(screen.UNSAFE_root).toBeDefined();
-//   expect(screen.UNSAFE_root.type).toBe(View);
-//   expect(screen.UNSAFE_root.props.testID).toBe('inner');
-// });
-
-test('container displays deprecation', () => {
+test('returns container', () => {
   render(<View testID="inner" />);
 
-  expect(() => (screen as any).container).toThrowErrorMatchingInlineSnapshot(`
-    "'container' property has been renamed to 'UNSAFE_root'.
-
-    Consider using 'root' property which returns root host element."
-  `);
+  expect(screen.container).toBeDefined();
+  expect(screen.container.type).toBe('CONTAINER');
+  expect(screen.container.props).toEqual({});
 });
 
 test('RenderAPI type', () => {

src/__tests__/screen.test.tsx

@@ -53,7 +53,7 @@ test('screen works with nested re-mounting rerender', () => {
 
 test('screen throws without render', () => {
   expect(() => screen.root).toThrow('`render` method has not been called');
-  expect(() => screen.UNSAFE_root).toThrow('`render` method has not been called');
+  expect(() => screen.container).toThrow('`render` method has not been called');
   expect(() => screen.debug()).toThrow('`render` method has not been called');
   expect(() => screen.debug.shallow()).toThrow('`render` method has not been called');
   expect(() => screen.getByText('Mt. Everest')).toThrow('`render` method has not been called');

src/helpers/__tests__/component-tree.test.tsx

@@ -37,15 +37,15 @@ describe('getHostSiblings()', () => {
   });
 });
 
-describe('getUnsafeRootElement()', () => {
-  it('returns UNSAFE_root for mounted view', () => {
+describe('getRootElement()', () => {
+  it('returns container for mounted view', () => {
     render(
       <View>
         <View testID="view" />
       </View>,
     );
 
     const view = screen.getByTestId('view');
-    expect(getRootElement(view)).toEqual(screen.UNSAFE_root);
+    expect(getRootElement(view)).toEqual(screen.container);
   });
 });

src/matchers/__tests__/utils.test.tsx

@@ -25,7 +25,7 @@ test('checkHostElement allows rejects composite element', () => {
 
   expect(() => {
     // @ts-expect-error
-    checkHostElement(screen.UNSAFE_root, fakeMatcher, {});
+    checkHostElement(screen.container, fakeMatcher, {});
   }).toThrow(/value must be a host element./);
 });
 

src/matchers/to-be-on-the-screen.tsx

@@ -9,7 +9,7 @@ export function toBeOnTheScreen(this: jest.MatcherContext, element: HostElement)
     checkHostElement(element, toBeOnTheScreen, this);
   }
 
-  const pass = element === null ? false : screen.UNSAFE_root === getRootElement(element);
+  const pass = element === null ? false : screen.container === getRootElement(element);
 
   const errorFound = () => {
     return `expected element tree not to contain element, but found\n${formatElement(element)}`;

src/render.tsx

@@ -111,23 +111,10 @@ function buildRenderResult(
     get root(): HostElement {
       return renderer.root;
     },
-    UNSAFE_root: instance,
+    container: instance,
   };
 
-  // Add as non-enumerable property, so that it's safe to enumerate
-  // `render` result, e.g. using destructuring rest syntax.
-  Object.defineProperty(result, 'container', {
-    enumerable: false,
-    get() {
-      throw new Error(
-        "'container' property has been renamed to 'UNSAFE_root'.\n\n" +
-          "Consider using 'root' property which returns root host element.",
-      );
-    },
-  });
-
   setRenderResult(result);
-
   return result;
 }
 

src/screen.ts

@@ -21,7 +21,7 @@ const defaultScreen: Screen = {
   get root(): HostElement {
     throw new Error(SCREEN_ERROR);
   },
-  get UNSAFE_root(): HostElement {
+  get container(): HostElement {
     throw new Error(SCREEN_ERROR);
   },
   debug: notImplementedDebug,