Add local development setup for RACM debugging by glemson · Pull Request #93 · sciserver/opensciserver

glemson · 2026-03-03T18:27:30Z

Add documentation and configuration changes to support running RACM locally via Spring Boot embedded Tomcat for development and debugging.

Add RACM README.md with local setup, build, and Eclipse instructions
Exclude spring-boot-starter-logging globally to prevent log4j bridge conflicts
Exclude org.springframework.boot.jdbc from AspectJ weaving (Oracle classes)
Add .gitignore entries for Eclipse artifacts, AspectJ dumps, and RACM lib/
Add racm .gitignore for lib/ and WebContent/WEB-INF/classes/

Add documentation and configuration changes to support running RACM locally via Spring Boot embedded Tomcat for development and debugging. - Add RACM README.md with local setup, build, and Eclipse instructions - Exclude spring-boot-starter-logging globally to prevent log4j bridge conflicts - Exclude org.springframework.boot.jdbc from AspectJ weaving (Oracle classes) - Add .gitignore entries for Eclipse artifacts, AspectJ dumps, and RACM lib/ - Add racm .gitignore for lib/ and WebContent/WEB-INF/classes/ Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Copilot

Pull request overview

Adds local-development documentation and configuration tweaks to make the RACM service easier to run/debug locally (embedded Tomcat + AspectJ LTW), while also adjusting repository ignores and build configuration to avoid logging/weaving conflicts.

Changes:

Document RACM local build/run/debug workflow (including required javaagents) and add RACM-specific developer notes.
Update AspectJ weaving config to exclude org.springframework.boot.jdbc..*.
Add/extend .gitignore entries and globally exclude spring-boot-starter-logging from Java subprojects.

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`components/java/racm/src/main/resources/META-INF/aop.xml`	Excludes Spring Boot JDBC packages from AspectJ weaving.
`components/java/racm/README.md`	New RACM local setup/build/run/debug documentation.
`components/java/racm/CLAUDE.md`	New RACM component notes (build/debug/config/architecture).
`components/java/racm/.gitignore`	Ignores local-only RACM libs and Eclipse/Tomcat class output.
`components/java/build.gradle`	Globally excludes `spring-boot-starter-logging` from all Java subprojects.
`.gitignore`	Adds ignores for Eclipse artifacts, AspectJ dumps, and backup files.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

components/java/racm/CLAUDE.md

Copilot · 2026-03-03T19:13:57Z

components/java/build.gradle

