المادة 4: فخ ذاكرة التكوين Gradle

في رحلتنا لإنشاء الإضافة`site-baker`, نحن اتبعنا نهج TDD صارمًا. كل وظيفة تم اختبارها، والتحقق منها، وتقدمنا بثقة. ثم، في يوم ما، وصل غير المتوقع. začal البناء يتصرف بشكل غير منتظم. بدت التعديلات في منطق البرنامج الإضافي أو في ملفات التكوين وكأنها تُتجاهل، واختباراتنا الوظيفية، التي كانت موثوقة سابقًا، فشلت دون سبب واضح.

قد يكون هذا النوع من المشكلة محبطًا بشكل لا يصدق. إنه يشكك في موثوقية الأداة وصحة كودنا. بعد جلسة تصحيح أخطاء مكثفة، تم تحديد الجاني:ذاكرة التخزين المؤقت لتكوين Gradle.

كانت المشكلة تتجلى بعدة طرق :

كان كل شيء يسير كما لو أن Gradle كان ينفّذ "نسخة شبح" من بنائنا، متناسيًا تغييراتنا الأحدث.

ذاكرة التخزين المؤقت للتكوين هي ميزة نسبيًا حديثة وقوية جدًا في Gradle، مفعلة افتراضيًا في الإصدارات الجديدة. هدفها هو جعل عمليات البناء أسرع.

توفير الوقت مذهل في المشاريع الكبيرة. ومع ذلك، فإن هذا الأداء يأتي بتكلفة: فهو يفرض قواعد صارمة على كيفية كتابة المكونات الإضافية.

إضافتنا`site-baker`كان يخالف، دون علمه، عدة قواعد لتخزين الإعدادات. حتى يكون رسم بياني للمهام قابلاً للتسلسل، لا يجب أن تحتوي المهام على مراجع إلى كائنات معقدة مثل الكائن`Project`أو قراءة الملفات بطريقة تعسفية أثناء مرحلة التنفيذ.

خطأنا الرئيسي كان قراءة محتوى ملف YAML مباشرةً داخل منطق تنفيذ المهمة، باستخدام إشارة إلى المسار المخزن في امتدادنا. هذه الطريقة غير متوافقة مع التخزين المؤقت لأن Gradle لا يمكنه معرفة ما إذا كان محتوى الملف قد تغير إذا لم تُصَمَّم هذه القراءة على أنهاإدخال المهمة(إدخال المهمة)

لإلغاء حظرنا واستعادة سلوك البناء المتوقّع، كان الحل الأسرع هو تعطيل ذاكرة التخزين المؤقت للتكوين. يكفي إضافة السطر التالي في الملف`gradle.properties`المشروع الذي يستخدم المكون الإضافي (أو في حالتنا، مشروع الاختبار)site-baker).

على الفور، استعادت عمليات البناء سلوكها الطبيعي. كانت كل عملية تنفيذ تعيد تشغيل مرحلة التكوين، وكانت تغييراتنا تؤخذ بالحسبان.

ومع ذلك، هذا حل بديل، وليس حلاً دائمًا. إنه يضحي بالأداء ولا يحل المشكلة الأساسية في مكوّننا.

لكي يكون البرنامج المساعد مواطنًا جيدًا في نظام Gradle الحديث، يجب أن يكون متوافقًا مع ذاكرة التخزين المؤقت للتكوين. وهذا يعني إعادة التفكير في كيفية تدفق البيانات إلى مهامنا.

المفتاح هو استخدام الـواجهات برمجة التطبيقات للمزودمن Gradle. بدلاً من تمرير القيم المباشرة (مثل`String` ou un File) إلى مهامنا، يجب علينا المرور عبر بعض`Property<T>`أو بعض`Provider<T>`.

هنا خطة إعادة هيكلة :

[source,kotlin] ---- @get:InputFile مجرد val configFile: RegularFileProperty ----