Menangani sesi dengan Firestore

Banyak aplikasi memerlukan penanganan sesi untuk autentikasi dan preferensi pengguna. Framework Flask dilengkapi dengan implementasi berbasis memori untuk melakukan fungsi ini. Namun, penerapan ini tidak cocok untuk aplikasi yang dapat ditayangkan dari beberapa instance, karena sesi yang direkam dalam satu instance mungkin berbeda dengan instance lainnya. Tutorial ini menunjukkan cara menangani sesi di App Engine.

Tujuan

• Tulis aplikasi.
• Jalankan aplikasi secara lokal.
• Deploy aplikasi di App Engine.

Biaya

Dalam dokumen ini, Anda akan menggunakan komponen Google Cloudyang dapat ditagih berikut:

• App Engine
• Firestore

Untuk membuat perkiraan biaya berdasarkan proyeksi penggunaan Anda, gunakan kalkulator harga.

Pengguna Google Cloud baru mungkin memenuhi syarat untuk mendapatkan uji coba gratis.

Setelah menyelesaikan tugas yang dijelaskan dalam dokumen ini, Anda dapat menghindari penagihan berkelanjutan dengan menghapus resource yang Anda buat. Untuk mengetahui informasi selengkapnya, baca bagian Pembersihan.

Sebelum memulai

Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.

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

Instal Google Cloud CLI.

Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut:

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

Instal Google Cloud CLI.

Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut:

gcloud init

1. Instal Python, pip, dan virtualenv di sistem Anda. Untuk mengetahui petunjuknya, lihat Menyiapkan lingkungan pengembangan Python untuk Google Cloud.

Menyiapkan project

1. Di jendela terminal, mulai di direktori pilihan Anda dan buat direktori baru bernama sessions. Semua kode untuk tutorial ini ada di dalam direktori sessions.

2. Ubah ke direktori sessions:

   cd sessions
   

3. Buat requirements.txt dengan konten berikut:

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

4. Instal dependensinya:

   pip install  -r requirements.txt
   

Di akhir tutorial ini, struktur file akhir akan mirip dengan berikut ini:

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

Menulis aplikasi web

Aplikasi ini menampilkan sapaan dalam berbagai bahasa untuk setiap pengguna. Pengguna yang kembali selalu disapa dalam bahasa yang sama.

Sebelum aplikasi Anda dapat menyimpan preferensi untuk pengguna, Anda memerlukan cara untuk menyimpan informasi tentang pengguna saat ini dalam sesi. Aplikasi contoh ini menggunakan cookie dan Firestore untuk menyimpan data sesi.

• Di jendela terminal, buat file bernama main.py dengan konten berikut:

  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)

• Diagram berikut menggambarkan cara Firestore menangani sesi untuk aplikasi App Engine.

  

Menghapus sesi

Anda dapat menghapus data sesi atau menerapkan strategi penghapusan otomatis. Jika Anda menggunakan solusi penyimpanan untuk sesi seperti Memcache atau Redis, sesi yang sudah berakhir akan otomatis dihapus.

Berjalan secara lokal

1. Di jendela terminal, instal server HTTP Gunicorn:

   pip install gunicorn
   

2. Jalankan server HTTP Gunicorn:

   gunicorn -b :8080 main:app
   

3. Lihat aplikasi di browser web Anda:

   Cloud Shell

   Di toolbar Cloud Shell, klik Web preview dan pilih Preview on port 8080.

   Mesin lokal

   Di browser Anda, buka http://localhost:8080

   Anda akan melihat salah satu dari lima ucapan: "Hello World", "Hallo Welt", "Hola mundo", "Salut le Monde", atau "Ciao Mondo". Bahasa akan berubah jika Anda membuka halaman di browser lain atau dalam mode samaran. Anda dapat melihat dan mengedit data sesi di konsolGoogle Cloud .

   

4. Untuk menghentikan server HTTP, di jendela terminal, tekan Control+C.

Men-deploy dan menjalankan di App Engine

