[Tech Debt]Add cross-language resource consistency checking tool by da-daken · Pull Request #579 · apache/flink-agents

da-daken · 2026-03-19T15:46:55Z

Linked issue: #xxx

Purpose of change

to fix that 'It would be nice check in CI that the referenced class actually exist, and names in Java and Python are consistent.'

Tests

API

no API

doc-needed
doc-not-needed
doc-included

da-daken · 2026-03-22T07:10:03Z

hi @xintongsong , This push did not trigger CI. I noticed that the error message in CI indicates that astral-sh/setup-uv@v4 is not allowed, but I didn't add it. How should I resolve this issue? and hope you can review when you have time!

xintongsong · 2026-03-25T11:02:56Z

@da-daken Sorry for the late response. It took us a bit time to fix the CI issue. Now the CI should be properly triggered.

da-daken · 2026-03-26T05:20:49Z

@xintongsong Thank you for resolving the CI issue. Now the CI has all passed. You can review it when you have time. The plan is for both the Java side and the Python side to check whether their own classes exist, and then a consistency script will determine if both sides are consistent. This way, we can verify that the classes on both sides can be correctly loaded.

wenjin272

Hi, @da-daken, thanks for your work. I think the three added tests—java ut, python ut, and java vs. python e2e—can ensure consistency in resource names. I left some minor comments.

wenjin272 · 2026-03-30T02:38:10Z

.github/workflows/ci.yml

          echo "$HOME/.local/bin" >> $GITHUB_PATH
      - name: Check code style
        run: ./tools/lint.sh -c
+      - name: Check ResourceName consistency (Java vs Python)


I think that placing consistency checks for resource names within code style checks is not entirely appropriate, because code style typically refers to the checking of coding conventions and rules within a single language. I think it is more appropriate to include it in the cross-language test.

wenjin272 · 2026-03-30T02:40:12Z

python/pyproject.toml

 test = [
    "pytest==8.4.0",
+    "apache-flink>=1.20",
+    "cloudpickle",


If the consistency check for resource names is moved to the cross-language test, these additional dependencies are unnecessary because we manually install apache-flink in tools/e2e.sh.

yes, you're right! thank you for your review! I will commit soon

wenjin272 · 2026-03-31T09:01:46Z

.github/workflows/ci.yml

+          tools/e2e.sh
+      - name: Check ResourceName consistency (Java vs Python)
+        working-directory: python
+        run: uv run --no-sync python ../tools/check_resource_consistency.py


I think we can add this test to e2e.sh instead of creating a separate job stage.

Yes, it looks cleaner this way, I will move it to e2e.sh

wenjin272 · 2026-04-01T06:39:06Z

LGTM. Please take a look at your convenience @xintongsong .

xintongsong

Thanks for working on this, @da-daken and @wenjin272. I left 2 more comments. PTAL.

xintongsong · 2026-04-02T08:57:47Z

e2e-test/test-scripts/check_resource_consistency.py

+    ("OPENAI_COMPLETIONS_CONNECTION", "OPENAI_CONNECTION"),
+    ("OPENAI_COMPLETIONS_SETUP", "OPENAI_SETUP"),
+}
+


Instead of maintaining _NAME_ALIASES to work around naming inconsistencies between Java and Python, I think we should fix the root cause — unify the constant names on both sides.

thanks for you review , I have fixed consistency between Python resourceName and Java resourceName!

xintongsong · 2026-04-02T08:58:52Z

e2e-test/test-scripts/check_resource_consistency.py

+from pathlib import Path
+
+
+def parse_java_resource_name(java_path: Path) -> dict:


Shall we place this script in e2e-test/test-scripts/? tools/ is meant for scripts directly executed by developers / maintainers. Those indirectly invoked by e2e.sh should be placed in e2e-test/test-scripts/.

wenjin272

Hi, @da-daken, only one comment.

wenjin272 · 2026-04-08T11:26:55Z

python/flink_agents/api/resource.py

-        OPENAI_CONNECTION = "flink_agents.integrations.chat_models.openai.openai_chat_model.OpenAIChatModelConnection"
-        OPENAI_SETUP = "flink_agents.integrations.chat_models.openai.openai_chat_model.OpenAIChatModelSetup"
+        OPENAI_COMPLETIONS_CONNECTION = "flink_agents.integrations.chat_models.openai.openai_chat_model.OpenAIChatModelConnection"
+        OPENAI_COMPLETIONS_SETUP = "flink_agents.integrations.chat_models.openai.openai_chat_model.OpenAIChatModelSetup"


We need to synchronously update all instances in the documentation where these constants are used.

@wenjin272 are you willing to push again? It looks like the CI failure is an environment issue.

Hi, @da-daken, the "documents" mentioned here refer not only to docstrings in Python files but also to Markdown files in the docs directory. You can perform a global search for the usage of these two constants.

hi @wenjin272 , I updated all the references in the latest commit.

wenjin272

LGTM

wenjin272

LGTM

github-actions bot added doc-not-needed Your PR changes do not impact docs fixVersion/0.3.0 The feature or bug should be implemented/fixed in the 0.3.0 version. priority/major Default priority of the PR or issue. and removed doc-not-needed Your PR changes do not impact docs labels Mar 19, 2026

xintongsong mentioned this pull request Mar 20, 2026

[Tech Debt] Guard resource name consistency with CI #566

Open

2 tasks

da-daken added 2 commits March 25, 2026 19:02

[Tech Debt]Add cross-language resource consistency checking tool

59d8178

[test]ResourceCheckTest add Apache licence

af72ae0

xintongsong force-pushed the resource_ci_check branch from 9e29579 to af72ae0 Compare March 25, 2026 11:02

yan.xu added 2 commits March 26, 2026 11:28

[test] Fix Ruff violations in test_resource_name

355cd9d

[test] Fix code style

794447a

wenjin272 reviewed Mar 30, 2026

View reviewed changes

[ci] Remove check resourceName to cross_language_tests

5e58192

wenjin272 reviewed Mar 31, 2026

View reviewed changes

[ci] Remove check resourceName to e2e.sh

ea4c427

xintongsong reviewed Apr 2, 2026

View reviewed changes

[ci] Fix consistency between Python resourceName and Java resourceName

0f9079d

wenjin272 reviewed Apr 8, 2026

View reviewed changes

da-daken and others added 2 commits April 8, 2026 22:18

[doc] fix resource.py doc

ca20c9a

[doc] fix resourceName in docs

5560280

wenjin272 reviewed Apr 9, 2026

View reviewed changes

wenjin272 approved these changes Apr 9, 2026

View reviewed changes

da-daken requested a review from xintongsong April 10, 2026 08:16

		from pathlib import Path


		def parse_java_resource_name(java_path: Path) -> dict:

Conversation

da-daken commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose of change

Tests

API

Uh oh!

da-daken commented Mar 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xintongsong commented Mar 25, 2026

Uh oh!

da-daken commented Mar 26, 2026

Uh oh!

wenjin272 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wenjin272 commented Apr 1, 2026

Uh oh!

xintongsong left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wenjin272 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

da-daken Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wenjin272 left a comment

Choose a reason for hiding this comment

Uh oh!

wenjin272 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

da-daken commented Mar 19, 2026 •

edited

Loading

da-daken commented Mar 22, 2026 •

edited

Loading

da-daken Apr 9, 2026 •

edited

Loading