-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
Add command to reindex existing data (fixes #20) #56
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
flake8 | ||
pytest | ||
pytest-cache | ||
pytest-cover | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,123 @@ | ||
import argparse | ||
import elasticsearch | ||
import logging | ||
import sys | ||
|
||
from pyramid.paster import bootstrap | ||
|
||
from kinto.core.storage.exceptions import RecordNotFoundError | ||
from kinto.core.storage import Sort, Filter | ||
from kinto.core.utils import COMPARISON | ||
|
||
|
||
DEFAULT_CONFIG_FILE = 'config/kinto.ini' | ||
|
||
logger = logging.getLogger(__package__) | ||
|
||
|
||
def main(cli_args=None): | ||
if cli_args is None: | ||
cli_args = sys.argv[1:] | ||
|
||
parser = argparse.ArgumentParser() | ||
parser.add_argument('--ini', | ||
help='Application configuration file', | ||
dest='ini_file', | ||
required=False, | ||
default=DEFAULT_CONFIG_FILE) | ||
parser.add_argument('-b', '--bucket', | ||
help='Bucket name.', | ||
type=str) | ||
parser.add_argument('-c', '--collection', | ||
help='Collection name.', | ||
type=str) | ||
args = parser.parse_args(args=cli_args) | ||
|
||
print("Load config...") | ||
env = bootstrap(args.ini_file) | ||
registry = env['registry'] | ||
|
||
# Make sure that kinto-elasticsearch is configured. | ||
try: | ||
indexer = registry.indexer | ||
except AttributeError: | ||
logger.error("kinto-elasticsearch not available.") | ||
return 62 | ||
|
||
bucket_id = args.bucket | ||
collection_id = args.collection | ||
|
||
# Get index schema from collection metadata. | ||
try: | ||
schema = get_index_schema(registry.storage, bucket_id, collection_id) | ||
except RecordNotFoundError: | ||
logger.error("No collection '%s' in bucket '%s'" % (collection_id, bucket_id)) | ||
return 63 | ||
|
||
# Give up if collection has no index mapping. | ||
if schema is None: | ||
logger.error("No `index:schema` attribute found in collection metadata.") | ||
return 64 | ||
|
||
# XXX: Are you sure? | ||
recreate_index(indexer, bucket_id, collection_id, schema) | ||
reindex_records(indexer, registry.storage, bucket_id, collection_id) | ||
|
||
return 0 | ||
|
||
|
||
def get_index_schema(storage, bucket_id, collection_id): | ||
# Open collection metadata. | ||
# XXX: https://github.com/Kinto/kinto/issues/710 | ||
metadata = storage.get(parent_id="/buckets/%s" % bucket_id, | ||
collection_id="collection", | ||
object_id=collection_id) | ||
return metadata.get("index:schema") | ||
|
||
|
||
def recreate_index(indexer, bucket_id, collection_id, schema): | ||
index_name = indexer.indexname(bucket_id, collection_id) | ||
# Delete existing index. | ||
indexer.delete_index(bucket_id, collection_id) | ||
print("Old index '%s' deleted." % index_name) | ||
# Recreate the index with the new schema. | ||
indexer.create_index(bucket_id, collection_id, schema=schema) | ||
print("New index '%s' created." % index_name) | ||
|
||
|
||
def get_paginated_records(storage, bucket_id, collection_id, limit=5000): | ||
# We can reach the storage_fetch_limit, so we use pagination. | ||
parent_id = "/buckets/%s/collections/%s" % (bucket_id, collection_id) | ||
sorting = [Sort('last_modified', -1)] | ||
pagination_rules = [] | ||
while "not gone through all pages": | ||
records, _ = storage.get_all(parent_id=parent_id, | ||
collection_id="record", | ||
pagination_rules=pagination_rules, | ||
sorting=sorting, | ||
limit=limit) | ||
if len(records) == 0: | ||
break # Done. | ||
|
||
yield records | ||
|
||
smallest_timestamp = records[-1]["last_modified"] | ||
pagination_rules = [ | ||
[Filter("last_modified", smallest_timestamp, COMPARISON.LT)] | ||
] | ||
|
||
|
||
def reindex_records(indexer, storage, bucket_id, collection_id): | ||
total = 0 | ||
for records in get_paginated_records(storage, bucket_id, collection_id): | ||
try: | ||
with indexer.bulk() as bulk: | ||
for record in records: | ||
bulk.index_record(bucket_id, | ||
collection_id, | ||
record=record) | ||
print(".", end="") | ||
total += len(bulk.operations) | ||
except elasticsearch.ElasticsearchException: | ||
logger.exception("Failed to index record") | ||
print("\n%s records reindexed." % total) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,6 +2,12 @@ | |
use = egg:kinto | ||
kinto.userid_hmac_secret = some-secret-string | ||
|
||
kinto.storage_backend = kinto.core.storage.postgresql | ||
kinto.storage_url = postgres://postgres:postgres@localhost:5432/postgres | ||
|
||
kinto.permission_backend = kinto.core.permission.postgresql | ||
kinto.permission_url = postgres://postgres:postgres@localhost:5432/postgres | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @Natim is this intentional? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes for tests i guess. |
||
kinto.includes = kinto_elasticsearch | ||
kinto.plugins.flush | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
import elasticsearch | ||
import mock | ||
import os | ||
import unittest | ||
from kinto_elasticsearch.command_reindex import main, reindex_records | ||
from . import BaseWebTest | ||
|
||
HERE = os.path.abspath(os.path.dirname(__file__)) | ||
|
||
|
||
class TestMain(BaseWebTest, unittest.TestCase): | ||
|
||
schema = { | ||
"properties": { | ||
"id": {"type": "keyword"}, | ||
"last_modified": {"type": "long"}, | ||
"build": { | ||
"properties": { | ||
"date": {"type": "date", "format": "strict_date"}, | ||
"id": {"type": "keyword"} | ||
} | ||
} | ||
} | ||
} | ||
|
||
def test_cli_fail_if_elasticsearch_plugin_not_installed(self): | ||
with mock.patch('kinto_elasticsearch.command_reindex.logger') as logger: | ||
exit_code = main(['--ini', os.path.join(HERE, 'wrong_config.ini'), | ||
'--bucket', 'bid', '--collection', 'cid']) | ||
assert exit_code == 62 | ||
logger.error.assert_called_with('kinto-elasticsearch not available.') | ||
|
||
def test_cli_fail_if_collection_or_bucket_do_not_exists(self): | ||
with mock.patch('kinto_elasticsearch.command_reindex.logger') as logger: | ||
exit_code = main(['--ini', os.path.join(HERE, 'config.ini'), | ||
'--bucket', 'bid', '--collection', 'cid']) | ||
assert exit_code == 63 | ||
logger.error.assert_called_with( | ||
"No collection 'cid' in bucket 'bid'") | ||
|
||
def test_cli_fail_if_collection_has_no_index_schema(self): | ||
# Create collection or bucket | ||
self.app.put("/buckets/bid", headers=self.headers) | ||
self.app.put("/buckets/bid/collections/cid", headers=self.headers) | ||
|
||
with mock.patch('kinto_elasticsearch.command_reindex.logger') as logger: | ||
exit_code = main(['--ini', os.path.join(HERE, 'config.ini'), | ||
'--bucket', 'bid', '--collection', 'cid']) | ||
assert exit_code == 64 | ||
logger.error.assert_called_with( | ||
'No `index:schema` attribute found in collection metadata.') | ||
|
||
def test_cli_reindexes_if_collection_has_an_index_schema(self): | ||
# Create collection or bucket | ||
self.app.put("/buckets/bid", headers=self.headers) | ||
body = {"data": {"index:schema": self.schema}} | ||
self.app.put_json("/buckets/bid/collections/cid", body, headers=self.headers) | ||
self.app.post_json("/buckets/bid/collections/cid/records", | ||
{"data": {"build": {"id": "efg", "date": "2017-02-01"}}}, | ||
headers=self.headers) | ||
|
||
exit_code = main(['--ini', os.path.join(HERE, 'config.ini'), | ||
'--bucket', 'bid', '--collection', 'cid']) | ||
assert exit_code == 0 | ||
|
||
def test_cli_logs_elasticsearch_exceptions(self): | ||
indexer = mock.MagicMock() | ||
indexer.bulk().__enter__().index_record.side_effect = elasticsearch.ElasticsearchException | ||
|
||
with mock.patch('kinto_elasticsearch.command_reindex.logger') as logger: | ||
with mock.patch('kinto_elasticsearch.command_reindex.get_paginated_records', | ||
return_value=[[{}, {}]]) as get_paginated_records: | ||
reindex_records(indexer, | ||
mock.sentinel.storage, | ||
mock.sentinel.bucket_id, | ||
mock.sentinel.collection_id) | ||
get_paginated_records.assert_called_with(mock.sentinel.storage, | ||
mock.sentinel.bucket_id, | ||
mock.sentinel.collection_id) | ||
logger.exception.assert_called_with('Failed to index record') | ||
|
||
def test_cli_default_to_sys_argv(self): | ||
with mock.patch('sys.argv', ['cli', '--ini', os.path.join(HERE, 'wrong_config.ini')]): | ||
exit_code = main() | ||
assert exit_code == 62 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
[app:main] | ||
use = egg:kinto | ||
kinto.userid_hmac_secret = some-secret-string | ||
|
||
kinto.includes = kinto.plugins.flush |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you think we could work on adding an entry-point so that plugins can add sub-commands to the kinto command?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have created Kinto/kinto#1330 about that.