From e67efd930e0810dc9ef1fe22e43745794b1fa3ed Mon Sep 17 00:00:00 2001 From: mkbadeniyi Date: Mon, 12 Oct 2026 05:52:21 +0100 Subject: [PATCH] fix(spec): refuse an autocomplete query over 64 characters --- .../io/github/adeniyikayodee/ngpostcode/api/Api.java | 9 ++++++++- js/packages/ng-postcode-js/src/api.ts | 10 +++++++++- python/src/ng_postcode/api.py | 8 +++++++- spec/requests.json | 3 +++ src/api.rs | 11 +++++++++++ 5 files changed, 38 insertions(+), 3 deletions(-) diff --git a/java/api/src/main/java/io/github/adeniyikayodee/ngpostcode/api/Api.java b/java/api/src/main/java/io/github/adeniyikayodee/ngpostcode/api/Api.java index 0031284..10b8f95 100644 --- a/java/api/src/main/java/io/github/adeniyikayodee/ngpostcode/api/Api.java +++ b/java/api/src/main/java/io/github/adeniyikayodee/ngpostcode/api/Api.java @@ -25,6 +25,9 @@ public final class Api { public static final String BASE_URL = "https://api.postcode.gov.ng"; + /** Characters of autocomplete text sent. A full code with its separators is 15. */ + private static final int MAX_PARTIAL = 64; + // Responses are read as a tree and checked by hand: data binding would turn a missing // boolean into false, and a renamed field into "not assigned". /** Levels of nesting a body may have: what serde_json, behind the Rust crate, reads. */ @@ -57,13 +60,17 @@ public static Request lookup(Postcode code) { /** * Suggests completions for a partial postcode such as {@code EK 01 A}. * - * @throws IllegalArgumentException for a blank {@code partial}: the live API never answers one + * @throws IllegalArgumentException for a blank {@code partial}, which the live API never answers, + * or one over 64 characters */ public static Request autocomplete(String partial) { // Unicode White_Space, as the other implementations trim: isBlank() keeps a no-break space. if (partial.chars().allMatch(c -> Character.isSpaceChar(c) || (c >= '\t' && c <= '\r') || c == 0x85)) { throw new IllegalArgumentException("partial must not be empty"); } + if (partial.codePointCount(0, partial.length()) > MAX_PARTIAL) { + throw new IllegalArgumentException("partial is over " + MAX_PARTIAL + " characters"); + } return new Request<>("/v1/search/autocomplete", List.of(Map.entry("q", partial)), Api::readAutocomplete); } diff --git a/js/packages/ng-postcode-js/src/api.ts b/js/packages/ng-postcode-js/src/api.ts index eff33c5..c380ca0 100644 --- a/js/packages/ng-postcode-js/src/api.ts +++ b/js/packages/ng-postcode-js/src/api.ts @@ -10,6 +10,9 @@ import { Postcode, SEGMENTS, type Segment, trimWhiteSpace } from "./postcode.js" export const BASE_URL = "https://api.postcode.gov.ng"; +/** Characters of autocomplete text sent. A full code with its separators is 15. */ +const MAX_PARTIAL = 64; + /** A GET request whose successful response decodes to `T`. */ export interface Request { readonly path: string; @@ -137,11 +140,16 @@ export function lookup(code: Postcode, level = 1): Request { /** * Suggest completions for a partial postcode such as `EK 01 A`. * - * Throws `RangeError` for an empty `partial`: the live API never answers one. + * Throws `RangeError` for an empty `partial`, which the live API never answers, or one + * over 64 characters. */ export function autocomplete(partial: string): Request { if (typeof partial !== "string") throw new TypeError("partial must be text"); if (!trimWhiteSpace(partial)) throw new RangeError("partial must not be empty"); + // Spread counts characters, where `length` counts an emoji as two. + if ([...partial].length > MAX_PARTIAL) { + throw new RangeError(`partial is over ${MAX_PARTIAL} characters`); + } return { path: "/v1/search/autocomplete", params: [["q", partial]], read: readAutocomplete }; } diff --git a/python/src/ng_postcode/api.py b/python/src/ng_postcode/api.py index dff84c4..e44cc6f 100644 --- a/python/src/ng_postcode/api.py +++ b/python/src/ng_postcode/api.py @@ -21,6 +21,9 @@ BASE_URL = "https://api.postcode.gov.ng" +_MAX_PARTIAL = 64 +"""Characters of autocomplete text sent. A full code with its separators is 15.""" + _MAX_DEPTH = 127 """Levels of nesting a body may have: what serde_json, behind the Rust crate, reads.""" @@ -161,12 +164,15 @@ def lookup(code: Postcode, level: int = 1) -> Request[Lookup]: def autocomplete(partial: str) -> Request[Autocomplete]: """Suggest completions for a partial postcode such as `EK 01 A`. - Raises `ValueError` for an empty `partial`: the live API never answers one. + Raises `ValueError` for an empty `partial`, which the live API never answers, or one + over 64 characters. """ if not isinstance(partial, str): raise TypeError(f"partial must be text, got {partial!r}") if not partial.strip(WHITE_SPACE): raise ValueError("partial must not be empty") + if len(partial) > _MAX_PARTIAL: + raise ValueError(f"partial is over {_MAX_PARTIAL} characters") return Request("/v1/search/autocomplete", (("q", partial),), _autocomplete) diff --git a/spec/requests.json b/spec/requests.json index dd2c370..63c3986 100644 --- a/spec/requests.json +++ b/spec/requests.json @@ -10,6 +10,9 @@ { "name": "autocomplete_next_line", "request": "autocomplete", "args": {"q": "\u0085"}, "sends": null }, { "name": "autocomplete_control_character", "request": "autocomplete", "args": {"q": "\u001c"}, "sends": {"path": "/v1/search/autocomplete", "query": [["q", "\u001c"]]} }, { "name": "autocomplete_blank", "request": "autocomplete", "args": {"q": " "}, "sends": null }, + { "name": "autocomplete_at_the_length_limit", "request": "autocomplete", "args": {"q": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"}, "sends": {"path": "/v1/search/autocomplete", "query": [["q", "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"]]} }, + { "name": "autocomplete_limit_counts_characters", "request": "autocomplete", "args": {"q": "\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00"}, "sends": {"path": "/v1/search/autocomplete", "query": [["q", "\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00\ud83d\ude00"]]} }, + { "name": "autocomplete_too_long", "request": "autocomplete", "args": {"q": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"}, "sends": null }, { "name": "reverse", "request": "reverse", "args": {"lat": 7.6211, "lng": 5.2214}, "sends": {"path": "/v1/search/reverse", "query": [["lat", "7.6211"], ["lng", "5.2214"]]} }, { "name": "reverse_within", "request": "reverse", "args": {"lat": 7.6211, "lng": 5.2214, "metres": 100}, "sends": {"path": "/v1/search/reverse", "query": [["lat", "7.6211"], ["lng", "5.2214"], ["max_distance_m", "100"]]} }, { "name": "nearby_within", "request": "nearby", "args": {"lat": 7.6211, "lng": 5.2214, "metres": 62.5}, "sends": {"path": "/v1/search/nearby", "query": [["lat", "7.6211"], ["lng", "5.2214"], ["radius", "62.5"]]} }, diff --git a/src/api.rs b/src/api.rs index 87705ba..6de0c50 100644 --- a/src/api.rs +++ b/src/api.rs @@ -12,6 +12,9 @@ use crate::{Postcode, Segment}; pub const BASE_URL: &str = "https://api.postcode.gov.ng"; +/// Characters of autocomplete text sent. A full code with its separators is 15. +const MAX_PARTIAL: usize = 64; + /// A GET request whose successful response decodes to `T`. #[derive(Clone, Debug)] pub struct Request { @@ -41,6 +44,8 @@ pub enum InvalidRequest { Level(u8), /// The autocomplete text is empty, which the live API never answers. EmptyQuery, + /// The autocomplete text is over 64 characters. + QueryTooLong, /// The named coordinate or distance is not a finite number. NotFinite(&'static str), /// The named coordinate is off the globe: latitude beyond 90, or longitude beyond 180. @@ -64,6 +69,9 @@ pub fn autocomplete(partial: &str) -> Result, InvalidReque if partial.trim().is_empty() { return Err(InvalidRequest::EmptyQuery); } + if partial.chars().count() > MAX_PARTIAL { + return Err(InvalidRequest::QueryTooLong); + } let query = [("q", partial.to_owned())]; Ok(Request::get( "/v1/search/autocomplete", @@ -341,6 +349,9 @@ impl fmt::Display for InvalidRequest { match self { Self::Level(level) => write!(f, "level must be 1 to 5, got {level}"), Self::EmptyQuery => f.write_str("autocomplete text must not be empty"), + Self::QueryTooLong => { + write!(f, "autocomplete text is over {MAX_PARTIAL} characters") + } Self::NotFinite(name) => write!(f, "{name} must be a finite number"), Self::OutOfRange(name) => write!(f, "{name} is off the globe"), Self::Negative(name) => write!(f, "{name} must not be negative"),