Design: الاقتراح: Async / Await JS API

تم تطوير هذا الاقتراح بالتعاون مع fmccabe و thibaudmichaud و lukewagner و kripken ، جنبًا إلى جنب مع التعليقات من Stacks Subgroup (مع تصويت غير رسمي بالموافقة على التقدم إلى المرحلة 0 اليوم). لاحظ أنه نظرًا لضيق الوقت ، فإن الخطة هي تقديم عرض تقديمي سريع جدًا (أي 5 دقائق) والتصويت للتقدم إلى المرحلة 1 في 3 أغسطس. لتسهيل ذلك ، نشجع الأشخاص بشدة على إثارة مخاوفهم هنا في وقت مبكر حتى نتمكن من تحديد ما إذا كانت هناك أي مخاوف كبيرة تستحق دفع العرض التقديمي + التصويت إلى تاريخ لاحق مع مزيد من الوقت.

الغرض من هذا الاقتراح هو توفير تفاعل فعال نسبيًا ومتوافقًا نسبيًا بين وعود JavaScript و WebAssembly ولكن مع العمل في ظل القيود التي تنص على أن التغييرات الوحيدة هي على JS API وليس إلى Core wasm.
من المتوقع أن يؤدي اقتراح Stack-Switching في النهاية إلى توسيع WebAssembly الأساسي بوظيفة تنفيذ العمليات التي نقدمها في هذا الاقتراح مباشرةً داخل WebAssembly ، جنبًا إلى جنب مع العديد من عمليات تبديل المكدس القيمة الأخرى ، ولكن حالة الاستخدام الخاصة هذه للتبديل المكدس كانت الاستعجال الكافي لاستحقاق مسار أسرع عبر JS API فقط.
لمزيد من المعلومات ، يرجى الرجوع إلى الملاحظات والشرائح الخاصة باجتماع المجموعة الفرعية Stack في 28 يونيو 2021 ، والتي توضح بالتفصيل سيناريوهات الاستخدام والعوامل التي أخذناها في الاعتبار وتلخص الأساس المنطقي لكيفية وصولنا إلى التصميم التالي.

تحديث: بعد التعليقات التي تلقتها مجموعة Stacks الفرعية من TC39 ، فإن هذا الاقتراح يسمح فقط بتعليق حزم WebAssembly - لا يُجري أي تغييرات على لغة JavaScript ، ولا يُمكّن بشكل غير مباشر الدعم المنفصل asycn / await في JavaScript.

يعتمد هذا (بشكل فضفاض) على اقتراح أنواع js ، والذي يقدم WebAssembly.Function كفئة فرعية من Function .

واجهه المستخدم

الاقتراح هو إضافة الواجهة والمنشئ والطرق التالية إلى JS API ، مع مزيد من التفاصيل حول دلالاتها أدناه.

interface Suspender {
   constructor();
   Function suspendOnReturnedPromise(Function func); // import wrapper
   // overloaded: WebAssembly.Function suspendOnReturnedPromise(WebAssembly.Function func);
   WebAssembly.Function returnPromiseOnSuspend(WebAssembly.Function func); // export wrapper
}

مثال

فيما يلي مثال على كيف نتوقع أن يستخدم المرء واجهة برمجة التطبيقات هذه.
في سيناريوهات الاستخدام الخاصة بنا ، وجدنا أنه من المفيد النظر في وحدات WebAssembly في أنها تشتمل على عمليات استيراد وتصدير "متزامنة" و "غير متزامنة".
تدعم واجهة برمجة تطبيقات JS الحالية عمليات الاستيراد والتصدير "المتزامنة" فقط.
تُستخدم أساليب واجهة Suspender لتغليف الواردات والصادرات ذات الصلة من أجل جعل "غير متزامن" ، حيث يربط كائن Suspender نفسه صراحةً هذه الواردات والصادرات معًا لتسهيل كل من التنفيذ والتركيب.

WebAssembly ( demo.wasm ):

(module
    (import "js" "init_state" (func $init_state (result f64)))
    (import "js" "compute_delta" (func $compute_delta (result f64)))
    (global $state f64)
    (func $init (global.set $state (call $init_state)))
    (start $init)
    (func $get_state (export "get_state") (result f64) (global.get $state))
    (func $update_state (export "update_state") (result f64)
      (global.set (f64.add (global.get $state) (call $compute_delta)))
      (global.get $state)
    )
)

نص ( data.txt ):

19827.987

جافا سكريبت:

var suspender = new Suspender();
var init_state = () => 2.71;
var compute_delta = () => fetch('data.txt').then(res => res.text()).then(txt => parseFloat(txt));
var importObj = {js: {
    init_state: init_state,
    compute_delta: suspender.suspendOnReturnedPromise(compute_delta)
}};

fetch('demo.wasm').then(response =>
    response.arrayBuffer()
).then(buffer =>
    WebAssembly.instantiate(buffer, importObj)
).then(({module, instance}) => {
    var get_state = instance.exports.get_state;
    var update_state = suspender.returnPromiseOnSuspend(instance.exports.update_state);
    ...
});

