Skip to content

Add a service layer abstraction for fetching feature collections#16

Merged
rm-hull merged 17 commits into
mainfrom
tests/inc-coverage
Jun 28, 2025
Merged

Add a service layer abstraction for fetching feature collections#16
rm-hull merged 17 commits into
mainfrom
tests/inc-coverage

Conversation

@rm-hull

@rm-hull rm-hull commented Jun 28, 2025

Copy link
Copy Markdown
Collaborator

No description provided.

rm-hull and others added 16 commits June 27, 2025 21:42
…s/inc-coverage

* 'main' of github.com:rm-hull/postcode-polygons:
  Add tests on file_operations (#10)
…s/inc-coverage

* 'main' of github.com:rm-hull/postcode-polygons:
  Add tests on CSV parser (#11)
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…s/inc-coverage

* 'main' of github.com:rm-hull/postcode-polygons:
  Add tests on codepoint spatial index (#12)
…s/inc-coverage

* 'main' of github.com:rm-hull/postcode-polygons:
  Use interface for spatial index rather than concrete struct (#15)
  Inflate the bound box to include polygons whos centroids might be just outside the current bounds (#14)
…s/inc-coverage

* 'main' of github.com:rm-hull/postcode-polygons:
  Add tests over search endpoints (#13)

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Summary of Changes

Hello @rm-hull, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a dedicated service layer for fetching geographic feature collections, specifically postcode polygons. By abstracting the data access and caching mechanisms behind a PolygonsRepo interface, these changes enhance the application's modularity, maintainability, and testability. The PolygonSearch API endpoint now leverages this new abstraction, decoupling its logic from the underlying data storage and caching implementation details.

Highlights

  • Service Layer Abstraction: I've introduced a new PolygonsRepo interface and its CachedPolygonsRepo implementation within the internal package. This abstracts the logic for retrieving geojson.FeatureCollection objects, including file decompression and caching, centralizing data access concerns.
  • Dependency Inversion: The PolygonSearch handler in the routes package has been refactored to depend on the new PolygonsRepo interface instead of directly on the memoize.Memoizer cache and raw file system operations. This promotes a cleaner architecture and better separation of concerns.
  • Improved Testability: The introduction of the PolygonsRepo interface allows for easier mocking of the data retrieval layer in unit tests. Correspondingly, a mockPolygonsRepo has been added to routes/search_test.go, and existing tests were updated, along with a new success test case for PolygonSearch.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions

github-actions Bot commented Jun 28, 2025

Copy link
Copy Markdown
TestsPassed ✅SkippedFailed
JUnit Test Report36 ran36 passed0 skipped0 failed
TestResult
JUnit Test Report
postcode-polygons/internal.TestDecompressFeatureCollection_Success✅ passed
postcode-polygons/internal.TestDecompressFeatureCollection_FileNotFound✅ passed
postcode-polygons/internal.TestDecompressFeatureCollection_InvalidBZ2✅ passed
postcode-polygons/internal.TestCompressFeatureCollection_Success✅ passed
postcode-polygons/internal.TestCompressFeatureCollection_ErrorOnCreate✅ passed
postcode-polygons/internal.TestCompressFeatureCollection_And_DecompressFeatureCollection_RoundTrip✅ passed
postcode-polygons/routes.TestCodePointSearch_BadBBox✅ passed
postcode-polygons/routes.TestCodePointSearch_TooBig✅ passed
postcode-polygons/routes.TestCodePointSearch_InternalError✅ passed
postcode-polygons/routes.TestCodePointSearch_Success✅ passed
postcode-polygons/routes.TestPolygonSearch_BadBBox✅ passed
postcode-polygons/routes.TestPolygonSearch_InternalError✅ passed
postcode-polygons/routes.TestPolygonSearch_Success✅ passed
postcode-polygons/routes.TestPolygonSearch_PolygonNotFound✅ passed
postcode-polygons/routes.TestPolygonSearch_PolygonRepoError✅ passed
postcode-polygons/routes.TestParseBBox/valid✅ passed
postcode-polygons/routes.TestParseBBox/too_few_parts✅ passed
postcode-polygons/routes.TestParseBBox/not_numbers✅ passed
postcode-polygons/routes.TestParseBBox/min_greater_than_max✅ passed
postcode-polygons/routes.TestParseBBox✅ passed
postcode-polygons/routes.TestIsTooBig/not_too_big✅ passed
postcode-polygons/routes.TestIsTooBig/too_wide✅ passed
postcode-polygons/routes.TestIsTooBig/too_high✅ passed
postcode-polygons/routes.TestIsTooBig✅ passed
postcode-polygons/spatial-index.TestNewCodePointSpatialIndex_Success✅ passed
postcode-polygons/spatial-index.TestNewCodePointSpatialIndex_BadZip✅ passed
postcode-polygons/spatial-index.TestSearch✅ passed
postcode-polygons/spatial-index.TestSearchIter_InvalidBounds✅ passed
postcode-polygons/spatial-index.TestLen✅ passed
postcode-polygons/spatial-index.Test_fromCodePointCSV✅ passed
postcode-polygons/spatial-index.TestParseCSV_WithHeader_Success✅ passed
postcode-polygons/spatial-index.TestParseCSV_WithoutHeader_Success✅ passed
postcode-polygons/spatial-index.TestParseCSV_ParseError✅ passed
postcode-polygons/spatial-index.TestParseCSV_MalformedLine✅ passed
postcode-polygons/spatial-index.TestParseCSV_HeaderReadError✅ passed
postcode-polygons/spatial-index.TestParseCSV_YieldStopsEarly✅ passed

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request successfully introduces a service layer abstraction for fetching feature collections, which is a great step towards improving the modularity and testability of the application. The PolygonsRepo interface and its CachedPolygonsRepo implementation correctly encapsulate the data retrieval logic, and the updates to the routes/search.go handler and associated tests are well-executed, demonstrating a clear separation of concerns.

Comment thread internal/polygons_repo.go
@coveralls

coveralls commented Jun 28, 2025

Copy link
Copy Markdown

Pull Request Test Coverage Report for Build 15949163788

Details

  • 5 of 17 (29.41%) changed or added relevant lines in 3 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+4.9%) to 51.907%

Changes Missing Coverage Covered Lines Changed/Added Lines %
cmd/api_server.go 0 3 0.0%
internal/polygons_repo.go 0 9 0.0%
Totals Coverage Status
Change from base Build 15948796983: 4.9%
Covered Lines: 245
Relevant Lines: 472

💛 - Coveralls

@rm-hull
rm-hull merged commit 16a0625 into main Jun 28, 2025
3 checks passed
@rm-hull
rm-hull deleted the tests/inc-coverage branch June 28, 2025 23:27
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.

2 participants