This is an automated email from the ASF dual-hosted git repository.
linxinyuan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/texera.git
The following commit(s) were added to refs/heads/main by this push:
new cb7da2a035 feat: add run configurations to improve developer
experience (#4087)
cb7da2a035 is described below
commit cb7da2a03537b2d35b6298c3795d47e5aa48beda
Author: LJX2017 <[email protected]>
AuthorDate: Mon Dec 1 19:22:19 2025 -0800
feat: add run configurations to improve developer experience (#4087)
<!--
Thanks for sending a pull request (PR)! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines:
[Contributing to
Texera](https://github.com/apache/texera/blob/main/CONTRIBUTING.md)
2. Ensure you have added or run the appropriate tests for your PR
3. If the PR is work in progress, mark it a draft on GitHub.
4. Please write your PR title to summarize what this PR proposes, we
are following Conventional Commits style for PR titles as well.
5. Be sure to keep the PR description updated to reflect all changes.
-->
### What changes were proposed in this PR?
<!--
Please clarify what changes you are proposing. The purpose of this
section
is to outline the changes. Here are some tips for you:
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
3. If it is a refactoring, clarify what has been changed.
3. It would be helpful to include a before-and-after comparison using
screenshots or GIFs.
4. Please consider writing useful notes for better and faster reviews.
-->
This PR adds pre-configured IntelliJ run configurations for:
- launching all 8 backend microservices,
- the frontend service,
- and lakeFS via Docker Compose.
With these changes, developers can now launch the backend services,
lakeFS, and frontend directly from IntelliJ’s run menu, eliminating the
need to manually locate and configure each relevant class or compose
file. This leverages IntelliJ’s built-in Compound and individual run
configurations, so no additional plugins are required.
https://github.com/user-attachments/assets/9ef8fb13-2dc3-4598-ba44-0540d37202db
### Any related issues, documentation, discussions?
<!--
Please use this section to link other resources if not mentioned
already.
1. If this PR fixes an issue, please include `Fixes #1234`, `Resolves
#1234`
or `Closes #1234`. If it is only related, simply mention the issue
number.
2. If there is design documentation, please add the link.
3. If there is a discussion in the mailing list, please add the link.
-->
Fixes #4045
### How was this PR tested?
<!--
If tests were added, say they were added here. Or simply mention that if
the PR
is tested with existing test cases. Make sure to include/update test
cases that
check the changes thoroughly including negative and positive cases if
possible.
If it was tested in a way different from regular unit tests, please
clarify how
you tested step by step, ideally copy and paste-able, so that other
reviewers can
test and check, and descendants can verify in the future. If tests were
not added,
please describe why they were not added and/or why it was difficult to
add.
-->
Verified on a local IntelliJ IDEA environment. The Compound run config
cleanly launches all backend microservices in parallel.
### Was this PR authored or co-authored using generative AI tooling?
<!--
If generative AI tooling has been used in the process of authoring this
PR,
please include the phrase: 'Generated-by: ' followed by the name of the
tool
and its version. If no, write 'No'.
Please refer to the [ASF Generative Tooling
Guidance](https://www.apache.org/legal/generative-tooling.html) for
details.
-->
No
---------
Co-authored-by: Xinyuan Lin <[email protected]>
Co-authored-by: Chen Li <[email protected]>
---
.run/AccessControlService.run.xml | 33 +++++++++++++++++++++++++++++++
.run/ComputingUnitManagingService.run.xml | 33 +++++++++++++++++++++++++++++++
.run/ComputingUnitMaster.run.xml | 33 +++++++++++++++++++++++++++++++
.run/ComputingUnitWorker.run.xml | 33 +++++++++++++++++++++++++++++++
.run/ConfigService.run.xml | 33 +++++++++++++++++++++++++++++++
.run/FileService.run.xml | 33 +++++++++++++++++++++++++++++++
.run/TexeraWebApplication.run.xml | 33 +++++++++++++++++++++++++++++++
.run/WorkflowCompilingService.run.xml | 33 +++++++++++++++++++++++++++++++
.run/frontend.run.xml | 30 ++++++++++++++++++++++++++++
.run/texera micro services.run.xml | 31 +++++++++++++++++++++++++++++
.run/texera-lakefs.run.xml | 28 ++++++++++++++++++++++++++
11 files changed, 353 insertions(+)
diff --git a/.run/AccessControlService.run.xml
b/.run/AccessControlService.run.xml
new file mode 100644
index 0000000000..20e908f2ad
--- /dev/null
+++ b/.run/AccessControlService.run.xml
@@ -0,0 +1,33 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<component name="ProjectRunConfigurationManager">
+ <configuration default="false" name="AccessControlService"
type="Application" factoryName="Application">
+ <option name="MAIN_CLASS_NAME"
value="org.apache.texera.service.AccessControlService" />
+ <module name="texera.access-control-service.main" />
+ <extension name="coverage">
+ <pattern>
+ <option name="PATTERN" value="org.apache.texera.service.*" />
+ <option name="ENABLED" value="true" />
+ </pattern>
+ </extension>
+ <method v="2">
+ <option name="Make" enabled="true" />
+ </method>
+ </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/ComputingUnitManagingService.run.xml
b/.run/ComputingUnitManagingService.run.xml
new file mode 100644
index 0000000000..c7a2c4bf85
--- /dev/null
+++ b/.run/ComputingUnitManagingService.run.xml
@@ -0,0 +1,33 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<component name="ProjectRunConfigurationManager">
+ <configuration default="false" name="ComputingUnitManagingService"
type="Application" factoryName="Application">
+ <option name="MAIN_CLASS_NAME"
value="org.apache.texera.service.ComputingUnitManagingService" />
+ <module name="texera.computing-unit-managing-service.main" />
+ <extension name="coverage">
+ <pattern>
+ <option name="PATTERN" value="org.apache.texera.service.*" />
+ <option name="ENABLED" value="true" />
+ </pattern>
+ </extension>
+ <method v="2">
+ <option name="Make" enabled="true" />
+ </method>
+ </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/ComputingUnitMaster.run.xml b/.run/ComputingUnitMaster.run.xml
new file mode 100644
index 0000000000..78a818af29
--- /dev/null
+++ b/.run/ComputingUnitMaster.run.xml
@@ -0,0 +1,33 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<component name="ProjectRunConfigurationManager">
+ <configuration default="false" name="ComputingUnitMaster" type="Application"
factoryName="Application">
+ <option name="MAIN_CLASS_NAME"
value="org.apache.texera.web.ComputingUnitMaster" />
+ <module name="texera.amber.main" />
+ <extension name="coverage">
+ <pattern>
+ <option name="PATTERN" value="org.apache.texera.web.*" />
+ <option name="ENABLED" value="true" />
+ </pattern>
+ </extension>
+ <method v="2">
+ <option name="Make" enabled="true" />
+ </method>
+ </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/ComputingUnitWorker.run.xml b/.run/ComputingUnitWorker.run.xml
new file mode 100644
index 0000000000..a5e4c90505
--- /dev/null
+++ b/.run/ComputingUnitWorker.run.xml
@@ -0,0 +1,33 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<component name="ProjectRunConfigurationManager">
+ <configuration default="false" name="ComputingUnitWorker" type="Application"
factoryName="Application">
+ <option name="MAIN_CLASS_NAME"
value="org.apache.texera.web.ComputingUnitWorker" />
+ <module name="texera.amber.main" />
+ <extension name="coverage">
+ <pattern>
+ <option name="PATTERN" value="org.apache.texera.web.*" />
+ <option name="ENABLED" value="true" />
+ </pattern>
+ </extension>
+ <method v="2">
+ <option name="Make" enabled="true" />
+ </method>
+ </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/ConfigService.run.xml b/.run/ConfigService.run.xml
new file mode 100644
index 0000000000..cfbd94abc9
--- /dev/null
+++ b/.run/ConfigService.run.xml
@@ -0,0 +1,33 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<component name="ProjectRunConfigurationManager">
+ <configuration default="false" name="ConfigService" type="Application"
factoryName="Application">
+ <option name="MAIN_CLASS_NAME"
value="org.apache.texera.service.ConfigService" />
+ <module name="texera.config-service.main" />
+ <extension name="coverage">
+ <pattern>
+ <option name="PATTERN" value="org.apache.texera.service.*" />
+ <option name="ENABLED" value="true" />
+ </pattern>
+ </extension>
+ <method v="2">
+ <option name="Make" enabled="true" />
+ </method>
+ </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/FileService.run.xml b/.run/FileService.run.xml
new file mode 100644
index 0000000000..76a3f5cf31
--- /dev/null
+++ b/.run/FileService.run.xml
@@ -0,0 +1,33 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<component name="ProjectRunConfigurationManager">
+ <configuration default="false" name="FileService" type="Application"
factoryName="Application">
+ <option name="MAIN_CLASS_NAME"
value="org.apache.texera.service.FileService" />
+ <module name="texera.file-service.main" />
+ <extension name="coverage">
+ <pattern>
+ <option name="PATTERN" value="org.apache.texera.service.*" />
+ <option name="ENABLED" value="true" />
+ </pattern>
+ </extension>
+ <method v="2">
+ <option name="Make" enabled="true" />
+ </method>
+ </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/TexeraWebApplication.run.xml
b/.run/TexeraWebApplication.run.xml
new file mode 100644
index 0000000000..b6537a0ef1
--- /dev/null
+++ b/.run/TexeraWebApplication.run.xml
@@ -0,0 +1,33 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<component name="ProjectRunConfigurationManager">
+ <configuration default="false" name="TexeraWebApplication"
type="Application" factoryName="Application">
+ <option name="MAIN_CLASS_NAME"
value="org.apache.texera.web.TexeraWebApplication" />
+ <module name="texera.amber.main" />
+ <extension name="coverage">
+ <pattern>
+ <option name="PATTERN" value="org.apache.texera.web.*" />
+ <option name="ENABLED" value="true" />
+ </pattern>
+ </extension>
+ <method v="2">
+ <option name="Make" enabled="true" />
+ </method>
+ </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/WorkflowCompilingService.run.xml
b/.run/WorkflowCompilingService.run.xml
new file mode 100644
index 0000000000..78f1a05861
--- /dev/null
+++ b/.run/WorkflowCompilingService.run.xml
@@ -0,0 +1,33 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<component name="ProjectRunConfigurationManager">
+ <configuration default="false" name="WorkflowCompilingService"
type="Application" factoryName="Application">
+ <option name="MAIN_CLASS_NAME"
value="org.apache.texera.service.WorkflowCompilingService" />
+ <module name="texera.workflow-compiling-service.main" />
+ <extension name="coverage">
+ <pattern>
+ <option name="PATTERN" value="org.apache.texera.service.*" />
+ <option name="ENABLED" value="true" />
+ </pattern>
+ </extension>
+ <method v="2">
+ <option name="Make" enabled="true" />
+ </method>
+ </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/frontend.run.xml b/.run/frontend.run.xml
new file mode 100644
index 0000000000..8132f57602
--- /dev/null
+++ b/.run/frontend.run.xml
@@ -0,0 +1,30 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<component name="ProjectRunConfigurationManager">
+ <configuration default="false" name="frontend" type="js.build_tools.npm">
+ <package-json value="$PROJECT_DIR$/frontend/package.json" />
+ <command value="run" />
+ <scripts>
+ <script value="start" />
+ </scripts>
+ <node-interpreter value="project" />
+ <envs />
+ <method v="2" />
+ </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/texera micro services.run.xml b/.run/texera micro
services.run.xml
new file mode 100644
index 0000000000..6cdb0a02a5
--- /dev/null
+++ b/.run/texera micro services.run.xml
@@ -0,0 +1,31 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<component name="ProjectRunConfigurationManager">
+ <configuration default="false" name="texera micro services"
type="CompoundRunConfigurationType">
+ <toRun name="AccessControlService" type="Application" />
+ <toRun name="ComputingUnitManagingService" type="Application" />
+ <toRun name="ComputingUnitMaster" type="Application" />
+ <toRun name="ComputingUnitWorker" type="Application" />
+ <toRun name="ConfigService" type="Application" />
+ <toRun name="FileService" type="Application" />
+ <toRun name="TexeraWebApplication" type="Application" />
+ <toRun name="WorkflowCompilingService" type="Application" />
+ <method v="2" />
+ </configuration>
+</component>
\ No newline at end of file
diff --git a/.run/texera-lakefs.run.xml b/.run/texera-lakefs.run.xml
new file mode 100644
index 0000000000..e26ec964fd
--- /dev/null
+++ b/.run/texera-lakefs.run.xml
@@ -0,0 +1,28 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<component name="ProjectRunConfigurationManager">
+ <configuration default="false" name="texera-lakefs" type="docker-deploy"
factoryName="docker-compose.yml" server-name="Docker">
+ <deployment type="docker-compose.yml">
+ <settings>
+ <option name="sourceFilePath"
value="file-service/src/main/resources/docker-compose.yml" />
+ </settings>
+ </deployment>
+ <method v="2" />
+ </configuration>
+</component>
\ No newline at end of file
