From b2fea4d5b3aef4a4df4ccecca7cf7f5a30659e40 Mon Sep 17 00:00:00 2001 From: LongYinan Date: Thu, 2 Dec 2021 16:25:20 +0800 Subject: [PATCH] fix(napi-derive): correct the aliased type generation --- crates/backend/src/typegen.rs | 20 ++++++++++++++++++-- crates/backend/src/typegen/const.rs | 3 ++- crates/backend/src/typegen/enum.rs | 3 ++- crates/backend/src/typegen/struct.rs | 3 ++- crates/macro/src/parser/attrs.rs | 7 +++---- examples/napi/__test__/typegen.spec.ts.md | 9 +++++++++ examples/napi/__test__/typegen.spec.ts.snap | Bin 1873 -> 1932 bytes examples/napi/__test__/values.spec.ts | 12 ++++++++++++ examples/napi/index.d.ts | 9 +++++++++ examples/napi/src/object.rs | 17 +++++++++++++++++ 10 files changed, 74 insertions(+), 9 deletions(-) diff --git a/crates/backend/src/typegen.rs b/crates/backend/src/typegen.rs index 2b86c926..e606fd09 100644 --- a/crates/backend/src/typegen.rs +++ b/crates/backend/src/typegen.rs @@ -3,7 +3,7 @@ mod r#enum; mod r#fn; pub(crate) mod r#struct; -use std::collections::HashMap; +use std::{cell::RefCell, collections::HashMap}; use once_cell::sync::Lazy; use syn::Type; @@ -17,6 +17,16 @@ pub struct TypeDef { pub js_doc: String, } +thread_local! { + static ALIAS: RefCell> = Default::default(); +} + +fn add_alias(name: String, alias: String) { + ALIAS.with(|aliases| { + aliases.borrow_mut().insert(name, alias); + }); +} + pub fn js_doc_from_comments(comments: &[String]) -> String { if comments.is_empty() { return "".to_owned(); @@ -248,7 +258,13 @@ pub fn ty_to_ts_type(ty: &Type, is_return_ty: bool) -> (String, bool) { )); } else { // there should be runtime registered type in else - ts_ty = Some((rust_ty, false)); + let type_alias = ALIAS.with(|aliases| { + aliases + .borrow() + .get(rust_ty.as_str()) + .map(|a| (a.to_owned(), false)) + }); + ts_ty = type_alias.or_else(|| Some((rust_ty, false))); } } diff --git a/crates/backend/src/typegen/const.rs b/crates/backend/src/typegen/const.rs index 5ac266be..29343d3a 100644 --- a/crates/backend/src/typegen/const.rs +++ b/crates/backend/src/typegen/const.rs @@ -1,9 +1,10 @@ use super::{ToTypeDef, TypeDef}; -use crate::{js_doc_from_comments, ty_to_ts_type, NapiConst}; +use crate::{js_doc_from_comments, ty_to_ts_type, typegen::add_alias, NapiConst}; impl ToTypeDef for NapiConst { fn to_type_def(&self) -> TypeDef { + add_alias(self.name.to_string(), self.js_name.to_string()); TypeDef { kind: "const".to_owned(), name: self.js_name.to_owned(), diff --git a/crates/backend/src/typegen/enum.rs b/crates/backend/src/typegen/enum.rs index 3046c648..eeabbe53 100644 --- a/crates/backend/src/typegen/enum.rs +++ b/crates/backend/src/typegen/enum.rs @@ -1,8 +1,9 @@ -use super::{ToTypeDef, TypeDef}; +use super::{add_alias, ToTypeDef, TypeDef}; use crate::{js_doc_from_comments, NapiEnum}; impl ToTypeDef for NapiEnum { fn to_type_def(&self) -> TypeDef { + add_alias(self.name.to_string(), self.js_name.to_string()); TypeDef { kind: "enum".to_owned(), name: self.js_name.to_owned(), diff --git a/crates/backend/src/typegen/struct.rs b/crates/backend/src/typegen/struct.rs index d44a8b24..c592bf8b 100644 --- a/crates/backend/src/typegen/struct.rs +++ b/crates/backend/src/typegen/struct.rs @@ -1,7 +1,7 @@ use std::cell::RefCell; use std::collections::HashMap; -use super::{ToTypeDef, TypeDef}; +use super::{add_alias, ToTypeDef, TypeDef}; use crate::{js_doc_from_comments, ty_to_ts_type, NapiImpl, NapiStruct, NapiStructKind}; thread_local! { @@ -15,6 +15,7 @@ impl ToTypeDef for NapiStruct { c.borrow_mut() .insert(self.name.to_string(), self.js_name.clone()); }); + add_alias(self.name.to_string(), self.js_name.to_string()); TypeDef { kind: String::from(if self.kind == NapiStructKind::Object { "interface" diff --git a/crates/macro/src/parser/attrs.rs b/crates/macro/src/parser/attrs.rs index a04da0ef..111135d5 100644 --- a/crates/macro/src/parser/attrs.rs +++ b/crates/macro/src/parser/attrs.rs @@ -1,9 +1,8 @@ +use std::cell::{Cell, RefCell}; +use std::collections::HashMap; + use napi_derive_backend::{bail_span, BindgenResult, Diagnostic}; use proc_macro2::{Delimiter, Ident, Span, TokenTree}; -use std::{ - cell::{Cell, RefCell}, - collections::HashMap, -}; use syn::spanned::Spanned; thread_local! { diff --git a/examples/napi/__test__/typegen.spec.ts.md b/examples/napi/__test__/typegen.spec.ts.md index 546498dd..4b3b4e40 100644 --- a/examples/napi/__test__/typegen.spec.ts.md +++ b/examples/napi/__test__/typegen.spec.ts.md @@ -78,6 +78,15 @@ Generated by [AVA](https://avajs.dev). age?: number | undefined | null␊ }␊ export function receiveAllOptionalObject(obj?: AllOptionalObject | undefined | null): void␊ + export enum ALIAS {␊ + A = 0,␊ + B = 1␊ + }␊ + export interface AliasedStruct {␊ + a: ALIAS␊ + b: number␊ + }␊ + export function fnReceivedAliased(s: AliasedStruct, e: ALIAS): void␊ export function asyncPlus100(p: Promise): Promise␊ /** This is an interface for package.json */␊ export interface PackageJson {␊ diff --git a/examples/napi/__test__/typegen.spec.ts.snap b/examples/napi/__test__/typegen.spec.ts.snap index 8852cae6e3ea2a768385a88b906727190f2a3f7f..b73f0fe81fb13d3e92602bcefe849a7fbb51cd12 100644 GIT binary patch literal 1932 zcmV;72XpvARzVmJg#mVce`~w5|ETwJb9b-TCNfJxmKGHKOh$$) zNe0Y3Q)#S&W}9@JAoT`v*pEU|>JuV-kR zwFaVhwz*&(J(5u{q~-|RVNC>{C#g!fW_LESe!og1MW)A@FuZrF0-6pAH6CxBwILrs zd^>R*&^FoNgB@vFBrJx_Vo>6Xz+%JPW^gsKowd~qD8av*r*RNbAwn7*w+S9(aqIxjRh+;N?{NxB^Z?@^#Bu=_G!cj+;w}YPs-ZPYxJ#Nst-mWccK*o z49=whYrxFcLDOSDcB>yOS);TDqBOqcC-B;S5dQm8`Gnk|fR#^(;RUGf} zGZ?PnaElL)(Ei&v>2fRQGt12ImMkq+1q#&m)XvIsz}nNs)FaUxrRvn)lb{aqE&~*0 zBGCM6=Am__eAH#BX(8_V1n5yFjh85Aq!l^7BGruTVfmoWl=`zLneh*HnV=S;;7i;e zAHLFGMn7eeCJgiO8vu|h7|8kfb{`y;*v`(5)>b=$Q(fFNS1sxjZbFB(u}PPQ zse;7=p+bly(3sJXsXiIlg(}kh!V|T~w;hA9(!S7L&smd9+7ZIVpg@bg_Za?*stl0O z0lO$<71uju5#uMUq!HZ+qRN(30>MA1&03vDJDojib*IRu8<=4x7Wk(Hc(NF-Zm(prS&qUxeyo1`Zq(@Tqs!LZaARkTV|-KX@WprPDF zV>h-46n;?PRe-#isFDy-16V=ijH&C@0r9@+FRfjj{1JunzH}9O&CH&C>Fh{MNbc2B zyngD_lS^Ta6TO~4o@U8Tq2E%O>4dPl34TkJ5YQ&pDO-tj^=eoCrqMq{N z0X9eG$t(K`#}us6S40h6zJ>((%B{YFgz;6z@jV7Hg<{VHwAe!=({8%xw{PX77f`)}_7ZiBy^LYnSae`}1>};Y)FNg!f*XP!v*nG? zsRmrwK>Ge-qu`j0+BsDS^JaURWm34NY51z7a2?yB<`H~7Z4}Tyl2nsdUs}$2vJpu$9`Xa@Ap0&(r7epG~WLHgFk-%>%}iW zee&r)fByFC&o>(Q@5A>Sjkg=`+Vzch8t=W;eE;?WVOnr$ZpB>FP%yG^yV+#tBb6Ew z392>OJ~u3tRP2SXS!C|?H^`eNAt|G=l449g{82?i-_a)Ja=2ktJYYr>trC{AYfp(UqL(F}1V_73BGg%83E^DN(Y9(0 zMDOfy!Mb`ZqhLhMF}TB;2s}?xm2l1OY-WQ&l}3t8k27I-|4aom9TsXl-a2bTK7{yo z<2axlvdM?L(zHofEL+8*#210ZhPlJwdStunYnM=hf49!!AfiHqG&<=JyvWkT3*_zw zIaNFc0r<nq!CGcQl+2vh#<)3V>AvOPOM5mb0hgo9cv2_9s|5>O zP;OgM1@nYwPD+ght2Iht5h^7Zl_m866P6BW#0ccNP3qIKwu>5lYgg)n708`x#Q=kI zDZrXA*dwP@WDr%FGR%C#Wu~Aotgb-n8j2bL>14?ZvE_QmWo(T_d7CsnvB^!yeKiDt zEVc8Khg=8^$pAINoo`VC=gY-;pK3GCIkV^lk(Sq|7b*jLG7*yypmajuwqOt&5ekY2 z03f)UWM>nbGwp7&IB)4zrj5eVv5jA7@}6Xc4UpIt-MBnX8Sby*$BxQUSg+xFpP$2W z9hcjDc#QUch95m{<$P|L8D`1yQdOWpZC~xKt^}+zYfL>7&2g&EY@P&lh<6pBXcK|v z-!KoYbM2$9O3ey!=@XzwnKWLZoRe16_=-|9v4`c0I#cTJo@Bq9oyfeK%Dh_X&Dwe@NM0Vm?r@l?U$ zflwjD5@^hL#MFQc?M4;pLE(v7VWvb43^igPyUEP=Ul!Hy=G?LJ|cD{=DK@O6c3B~%y-qn zaiZ7rcgZ~28H_S2Gu;q&x4>_y5&|Z$nsRs5eA^#$7Z(>H$lz9h=;4u_U13$*m`bwx)9xRI|AV|8YN&XuV)kFe0a#tfvu_N$ zs)7?FzByQ3vE8ERlm}2+@~tahce9g7AG$>BWVL4G)JzK=eXe^)DC#LM-Zo9LKwjAg zZkk0#rLTw@xo!ys@|D|t1qI{ljN?-WVhVkf37B4uA|VvJEEGIyqZozr_Zc7sQhG>u zG6GVp*~Al%bRQk!dn)jDTSra*xozM3UC9$FCKI(Cuc5$Fw{2_d$NpI5ux1m~ysfs(Wir5GBwMfMHA$2DuqKN$?&pJhBOfB0OmrUTY~(0bs1`pyhP| zU2Ilp#lKT{s@-RT&+c0SN9;%?3CyEzAC+TkV~Kjr$=^Tz@SWX9^UjVHP56vj|4z<& z0RPNoz*=~+*z2@%pSt(QexgorOfXCviw>MzfLyYaTExspa8u9|wzByJ)qo2dNZ(&< z9GtLmC#MSGyVaRxnKrH&c|ZyC>f9NYHW-YpmV}N&)?+Nb*YVzb6&=+FLTlE%`%oc* z7=C!IAlHE!ECxKs&Rc^&pMjX295fZfgQu)l!a=7b!a=5r(m*(;2H>F{;qU^3`l?kt z^H;3yqumF+$J@Q>pRgtb{)oT&a(%6CzIP}BqUDv(rc4$?6_SAHazW40PUkmYhTC~w zT%sH;$DNHJO8Kls@~@IUTkP;W=0iYl;G1w! { @@ -208,6 +211,15 @@ test('option object', (t) => { t.notThrows(() => receiveAllOptionalObject({})) }) +test('aliased rust struct and enum', (t) => { + const a: ALIAS = ALIAS.A + const b: AliasedStruct = { + a, + b: 1, + } + t.notThrows(() => fnReceivedAliased(b, ALIAS.B)) +}) + test('serde-json', (t) => { const packageJson = readPackageJson() t.is(packageJson.name, 'napi-rs') diff --git a/examples/napi/index.d.ts b/examples/napi/index.d.ts index 216febe4..3e9dbb64 100644 --- a/examples/napi/index.d.ts +++ b/examples/napi/index.d.ts @@ -68,6 +68,15 @@ export interface AllOptionalObject { age?: number | undefined | null } export function receiveAllOptionalObject(obj?: AllOptionalObject | undefined | null): void +export enum ALIAS { + A = 0, + B = 1 +} +export interface AliasedStruct { + a: ALIAS + b: number +} +export function fnReceivedAliased(s: AliasedStruct, e: ALIAS): void export function asyncPlus100(p: Promise): Promise /** This is an interface for package.json */ export interface PackageJson { diff --git a/examples/napi/src/object.rs b/examples/napi/src/object.rs index 389ecefd..6faeca0c 100644 --- a/examples/napi/src/object.rs +++ b/examples/napi/src/object.rs @@ -42,3 +42,20 @@ fn receive_all_optional_object(obj: Option) -> Result<()> { } Ok(()) } + +#[napi(js_name = "ALIAS")] +pub enum AliasedEnum { + A, + B, +} + +#[napi(object, js_name = "AliasedStruct")] +pub struct StructContainsAliasedEnum { + pub a: AliasedEnum, + pub b: u32, +} + +#[napi] +fn fn_received_aliased(mut s: StructContainsAliasedEnum, e: AliasedEnum) { + s.a = e; +}