feat(huggingFace): refactor operator into per-task codegen + text-generation by PG1204 · Pull Request #5278 · apache/texera

PG1204 · 2026-05-28T18:58:54Z

⚠️ This PR is stacked on #5124. Until that lands, the diff below includes #5124's HuggingFaceModelResource.scala and the 1-line registration in TexeraWebApplication.scala. The new code in this PR is everything under common/workflow-operator/src/main/scala/org/apache/texera/amber/operator/huggingFace/ and the new test under common/workflow-operator/src/test/.../huggingFace/HuggingFaceInferenceOpDescSpec.scala. Once #5124 merges, this diff will auto-clean to ~839 lines.

What changes were proposed in this PR?

Refactors the monolithic 1,278-line HuggingFaceInferenceOpDesc from the team's feature branch into a dispatcher + per-task codegen architecture and ships the first task family (text-generation):

codegen/TaskCodegen.scala introduces the trait + CodegenContext that model per-task variation.
codegen/PythonCodegenBase.scala emits the shared provider-fallback / process_table / _parse_response infrastructure with two holes for the per-task payload and parse snippets.
codegen/TextGenCodegen.scala supplies text-generation's chat-completions payload and the body["choices"][0 ["message"]["content"] parse branch.
HuggingFaceInferenceOpDesc.scala becomes a thin (~180-line) dispatcher holding the @JsonProperty fields and the registeredCodegens map.

User-input string fields are typed EncodableString and emitted via the pyb"..." macro so values reach Python as self.decode_python_template('<base64>') rather than raw literals. Class constants are assigned in open(self) so self is in scope for the decode call. The generated process_table runs a defensive _HF_MODEL_ID_PATTERN check at runtime before any HF URL is composed.

The TaskCodegen trait also exposes a tasks: Set[String] default so a single codegen can register under multiple task strings, this becomes relevant in PR 3 (image family).

Any related issues, documentation, or discussions?

Tracked in #5277 & #5041(umbrella issue for the HuggingFace operator end-to-end implementation).

Closes #5277

Stacked on #5124 (PR 1 - REST resource).

This is PR 2 of a multi-PR series landing the HuggingFace operator end-to-end. The full plan and umbrella issue live separately; this PR's scope is exactly the dispatcher pattern + text-generation codegen.

How was this PR tested?

sbt "WorkflowOperator/compile; WorkflowOperator/Test/compile" clean.
sbt scalafmtCheck clean.
sbt "WorkflowOperator/testOnly org.apache.texera.amber.operator.huggingFace.HuggingFaceInferenceOpDescSpec" - 10/10 pass (operator info, validation, codegen wiring, MODEL_ID runtime check, leak-prevention, clamping, schema).
sbt "WorkflowOperator/testOnly org.apache.texera.amber.util.PythonCodeRawInvalidTextSpec" - 117/117 descriptors py_compile cleanly, no raw-text leaks. The new operator is included in this scan.
Generated Python verified via python3 -m py_compile on a sample output.

Was this PR authored or co-authored using generative AI tooling?

Co-authored with Claude Opus 4.7

…d media proxy Introduces a new Jersey REST resource exposing endpoints used by the upcoming HuggingFace operator UI: - GET /api/huggingface/models — browse / search models per task - GET /api/huggingface/tasks — list HF pipeline tags with hosted inference - POST /api/huggingface/upload-audio — upload audio for HF audio tasks - GET /api/huggingface/audio-preview — stream uploaded audio (path-validated) - GET /api/huggingface/media-proxy — proxy remote media URLs to bypass CORS This is the first PR in a stacked series landing the HF operator end-to-end. No operator code yet; this resource is independently useful and lets the frontend integrate with HF before the operator class lands.

Addresses xuang7's review on PR apache#5124 — both endpoints previously buffered the full payload into a heap-resident byte[] with no upper bound, leaving the JVM open to OOM on a hostile or buggy upstream response (/media-proxy) or out-of-band write into the audio temp dir (/audio-preview). - /media-proxy: switch from Unirest.asBytes() to asObject(Function<RawResponse, T>), streaming the upstream body in 8 KiB chunks with a running byte counter. Aborts with 413 if the declared Content-Length exceeds the cap (pre-check) or if the body crosses the cap mid-read (defends against missing/lying Content-Length). New MAX_MEDIA_PROXY_BYTES = 50 MiB, sized for HF inference media (text-to-image ~5 MiB, text-to-video ~30 MiB) with headroom. - /audio-preview: add Files.size() defense-in-depth check before readAllBytes. /upload-audio already enforces MAX_AUDIO_BYTES on ingest; this catches the case where a bug or out-of-band write puts an oversized file in the temp dir. Adds a spec covering the audio-preview cap using a sparse-file fixture so the test stays fast (87/87 spec passes). The media-proxy cap path is exercised via the existing input-validation suite plus the new streamMediaWithCap helper - a follow-up can add a fake-RawResponse unit test if reviewers want explicit coverage of the chunked-read cap. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