+    configurations.all {
+        exclude group: 'org.springframework.boot', module: 'spring-boot-starter-logging'


The global exclusion of spring-boot-starter-logging for all Java subprojects is likely to break projects that rely on it transitively. For example, fileservice-bootstrapper uses org.apache.logging.log4j.* but only depends on spring-boot-starter; it currently gets log4j-api via spring-boot-starter-logging (through log4j-to-slf4j). With this change, that module will no longer compile/run with logging. Consider scoping this exclusion only to Spring Boot apps that explicitly add spring-boot-starter-log4j2, or alternatively add explicit logging dependencies (e.g., log4j-api / spring-boot-starter-log4j2) to the affected projects instead of excluding globally.

Suggested change

configurations.all {

exclude group: 'org.springframework.boot', module: 'spring-boot-starter-logging'

afterEvaluate { project ->

def implementationConfig = project.configurations.findByName('implementation')

def hasLog4j2Starter = implementationConfig?.dependencies?.any { dep ->

dep.group == 'org.springframework.boot' && dep.name == 'spring-boot-starter-log4j2'

}

if (hasLog4j2Starter) {

configurations.all {

exclude group: 'org.springframework.boot', module: 'spring-boot-starter-logging'

}

}

Copilot · 2026-03-03T19:13:58Z

components/java/racm/README.md

+- Java 17 JDK
+- SQL Server with a `racm` database
+- Two Java agent JARs (required by AspectJ load-time weaving and EclipseLink):
+  - `aspectjweaver-1.9.22.1.jar` (available in Gradle cache after building)
+  - `spring-instrument-5.3.31.jar` (download from Maven Central, store in `racm/lib/` which is gitignored)
+


This README hard-codes spring-instrument-5.3.31.jar for the -javaagent, but the RACM Gradle build currently declares Spring Boot starter dependencies at 3.2.2 (while the plugin is 2.7.18). If RACM is effectively on Spring Boot 3/Spring Framework 6, the spring-instrument major version must match (5.x vs 6.x) or load-time weaving may fail. Consider updating the README to derive the required agent version from the Gradle build (or add org.springframework:spring-instrument as a Gradle dependency and instruct developers to use the jar from the Gradle cache).

this caused a consistency problem with other components when actually trying to run racm from within eclipse. simplest solution was to have the library explicitly loaded here.

Add documentation and configuration changes to support running RACM locally via Spring Boot embedded Tomcat for development and debugging. - Add RACM README.md with local setup, build, and Eclipse instructions - Exclude spring-boot-starter-logging globally to prevent log4j bridge conflicts - Exclude org.springframework.boot.jdbc from AspectJ weaving (Oracle classes) - Add .gitignore entries for Eclipse artifacts, AspectJ dumps, and RACM lib/ - Add racm .gitignore for lib/ and WebContent/WEB-INF/classes/ Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

amitschang · 2026-03-05T15:07:45Z

components/java/racm/CLAUDE.md

@@ -0,0 +1,39 @@
+# RACM Component
+
+## Code Style


much of this file is generic either the repo as a whole or the java projects within. Perhaps it is prudent to place much of it at a higher level in the repo sooner rather than later?

agreed, but let's discuss our GenAI usage and how it is reflected in the code base in general.

I think it is probably best for this PR to leave the CLAUDE.md file here and later when working in the larger context to add a file there and maybe move some of the current content up.

amitschang · 2026-03-05T15:11:25Z

components/java/racm/README.md

+### Prerequisites
+
+- Java 17 JDK
+- SQL Server with a `racm` database


Could supply more information on this (e.g. version requirements, how to start one in docker), or we can add a reference to the relevant place in the helm chart to look

the database could also be named differently as long as it is properly set in the config file(s)

amitschang · 2026-03-05T15:13:36Z

components/java/springutils/build.gradle

+        api('org.springframework.boot:spring-boot-starter-web:2.6.6') {
+            exclude group: 'org.springframework.boot', module: 'spring-boot-starter-logging'
+        }


I think this better belongs in the racm gradle file, similar to that of fileservice. However if there is another reason to do it here due to eclipse, we probably want to create an issue to track a resolution

I think we want to homogenize how logging is done anyway I think? so an issue is in order.
This is still a draft and let's have some further discussion how to.

I think I'd like to take the current solution, issue an issue and move towards updating the logging of racm.

glemson requested review from amitschang, Copilot and jkim485 March 3, 2026 18:27

Copilot started reviewing on behalf of glemson March 3, 2026 19:10 View session

Copilot AI reviewed Mar 3, 2026

View reviewed changes

glemson and others added 2 commits March 3, 2026 14:37

reverting root build.gradle file

74b1376

glemson marked this pull request as draft March 3, 2026 21:02

glemson force-pushed the eclipse-config branch 3 times, most recently from cdbfbf6 to 71d0595 Compare March 4, 2026 12:42

remove artefacts from root build.gradle

c965322

glemson force-pushed the eclipse-config branch from 71d0595 to c965322 Compare March 4, 2026 12:45

amitschang reviewed Mar 5, 2026

View reviewed changes

glemson marked this pull request as ready for review March 7, 2026 13:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add local development setup for RACM debugging#93

Add local development setup for RACM debugging#93
glemson wants to merge 4 commits intomainfrom
eclipse-config

glemson commented Mar 3, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI Mar 3, 2026

Uh oh!

Copilot AI Mar 3, 2026

Uh oh!

glemson Mar 4, 2026

Uh oh!

amitschang Mar 5, 2026

Uh oh!

glemson Mar 6, 2026

Uh oh!

glemson Mar 7, 2026

Uh oh!

amitschang Mar 5, 2026

Uh oh!

glemson Mar 6, 2026

Uh oh!

amitschang Mar 5, 2026

Uh oh!

glemson Mar 6, 2026

Uh oh!

glemson Mar 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		configurations.all {
		exclude group: 'org.springframework.boot', module: 'spring-boot-starter-logging'

-    configurations.all {
-        exclude group: 'org.springframework.boot', module: 'spring-boot-starter-logging'
+    afterEvaluate { project ->
+        def implementationConfig = project.configurations.findByName('implementation')
+        def hasLog4j2Starter = implementationConfig?.dependencies?.any { dep ->
+            dep.group == 'org.springframework.boot' && dep.name == 'spring-boot-starter-log4j2'
+        }
+        if (hasLog4j2Starter) {
+            configurations.all {
+                exclude group: 'org.springframework.boot', module: 'spring-boot-starter-logging'
+            }
+        }

Conversation

glemson commented Mar 3, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 3, 2026

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants