Merge pull request #130 from matsumatsu20/feature/create-comment-liked-show

keillera · web-flow · commit c996880a4232 · 2018-07-12T22:41:01.000+09:00
Feature/create comment liked show
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -40,7 +40,7 @@
 ## DBやDBへのクエリに対する変更
 
 * DBのスキーマに変更があるか
-  - [ ] 変更がある場合は[ドキュメント](https://alis-dev.esa.io/posts/58)に反映
+  - [ ] 変更がある場合は[ドキュメント](https://alismedia.atlassian.net/wiki/spaces/DEV/pages/9273460)に反映
 * 変更されるクエリ (変更前、変更後)
 * 新規に追加されるクエリ
 * 観点:
diff --git a/api-template.yaml b/api-template.yaml
@@ -728,6 +728,38 @@ Resources:
                 passthroughBehavior: when_no_templates
                 httpMethod: POST
                 type: aws_proxy
+
+          /me/articles/{article_id}/comments/likes:
+            get:
+              description: '指定された記事のコメントの中で、自分がいいねを実行したコメントのIDの一覧を取得する'
+              parameters:
+              - name: 'article_id'
+                in: 'path'
+                description: '対象記事を指定するために使用'
+                required: true
+                type: 'string'
+              responses:
+                '200':
+                  description: 'いいねを実施したコメントのIDの一覧'
+                  schema:
+                    type: object
+                    properties:
+                      comment_ids:
+                        type: array
+                        items:
+                          type: 'string'
+                          enum:
+                            - "comment_id"
+              security:
+                - cognitoUserPool: []
+              x-amazon-apigateway-integration:
+                responses:
+                  default:
+                    statusCode: "200"
+                uri: !Sub arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${MeArticlesCommentsLikesIndex.Arn}/invocations
+                passthroughBehavior: when_no_templates
+                httpMethod: POST
+                type: aws_proxy
           /me/comments/{comment_id}:
             delete:
               description: '指定されたコメントを削除する'
@@ -1404,6 +1436,19 @@ Resources:
             Path: /me/articles/{article_id}/comments
             Method: post
             RestApiId: !Ref RestApi
+  MeArticlesCommentsLikesIndex:
+    Type: AWS::Serverless::Function
+    Properties:
+      Handler: handler.lambda_handler
+      Role: !GetAtt LambdaRole.Arn
+      CodeUri: ./deploy/me_articles_comments_likes_index.zip
+      Events:
+        Api:
+          Type: Api
+          Properties:
+            Path: /me/articles/{article_id}/comments/likes
+            Method: get
+            RestApiId: !Ref RestApi
   CommentsLikesShow:
     Type: AWS::Serverless::Function
     Properties:
diff --git a/database-template.yaml b/database-template.yaml
@@ -426,11 +426,23 @@ Resources:
           AttributeType: S
         - AttributeName: user_id
           AttributeType: S
+        - AttributeName: article_id
+          AttributeType: S
       KeySchema:
         - AttributeName: comment_id
           KeyType: HASH
         - AttributeName: user_id
           KeyType: RANGE
+      GlobalSecondaryIndexes:
+        - IndexName: article_id-index
+          KeySchema:
+            - AttributeName: article_id
+              KeyType: HASH
+          Projection:
+            ProjectionType: ALL
+          ProvisionedThroughput:
+            ReadCapacityUnits: !Ref MinDynamoReadCapacitty
+            WriteCapacityUnits: !Ref MinDynamoWriteCapacitty
       ProvisionedThroughput:
         ReadCapacityUnits: !Ref MinDynamoReadCapacitty
         WriteCapacityUnits: !Ref MinDynamoWriteCapacitty
@@ -1576,6 +1588,50 @@ Resources:
         ScaleOutCooldown: 60
         PredefinedMetricSpecification:
           PredefinedMetricType: DynamoDBWriteCapacityUtilization
+  CommentLikedUserArticleIdIndexReadCapacityScalableTarget:
+    Type: AWS::ApplicationAutoScaling::ScalableTarget
+    DependsOn: ScalingRole
+    Properties:
+      MaxCapacity: !Ref MaxDynamoReadCapacitty
+      MinCapacity: !Ref MinDynamoReadCapacitty
+      ResourceId: !Sub 'table/${CommentLikedUser}/index/article_id-index'
+      RoleARN: !GetAtt ScalingRole.Arn
+      ScalableDimension: dynamodb:index:ReadCapacityUnits
+      ServiceNamespace: dynamodb
+  CommentLikedUserArticleIdIndexWriteCapacityScalableTarget:
+    Type: 'AWS::ApplicationAutoScaling::ScalableTarget'
+    DependsOn: ScalingRole
+    Properties:
+      MaxCapacity: !Ref MaxDynamoWriteCapacitty
+      MinCapacity: !Ref MinDynamoWriteCapacitty
+      ResourceId: !Sub 'table/${CommentLikedUser}/index/article_id-index'
+      RoleARN: !GetAtt ScalingRole.Arn
+      ScalableDimension: dynamodb:index:WriteCapacityUnits
+      ServiceNamespace: dynamodb
+  CommentLikedUserArticleIdIndexReadScalingPolicy:
+    Type: 'AWS::ApplicationAutoScaling::ScalingPolicy'
+    Properties:
+      PolicyName: ReadAutoScalingPolicy
+      PolicyType: TargetTrackingScaling
+      ScalingTargetId: !Ref CommentLikedUserArticleIdIndexReadCapacityScalableTarget
+      TargetTrackingScalingPolicyConfiguration:
+        TargetValue: 50.0
+        ScaleInCooldown: 60
+        ScaleOutCooldown: 60
+        PredefinedMetricSpecification:
+          PredefinedMetricType: DynamoDBReadCapacityUtilization
+  CommentLikedUserArticleIdIndexWriteScalingPolicy:
+    Type: 'AWS::ApplicationAutoScaling::ScalingPolicy'
+    Properties:
+      PolicyName: WriteAutoScalingPolicy
+      PolicyType: TargetTrackingScaling
+      ScalingTargetId: !Ref CommentLikedUserArticleIdIndexWriteCapacityScalableTarget
+      TargetTrackingScalingPolicyConfiguration:
+        TargetValue: 50.0
+        ScaleInCooldown: 60
+        ScaleOutCooldown: 60
+        PredefinedMetricSpecification:
+          PredefinedMetricType: DynamoDBWriteCapacityUtilization
   DeletedCommentTableReadCapacityScalableTarget:
     Type: AWS::ApplicationAutoScaling::ScalableTarget
     DependsOn: ScalingRole
diff --git a/database.yaml b/database.yaml
@@ -399,11 +399,23 @@ Resources:
           AttributeType: S
         - AttributeName: user_id
           AttributeType: S
+        - AttributeName: article_id
+          AttributeType: S
       KeySchema:
         - AttributeName: comment_id
           KeyType: HASH
         - AttributeName: user_id
           KeyType: RANGE
+      GlobalSecondaryIndexes:
+        - IndexName: article_id-index
+          KeySchema:
+            - AttributeName: article_id
+              KeyType: HASH
+          Projection:
+            ProjectionType: ALL
+          ProvisionedThroughput:
+            ReadCapacityUnits: 1
+            WriteCapacityUnits: 1
       ProvisionedThroughput:
         ReadCapacityUnits: 1
         WriteCapacityUnits: 1
diff --git a/src/common/db_util.py b/src/common/db_util.py
@@ -72,3 +72,16 @@ def items_values_empty_to_none(values):
         for k, v in values.items():
             if v == '':
                 values[k] = None
+
+    @staticmethod
+    def query_all_items(dynamodb_table, query_params):
+
+        response = dynamodb_table.query(**query_params)
+        items = response['Items']
+
+        while 'LastEvaluatedKey' in response:
+            query_params.update({'ExclusiveStartKey': response['LastEvaluatedKey']})
+            response = dynamodb_table.query(**query_params)
+            items.extend(response['Items'])
+
+        return items
diff --git a/src/handlers/me/articles/comments/likes/index/handler.py b/src/handlers/me/articles/comments/likes/index/handler.py
@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+import boto3
+from me_articles_comments_likes_index import MeArticlesCommentsLikesIndex
+
+dynamodb = boto3.resource('dynamodb')
+
+
+def lambda_handler(event, context):
+    me_articles_comments_likes_index = MeArticlesCommentsLikesIndex(event=event, context=context, dynamodb=dynamodb)
+    return me_articles_comments_likes_index.main()
diff --git a/src/handlers/me/articles/comments/likes/index/me_articles_comments_likes_index.py b/src/handlers/me/articles/comments/likes/index/me_articles_comments_likes_index.py
@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+import json
+import os
+import settings
+
+from boto3.dynamodb.conditions import Key
+from db_util import DBUtil
+from lambda_base import LambdaBase
+from jsonschema import validate
+
+
+class MeArticlesCommentsLikesIndex(LambdaBase):
+    def get_schema(self):
+        return {
+            'type': 'object',
+            'properties': {
+                'article_id': settings.parameters['article_id']
+            },
+            'required': ['article_id']
+        }
+
+    def validate_params(self):
+        validate(self.params, self.get_schema())
+        DBUtil.validate_article_existence(self.dynamodb, self.params['article_id'], status='public')
+
+    def exec_main_proc(self):
+        user_id = self.event['requestContext']['authorizer']['claims']['cognito:username']
+
+        comment_liked_user_table = self.dynamodb.Table(os.environ['COMMENT_LIKED_USER_TABLE_NAME'])
+
+        query_params = {
+            'IndexName': 'article_id-index',
+            'KeyConditionExpression': Key('article_id').eq(self.params['article_id']),
+        }
+
+        result = DBUtil.query_all_items(comment_liked_user_table, query_params)
+
+        comment_ids = [liked_user['comment_id'] for liked_user in result if liked_user['user_id'] == user_id]
+
+        return {
+            'statusCode': 200,
+            'body': json.dumps({'comment_ids': comment_ids})
+        }
diff --git a/src/handlers/me/comments/likes/create/me_comments_likes_create.py b/src/handlers/me/comments/likes/create/me_comments_likes_create.py
@@ -28,17 +28,20 @@ def validate_params(self):
     def exec_main_proc(self):
         user_id = self.event['requestContext']['authorizer']['claims']['cognito:username']
 
-        comment_liked_user_table = self.dynamodb.Table(os.environ['COMMENT_LIKED_USER_TABLE_NAME'])
+        comment_table = self.dynamodb.Table(os.environ['COMMENT_TABLE_NAME'])
+        comment = comment_table.get_item(Key={'comment_id': self.params['comment_id']}).get('Item')
 
-        comment = {
-            'comment_id': self.params['comment_id'],
+        comment_liked_user_table = self.dynamodb.Table(os.environ['COMMENT_LIKED_USER_TABLE_NAME'])
+        comment_liked_user = {
+            'comment_id': comment['comment_id'],
             'user_id': user_id,
+            'article_id': comment['article_id'],
             'created_at': int(time.time())
         }
 
         try:
             comment_liked_user_table.put_item(
-                Item=comment,
+                Item=comment_liked_user,
                 ConditionExpression='attribute_not_exists(comment_id)'
             )
         except ClientError as e:
diff --git a/tests/common/test_db_util.py b/tests/common/test_db_util.py
@@ -1,4 +1,6 @@
 import os
+
+from boto3.dynamodb.conditions import Key
 from db_util import DBUtil
 from tests_util import TestsUtil
 from unittest import TestCase
@@ -53,6 +55,50 @@ def setUpClass(cls):
         ]
         TestsUtil.create_table(cls.dynamodb, os.environ['COMMENT_TABLE_NAME'], cls.comment_items)
 
+        article_pv_user_items = [
+            {
+                'article_id': 'article01',
+                'user_id': 'one_day_before_user1',
+                'article_user_id': 'article_user_1',
+                'target_date': '2018-05-01',
+                'created_at': 1520035200,
+                'sort_key': 1520035200000000
+            },
+            {
+                'article_id': 'one_day_before_article',
+                'user_id': 'one_day_before_user1',
+                'article_user_id': 'article_user_1',
+                'target_date': '2018-05-01',
+                'created_at': 1520035200,
+                'sort_key': 1520035200000000
+            },
+            {
+                'article_id': 'article01',
+                'user_id': 'a1_user1',
+                'article_user_id': 'article_user_1',
+                'target_date': '2018-05-01',
+                'created_at': 1520121600,
+                'sort_key': 1520121600000000
+            },
+            {
+                'article_id': 'article01',
+                'user_id': 'a1_user2',
+                'article_user_id': 'article_user_1',
+                'target_date': '2018-05-01',
+                'created_at': 1520125200,
+                'sort_key': 1520125200000000
+            },
+            {
+                'article_id': 'article02',
+                'user_id': 'a1_user2',
+                'article_user_id': 'article_user_2',
+                'target_date': '2018-05-02',
+                'created_at': 1520125200,
+                'sort_key': 1520125200000000
+            }
+        ]
+        TestsUtil.create_table(cls.dynamodb, os.environ['ARTICLE_PV_USER_TABLE_NAME'], article_pv_user_items)
+
     @classmethod
     def tearDownClass(cls):
         TestsUtil.delete_all_tables(cls.dynamodb)
@@ -236,3 +282,28 @@ def test_items_values_empty_to_none_ok(self):
 
         self.assertEqual(values['test'], 'test')
         self.assertEqual(values['empty'], None)
+
+    def test_query_all_items_with_limit(self):
+        article_pv_user_table = self.dynamodb.Table(os.environ['ARTICLE_PV_USER_TABLE_NAME'])
+        # ユースケースとしては1MBを超え、レスポンスにLastEvaluatedKeyが付与されて返ってくる場合だが
+        # Limitを付与した際も同じレスポンスなのでLimitで代用している
+        query_params = {
+            'IndexName': 'target_date-sort_key-index',
+            'KeyConditionExpression': Key('target_date').eq('2018-05-01'),
+            'Limit': 1
+        }
+
+        response = DBUtil.query_all_items(article_pv_user_table, query_params)
+
+        self.assertEqual(len(response), 4)
+
+    def test_query_all_items_with_no_limit(self):
+        article_pv_user_table = self.dynamodb.Table(os.environ['ARTICLE_PV_USER_TABLE_NAME'])
+        query_params = {
+            'IndexName': 'target_date-sort_key-index',
+            'KeyConditionExpression': Key('target_date').eq('2018-05-01')
+        }
+
+        response = DBUtil.query_all_items(article_pv_user_table, query_params)
+
+        self.assertEqual(len(response), 4)
diff --git a/tests/handlers/me/articles/comments/likes/index/test_me_articles_comments_likes_index.py b/tests/handlers/me/articles/comments/likes/index/test_me_articles_comments_likes_index.py
diff --git a/tests/handlers/me/comments/likes/create/test_me_comments_likes_create.py b/tests/handlers/me/comments/likes/create/test_me_comments_likes_create.py
