[WIP]: Fulltext search (#8381)

.docker/Dockerfile

@@ -1,6 +1,6 @@
 FROM rocketchat/base:4
 
-ENV RC_VERSION 0.59.0-develop
+ENV RC_VERSION 0.59.2
 
 MAINTAINER buildmaster@rocket.chat
 

.meteor/packages

@@ -177,3 +177,4 @@ deepwell:bootstrap-datepicker2
 rocketchat:postcss
 dynamic-import@0.1.3
 keepnox:perfect-scrollbar
+redlink:search

.meteor/versions

@@ -121,6 +121,7 @@ random@1.0.10
 rate-limit@1.0.8
 reactive-dict@1.1.9
 reactive-var@1.0.11
+redlink:search@0.0.1
 reload@1.1.11
 retry@1.0.9
 rocketchat:2fa@0.0.1
@@ -190,6 +191,7 @@ rocketchat:postcss@1.0.0
 rocketchat:push-notifications@0.0.1
 rocketchat:reactions@0.0.1
 rocketchat:sandstorm@0.0.1
+rocketchat:search@0.0.1
 rocketchat:slackbridge@0.0.1
 rocketchat:slashcommands-archive@0.0.1
 rocketchat:slashcommands-asciiarts@0.0.1

.sandstorm/sandstorm-pkgdef.capnp

@@ -21,7 +21,7 @@ const pkgdef :Spk.PackageDefinition = (
 
 		appVersion = 62,  # Increment this for every release.
 
-		appMarketingVersion = (defaultText = "0.59.0-develop"),
+		appMarketingVersion = (defaultText = "0.59.2"),
 		# Human-readable representation of appVersion. Should match the way you
 		# identify versions of your app in documentation and marketing.
 

.travis/snap.sh

@@ -17,7 +17,7 @@ elif [[ $TRAVIS_TAG ]]; then
     RC_VERSION=$TRAVIS_TAG
 else
     CHANNEL=edge
-    RC_VERSION=0.59.0-develop
+    RC_VERSION=0.59.2
 fi
 
 echo "Preparing to trigger a snap release for $CHANNEL channel"

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "Rocket.Chat",
 	"description": "The Ultimate Open Source WebChat Platform",
-	"version": "0.59.0-develop",
+	"version": "0.59.2",
 	"author": {
 		"name": "Rocket.Chat",
 		"url": "https://rocket.chat/"

packages/redlink-search/README.md

@@ -0,0 +1,5 @@
+# Purpose
+This package provides options to enable full-text-search in Rocket.Chat
+
+# Implementation
+For integrating as loosely as possible, this package provides an implementation of the Rocket.Chat search interface.

packages/redlink-search/lib/SearchProvider.js

@@ -0,0 +1,47 @@
+import {
+	SearchProvider,
+	searchProviders,
+	SearchProviderMetadata,
+	SearchProviderRuntimeIntegration,
+	SearchProviderUi
+} from 'meteor/rocketchat:search';
+
+export const SETTING_URL = 'RedlinkSearchUrl';
+
+class RedlinkSearchProviderRuntimeIntegration extends SearchProviderRuntimeIntegration {
+
+}
+
+class RedlinkSearchProviderMetadata extends SearchProviderMetadata {
+	supportsPermissions() {
+		return true;
+	}
+
+	addSettings(section) {
+		section.add(SETTING_URL, '');
+	}
+
+	isConfigurationValid(settings, logger) {
+		logger.debug('Validating settings', settings);
+		if (!settings[SETTING_URL] || settings[SETTING_URL] === '') {
+			return false;
+		}
+	}
+}
+
+/*
+Don't know whether an own UI is really necessary
+ */
+class RedlinkSearchProviderUi extends SearchProviderUi {
+
+}
+
+class RedlinkSearchProvider extends SearchProvider {
+	constructor() {
+		super('redlink', new RedlinkSearchProviderRuntimeIntegration(), new RedlinkSearchProviderMetadata(), new RedlinkSearchProviderUi());
+	}
+}
+
+Meteor.startup(function() {
+	searchProviders.add(new RedlinkSearchProvider());
+});

packages/redlink-search/package.js

@@ -0,0 +1,23 @@
+Package.describe({
+	name: 'redlink:search',
+	version: '0.0.1',
+	summary: 'Full-text search for RocketChat - open source provided by Redlink',
+	git: 'https://github.com/redlink-gmbh/rocket-search',
+	documentation: 'README.md'
+});
+
+Package.onUse(function(api) {
+	api.versionsFrom('1.5.2.2');
+	api.use('ecmascript');
+	api.use('rocketchat:search');
+
+	api.addFiles('lib/SearchProvider.js');
+
+	api.mainModule('redlink-search.js');
+});
+
+/*Package.onTest(function(api) {
+	api.use('ecmascript');
+	api.use('tinytest');
+	api.use('redlink:search');
+});*/

packages/redlink-search/redlink-search.js

@@ -0,0 +1,5 @@
+// Write your package code here!
+
+// Variables exported by this module can be imported by other packages and
+// applications. See redlink-search-lib-tests.js for an example of importing.
+export const name = 'search-redlink';

packages/rocketchat-lib/rocketchat.info

@@ -1,3 +1,3 @@
 {
-	"version": "0.59.0-develop"
+	"version": "0.59.2"
 }

packages/rocketchat-search/README.md

@@ -0,0 +1,2 @@
+# Purpose
+This package provides a framework and libraries for implementing a full-text-search inside Rocket.Chat

packages/rocketchat-search/lib/RoomSearchResult.js

@@ -0,0 +1,10 @@
+/**
+ * Transport object for a single result when searching for Rooms
+ */
+export class RoomSearchResult {
+	constructor(roomId, title, formattedExcerpt) {
+		this.roomId = roomId;
+		this.title = title;
+		this.formattedExcerpt = formattedExcerpt;
+	}
+}

packages/rocketchat-search/lib/SearchProvider.js

@@ -0,0 +1,90 @@
+import {SearchProviderRuntimeIntegration} from './SearchProviderRuntimeIntegration';
+import {SearchProviderMetadata} from './SearchProviderMetadata';
+import {SearchProviderUi} from './SearchProviderUi';
+
+/**
+ * A search provider is an implementation of a full-text-search within Rocket.Chat
+ * As such, it is integrated during the search-relevant events at runtime.
+ * It may provide own UI elements or re-use generic UI components
+ */
+export class SearchProvider {
+	constructor(identifier, runtimeIntegration, metadata, ui) {
+		if (!(runtimeIntegration instanceof SearchProviderRuntimeIntegration)) {
+			throw new Error('Invalid runtimeIntegration object, it must extend "SearchProviderRuntimeIntegration"');
+		}
+
+		if (!(metadata instanceof SearchProviderMetadata)) {
+			throw new Error('Invalid metadata object, it must extend "SearchProviderMetadata"');
+		}
+
+		if (!(ui instanceof SearchProviderUi)) {
+			throw new Error('Invalid ui object, it must extend "SearchProviderUi"');
+		}
+
+		this._identifier = identifier;
+
+		this._metadata = metadata;
+
+		// restrict visibility of components to the tier they are used on
+		if (Meteor.isServer) {
+			this._runtimeIntegration = runtimeIntegration;
+		}
+
+		if (Meteor.isClient) {
+			this._ui = ui;
+		}
+	}
+
+	get identifier() {
+		return this._identifier;
+	}
+
+	/*
+	As an alternative to interfaces, we use composition in order to group features and methods
+	 */
+
+	/**
+	 * Interface for integrating the search provider in the transaction process of executing Rocket.Chat
+	 * @return {SearchProviderRuntimeIntegration}
+	 */
+	get runtimeIntegration() {
+		return this._runtimeIntegration;
+	}
+
+	/**
+	 * Interface for retrieving infromatino about the search provider which are used for configuration of the provider
+	 * or for triggering switches in the caller
+	 * @return {SearchProviderMetadata}
+	 */
+	get metadata() {
+		return this._metadata;
+	}
+
+	/**
+	 * Interface for everything related to the user interface. This includes the actual UI components as well as all
+	 * kinds of text presented to the end-user
+	 * @return {SearchProviderUi}
+	 */
+	get ui() {
+		return this._ui;
+	}
+
+	/*
+	The following methods are the actual core of the search
+	 */
+
+	/**
+	 * Perform a full-text-search for rooms. The content which is searched may depend on the provider.
+	 * Potential sources are all properties handed over during replication
+	 * @param searchText The text as entered by the user. Caution: there's no escaping done by the consumer. Protection
+	 * for code injection needs to be performed by the implementaion
+	 * @param userId The technical GUID of the user who executed the seach. This allows for integration of an ACL
+	 * @param logger A logger providing log-levels {error, warn, info/log, debug, success}
+	 * @return {Array} //todo: Define format of the result instance
+	 */
+	findRooms(searchText, userId, logger) {
+		logger.debug('Search for rooms triggered by', userId, 'with search text', searchText);
+		return [];
+	}
+
+}