mirror of
https://github.com/MadsLorentzen/ai-job-search.git
synced 2026-09-17 08:36:25 +00:00
feat(freehire-search): search returns each hit's full description (#251)
The skill queried /api/v1/jobs/search, whose `description` is the search index's truncated preview — and the CLI dropped it entirely, so a result carried only title/company/location/date/url. Reading a posting therefore meant a `detail` call per hit, which is exactly what job-scraper's Step 2 prescribes: "fetch full detail with that portal's `detail` command". freehire exposes a search endpoint for programmatic consumers, /api/v1/agent/jobs/search: same query, ranking, facets and pagination, but asked to (`include_description=true`) it replaces the preview with the posting's full description read from the database, rendered as `description_format=markdown|text|html`. Reproduce the difference: curl -s "https://freehire.me/api/v1/jobs/search?q=golang&limit=1" \ | jq -r '.data[0].description | length' # preview, capped curl -s "https://freehire.me/api/v1/agent/jobs/search?q=golang&limit=1\ &include_description=true&description_format=markdown" \ | jq -r '.data[0].description | length' # full text So `search` now calls that endpoint, always asking for full descriptions, and each JSON result carries `description` verbatim — no client-side HTML stripping, since the API already rendered it. Markdown is the default because it preserves the headings and requirement lists /rank reasons over; `--description-format text|html` selects the others. The flag is validated client-side: the API answers an unrecognized format with raw HTML rather than an error, so a typo would silently change the output instead of failing. `table` and `plain` stay description-free — a full posting body would swamp a scannable list — and `detail` is untouched, for looking one posting up by slug (including a closed one, absent from search). One behaviour change beyond the endpoint: a 404 from the search path used to be folded into an empty result set. On the agent endpoint a 404 means the instance predates it — a self-hosted freehire behind FREEHIRE_API_URL — so it is now reported as an error naming the path, instead of a plausible "no results" that hides the misconfiguration. Tests cover the requested URL and params, verbatim (unstripped) markdown, the null-when-absent case, the 404-is-an-error contract, and the flag validation. All network-free.
This commit is contained in:
@@ -3,7 +3,7 @@
|
||||
CLI for searching the [freehire.me](https://freehire.me) job aggregator across
|
||||
**many markets** (tech-focused), via its public JSON API.
|
||||
|
||||
**Data source**: freehire.me REST API (`/api/v1/jobs/search`, `/api/v1/jobs/facets`, `/api/v1/jobs/{slug}`).
|
||||
**Data source**: freehire.me REST API (`/api/v1/agent/jobs/search`, `/api/v1/jobs/facets`, `/api/v1/jobs/{slug}`).
|
||||
**Authentication**: None required — reads are public (only tracking mutations need a key, and those are out of scope here).
|
||||
**Dependencies**: None (plain `bun` + `fetch`). `bun install` is optional and only pulls dev type defs.
|
||||
|
||||
@@ -44,6 +44,11 @@ Compose (`make up` → API on `:8080`, same `/api/v1/...` paths).
|
||||
`search` accepts `--format json|table|plain` (default `json`); `detail` accepts `--format json|plain`.
|
||||
All errors are written to **stderr** as `{ "error": "...", "code": "..." }` with exit code `1`.
|
||||
|
||||
`search` hits the API's agent endpoint, so every JSON result already carries the
|
||||
posting's **full** description (Markdown by default, `--description-format
|
||||
text|html` to change it). `detail` remains for looking a single posting up by
|
||||
slug — including a closed one, which search does not return.
|
||||
|
||||
## Quick examples
|
||||
|
||||
```bash
|
||||
@@ -80,6 +85,7 @@ See `../SKILL.md` for the full flag reference and the hosted-dependency note.
|
||||
| `--remote` | | `remote` \| `hybrid` \| `onsite` (`work_mode`). |
|
||||
| `--facet` | | Any other facet as `key=value` (repeatable). |
|
||||
| `--format` | | `json` \| `table` \| `plain`. |
|
||||
| `--description-format` | | `markdown` (default) \| `text` \| `html` — how each result's full description is rendered (`json` output only). |
|
||||
|
||||
Facet values come from freehire's controlled vocabularies. Discover the live
|
||||
values (with counts) for a market at
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
// freehire.me — a personal project maintained best-effort (no formal SLA). Point
|
||||
// FREEHIRE_API_URL at a self-hosted freehire backend to swap the source.
|
||||
|
||||
import { runSearch, type SearchOpts } from "./commands/search.js"
|
||||
import { runSearch, DESCRIPTION_FORMATS, type DescriptionFormat, type SearchOpts } from "./commands/search.js"
|
||||
import { runDetail, type DetailOpts } from "./commands/detail.js"
|
||||
import { baseUrl } from "./helpers.js"
|
||||
|
||||
@@ -81,6 +81,8 @@ SEARCH FLAGS
|
||||
--page <n> 1-indexed page. Default 1.
|
||||
--limit, -n <n> Results per page (API limit). Default 25.
|
||||
--format <fmt> json (default) | table | plain.
|
||||
--description-format markdown (default) | text | html — how each result's
|
||||
full description is rendered (json output only).
|
||||
|
||||
FACET FILTERS (values from freehire.me's controlled vocabularies; comma = OR)
|
||||
--region <codes> Macro-region: global, eu, us, apac, latam, cis, ... e.g. --region eu,us
|
||||
@@ -129,6 +131,18 @@ async function main(): Promise<number> {
|
||||
if (cmd === "search") {
|
||||
const fmt = (flags.format as string) || "json"
|
||||
|
||||
// Validated here rather than server-side: the API answers an unrecognized
|
||||
// format with raw HTML instead of an error, so a typo would silently change
|
||||
// the output rather than fail.
|
||||
const descFmt = stringFlag(flags["description-format"]) ?? "markdown"
|
||||
if (!DESCRIPTION_FORMATS.includes(descFmt as DescriptionFormat)) {
|
||||
const supported = DESCRIPTION_FORMATS.join("|")
|
||||
process.stderr.write(
|
||||
JSON.stringify({ error: `--description-format must be one of ${supported}, got "${descFmt}"`, code: "BAD_ARG" }) + "\n",
|
||||
)
|
||||
return 1
|
||||
}
|
||||
|
||||
for (const name of ["jobage", "page", "limit"] as const) {
|
||||
if (flags[name] !== undefined) {
|
||||
const v = parseIntFlag(name, flags[name])
|
||||
@@ -157,6 +171,7 @@ async function main(): Promise<number> {
|
||||
page: flags.page ? Math.max(1, parseInt(flags.page as string, 10)) : 1,
|
||||
limit: flags.limit ? Math.max(1, parseInt(flags.limit as string, 10)) : 25,
|
||||
format: (["json", "table", "plain"].includes(fmt) ? fmt : "json") as SearchOpts["format"],
|
||||
descriptionFormat: descFmt as DescriptionFormat,
|
||||
regions: commaList(flags.region),
|
||||
countries: commaList(flags.country),
|
||||
cities: commaList(flags.city),
|
||||
|
||||
@@ -1,11 +1,23 @@
|
||||
import { apiGet, toResult, writeError, type FreehireJob, type JobResult } from "../helpers.js"
|
||||
|
||||
// The agent variant of the job search: the same query, ranking, and facets as the
|
||||
// web's /jobs/search, but each hit carries the posting's full description instead
|
||||
// of the search index's truncated preview — so a run reads every result without a
|
||||
// follow-up `detail` per hit.
|
||||
const SEARCH_PATH = "/api/v1/agent/jobs/search"
|
||||
|
||||
/** How the API renders each result's full description. */
|
||||
export type DescriptionFormat = "markdown" | "text" | "html"
|
||||
|
||||
export const DESCRIPTION_FORMATS: DescriptionFormat[] = ["markdown", "text", "html"]
|
||||
|
||||
export interface SearchOpts {
|
||||
query?: string
|
||||
jobage: number
|
||||
page: number
|
||||
limit: number
|
||||
format: "json" | "table" | "plain"
|
||||
descriptionFormat: DescriptionFormat
|
||||
// Facet filters (already parsed into value lists; empty means unset).
|
||||
regions: string[]
|
||||
countries: string[]
|
||||
@@ -25,6 +37,10 @@ function buildQuery(opts: SearchOpts): URLSearchParams {
|
||||
p.set("limit", String(opts.limit))
|
||||
p.set("offset", String((opts.page - 1) * opts.limit))
|
||||
p.set("semantic_ratio", "0") // keyword search; the semantic index is opt-in
|
||||
// The agent endpoint serves the index's truncated preview unless asked to
|
||||
// rehydrate each hit from the database, so both params travel together.
|
||||
p.set("include_description", "true")
|
||||
p.set("description_format", opts.descriptionFormat)
|
||||
if (opts.jobage > 0 && opts.jobage < 9999) p.set("posted_within_days", String(opts.jobage))
|
||||
if (opts.workMode) p.set("work_mode", opts.workMode)
|
||||
if (opts.company) p.set("company_slug", opts.company)
|
||||
@@ -90,11 +106,19 @@ function renderPlain(rows: JobResult[]): string {
|
||||
|
||||
export async function runSearch(opts: SearchOpts): Promise<number> {
|
||||
try {
|
||||
const env = await apiGet<FreehireJob[]>(`/api/v1/jobs/search?${buildQuery(opts).toString()}`)
|
||||
// The search endpoint returns an envelope; a null (404) is treated as empty.
|
||||
const jobs = env?.data ?? []
|
||||
const rows = jobs.map(toResult)
|
||||
const total = env?.meta?.total ?? rows.length
|
||||
const env = await apiGet<FreehireJob[]>(`${SEARCH_PATH}?${buildQuery(opts).toString()}`)
|
||||
// A 404 here is a missing endpoint, not a missing job: a freehire instance
|
||||
// older than the agent search surface answers that way, and reporting it as
|
||||
// an empty result set would hide the misconfiguration behind plausible output.
|
||||
if (!env) {
|
||||
writeError(
|
||||
`${SEARCH_PATH} not found — this freehire instance predates the agent search endpoint; upgrade it or unset FREEHIRE_API_URL to use the hosted API`,
|
||||
"SEARCH_FAILED",
|
||||
)
|
||||
return 1
|
||||
}
|
||||
const rows = (env.data ?? []).map(toResult)
|
||||
const total = env.meta?.total ?? rows.length
|
||||
|
||||
if (opts.format === "table") {
|
||||
process.stdout.write(renderTable(rows) + "\n")
|
||||
|
||||
@@ -114,6 +114,10 @@ export interface FreehireJob {
|
||||
* A search result in the portal-skill contract shape. `id` is the public_slug
|
||||
* (what `detail <slug>` consumes) and `date` is the posting date; missing values
|
||||
* are `null`, never omitted. The extra facet fields are a permitted superset.
|
||||
*
|
||||
* `description` is the posting's full text in the format the search asked the API
|
||||
* for — the agent search endpoint hydrates it server-side, so it arrives already
|
||||
* rendered and is passed through verbatim rather than run through `cleanHtml`.
|
||||
*/
|
||||
export interface JobResult {
|
||||
id: string
|
||||
@@ -127,6 +131,7 @@ export interface JobResult {
|
||||
regions: string[]
|
||||
countries: string[]
|
||||
skills: string[]
|
||||
description: string | null
|
||||
}
|
||||
|
||||
/** A job detail: the search result plus the cleaned description and enrichment. */
|
||||
@@ -153,6 +158,7 @@ export function toResult(j: FreehireJob): JobResult {
|
||||
regions: j.regions,
|
||||
countries: j.countries,
|
||||
skills: j.skills,
|
||||
description: j.description || null,
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -31,6 +31,16 @@ describe("freehire CLI flag validation", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("--description-format validation", () => {
|
||||
test("an unsupported format exits 1 with BAD_ARG", async () => {
|
||||
const result = await runCLI(["search", "--description-format", "tekst"]);
|
||||
expect(result.exitCode).not.toBe(0);
|
||||
const err = parsedStderr(result.stderr);
|
||||
expect(err.code).toBe("BAD_ARG");
|
||||
expect(err.error).toMatch(/description-format/);
|
||||
});
|
||||
});
|
||||
|
||||
describe("--facet validation", () => {
|
||||
test("a facet without '=' exits 1 with BAD_ARG", async () => {
|
||||
const result = await runCLI(["search", "--facet", "novalue"]);
|
||||
|
||||
@@ -15,12 +15,32 @@ function captureStdout(): { get: () => string } {
|
||||
return { get: () => buf };
|
||||
}
|
||||
|
||||
function mockFetch(status: number, body: unknown): void {
|
||||
globalThis.fetch = (async () =>
|
||||
new Response(typeof body === "string" ? body : JSON.stringify(body), {
|
||||
/** Stub fetch with a canned response; the return value exposes the URL it was called with. */
|
||||
function mockFetch(status: number, body: unknown): { url: () => string } {
|
||||
let requested = "";
|
||||
globalThis.fetch = (async (input: string | URL | Request) => {
|
||||
requested = typeof input === "string" ? input : input instanceof URL ? input.href : input.url;
|
||||
return new Response(typeof body === "string" ? body : JSON.stringify(body), {
|
||||
status,
|
||||
headers: { "content-type": "application/json" },
|
||||
})) as typeof fetch;
|
||||
});
|
||||
}) as typeof fetch;
|
||||
return { url: () => requested };
|
||||
}
|
||||
|
||||
/** The query params of the URL the mocked fetch was called with. */
|
||||
function requestedParams(mock: { url: () => string }): URLSearchParams {
|
||||
return new URL(mock.url()).searchParams;
|
||||
}
|
||||
|
||||
function captureStderr(): { get: () => string; restore: () => void } {
|
||||
let buf = "";
|
||||
const original = process.stderr.write;
|
||||
process.stderr.write = ((chunk: string | Uint8Array) => {
|
||||
buf += chunk.toString();
|
||||
return true;
|
||||
}) as typeof process.stderr.write;
|
||||
return { get: () => buf, restore: () => (process.stderr.write = original) };
|
||||
}
|
||||
|
||||
function job(overrides: Partial<FreehireJob> = {}): FreehireJob {
|
||||
@@ -56,6 +76,7 @@ const searchOpts = {
|
||||
page: 1,
|
||||
limit: 25,
|
||||
format: "json" as const,
|
||||
descriptionFormat: "markdown" as const,
|
||||
regions: [] as string[],
|
||||
countries: [] as string[],
|
||||
cities: [] as string[],
|
||||
@@ -80,6 +101,61 @@ describe("runSearch (mocked fetch)", () => {
|
||||
expect(parsed.results[0].date).toBe("2026-07-06T00:00:00Z");
|
||||
});
|
||||
|
||||
test("queries the agent endpoint asking for full descriptions", async () => {
|
||||
const mock = mockFetch(200, { data: [job()], meta: { total: 1 } });
|
||||
captureStdout();
|
||||
|
||||
await runSearch({ ...searchOpts, query: "backend" });
|
||||
|
||||
expect(new URL(mock.url()).pathname).toBe("/api/v1/agent/jobs/search");
|
||||
expect(requestedParams(mock).get("include_description")).toBe("true");
|
||||
expect(requestedParams(mock).get("description_format")).toBe("markdown");
|
||||
});
|
||||
|
||||
test("asks for the requested description format", async () => {
|
||||
const mock = mockFetch(200, { data: [job()], meta: { total: 1 } });
|
||||
captureStdout();
|
||||
|
||||
await runSearch({ ...searchOpts, descriptionFormat: "text", query: "backend" });
|
||||
|
||||
expect(requestedParams(mock).get("description_format")).toBe("text");
|
||||
});
|
||||
|
||||
test("carries each hit's description verbatim, in the server's format", async () => {
|
||||
const markdown = "## About the role\n\n- Write Go\n- Ship things";
|
||||
mockFetch(200, { data: [job({ description: markdown })], meta: { total: 1 } });
|
||||
const out = captureStdout();
|
||||
|
||||
await runSearch({ ...searchOpts, query: "backend" });
|
||||
|
||||
expect(JSON.parse(out.get()).results[0].description).toBe(markdown);
|
||||
});
|
||||
|
||||
test("a hit with no description carries null, not an empty string", async () => {
|
||||
mockFetch(200, { data: [job({ description: "" })], meta: { total: 1 } });
|
||||
const out = captureStdout();
|
||||
|
||||
await runSearch({ ...searchOpts, query: "backend" });
|
||||
|
||||
expect(JSON.parse(out.get()).results[0].description).toBeNull();
|
||||
});
|
||||
|
||||
// A self-hosted freehire predating /agent/jobs/search answers 404, which apiGet
|
||||
// maps to null. Reporting that as "no results" would hide a broken endpoint
|
||||
// behind an empty, plausible-looking result set.
|
||||
test("a 404 from the search endpoint is an error, not an empty result set", async () => {
|
||||
mockFetch(404, { error: "not found" });
|
||||
const err = captureStderr();
|
||||
const out = captureStdout();
|
||||
|
||||
const code = await runSearch({ ...searchOpts, query: "backend" });
|
||||
err.restore();
|
||||
|
||||
expect(code).toBe(1);
|
||||
expect(out.get()).toBe("");
|
||||
expect(JSON.parse(err.get()).error).toMatch(/agent\/jobs\/search/);
|
||||
});
|
||||
|
||||
test("empty result set yields an empty results array", async () => {
|
||||
mockFetch(200, { data: [], meta: { total: 0 } });
|
||||
const out = captureStdout();
|
||||
|
||||
Reference in New Issue
Block a user