mirror of
https://github.com/google/nomulus.git
synced 2025-05-02 04:57:51 +02:00
bba975a991
The task-queue API only allows reading 1000 tasks at a time, hence the original reason for this limit. We get over that limit by reading (and processing) items from the queue in a loop - 1000 at a time. This is important because the 1000 dns-updates are shared among all TLDs, meaning that a TLD with >1000 waiting updates can affect the update latency of other TLDs. In addition, partially fixes the bug where if there are more than 1000 updates to paused / non-existing TLDs, we completely block all updated to all TLDs. By partially fixed, I mean "if we have around 1000 updates to paused TLDs, we will read them every time ReadDnsUpdates is called, ignore then, and only then get to the actual updates we want to process". This works for a number of 1000 updates waiting - but if paused TLDs have tens or hundreds of thousands of updates waiting - this might still choke up other TLDs (not to mention we keep reading / updating 10s or 100s of thousands of tasks in the queue, that's... bad.) A more thorough fix will come in a future CL, as it requires a more thorough change in the code. Note that the queue lease command supports a maximum of 10 QPS. Any more than that - and we get errors / empty results. Hence we limit our QPS to 9 to be on the safe side. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=185218684
385 lines
15 KiB
Java
385 lines
15 KiB
Java
// Copyright 2017 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.
|
|
|
|
package google.registry.dns;
|
|
|
|
import static com.google.appengine.api.taskqueue.QueueFactory.getQueue;
|
|
import static com.google.common.collect.ImmutableList.toImmutableList;
|
|
import static com.google.common.collect.Lists.transform;
|
|
import static com.google.common.truth.Truth.assertThat;
|
|
import static com.google.common.truth.Truth8.assertThat;
|
|
import static google.registry.dns.DnsConstants.DNS_PUBLISH_PUSH_QUEUE_NAME;
|
|
import static google.registry.dns.DnsConstants.DNS_PULL_QUEUE_NAME;
|
|
import static google.registry.dns.DnsConstants.DNS_TARGET_NAME_PARAM;
|
|
import static google.registry.dns.DnsConstants.DNS_TARGET_TYPE_PARAM;
|
|
import static google.registry.request.RequestParameters.PARAM_TLD;
|
|
import static google.registry.testing.DatastoreHelper.createTlds;
|
|
import static google.registry.testing.DatastoreHelper.persistResource;
|
|
import static google.registry.testing.TaskQueueHelper.assertNoTasksEnqueued;
|
|
import static google.registry.testing.TaskQueueHelper.assertTasksEnqueued;
|
|
import static google.registry.testing.TaskQueueHelper.getQueuedParams;
|
|
|
|
import com.google.appengine.api.taskqueue.QueueFactory;
|
|
import com.google.appengine.api.taskqueue.TaskOptions;
|
|
import com.google.appengine.api.taskqueue.TaskOptions.Method;
|
|
import com.google.common.base.Joiner;
|
|
import com.google.common.collect.ImmutableList;
|
|
import com.google.common.collect.ImmutableMultimap;
|
|
import com.google.common.collect.ImmutableSet;
|
|
import com.google.common.net.InternetDomainName;
|
|
import google.registry.dns.DnsConstants.TargetType;
|
|
import google.registry.model.registry.Registry;
|
|
import google.registry.model.registry.Registry.TldType;
|
|
import google.registry.testing.AppEngineRule;
|
|
import google.registry.testing.FakeClock;
|
|
import google.registry.testing.TaskQueueHelper.TaskMatcher;
|
|
import google.registry.util.Retrier;
|
|
import google.registry.util.TaskEnqueuer;
|
|
import java.util.ArrayList;
|
|
import java.util.List;
|
|
import java.util.Map.Entry;
|
|
import java.util.Optional;
|
|
import java.util.stream.IntStream;
|
|
import org.joda.time.DateTime;
|
|
import org.joda.time.DateTimeZone;
|
|
import org.joda.time.Duration;
|
|
import org.junit.Before;
|
|
import org.junit.Rule;
|
|
import org.junit.Test;
|
|
import org.junit.runner.RunWith;
|
|
import org.junit.runners.JUnit4;
|
|
|
|
/** Unit tests for {@link ReadDnsQueueAction}. */
|
|
@RunWith(JUnit4.class)
|
|
public class ReadDnsQueueActionTest {
|
|
|
|
private static final int TEST_TLD_UPDATE_BATCH_SIZE = 100;
|
|
private DnsQueue dnsQueue;
|
|
private FakeClock clock = new FakeClock(DateTime.now(DateTimeZone.UTC));
|
|
|
|
@Rule
|
|
public final AppEngineRule appEngine = AppEngineRule.builder()
|
|
.withDatastore()
|
|
.withTaskQueue(Joiner.on('\n').join(
|
|
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>",
|
|
"<queue-entries>",
|
|
" <queue>",
|
|
" <name>dns-publish</name>",
|
|
" <rate>1/s</rate>",
|
|
" </queue>",
|
|
" <queue>",
|
|
" <name>dns-pull</name>",
|
|
" <mode>pull</mode>",
|
|
" </queue>",
|
|
"</queue-entries>"))
|
|
.withClock(clock)
|
|
.build();
|
|
|
|
@Before
|
|
public void before() throws Exception {
|
|
clock.setTo(DateTime.now(DateTimeZone.UTC));
|
|
createTlds("com", "net", "example");
|
|
persistResource(
|
|
Registry.get("com").asBuilder().setDnsWriters(ImmutableSet.of("comWriter")).build());
|
|
persistResource(
|
|
Registry.get("net").asBuilder().setDnsWriters(ImmutableSet.of("netWriter")).build());
|
|
persistResource(
|
|
Registry.get("example")
|
|
.asBuilder()
|
|
.setTldType(TldType.TEST)
|
|
.setDnsWriters(ImmutableSet.of("exampleWriter"))
|
|
.build());
|
|
dnsQueue = DnsQueue.create();
|
|
}
|
|
|
|
private void run() throws Exception {
|
|
ReadDnsQueueAction action = new ReadDnsQueueAction();
|
|
action.tldUpdateBatchSize = TEST_TLD_UPDATE_BATCH_SIZE;
|
|
action.requestedMaximumDuration = Duration.standardSeconds(10);
|
|
action.clock = clock;
|
|
action.dnsQueue = dnsQueue;
|
|
action.dnsPublishPushQueue = QueueFactory.getQueue(DNS_PUBLISH_PUSH_QUEUE_NAME);
|
|
action.taskEnqueuer = new TaskEnqueuer(new Retrier(null, 1));
|
|
action.jitterSeconds = Optional.empty();
|
|
// Advance the time a little, to ensure that leaseTasks() returns all tasks.
|
|
clock.setTo(DateTime.now(DateTimeZone.UTC).plusMillis(1));
|
|
action.run();
|
|
}
|
|
|
|
private static TaskOptions createRefreshTask(String name, TargetType type) {
|
|
TaskOptions options = TaskOptions.Builder
|
|
.withMethod(Method.PULL)
|
|
.param(DNS_TARGET_TYPE_PARAM, type.toString())
|
|
.param(DNS_TARGET_NAME_PARAM, name);
|
|
String tld = InternetDomainName.from(name).parts().reverse().get(0);
|
|
return options.param("tld", tld);
|
|
}
|
|
|
|
private static TaskMatcher createDomainRefreshTaskMatcher(String name) {
|
|
return new TaskMatcher()
|
|
.param(DNS_TARGET_NAME_PARAM, name)
|
|
.param(DNS_TARGET_TYPE_PARAM, TargetType.DOMAIN.toString());
|
|
}
|
|
|
|
private void assertTldsEnqueuedInPushQueue(ImmutableMultimap<String, String> tldsToDnsWriters)
|
|
throws Exception {
|
|
assertTasksEnqueued(
|
|
DNS_PUBLISH_PUSH_QUEUE_NAME,
|
|
transform(
|
|
tldsToDnsWriters.entries().asList(),
|
|
(Entry<String, String> tldToDnsWriter) ->
|
|
new TaskMatcher()
|
|
.url(PublishDnsUpdatesAction.PATH)
|
|
.param("tld", tldToDnsWriter.getKey())
|
|
.param("dnsWriter", tldToDnsWriter.getValue())
|
|
.header("content-type", "application/x-www-form-urlencoded")));
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_methodPostIsDefault() throws Exception {
|
|
dnsQueue.addDomainRefreshTask("domain.com");
|
|
dnsQueue.addDomainRefreshTask("domain.net");
|
|
dnsQueue.addDomainRefreshTask("domain.example");
|
|
run();
|
|
assertNoTasksEnqueued(DNS_PULL_QUEUE_NAME);
|
|
assertTasksEnqueued(
|
|
DNS_PUBLISH_PUSH_QUEUE_NAME,
|
|
new TaskMatcher().method("POST"),
|
|
new TaskMatcher().method("POST"),
|
|
new TaskMatcher().method("POST"));
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_allTlds() throws Exception {
|
|
dnsQueue.addDomainRefreshTask("domain.com");
|
|
dnsQueue.addDomainRefreshTask("domain.net");
|
|
dnsQueue.addDomainRefreshTask("domain.example");
|
|
run();
|
|
assertNoTasksEnqueued(DNS_PULL_QUEUE_NAME);
|
|
assertTldsEnqueuedInPushQueue(
|
|
ImmutableMultimap.of("com", "comWriter", "net", "netWriter", "example", "exampleWriter"));
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_moreUpdatesThanQueueBatchSize() throws Exception {
|
|
// The task queue has a batch size of 1000 (that's the maximum number of items you can lease at
|
|
// once).
|
|
ImmutableList<String> domains =
|
|
IntStream.range(0, 1500)
|
|
.mapToObj(i -> String.format("domain_%04d.com", i))
|
|
.collect(toImmutableList());
|
|
domains.forEach(dnsQueue::addDomainRefreshTask);
|
|
run();
|
|
assertNoTasksEnqueued(DNS_PULL_QUEUE_NAME);
|
|
ImmutableList<ImmutableMultimap<String, String>> queuedParams =
|
|
getQueuedParams(DNS_PUBLISH_PUSH_QUEUE_NAME);
|
|
// ReadDnsQueueAction batches items per TLD in batches of size 100.
|
|
// So for 1500 items in the DNS queue, we expect 15 items in the push queue
|
|
assertThat(queuedParams).hasSize(15);
|
|
// Check all the expected domains are indeed enqueued
|
|
assertThat(
|
|
queuedParams
|
|
.stream()
|
|
.flatMap(params -> params.get("domains").stream()))
|
|
.containsExactlyElementsIn(domains);
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_twoDnsWriters() throws Exception {
|
|
persistResource(
|
|
Registry.get("com")
|
|
.asBuilder()
|
|
.setDnsWriters(ImmutableSet.of("comWriter", "otherWriter"))
|
|
.build());
|
|
dnsQueue.addDomainRefreshTask("domain.com");
|
|
run();
|
|
assertNoTasksEnqueued(DNS_PULL_QUEUE_NAME);
|
|
assertTldsEnqueuedInPushQueue(ImmutableMultimap.of("com", "comWriter", "com", "otherWriter"));
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_oneTldPaused_returnedToQueue() throws Exception {
|
|
persistResource(Registry.get("net").asBuilder().setDnsPaused(true).build());
|
|
dnsQueue.addDomainRefreshTask("domain.com");
|
|
dnsQueue.addDomainRefreshTask("domain.net");
|
|
dnsQueue.addDomainRefreshTask("domain.example");
|
|
run();
|
|
assertTasksEnqueued(DNS_PULL_QUEUE_NAME, createDomainRefreshTaskMatcher("domain.net"));
|
|
assertTldsEnqueuedInPushQueue(
|
|
ImmutableMultimap.of("com", "comWriter", "example", "exampleWriter"));
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_oneTldUnknown_returnedToQueue() throws Exception {
|
|
dnsQueue.addDomainRefreshTask("domain.com");
|
|
dnsQueue.addDomainRefreshTask("domain.example");
|
|
QueueFactory.getQueue(DNS_PULL_QUEUE_NAME)
|
|
.add(
|
|
TaskOptions.Builder.withDefaults()
|
|
.method(Method.PULL)
|
|
.param(DNS_TARGET_TYPE_PARAM, TargetType.DOMAIN.toString())
|
|
.param(DNS_TARGET_NAME_PARAM, "domain.unknown")
|
|
.param(PARAM_TLD, "unknown"));
|
|
run();
|
|
assertTasksEnqueued(DNS_PULL_QUEUE_NAME, createDomainRefreshTaskMatcher("domain.unknown"));
|
|
assertTldsEnqueuedInPushQueue(
|
|
ImmutableMultimap.of("com", "comWriter", "example", "exampleWriter"));
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_corruptTaskTldMismatch_published() throws Exception {
|
|
// TODO(mcilwain): what's the correct action to take in this case?
|
|
dnsQueue.addDomainRefreshTask("domain.com");
|
|
dnsQueue.addDomainRefreshTask("domain.example");
|
|
QueueFactory.getQueue(DNS_PULL_QUEUE_NAME)
|
|
.add(
|
|
TaskOptions.Builder.withDefaults()
|
|
.method(Method.PULL)
|
|
.param(DNS_TARGET_TYPE_PARAM, TargetType.DOMAIN.toString())
|
|
.param(DNS_TARGET_NAME_PARAM, "domain.wrongtld")
|
|
.param(PARAM_TLD, "net"));
|
|
run();
|
|
assertNoTasksEnqueued(DNS_PULL_QUEUE_NAME);
|
|
assertTldsEnqueuedInPushQueue(
|
|
ImmutableMultimap.of("com", "comWriter", "example", "exampleWriter", "net", "netWriter"));
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_corruptTaskNoTld_discarded() throws Exception {
|
|
dnsQueue.addDomainRefreshTask("domain.com");
|
|
dnsQueue.addDomainRefreshTask("domain.example");
|
|
QueueFactory.getQueue(DNS_PULL_QUEUE_NAME)
|
|
.add(
|
|
TaskOptions.Builder.withDefaults()
|
|
.method(Method.PULL)
|
|
.param(DNS_TARGET_TYPE_PARAM, TargetType.DOMAIN.toString())
|
|
.param(DNS_TARGET_NAME_PARAM, "domain.net"));
|
|
run();
|
|
// The corrupt task isn't in the pull queue, but also isn't in the push queue
|
|
assertNoTasksEnqueued(DNS_PULL_QUEUE_NAME);
|
|
assertTldsEnqueuedInPushQueue(
|
|
ImmutableMultimap.of("com", "comWriter", "example", "exampleWriter"));
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_corruptTaskNoName_discarded() throws Exception {
|
|
dnsQueue.addDomainRefreshTask("domain.com");
|
|
dnsQueue.addDomainRefreshTask("domain.example");
|
|
QueueFactory.getQueue(DNS_PULL_QUEUE_NAME)
|
|
.add(
|
|
TaskOptions.Builder.withDefaults()
|
|
.method(Method.PULL)
|
|
.param(DNS_TARGET_TYPE_PARAM, TargetType.DOMAIN.toString())
|
|
.param(PARAM_TLD, "net"));
|
|
run();
|
|
// The corrupt task isn't in the pull queue, but also isn't in the push queue
|
|
assertNoTasksEnqueued(DNS_PULL_QUEUE_NAME);
|
|
assertTldsEnqueuedInPushQueue(
|
|
ImmutableMultimap.of("com", "comWriter", "example", "exampleWriter"));
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_corruptTaskNoType_discarded() throws Exception {
|
|
dnsQueue.addDomainRefreshTask("domain.com");
|
|
dnsQueue.addDomainRefreshTask("domain.example");
|
|
QueueFactory.getQueue(DNS_PULL_QUEUE_NAME)
|
|
.add(
|
|
TaskOptions.Builder.withDefaults()
|
|
.method(Method.PULL)
|
|
.param(DNS_TARGET_NAME_PARAM, "domain.net")
|
|
.param(PARAM_TLD, "net"));
|
|
run();
|
|
// The corrupt task isn't in the pull queue, but also isn't in the push queue
|
|
assertNoTasksEnqueued(DNS_PULL_QUEUE_NAME);
|
|
assertTldsEnqueuedInPushQueue(
|
|
ImmutableMultimap.of("com", "comWriter", "example", "exampleWriter"));
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_corruptTaskWrongType_discarded() throws Exception {
|
|
dnsQueue.addDomainRefreshTask("domain.com");
|
|
dnsQueue.addDomainRefreshTask("domain.example");
|
|
QueueFactory.getQueue(DNS_PULL_QUEUE_NAME)
|
|
.add(
|
|
TaskOptions.Builder.withDefaults()
|
|
.method(Method.PULL)
|
|
.param(DNS_TARGET_TYPE_PARAM, "Wrong type")
|
|
.param(DNS_TARGET_NAME_PARAM, "domain.net")
|
|
.param(PARAM_TLD, "net"));
|
|
run();
|
|
// The corrupt task isn't in the pull queue, but also isn't in the push queue
|
|
assertNoTasksEnqueued(DNS_PULL_QUEUE_NAME);
|
|
assertTldsEnqueuedInPushQueue(
|
|
ImmutableMultimap.of("com", "comWriter", "example", "exampleWriter"));
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_zone_getsIgnored() throws Exception {
|
|
dnsQueue.addHostRefreshTask("ns1.domain.com");
|
|
dnsQueue.addDomainRefreshTask("domain.net");
|
|
dnsQueue.addZoneRefreshTask("example");
|
|
run();
|
|
assertNoTasksEnqueued(DNS_PULL_QUEUE_NAME);
|
|
assertTasksEnqueued(
|
|
DNS_PUBLISH_PUSH_QUEUE_NAME,
|
|
new TaskMatcher().url(PublishDnsUpdatesAction.PATH).param("domains", "domain.net"),
|
|
new TaskMatcher().url(PublishDnsUpdatesAction.PATH).param("hosts", "ns1.domain.com"));
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_manyDomainsAndHosts() throws Exception {
|
|
List<TaskMatcher> expectedTasks = new ArrayList<>();
|
|
for (String tld : ImmutableList.of("com", "net")) {
|
|
int refreshItemsInTask = 0;
|
|
TaskMatcher task = null;
|
|
// 0: domain; 1: host 1; 2: host 2
|
|
for (int thingType = 0; thingType < 3; thingType++) {
|
|
for (int i = 0; i < 150; i++) {
|
|
String domainName = String.format("domain%04d.%s", i, tld);
|
|
// If we don't have an existing task into which to dump new refreshes, create one.
|
|
if (task == null) {
|
|
task = new TaskMatcher().url(PublishDnsUpdatesAction.PATH);
|
|
expectedTasks.add(task);
|
|
refreshItemsInTask = 0;
|
|
}
|
|
switch (thingType) {
|
|
case 1:
|
|
getQueue(DNS_PULL_QUEUE_NAME)
|
|
.add(createRefreshTask("ns1." + domainName, TargetType.HOST));
|
|
task.param("hosts", "ns1." + domainName);
|
|
break;
|
|
case 2:
|
|
getQueue(DNS_PULL_QUEUE_NAME)
|
|
.add(createRefreshTask("ns2." + domainName, TargetType.HOST));
|
|
task.param("hosts", "ns2." + domainName);
|
|
break;
|
|
default:
|
|
dnsQueue.addDomainRefreshTask(domainName);
|
|
task.param("domains", domainName);
|
|
break;
|
|
}
|
|
// If this task is now full up, wash our hands of it, so that we'll start a new one the
|
|
// next time through the loop.
|
|
refreshItemsInTask++;
|
|
if (refreshItemsInTask >= TEST_TLD_UPDATE_BATCH_SIZE) {
|
|
task = null;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
run();
|
|
assertNoTasksEnqueued(DNS_PULL_QUEUE_NAME);
|
|
assertTasksEnqueued(DNS_PUBLISH_PUSH_QUEUE_NAME, expectedTasks);
|
|
}
|
|
}
|