♻️ Use URI creator in inserter
authorDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Tue, 11 Feb 2020 18:23:25 +0000 (19:23 +0100)
committerDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Tue, 11 Feb 2020 18:23:25 +0000 (19:23 +0100)
src/main/java/net/pterodactylus/sone/core/Core.java
src/main/java/net/pterodactylus/sone/core/SoneInserter.java
src/main/kotlin/net/pterodactylus/sone/core/SoneUriCreator.kt
src/main/kotlin/net/pterodactylus/sone/main/SoneModule.kt
src/test/kotlin/net/pterodactylus/sone/core/CoreTest.kt
src/test/kotlin/net/pterodactylus/sone/core/SoneInserterTest.kt
src/test/kotlin/net/pterodactylus/sone/main/SoneModuleTest.kt

index ca08ae1..ce5daa2 100644 (file)
@@ -180,8 +180,10 @@ public class Core extends AbstractService implements SoneProvider, PostProvider,
        private final MetricRegistry metricRegistry;
        private final Histogram configurationSaveTimeHistogram;
 
+       private final SoneUriCreator soneUriCreator;
+
        @Inject
-       public Core(Configuration configuration, FreenetInterface freenetInterface, IdentityManager identityManager, SoneDownloader soneDownloader, ImageInserter imageInserter, UpdateChecker updateChecker, WebOfTrustUpdater webOfTrustUpdater, EventBus eventBus, Database database, MetricRegistry metricRegistry) {
+       public Core(Configuration configuration, FreenetInterface freenetInterface, IdentityManager identityManager, SoneDownloader soneDownloader, ImageInserter imageInserter, UpdateChecker updateChecker, WebOfTrustUpdater webOfTrustUpdater, EventBus eventBus, Database database, MetricRegistry metricRegistry, SoneUriCreator soneUriCreator) {
                super("Sone Core");
                this.configuration = configuration;
                this.freenetInterface = freenetInterface;
@@ -193,6 +195,7 @@ public class Core extends AbstractService implements SoneProvider, PostProvider,
                this.eventBus = eventBus;
                this.database = database;
                this.metricRegistry = metricRegistry;
+               this.soneUriCreator = soneUriCreator;
                preferences = new Preferences(eventBus);
                this.configurationSaveTimeHistogram = metricRegistry.histogram("configuration.save.duration", () -> new Histogram(new ExponentiallyDecayingReservoir(3000, 0)));
        }
@@ -610,7 +613,7 @@ public class Core extends AbstractService implements SoneProvider, PostProvider,
                sone.setLatestEdition(fromNullable(tryParse(property)).or(0L));
                sone.setClient(new Client("Sone", SonePlugin.getPluginVersion()));
                sone.setKnown(true);
-               SoneInserter soneInserter = new SoneInserter(this, eventBus, freenetInterface, metricRegistry, ownIdentity.getId());
+               SoneInserter soneInserter = new SoneInserter(this, eventBus, freenetInterface, metricRegistry, soneUriCreator, ownIdentity.getId());
                soneInserter.insertionDelayChanged(new InsertionDelayChangedEvent(preferences.getInsertionDelay()));
                eventBus.register(soneInserter);
                synchronized (soneInserters) {
index f18776b..ba13305 100644 (file)
@@ -27,7 +27,6 @@ import java.io.Closeable;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.StringWriter;
-import java.net.MalformedURLException;
 import java.nio.charset.Charset;
 import java.util.HashMap;
 import java.util.HashSet;
@@ -49,7 +48,6 @@ import net.pterodactylus.sone.data.Post;
 import net.pterodactylus.sone.data.Reply;
 import net.pterodactylus.sone.data.Sone;
 import net.pterodactylus.sone.data.Sone.SoneStatus;
-import net.pterodactylus.sone.freenet.wot.OwnIdentity;
 import net.pterodactylus.sone.main.SonePlugin;
 import net.pterodactylus.util.io.Closer;
 import net.pterodactylus.util.service.AbstractService;
@@ -107,6 +105,7 @@ public class SoneInserter extends AbstractService {
        private final FreenetInterface freenetInterface;
 
        private final SoneModificationDetector soneModificationDetector;
+       private final SoneUriCreator soneUriCreator;
        private final long delay;
        private final String soneId;
        private final Histogram soneInsertDurationHistogram;
@@ -124,8 +123,8 @@ public class SoneInserter extends AbstractService {
         * @param soneId
         *            The ID of the Sone to insert
         */
-       public SoneInserter(final Core core, EventBus eventBus, FreenetInterface freenetInterface, MetricRegistry metricRegistry, final String soneId) {
-               this(core, eventBus, freenetInterface, metricRegistry, soneId, new SoneModificationDetector(new LockableFingerprintProvider() {
+       public SoneInserter(final Core core, EventBus eventBus, FreenetInterface freenetInterface, MetricRegistry metricRegistry, SoneUriCreator soneUriCreator, final String soneId) {
+               this(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, soneId, new SoneModificationDetector(new LockableFingerprintProvider() {
                        @Override
                        public boolean isLocked() {
                                Sone sone = core.getSone(soneId);
@@ -147,13 +146,14 @@ public class SoneInserter extends AbstractService {
        }
 
        @VisibleForTesting
-       SoneInserter(Core core, EventBus eventBus, FreenetInterface freenetInterface, MetricRegistry metricRegistry, String soneId, SoneModificationDetector soneModificationDetector, long delay) {
+       SoneInserter(Core core, EventBus eventBus, FreenetInterface freenetInterface, MetricRegistry metricRegistry, SoneUriCreator soneUriCreator, String soneId, SoneModificationDetector soneModificationDetector, long delay) {
                super("Sone Inserter for “" + soneId + "”", false);
                this.core = core;
                this.eventBus = eventBus;
                this.freenetInterface = freenetInterface;
                this.soneInsertDurationHistogram = metricRegistry.histogram("sone.insert.duration", () -> new Histogram(new ExponentiallyDecayingReservoir(3000, 0)));
                this.soneInsertErrorMeter = metricRegistry.meter("sone.insert.errors");
+               this.soneUriCreator = soneUriCreator;
                this.soneId = soneId;
                this.soneModificationDetector = soneModificationDetector;
                this.delay = delay;
@@ -238,7 +238,7 @@ public class SoneInserter extends AbstractService {
                                                long insertTime = currentTimeMillis();
                                                eventBus.post(new SoneInsertingEvent(sone));
                                                Stopwatch stopwatch = Stopwatch.createStarted();
-                                               FreenetURI finalUri = freenetInterface.insertDirectory(getSoneInsertUri(sone), insertInformation.generateManifestEntries(), "index.html");
+                                               FreenetURI finalUri = freenetInterface.insertDirectory(soneUriCreator.getInsertUri(sone), insertInformation.generateManifestEntries(), "index.html");
                                                stopwatch.stop();
                                                soneInsertDurationHistogram.update(stopwatch.elapsed(MICROSECONDS));
                                                eventBus.post(new SoneInsertedEvent(sone, stopwatch.elapsed(MILLISECONDS), insertInformation.getFingerprint()));
@@ -286,14 +286,6 @@ public class SoneInserter extends AbstractService {
                setInsertionDelay(insertionDelayChangedEvent.getInsertionDelay());
        }
 
-       private FreenetURI getSoneInsertUri(Sone sone) throws MalformedURLException {
-               return new FreenetURI(((OwnIdentity) sone.getIdentity()).getInsertUri())
-                               .setKeyType("USK")
-                               .setDocName("Sone")
-                               .setMetaString(new String[0])
-                               .setSuggestedEdition(sone.getLatestEdition());
-       }
-
        /**
         * Container for information that are required to insert a Sone. This
         * container merely exists to copy all relevant data without holding a lock
index 115c748..183303a 100644 (file)
@@ -7,13 +7,13 @@ import net.pterodactylus.sone.freenet.wot.OwnIdentity
 /**
  * Injectable helper class that can create request and insert URIs for [Sones][Sone].
  */
-class SoneUriCreator {
+open class SoneUriCreator {
 
        fun getRequestUri(sone: Sone): FreenetURI = sone.identity.requestUri
                        .let(::FreenetURI)
                        .sonify(sone.latestEdition)
 
-       fun getInsertUri(sone: Sone): FreenetURI? = (sone.identity as? OwnIdentity)?.insertUri
+       open fun getInsertUri(sone: Sone): FreenetURI? = (sone.identity as? OwnIdentity)?.insertUri
                        ?.let(::FreenetURI)
                        ?.sonify(sone.latestEdition)
 
index 749de0d..1f92a93 100644 (file)
@@ -7,6 +7,7 @@ import com.google.inject.*
 import com.google.inject.matcher.*
 import com.google.inject.name.Names.*
 import com.google.inject.spi.*
+import net.pterodactylus.sone.core.SoneUriCreator
 import net.pterodactylus.sone.database.*
 import net.pterodactylus.sone.database.memory.*
 import net.pterodactylus.sone.freenet.*
@@ -61,6 +62,7 @@ open class SoneModule(private val sonePlugin: SonePlugin, private val eventBus:
                bind(MetricRegistry::class.java).`in`(Singleton::class.java)
                bind(WebOfTrustConnector::class.java).to(PluginWebOfTrustConnector::class.java).`in`(Singleton::class.java)
                bind(TickerShutdown::class.java).`in`(Singleton::class.java)
+               bind(SoneUriCreator::class.java).`in`(Singleton::class.java)
 
                bindListener(Matchers.any(), object : TypeListener {
                        override fun <I> hear(typeLiteral: TypeLiteral<I>, typeEncounter: TypeEncounter<I>) {
index 9eb123c..39273d0 100644 (file)
@@ -52,7 +52,8 @@ class CoreTest {
                val eventBus = mock<EventBus>()
                val database = mock<Database>()
                val metricRegistry = MetricRegistry()
-               val core = Core(configuration, freenetInterface, identityManager, soneDownloader, imageInserter, updateChecker, webOfTrustUpdater, eventBus, database, metricRegistry)
+               val soneUriCreator = SoneUriCreator()
+               val core = Core(configuration, freenetInterface, identityManager, soneDownloader, imageInserter, updateChecker, webOfTrustUpdater, eventBus, database, metricRegistry, soneUriCreator)
                val ownIdentity = mock<OwnIdentity>()
                val identity = mock<Identity>()
                whenever(identity.id).thenReturn("sone-id")
@@ -169,7 +170,8 @@ class CoreTest {
                val webOfTrustUpdater = mock<WebOfTrustUpdater>()
                val database = mock<Database>()
                val metricRegistry = MetricRegistry()
-               return Core(configuration, freenetInterface, identityManager, soneDownloader, imageInserter, updateChecker, webOfTrustUpdater, eventBus, database, metricRegistry)
+               val soneUriCreator = SoneUriCreator()
+               return Core(configuration, freenetInterface, identityManager, soneDownloader, imageInserter, updateChecker, webOfTrustUpdater, eventBus, database, metricRegistry, soneUriCreator)
        }
 
 }
index 7d06552..3da9e88 100644 (file)
@@ -38,6 +38,9 @@ class SoneInserterTest {
        private val core = mock<Core>()
        private val eventBus = mock<EventBus>()
        private val freenetInterface = mock<FreenetInterface>()
+       private val soneUriCreator = object : SoneUriCreator() {
+               override fun getInsertUri(sone: Sone): FreenetURI = expectedInsertUri
+       }
 
        @Before
        fun setupCore() {
@@ -49,7 +52,7 @@ class SoneInserterTest {
        @Test
        fun `insertion delay is forwarded to sone inserter`() {
                val eventBus = AsyncEventBus(directExecutor())
-               eventBus.register(SoneInserter(core, eventBus, freenetInterface, metricRegistry, "SoneId"))
+               eventBus.register(SoneInserter(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, "SoneId"))
                eventBus.post(InsertionDelayChangedEvent(15))
                assertThat(SoneInserter.getInsertionDelay().get(), equalTo(15))
        }
@@ -68,27 +71,27 @@ class SoneInserterTest {
        fun `isModified is true if modification detector says so`() {
                val soneModificationDetector = mock<SoneModificationDetector>()
                whenever(soneModificationDetector.isModified).thenReturn(true)
-               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, "SoneId", soneModificationDetector, 1)
+               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, "SoneId", soneModificationDetector, 1)
                assertThat(soneInserter.isModified, equalTo(true))
        }
 
        @Test
        fun `isModified is false if modification detector says so`() {
                val soneModificationDetector = mock<SoneModificationDetector>()
-               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, "SoneId", soneModificationDetector, 1)
+               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, "SoneId", soneModificationDetector, 1)
                assertThat(soneInserter.isModified, equalTo(false))
        }
 
        @Test
        fun `last fingerprint is stored correctly`() {
-               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, "SoneId")
+               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, "SoneId")
                soneInserter.lastInsertFingerprint = "last-fingerprint"
                assertThat(soneInserter.lastInsertFingerprint, equalTo("last-fingerprint"))
        }
 
        @Test
        fun `sone inserter stops when it should`() {
-               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, "SoneId")
+               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, "SoneId")
                soneInserter.stop()
                soneInserter.serviceRun()
        }
@@ -100,7 +103,7 @@ class SoneInserterTest {
                val soneModificationDetector = mock<SoneModificationDetector>()
                whenever(soneModificationDetector.isEligibleForInsert).thenReturn(true)
                whenever(freenetInterface.insertDirectory(eq(expectedInsertUri), any<HashMap<String, Any>>(), eq("index.html"))).thenReturn(finalUri)
-               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, "SoneId", soneModificationDetector, 1)
+               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, "SoneId", soneModificationDetector, 1)
                doAnswer {
                        soneInserter.stop()
                        null
@@ -121,7 +124,7 @@ class SoneInserterTest {
                val sone = createSone(insertUri)
                val soneModificationDetector = mock<SoneModificationDetector>()
                whenever(soneModificationDetector.isEligibleForInsert).thenReturn(true)
-               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, "SoneId", soneModificationDetector, 1)
+               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, "SoneId", soneModificationDetector, 1)
                whenever(freenetInterface.insertDirectory(eq(expectedInsertUri), any<HashMap<String, Any>>(), eq("index.html"))).thenAnswer {
                        soneInserter.stop()
                        finalUri
@@ -141,7 +144,7 @@ class SoneInserterTest {
        fun `sone inserter does not insert sone if it is not eligible`() {
                createSone(insertUri)
                val soneModificationDetector = mock<SoneModificationDetector>()
-               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, "SoneId", soneModificationDetector, 1)
+               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, "SoneId", soneModificationDetector, 1)
                Thread(Runnable {
                        try {
                                Thread.sleep(500)
@@ -161,7 +164,7 @@ class SoneInserterTest {
                val sone = createSone(insertUri)
                val soneModificationDetector = mock<SoneModificationDetector>()
                whenever(soneModificationDetector.isEligibleForInsert).thenReturn(true)
-               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, "SoneId", soneModificationDetector, 1)
+               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, "SoneId", soneModificationDetector, 1)
                val soneException = SoneException(Exception())
                whenever(freenetInterface.insertDirectory(eq(expectedInsertUri), any<HashMap<String, Any>>(), eq("index.html"))).thenAnswer {
                        soneInserter.stop()
@@ -181,7 +184,7 @@ class SoneInserterTest {
        @Test
        fun `sone inserter exits if sone is unknown`() {
                val soneModificationDetector = mock<SoneModificationDetector>()
-               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, "SoneId", soneModificationDetector, 1)
+               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, "SoneId", soneModificationDetector, 1)
                whenever(soneModificationDetector.isEligibleForInsert).thenReturn(true)
                whenever(core.getSone("SoneId")).thenReturn(null)
                soneInserter.serviceRun()
@@ -190,7 +193,7 @@ class SoneInserterTest {
        @Test
        fun `sone inserter catches exception and continues`() {
                val soneModificationDetector = mock<SoneModificationDetector>()
-               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, "SoneId", soneModificationDetector, 1)
+               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, "SoneId", soneModificationDetector, 1)
                val stopInserterAndThrowException = Answer<Optional<Sone>> {
                        soneInserter.stop()
                        throw NullPointerException()
@@ -243,7 +246,7 @@ class SoneInserterTest {
                val soneModificationDetector = mock<SoneModificationDetector>()
                whenever(soneModificationDetector.isEligibleForInsert).thenReturn(true)
                whenever(freenetInterface.insertDirectory(eq(expectedInsertUri), any<HashMap<String, Any>>(), eq("index.html"))).thenReturn(finalUri)
-               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry,"SoneId", soneModificationDetector, 1)
+               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, "SoneId", soneModificationDetector, 1)
                doAnswer {
                        soneInserter.stop()
                        null
@@ -258,7 +261,7 @@ class SoneInserterTest {
                createSone(insertUri)
                val soneModificationDetector = mock<SoneModificationDetector>()
                whenever(soneModificationDetector.isEligibleForInsert).thenReturn(true)
-               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, "SoneId", soneModificationDetector, 1)
+               val soneInserter = SoneInserter(core, eventBus, freenetInterface, metricRegistry, soneUriCreator, "SoneId", soneModificationDetector, 1)
                whenever(freenetInterface.insertDirectory(eq(expectedInsertUri), any<HashMap<String, Any>>(), eq("index.html"))).thenAnswer {
                        soneInserter.stop()
                        throw SoneException(Exception())
@@ -273,8 +276,4 @@ class SoneInserterTest {
 }
 
 val insertUri = createInsertUri
-val expectedInsertUri: FreenetURI = FreenetURI(insertUri.toString())
-               .setKeyType("USK")
-               .setDocName("Sone")
-               .setMetaString(kotlin.emptyArray())
-               .setSuggestedEdition(0)
+val expectedInsertUri = createInsertUri
index c628334..676ca6b 100644 (file)
@@ -228,4 +228,9 @@ class SoneModuleTest {
                injector.verifySingletonInstance<TickerShutdown>()
        }
 
+       @Test
+       fun `sone URI creator is created as singleton`() {
+               injector.verifySingletonInstance<SoneUriCreator>()
+       }
+
 }