۱۳ مرداد ۲۵۸۵ · 6 دقیقه مطالعه
باگی که تقصیرش رو انداختم گردن پرووایدر
چند هفته بود که یکی از استکها یه terraform plan داشت که یاد گرفته بودم نادیدهش بگیرم. هر بار و روی همهی محیطها، میخواست قانون رمزنگاری سمت سرور رو از یه باکت S3 برداره و یه قانون خالی جاش بذاره. باکت واقعی درست رمزنگاری شده بود. توی AWS هیچچیز خراب نبود. فقط پلن همگرا نمیشد، و هر مقداری هم که تعریف میکردم، پلن بعدی دوباره همون تغییر رو میخواست.
توی ذهنم گذاشتمش توی پوشهی «رفتار عجیب پرووایدر AWS، ارزش درستکردن نداره» و رفتم سراغ کار بعدی. اشتباهم همین بود. پرووایدر دقیقاً همون کاری رو میکرد که بهش گفته شده بود. دروغ کلاً بالادست Terraform بود، توی کد خودم، و تمام مدت جلوی چشمم توی فایلی نشسته بود که هیچوقت زحمت باز کردنش رو به خودم نداده بودم.
واکنش غریزی، و اینکه چرا اشتباهه
این استک با CDKTF و به زبون Python نوشته شده. ریسورسها رو به شکل کلاسهای تایپدار یا دیکشنریهای ساده مینویسی، cdktf synth اونها رو به یه فایل cdk.tf.json تبدیل میکنه، و Terraform بر اساس همون فایل پلن میگیره. وقتی یه پلن ادا درمیاره، واکنش غریزی اینه که تقصیر رو گردن لایهای بندازی که داخلش رو نمیبینی: منطق مقایسهی پرووایدر، ریسورسی که معروفه گاهی بدقلقی میکنه، یه رفتار عجیب توی استیت. ریسورسهای رمزنگاری S3 به دریفتهای الکی معروفن، پس این توضیح با داستانی که دلم میخواست باورش کنم جور درمیاومد.
این واکنش اشتباهه، چون CDKTF یه خروجی داره که میشه خوندش. cdk.tf.json دقیقاً همون فایل JSON هست که Terraform بر اساسش پلن میگیره. جعبهسیاه نیست؛ خروجی کامپایلشدهست که بعد از هر سینث روی دیسک نشسته. من هفتهها دربارهی رفتار پرووایدر فکر و استدلال کرده بودم و صفر ثانیه وقت گذاشته بودم ببینم واقعاً چی دارم تحویلش میدم.
وقتی بالاخره فایل رو باز کردم، قانون اونجا بود. فقط خالی بود:
"rule": [
{}
]
Terraform دریفت نداشت. با وفاداری تمام داشت سعی میکرد باکتی رو که یه قانون رمزنگاری واقعی داشت با کانفیگی تطبیق بده که میگفت این قانون نباید هیچ محتوایی داشته باشه. یه بلاک خالی خودش یه دستور صریحه، نه نبودِ دستور. پرووایدر بیگناه بود.
علت اصلی
این کدیه که اون بلاک خالی رو تولید کرد. کاملاً معمولی به نظر میرسه:
S3BucketServerSideEncryptionConfiguration(
self, "encryption",
bucket=bucket.id,
rule=[{
"apply_server_side_encryption_by_default": {
"sse_algorithm": "aws:kms",
"kms_master_key_id": key.arn,
},
"bucket_key_enabled": True,
}],
)
آرگومان rule یه لیست میگیره. هر آیتمش یه دیکشنری تودرتوئه: بلاکی که داخلش یه بلاک دیگه هست. کل مشکل همین تودرتو بودنه.
بایندینگهای Python در CDKTF روی jsii سوارن، و jsii دیکشنریهای Python رو خودکار به استراکتهای تایپداری تبدیل میکنه که کد TypeScript زیرین انتظارشون رو داره. این تبدیل بهصورت بازگشتی وارد آیتمهایی از لیست که خودشون دیکشنری تودرتو هستن نمیشه. وقتی jsii یه Sequence[Union[SomeTypedClass, Dict]] رو پیمایش میکنه و به دیکشنریای میرسه که مقدارهاش خودشون دیکشنریان، نمیتونه ساختار داخلی رو نگاشت کنه و بیسروصدا یه آبجکت خالی بیرون میده. نه استثنایی، نه هشداری. سینث هم با کد خروج صفر تموم میشه.
چیزی که این ماجرا رو واقعاً موذیانه میکنه اینه که همین الگو همهجای دیگه کار میکنه. لیستی از دیکشنریها با مقدارهای اسکالر و تخت بدون هیچ مشکلی تبدیل میشه:
# This renders correctly. The list items are flat.
taint=[{
"key": "dedicated",
"value": "gpu",
"effect": "NO_SCHEDULE",
}]
پس حالت خراب و حالت سالم از نظر ظاهری عین همان: لیستی از دیکشنریها که به آرگومان یه ریسورس پاس داده میشه. تنها فرق اینه که مقدارهای دیکشنری اسکالرن یا خودشون دیکشنریان، و هیچچیز، نه کد، نه خروجی سینث، نه چکهایی که نوشتی، این دو تا رو از هم جدا نمیکنه. با خوندن کد Python نمیتونی پیداش کنی. فقط با خوندن JSON پیدا میشه.
تلهای توی تله
بلاک خالی از یه عملیات بیاثر بدتره. یه اعلام صریحه که «این قانون هیچ تنظیمی نداره»، یعنی پلن هیچوقت نمیتونه همگرا بشه. Terraform یه قانون واقعی روی باکت میبینه، یه قانونِ خالی توی کانفیگ میبینه، و تغییر لازم رو پیشنهاد میده. کد Python رو ویرایش میکنی تا مقدارهای بیشتری اضافه کنی، jsii اونها رو هم به همون شکل دور میریزه، پس JSON همچنان [{}] میمونه و پلن بعدی عین قبلیه. ویرایش کانفیگی که قراره مشکل رو حل کنه از پسش برنمیاد، چون مقدارهات اصلاً از سینث جون سالم به در نمیبرن که به Terraform برسن. برای همین بود که شبیه دریفتی به نظر میرسید که درستشدنی نیست. یه جورایی هم واقعاً همین بود، تا وقتی که من اصرار داشتم توی لایهی اشتباه درستش کنم.
راهحل
دیگه یه دیکشنری تودرتو دست jsii نده که خودش حدس بزنه. کلاس تایپدار رو صریحاً بساز، تا تبدیل چیزی برای حدس زدن نداشته باشه:
S3BucketServerSideEncryptionConfiguration(
self, "encryption",
bucket=bucket.id,
rule=[S3BucketServerSideEncryptionConfigurationRuleA(
apply_server_side_encryption_by_default=(
S3BucketServerSideEncryptionConfigurationRuleApplyServerSideEncryptionByDefaultA(
sse_algorithm="aws:kms",
kms_master_key_id=key.arn,
)
),
bucket_key_enabled=True,
)],
)
اسم کلاسها طولانیان و اون A آخرشون یادگار نحوهی تولید بایندینگهاست، ولی نکته اینه که حالا jsii یه آبجکت کاملاً تایپدار تحویل میگیره، نه دیکشنریای که مجبور باشه داخلش رو بکاوه. ساختار تودرتو حفظ میشه، JSON همهی کلیدها رو در خودش داره، و پلن از همون بار اول همگرا میشه. قاعدهی سرانگشتی: هر ریسورسی که آیتمهای لیستش خودشون یه بلاک تودرتو دارن، کلاس تایپدار لازم داره، نه دیکشنری خام.
درسی که ارزش نگه داشتن داره
راستش این باگ رو قبلاً هم دیده بودم و ربطش رو نفهمیده بودم. روی پرووایدر Kubernetes، ساختن ریسورسها از دیکشنری بیصدا volumeMounts رو حذف کرده بود، یه StatefulSet رو با متغیر محیطی پسورد خالی ول کرده بود، و پرابهای readiness رو پاک کرده بود، همه بدون هیچ خطای سینث. اون موقع گذاشته بودمش به حساب رفتار عجیب پرووایدر Kubernetes. ولی اینطور نیست. این ویژگی بایندینگهای Python در CDKTF هست، و روی هر پرووایدری سر باز میکنه، به محض اینکه ریسورست یه بلاک تودرتو داخل یه لیست داشته باشه.
درس ماندگار ربطی به S3 یا Kubernetes یا هیچ ریسورس خاصی نداره. اینه: سینث موفق یعنی کدت اجرا شده، نه اینکه همون چیزی رو تولید کرده که منظورت بود. این دو تا یکی نیستن، و فاصلهی بینشون دقیقاً همونجاییه که این باگ زندگی میکنه. چکهایی که با grep نوشتی پاس میشن، چون فیلدهایی که حذف میشن همونهاییان که خیلی عمیق تودرتو هستن و هیچکس براشون grep نمینویسه. پاس شدن سینث هم هیچی بهت نمیگه، چون حذف کردن فیلدها دقیقاً کاریه که سینث انجام میده.
پس وقتی یه پلن همگرا نمیشه و ریسورس توی کنسول درست به نظر میرسه، جلوی وسوسهی مقصر دونستن پرووایدر رو بگیر. خروجی کامپایلشده رو باز کن. فایل cdk.tf.json رو بخون که Terraform واقعاً بر اساسش پلن میگیره، نه کدی که دلت میخواد همونی باشه که Terraform میبینه. ابزار تقریباً همیشه دقیقاً همون کاری رو میکنه که بهش گفتی. سؤال جالب اینه که واقعاً چی بهش گفتی، و جوابش فقط یه سینث فاصله داره، نوشتهشده توی فایلی که بیشتر آدمها هیچوقت بازش نمیکنن.