Skip to content

[ISSUE #7599] Externalize Apollo after the deprecation release - #7628

Open
yangjj-iso wants to merge 17 commits into
apache:masterfrom
yangjj-iso:feat/7599-externalize-apollo
Open

yangjj-iso wants to merge 17 commits into
apache:masterfrom
yangjj-iso:feat/7599-externalize-apollo

Conversation

@yangjj-iso

@yangjj-iso yangjj-iso commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Refs #7599. Receiving integration: apache/shenyu-plugin-store#28.

Prepare the later Apollo cutover by transferring the registry, gateway synchronization, Admin listener and starter as one stack. Remove core reactor/implementation dependencies and retired SDK licensing, preserve the apollo type, stored keys, registry SPI and ApolloPathConstants compatibility shim, and document explicit installation and rollback.

Synchronized with master 92d16c2. Preserve current upstream release notes and websocket redirect controls. The receiver also carries the upstream .list index-key correction and its regressions, so names such as blacklist/whitelist are not dropped during the transfer.

Fresh Java 17 validation: the affected Admin/Bootstrap reactor packages with main/test compilation and Checkstyle; 14 registry/SPI/classpath tests and 7 dependency-boundary script tests pass. Runtime inventories exclude com.ctrip.framework.apollo in Admin/Bootstrap. Verify and a separate root RAT check pass; whitespace checks pass.

Ready for formal code review. Do not merge in the release that introduces deprecation. Merge still requires a linked community decision, a completed released deprecation cycle, validated receiving/deployment CI, compatible external artifact publication with unique coordinate ownership, and a rollback announcement. No release/publication or fresh Docker E2E result is claimed; #7599 remains open.

CI follow-up (2026-11-06): commit fc40dda addresses the three failures in run 42014848480: wait for the master-selection error counter, wait for a peer HTTP request's asynchronous cleanup, and start the HTTP-sync WireMock fixture before Spring creates its context (using a dynamic port). Fresh Java 21 affected-reactor verify passed all 15 selected tests; all 41 Checkstyle and RAT executions passed. Fresh hosted CI is pending. The released deprecation cycle, external publication and deployment requirements above remain merge gates.

@Aias00 Aias00 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.

Review: COMMENT (draft — not approving)

Solid, complete in-tree externalization of the four Apollo modules, consistent with #7599 and the master tracking issue #7306.

What looks correct:

  • All five apollo artifacts are removed: shenyu-admin-listener-apollo, shenyu-sync-data-apollo, shenyu-registry-apollo, shenyu-spring-boot-starter-sync-data-apollo — plus their parent <module> entries, imports, and application.yml references.
  • LICENSE/NOTICE (admin + bootstrap dist) drop the apollo-client / apollo-openapi / apollo-core entries, and ApolloPathConstants is correctly kept in core as a compatibility shim with no Apollo SDK dependency.
  • .github/scripts/check-registry-dependencies.py removes apollo from both PROVIDERS and COMPATIBILITY_PROVIDERS.
  • CI is green: Analyze (java), build, and all integrated-test jobs pass.

Blocking-for-merge concern (not for the draft itself):

  • Per the migration contract this PR ships in docs/plugin-store-apollo.md, Apollo must remain available for the deprecation release, and removal requires dev-list consensus, a released deprecation cycle, external artifact publication, and an announced rollback window — with no removal release scheduled. The PR is correctly marked draft and the doc explicitly says the removal PR "must not be merged in that deprecation release." Please keep that gate: do not merge until #7627 (the deprecation notice) has actually shipped in a core release and the deprecation cycle is complete. Merging this ahead of that would contradict the contract the project is publishing.

Minor (non-blocking):

  • The doc's "store 2.7.1-SNAPSHOT against core 2.7.2-SNAPSHOT" are development coordinates; make sure the final published version replaces them with a real compatibility matrix.

Leaving as a comment because it is a draft; the mechanics are sound.

@yangjj-iso

Copy link
Copy Markdown
Contributor Author

CI update for head d2e5f8daf: dependency downloads are still blocking checks after CI was re-triggered:

  • ci / registry_dependencies: Maven Central returned 502 Bad Gateway for org.codehaus.plexus:plexus-classworlds:2.5.2, a dependency of the os-maven-plugin build extension. Maven could not read the project, so this step did not reach its tests.
  • Combination integration build: the Docker Maven plugin could not resolve the artifact descriptor for com.google.guava:guava:30.1-android.

Could a maintainer with workflow rerun permissions please rerun the failed jobs once dependency downloads are healthy? GitHub rejects reruns from my contributor account with Must have admin rights to Repository. Thank you.

# Conflicts:
#	RELEASE-NOTES.md
#	shenyu-admin-listener/shenyu-admin-listener-apollo/pom.xml
#	shenyu-bootstrap/src/main/resources/application.yml
#	shenyu-dist/shenyu-bootstrap-dist/src/main/release-docs/LICENSE
#	shenyu-registry/shenyu-registry-apollo/pom.xml
#	shenyu-spring-boot-starter/shenyu-spring-boot-starter-sync-data-center/shenyu-spring-boot-starter-sync-data-apollo/pom.xml
#	shenyu-sync-data-center/shenyu-sync-data-apollo/pom.xml
#	shenyu-sync-data-center/shenyu-sync-data-apollo/src/main/java/org/apache/shenyu/sync/data/apollo/ApolloDataService.java
#	shenyu-sync-data-center/shenyu-sync-data-apollo/src/test/java/org/apache/shenyu/sync/data/apollo/ApolloDataServiceTest.java
@yangjj-iso
yangjj-iso marked this pull request as ready for review November 1, 2026 23:22
Admin and dependencies compile/package successfully across the 37-module reactor; Checkstyle and RAT pass. Unit tests were skipped for this source-removal validation. Existing external publication and deprecation-release gates remain required before cutover.

Signed-off-by: redyyang <3202137046@qq.com>

@Aias00 Aias00 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.

Stream Agent analysis

Synthesis (FINAL) of PR #7628 "[ISSUE #7599] Externalize Apollo after the deprecation release" at head c34d578, base d7e8282, across 34 reviewed partitions (nodes 34, plan_digest 84b4fa75e02e12b7fad9e451cf18ad6cc209c214d1426d305162c73c7ba948f1, global_complete_diff true). The PR is a coherent, purely subtractive externalization: it removes the in-tree Apollo registry, sync-data and admin-listener stacks (ApolloClient, ApolloConfig, ApolloDataService, ApolloInstanceRegisterRepository, ApolloSyncConfiguration, ApolloProperties, ApolloDataChangedInit/Listener, and their tests) along with their POM modules and aggregator entries, deletes Spring Boot auto-configuration imports/spring.factories/spring.provides registrations and SPI service files, drops the apollo-client/apollo-openapi managed dependencies and the Apollo version property from the root pom, removes commented Apollo examples from several YAML resources, and updates docs (README.md, shenyu-registry/README.md, RELEASE-NOTES.md, docs/plugin-store-apollo.md) to describe Apollo as an external extension while retaining the apollo type and compatibility shims. Every child partition returned PASS with no anchoring HIGH/CRITICAL finding, and no partition reported a missing, binary or truncated patch; scope warnings correctly avoided treating prose as source and avoided inferring defects from fragment boundaries. Cross-file interactions are internally consistent: module-list removals (shenyu-registry/pom.xml, shenyu-admin-listener/pom.xml, shenyu-spring-boot-starter-sync-data-center/pom.xml, shenyu-sync-data-center/pom.xml, root pom.xml) match the deleted module POMs and sources, and the documentation count correction (six to five in-tree registry implementations) matches the removal of exactly one module. No blocking defect is asserted anywhere. However, the frozen CI evidence reports check_count 10, status_count 0, legacy_state "pending" and passed=false, i.e. CI is not observed as passed. Under the required gating rule (all_parts_passed true AND complete_diff true AND CI passed before FINAL PASS), the third condition is unmet, so this synthesis cannot return PASS despite unanimous clean partitions. Verdict is INCONCLUSIVE pending CI completion/confirmation; it is explicitly not a NEEDS_CHANGES, since no concrete blocking defect is anchored to any diff path/line. No tests were executed locally and no runtime compatibility of the external receiver repo could be verified, as it is outside this repository's diff.

Evidence

  • Batch coverage: nodes=34, partitions=34, plan_digest=84b4fa75e02e12b7fad9e451cf18ad6cc209c214d1426d305162c73c7ba948f1; globally_complete_diff=true; all_parts_passed=true; every child review_verdict=PASS with empty blocking_findings.
  • CI evidence: check_count=10, status_count=0, legacy_state="pending", passed=false — CI is not observed as passed, which blocks the FINAL PASS gate.
  • Externally-facing surface area within this repo: deletion of SPI registration, Spring Boot AutoConfiguration.imports/spring.factories/spring.provides, POM modules and root dependency management, plus README/RELEASE-NOTES/plugin-store-apollo docs describing Apollo as external with retained compatibility shims; all deletions were internally consistent across partitions.

Recommended next steps

  • Confirm final CI status for head c34d578; if all required checks pass, the FINAL verdict can be re-issued as PASS (all partitions already passed with complete diffs).
  • If CI reports failures, map them to the affected modules (registry/sync-data/admin-listener Apollo deletions, aggregator POM entries, SPI/auto-configuration removals) and escalate only concrete anchored defects.
  • If ongoing Apollo support is required, verify the external plugin-store repository actually provides the removed registrations (SPI files, spring.factories/AutoConfiguration.imports) and that the retained apollo type/compatibility shims resolve against it.

Scope: captured diff and GitHub check metadata only; no local tests were executed.

Task: 31502df2-cd08-4170-92f7-c0a6daa5482b · Commit: c34d578a3d447b353dfd3b03cf6e2dcaad2d1c8f

Review verdict: INCONCLUSIVE

This is a FINAL/synthesis pass over 34 PARTITION-level reviews of PR #7628 at head c34d578. The gating conditions for FINAL PASS are: all_parts_passed=true (satisfied), complete_diff/global_complete_diff=true (satisfied), and CI passed (NOT satisfied — the frozen evidence reports check_count=10 with status_count=0, legacy_state="pending" and passed=false). Because a required gate is demonstrably unmet rather than merely unverified by me, a PASS cannot be issued; the correct reduction is INCONCLUSIVE with no blocking findings. No child gave NEEDS_CHANGES or INCONCLUSIVE, so nothing was downgraded, and no concrete HIGH/CRITICAL defect is anchored to any path/line/side, so NEEDS_CHANGES would be unfounded. The change set is a consistent, purely subtractive externalization: removed module POMs match removed sources and aggregator entries, the doc count correction (six to five) matches the single removed in-tree registry, and no partition reported a missing, binary or truncated patch. Limitations: only this repo's diff and its partition summaries were assessed; behavior of the external plugin-store receiver, runtime compatibility of the retained apollo type/shims, and build/test execution could not be verified — no tests were executed by this review.

Publication: COMMENT (INCONCLUSIVE_REVIEW)

Review details

Synthesized review of #7628 at c34d578: the PR cleanly externalizes Apollo (registry, sync-data, admin listener and starter) after deprecation — deleting the in-tree implementations, their tests, POM modules, aggregator entries, auto-configuration/SPI registrations and managed dependencies, and updating documentation to describe Apollo as an external extension with retained compatibility shims. All 34 reviewed partitions passed with complete diffs and no anchored high or critical defects. The only gap is verification state: frozen CI evidence shows 10 checks but status_count 0 with legacy_state "pending" and passed=false, so the FINAL PASS gate (all parts passed + complete diff + CI passed) is not satisfied. Verdict: INCONCLUSIVE pending CI. This is not a request for code changes — no blocking finding was identified — and no tests were executed as part of this review.

@codecov-commenter

codecov-commenter commented Nov 5, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.90%. Comparing base (1748a0e) to head (b0dc929).
⚠️ Report is 1360 commits behind head on master.

Additional details and impacted files
@@              Coverage Diff              @@
##             master    #7628       +/-   ##
=============================================
+ Coverage     61.49%   71.90%   +10.40%     
- Complexity     8818    18131     +9313     
=============================================
  Files          1261     1762      +501     
  Lines         39273    68456    +29183     
  Branches       3725     8038     +4313     
=============================================
+ Hits          24151    49222    +25071     
- Misses        12952    15078     +2126     
- Partials       2170     4156     +1986     
Flag Coverage Δ
admin 75.54% <ø> (?)
client-register-registry 54.64% <ø> (?)
core 65.62% <ø> (?)
dist-extra 61.78% <ø> (?)
gateway-runtime 83.70% <ø> (?)
plugin-ai 76.57% <ø> (?)
plugin-base 79.79% <ø> (?)
plugin-logging 76.65% <ø> (?)
plugin-proxy 77.44% <ø> (?)
starters 74.16% <ø> (?)
starters-agent 93.65% <ø> (?)
sync 65.68% <ø> (?)

Flags with carried forward coverage won't be shown. 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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@yangjj-iso

Copy link
Copy Markdown
Contributor Author

Pushed fc40dda to address all three failures in CI run 42014848480: synchronize the error-counter assertion and asynchronous HTTP cleanup assertion, and start the HTTP-sync test server before Spring context initialization using a dynamic port. Local Java 21 verify passed all 15 selected tests and 41 Checkstyle/RAT executions. The PR description now records this validation. Fresh hosted CI is pending; external publication and released-deprecation gates remain required. Please re-review this head when CI completes.

@yangjj-iso
yangjj-iso requested a review from Aias00 November 6, 2026 12:24
@yangjj-iso

Copy link
Copy Markdown
Contributor Author

Current-head validation is complete for fc40dda: all 10 workflow runs now pass, including CI, IT and E2E.

The previously failing Admin error-counter test, reactive cancellation cleanup test and fixed-port starter test are green on the hosted run. Please re-review against this head. The completed deprecation release, compatible external publication and rollback/deployment coordination remain merge/release gates; green checks do not waive them.

@Aias00 Aias00 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.

Stream Agent analysis

SYNTHESIS/FINAL review of apache/shenyu PR #7628 (head fc40dda) aggregating child review nodes. Both direct child SYNTHESIS nodes returned INCONCLUSIVE with empty blocking_findings. all_parts_passed is false; complete_diff true but partition coverage incomplete per child reports. Per review policy, INCONCLUSIVE children cannot be overridden to PASS, and FINAL PASS requires all_parts_passed true, complete_diff true, and CI passed. Although top-level CI indicates passed, child contexts reported absent CI and incomplete partitions, preserving uncertainty. No concrete blocking defects anchored in supplied diff segments, but full cross-file correctness (externalized SPI shim, dangling references, cross-repo equivalence) remains unverified.

Evidence

  • Platform-reduce-5-0 node (task_id 97e4cf3a-19dd-4ddc-946d-9db13d03ea68) reports review_verdict INCONCLUSIVE, all_parts_passed false, complete_diff true
  • Child nodes reduce-4-0 and reduce-4-1 returned INCONCLUSIVE due to absent CI and incomplete partition coverage per attached review_reason
  • Head sha fc40dda, base sha d7e8282, title '[ISSUE #7599] Externalize Apollo after the deprecation release'

Recommended next steps

  • Complete the remaining partition reviews (all_parts_passed=false) to cover full PR diff
  • Verify CI status explicitly within each child review context to resolve contradiction
  • Re-run cross-file SYNTHESIS/FINAL after full coverage to either PASS or flag defects

Scope: captured diff and GitHub check metadata only; no local tests were executed.

Task: 515b4e84-2c95-4d3c-8b44-84007738da9f · Commit: fc40dda8eea3202f2226bf9274624aa19da9119a

Review verdict: INCONCLUSIVE

SYNTHESIS/FINAL assessment from frozen attachment: two child SYNTHESIS nodes (reduce-4-0, reduce-4-1) both INCONCLUSIVE with empty blocking_findings and complete_diff true for supplied partitions. Review rules forbid overriding child INCONCLUSIVE with PASS and require all_parts_passed true, complete_diff true, and CI passed for FINAL PASS. Attachment shows all_parts_passed=false and child contexts lacked CI, so final verdict must be INCONCLUSIVE. Scope limitations: only attached child summaries used; no local tests executed; not all PR diffs necessarily reviewed. Uncertainty about cross-file correctness and external equivalence preserved.

Publication: COMMENT (INCONCLUSIVE_REVIEW)

Review details

The attached frozen review evidence for PR #7628 shows a FINAL synthesis verdict of INCONCLUSIVE. Child review partitions were incomplete and CI evidence was contradictory/absent in child contexts, with all_parts_passed=false. Therefore, no PASS can be granted. Recommend completing all partition reviews and confirming CI in each context before final triage.

@yangjj-iso

Copy link
Copy Markdown
Contributor Author

Pushed b0dc929fe2ec9733592c50235fdfa5c5f3bbdec0 to resolve the merge conflict with master 548bec1f. Both branches had fixed the master-election test race; this merge retains upstream's final wait on the recorded error count and its ZooKeeper integration-test stabilization. The Apollo externalization behavior is unchanged.

Fresh Linux/OpenJDK 21 Admin-reactor verify passed: 37 modules, all 9 ShenyuClusterServiceTest cases, Checkstyle and RAT, with no test failures/errors/skips. Whitespace checks passed. The container needed Byte Buddy loaded at JVM startup because runtime self-attachment is unavailable.

Fresh hosted checks are starting; please review the new head after they finish. The released deprecation cycle, compatible external publication and deployment/rollback coordination remain merge gates.

This branch has not been deployed

No deployments
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.

3 participants