ابزاری با اسکیما (Schema) زیر در رجیستری ثبت شده است و مدل، چهار مجموعهآرگومان زیر را ارسال میکند. برای هر مورد مشخص کنید رجیستری چه پاسخی برمیگرداند و چرا ساختار این پاسخ برای مدل اهمیت دارد.
registry.register(
name="db.get_user",
schema={
"type": "object",
"required": ["id"],
"properties": {
"id": {"type": "integer"},
"fields": {"type": "array", "items": {"type": "string", "enum": ["id", "name", "email"]}},
},
},
handler=get_user,
)
cases = [
{"id": 42, "fields": ["id", "name"]},
{"id": "forty-two"},
{"fields": ["id"]},
{"id": 1, "fields": ["id", "phone"]},
]اول خودتان جواب بدهید، بعد پاسخ را باز کنید.
پاسخ کوتاه
مورد اول اعتبارسنجی را با موفقیت پشت سر میگذارد و نتیجهی Ok برمیگرداند. مورد دوم یک خطا در مسیر /id با کلیدواژهی type برمیگرداند؛ چون رشته عدد صحیح نیست و اعتبارسنج هرگز نوع داده را تبدیل ضمنی (Coerce) نمیکند. مورد سوم یک خطا در مسیر /id با کلیدواژهی required برمیگرداند؛ زیرا این ویژگی ارسال نشده است. مورد چهارم یک خطا در مسیر /fields/1 با کلیدواژهی enum برمیگرداند؛ چرا که phone جزو مقادیر مجاز نیست و این مسیر دقیقاً به همان عضو آرایه اشاره میکند تا مدل بتواند همان یک مقدار را در فراخوانی بعدی اصلاح کند.
پاسخ کامل
پیمایش ساختار
اعتبارسنج کارش را بر اساس type توزیع میکند. برای شیءها، ابتدا required را بررسی میکند و سپس سراغ تکتک ویژگیهایی میرود که اسکیما دارند. برای آرایهها، تکتک اعضا را با اسکیمای items میسنجد و اندیس عضو را به انتهای مسیر اضافه میکند. عدم تطابق نوع داده (Type mismatch)، پیمایش را در همان گره متوقف کرده و فقط یک خطا گزارش میدهد؛ بنابراین یک نوعِ اشتباه، آبشاری از خطاهای تودرتو در زیرمجموعهی خود تولید نمیکند.
| مورد | نتیجه | مسیر | کلیدواژه |
|---|---|---|---|
{"id": 42, "fields": ["id", "name"]} |
Ok |
||
{"id": "forty-two"} |
یک خطا | /id |
type |
{"fields": ["id"]} |
یک خطا | /id |
required |
{"id": 1, "fields": ["id", "phone"]} |
یک خطا | /fields/1 |
enum |
چرا مسیر همان اصلِ محصول است؟
مدل یک اشارهگر جیسان (JSON Pointer) را بسیار بهتر از یک جملهی متنی درک میکند. خطایی که بگوید فیلد ایمیل انتظار رشته داشت، همراه با مسیر /user/email، در همان رفتوبرگشت اول برطرف میشود. اما یک پیام متنی که صرفاً بگوید آرگومانها نامعتبر بودند، یک نوبت گفتوگو (Turn) را به حدس و گمان هدر میدهد. مسیرها از قالب استاندارد اشارهگر جیسان پیروی میکنند: نام ویژگیها و اندیسهای آرایه که با اسلش از هم جدا شدهاند، و کاراکترهای ~ و / درون هر بخش اِسکِیپ (Escape) میشوند.
کارهایی که اعتبارسنج عمداً انجام نمیدهد
- نوع داده را تبدیل ضمنی نمیکند. رشتهی
"42"در برابر اسکیمای عدد صحیح یا اعشاری با خطا مواجه میشود. مدلی که یاد بگیرد رشتهها پذیرفته میشوند، همهجا رشته ارسال خواهد کرد. - کنترلکننده (Handler) را فراخوانی نمیکند. اسکیما از جنس داده است و کنترلکننده از جنس کد؛ مخلوط کردن آنها اعتبارسنجی را به داخل کنترلکنندهها میبرد و باعث دریفت (Drift) منطق برنامه میشود.
- مرز امنیتی نیست. حتی بعد از گذر از سد اعتبارسنجی، باز هم ممکن است رفتار کنترلکننده مخرب یا ناخواسته باشد. توزیعکنندهی وظایف (Dispatcher) زمانبندی وقفه (Timeout) و ساندباکس (Sandbox) را اعمال میکند؛ رجیستری ابزار فقط ساختار را تعیین میکند.
انضباط در ثبت ابزارها
تابع register نامی را که از قبل در جدول وجود داشته باشد نمیپذیرد، مگر اینکه فراخواننده آرگومان override=True را ارسال کرده باشد. اینکه دو بخش از کد یک نام مشترک را ثبت کنند باگی است که پیدا کردنش در محیط عملیاتی (Production) یک هفته زمان میبرد؛ به همین دلیل رفتار پیشفرض بالا بردن استثنا (Raise) است.
سؤالهای تکمیلی مصاحبهگر
- سطح 2: مدل آرگومان
{"id": true}را میفرستد. چه اتفاقی میافتد؟ پاسخ مورد انتظار: خطای نوع داده در مسیر/id؛ زیرا اعتبارسنج با بولی مثل عدد صحیح رفتار نمیکند، حتی اگر خودِ زبان آن را بپذیرد. - سطح 2: چرا عدم تطابق نوع داده، پیمایش را در همان گره متوقف میکند؟ پاسخ مورد انتظار: وقتی نوع دادهی والد اشتباه است، فرزندان آن هیچ معنایی ندارند؛ یک خطای واضح بسیار بهتر از فهرستی از خطاهای ناشی از همان یک اشتباه است.
- سطح 3: اسکیما از
oneOfاستفاده میکند. تابعregisterچه میکند؟ پاسخ مورد انتظار: استثنا پرتاب میکند؛ زیرا رجیستری از هشت کلیدواژهی مشخص پشتیبانی میکند و هر چیزی خارج از این زیرمجموعه را در همان لحظهی ثبت رد خواهد کرد. - سطح 3: تعداد ابزارهای کاتالوگ از 50 تا میگذرد و اسکیماها شروع به تکرار میکنند. ابتدا کدام دو قابلیت توسعه را اضافه میکنید؟ پاسخ مورد انتظار: قابلیت
ref$در برابر یک بلوک تعاریف محلی، وadditionalProperties: falseبرای اعمال ساختار سختگیرانه.
جوابهای اشتباهی که مصاحبهگرها زیاد میشنوند
- «یک پیام ارسال کنید که میگوید آرگومانها نامعتبرند و اجازه دهید مدل دوباره تلاش کند.» تلاش مجدد بدون داشتن مسیر، فقط حدس زدن است؛ در حالی که داشتن مسیر دقیق، فراخوانی را در همان نوبت اول اصلاح میکند.
- «رشته را به عدد تبدیل ضمنی کنید، چون نیت (Intent) مدل مشخص است.» تبدیل ضمنی به مدل یاد میدهد که اسکیما صرفاً یک پیشنهاد است؛ بنابراین در فراخوانی بعدی رشتهای را به جایی میفرستد که هیچ امکانی برای تبدیل ضمنی وجود ندارد.
- «اعتبارسنجی فراخوانی ابزار را ایمن میکند.» اعتبارسنجی فقط ساختار را بررسی میکند و کنترلکننده همچنان ممکن است رفتار نامناسبی نشان دهد؛ بنابراین مهلت زمانی و ساندباکس وظیفهی توزیعکنندهی وظایف است.
کجای دوره آموزش داده میشود
در درس رجیستری ابزار رجیستری، اعتبارسنج هشتکلیدواژهای و مسیرهای اشارهگر ساخته میشوند.