Skip to content

Make grant loader localKey domain prefix configurable #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rpoet-jh merged 2 commits into from
Apr 20, 2026
Merged

Make grant loader localKey domain prefix configurable #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41908d2
Make localKey domain prefix configurable
rpoet-jh Apr 20, 2026
4f8817b
Remove default domain value
rpoet-jh Apr 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions ...-loader/src/main/java/org/eclipse/pass/support/grant/data/AbstractDefaultPassUpdater.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import java.util.Properties;

import lombok.Getter;
import lombok.Setter;
import org.apache.commons.lang3.StringUtils;
import org.eclipse.pass.support.client.PassClient;
import org.eclipse.pass.support.client.PassClientResult;
Expand Down Expand Up @@ -71,7 +72,9 @@ public abstract class AbstractDefaultPassUpdater implements PassUpdater {
@Getter
private final List<String> ingestRecordErrors = new ArrayList<>();

private String domain = "default.domain";
@Setter @Getter
private String domain;

private String latestUpdateString = "";

private record GrantAccumulate(GrantIngestRecord grantIngestRecord, ZonedDateTime awardDate,
Expand Down Expand Up @@ -114,10 +117,6 @@ public void updatePass(Collection<GrantIngestRecord> results, String mode) {
}
}

public void setDomain(String domain) {
this.domain = domain;
}

/**
* This method provides the latest timestamp of all records processed. After processing, this timestamp
* will be used to be tha base timestamp for the next run of the app
Expand Down Expand Up @@ -575,7 +574,7 @@ private void setFunderPolicyIfNeeded(Funder funder, String funderCode) {
*/
private Funder updateFunderInPass(Funder systemFunder) throws IOException, GrantDataException {
String baseLocalKey = systemFunder.getLocalKey();
String fullLocalKey = GrantDataUtils.buildLocalKey(domain, FUNDER_ID_TYPE, baseLocalKey);
String fullLocalKey = GrantDataUtils.buildLocalKey(getDomain(), FUNDER_ID_TYPE, baseLocalKey);
systemFunder.setLocalKey(fullLocalKey);

PassClientSelector<Funder> selector = new PassClientSelector<>(Funder.class);
Expand Down Expand Up @@ -654,7 +653,7 @@ private User lookupPassUser(String locatorId) {
*/
private Grant updateGrantInPass(Grant systemGrant) throws IOException, GrantDataException {
String baseLocalKey = systemGrant.getLocalKey();
String fullLocalKey = GrantDataUtils.buildLocalKey(domain, GRANT_ID_TYPE, baseLocalKey);
String fullLocalKey = GrantDataUtils.buildLocalKey(getDomain(), GRANT_ID_TYPE, baseLocalKey);
systemGrant.setLocalKey(fullLocalKey);

LOG.debug("Looking for grant with localKey {}", fullLocalKey);
Expand Down
25 changes: 15 additions & 10 deletions pass-grant-loader/src/main/java/org/eclipse/pass/support/grant/data/jhu/JhuPassUpdater.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Profile;
import org.springframework.stereotype.Component;

Expand All @@ -44,12 +45,12 @@
public class JhuPassUpdater extends AbstractDefaultPassUpdater {

private static final Logger LOG = LoggerFactory.getLogger(JhuPassUpdater.class);
private static final String DOMAIN = "johnshopkins.edu";

private static final String EMPLOYEE_ID_TYPE = "employeeid";
private static final String JHED_ID_TYPE = "eppn";

static final String EMPLOYEE_LOCATOR_ID = DOMAIN + ":" + EMPLOYEE_ID_TYPE + ":";
static final String JHED_LOCATOR_ID = DOMAIN + ":" + JHED_ID_TYPE + ":";
private final String employeeIdLocatorPrefix;
private final String eppnLocatorPrefix;

private final DifferenceLogger differenceLogger;

Expand All @@ -58,13 +59,17 @@ public class JhuPassUpdater extends AbstractDefaultPassUpdater {
* @param differenceLogger the diff logger
* @param passClient the pass client
* @param policyProperties the policy properties
* @param localKeyDomainPrefix the domain prefix to use in localKeys
*/
public JhuPassUpdater(DifferenceLogger differenceLogger,
PassClient passClient,
@Qualifier("policyProperties") Properties policyProperties) {
@Qualifier("policyProperties") Properties policyProperties,
@Value("${local.key.domain.prefix}") String localKeyDomainPrefix) {
super(passClient, policyProperties);
this.differenceLogger = differenceLogger;
setDomain(DOMAIN);
setDomain(localKeyDomainPrefix);
employeeIdLocatorPrefix = getDomain() + ":" + EMPLOYEE_ID_TYPE + ":";
eppnLocatorPrefix = getDomain() + ":" + JHED_ID_TYPE + ":";
}

@Override
Expand Down Expand Up @@ -104,11 +109,11 @@ public User buildUser(GrantIngestRecord grantIngestRecord) {
String employeeId = grantIngestRecord.getPiEmployeeId();
//Build the List of locatorIds - put the most reliable ids first
if (StringUtils.isNotBlank(employeeId)) {
user.getLocatorIds().add(EMPLOYEE_LOCATOR_ID + employeeId);
user.getLocatorIds().add(employeeIdLocatorPrefix + employeeId);
}
if (StringUtils.isNotBlank(grantIngestRecord.getPiInstitutionalId())) {
String jhedId = grantIngestRecord.getPiInstitutionalId().toLowerCase();
user.getLocatorIds().add(JHED_LOCATOR_ID + jhedId);
user.getLocatorIds().add(eppnLocatorPrefix + jhedId);
}
user.getRoles().add(UserRole.SUBMITTER);
LOG.debug("Built user with employee ID {}", employeeId);
Expand Down Expand Up @@ -166,7 +171,7 @@ private boolean userNeedsUpdate(User system, User stored) {
if (!Objects.equals(system.getLastName(), stored.getLastName())) {
return true;
}
String systemUserJhedLocatorId = findLocatorId(system, JhuPassUpdater.JHED_LOCATOR_ID);
String systemUserJhedLocatorId = findLocatorId(system, eppnLocatorPrefix);
if (Objects.nonNull(systemUserJhedLocatorId) && !stored.getLocatorIds().contains(systemUserJhedLocatorId)) {
return true;
}
Expand Down Expand Up @@ -201,9 +206,9 @@ private User updateUser(User system, User stored) {
stored.setFirstName(system.getFirstName());
stored.setMiddleName(system.getMiddleName());
stored.setLastName(system.getLastName());
String systemUserJhedLocatorId = findLocatorId(system, JhuPassUpdater.JHED_LOCATOR_ID);
String systemUserJhedLocatorId = findLocatorId(system, eppnLocatorPrefix);
if (Objects.nonNull(systemUserJhedLocatorId) && !stored.getLocatorIds().contains(systemUserJhedLocatorId)) {
stored.getLocatorIds().removeIf(locatorId -> locatorId.startsWith(JhuPassUpdater.JHED_LOCATOR_ID));
stored.getLocatorIds().removeIf(locatorId -> locatorId.startsWith(eppnLocatorPrefix));
stored.getLocatorIds().add(systemUserJhedLocatorId);
}
//populate null fields if we can
Expand Down
2 changes: 2 additions & 0 deletions pass-grant-loader/src/main/resources/application.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ spring.cloud.aws.s3.enabled=false

spring.profiles.active=jhu

local.key.domain.prefix=${LOCAL_KEY_DOMAIN_PREFIX}

pass.policy.prop.path=${POLICY_PROP_PATH:file:///data/grantloader/policy.properties}
pass.grant.update.ts.path=${GRANT_UPDATE_TS_PATH:file:///data/grantloader/grant_update_timestamps}

Expand Down
3 changes: 2 additions & 1 deletion pass-grant-loader/src/test/java/org/eclipse/pass/support/grant/AwsParamStoreConfigTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@
"pass.client.password=${PASS_CORE_PASSWORD:test-pw}",
"grant.db.url=${GRANT_DB_URL:test-grant-db-url}",
"grant.db.username=${GRANT_DB_USER:test-grant-db-user}",
"grant.db.password=${GRANT_DB_PASSWORD:test-grant-db-pw}"
"grant.db.password=${GRANT_DB_PASSWORD:test-grant-db-pw}",
"local.key.domain.prefix=passtest.edu"
})
@ContextConfiguration(initializers = ConfigDataApplicationContextInitializer.class)
@Testcontainers
Expand Down
3 changes: 2 additions & 1 deletion pass-grant-loader/src/test/java/org/eclipse/pass/support/grant/PolicyPropertiesS3IT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@
"pass.client.password=test-pw",
"grant.db.url=test-grant-db-url",
"grant.db.username=test-grant-db-user",
"grant.db.password=test-grant-db-pw"
"grant.db.password=test-grant-db-pw",
"local.key.domain.prefix=passtest.edu"
})
@Testcontainers
public class PolicyPropertiesS3IT {
Expand Down
5 changes: 3 additions & 2 deletions ...-grant-loader/src/test/java/org/eclipse/pass/support/grant/data/jhu/JhuPassUpdaterIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@
package org.eclipse.pass.support.grant.data.jhu;

import static org.eclipse.pass.support.grant.data.DateTimeUtil.createZonedDateTime;
import static org.eclipse.pass.support.grant.data.jhu.JhuPassUpdater.EMPLOYEE_LOCATOR_ID;
import static org.eclipse.pass.support.grant.data.jhu.JhuPassUpdater.JHED_LOCATOR_ID;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
Expand Down Expand Up @@ -49,6 +47,9 @@
@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_EACH_TEST_METHOD)
class JhuPassUpdaterIT extends AbstractIntegrationTest {

static final String EMPLOYEE_LOCATOR_ID = "johnshopkins.edu:employeeid:";
static final String JHED_LOCATOR_ID = "johnshopkins.edu:eppn:";

private final String grantIdPrefix = "johnshopkins.edu:grant:";

@Autowired private JhuPassUpdater jhuPassUpdater;
Expand Down
4 changes: 2 additions & 2 deletions ...loader/src/test/java/org/eclipse/pass/support/grant/data/jhu/JhuPassUpdaterOrderedIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
package org.eclipse.pass.support.grant.data.jhu;

import static org.eclipse.pass.support.grant.data.DateTimeUtil.createZonedDateTime;
import static org.eclipse.pass.support.grant.data.jhu.JhuPassUpdater.EMPLOYEE_LOCATOR_ID;
import static org.eclipse.pass.support.grant.data.jhu.JhuPassUpdater.JHED_LOCATOR_ID;
import static org.eclipse.pass.support.grant.data.jhu.JhuPassUpdaterIT.EMPLOYEE_LOCATOR_ID;
import static org.eclipse.pass.support.grant.data.jhu.JhuPassUpdaterIT.JHED_LOCATOR_ID;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;

Expand Down
2 changes: 2 additions & 0 deletions pass-grant-loader/src/test/resources/test-application.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ pass.client.url=http://localhost:8080/
pass.client.user=backend
pass.client.password=moo

local.key.domain.prefix=johnshopkins.edu

spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.url=jdbc:h2:mem:db
spring.datasource.username=sa
Expand Down
Loading