AWS Amplifyを用いたオンラインチャットアプリのバックエンド開発ブログ

 
type User @model
@auth(rules: [
  {allow: owner, operations:[create, read]}
  {allow: private, operations: [read]}
])
{
  id: ID!
  handleName: String!
}

type Thread @model 
@auth(rules: [
    {allow: owner,  ownerField: "owner", operations:[create, read]}
    {allow: private, operations: [read]}
  ])
{
  id: ID!
  owner: User! @connection
  title: String!
  createdAt: AWSDateTime!
  posts: [Post] @connection(keyName: "byThread", fields: ["id"])
}

type Post @model 
@key(name: "byThread", fields:["threadId", "createdAt"])
@key(name: "postSortByCreatedAt", fields:["threadId", "createdAt"], queryField:"listPostSortByCreatedAt")
@auth(rules: [
    {allow: owner,  ownerField: "owner", operations:[create, read]}
    {allow: private, operations: [read]}
  ])
{
  id: ID!
  threadId: ID!
  owner: User! @connection
  createdAt: AWSDateTime!
  userAttend: UserAttend @connection
  chat: Chat @connection
}

type UserAttend @model
@key(name: "userAttendSortByCreatedAt", fields:["threadId", "createdAt"], queryField:"listUserAttendSortByCreatedAt")
@auth(rules: [
    {allow: owner, operations:[create, read]}
    {allow: private, operations: [create, read]}
  ])
{
  id: ID!
  owner: User! @connection
  threadId: ID!
  createdAt: AWSDateTime!
}

type Chat @model
@key(name: "chatSortByCreatedAt", fields:["threadId", "createdAt"], queryField:"listChatSortByCreatedAt")
@auth(rules: [
    {allow: owner, operations:[create, read]}
    {allow: private, operations: [read]}
  ])
{
  id: ID!
  contents: String!
  owner: User! @connection
  threadId: ID!
  createdAt: AWSDateTime!
}

type Pin @model
@key(name: "pinSortByCreatedAt", fields:["threadId", "createdAt"], queryField:"listPinSortByCreatedAt") 
@auth(rules: [
    {allow: owner,  operations:[create, read]}
    {allow: private, operations: [create, read]}
  ])
{
  id: ID!
  postId: ID!
  isOn: Boolean!
  owner: User! @connection
  threadId: ID!
  createdAt: AWSDateTime!
}

type Good @model
@key(name: "listGoodSortByCreatedAt", fields:["threadId", "createdAt"], queryField:"listGoodSortByCreatedAt") 
@auth(rules: [
    {allow: owner,  operations:[create, read]}
    {allow: private, operations: [create, read]}
  ])
{
  id: ID!
  postId: ID!
  isOn: Boolean!
  owner: User! @connection
  threadId: ID!
  createdAt: AWSDateTime!
}

@model注釈は、記述したデータ型毎にDynamoDBのテーブルを作成することを指示します。
上記@auth注釈の書き方で、データ作成者がデータの作成と読み込み権限をもち、Cognitoへ認証したユーザーが読み込み権限を持つことを指定しています。
また@key(name:..., field:["threadId", "createdAt"], qeuryField...)注釈を設定しました。これは、各データをthreadIDごとに分け、さらに”createdAt”順に並べることを指定します。この指定により、アプリの仕様上データアクセス効率が上がりました。

このスキーマを設計していくのに、Amplifyのmock機能が非常に有用でした。amplify mockコマンドで、ローカル環境にGraphiQL IDEを立ち上げられます。
コマンド中にGraphQLスキーマを変更すると、その変更を検知して環境に自動的に反映してくれます。この機能によりスピーディに「スキーマ変更→スキーマの確認」のサイクルが回せました。結果として、この機能が開発の時間的コストの縮小に寄与しました。

Cognitoユーザーを開発側で事前作成する

PoCに参加するユーザーのCognitoユーザーアカウントをaws CLIを用いて事前に作成しました。

まずはaws cognito-idp admin-create-userコマンドでCognitoユーザーを作成します。

 aws cognito-idp admin-create-user \
  --user-pool-id ${POOLID} \
  --username ${USERNAME} \
  --no-force-alias-creation \
  --profile ${PROFILE} \
  --region ${REGION}

Cognitoユーザーは作成されますが、Cognito上のステータスがFORCE_CHANGE_PASSWORD状態となります。これは、ユーザーがログインすると、パスワードを変更するよう要求される状態をしめします。このままですと、「テストユーザーはパスワードを設定・変更しない」という要件を満たせません。ですので、開発側でパスワードを設定し、かつ恒久的な状態にします。これをcognito-idp admin-set-user-passwordコマンドで行います。