Rubyを使用したGoogleCloud関数の構築、テスト、デプロイ

一般に、ホスティング環境が異なれば、関数が書き込まれる別のファイルを指定できます。ただし、Google Cloud Functionsでは、 app.rbである必要があります プロジェクトディレクトリのルートにあります。これで、関数を作成する準備が整いました。

app.rbを開きます 関数を作成します：

# Cloud Functions Entrypoint

require 'functions_framework'
require 'connection_pool'
require 'active_model_serializers'
require './lib/store'
require './lib/send_sms_notification'
require './lib/response'
require './lib/serializers/models/base_model'
require './lib/serializers/models/otp_response'
require './lib/serializers/application_serializer'
require './lib/serializers/base_model_serializer'
require './lib/serializers/otp_response_serializer'

FunctionsFramework.on_startup do |function|
  # Setup Shared Redis Client
  require 'redis'
  set_global :redis_client, ConnectionPool.new(size: 5, timeout: 5) { Redis.new }
end

# Define HTTP Function
FunctionsFramework.http "otp" do |request|

  store = Store.new(global(:redis_client))
  data = JSON.parse(request.body.read)

  if  request.post? && request.path == '/otp'
    phone_number = data['phone_number']
    record = store.get(phone_number)
    unless record.nil? || record.expired?
      data = Models::OtpResponse.new(phone_number: phone_number,
                                      otp: record['otp'],
                                      expires_at: record['expires_at'])
      json = Response.generate_json(status: true,
                            message: 'OTP previously sent',
                            data: data)

      return json
    end

    otp = rand(1111..9999)
    record = store.set(phone_number, otp)
    SendSmsNotification.new(phone_number, otp).call

    data = Models::OtpResponse.new(phone_number: phone_number,
                                    otp: record['otp'],
                                    expires_at: record['expires_at'])

    Response.generate_json(status: true,
                          message: 'OTP sent successfully',
                          data: data)

  elsif request.put? && request.path == '/otp/verify'
    phone_number = data['phone_number']
    record = store.get(phone_number)

    if record.nil?
      return Response.generate_json(status: false, message: "OTP not sent to number")
    elsif record.expired?
      return Response.generate_json(status: false,  message: 'OTP code expired')
    end

    is_verified = data['otp'] == record['otp']

    if is_verified
      return Response.generate_json(status: true, message: 'OTP verified')
    else
      return Response.generate_json(status: false, message: 'OTP does not match')
    end

  elsif request.put? && request.path == '/otp/resend'
    phone_number = data['phone_number']
    store.del(phone_number)

    otp = rand(1111..9999)
    record = store.set(phone_number, otp)
    SendSmsNotification.new(phone_number, otp).call

    data = Models::OtpResponse.new(phone_number: phone_number,
                                    otp: record['otp'],
                                    expires_at: record['expires_at'])

    json = Response.generate_json(status: true,
                          message: 'OTP sent successfully',
                          data: data)
  else
    Response.generate_json(status: false,
                            message: 'Request method and path did not match')
  end
end

これは大量のコードなので、分解します：

• Functions_Framework.on_startup 関数がリクエストの処理を開始する前に、Rubyインスタンスごとに実行されるコードのブロックです。関数が呼び出される前に、任意の形式の初期化を実行することが理想的です。この場合、私はそれを使用して、Redisサーバーへの接続プールを作成して共有しています：

  set_global :redis_client, ConnectionPool.new(size: 5, timeout: 5) { Redis.new }
  

  これにより、Redis接続オブジェクトのプールを複数の同時関数呼び出し間で恐れることなく共有できます。複数のスタートアップを定義できます。定義された順序で実行されます。 Functions Frameworkに注意することも重要です。 関数の完了後に実行する特別なフックは提供されません。

• Functions_Framework.http'otp' do | request | 関数の要求と応答の処理を処理します。この機能は、3つの異なるルートパターンをサポートします。他のタイプの関数を定義することもできます（例： Functions_Framework.cloud_event'otp' do | event | ）他のGoogleサービスからのイベントを処理します。同じファイルに複数の関数を定義することもできますが、独立してデプロイされます。

• store =Store.new（global（：redis_client））で 、 global メソッドは、グローバル共有状態に格納されているオブジェクトを取得するために使用されます。上記で使用されているように、 startupのグローバルセットアップで定義された接続プールからRedisクライアントを取得します ブロック。

• 応答 およびModels::OtpResponse active_model_serializersを使用して応答のシリアル化を処理します 適切にフォーマットされたJSON応答を提供します。

bundle exec functions-framework-ruby --target=otp --port=3000

require './spec/spec_helper.rb'
require 'functions_framework/testing'

describe  'OTP Functions' do
  include FunctionsFramework::Testing

  describe 'Send OTP', redis: true do
    let(:phone_number) { "+2347012345678" }
    let(:body) { { phone_number: phone_number }.to_json }
    let(:headers) { ["Content-Type: application/json"] }

    it 'should send OTP successfully' do
      load_temporary "app.rb" do
        request = make_post_request "/otp", body, headers

        response = call_http "otp", request
        expect(response.status).to eq 200
        expect(response.content_type).to eq("application/json")

        parsed_response = JSON.parse(response.body.join)
        expect(parsed_response['status']).to eq true
        expect(parsed_response['message']).to eq 'OTP sent successfully'
      end
    end
  end
end

name: Deployment
on:
  push:
    branches:
      - main
jobs:
  deploy:
    name: Function Deployment
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - id: deploy
        uses: google-github-actions/deploy-cloud-functions@main
        with:
          name: otp-cloud-function
          runtime: ruby26
          credentials: ${{ secrets.gcp_credentials }}
          env_vars: "TWILIO_ACCOUNT_SID=${{ secrets.TWILIO_ACCOUNT_SID }},TWILIO_AUTH_TOKEN=${{ secrets.TWILIO_AUTH_TOKEN }},TWILIO_PHONE_NUMBER=${{ secrets.TWILIO_PHONE_NUMBER }},REDIS_URL=${{ secrets.REDIS_URL }}"