From d03604797f8f59b1c6dd40689a8174e29f179acd Mon Sep 17 00:00:00 2001
From: toter3 <toter3@gmail.com>
Date: Wed, 22 Mar 2023 14:01:09 +0200
Subject: [PATCH] add accessibility and testId props and virtual nodes to
 support e2e tests tools (#2001)

PR adding accessibility and testId props and virtual nodes to support e2e tests tools and provide general accessibility support.

Co-authored-by: yonatan.altaraz <yonatan.altaraz@khealth.ai>
Co-authored-by: galkahana <gal.kahana@hotmail.com>
---
 .../horcrux/svg/RenderableViewManager.java    | 15 +++++++
 .../main/java/com/horcrux/svg/SvgView.java    | 11 +++++
 .../java/com/horcrux/svg/VirtualView.java     | 44 +++++++++++++++++++
 apple/RNSVGNode.h                             |  3 ++
 apple/RNSVGNode.mm                            | 12 +++++
 apple/ViewManagers/RNSVGNodeManager.mm        |  4 ++
 src/lib/extract/extractProps.ts               | 18 ++++++++
 src/lib/extract/types.ts                      |  3 ++
 8 files changed, 110 insertions(+)

diff --git a/android/src/main/java/com/horcrux/svg/RenderableViewManager.java b/android/src/main/java/com/horcrux/svg/RenderableViewManager.java
index d6ca09be..b28a18f2 100644
--- a/android/src/main/java/com/horcrux/svg/RenderableViewManager.java
+++ b/android/src/main/java/com/horcrux/svg/RenderableViewManager.java
@@ -480,6 +480,21 @@ class VirtualViewManager<V extends VirtualView> extends ViewGroupManager<Virtual
     node.setName(name);
   }
 
+  @ReactProp(name = "accessible")
+  public void setAccessible(VirtualView node, boolean accessible) {
+      node.setAccessible(accessible);
+  }
+
+  @ReactProp(name = "accessibilityLabel")
+  public void setAccessibilityLabel(VirtualView node, String accessibilityLabel) {
+      node.setAccessibilityLabel(accessibilityLabel);
+  }
+
+  @ReactProp(name = "testID")
+  public void setTestID(VirtualView node, String testID) {
+      node.setTestID(testID);
+  }
+
   @ReactProp(name = "display")
   public void setDisplay(V node, String display) {
     node.setDisplay(display);
diff --git a/android/src/main/java/com/horcrux/svg/SvgView.java b/android/src/main/java/com/horcrux/svg/SvgView.java
index ad3c476f..b14de975 100644
--- a/android/src/main/java/com/horcrux/svg/SvgView.java
+++ b/android/src/main/java/com/horcrux/svg/SvgView.java
@@ -19,6 +19,7 @@ import android.graphics.Typeface;
 import android.util.Base64;
 import android.view.View;
 import android.view.ViewParent;
+import android.view.accessibility.AccessibilityNodeInfo;
 import com.facebook.react.bridge.Dynamic;
 import com.facebook.react.bridge.ReactContext;
 import com.facebook.react.uimanager.DisplayMetricsHolder;
@@ -72,6 +73,16 @@ public class SvgView extends ReactViewGroup implements ReactCompoundView, ReactC
     SvgViewManager.setSvgView(id, this);
   }
 
