טיפול בסשנים באמצעות Firestore

באפליקציות רבות נדרש ניהול סשנים לצורך אימות והעדפות משתמש. המסגרת Flask כוללת הטמעה מבוססת-זיכרון לביצוע הפונקציה הזו. עם זאת, ההטמעה הזו לא מתאימה לאפליקציה שאפשר להציג ממספר מופעים, כי יכול להיות שהביקור שתועד במופע אחד יהיה שונה ממופעים אחרים. במדריך הזה מוסבר איך לנהל סשנים ב-App Engine.

מטרות

• כותבים את האפליקציה.
• מריצים את האפליקציה באופן מקומי.
• פורסים את האפליקציה ב-App Engine.

עלויות

במסמך הזה משתמשים ברכיבים הבאים של Google Cloud, והשימוש בהם כרוך בתשלום:

• App Engine
• Firestore

כדי להעריך את ההוצאות בהתאם לתחזית השימוש שלכם, אתם יכולים להיעזר במחשבון העלויות.

משתמשים חדשים של Google Cloud ? יכול להיות שאתם זכאים לתקופת ניסיון בחינם.

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

לפני שמתחילים

נכנסים לחשבון Google Cloud . אם אתם משתמשים חדשים ב- Google Cloud, צרו חשבון כדי שתוכלו להעריך את הביצועים של המוצרים שלנו בתרחישים מהעולם האמיתי. לקוחות חדשים מקבלים בחינם גם קרדיט בשווי 300$ להרצה, לבדיקה ולפריסה של עומסי העבודה.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Firestore API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

התקינו את ה-CLI של Google Cloud.

אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

כדי לאתחל את ה-CLI של gcloud, הריצו את הפקודה הבאה:

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Firestore API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

התקינו את ה-CLI של Google Cloud.

אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

כדי לאתחל את ה-CLI של gcloud, הריצו את הפקודה הבאה:

gcloud init

1. מתקינים את Python‏, pip ו-virtualenv במערכת. הוראות מפורטות זמינות במאמר הגדרת סביבת פיתוח בשפת Python ל- Google Cloud.

הגדרת הפרויקט

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

2. עוברים לספרייה sessions:

   cd sessions
   

3. יוצרים את הקובץ requirements.txt עם התוכן הבא:

   google-cloud-firestore==2.11.1
   flask==2.2.5
   

4. מתקינים את יחסי התלות:

   pip install  -r requirements.txt
   

בסוף המדריך הזה, מבנה הקבצים הסופי יהיה דומה לזה:

sessions
├── app.yaml
├── main.py
└── requirements.txt

כתיבת אפליקציית האינטרנט

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

כדי שהאפליקציה תוכל לאחסן העדפות של משתמש, צריך לאחסן מידע על המשתמש הנוכחי בסשן. אפליקציית הדוגמה הזו משתמשת בקובצי Cookie וב-Firestore כדי לאחסן נתוני סשן.

• בחלון הטרמינל, יוצרים קובץ בשם main.py עם התוכן הבא:

  import random
  from uuid import uuid4
  
  from flask import Flask, make_response, request
  from google.cloud import firestore
  
  
  app = Flask(__name__)
  db = firestore.Client()
  sessions = db.collection('sessions')
  greetings = [
      'Hello World',
      'Hallo Welt',
      'Ciao Mondo',
      'Salut le Monde',
      'Hola Mundo',
  ]
  
  
  @firestore.transactional
  def get_session_data(transaction, session_id):
      """ Looks up (or creates) the session with the given session_id.
          Creates a random session_id if none is provided. Increments
          the number of views in this session. Updates are done in a
          transaction to make sure no saved increments are overwritten.
      """
      if session_id is None:
          session_id = str(uuid4())   # Random, unique identifier
  
      doc_ref = sessions.document(document_id=session_id)
      doc = doc_ref.get(transaction=transaction)
      if doc.exists:
          session = doc.to_dict()
      else:
          session = {
              'greeting': random.choice(greetings),
              'views': 0
          }
  
      session['views'] += 1   # This counts as a view
      transaction.set(doc_ref, session)
  
      session['session_id'] = session_id
      return session
  
  
  @app.route('/', methods=['GET'])
  def home():
      template = '<body>{} views for "{}"</body>'
  
      transaction = db.transaction()
      session = get_session_data(transaction, request.cookies.get('session_id'))
  
      resp = make_response(template.format(
          session['views'],
          session['greeting']
          )
      )
      resp.set_cookie('session_id', session['session_id'], httponly=True)
      return resp
  
  
  if __name__ == '__main__':
      app.run(host='127.0.0.1', port=8080)

• הדיאגרמה הבאה ממחישה איך Firestore מטפל בסשנים באפליקציית App Engine.

  

מחיקת סשנים

אתם יכולים למחוק נתוני סשן או להטמיע אסטרטגיה של מחיקה אוטומטית. אם אתם משתמשים בפתרונות אחסון לסשנים כמו Memcache או Redis, סשנים שתוקפם פג נמחקים אוטומטית.

הרצה מקומית

1. בחלון הטרמינל, מתקינים את שרת ה-HTTP של Gunicorn:

   pip install gunicorn
   

2. מריצים את שרת ה-HTTP של Gunicorn:

   gunicorn -b :8080 main:app
   

