is Response.envelope really needed?

[joeyguerra]

class Response {
// Public: Responses are sent to matching listeners. Messages know about the
// content and user that made the original message, and how to reply back to
// them.
//
// robot - A Robot instance.
// message - A Message instance.
// match - A Match object from the successful Regex match.
constructor (robot, message, match) {
this.robot = robot
this.message = message
this.match = match
this.envelope = {
room: this.message.room,
user: this.message.user,
message: this.message
}
}

What is the purpose of envelope here if message already contains the information?

[xurizaemon]

My understanding is that:

• message contains the message itself
• envelope exists to provide additional context

Conceptually, that makes sense to me - code might need modify the envelope without amending the message, or vice versa. As you say, context (sender, recipient) are being copied into the message here also, which might make it redundant.

Another way to consider that question is: How are plugins currently using those interfaces? That's more of a survey question, the "purpose" being that those things depend on being able to read this.message.room or this.envelope.room. (I don't have an answer for that ... I guess things can be theoretically redundant, and essential in practice.)

[joeyguerra]

I think I understand the idea of an envelope. So the data structure makes sense in that regard. Maybe people will post in here whether their scripts are using envelope or message...