Skip to content

Commit

Permalink
Make nomulus work locally (#2349)
Browse files Browse the repository at this point in the history
Chose the default transaction manager based on RegistryEnvironment. This
makes it possible to run nomulus on Jetty locally. Tested with the
following:

```bash
./gradle :jetty:run -Penvironment=alpha
curl http://localhost:8080/beta.app
```

The docker image is also updated to take an argument that specifies the
environment. It runs locally as well but the container doesn't get
access to locally stored credentials, so it fails to initialize the
transaction manager.
  • Loading branch information
jianglai authored Mar 11, 2024
1 parent 34a8a94 commit 1fb27fc
Show file tree
Hide file tree
Showing 7 changed files with 55 additions and 30 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import google.registry.config.CredentialModule;
import google.registry.config.RegistryConfig.ConfigModule;
import google.registry.keyring.secretmanager.SecretManagerKeyringModule;
import google.registry.persistence.PersistenceModule.AppEngineJpaTm;
import google.registry.persistence.PersistenceModule.DefaultJpaTm;
import google.registry.persistence.PersistenceModule.ReadOnlyReplicaJpaTm;
import google.registry.persistence.transaction.JpaTransactionManager;
import google.registry.privileges.secretmanager.SecretManagerModule;
Expand All @@ -39,8 +39,8 @@
})
public interface PersistenceComponent {

@AppEngineJpaTm
JpaTransactionManager appEngineJpaTransactionManager();
@DefaultJpaTm
JpaTransactionManager jpaTransactionManager();

@ReadOnlyReplicaJpaTm
JpaTransactionManager readOnlyReplicaJpaTransactionManager();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -220,8 +220,8 @@ static TransactionManager provideTransactionManager() {

@Provides
@Singleton
@AppEngineJpaTm
static JpaTransactionManager provideAppEngineJpaTm(
@DefaultJpaTm
static JpaTransactionManager provideDefaultJpaTm(
SqlCredentialStore credentialStore,
@PartialCloudSqlConfigs ImmutableMap<String, String> cloudSqlConfigs,
Clock clock) {
Expand Down Expand Up @@ -380,10 +380,10 @@ public enum JpaTransactionManagerType {
@Documented
public @interface SchemaManagerConnection {}

/** Dagger qualifier for {@link JpaTransactionManager} used for App Engine application. */
/** Dagger qualifier for {@link JpaTransactionManager} used by default. */
@Qualifier
@Documented
@interface AppEngineJpaTm {}
@interface DefaultJpaTm {}

/** Dagger qualifier for {@link JpaTransactionManager} used inside BEAM pipelines. */
@Qualifier
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@
import static com.google.common.base.Preconditions.checkState;
import static google.registry.util.PreconditionsUtils.checkArgumentNotNull;

import com.google.appengine.api.utils.SystemProperty;
import com.google.appengine.api.utils.SystemProperty.Environment.Value;
import com.google.common.base.Suppliers;
import google.registry.persistence.DaggerPersistenceComponent;
import google.registry.tools.RegistryToolEnvironment;
Expand All @@ -43,34 +41,21 @@ private TransactionManagerFactory() {}
private static JpaTransactionManager createJpaTransactionManager() {
// If we are running a nomulus command, jpaTm will be injected in RegistryCli.java
// by calling setJpaTm().
if (isInAppEngine()) {
return DaggerPersistenceComponent.create().appEngineJpaTransactionManager();
if (RegistryEnvironment.get() != RegistryEnvironment.UNITTEST) {
return DaggerPersistenceComponent.create().jpaTransactionManager();
} else {
return DummyJpaTransactionManager.create();
}
}

private static JpaTransactionManager createReplicaJpaTransactionManager() {
if (isInAppEngine()) {
if (RegistryEnvironment.get() != RegistryEnvironment.UNITTEST) {
return DaggerPersistenceComponent.create().readOnlyReplicaJpaTransactionManager();
} else {
return DummyJpaTransactionManager.create();
}
}

/**
* This function uses App Engine API to determine if the current runtime environment is App
* Engine.
*
* @see <a
* href="https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/utils/SystemProperty">App
* Engine API public doc</a>
*/
private static boolean isInAppEngine() {
// SystemProperty.environment.value() returns null if the current runtime is local JVM
return SystemProperty.environment.value() == Value.Production;
}

/**
* Returns {@link JpaTransactionManager} instance.
*
Expand Down
6 changes: 2 additions & 4 deletions jetty/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
FROM jetty:12-jdk21
ADD --chown=jetty:jetty build/jetty-base /jetty-base
ENV JETTY_BASE=/jetty-base
WORKDIR "$JETTY_BASE"
ADD --chown=jetty:jetty start.sh /
EXPOSE 8080
ENTRYPOINT ["java", "-jar", "/usr/local/jetty/start.jar"]

ENTRYPOINT ["/bin/sh", "/start.sh"]
19 changes: 18 additions & 1 deletion jetty/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ tasks.register('copyJettyBase', Copy) {
}

war {
setArchiveBaseName("root")
setArchiveBaseName("nomulus")
setDestinationDirectory(layout.buildDirectory.dir('jetty-base/webapps'))
dependsOn(tasks.named('copyJettyBase'))
}
Expand All @@ -49,4 +49,21 @@ tasks.register('buildNomulusImage', Exec) {
dependsOn(tasks.named('stage'))
}

tasks.register('run', JavaExec) {
// We do the check when the task actually runs, not when we define it.
// This way if one doesn't set the value, one can still run other tasks.
doFirst {
def jetty_home = System.getenv('JETTY_HOME')
if (jetty_home == null) {
throw new GradleException('JETTY_HOME is not set.')
}
}
def jetty_home = System.getenv('JETTY_HOME')
def environment = rootProject.environment
workingDir(layout.buildDirectory.dir('jetty-base'))
classpath = files(jetty_home + '/start.jar')
systemProperty('google.registry.environment', environment)
dependsOn(tasks.named('stage'))
}

project.build.dependsOn(tasks.named('buildNomulusImage'))
7 changes: 7 additions & 0 deletions jetty/src/main/jetty-base/webapps/nomulus.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "https://eclipse.dev/jetty/configure_10_0.dtd">

<Configure id="wac" class="org.eclipse.jetty.ee8.webapp.WebAppContext">
<Set name="contextPath">/</Set>
<Set name="war">./webapps/nomulus.war</Set>
</Configure>
18 changes: 18 additions & 0 deletions jetty/start.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#!/bin/sh
# Copyright 2024 The Nomulus Authors. All Rights Reserved.
#
# Licensed 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.

environment=$1
cd /jetty-base
java -jar /usr/local/jetty/start.jar -Dgoogle.registry.environment=${environment:-"alpha"}

0 comments on commit 1fb27fc

Please sign in to comment.