codecov-commenter · 2026-05-28T19:01:36Z

Codecov Report

❌ Patch coverage is 97.36842% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 52.17%. Comparing base (cd60535) to head (78ff986).

Files with missing lines	Patch %	Lines
...rator/huggingFace/HuggingFaceInferenceOpDesc.scala	97.56%	0 Missing and 1 partial ⚠️
...ber/operator/huggingFace/codegen/TaskCodegen.scala	88.88%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #5278      +/-   ##
============================================
- Coverage     52.42%   52.17%   -0.25%     
- Complexity     2481     2503      +22     
============================================
  Files          1070     1071       +1     
  Lines         41359    41329      -30     
  Branches       4441     4445       +4     
============================================
- Hits          21682    21564     -118     
- Misses        18406    18495      +89     
+ Partials       1271     1270       -1

Flag	Coverage Δ		*Carryforward flag
access-control-service	`64.61% <ø> (ø)`
agent-service	`33.76% <ø> (ø)`		Carriedforward from 5c2eaa2
amber	`53.48% <97.36%> (+0.20%)`	⬆️
computing-unit-managing-service	`1.65% <ø> (ø)`
config-service	`56.06% <ø> (ø)`
file-service	`38.21% <ø> (ø)`
frontend	`46.36% <ø> (-0.67%)`	⬇️	Carriedforward from 5c2eaa2
pyamber	`90.60% <ø> (-0.12%)`	⬇️	Carriedforward from 5c2eaa2
python	`90.75% <ø> (ø)`		Carriedforward from 5c2eaa2
workflow-compiling-service	`58.69% <ø> (ø)`

*This pull request uses carry forward flags. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

PG1204 · 2026-05-28T20:05:43Z

/request-review @Ma77Ball

@RolesAllowed

Per review on apache#5124 (xuang7, Ma77Ball): mark the resource with @RolesAllowed(Array("REGULAR", "ADMIN")) to document that all five endpoints require an authenticated user. The annotation isn't enforced yet — that's coming with the auth-enforcement PR @Yicong-Huang and @Ma77Ball are working on — but adding it now means no follow-up change is needed when enforcement lands, and it matches the convention used by UserConfigResource / AdminSettingsResource. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

@JsonProperty

