tests/leak-tests/src/test/java/org/apache/activemq/artemis/tests/leak/MessageReferenceLeakTest.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.activemq.artemis.tests.leak;

import io.github.checkleak.core.CheckLeak;
import org.apache.activemq.artemis.api.core.Message;
import org.apache.activemq.artemis.api.core.QueueConfiguration;
import org.apache.activemq.artemis.api.core.SimpleString;
import org.apache.activemq.artemis.api.core.client.ClientConsumer;
import org.apache.activemq.artemis.api.core.client.ClientMessage;
import org.apache.activemq.artemis.api.core.client.ClientProducer;
import org.apache.activemq.artemis.api.core.client.ClientSession;
import org.apache.activemq.artemis.api.core.client.ClientSessionFactory;
import org.apache.activemq.artemis.api.core.client.ServerLocator;
import org.apache.activemq.artemis.core.server.ActiveMQServer;
import org.apache.activemq.artemis.core.server.MessageReference;
import org.apache.activemq.artemis.core.server.Queue;
import org.apache.activemq.artemis.tests.util.ActiveMQTestBase;
import org.apache.activemq.artemis.utils.RandomUtil;
import org.junit.Assume;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.lang.invoke.MethodHandles;

public class MessageReferenceLeakTest extends ActiveMQTestBase {

   private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());

   ActiveMQServer server;
   ClientSession session;

   public void startServer() throws Exception {
      server = createServer(false, false);
      server.start();
   }

   @BeforeClass
   public static void beforeClass() throws Exception {
      Assume.assumeTrue(CheckLeak.isLoaded());
   }

   @Override
   @Before
   public void setUp() throws Exception {
      startServer();
      ServerLocator locator = addServerLocator(createInVMNonHALocator().setBlockOnNonDurableSend(true).setConsumerWindowSize(0));
      ClientSessionFactory sf = addSessionFactory(createSessionFactory(locator));
      session = addClientSession(sf.createSession(false, true, false));
      session.start();
   }

   @Override
   public void tearDown() throws Exception {
      super.tearDown();
      server = null;
   }

   @Test
   public void testScheduledMessageReferenceLeak() throws Exception {

      SimpleString address = RandomUtil.randomSimpleString();
      SimpleString queue = RandomUtil.randomSimpleString();

      session.createQueue(new QueueConfiguration().setAddress(address).setName(queue).setDurable(false));
      Queue serverQueue = server.locateQueue(queue);

      try (ClientProducer producer = session.createProducer(address)) {
         ClientMessage message = createTextMessage(session, "Hello world")
               .putLongProperty(Message.HDR_SCHEDULED_DELIVERY_TIME, System.currentTimeMillis() + 5000);
         producer.send(message);
      }

      assertNull(serverQueue.peekFirstMessage());

      MessageReference ref = serverQueue.peekFirstScheduledMessage();
      assertNotNull(ref);

      // Store this for later to check for leaks
      String refClassName = ref.getClass().getCanonicalName();
      long messageId = ref.getMessageID();
      // Get rid of the message reference.
      ref = null;
      assertNull(ref);

      // Override Message.HDR_SCHEDULED_DELIVERY_TIME
      serverQueue.deliverScheduledMessage(messageId);
      serverQueue.flushExecutor();

      try (ClientConsumer consumer = session.createConsumer(queue)) {
         ClientMessage message = consumer.receive(1000);
         assertNotNull(message);
         message.individualAcknowledge();
         session.commit(true);
         assertEquals(messageId, message.getMessageID());
      }

      // Now that I've consumed the message there should be no reference left.
      // I cannot just assert that there's no org.apache.activemq.artemis.core.server.MessageReference because there's
      // a static instance of it: org.apache.activemq.artemis.core.paging.cursor.impl.PageSubscriptionImpl.RETRY_MARK
      MemoryAssertions.assertMemory(new CheckLeak(), 0, refClassName);

      session.deleteQueue(queue);
   }
}