+  @Override
+  public void onInitializeAccessibilityNodeInfo (AccessibilityNodeInfo info) {
+    super.onInitializeAccessibilityNodeInfo(info);
+
+    Rect r = new Rect();
+    boolean isVisible = this.getGlobalVisibleRect(r);
+    info.setVisibleToUser(isVisible);
+    info.setClassName(this.getClass().getCanonicalName());
+  }
+
   @Override
   public void invalidate() {
     super.invalidate();
diff --git a/android/src/main/java/com/horcrux/svg/VirtualView.java b/android/src/main/java/com/horcrux/svg/VirtualView.java
index 4fa8417d..4859040a 100644
--- a/android/src/main/java/com/horcrux/svg/VirtualView.java
+++ b/android/src/main/java/com/horcrux/svg/VirtualView.java
@@ -9,8 +9,10 @@ import android.graphics.Paint;
 import android.graphics.Path;
 import android.graphics.RectF;
 import android.graphics.Region;
+import android.graphics.Rect;
 import android.view.View;
 import android.view.ViewParent;
+import android.view.accessibility.AccessibilityNodeInfo;
 import com.facebook.common.logging.FLog;
 import com.facebook.react.bridge.Dynamic;
 import com.facebook.react.bridge.ReactContext;
@@ -107,6 +109,33 @@ public abstract class VirtualView extends ReactViewGroup {
     mPointerEvents = pointerEvents;
   }
 
+  @Override
+  public void onInitializeAccessibilityNodeInfo (AccessibilityNodeInfo info) {
+    super.onInitializeAccessibilityNodeInfo(info);
+    if (mClientRect != null) {
+
+    SvgView root = getSvgView();
+
+    int[] rootPositionOnScreen = new int[2];
+    getSvgView().getLocationOnScreen(rootPositionOnScreen);
+    Rect infoBoundsInScreen = new Rect();
+    infoBoundsInScreen.left = rootPositionOnScreen[0] + (int) Math.floor(mClientRect.left);
+    infoBoundsInScreen.top = rootPositionOnScreen[1] + (int) Math.floor(mClientRect.top);
+    infoBoundsInScreen.right = infoBoundsInScreen.left + (int) Math.ceil(mClientRect.width());
+    infoBoundsInScreen.bottom = infoBoundsInScreen.top + (int) Math.ceil(mClientRect.height());
+
+    Rect rootVisibleRect = new Rect();
+    boolean isRootVisible = root.getGlobalVisibleRect(rootVisibleRect);
+    boolean infoIsVisibleToUser = isRootVisible && infoBoundsInScreen.intersect(rootVisibleRect);
+
+
+    String infoClassName = this.getClass().getCanonicalName();
+    info.setBoundsInScreen(infoBoundsInScreen);
+    info.setClassName(infoClassName);
+    info.setVisibleToUser(infoIsVisibleToUser);
+    }
+  }
+
   @Override
   public void invalidate() {
     if (this instanceof RenderableView && mPath == null) {
@@ -244,6 +273,21 @@ public abstract class VirtualView extends ReactViewGroup {
     invalidate();
   }
 
+  public void setAccessible(boolean accessible) {
+      this.setFocusable(accessible);
+      invalidate();
+  }
+
+  public void setAccessibilityLabel(String accessibilityLabel) {
+      this.setContentDescription(accessibilityLabel);
+      invalidate();
+  }
+
+  public void setTestID(String testID) {
+      this.setTag(testID);
+      invalidate();
+  }
+
   public void setDisplay(String display) {
     mDisplay = display;
     invalidate();
diff --git a/apple/RNSVGNode.h b/apple/RNSVGNode.h
index 3c65e102..f2eef958 100644
--- a/apple/RNSVGNode.h
+++ b/apple/RNSVGNode.h
@@ -74,6 +74,9 @@ extern CGFloat const RNSVG_DEFAULT_FONT_SIZE;
 @property (nonatomic, assign) CGRect markerBounds;
 @property (nonatomic, copy) RCTDirectEventBlock onLayout;
 
+@property (nonatomic, copy) NSString *testID;
+@property (nonatomic, assign) BOOL accessible;
+
 /**
  * RNSVGSvgView which ownes current RNSVGNode
  */
diff --git a/apple/RNSVGNode.mm b/apple/RNSVGNode.mm
index 37a023f7..8fc3cb87 100644
--- a/apple/RNSVGNode.mm
+++ b/apple/RNSVGNode.mm
@@ -190,6 +190,18 @@ CGFloat const RNSVG_DEFAULT_FONT_SIZE = 12;
   _name = name;
 }
 
+- (void)setTestID:(NSString *)testID
+{
+    self.accessibilityIdentifier = testID;
+    [self invalidate];
+}
+
+- (void)setAccessible:(BOOL)accessible
+{
+    self.isAccessibilityElement = accessible;
+    [self invalidate];
+}
+
 - (void)setDisplay:(NSString *)display
 {
   if ([display isEqualToString:_display]) {
diff --git a/apple/ViewManagers/RNSVGNodeManager.mm b/apple/ViewManagers/RNSVGNodeManager.mm
index f670bc01..5effd183 100644
--- a/apple/ViewManagers/RNSVGNodeManager.mm
+++ b/apple/ViewManagers/RNSVGNodeManager.mm
@@ -45,6 +45,10 @@ RCT_EXPORT_VIEW_PROPERTY(clipRule, RNSVGCGFCRule)
 RCT_EXPORT_VIEW_PROPERTY(responsible, BOOL)
 RCT_EXPORT_VIEW_PROPERTY(onLayout, RCTDirectEventBlock)
 
+RCT_EXPORT_VIEW_PROPERTY(testID, NSString)
+RCT_EXPORT_VIEW_PROPERTY(accessibilityLabel, NSString)
+RCT_EXPORT_VIEW_PROPERTY(accessible, BOOL)
+
 RCT_CUSTOM_SHADOW_PROPERTY(top, id, RNSVGNode) {}
 RCT_CUSTOM_SHADOW_PROPERTY(right, id, RNSVGNode) {}
 RCT_CUSTOM_SHADOW_PROPERTY(start, id, RNSVGNode) {}
diff --git a/src/lib/extract/extractProps.ts b/src/lib/extract/extractProps.ts
index 0b600675..d04ed3de 100644
--- a/src/lib/extract/extractProps.ts
+++ b/src/lib/extract/extractProps.ts
@@ -49,6 +49,9 @@ export default function extractProps(
     display?: string;
     opacity?: NumberProp;
     onLayout?: () => void;
+    testID?: string;
+    accessibilityLabel?: string;
+    accessible?: boolean;
   } & TransformProps &
     ResponderProps &
     StrokeProps &
@@ -68,6 +71,9 @@ export default function extractProps(
     markerStart = marker,
     markerMid = marker,
     markerEnd = marker,
+    testID,
+    accessibilityLabel,
+    accessible,
   } = props;
   const extracted: extractedProps = {};
 
@@ -111,6 +117,18 @@ export default function extractProps(
     extracted.name = String(id);
   }
 
+  if (testID) {
+    extracted.testID = String(testID);
+  }
+
+  if (accessibilityLabel) {
+    extracted.accessibilityLabel = String(accessibilityLabel);
+  }
+
+  if (accessible) {
+    extracted.accessible = Boolean(accessible);
+  }
+
   if (clipRule) {
     extracted.clipRule = clipRules[clipRule] === 0 ? 0 : 1;
   }
diff --git a/src/lib/extract/types.ts b/src/lib/extract/types.ts
index 56551e50..a86eb120 100644
--- a/src/lib/extract/types.ts
+++ b/src/lib/extract/types.ts
@@ -276,6 +276,9 @@ export type extractedProps = {
   clipPath?: string;
   clipRule?: number;
   display?: string;
+  testID?: string;
+  accessibilityLabel?: string;
+  accessible?: boolean;
   [touchableProperty: string]: unknown;
 };