…eration Splits the monolithic 1,278-line HuggingFaceInferenceOpDesc from the team's feature branch into a dispatcher + per-task codegen architecture and ships the first task family (text-generation) end-to-end. - TaskCodegen trait + CodegenContext model the per-task variation - PythonCodegenBase emits the shared provider-fallback / process_table / _parse_response infrastructure with two holes for the per-task payload and parse snippets - TextGenCodegen supplies text-generation's chat-completions payload and the body["choices"][0]["message"]["content"] parse branch - HuggingFaceInferenceOpDesc becomes a thin dispatcher (~180 lines) holding @JsonProperty fields and the registeredCodegens map User-input string fields are typed as EncodableString and emitted via the pyb"..." macro so values reach Python as self.decode_python_template('<base64>') rather than raw literals; class constants are assigned in open(self) so self is in scope for the decode call. Generated process_table runs a defensive _HF_MODEL_ID_PATTERN check at runtime before any HF URL is composed. PR 2 of a stacked 9-PR series. PR 1 (apache#5124) ships the supporting REST resource; PRs 3-5 will add image, audio + media-gen, and QA/ranking task families by registering new *Codegen objects in the dispatcher. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

@JsonProperty

…degen specs Addresses Codecov's 66.85% patch coverage warning by exercising the defensive null-handling branches in HuggingFaceInferenceOpDesc.scala and the TextGenCodegen contract that previously had no spec hits. - null-tolerance: feed null into every @JsonProperty (token, model, prompt col, system prompt, result col, task, maxNewTokens, temperature) and assert generatePythonCode still emits a parseable ProcessTableOperator with sane defaults (TASK falls back to text-generation, MAX_NEW_TOKENS clamps to 256, TEMPERATURE to 0.7). Covers the `if (x == null) ... else x` branches that previously had no test that took the null side. - TextGenCodegen.task: trivial canonical-value check. - TextGenCodegen ctx-independence: pass an "irrelevant"-filled ctx and assert payloadPython / parsePython still reference self.MODEL_ID and body["choices"]…. Catches a future refactor that accidentally splices ctx fields into the static snippets. 13/13 in HuggingFaceInferenceOpDescSpec, 2/2 in PythonCodeRawInvalidTextSpec (117/117 descriptors still py_compile cleanly). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Ma77Ball

Please look over the suggestions below.

…NAI_COMPATIBLE_PROVIDERS to class constants

Yicong-Huang · 2026-06-07T17:27:13Z

Hi @PG1204 what is the status of this PR? not sure if it is ready for review, given the note about stacked PR, is the current diff accurate?

PG1204 · 2026-06-07T20:39:31Z

Hi @PG1204 what is the status of this PR? not sure if it is ready for review, given the note about stacked PR, is the current diff accurate?

@Yicong-Huang The comments given by @Ma77Ball have been resolved, awaiting further review.
Yep the current diff is accurate.

PG1204 · 2026-06-07T23:07:44Z

Hi @PG1204 what is the status of this PR? not sure if it is ready for review, given the note about stacked PR, is the current diff accurate?

@Yicong-Huang This is PR-2 in the stacked PRs for the HuggingFace operator. PR-1 was merged a while back.

Ma77Ball

Overall LGTM! I think the below can be implemented or left as is.

…duplication

PG1204 and others added 7 commits May 17, 2026 13:02

fix: address review feedback on HuggingFaceModelResource

935ccc1

Merge branch 'apache:main' into hf/01-backend-skeleton

089c3c4

Merge branch 'apache:main' into hf/01-backend-skeleton

2aa865c

Merge branch 'apache:main' into hf/01-backend-skeleton

0c30beb

chore: retrigger CI

6857e34

github-actions Bot assigned PG1204 May 28, 2026

github-actions Bot added engine common labels May 28, 2026

PG1204 and others added 7 commits May 28, 2026 13:06

Merge branch 'apache:main' into hf/01-backend-skeleton

6f0f5fb

Merge branch 'main' into hf/01-backend-skeleton

fec6dfb

Merge branch 'apache:main' into hf/01-backend-skeleton

5e95bcd

fix: scala lint fixes

8350eb9

PG1204 force-pushed the hf/02-operator-textgen branch from 61e6c41 to 8350eb9 Compare May 29, 2026 20:38

Merge branch 'apache:main' into hf/02-operator-textgen

2efa337

github-actions Bot removed the engine label Jun 2, 2026

This was referenced Jun 3, 2026

Add image task family (ImageTaskCodegen) to HuggingFace operator #5319

Open

feat(huggingFace): add image task family via ImageTaskCodegen #5320

Open

Merge branch 'apache:main' into hf/02-operator-textgen

c44d7d0

Ma77Ball suggested changes Jun 4, 2026

View reviewed changes

Comment thread .../src/main/scala/org/apache/texera/amber/operator/huggingFace/codegen/PythonCodegenBase.scala Outdated

Comment thread .../src/main/scala/org/apache/texera/amber/operator/huggingFace/codegen/PythonCodegenBase.scala Outdated

PG1204 and others added 3 commits June 5, 2026 12:39

refactor(huggingFace): cap HTTP error detail + lift CHAT_ROUTES / OPE…

28fcab0

…NAI_COMPATIBLE_PROVIDERS to class constants

Merge branch 'apache:main' into hf/02-operator-textgen

eb9d6d1

Merge branch 'apache:main' into hf/02-operator-textgen

89e0819

Merge branch 'apache:main' into hf/02-operator-textgen

0f38215

Ma77Ball approved these changes Jun 10, 2026

View reviewed changes

Comment thread ...src/main/scala/org/apache/texera/amber/operator/huggingFace/HuggingFaceInferenceOpDesc.scala Outdated

PG1204 and others added 3 commits June 9, 2026 17:52

Merge branch 'apache:main' into hf/02-operator-textgen

48890a6

refactor(huggingFace): extract resolvedResultColumn helper to remove …

0304702

…duplication

Merge branch 'apache:main' into hf/02-operator-textgen

78ff986

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(huggingFace): refactor operator into per-task codegen + text-generation#5278

feat(huggingFace): refactor operator into per-task codegen + text-generation#5278
PG1204 wants to merge 23 commits into
apache:mainfrom
ELin2025:hf/02-operator-textgen

PG1204 commented May 28, 2026 •

edited

Loading

Uh oh!

codecov-commenter commented May 28, 2026 •

edited

Loading

Uh oh!

PG1204 commented May 28, 2026

Uh oh!

Ma77Ball left a comment

Uh oh!

Uh oh!

Uh oh!

Yicong-Huang commented Jun 7, 2026

Uh oh!

PG1204 commented Jun 7, 2026

Uh oh!

PG1204 commented Jun 7, 2026

Uh oh!

Ma77Ball left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

PG1204 commented May 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changes were proposed in this PR?

Any related issues, documentation, or discussions?

How was this PR tested?

Was this PR authored or co-authored using generative AI tooling?

Uh oh!

codecov-commenter commented May 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

PG1204 commented May 28, 2026

Uh oh!

Ma77Ball left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Yicong-Huang commented Jun 7, 2026

Uh oh!

PG1204 commented Jun 7, 2026

Uh oh!

PG1204 commented Jun 7, 2026

Uh oh!

Ma77Ball left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

PG1204 commented May 28, 2026 •

edited

Loading

codecov-commenter commented May 28, 2026 •

edited

Loading