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

באפליקציות רבות נדרש ניהול סשנים לצורך אימות והעדפות משתמש. ‫Sinatra כולל הטמעה מבוססת-זיכרון לביצוע הפונקציה הזו. עם זאת, ההטמעה הזו לא מתאימה לאפליקציה שאפשר להציג מכמה מופעים, כי יכול להיות שהסשן שמתועד במופע אחד יהיה שונה ממופעים אחרים. במדריך הזה מוסבר איך לנהל סשנים ב-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

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

1. הכנת סביבת הפיתוח.

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

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

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

   cd sessions
   

3. מפעילים את Gemfile:

   bundle init
   

4. מוסיפים את השורות הבאות לקובץ Gemfile שנוצר:

   gem "google-cloud-firestore", "~> 2.0"
   gem "sinatra", "~> 2.0"

   ב-Gemfile מפורטות כל ספריות Ruby הלא סטנדרטיות שהאפליקציה צריכה ש-App Engine יטען בשבילה:

   • ‫google-cloud-firestore הוא לקוח Ruby ל-Firestore API.

   • ‫Sinatra הוא ה-framework של Ruby לאינטרנט שמשמש את האפליקציה.

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

   bundle install
   

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

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

• בעזרת עורך טקסט, יוצרים קובץ בשם app.rb בספרייה sessions עם התוכן הבא:

  require "sinatra"
  
  require_relative "firestore_session"
  
  use Rack::Session::FirestoreSession
  
  set :greetings, ["Hello World", "Hallo Welt", "Ciao Mondo", "Salut le Monde", "Hola Mundo"]
  
  get "/" do
    session[:greeting] ||= settings.greetings.sample
    session[:views] ||= 0
    session[:views] += 1
    "<h1>#{session[:views]} views for \"#{session[:greeting]}\"</h1>"
  end

יצירת מאגר הסשנים

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

ל-Sinatra יש תמיכה מובנית בשמירת נתוני הפעילות בקובץ Cookie. כדי לשמור ב-Firestore במקום זאת, צריך להגדיר אובייקט Rack::Session משלכם.

• בספרייה sessions, יוצרים קובץ בשם firestore_session.rb עם התוכן הבא:

  require "google/cloud/firestore"
  require "rack/session/abstract/id"
  
  module Rack
    module Session
      class FirestoreSession < Abstract::Persisted
        def initialize app, options = {}
          super
  
          @firestore = Google::Cloud::Firestore.new
          @col = @firestore.col "sessions"
        end
  
        def find_session _req, session_id
          return [generate_sid, {}] if session_id.nil?
  
          doc = @col.doc session_id
          fields = doc.get.fields || {}
          [session_id, stringify_keys(fields)]
        end
  
        def write_session _req, session_id, new_session, _opts
          doc = @col.doc session_id
          doc.set new_session, merge: true
          session_id
        end
  
        def delete_session _req, session_id, _opts
          doc = @col.doc session_id
          doc.delete
          generate_sid
        end
  
        def stringify_keys hash
          new_hash = {}
          hash.each do |k, v|
            new_hash[k.to_s] =
              if v.is_a? Hash
                stringify_keys v
              else
                v
              end
          end
          new_hash
        end
      end
    end
  end

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

מחיקת סשנים

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

הרצה מקומית

1. מפעילים את שרת ה-HTTP:

   bundle exec ruby app.rb
   

2. צופים באפליקציה בדפדפן האינטרנט.

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

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

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

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

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

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

   runtime: ruby25
   entrypoint: bundle exec ruby app.rb

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

   gcloud app deploy
   

3. אפשר לראות את האפליקציה הפעילה בכתובת ה-URL הבאה, כאשר PROJECT_ID הוא מזהה הפרויקט: Google Cloud

   https://PROJECT_ID.appspot.com

ההודעה מועברת עכשיו על ידי שרת אינטרנט שפועל במופע של 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 משלכם.