في هذا المثال ، لدينا وحدة WebAssembly التي تعد آلة حالة مبسطة للغاية - في كل مرة تقوم فيها بتحديث الحالة ، تقوم ببساطة باستدعاء استيراد لحساب دلتا لإضافتها إلى الحالة.
من ناحية جافا سكريبت ، تبين أن الوظيفة التي نريد استخدامها لحساب دلتا يجب أن تعمل بشكل غير متزامن ؛ أي أنه يُرجع وعدًا برقم بدلاً من رقم نفسه.

يمكننا سد فجوة التزامن هذه باستخدام JS API الجديدة.
في المثال ، يتم تغليف استيراد وحدة WebAssembly باستخدام suspender.suspendOnReturnedPromise ، ويتم تغليف التصدير باستخدام suspender.returnPromiseOnSuspend ، وكلاهما يستخدم نفس suspender .
هذا suspender يتصل بالاثنين معًا.
يجعل الأمر كذلك ، في حالة إرجاع الاستيراد (غير المغلف) لوعدًا ، يقوم التصدير (المغلف) بإرجاع الوعد ، مع "تعليق" جميع الحسابات بينهما حتى يتم حل وعد الاستيراد.
يؤدي التفاف التصدير بشكل أساسي إلى إضافة علامة async ، كما أن التفاف الاستيراد يضيف بشكل أساسي علامة await ، ولكن على عكس JavaScript ، لا يتعين علينا صراحة وضع مؤشر ترابط async / await على طول الطريق من خلال جميع وظائف WebAssembly الوسيطة!

وفي الوقت نفسه ، فإن الاستدعاء الذي تم إجراؤه إلى init_state أثناء التهيئة يعود بالضرورة دون تعليق ، كما أن المكالمات إلى التصدير get_state تعود دائمًا دون تعليق ، لذلك لا يزال الاقتراح يدعم عمليات الاستيراد والتصدير "المتزامنة" الحالية يستخدم النظام البيئي WebAssembly اليوم.
بالطبع ، هناك العديد من التفاصيل التي يتم تجاهلها ، مثل حقيقة أنه إذا كان التصدير المتزامن يستدعي استيرادًا غير متزامن ، فسيقوم البرنامج بالاعتراض إذا حاول الاستيراد التعليق.
يوفر ما يلي مواصفات أكثر تفصيلاً بالإضافة إلى بعض إستراتيجيات التنفيذ.

تخصيص

A Suspender في إحدى الحالات التالية:

• غير نشط - لا يتم استخدامه في الوقت الحالي
• نشط [ caller ] - عنصر التحكم داخل Suspender ، حيث caller هي الوظيفة التي استدعت إلى Suspender وتتوقع externref يعاد
• معلق - في انتظار بعض الوعد لحلها

تؤكد الطريقة suspender.returnPromiseOnSuspend(func) أن func هو WebAssembly.Function مع نوع دالة على شكل [ti*] -> [to] ثم تُرجع WebAssembly.Function بنوع الوظيفة [ti*] -> [externref] يقوم بما يلي عند استدعائه بالوسيطات args :