Anda dapat menggunakan lingkungan standar App Engine untuk membangun dan men-deploy aplikasi yang berjalan secara andal dalam beban berat dan dengan data dalam jumlah besar.

Tutorial ini menggunakan lingkungan standar App Engine untuk men-deploy server.

1. Di jendela terminal, buat file app.yaml dan salin kode berikut:

   runtime: python37

2. Deploy aplikasi di App Engine:

   gcloud app deploy
   

3. Lihat aplikasi live di https://your-project-id.appspot.com:

   gcloud app browse
   

   Dengan your-project-id sebagai ID project Google Cloud Anda.

Ucapan kini dikirim oleh server web yang berjalan di instance App Engine.

Men-debug aplikasi

Jika Anda tidak dapat terhubung ke aplikasi App Engine, periksa hal-hal berikut:

1. Periksa apakah perintah deployment gcloud berhasil diselesaikan dan tidak menghasilkan error. Jika ada error (misalnya, message=Build failed), perbaiki, lalu coba men-deploy aplikasi App Engine lagi.

2. Di konsol Google Cloud , buka halaman Logs Explorer.

   Buka halaman Logs Explorer

   1. Di menu drop-down Recently selected resources, klik App Engine Application, lalu klik All module_id. Anda akan melihat daftar permintaan sejak Anda mengunjungi aplikasi. Jika Anda tidak melihat daftar permintaan, pastikan Anda memilih Semua module_id dari daftar drop-down. Jika Anda melihat pesan error yang dicetak ke konsol Google Cloud , periksa apakah kode aplikasi Anda cocok dengan kode di bagian tentang penulisan aplikasi web.

   2. Pastikan Firestore API diaktifkan.

Pembersihan

Menghapus project

Perhatian: Penghapusan project memiliki efek berikut:

• Semua hal dalam project akan dihapus. Jika Anda menggunakan project yang ada untuk mengerjakan tugas di dokumen ini, saat Anda menghapusnya, pekerjaan lain dalam project tersebut juga akan dihapus.
• Project ID kustom akan hilang. Saat membuat project ini, Anda mungkin juga membuat project ID kustom yang masih ingin digunakan pada masa mendatang. Agar tidak kehilangan URL yang menggunakan project ID tersebut, seperti URL appspot.com, hapus resource yang dipilih di dalam project, bukan menghapus seluruh project.

Jika Anda berencana mempelajari beberapa arsitektur, tutorial atau panduan memulai, dengan menggunakan kembali project dapat membantu Anda agar tidak melampaui batas kuota project.

1. Di Konsol Google Cloud , buka halaman Manage resources.

   Buka Kelola resource

2. Pada daftar project, pilih project yang ingin Anda hapus, lalu klik Delete.
3. Pada dialog, ketik project ID, lalu klik Shut down untuk menghapus project.

Menghapus instance App Engine

1. Di konsol Google Cloud , buka halaman Versions untuk App Engine.

   Buka Versi

2. Pilih kotak centang untuk versi aplikasi non-default yang ingin Anda hapus.
   Catatan: Satu-satunya cara untuk menghapus versi default aplikasi App Engine adalah dengan menghapus project Anda. Namun, Anda dapat menghentikan versi default ini di Google Cloud console. Tindakan ini akan menonaktifkan semua instance yang terkait dengan versi tersebut. Anda dapat memulai ulang instance ini jika nanti dibutuhkan.

   Di lingkungan standar App Engine, Anda dapat menghentikan versi default hanya jika aplikasi memiliki penskalaan manual atau dasar.

3. Untuk menghapus versi aplikasi, klik Hapus.

Langkah berikutnya

• Coba tutorial Cloud Run Functions lainnya.
• Pelajari App Engine lebih lanjut.
• Coba Cloud Run, yang memungkinkan Anda menjalankan container stateless di lingkungan yang terkelola sepenuhnya atau di cluster Google Kubernetes Engine Anda sendiri.