הלשכה הדיגיטליתהלשכה הדיגיטליתDIGITAL OFFICE · מבית בינה סולושנס גיטהאב
תיעוד למפתחים

אפליקציה היא קובץ הצהרה

איך אפליקציה מקבלת כניסה, מסד נתונים, מפתחות, אוטומציות והודעות בלי לכתוב אותם, איך תלויות מנוהלות, ומה קורה כשמכבים רכיב.

העיקרון

לכל אפליקציה יש תיקייה אחת וקובץ הצהרה אחד. זה הדבר היחיד שהלשכה קוראת עליה. אין רשימה מרכזית שצריך לעדכן: להתקין זה להוסיף תיקייה, ולהסיר זה למחוק אותה, וכל מה שנבנה ממנה, הכתובת, הכניסה, האריח, המפתחות והאוטומציות, נעלם בבנייה הבאה.

הלשכה קוראת את כל קובצי ההצהרה ואת קובץ המצב (מה מופעל, ומי מספק כל צורך), פותרת את התלויות, ובונה מהם את כל המערכת. שום דבר לא מחובר ביד.

קובץ ההצהרה

כך נראה קובץ הצהרה מקוצר:

{
  "name": "drive",
  "capabilities": [{ "name": "drive", "required_ops": ["list", "get", "put"] }],
  "use": [
    { "capability": "sql", "strength": "requires" },
    { "capability": "notify", "strength": "wants" }
  ],
  "routing": { "host": "drive", "port": 8080, "auth": "sso" },
  "connections": ["google-drive"],
  "blueprints": { "n8n": ["drive-sync.json"] }
}
  • מה האפליקציה מספקת לאחרות, ואילו פעולות היא יודעת לעשות.
  • במה היא תלויה, ובאיזה חוזק.
  • הכתובת שלה, והאם היא מאחורי הכניסה האחת.
  • אילו מפתחות לשירותים חיצוניים היא צריכה.
  • אילו תהליכי אוטומציה היא מביאה איתה.

חוזק תלות

  • חובה (requires): הספק נכנס לבד ועולה לפני האפליקציה. אם אין ספק בכלל, הלשכה עוצרת לפני שמשהו עולה.
  • רשות (wants): משתמשים בו אם הוא קיים, והאפליקציה עולה גם בלעדיו.
  • סתירה (conflicts): שתי אפליקציות שלא יכולות לרוץ יחד. הלשכה אומרת את זה, ואף פעם לא מכבה אחת בשקט.

כששני ספקים מתאימים לאותו צורך, הלשכה לא מנחשת: היא עוצרת ואומרת את שמות שניהם, עד שנבחר אחד בקובץ המצב.

מה כל אפליקציה מקבלת בלי לכתוב

  • כתובת ותעודת אבטחה, משורה אחת.
  • כניסה אחת: האפליקציה יודעת מי המשתמש, בלי קוד כניסה משלה.
  • אריח במסך הראשי, והמסך שלה נפתח בתוך הלשכה.
  • מפתחות: מגיעים מהחיבורים, ואפשר שלא יישבו בסביבה בכלל.
  • אוטומציות שנכנסות איתה ויוצאות איתה.
  • הודעות ומעקב תקלות, אם הם מופעלים.
  • מצב בריאות עם סיבה: נפתרה, הותקנה, עלתה, מוכנה.

מה קורה כשמכבים

מכבים אפליקציה שאחרות תלויות בה בחובה, והלשכה אומרת אילו מהן ייפגעו לפני שמשהו נכבה. תלות של רשות לא עוצרת כלום: האפליקציות שמשתמשות בה ממשיכות לעבוד בלעדיה. המידע של אפליקציה שמעבירים לארכיון נשמר, ואפשר להחזיר אותה.

הבדיקות

יותר מ־60 בדיקות רצות על כל שינוי בקוד, ובודקות בין השאר שאף שכבה נמוכה לא תלויה בשכבה גבוהה ממנה, שלכל אפליקציה יש בדיקת בריאות, ושכל אוטומציה מקבלת את מה שהיא צריכה. כל בדיקה קיימת כי משהו נכשל פעם בשקט. הגרף המלא של כל האפליקציות והתלויות שלהן נמצא במאגר בגיטהאב, ונבנה מחדש מקובצי ההצהרה.