From 15526b8c1d85c78777b05fae7c630a26fd5a0657 Mon Sep 17 00:00:00 2001
From: Eric Lau <ericglau@outlook.com>
Date: Fri, 24 Nov 2023 17:52:32 -0500
Subject: [PATCH] Replace using-for directives with dummy enums

---
 .../core/src/utils/make-namespaced.test.ts    |  10 ++++++----
 .../core/src/utils/make-namespaced.test.ts.md |   4 ++--
 .../src/utils/make-namespaced.test.ts.snap    | Bin 1205 -> 1236 bytes
 packages/core/src/utils/make-namespaced.ts    |  15 ++++++++++++---
 4 files changed, 20 insertions(+), 9 deletions(-)

diff --git a/packages/core/src/utils/make-namespaced.test.ts b/packages/core/src/utils/make-namespaced.test.ts
index 3f938bc37..d2434f239 100644
--- a/packages/core/src/utils/make-namespaced.test.ts
+++ b/packages/core/src/utils/make-namespaced.test.ts
@@ -35,7 +35,7 @@ async function testMakeNamespaced(
   const origInput = JSON.parse(JSON.stringify(origBuildInfo.input));
 
   const modifiedInput = makeNamespacedInput(origBuildInfo.input, origBuildInfo.output);
-  normalizeStateVariableNames(modifiedInput);
+  normalizeIdentifiers(modifiedInput);
   t.snapshot(modifiedInput);
 
   t.deepEqual(origBuildInfo.input, origInput);
@@ -46,12 +46,14 @@ async function testMakeNamespaced(
   t.is(modifiedOutput.errors, undefined);
 }
 
-function normalizeStateVariableNames(input: SolcInput): void {
+function normalizeIdentifiers(input: SolcInput): void {
   for (const source of Object.values(input.sources)) {
     if (source.content !== undefined) {
       source.content = source.content
-        .replace(/\$MainStorage_\d{1,6};/g, '$MainStorage_random;')
-        .replace(/\$SecondaryStorage_\d{1,6}/g, '$SecondaryStorage_random');
+        .replace(/\$MainStorage_\d{1,6}/g, '$MainStorage_random')
+        .replace(/\$SecondaryStorage_\d{1,6}/g, '$SecondaryStorage_random')
+        .replace(/\$UsingForDirective_\d+_\d{1,6}/, '$UsingForDirective_1_random')
+        .replace(/\$UsingForDirective_\d+_\d{1,6}/, '$UsingForDirective_2_random');
     }
   }
 }
diff --git a/packages/core/src/utils/make-namespaced.test.ts.md b/packages/core/src/utils/make-namespaced.test.ts.md
index d478ae695..7210fa3a2 100644
--- a/packages/core/src/utils/make-namespaced.test.ts.md
+++ b/packages/core/src/utils/make-namespaced.test.ts.md
@@ -123,10 +123,10 @@ Generated by [AVA](https://avajs.dev).
           /**␊
            * @param foo foo␊
            */␊
-          ␊
+          enum $UsingForDirective_1_random { dummy }␊
           ␊
           contract UsingForDirectives {␊
-            ␊
+            enum $UsingForDirective_2_random { dummy }␊
           ␊
             ␊
           }␊
diff --git a/packages/core/src/utils/make-namespaced.test.ts.snap b/packages/core/src/utils/make-namespaced.test.ts.snap
index 670298e761e86c8ee9a187a8e96e267d45ac5ccc..b35b1938cc9c47e8757eb3f4944a0086a6e73395 100644
GIT binary patch
literal 1236
zcmV;_1S|VNRzV<BZeeh9Xm4~Nb~6eC08t7VX?s4%SU^jmmTevBPykl@<%^1|I+89k
zFI~kIX&;LS00000000BcR?Tl4MHJtUq_G!@Q$U<JjG`106Mw{r1SNn{B`HM82VfV0
zR1uAL$LSF7jx{qIVnT}Gz=0Dd1c*x!C;kHt2q6yij8v%-966vOA;gIryq#U!>s^~|
zP?50o*0b||@6B)Cn|<?cw3=;ZABy)rCz8rG@m+jKkcV9&I@l%-qF%?BRCu@}t}!Xz
zz2P`m;@9$@n%a~W{PdhYu>}9mfDn*(KpxW1UC__%HQyk%)b;*wdU{&Z&uhA==>@<T
z4+o>k3wo}Ny#pT~kp4uSwW&j8SJNNR^^d`0Un7W=)H@JL^L<P+C791`A{3!NK=CIC
z(lu>WPY^PO3FUP2DnObbpCqBVOzsvra$g}_Q0DcfCOeqZkl<~7KrqiblDhOQ!j;N2
z2C4${C4{+7+OQIMQY#q>R*b<e+RT$2+fq~{5wfz|Pg8^KFo(9fWx?9Y?4_7lDbsAr
z?JzEh6PiOnj=}so$Y(|(AZ9Xl##aFOCJCEJ!F~Y9?IbLpg582c_2X0mW~H)VB(g9?
zJlt#(N4*<`gm!}ao=`6n#!XE*&{dSa&JCiZ7ki3f&q45rC!=@cr-@1h)nD9rwX{ub
z;t5jPazIU6l<*a_v(>OV93QwCiRcKU*Q@2H%eCsNW%craHjlB}X%lo}A^26m<C^UY
z$=nrqfH^6_M~Q=zfC#sjYt_XS5}K4<Og&{KB=^D94!qYxqsU$G^Qk9mPc5P2)znls
zoH`w{oQ=KgbL=_H1-@q{CkSlO!Mq!1Sno}ar-{=vn?0H-^V#IgFyZhqdKixzSgXN_
zS`yYnr@bAcLt@+b5NOQdCM^@sW)7K)n9U88Gx4O%%+I3|T7>6g=z6mYU)qzkzD@PG
z)taAQjT4GJRg66*;XnaB*i4&wK@pasL+sR60IWb*p&S+=D#c<L#A3_`Xpt)Lk*bm%
zqtn<qeF2NhzNbo(%9@qXUlCA>`v@x127vBm6s!Vb5?$tm^iaw}Soau5&!XTnNg1r~
z?baKYb{qRw>RY?d@7FiCH`g0`FGuh;ZE`paXqz^}HIppY!H@3}KG4Qcsl_^NUo_ri
zk@GS7Yp{hL!m?E8i)an%K6X)yu|TXK+Qjo+G#iGA@eRs@`hG<A7o#%^r_b?Sw~NwI
zjlqRtKF(Kdgs*UKBO<9j<W0^Q-}9xQ4q5N5s&;c%CGcDA-<LqDZW?qlCZ!9#@GlJF
zyzmdKPf?4*&S%PF?!uXoRrl0Vm)tK<{eJ`bE0?%$CP&>ja9uo@?_U?1npn;c-yd*+
zU4^M;K5{sDiF4c?j0%N<0v!S1?F49Q2xO@=+#jT&zk-Q{9IZJYRpxEng-#-B<&M$F
zUJi;B1ja_y@^ZSZGjIMM+Pd$?v~}hkQ2Y*ZUuH{ZEC8gI-Oh!HJsjVreWYi!X;CK;
zgFT+vZ&jE3oz~A_cn2hx-DzC}$P?L})^h;a$mq20T?_TAapo54{WI4OIIHC)xIORf
y&7|W0h^c9hf|Sg=ECOq0q6iQ(RRlhOsSnMJBJc$OzBK=<BJej0QuCGB4FCX!OI6GO

literal 1205
zcmV;m1WNlsRzV<BZeeh9Xm4~Nb~6eC0AybdZwuamp|?E?Xd|`?r7&W!V<s+qy?P_M
z&6=6&ARmhe00000000BcR?TnRL=^W&(rgUvrUG%|Fp648mh4A^NKgVORX!k6K7idK
zkPy+VJ(~`(J*$~<$r7cg8~}0RfDj-qMV#O--~b45pl43K!>L>lCyqRi?Om_Ei(6DA
zR(js?yx)8C=DqQ6-px+iW%iMH_e&zFbV=ahBZ7SF5z)mqaS-*pfuzF6U2&C3apR`r
zV2NLw-ZHf*E&S;vePRjzp8+8t?|?j{pE<9e*>Ar|Y^m%0;mpj8rk~YxQ`5_UF&+*_
zljrr4i~Yj@ACmq=leyHPvZv|ibp2EC*w+XmCG`)5()^s#ObHfnn+O%qpP={)1nHW#
zs%HW+h65_;=Ia1ygM5~SmI`CH$Tja3!Ubi1GBw%7oJIlO)&~Jjv#z8beVcHlGL3<%
z%mN8%ZW0$(0#9lsL%}L3*hQQ9l4Dznx+Fr@_xfdOv0diSPOm1ItIS?XnN<tTw!JRn
zk~on$B;**(uY-JHWD;U#b7y=DkRP(Ji5%<~fZWc)rgN|xaH!s&%D}8#6^u+3rihQ*
zE^*YmQO;;5c;E~5GGW}(lmlI5iIxUg(kqE#*mIaX;>-Bm_+X-5N6i;EUajs>oA`oM
zw;fQ^4kdgA?QXZMF2{!+Mj}4K=#570>Dppr)v}U0pv`0KbzOo^ECjzgcwDmsA(^)V
z4=^WH_$YCB5)k3`@?zuC3W-c=9;Uvs5|RhtY8T#{kx}d}`~}pPi%%_~<JH_$FPb_X
zvb>ObIpElLm<RFRb8v#d79Grc=?I(2<oGagKFoF!X3qRVc4j!>=rMYj&Kp>(!HHTD
z)<dVsj?odZZF~e_%;7ez5#MGGnTsQv8z^VfMVXzSM^$tQo{ypH?H+t-PcHUt8poZ^
z{QPP<pwv_4*k=+B6odzxahV^IuoPWl=e7c11;PsDuozLVRH7tSQa(V76v4-;dU1|U
zQ|I&rEVcq)QIe{fmC;`jK*fCo6?p?dClv*&FffU>I3Wp2d5CzAar7(-Ka-rn`u<+C
zb$PFKaHYAu_xwR~b7ynCwf}MqcWIl$VL&^y9j%#-avl5x9^nIR3YA-|>jt9r7K@#a
z(O-ovBnZn=sjr|l;C<|&4r8HMD%;syF}^{0Nb=W+7>ahpuGL4k$vNZuffUps>xnP5
z@?Fu@kJ`VdE2?e<bTTIW3rVUL202;yhp10chcge&*2dghvm+Vu)KVAH$H3H|gM3rU
z+zpeX?gpUt?+4Vbsfk}RTo0E`X<F0HO~(!=FLRE2gHgF$R-jn`%w<4RLm*3);lZ#B
z{S{0s<Y>*=m_>JR4{rUq?K(yy`z|09NQ{jdwdH&ZX5RWgv|vAtX~E1pp!fsifx`C7
zSOCakaqATo_Go-d^@(24Qbo7^cPZH8g}qT@x!)E228MS)O2u8#MSwg}+!Z|skd1<_
z=>D}kzZ>`5?!0%;`~hdRwgflb{k=t0{vR<l?NN}bd6y)xW@bo$m^l*o5T-sd3rOHA
T0DNu!S0wN^lI2kFg$)1zto2F%

diff --git a/packages/core/src/utils/make-namespaced.ts b/packages/core/src/utils/make-namespaced.ts
index d53c1a31b..c28f2abb2 100644
--- a/packages/core/src/utils/make-namespaced.ts
+++ b/packages/core/src/utils/make-namespaced.ts
@@ -72,8 +72,11 @@ export function makeNamespacedInput(input: SolcInput, output: SolcOutput): SolcI
                 modifications.push(makeDelete(contractNode, orig));
                 break;
               }
+              // - UsingForDirective isn't needed, but it might have NatSpec documentation which is not included in the AST.
+              //   We convert it to a dummy enum to avoid orphaning any possible documentation.
               case 'UsingForDirective': {
-                modifications.push(makeDelete(contractNode, orig));
+                const insertText = getUsingForReplacement(contractNode.id);
+                modifications.push(makeReplace(contractNode, orig, insertText));
                 break;
               }
               case 'StructDefinition': {
@@ -99,9 +102,11 @@ export function makeNamespacedInput(input: SolcInput, output: SolcOutput): SolcI
           }
           break;
         }
-        // - UsingFor can be deleted since its result only takes effect in functions
+        // - UsingForDirective isn't needed, but it might have NatSpec documentation which is not included in the AST.
+        //   We convert it to a dummy enum to avoid orphaning any possible documentation.
         case 'UsingForDirective': {
-          modifications.push(makeDelete(node, orig));
+          const insertText = getUsingForReplacement(node.id);
+          modifications.push(makeReplace(node, orig, insertText));
           break;
         }
         // - ErrorDefinition, FunctionDefinition, and VariableDeclaration might be imported by other files, so they cannot be deleted.
@@ -157,6 +162,10 @@ interface Modification {
   text?: string;
 }
 
+function getUsingForReplacement(astId: number) {
+  return `enum $UsingForDirective_${astId}_${(Math.random() * 1e6).toFixed(0)} { dummy }`;
+}
+
 function getPositions(node: Node) {
   const [start, length] = node.src.split(':').map(Number);
   const end = start + length;