3. צפייה באפליקציה בדפדפן אינטרנט:

   Cloud Shell

   בסרגל הכלים של Cloud Shell, לוחצים על Web preview (תצוגה מקדימה של אתר) ובוחרים באפשרות Preview on port 8080 (תצוגה מקדימה ביציאה 8080).

   מכונה מקומית

   בדפדפן, עוברים אל http://localhost:8080

   מוצג אחד מחמשת המשפטים הבאים: Hello World,‏ Hallo Welt,‏ Hola mundo,‏ Salut le Monde או Ciao Mondo. השפה משתנה אם פותחים את הדף בדפדפן אחר או במצב פרטי. אפשר לראות ולערוך את נתוני הסשן בGoogle Cloud מסוף.

   

4. כדי לעצור את שרת ה-HTTP, בחלון הטרמינל לוחצים על Control+C.

פריסה והרצה ב-App Engine

אתם יכולים להשתמש בסביבה רגילה של App Engine כדי ליצור ולפרוס אפליקציה שפועלת בצורה מהימנה בעומס כבד ועם כמויות גדולות של נתונים.

במדריך הזה משתמשים בסביבה הרגילה של App Engine כדי לפרוס את השרת.

1. בחלון הטרמינל, יוצרים קובץ app.yaml ומעתיקים את הטקסט הבא:

   runtime: python37

2. פורסים את האפליקציה ב-App Engine:

   gcloud app deploy
   

3. אפשר לראות את האפליקציה הפעילה בכתובת: https://your-project-id.appspot.com:

   gcloud app browse
   

   כאשר your-project-id הוא מזהה הפרויקט. Google Cloud

ההודעה מועברת עכשיו על ידי שרת אינטרנט שפועל במופע של App Engine.

ניפוי באגים באפליקציה

אם אתם לא מצליחים להתחבר לאפליקציית App Engine, כדאי לבדוק את הדברים הבאים:

1. בודקים שהפקודות gcloud deploy הושלמו בהצלחה ולא הוחזרו שגיאות. אם היו שגיאות (לדוגמה, message=Build failed), צריך לתקן אותן ולנסות שוב לפרוס את אפליקציית App Engine.

2. נכנסים לדף Logs Explorer במסוף Google Cloud .

   כניסה לדף Logs Explorer

   1. בתפריט הנפתח Recently selected resources (משאבים שנבחרו לאחרונה), לוחצים על App Engine Application (אפליקציית App Engine) ואז על All module_id (כל מזהי המודולים). מוצגת רשימה של בקשות מהביקור שלכם באפליקציה. אם לא מוצגת רשימה של בקשות, צריך לוודא שבחרתם באפשרות All module_id מהרשימה הנפתחת. אם הודעות השגיאה מודפסות ב Google Cloud מסוף, צריך לוודא שהקוד של האפליקציה זהה לקוד שבקטע על כתיבת אפליקציית האינטרנט.

   2. מוודאים ש-Firestore API מופעל.

הסרת המשאבים

מחיקת הפרויקט

זהירות: כשמוחקים פרויקט:

• התוכן של הפרויקט נמחק כולו. אם השתמשתם בפרויקט קיים כדי לתרגל את המשימות במדריך הזה, כשתמחקו אותו תימחק גם כל העבודה שביצעתם באותו פרויקט.
• מאבדים את מזהה הפרויקט בהתאמה אישית. כשיצרתם את הפרויקט, יכולתם לבחור לו מזהה פרויקט בהתאמה אישית כדי להשתמש בו בעתיד. כדי לשמור על כתובות ה-URL שמשתמשות במזהה הפרויקט, כמו appspot.com, צריך למחוק את המשאבים שנבחרו בפרויקט אבל לא את הפרויקט כולו.

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

1. במסוף Google Cloud , נכנסים לדף Manage resources.

   כניסה לדף Manage resources

2. ברשימת הפרויקטים, בוחרים את הפרויקט שרוצים למחוק ולוחצים על Delete.
3. כדי למחוק את הפרויקט, כותבים את מזהה הפרויקט בתיבת הדו-שיח ולוחצים על Shut down.

מחיקת מכונת App Engine

1. במסוף Google Cloud , נכנסים לדף Versions של App Engine.

   כניסה לדף Versions

2. מסמנים את התיבה שלצד גרסת האפליקציה שלא מוגדרת כברירת מחדל ושרוצים למחוק.
   הערה: אפשר למחוק את גרסת ברירת המחדל של אפליקציית App Engine רק על ידי מחיקת הפרויקט. עם זאת, אפשר להפסיק את גרסת ברירת המחדל במסוף Google Cloud . כל המכונות שקשורות לגרסה יכובו. במידת הצורך, אפשר יהיה להפעיל מחדש את המכונות בהמשך.

   בסביבה הרגילה של App Engine, אפשר להפסיק את גרסת ברירת המחדל רק אם ההתאמה לעומס (scaling) של האפליקציה היא ידנית או בסיסית.

3. כדי למחוק את גרסת האפליקציה, לוחצים על Delete.

המאמרים הבאים

• אפשר לנסות מדריכים נוספים בנושא פונקציות Cloud Run.
• מידע נוסף על App Engine
• כדאי לנסות את Cloud Run, שמאפשר להריץ קונטיינרים ללא שמירת מצב בסביבה מנוהלת או באשכול Google Kubernetes Engine משלכם.