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

[GEOT-6494] MBStyle extension #2743

Merged
merged 11 commits into from
Feb 13, 2020
Merged

Conversation

jodygarnett
Copy link
Member

@jodygarnett jodygarnett commented Jan 13, 2020

Reviewing mbstyle codebase, cleaning up reports and checking code coverage.

Related:

Working on:

  • Update pom.xml and move to extension
  • Documentation
  • Test coverage
  • Include BSD license for documentation

Checklist

For all pull requests:

  • Confirm you have read the contribution guidelines
  • You have sent a Contribution Licence Agreement (CLA) as necessary (not required for small changes, e.g., fixing typos in documentation)
  • Make sure the first PR targets the master branch, eventual backports will be managed later. This can be ignored if the PR is fixing an issue that only happens in a specific branch, but not in newer ones.
  • The changes are not breaking the build in downstream projects using SNAPSHOT dependencies, GeoWebCache and GeoServer.

The following are required only for core and extension modules (they are welcomed, but not required, for unsupported modules):

  • There is a ticket in Jira describing the issue/improvement/feature (a notable exemptions is, changes not visible to end users)
  • PR for bug fixes and small new features are presented as a single commit
  • Commit message must be in the form "[GEOT-XYZW] Title of the Jira ticket"
  • New unit tests have been added covering the changes
  • This PR passes all existing unit tests (test results will be reported by travis-ci after opening this PR)
  • This PR passes the QA checks (QA checks results will be reported by travis-ci after opening this PR)
  • Documentation has been updated accordingly.

Submitting the PR does not require you to check all items, but by the time it gets merged, they should be either satisfied or inapplicable.

@aaime
Copy link
Member

aaime commented Jan 13, 2020

@jodygarnett I see this is just a review, which is fine. Could you make sure all PRs against the module are merged before moving it? I have one out, one in the making.

@jodygarnett jodygarnett changed the title mbstyle review [GEOT-6493] MBStyle plugin available Jan 13, 2020
@jodygarnett
Copy link
Member Author

@aaime wrote:

Could you make sure all PRs against the module are merged before moving it?

Yes I would like to clean up what I can here, and then do a separate PR to move.

@jodygarnett jodygarnett changed the title [GEOT-6493] MBStyle plugin available [GEOT-6494] Review MBStyle plugin Jan 13, 2020
@jodygarnett jodygarnett force-pushed the mbstyle_QA branch 2 times, most recently from fcf2ea7 to bd649fb Compare January 31, 2020 21:51
@jodygarnett
Copy link
Member Author

@jodygarnett I see this is just a review, which is fine. Could you make sure all PRs against the module are merged before moving it? I have one out, one in the making.

@aaime do you have any additional PRs against this module for me to review?

@aaime
Copy link
Member

aaime commented Jan 31, 2020 via email

@aaime
Copy link
Member

aaime commented Feb 8, 2020

@jodygarnett I don't have time to work on the alpha issue, please go ahead with the review and move, I'll resume later.

Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
@jodygarnett jodygarnett marked this pull request as ready for review February 9, 2020 17:12
Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
@jodygarnett jodygarnett changed the title [GEOT-6494] Review MBStyle plugin [GEOT-6494] MBStyle extension Feb 9, 2020
Color
Quoting `MapBox Style Specification <https://www.mapbox.com/mapbox-gl-js/style-spec/>`__ :

``Color``
Copy link
Member Author

@jodygarnett jodygarnett Feb 9, 2020

Choose a reason for hiding this comment

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

@tbarsballe this section has some duplication with spec/types.rst, do you know any background to untangle?

Reading the content, it looks like this was an earlier summary of the specification

Copy link
Member

Choose a reason for hiding this comment

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

spec/*.rst is a direct copy of the MapBox spect with GeoTools supported version added.
This index page tries to provide a more concise overview / quickstart, and pulls some of the more top-level information from the spec. It could maybe do with some rewording, but should still keep all that info in it.

Copy link
Member Author

Choose a reason for hiding this comment

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

okay I removed the duplication, and made this focus on the example snippets

@jodygarnett
Copy link
Member Author

jodygarnett commented Feb 9, 2020

The integration tests show an unrelated failure in GeoServer GeoWebCache (GWC) Module - unable to delete a folder on disk.

Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
* Code contributed by government members is often contributed as public domain
* To facilitate adopting of the GeoTools library the example code used in the
user guide is also public domain

Copy link
Member Author

Choose a reason for hiding this comment

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

Moved this to the respective headings.

<module>property</module>
<module>shapefile</module>
<module>svg</module>
<module>coverage-multidim</module>
<module>geopkg</module>
Copy link
Member

Choose a reason for hiding this comment

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

So this change kicked geopkg out of the build? Ideally a module promotion should just do that, promote the module, all the other improvements should be in a different commit (if not different PR), because they are not related, and are easy to get lost in the movement of so many files (github reports 200+ files changed in this PR). Thankfully I spotted this one at the source...

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for the catch Andrea, I appreciate it.
I initially tried moving this to plugin, but it did not fit (since it defines new API).

@@ -1577,6 +1577,13 @@
<artifactId>jt-shadedrelief</artifactId>
<version>${jaiext.version}</version>
</dependency>

<!-- Third-party -->
<dependency>
Copy link
Member

@aaime aaime Feb 10, 2020

Choose a reason for hiding this comment

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

Ah, so mbstyle is using json-simple to parse JSON? The library is completely dead, has not seen releases since 2012.
Not holding it as a blocker for the module, but wondering, is there any plan to switch to something supported? (it would not be the first dependency having this issue mind, I'm really just asking).

Copy link
Member Author

Choose a reason for hiding this comment

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

I am not aware why this was chosen, just annoyed it was not in the dependency management section.

Didn't we talk this out with GeoMesa folks to select a decent JSON library?

Copy link
Member

Choose a reason for hiding this comment

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

There was a discussion on dependencies for gt-main, and we ended up using jackson for that. But mbstyles is older, and used the same library as the semi-defunct gt-geojson (which I hope is gonna be replaced by the gt-jacksondatastore one day or the other...)

Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
@jodygarnett
Copy link
Member Author

Travis is failing on documentation toctree use of caption directive, must be an older version of sphinx.

Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
@jodygarnett
Copy link
Member Author

This was approved by PMC:

  • Andrea Aime +1
  • Ian Turton +1
  • Jody Garnett +1
  • Nuno Oliveira +1
  • Simone Giannecchini +1
  • Torben Barsballe +1

@jodygarnett jodygarnett merged commit b709df9 into geotools:master Feb 13, 2020
@jodygarnett
Copy link
Member Author

There is no need to backport at this time.

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.

3 participants