Skip to content

Inflate the bound box to include polygons whos centroids might be just outside the current bounds#14

Merged
rm-hull merged 2 commits into
mainfrom
feat/expand-bounds
Jun 28, 2025
Merged

Inflate the bound box to include polygons whos centroids might be just outside the current bounds#14
rm-hull merged 2 commits into
mainfrom
feat/expand-bounds

Conversation

@rm-hull

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

Copy link
Copy Markdown
Collaborator

No description provided.

@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 enhances the spatial search functionality by introducing a mechanism to slightly inflate the bounding box used for queries. This change specifically targets searches for 'units' to improve the likelihood of including relevant polygons whose centroids might fall just outside the initially defined search area, thereby making the search results more comprehensive.

Highlights

  • Bounding Box Expansion Utility: Introduced a new helper function, expandBounds, which takes a pointer to a []uint32 representing a bounding box and an integer extendBy. This function modifies the bounding box in place by subtracting extendBy from the minimum easting and northing coordinates, and adding extendBy to the maximum easting and northing coordinates, effectively enlarging the search area.
  • Conditional Bounding Box Inflation: Integrated the expandBounds function into the PolygonSearch logic. The bounding box (bbox) is now conditionally expanded by 100 units if the determined search target is 'units'. This aims to ensure that polygons whose centroids might be slightly outside the initial query bounds are still considered.
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 Report18 ran18 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/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

@coveralls

coveralls commented Jun 28, 2025

Copy link
Copy Markdown

Pull Request Test Coverage Report for Build 15944932441

Details

  • 0 of 10 (0.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.7%) to 32.112%

Changes Missing Coverage Covered Lines Changed/Added Lines %
routes/search.go 0 10 0.0%
Totals Coverage Status
Change from base Build 15936761212: -0.7%
Covered Lines: 149
Relevant Lines: 464

💛 - Coveralls

@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 introduces a change to expand the bounding box for 'units' searches to include nearby polygons. A critical bug was identified in the expandBounds function related to integer overflow/underflow, which could lead to incorrect search results. A corrected implementation has been provided. Additionally, a suggestion was made to replace a magic number with a constant to improve code maintainability.

Comment thread routes/search.go Outdated
Comment on lines +117 to +123
func expandBounds(bbox *[]uint32, extendBy int) {
b := *bbox
b[0] = uint32(int(b[0]) - extendBy) // min_easting
b[1] = uint32(int(b[1]) - extendBy) // min_northing
b[2] = uint32(int(b[2]) + extendBy) // max_easting
b[3] = uint32(int(b[3]) + extendBy) // max_northing
}

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.

critical

This function has a critical bug related to integer underflow and overflow.

Subtracting extendBy from a uint32 can lead to underflow if the initial value is small (e.g., uint32(50) - 100). Casting to int first doesn't prevent the issue, as casting a negative result back to uint32 will cause it to wrap around to a very large positive number.

Adding extendBy can cause an overflow if the value is close to math.MaxUint32, which will also wrap around.
Both scenarios will create an invalid bounding box, leading to incorrect search results. The logic should clamp the values at 0 and math.MaxUint32.

func expandBounds(bbox *[]uint32, extendBy int) {
	b := *bbox
	uExtendBy := uint32(extendBy)
	// Handle underflow for min coordinates
	if b[0] < uExtendBy {
		b[0] = 0
	} else {
		b[0] -= uExtendBy
	}
	if b[1] < uExtendBy {
		b[1] = 0
	} else {
		b[1] -= uExtendBy
	}
	// Handle overflow for max coordinates
	if b[2] > math.MaxUint32-uExtendBy {
		b[2] = math.MaxUint32
	} else {
		b[2] += uExtendBy
	}
	if b[3] > math.MaxUint32-uExtendBy {
		b[3] = math.MaxUint32
	} else {
		b[3] += uExtendBy
	}
}

Comment thread routes/search.go
@rm-hull
rm-hull merged commit 70cc44a into main Jun 28, 2025
3 checks passed
@rm-hull
rm-hull deleted the feat/expand-bounds branch June 28, 2025 14:14
rm-hull added a commit that referenced this pull request Jun 28, 2025
…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)
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