Introduce persistence layer for the broker #106

Asitha · 2017-12-22T06:24:28Z

Purpose

Describe the problems, issues, or needs driving this feature/fix and include links to related issues in the following format: Resolves issue1, issue2, etc.

Purpose of this feature is to introduce persistence of Messages, Exchanges, Queues and Bindings so that messages won't get lost on server failure.

Resolves #24, Resolves #105, Resolves #93, Resolves #79, Resolves #69

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

With this PR we are introducing RDBMS based message persistence layer to persist Messages, Exchanges, Queues and Bindings

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

Following key improvements are done

Introduce RDBMS based persistence support. (Added built in Derby database and script for MySQL)
Re-queued messages delivered first when dequeuing from the queue.
Restore persisted states when restarting the broker.
Initial implementation of message persistence operation cancellation as an optimisation.

User stories

Summary of user stories addressed by this change>

N/A

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

RDBMS based persistent layer. Supports standard SQL based DBMS

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

Unit tests

Code coverage information
Integration tests

Details about the test cases and coverage

Yes

Security checks

Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? yes/no
Ran FindSecurityBugs plugin and verified report? yes/no
Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? yes/no

No

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

N/A

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

…opment iteration

…ase v1.0.47

…next development iteration

…ase v1.0.47

…next development iteration

a5anka · 2018-01-08T05:55:12Z

modules/broker-core/src/main/java/org/wso2/broker/core/Metadata.java

    }

-    public ByteBuf getRawMetadata() {
-        return rawMetadata;
+    public boolean hasAttachedQueues() {


Shall we use a single word denote the attached queues (attached or owned)?

Used the word attached in all the places

a5anka · 2018-01-08T06:05:32Z

modules/broker-amqp/src/main/java/org/wso2/broker/amqp/codec/InMemoryMessageAggregator.java

@@ -56,15 +55,15 @@ public void basicPublishReceived(ShortString routingKey, ShortString exchangeNam

    /**
     * Add the header frame that gives the relevant metadata for the given message.
-     *
-     * @param rawMetadata unprocessed raw metadata {@link ByteBuf}
+     *  @param headers protocol specific headers


Let's fix the spacing issue.

a5anka · 2018-01-08T06:06:14Z

modules/broker-amqp/src/main/java/org/wso2/broker/amqp/codec/InMemoryMessageAggregator.java

-     *
-     * @param rawMetadata unprocessed raw metadata {@link ByteBuf}
+     *  @param headers protocol specific headers
+     * @param properties


Let's define what the properties mean

a5anka · 2018-01-08T07:53:07Z

modules/broker-core/src/main/java/org/wso2/broker/core/Exchange.java


-    void bind(Queue queue, String routingKey, FieldTable arguments) throws BrokerException;
+    public BindingDao getBindingDao() {


This method is unused. Maybe we can get rid of it.

Method removed.

warunalakshitha · 2018-01-08T08:10:20Z

modules/broker-core/src/main/java/org/wso2/broker/core/MessageIdGenerator.java

+        previousTimestamp = ts;
+        long id = (ts - REFERENCE_START) * 256L * 1024L + instanceId * 1024L + offset;
+        if (previousId == id) {
+            throw new RuntimeException("duplicate ids detected. This should never happen");


better to use "Duplicate"

a5anka · 2018-01-08T08:59:02Z

modules/broker-core/src/main/java/org/wso2/broker/core/MessagingEngine.java

                        }
+                        // Unique queues can be empty due unmatching selectors.
+                        if (!uniqueQueues.isEmpty()) {
+                            boolean published = publishToQueues(message, uniqueQueues);


Do we need a local variable for this? Can't directly use it on if?

Updated the code segment.

a5anka · 2018-01-08T09:14:09Z

modules/broker-core/src/main/java/org/wso2/broker/core/QueueRegistry.java

+
+        if (passive && queueHandler == null) {
+            throw new BrokerException("QueueHandler [ " + queueName + " ] doesn't exists. Passive parameter " +
+                    "is set, hence not creating the queue.");


+ should precede here

a5anka · 2018-01-08T11:43:01Z

modules/integration/src/test/resources/broker-auto-start-suite.xml

+        <!--<classes>-->
+            <!--<class name="org.wso2.messaging.integration.QueueConsumerTest"/>-->
+        <!--</classes>-->
+    <!--</test>-->


Shall we remove this part since we have it above?

a5anka · 2018-01-08T11:44:12Z

modules/launcher/src/main/assembly/assembly.xml

+        <fileSet>
+            <directory>target/database/</directory>
+            <outputDirectory>database</outputDirectory>
+            <fileMode>755</fileMode>


Do we need to set the file mode to 755?

Changed to 644

- Implement database backed queue with message persist and delete operations.

- Update broker metadata implementation with FieldTables to handle message properties and headers. - Implement database backed queue message restoration at broker startup.

Send an error to the client and log the exception when the client request to close a consumer with an invalid consumer tag.

Asitha requested a review from a5anka December 22, 2017 06:24

Asitha self-assigned this Dec 22, 2017

Asitha requested review from warunalakshitha and MaryamZi December 22, 2017 06:24

Asitha force-pushed the message-persistence branch 4 times, most recently from a32b55d to bb4d246 Compare December 28, 2017 06:04

Asitha force-pushed the message-persistence branch from bb4d246 to 6cefbd9 Compare January 2, 2018 04:12

wso2-jenkins-bot added a commit that referenced this pull request Jan 3, 2018

[WSO2 Release] [Jenkins #106] [Release 1.0.47] prepare release v1.0.47

1871cdc

wso2-jenkins-bot added a commit that referenced this pull request Jan 3, 2018

[WSO2 Release] [Jenkins #106] [Release 1.0.47] prepare for next devel…

21c3d0a

…opment iteration

Asitha force-pushed the message-persistence branch 2 times, most recently from 0489b8c to b704394 Compare January 4, 2018 13:06

warunalakshitha pushed a commit to warunalakshitha/message-broker that referenced this pull request Jan 4, 2018

[WSO2 Release] [Jenkins wso2-attic#106] [Release 1.0.47] prepare rele…

4813ee9

…ase v1.0.47

warunalakshitha pushed a commit to warunalakshitha/message-broker that referenced this pull request Jan 4, 2018

[WSO2 Release] [Jenkins wso2-attic#106] [Release 1.0.47] prepare for …

6ef2afd

…next development iteration

warunalakshitha pushed a commit to warunalakshitha/message-broker that referenced this pull request Jan 4, 2018

[WSO2 Release] [Jenkins wso2-attic#106] [Release 1.0.47] prepare rele…

e99010d

…ase v1.0.47

warunalakshitha pushed a commit to warunalakshitha/message-broker that referenced this pull request Jan 4, 2018

[WSO2 Release] [Jenkins wso2-attic#106] [Release 1.0.47] prepare for …

39963df

…next development iteration

a5anka mentioned this pull request Jan 5, 2018

Introducing mysql database script #70

Closed

Asitha force-pushed the message-persistence branch 6 times, most recently from 0a5b8af to 4cee110 Compare January 8, 2018 05:30