mirrors/nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus synced 2026-01-05 04:56:03 +00:00
Code Issues Releases Wiki Activity

Change ICANN upload cursor time (#2346)

Browse Source 
The staging job runs at 9AM on the 2nd day of each month, we should set
the cursor to be after that time, otherwise we attempt to upload reports
on the 1st day of each month before they are ready, causing an error
email to be sent to us.
This commit is contained in:
Lai Jiang
2024-03-07 10:52:14 -05:00
committed by GitHub
parent df4e345961
commit 40174b825a
2 changed files with 54 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
core/src/main/java/google/registry/reporting/icann/IcannReportingUploadAction.java
View File

@@ -63,7 +63,7 @@ import org.joda.time.Duration;
* <p>Parameters:
*
* <p>subdir: the subdirectory of gs://[project-id]-reporting/ to retrieve reports from. For
* example: "manual/dir" means reports will be stored under gs://[project-id]-reporting/manual/dir.
* example, "manual/dir" means reports will be stored under gs://[project-id]-reporting/manual/dir.
* Defaults to "icann/monthly/[last month in yyyy-MM format]".
*/
@Action(
@@ -98,6 +98,17 @@ public final class IcannReportingUploadAction implements Runnable {
@Inject
IcannReportingUploadAction() {}
/**
* Get the scheduled time for the next month of the given {@link DateTime}.
*
* <p>The scheduled time is always the second day of next month at 10AM UTC. This is because the
* staging action is scheduled to run at 9AM UTC on that day, and there is no reason to run the
* upload job before that. See {@code icannReportingStaging} in {@code cloud-scheduler.xml}.
*/
private static DateTime getScheduledTimeForCurrentMonth(DateTime time) {
return time.withDayOfMonth(2).withHourOfDay(10).withMinuteOfHour(0).plusMonths(1);
}
@Override
public void run() {
if (!lockHandler.executeWithLocks(
@@ -170,12 +181,10 @@ public final class IcannReportingUploadAction implements Runnable {
if (success) {
Cursor newCursor =
Cursor.createScoped(
cursorType,
cursorTime.withTimeAtStartOfDay().withDayOfMonth(1).plusMonths(1),
Tld.get(tldStr));
// In order to keep the transactions short-lived, we load all of the cursors in a single
cursorType, getScheduledTimeForCurrentMonth(cursorTime), Tld.get(tldStr));
// In order to keep the transactions short-lived, we load all the cursors in a single
// transaction then later use per-cursor transactions when checking + saving the cursors. We
// run behind a lock so the cursors shouldn't be changed, but double check to be sure.
// run behind a lock, so the cursors shouldn't be changed, but double check to be sure.
success =
tm().transact(
() -> {
@@ -235,7 +244,7 @@ public final class IcannReportingUploadAction implements Runnable {
/**
* Return a map with the Cursor and scope for each key in the keyMap. If the key from the keyMap
* does not have an existing cursor, create a new cursor with a default cursorTime of the first of
* does not have an existing cursor, create a new cursor with a default cursorTime at the first of
* next month.
*/
private ImmutableMap<Cursor, String> defaultNullCursorsToNextMonthAndAddToMap(
@@ -245,15 +254,13 @@ public final class IcannReportingUploadAction implements Runnable {
ImmutableMap.Builder<Cursor, String> cursors = new ImmutableMap.Builder<>();
keyMap.forEach(
(key, registry) -> {
// Cursor time is defaulted to the first of next month since a new tld will not yet have a
// report staged for upload.
// Cursor time is defaulted to 10AM on the second day of next month since a new tld will
// not yet have a report staged for upload.
Cursor cursor =
cursorMap.getOrDefault(
key,
Cursor.createScoped(
type,
clock.nowUtc().withDayOfMonth(1).withTimeAtStartOfDay().plusMonths(1),
registry));
type, getScheduledTimeForCurrentMonth(clock.nowUtc()), registry));
if (!cursorMap.containsValue(cursor)) {
tm().put(cursor);
}
@@ -278,7 +285,7 @@ public final class IcannReportingUploadAction implements Runnable {
}
private void emailUploadResults(ImmutableMap<String, Boolean> reportSummary) {
if (reportSummary.size() == 0) {
if (reportSummary.isEmpty()) {
logger.atInfo().log("No uploads were attempted today; skipping notification email.");
return;
}

62
core/src/test/java/google/registry/reporting/icann/IcannReportingUploadActionTest.java
View File

@@ -130,11 +130,12 @@ class IcannReportingUploadActionTest {
.sendEmail(
EmailMessage.create(
"ICANN Monthly report upload summary: 3/4 succeeded",
"Report Filename - Upload status:\n"
+ "foo-activity-200606.csv - SUCCESS\n"
+ "foo-transactions-200606.csv - SUCCESS\n"
+ "tld-activity-200606.csv - FAILURE\n"
+ "tld-transactions-200606.csv - SUCCESS",
"""
Report Filename - Upload status:
foo-activity-200606.csv - SUCCESS
foo-transactions-200606.csv - SUCCESS
tld-activity-200606.csv - FAILURE
tld-transactions-200606.csv - SUCCESS""",
new InternetAddress("recipient@example.com")));
}
@@ -164,9 +165,10 @@ class IcannReportingUploadActionTest {
.sendEmail(
EmailMessage.create(
"ICANN Monthly report upload summary: 2/2 succeeded",
"Report Filename - Upload status:\n"
+ "tld-activity-200512.csv - SUCCESS\n"
+ "tld-transactions-200512.csv - SUCCESS",
"""
Report Filename - Upload status:
tld-activity-200512.csv - SUCCESS
tld-transactions-200512.csv - SUCCESS""",
new InternetAddress("recipient@example.com")));
}
@@ -179,7 +181,7 @@ class IcannReportingUploadActionTest {
action.run();
Cursor cursor =
loadByKey(Cursor.createScopedVKey(CursorType.ICANN_UPLOAD_ACTIVITY, Tld.get("tld")));
assertThat(cursor.getCursorTime()).isEqualTo(DateTime.parse("2006-08-01TZ"));
assertThat(cursor.getCursorTime()).isEqualTo(DateTime.parse("2006-08-02T10:00:00Z"));
}
@Test
@@ -207,11 +209,12 @@ class IcannReportingUploadActionTest {
.sendEmail(
EmailMessage.create(
"ICANN Monthly report upload summary: 3/4 succeeded",
"Report Filename - Upload status:\n"
+ "foo-activity-200606.csv - SUCCESS\n"
+ "foo-transactions-200606.csv - SUCCESS\n"
+ "tld-activity-200606.csv - FAILURE\n"
+ "tld-transactions-200606.csv - SUCCESS",
"""
Report Filename - Upload status:
foo-activity-200606.csv - SUCCESS
foo-transactions-200606.csv - SUCCESS
tld-activity-200606.csv - FAILURE
tld-transactions-200606.csv - SUCCESS""",
new InternetAddress("recipient@example.com")));
}
@@ -266,11 +269,12 @@ class IcannReportingUploadActionTest {
.sendEmail(
EmailMessage.create(
"ICANN Monthly report upload summary: 3/4 succeeded",
"Report Filename - Upload status:\n"
+ "foo-activity-200606.csv - SUCCESS\n"
+ "foo-transactions-200606.csv - SUCCESS\n"
+ "tld-activity-200606.csv - FAILURE\n"
+ "tld-transactions-200606.csv - SUCCESS",
"""
Report Filename - Upload status:
foo-activity-200606.csv - SUCCESS
foo-transactions-200606.csv - SUCCESS
tld-activity-200606.csv - FAILURE
tld-transactions-200606.csv - SUCCESS""",
new InternetAddress("recipient@example.com")));
}
@@ -313,14 +317,14 @@ class IcannReportingUploadActionTest {
IcannReportingUploadAction action = createAction();
action.lockHandler = new FakeLockHandler(false);
ServiceUnavailableException thrown =
assertThrows(ServiceUnavailableException.class, () -> action.run());
assertThrows(ServiceUnavailableException.class, action::run);
assertThat(thrown)
.hasMessageThat()
.contains("Lock for IcannReportingUploadAction already in use");
}
@Test
void testSuccess_nullCursorsInitiatedToFirstOfNextMonth() throws Exception {
void testSuccess_nullCursorsInitiatedToSecondOfNextMonth() throws Exception {
createTlds("new");
IcannReportingUploadAction action = createAction();
@@ -335,18 +339,20 @@ class IcannReportingUploadActionTest {
.sendEmail(
EmailMessage.create(
"ICANN Monthly report upload summary: 3/4 succeeded",
"Report Filename - Upload status:\n"
+ "foo-activity-200606.csv - SUCCESS\n"
+ "foo-transactions-200606.csv - SUCCESS\n"
+ "tld-activity-200606.csv - FAILURE\n"
+ "tld-transactions-200606.csv - SUCCESS",
"""
Report Filename - Upload status:
foo-activity-200606.csv - SUCCESS
foo-transactions-200606.csv - SUCCESS
tld-activity-200606.csv - FAILURE
tld-transactions-200606.csv - SUCCESS""",
new InternetAddress("recipient@example.com")));
Cursor newActivityCursor =
loadByKey(Cursor.createScopedVKey(CursorType.ICANN_UPLOAD_ACTIVITY, Tld.get("new")));
assertThat(newActivityCursor.getCursorTime()).isEqualTo(DateTime.parse("2006-08-01TZ"));
assertThat(newActivityCursor.getCursorTime()).isEqualTo(DateTime.parse("2006-08-02T10:00:00Z"));
Cursor newTransactionCursor =
loadByKey(Cursor.createScopedVKey(CursorType.ICANN_UPLOAD_TX, Tld.get("new")));
assertThat(newTransactionCursor.getCursorTime()).isEqualTo(DateTime.parse("2006-08-01TZ"));
assertThat(newTransactionCursor.getCursorTime())
.isEqualTo(DateTime.parse("2006-08-02T10:00:00Z"));
}
}