1. مصائد إذا كانت حالة suspender غير نشطة
2. تغيير حالة suspender إلى نشط [ caller ] (حيث caller هو المتصل الحالي)
3. يتيح أن يكون result نتيجة استدعاء func(args) (أو أي فخ أو استثناء تم إلقاؤه)
4. يؤكد أن حالة suspender نشطة [ caller' ] لبعض caller' (يجب ضمان ذلك ، على الرغم من أن المتصل قد تغير)
5. تغيير حالة suspender إلى غير نشط
6. إرجاع (أو إعادة عرض) result إلى caller'

الطريقة suspender.suspendOnReturnedPromise(func)

• إذا كان func هو WebAssembly.Function ، فإنه يؤكد أن نوع وظيفته على الشكل [t*] -> [externref] وإرجاع WebAssembly.Function مع نوع الوظيفة [t*] -> [externref] ؛
• بخلاف ذلك ، يؤكد أن func هو Function وإرجاع Function .

في كلتا الحالتين ، تقوم الدالة التي تم إرجاعها بواسطة suspender.suspendOnReturnedPromise(func) بما يلي عند استدعائها باستخدام الوسيطات args :

1. يتيح أن يكون result نتيجة استدعاء func(args) (أو أي اعتراض أو استثناء تم إلقاؤه)
2. إذا لم يكن result وعدًا مرتجعًا ، فحينئذٍ يُرجع (أو يعيد حفظه) result
3. مصائد إذا كانت حالة suspender غير نشطة [ caller ] لبعض caller
4. يتيح أن يكون frames إطارات المكدس منذ caller
5. الاعتراضات في حالة وجود أي إطارات للوظائف غير القابلة للتعليق في frames
6. يغير حالة suspender إلى معلق
7. لعرض نتيجة result.then(onFulfilled, onRejected) مع الدالات onFulfilled و onRejected التي تقوم بما يلي:
   
   
   
   1. يؤكد أن حالة suspender معلقة (يجب ضمانها)
   
   
   2. تغيير حالة suspender إلى نشط [ caller' ] ، حيث caller' هو المتصل بـ onFulfilled / onRejected
   
   
   3. 
      
      
      • في حالة onFulfilled ، يتم تحويل القيمة المحددة إلى externref وإرجاعها إلى frames
      
      
      
      • في حالة onRejected ، يتم طرح القيمة المحددة حتى frames كاستثناء وفقًا لواجهة برمجة تطبيقات JS لاقتراح معالجة الاستثناءات
      
      
      
   
   

تكون الوظيفة قابلة للتعليق إذا كانت كذلك

• التي تحددها وحدة WebAssembly ،
• تم إرجاعها suspendOnReturnedPromise ،
• تم إرجاعه returnPromiseOnSuspend ،
• أو يتم إنشاؤها عن طريق إنشاء دالة مضيف لوظيفة قابلة للتعليق

الأهم من ذلك ، أن الوظائف المكتوبة في JavaScript غير قابلة للتعليق ، وتتوافق مع التعليقات الواردة من أعضاء TC39 ، ووظائف المضيف (باستثناء القليل منها المذكورة أعلاه) غير قابلة للتعليق ، بما يتوافق مع التعليقات الواردة من المشرفين على صيانة المحرك.

تطبيق

فيما يلي إستراتيجية تنفيذ لهذا الاقتراح.
إنه يفترض دعم المحرك للتبديل المكدس ، وهو بالطبع المكان الذي تكمن فيه تحديات التنفيذ الرئيسية.

هناك نوعان من الحزم: مكدس مضيف (وجافا سكريبت) ومكدس WebAssembly. يحتوي كل حزمة WebAssembly على حقل معلق يسمى suspender . كل موضوع له مكدس مضيف.

كل Suspender يحتوي على حقلين مرجعيين للمكدس: أحدهما يسمى caller والآخر يسمى suspended .

• في حالة غير نشط ، كلا الحقلين فارغين.
• في الحالة النشطة ، يشير الحقل caller إلى المكدس (المعلق) للمتصل ، والحقل suspended خالٍ
• في ولاية المعلقة، و suspended المراجع حقل (مع وقف التنفيذ) WebAssembly كومة ترتبط حاليا مع حمالة، و caller الحقل فارغة.

suspender.returnPromiseOnSuspend(func)(args) تم تنفيذه بواسطة

1. التحقق من أن suspender.caller و suspended.suspended فارغين (وإلا فإن الملاءمة)
2. السماح لـ stack أن يكون مكدس WebAssembly المخصص حديثًا والمرتبط بـ suspender
3. التبديل إلى stack وتخزين المكدس السابق في suspender.caller
4. جعل result هو نتيجة func(args) (أو أي فخ أو استثناء تم إلقاؤه)
5. التبديل إلى suspender.caller وتعيينه على قيمة خالية
6. تحرير stack
7. عائد (أو إعادة نمو) result

suspender.suspendOnReturnedPromise(func)(args) بواسطة

1. استدعاء func(args) ، اصطياد أي فخ أو استثناء
2. إذا لم يكن result وعدًا مرتجعًا ، فالإرجاع (أو إعادة الإسقاط) result
3. التحقق من أن suspender.caller ليس فارغًا (الملاءمة وإلا)
4. دع stack هو المكدس الحالي
5. بينما stack ليس حزمة WebAssembly المرتبطة بـ suspender :
   
   
   
   • التحقق من أن stack عبارة عن مكدس WebAssembly (الملاءمة بخلاف ذلك)
   
   
   • تحديث stack ليصبح stack.suspender.caller
   
   
6. التبديل إلى suspender.caller ، وتعيينه على null ، وتخزين المكدس السابق في suspender.suspended
7. إرجاع نتيجة result.then(onFulfilled, onRejected) بالوظائف onFulfilled و onRejected التي تم تنفيذها بواسطة
   
   
   
   1. التبديل إلى suspender.suspended ، وتعيينه على قيمة خالية ، وتخزين المكدس السابق في suspender.caller
   
   
   2. 
      
      
      • في حالة onFulfilled ، يتم تحويل القيمة المعطاة إلى externref وإعادتها
      
      
      
      • في حالة onRejected ، إعادة طرح القيمة المعطاة
      
      
      
   
   

يتم تغيير تنفيذ الوظيفة التي تم إنشاؤها عن طريق إنشاء وظيفة مضيفة لوظيفة قابلة للتعليق للتبديل أولاً إلى مكدس المضيف لمؤشر الترابط الحالي (إذا لم يكن موجودًا بالفعل) وللرجوع أخيرًا إلى المكدس السابق.