Snippet message #4623

juanwolf · 2016-10-13T14:36:58Z

@RocketChat/core

Closes #4395 [Closes #1553 but no auto-recognition]

I made a plugin to handle snippets into RocketChat. It is not finished yet but some review from the community would be awesome.

How it works

Send your code as a normal message
Use the toolbox on your message such as below

- Choose a name for your snippet

- Confirmation Message

- Snippet created!

After that, the message containing the snippet is formatted as you could do it using the "```". The system also create a new message containing the link to access to your snippet.

You can also access to your snippet with the tab bar on your right.

- View your snippet

# Settings ## Message configuration

You can disable or enable this feature in the "Message" administration section

## ~~Snippet storage configuration~~

~~You have the choice between GridFS storage and FileSystem storage~~

Please do not hesitate to review the code and give me your thoughts about this plugin :)

Edit 14/10

The persistence of the message as a file has been removed because it was not really useful.
Snippets are now stored only into the rocketchat_messages collection instead of having a rocketchat_snippeted_message
The snippet is downloadable

Behavior copied from the pin message plugin.

cpitman · 2016-10-14T03:38:16Z

Do snippets really need to be stored separately? Could it just be a property of a normal message?

juanwolf · 2016-10-14T06:20:09Z

No not really. I based this plugin on the rocketchat-pin-message which does save messages in a different collections. There's already a property in the rocketchat-message collection for a snippet message so it should be quick to do the changes.

cpitman · 2016-10-14T14:20:21Z

Either way, this will help a ton with users that are pasting in large chunks of code, console output, etc.

sampaiodiego · 2016-10-14T22:26:37Z

nice work @juanwolf .. =)

snippet messages are still limited by message size limit, right?

juanwolf · 2016-10-14T23:59:37Z

@sampaiodiego thanks! Yes. The snippet message is stored as a normal message so the limitation should still work.

rodrigok · 2016-10-24T16:45:51Z

packages/rocketchat-message-snippet/client/actionButton.js

