Skip to content
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

Improve documentation and add a test suite. #5

Merged
merged 7 commits into from
Oct 4, 2016

Conversation

23Skidoo
Copy link
Contributor

@23Skidoo 23Skidoo commented Oct 3, 2016

Also fixes a couple of bugs uncovered by the test suite.

23Skidoo and others added 6 commits October 3, 2016 12:08
The 'putMapping' action has a 'MappingName' argument for this purpose,
no need to also specify the name in the 'ToJSON' instance.

This bug broke upsert semantics -- inserting the same mapping twice
resulted in a "Root type mapping not empty after parsing!"
exception.

See
    * https://www.elastic.co/guide/en/elasticsearch/reference/2.4/indices-put-mapping.html
    * bitemyapp/bloodhound#143
"type" .= ("integer"::T.Text)
]
, "insertion_time" .= object [
"type" .= ("date"::T.Text)
, "format" .= ("strict_date_time"::T.Text)
, "format" .= ("date_time"::T.Text)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this for compatibility with ElasticSearch 1.7?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Elasticsearch < 2 in general, which is the recommended version to use with Bloodhound.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@23Skidoo another Bloodhound user is trying to make 2.x compatibility happen, but we're hesitant to leave the AWS users behind. Unfortunately, the hosted AWS Elasticsearch offering is 1.x only at the moment.

Copy link
Contributor Author

@23Skidoo 23Skidoo Oct 18, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bitemyapp AWS supports both 1.5 and 2.3 now. Good to know that 2.x compatibility is being worked on.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@23Skidoo not super actively. If it's something you want, you'll have to pitch in.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bitemyapp I'll keep it in mind, not sure right now how important 2.x support is for us.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could go with 2.x on AWS, since we haven't set anything up yet, and I have no idea how hard it is to migrate, but it sounds like something to avoid.

@arybczak reported no problems with 2.3.3 so maybe we should try that... especially if bloodhound support is in the pipeline.

@@ -0,0 +1,83 @@
# -*- restclient -*-
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file looks interesting, but I have no idea how it works!?
Could you enlighten the ignorant :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -1,2 +1,7 @@
/dist/
/dist-newstyle/
/.cabal-sandbox/
TAGS
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this not better in your own global .gitignore? I don't know what the current "best practice" is... just a thought.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With a global .gitignore you might end up ignoring more stuff than strictly needed as your global .gitignore becomes the union of .gitignores for all projects you're working on. Per-project ones also provide a better experience for new contributors.

@jonathanjouty
Copy link
Contributor

Nice work adding some documentation to parameters, etc. Ups the quality and this is good.

Will try this out in the evening, just minor comments from first glance for now.

@jonathanjouty jonathanjouty self-assigned this Oct 4, 2016
@@ -22,15 +25,19 @@ before_cache:

matrix:
include:
- env: CABALVER=head GHCVER=7.8.4
- env: CABALVER=head GHCVER=7.8.4 ELASTICSEARCH=1.7
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Elasticsearch < 2 in general, which is the recommended version to use with Bloodhound.

In our own self interest should we test against Elasticsearch 1.5?
As this is what AWS supports, though Bloodhound already tests against 1.7 (and others too).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, I was working with 2.3.3 and it was just fine.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arybczak Yeah, it doesn't seem to be a problem even though it is not "officially" supported by Bloodhound.

@jonathanjouty
Copy link
Contributor

Apart from my minor quibbles everything looks great, even ran tests on my machine :P
Thanks for the clarification in 0fed9e1.
Feel free to merge, over to you @23Skidoo.

@23Skidoo 23Skidoo merged commit dbe6686 into master Oct 4, 2016
@23Skidoo 23Skidoo deleted the documentation-and-ci branch October 4, 2016 16:53
@23Skidoo
Copy link
Contributor Author

Relevant upstream PR, just for reference: bitemyapp/bloodhound#143.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants