Skip to content

ALIS-1255: Add parameter of offset to api that use elasticsearch #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

ALIS-1255: Add parameter of offset to api that use elasticsearch #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion api-template.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,11 @@ Resources:
description: "ページ"
required: false
type: "integer"
- name: "offset"
in: "query"
description: "取得開始位置"
required: false
type: "integer"
responses:
"200":
description: "検索記事一覧"
Expand Down Expand Up @@ -298,6 +303,11 @@ Resources:
description: "ページ"
required: false
type: "integer"
- name: "offset"
in: "query"
description: "取得開始位置"
required: false
type: "integer"
responses:
"200":
description: "検索ユーザー一覧"
Expand Down Expand Up @@ -333,6 +343,11 @@ Resources:
description: "ページ数"
required: false
type: "integer"
- name: "offset"
in: "query"
description: "取得開始位置"
required: false
type: "integer"
responses:
"200":
description: "最新記事一覧"
Expand Down Expand Up @@ -360,7 +375,7 @@ Resources:
minimum: 1
- name: 'page'
in: 'query'
description: '取得対象ページのoffset'
description: 'ページ数'
required: false
type: 'integer'
minimum: 1
Expand All @@ -369,6 +384,11 @@ Resources:
description: '検索対象のトピック名'
required: false
type: 'string'
- name: "offset"
in: "query"
description: "取得開始位置"
required: false
type: "integer"
responses:
'200':
description: '人気記事一覧'
Expand Down
16 changes: 8 additions & 8 deletions src/common/es_util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
class ESUtil:

@staticmethod
def search_article(elasticsearch, word, limit, page):
def search_article(elasticsearch, word, limit, page, offset):
body = {
"query": {
"bool": {
Expand All @@ -16,7 +16,7 @@ def search_article(elasticsearch, word, limit, page):
"_score",
{"published_at": "desc"}
],
"from": limit*(page-1),
"from": limit*(page-1) + offset,
"size": limit
}
for s in word.split():
Expand Down Expand Up @@ -44,7 +44,7 @@ def search_article(elasticsearch, word, limit, page):
return res

@staticmethod
def search_user(elasticsearch, word, limit, page):
def search_user(elasticsearch, word, limit, page, offset):
body = {
"query": {
"bool": {
Expand All @@ -54,7 +54,7 @@ def search_user(elasticsearch, word, limit, page):
]
}
},
"from": limit*(page-1),
"from": limit*(page-1) + offset,
"size": limit
}
res = elasticsearch.search(
Expand All @@ -64,7 +64,7 @@ def search_user(elasticsearch, word, limit, page):
return res

@staticmethod
def search_popular_articles(elasticsearch, params, limit, page):
def search_popular_articles(elasticsearch, params, limit, page, offset):
body = {
'query': {
'bool': {
Expand All @@ -75,7 +75,7 @@ def search_popular_articles(elasticsearch, params, limit, page):
'sort': [
{'article_score': 'desc'}
],
'from': limit * (page - 1),
'from': limit * (page - 1) + offset,
'size': limit
}

Expand All @@ -92,7 +92,7 @@ def search_popular_articles(elasticsearch, params, limit, page):
return articles

@staticmethod
def search_recent_articles(elasticsearch, params, limit, page):
def search_recent_articles(elasticsearch, params, limit, page, offset):
body = {
'query': {
'bool': {
Expand All @@ -102,7 +102,7 @@ def search_recent_articles(elasticsearch, params, limit, page):
'sort': [
{'sort_key': 'desc'}
],
'from': limit * (page - 1),
'from': limit * (page - 1) + offset,
'size': limit
}

Expand Down
5 changes: 5 additions & 0 deletions src/common/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,11 @@
'minimum': 1,
'maximum': 100000
},
'offset': {
'type': 'integer',
'minimum': 0,
'maximum': 100
},
'query': {
'type': 'string',
'minLength': 1,
Expand Down
7 changes: 4 additions & 3 deletions src/handlers/articles/popular/articles_popular.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ def get_schema(self):
'properties': {
'limit': settings.parameters['limit'],
'page': settings.parameters['page'],
'topic': settings.parameters['topic']
'topic': settings.parameters['topic'],
'offset': settings.parameters['offset']
}
}

Expand All @@ -31,8 +32,8 @@ def validate_params(self):
def exec_main_proc(self):
limit = int(self.params['limit']) if self.params.get('limit') else settings.articles_popular_default_limit
page = int(self.params['page']) if self.params.get('page') else 1

articles = ESUtil.search_popular_articles(self.elasticsearch, self.params, limit, page)
offset = int(self.params['offset']) if self.params.get('offset') is not None else 0
articles = ESUtil.search_popular_articles(self.elasticsearch, self.params, limit, page, offset)

response = {
'Items': articles
Expand Down
6 changes: 4 additions & 2 deletions src/handlers/articles/recent/articles_recent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ def get_schema(self):
'properties': {
'limit': settings.parameters['limit'],
'page': settings.parameters['page'],
'topic': settings.parameters['topic']
'topic': settings.parameters['topic'],
'offset': settings.parameters['offset']
}
}

Expand All @@ -32,8 +33,9 @@ def exec_main_proc(self):
limit = int(self.params.get('limit')) if self.params.get('limit') is not None \
else settings.article_recent_default_limit
page = int(self.params.get('page')) if self.params.get('page') is not None else 1
offset = int(self.params['offset']) if self.params.get('offset') is not None else 0

articles = ESUtil.search_recent_articles(self.elasticsearch, self.params, limit, page)
articles = ESUtil.search_recent_articles(self.elasticsearch, self.params, limit, page, offset)

response = {
'Items': articles
Expand Down
6 changes: 4 additions & 2 deletions src/handlers/search/articles/search_articles.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ def get_schema(self):
'properties': {
'limit': settings.parameters['limit'],
'page': settings.parameters['page'],
'query': settings.parameters['query']
'query': settings.parameters['query'],
'offset': settings.parameters['offset']
},
'required': ['query']
}
Expand All @@ -28,7 +29,8 @@ def exec_main_proc(self):
query = self.params['query']
limit = int(self.params.get('limit')) if self.params.get('limit') is not None else settings.article_recent_default_limit
page = int(self.params.get('page')) if self.params.get('page') is not None else 1
response = ESUtil.search_article(self.elasticsearch, query, limit, page)
offset = int(self.params['offset']) if self.params.get('offset') is not None else 0
response = ESUtil.search_article(self.elasticsearch, query, limit, page, offset)
result = []
for a in response["hits"]["hits"]:
del(a["_source"]["body"])
Expand Down
6 changes: 4 additions & 2 deletions src/handlers/search/users/search_users.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ def get_schema(self):
'properties': {
'limit': settings.parameters['limit'],
'page': settings.parameters['page'],
'query': settings.parameters['query']
'query': settings.parameters['query'],
'offset': settings.parameters['offset']
},
'required': ['query']
}
Expand All @@ -28,7 +29,8 @@ def exec_main_proc(self):
query = self.params['query']
limit = int(self.params.get('limit')) if self.params.get('limit') is not None else settings.article_recent_default_limit
page = int(self.params.get('page')) if self.params.get('page') is not None else 1
response = ESUtil.search_user(self.elasticsearch, query, limit, page)
offset = int(self.params['offset']) if self.params.get('offset') is not None else 0
response = ESUtil.search_user(self.elasticsearch, query, limit, page, offset)
result = []
for u in response["hits"]["hits"]:
result.append(u["_source"])
Expand Down
81 changes: 81 additions & 0 deletions tests/handlers/articles/popular/test_articles_popular.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,60 @@ def test_main_ok_with_page(self):
self.assertEqual(response['statusCode'], 200)
self.assertEqual(json.loads(response['body'])['Items'], expected_items)

def test_main_ok_with_offset(self):
params = {
'queryStringParameters': {
'limit': '1',
'page': '1',
'offset': '2'
}
}

response = ArticlesPopular(params, {}, dynamodb=self.dynamodb, elasticsearch=self.elasticsearch).main()

expected_items = [
{
'article_id': 'testid000003',
'user_id': 'matsumatsu20',
'created_at': 1520150272,
'title': 'title04',
'overview': 'overview04',
'status': 'public',
'topic': 'crypto',
'article_score': 6,
'sort_key': 1520150272000003
}
]

self.assertEqual(response['statusCode'], 200)
self.assertEqual(json.loads(response['body'])['Items'], expected_items)

def test_main_ok_with_only_offset(self):
params = {
'queryStringParameters': {
'offset': '2'
}
}

response = ArticlesPopular(params, {}, dynamodb=self.dynamodb, elasticsearch=self.elasticsearch).main()

expected_items = [
{
'article_id': 'testid000003',
'user_id': 'matsumatsu20',
'created_at': 1520150272,
'title': 'title04',
'overview': 'overview04',
'status': 'public',
'topic': 'crypto',
'article_score': 6,
'sort_key': 1520150272000003
}
]

self.assertEqual(response['statusCode'], 200)
self.assertEqual(json.loads(response['body'])['Items'], expected_items)

def test_call_validate_topic(self):
params = {
'queryStringParameters': {
Expand Down Expand Up @@ -297,3 +351,30 @@ def test_validation_page_min(self):
}

self.assert_bad_request(params)

def test_validation_offset_type(self):
params = {
'queryStringParameters': {
'offset': 'A'
}
}

self.assert_bad_request(params)

def test_validation_offset_max(self):
params = {
'queryStringParameters': {
'offset': '101'
}
}

self.assert_bad_request(params)

def test_validation_offset_min(self):
params = {
'queryStringParameters': {
'offset': '-1'
}
}

self.assert_bad_request(params)
53 changes: 53 additions & 0 deletions tests/handlers/articles/recent/test_articles_recent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,32 @@ def test_main_ok_with_page(self):
self.assertEqual(response['statusCode'], 200)
self.assertEqual(len(json.loads(response['body'])['Items']), 10)

def test_main_ok_with_offset(self):
params = {
'queryStringParameters': {
'limit': '20',
'page': '2',
'offset': '5',
'topic': 'food'
}
}
response = ArticlesRecent(params, {}, dynamodb=self.dynamodb, elasticsearch=self.elasticsearch).main()

self.assertEqual(response['statusCode'], 200)
self.assertEqual(len(json.loads(response['body'])['Items']), 5)

def test_main_ok_with_only_offset(self):
params = {
'queryStringParameters': {
'offset': '28',
'topic': 'food'
}
}
response = ArticlesRecent(params, {}, dynamodb=self.dynamodb, elasticsearch=self.elasticsearch).main()

self.assertEqual(response['statusCode'], 200)
self.assertEqual(len(json.loads(response['body'])['Items']), 2)

def test_main_ok_exceed_page(self):
params = {
'queryStringParameters': {
Expand Down Expand Up @@ -245,3 +271,30 @@ def test_validation_too_big_page(self):
}

self.assert_bad_request(params)

def test_validation_offset_type(self):
params = {
'queryStringParameters': {
'offset': 'A'
}
}

self.assert_bad_request(params)

def test_validation_offset_max(self):
params = {
'queryStringParameters': {
'offset': '101'
}
}

self.assert_bad_request(params)

def test_validation_offset_min(self):
params = {
'queryStringParameters': {
'offset': '-1'
}
}

self.assert_bad_request(params)
Loading