1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the qtqa module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
const express = require("express");
const EventEmitter = require("events");
const net = require("net");
const uuidv1 = require("uuid/v1");
const postgreSQLClient = require("./postgreSQLClient");
const emailClient = require("./emailClient");
const toolbox = require("./toolbox");
const config = require("./config.json");
// Receive and route incoming requests
// Only pay attention to change-merged events.
// Each gerrit repo that needs use of the bot must be configured with a
// webhook that will send change-merged notifications to this bot.
// Set default values with the config file.
let webhookPort = config.WEBHOOK_PORT;
let gerritIPv4 = config.GERRIT_IPV4;
let gerritIPv6 = config.GERRIT_IPV6;
let adminEmail = config.ADMIN_EMAIL;
// Prefer environment variable if set.
if (process.env.PORT)
webhookPort = Number(process.env.PORT);
if (process.env.GERRIT_IPV4)
gerritIPv4 = process.env.GERRIT_IPV4;
if (process.env.GERRIT_IPV6)
gerritIPv6 = process.env.GERRIT_IPV6;
if (process.env.ADMIN_EMAIL)
adminEmail = process.env.ADMIN_EMAIL;
class webhookListener extends EventEmitter {
constructor(requestProcessor) {
super();
this.requestProcessor = requestProcessor;
}
receiveEvent(req) {
let _this = this;
// Set a unique ID and the full change ID for all inbound requests.
req["uuid"] = uuidv1(); // used for tracking and database access.
if (req.change) {
req["fullChangeID"] =
`${encodeURIComponent(req.change.project)}~${req.change.branch}~${req.change.id}`;
}
if (req.type == "change-merged") {
// Insert the new request into the database for survivability.
const columns = [
"uuid", "changeid", "state", "revision", "rawjson", "cherrypick_results_json"
];
const rowdata = [
req.uuid, req.change.id, "new", req.patchSet.revision,
toolbox.encodeJSONtoBase64(req), toolbox.encodeJSONtoBase64({})
];
postgreSQLClient.insert("processing_queue", columns, rowdata, function(changes) {
// Emit a signal for this merge in case anything is waiting on it.
_this.requestProcessor.emit(`merge_${req.fullChangeID}`);
// Ready to begin processing the merged change.
_this.emit("newRequestStored", req.uuid);
});
} else if (req.type == "change-abandoned") {
// Emit a signal that the change was abandoned in case anything is
// waiting on it. We don't need to do any direct processing on
// abandoned changes.
_this.emit(`abandon_${req.fullChangeID}`);
} else if (req.type == "patchset-created") {
// Treat all new changes as "cherryPickCreated"
// since gerrit doesn't send a separate notification for actual
// cherry-picks. This should be harmless since we will only
// ever be listening for this signal on change ID's that should
// be the direct result of a cherry-pick.
if (req.patchSet.number == 1)
_this.requestProcessor.emit(`cherryPickCreated_${req.fullChangeID}`);
} else if (req.type == "change-staged") {
// Emit a signal that the change was staged in case anything is
// waiting on it.
_this.requestProcessor.emit(`staged_${req.fullChangeID}`);
} else if (req.type == "change-unstaged") {
// Emit a signal that the change was staged in case anything is
// waiting on it.
_this.requestProcessor.emit(`unstaged_${req.fullChangeID}`);
}
}
// Set up a server and start listening on a given port.
startListening() {
let _this = this;
let server = express();
server.use(express.json()); // Set Express to use JSON parsing by default.
server.enable("trust proxy", true);
// Create a custom error handler for Express.
server.use(function(err, req, res, next) {
if (err instanceof SyntaxError) {
// Send the bad request to gerrit admins so it can either be manually processed
// or fixed if there's a bug.
console.log("Syntax error in input. The incoming request may be broken!");
emailClient.genericSendEmail(
adminEmail, "Cherry-pick bot: Error in received webhook",
undefined, // Don't bother assembling an HTML body for this debug message.
err.message + "\n\n" + err.body
);
res.sendStatus(400);
} else {
// This shouldn't happen as long as we're only receiving JSON formatted webhooks from gerrit
res.sendStatus(500);
console.trace(err);
}
});
function validateOrigin(req, res) {
// Filter requests to only receive from an expected gerrit instance.
let clientIp = req.headers["x-forwarded-for"] || req.connection.remoteAddress;
let validOrigin = false;
if (net.isIPv4(clientIp) && clientIp != gerritIPv4) {
res.sendStatus(401);
} else if (net.isIPv6(clientIp) && clientIp != gerritIPv6) {
res.sendStatus(401);
} else if (!net.isIP(clientIp)) {
// ERROR, but don't exit.
console.trace(`FATAL: Incoming request appears to have an invalid origin IP.`);
res.sendStatus(500); // Try to send a status anyway.
} else {
res.sendStatus(200);
validOrigin = true;
}
return validOrigin;
}
// Set up the listening endpoint
console.log("Starting server.");
server.post("/gerrit-events", (req, res) => {
if (validateOrigin(req, res))
_this.emit("newRequest", req.body);
});
server.get("/", (req, res) => res.send("Nothing to see here."));
server.listen(webhookPort);
_this.emit("serverStarted", `Server started listening on port ${webhookPort}`);
}
}
module.exports = webhookListener;
|