+		validation: function(message) {
+			let room = RocketChat.models.Rooms.findOne({_id: message.rid});
+
+			if (Array.isArray(room.usernames) && (room.usernames.indexOf(Meteor.user().username) === -1)) {


Can you change this to use subscription instead of room's username?
Like here https://github.com/RocketChat/Rocket.Chat/blob/develop/packages/rocketchat-lib/client/MessageAction.coffee#L100

rodrigok · 2016-10-24T16:48:28Z

packages/rocketchat-message-snippet/client/actionButton.js

+				return false;
+			} else {
+				if (message.snippeted || ((RocketChat.settings.get('Message_AllowSnippeting') === undefined) ||
+										(RocketChat.settings.get('Message_AllowSnippeting') === null))) {


Message_AllowSnippeting can be false, right?

Yeah right, focused on the null value but not the proper one 😞

rodrigok · 2016-10-24T16:51:47Z

packages/rocketchat-message-snippet/client/page/snippetPage.html

+        </div>
+    </div>
+
+</template>


Can you fix indentation here? Please, do not mix spaces and tabs (we prefer tabs)

rodrigok · 2016-10-24T16:53:24Z

packages/rocketchat-message-snippet/client/page/snippetPage.js

+		let message = Messages.findOne({ _id: FlowRouter.getParam('snippetId') });
+		if (message === undefined) {
+			return null;
+		} else {


The else block is not needed here, the return will stop the code execution 😄

rodrigok · 2016-10-24T16:54:47Z

packages/rocketchat-message-snippet/client/page/snippetPage.js

+
+Template.snippetPage.onCreated(function() {
+	let snippetId = FlowRouter.getParam('snippetId');
+	console.log(`${snippetId}: ${this.snippet}`);


Can you remove this log?

rodrigok · 2016-10-24T17:24:41Z

packages/rocketchat-message-snippet/server/publications/snippetedMessage.js

+		{ '_id': _id }
+	).observeChanges({
+		added: function(_id, record) {
+			publication.added('rocketchat_message', _id, record);


We should not use the real collection name here, can you replace by rocketchat_snippeted_message

rodrigok · 2016-10-24T17:26:28Z

packages/rocketchat-message-snippet/client/lib/collections.js

@@ -0,0 +1 @@
+this.Messages = new Meteor.Collection('rocketchat_message');


We should not use the real collection name here, can you replace by rocketchat_snippeted_message

And, can you change the variable name? This variable will store only messages from snippeted messages and only when you have the tab bar open

I will do that! Why should we not use the 'rocketchat_message' collection?

rodrigok · 2016-10-24T17:30:21Z

packages/rocketchat-message-snippet/server/publications/snippetedMessagesByRoom.js

+		}
+	).observeChanges({
+		added: function(_id, record) {
+			publication.added('rocketchat_message', _id, record);


We should not use the real collection name here, can you replace by rocketchat_snippeted_message

rodrigok · 2016-10-24T17:33:15Z

packages/rocketchat-message-snippet/server/requests.js

+	var match = /^\/([^\/]+)\/(.*)/.exec(req.url);
+
+	if (match[1]) {
+		let snippet = RocketChat.models.Messages.findOneById(match[1]);


You should do this find after login verification, cuz it's not necessary if user is not authorized.

Can you verify if the message is a snippet, otherwise users can download any message

And, can you verify if the user has access to the room where this message came from?

rodrigok · 2016-10-24T17:37:06Z

packages/rocketchat-message-snippet/server/startup/settings.js

@@ -0,0 +1,13 @@
+Meteor.startup(function() {
+	RocketChat.settings.add('Message_AllowSnippeting', true, {


We usually start new features as disabled by default then users can enable and test, can you change to false?

juanwolf · 2016-10-25T16:36:28Z

Thanks for the code review @rodrigok ! I did some modifications you asked for, I will continue to work on it tomorrow.

rodrigok · 2016-10-25T16:45:58Z

@juanwolf awesome, thanks

juanwolf · 2016-10-26T16:28:08Z

@rodrigok Little question. Because you mentioned that permissions were not set in the request.js file, I wanted to manage it to directly in the snippet page as well. Unfortunately it's just front-end (using FlowRouter) so I can't do proper queries to the mongo, I managed permissions into the publication 'snippetedMessage' but it gives me an empty template (which makes sense but that's really ugly).

I was wondering if you have an idea of where I could manage this permission and send to the user a proper 403 response.

rodrigok · 2016-10-26T17:16:41Z

@juanwolf We can start with this ugly solution and start a new PR for improvements. One way is use method to get data instead of subscriptions, in fact we are replacing a lot of subscriptions by methods, then you can receive the response for your single record or an error and manage the template to show the correct result easily.

rodrigok · 2016-10-27T12:11:01Z

@juanwolf Can you fix the conflict?

juanwolf · 2016-10-27T12:13:28Z

@rodrigok I am on it !

rodrigok · 2016-10-31T11:41:50Z

@engelgabriel IMHO we should merge this in release 0.46

B0biN · 2017-05-18T09:12:20Z

Required to allow in permissions for normal users!!!

Jean-Loup Adde added 7 commits October 13, 2016 10:31

Add snippet message plugin.

c7d3200

Behavior copied from the pin message plugin.

Move client tabs into tabBar folder.

0c9dba7

Add syntax highlighting when a snippet is created.

71e1ef0

Add snippet page and file creation.

6983d26

Add tabBar english translation.

c26c066

Add scrollbar into the snippet view page.

de9ece2

Fix eslint issues.

f038986

Jean-Loup Adde added 2 commits October 14, 2016 13:19

Remove useless snippet collection.

97693ff

Add download button and removed file creation.

baeedd7

Remove unused settings and add translation.

bd3a7c1

engelgabriel added this to the 0.44.0 milestone Oct 17, 2016

rodrigok requested changes Oct 24, 2016

View reviewed changes

Jean-Loup Adde added 7 commits October 25, 2016 15:47

Disabling the snippet feature by default.

1d39acc

Fix Message_AllowSnippeting setting checks.

1cc24dc

Remove unused mime-type dependency.

a089ef1

Remove unused ChatSnippetMessage class.

88f4c80

Remove log and useless else condition.

211cafd

Changed user rooms verifications to subscriptions.

29329ed

Change rocketchat_message collection to a custom one.

49bade9

rodrigok modified the milestones: 0.44.0, 0.45.0 Oct 25, 2016

Jean-Loup Adde added 3 commits October 26, 2016 15:56

Change spaces to tabs in html files.

aafa676

Snippet: Fix permissions in the download section.

7d71eb7

Snippet: Fix collection call.

cff2738

Snippet: Fix permission in snippetedMessage publication.

f0752b3

Snippet: Remove debug logs.

fd68cfb

Jean-Loup Adde added 2 commits October 27, 2016 13:18

Merge branch 'develop' into snippet-message

cbf26d8

Merge branch 'develop' into snippet-message

be4b5f7

rodrigok approved these changes Oct 31, 2016

View reviewed changes

engelgabriel modified the milestones: 0.45.0, 0.46.0 Nov 1, 2016

rodrigok added the Ready to Marge label Nov 1, 2016

engelgabriel merged commit 2f8c637 into RocketChat:develop Nov 2, 2016

reetp mentioned this pull request Jun 26, 2019

Can't add snippet in 0.59.4 #9178

Closed

Snippet message #4623

Snippet message #4623

juanwolf commented Oct 13, 2016 •

edited

cpitman commented Oct 14, 2016

juanwolf commented Oct 14, 2016

cpitman commented Oct 14, 2016

sampaiodiego commented Oct 14, 2016

juanwolf commented Oct 14, 2016

rodrigok Oct 24, 2016

rodrigok Oct 24, 2016

juanwolf Oct 25, 2016 •

edited

rodrigok Oct 24, 2016

rodrigok Oct 24, 2016

rodrigok Oct 24, 2016

rodrigok Oct 24, 2016

rodrigok Oct 24, 2016

rodrigok Oct 24, 2016

juanwolf Oct 25, 2016

rodrigok Oct 24, 2016

rodrigok Oct 24, 2016

rodrigok Oct 24, 2016

rodrigok Oct 24, 2016

rodrigok Oct 24, 2016

juanwolf commented Oct 25, 2016

rodrigok commented Oct 25, 2016

juanwolf commented Oct 26, 2016

rodrigok commented Oct 26, 2016

rodrigok commented Oct 27, 2016

juanwolf commented Oct 27, 2016

rodrigok commented Oct 31, 2016

B0biN commented May 18, 2017 •

edited

		@@ -0,0 +1 @@
		this.Messages = new Meteor.Collection('rocketchat_message');

		@@ -0,0 +1,13 @@
		Meteor.startup(function() {
		RocketChat.settings.add('Message_AllowSnippeting', true, {

Snippet message #4623

Snippet message #4623

Conversation

juanwolf commented Oct 13, 2016 • edited

How it works

Edit 14/10

cpitman commented Oct 14, 2016

juanwolf commented Oct 14, 2016

cpitman commented Oct 14, 2016

sampaiodiego commented Oct 14, 2016

juanwolf commented Oct 14, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

juanwolf Oct 25, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

juanwolf commented Oct 25, 2016

rodrigok commented Oct 25, 2016

juanwolf commented Oct 26, 2016

rodrigok commented Oct 26, 2016

rodrigok commented Oct 27, 2016

juanwolf commented Oct 27, 2016

rodrigok commented Oct 31, 2016

B0biN commented May 18, 2017 • edited

juanwolf commented Oct 13, 2016 •

edited

juanwolf Oct 25, 2016 •

edited

B0biN commented May 18, 2017 •

edited