7 | Privately message with your GitHub followers4 | 5 |
6 |
7 |
12 |
13 | [Login with your GitHub account](https://octochat.dev/login) to start messaging privately with your GitHub followers.
14 |
15 | ## About
16 |
17 | This app is intended _for demonstration use only_, and is deployed using [Amazon Web Services](https://aws.amazon.com/). The architecture is explained at a high-level [here](docs/ARCHITECTURE.md).
18 |
19 | ## Development
20 |
21 | Create a `.env` file based on [the included example template](.env.example).
22 |
23 | Build a development image from [`Dockerfile.develop`](Dockerfile.develop):
24 |
25 | ```shell
26 | docker build -t octochat -f Dockerfile.develop .
27 | ```
28 |
29 | Use the included [`server.sh`](script/server.sh) script to run the development server in a container:
30 |
31 | ```shell
32 | ./script/server.sh
33 | ```
34 |
35 | The application will be available at [http://localhost:49160/](http://localhost:49160/).
36 |
37 | ## Contributions
38 |
39 | We welcome contributions! See how to [contribute](docs/CONTRIBUTING.md).
40 |
41 | ## License
42 |
43 | [MIT](LICENSE.md)
44 |
--------------------------------------------------------------------------------
/app/lib/app.js:
--------------------------------------------------------------------------------
1 | // for web framework
2 | const express = require('express');
3 | const app = express();
4 |
5 | // nunjucks for template rendering
6 | // https://mozilla.github.io/nunjucks/getting-started.html
7 | const nunjucks = require('nunjucks');
8 | nunjucks.configure('/app/views', {
9 | express: app,
10 | autoescape: true,
11 | noCache: true
12 | });
13 | app.set('view engine', 'html');
14 |
15 | // http://expressjs.com/en/starter/static-files.html
16 | app.use(express.static('public'));
17 |
18 | app.use(express.urlencoded({
19 | extended: false
20 | }));
21 |
22 | // init our file-based session storage
23 | const session = require('express-session');
24 | const FileStore = require('session-file-store')(session);
25 | app.use(
26 | session({
27 | store: new FileStore({
28 | path: '/app/.data',
29 | ttl: 86400
30 | }),
31 | resave: false,
32 | saveUninitialized: true,
33 | secret: process.env.SESSION_STORE_SECRET
34 | })
35 | );
36 |
37 | module.exports = {
38 | app
39 | };
40 |
--------------------------------------------------------------------------------
/app/lib/handlers.js:
--------------------------------------------------------------------------------
1 | // data model
2 | const model = require('./model');
3 | const { body, validationResult } = require('express-validator');
4 | const logger = require('../lib/logger');
5 |
6 | // for GitHub API
7 | const Octokit = require('@octokit/rest');
8 |
9 | // for OAuth authorization "state" generation
10 | const crypto = require('crypto');
11 |
12 | // for HTTP request
13 | const axios = require('axios');
14 | // (...we want JSON by default)
15 | axios.defaults.headers.common.Accept = 'application/json';
16 |
17 | // server-side validation rules for incoming new message form
18 | module.exports.validateMessage = () => {
19 | return [
20 | body('message')
21 | .not().isEmpty()
22 | .trim()
23 | .escape()
24 | ];
25 | };
26 |
27 | module.exports.getRoot = async (request, response) => {
28 | if (request.session.token) {
29 | const messages = await model.messagesReceivedList(request.session.viewData.user.id);
30 |
31 | // expose various parameters to template via viewData
32 | request.session.viewData.messages = messages;
33 | request.session.viewData.selectedBox = 'Inbox';
34 | // empty out any conversation data
35 | delete request.session.viewData.messages;
36 | delete request.session.viewData.conversation;
37 | delete request.session.viewData.selectedFollower;
38 | }
39 |
40 | // render and send the page
41 | response.render('index', {
42 | title: process.env.TITLE,
43 | ...request.session.viewData
44 | });
45 | };
46 |
47 | module.exports.getConversation = async (request, response) => {
48 | if (request.session.token) {
49 | const userId = request.params.userId; // github user id
50 | const messages = await model.messagesBetween(request.session.viewData.user.id, userId);
51 |
52 | // expose authenticated user to template via viewData
53 | request.session.viewData.messages = messages;
54 | request.session.viewData.conversation = userId;
55 | request.session.viewData.selectedFollower = request.session.viewData.followers.find(follower => parseInt(follower.id, 10) === parseInt(userId, 10));
56 |
57 | // render and send the page
58 | response.render('index', {
59 | title: process.env.TITLE,
60 | ...request.session.viewData
61 | });
62 | } else {
63 | return response.redirect('/');
64 | }
65 | };
66 |
67 | module.exports.getSent = async (request, response) => {
68 | if (request.session.token) {
69 | const messages = await model.messagesSentList(request.session.viewData.user.id);
70 |
71 | request.session.viewData.messages = messages;
72 | request.session.viewData.selectedBox = 'Sent';
73 |
74 | // render and send the page
75 | response.render('index', {
76 | title: process.env.TITLE,
77 | ...request.session.viewData
78 | });
79 | } else {
80 | return response.redirect('/');
81 | }
82 | };
83 |
84 | module.exports.postMessage = async (request, response) => {
85 | const message = request.body.message;
86 |
87 | if (validationResult(request).array().length) {
88 | // error
89 | response.redirect('/');
90 | } else {
91 | await model.messageAdd({
92 | toId: request.session.viewData.selectedFollower.id,
93 | to: request.session.viewData.selectedFollower.login,
94 | fromId: request.session.viewData.user.id,
95 | from: request.session.viewData.user.login,
96 | message
97 | });
98 |
99 | response.redirect(`/messages/${request.session.viewData.selectedFollower.id}`);
100 | }
101 | };
102 |
103 | module.exports.login = async (request, response) => {
104 | // generate a random state
105 | const state = crypto
106 | .createHmac('sha1', process.env.CLIENT_SECRET)
107 | .update(Math.random().toString())
108 | .digest('hex')
109 | .substring(0, 8);
110 |
111 | return response.redirect(
112 | `https://github.com/login/oauth/authorize?client_id=${process.env.CLIENT_ID}&state=${state}`
113 | );
114 | };
115 |
116 | module.exports.logout = async (request, response) => {
117 | // delete the token and viewData
118 | delete request.session.token;
119 | delete request.session.viewData;
120 |
121 | // go home
122 | return response.redirect('/');
123 | };
124 |
125 | // for completing OAuth authorization flow
126 |
127 | module.exports.completeOauth = async (request, response) => {
128 | const code = request.query.code;
129 | const state = request.query.state;
130 |
131 | if (code) {
132 | // exchange for token
133 | // per, https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#2-users-are-redirected-back-to-your-site-by-github
134 | const token = await axios.post(
135 | 'https://github.com/login/oauth/access_token',
136 | {
137 | client_id: process.env.CLIENT_ID,
138 | client_secret: process.env.CLIENT_SECRET,
139 | code: code,
140 | state: state,
141 | redirect_uri: process.env.REDIRECT_URI
142 | }
143 | );
144 |
145 | // preserve token in session storage
146 | request.session.viewData = {};
147 | request.session.token = token.data.access_token;
148 |
149 | const github = new Octokit({
150 | auth: request.session.token
151 | });
152 |
153 | // get followers of authenticated user
154 | // paginated to 30 by default; this grabs them all per https://octokit.github.io/rest.js/#pagination
155 | const followersPage = github.users.listFollowersForAuthenticatedUser.endpoint.merge({ per_page: 100 });
156 | const followers = (await github.paginate(followersPage));
157 | // get authenticated user
158 | const currentUser = await github.users.getAuthenticated();
159 |
160 | logger.info(`Retrieved ${followers.length} followers.`);
161 |
162 | // sort followers by login, alphabetically, ignoring case
163 | followers
164 | .sort((a, b) => a.login.toLowerCase().localeCompare(b.login.toLowerCase()));
165 | logger.debug(`Followers: ${JSON.stringify(followers.map(f => f.login), null, 4)}`);
166 |
167 | request.session.viewData.followers = followers;
168 | request.session.viewData.user = currentUser.data;
169 |
170 | // redirect home
171 | return response.redirect('/');
172 | }
173 |
174 | // not found
175 | response.status(404).send('Not found');
176 | };
177 |
178 | // for alb health check
179 | module.exports.healthCheck = async (request, response) => {
180 | response.status(200).send('OK');
181 | };
182 |
--------------------------------------------------------------------------------
/app/lib/logger.js:
--------------------------------------------------------------------------------
1 | const Logger = require('bunyan');
2 | const bunyanFormat = require('bunyan-format');
3 | const { name } = require('../package');
4 |
5 | const logger = new Logger({
6 | name,
7 | level: process.env.LOG_LEVEL || 'info',
8 | stream: bunyanFormat({ outputMode: process.env.LOG_FORMAT || 'short' }, process.stderr)
9 | });
10 |
11 | module.exports = logger;
12 |
--------------------------------------------------------------------------------
/app/lib/model.js:
--------------------------------------------------------------------------------
1 | // https://aws.amazon.com/sdk-for-node-js/
2 | const aws = require('aws-sdk');
3 | const lambda = new aws.Lambda();
4 | const utilities = require('./utilities');
5 |
6 | // Callback to Promise wrapper of lambda.invoke
7 | const invokeLambda = async (params) => {
8 | // Convert callback to promise for easier handling
9 | return new Promise((resolve) => {
10 | // https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Lambda.html#invoke-property
11 | lambda.invoke(params, (err, data) => {
12 | resolve({ err, data });
13 | });
14 | });
15 | };
16 |
17 | // send a message
18 | const messageAdd = async (msgObj) => {
19 | const params = {
20 | FunctionName: 'message_add',
21 | Payload: `{"toId": ${msgObj.toId}, "to": "${msgObj.to}", "fromId": ${msgObj.fromId}, "from": "${msgObj.from}", "message": "${msgObj.message}"}`
22 | };
23 |
24 | return invokeLambda(params);
25 | };
26 |
27 | // list the 50 most recently received messages
28 | const messagesReceivedList = async (toId) => {
29 | const params = {
30 | FunctionName: 'messages_received_list',
31 | Payload: `{
32 | "toId": ${toId}
33 | }`
34 | };
35 |
36 | return utilities.cleanMessages(await invokeLambda(params));
37 | };
38 |
39 | // list the 50 most recently sent messages
40 | const messagesSentList = async (fromId) => {
41 | const params = {
42 | FunctionName: 'messages_sent_list',
43 | Payload: `{
44 | "fromId": ${fromId}
45 | }`
46 | };
47 |
48 | return utilities.cleanMessages(await invokeLambda(params));
49 | };
50 |
51 | // get messages between two user ids
52 | const messagesBetween = async (user1, user2) => {
53 | // gather messages from user2 sent to user1
54 | const received = (await messagesReceivedList(user1)).filter(msg => parseInt(msg.fromId, 10) === parseInt(user2, 10));
55 | // gather messages to user2 sent by user1
56 | const sent = (await messagesSentList(user1)).filter(msg => parseInt(msg.toId, 10) === parseInt(user2, 10));
57 | // combine into one array and sort by received date
58 | return [].concat(received, sent).sort((a, b) => new Date(a.receivedAt) - new Date(b.receivedAt));
59 | };
60 |
61 | module.exports = {
62 | messageAdd,
63 | messagesReceivedList,
64 | messagesSentList,
65 | messagesBetween
66 | };
67 |
--------------------------------------------------------------------------------
/app/lib/utilities.js:
--------------------------------------------------------------------------------
1 | const cleanMessages = (msgs) => {
2 | const messages = JSON.parse(msgs.data.Payload);
3 | return messages.data.map((message) => {
4 | return {
5 | ...message,
6 | receivedAt: (new Date(message.receivedAt * 1000)).toLocaleString()
7 | };
8 | });
9 | };
10 |
11 | module.exports = {
12 | cleanMessages
13 | };
14 |
--------------------------------------------------------------------------------
/app/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "octochat",
3 | "author": {
4 | "name": "GitHub"
5 | },
6 | "version": "0.0.1",
7 | "description": "A DEMO GitHub App to chat among octocats",
8 | "main": "server.js",
9 | "scripts": {
10 | "start": "node server.js",
11 | "test": "jest --coverage",
12 | "lint": "semistandard"
13 | },
14 | "dependencies": {
15 | "@octokit/rest": "^16.2.0",
16 | "aws-sdk": "^2.577.0",
17 | "axios": "^0.18.0",
18 | "bunyan": "^1.8.12",
19 | "bunyan-format": "^0.2.1",
20 | "express": "^4.16.4",
21 | "express-session": "^1.17.0",
22 | "express-validator": "^6.2.0",
23 | "nunjucks": "^3.2.0",
24 | "session-file-store": "^1.3.1"
25 | },
26 | "devDependencies": {
27 | "jest": "^24.9.0",
28 | "jest-express": "^1.10.1",
29 | "nodemon": "^2.0.1",
30 | "semistandard": "^14.2.0"
31 | },
32 | "engines": {
33 | "node": "12.x"
34 | },
35 | "repository": {
36 | "url": "https://github.com/github-developer/octochat-aws"
37 | },
38 | "license": "MIT",
39 | "keywords": [
40 | "node",
41 | "express"
42 | ]
43 | }
44 |
--------------------------------------------------------------------------------
/app/public/client.js:
--------------------------------------------------------------------------------
1 | document.addEventListener('DOMContentLoaded', function () {
2 | console.log('👋');
3 | });
4 |
--------------------------------------------------------------------------------
/app/public/style.css:
--------------------------------------------------------------------------------
1 | /* https://leaverou.github.io/bubbly/ */
2 | .Box-body {
3 | padding: 0;
4 | border-bottom: 0px;
5 | }
6 | .Box-footer {
7 | border-top: 0px;
8 | }
9 | .message {
10 | position: relative;
11 | margin: 10px 36px;
12 | background: #c0c0c0;
13 | border-radius: 0.4em;
14 | max-width: 25%;
15 | padding: 5px 10px;
16 | color: #fff;
17 | font-size: 1.25em;
18 | clear: both;
19 | }
20 |
21 | .message.from {
22 | text-align: left;
23 | float: left;
24 | clear: both;
25 | }
26 |
27 | .message.from:after {
28 | content: "";
29 | position: absolute;
30 | left: 0;
31 | top: 60%;
32 | width: 0;
33 | height: 0;
34 | border: 20px solid transparent;
35 | border-right-color: #c0c0c0;
36 | border-left: 0;
37 | border-bottom: 0;
38 | margin-top: -10px;
39 | margin-left: -20px;
40 | }
41 |
42 | .message.to {
43 | background: #0366d6;
44 | text-align: right;
45 | float: right;
46 | clear: both;
47 | }
48 |
49 | .message.to:after {
50 | content: "";
51 | position: absolute;
52 | right: 0;
53 | top: 50%;
54 | width: 0;
55 | height: 0;
56 | border: 20px solid transparent;
57 | border-left-color: #0366d6;
58 | border-right: 0;
59 | border-bottom: 0;
60 | margin-top: -10px;
61 | margin-right: -20px;
62 | }
63 |
64 | .inbox-message{
65 | margin: 16px;
66 | padding: 5px;
67 | border: 1px solid #6a737d;
68 | }
69 | .inbox-message .heading{
70 | font-weight: bold;
71 | }
72 |
--------------------------------------------------------------------------------
/app/server.js:
--------------------------------------------------------------------------------
1 | const { app } = require('./lib/app');
2 | const handlers = require('./lib/handlers');
3 | const logger = require('./lib/logger');
4 |
5 | // set up handlers for each route
6 | app.get('/', handlers.getRoot);
7 | app.get('/messages/:userId', handlers.getConversation);
8 | app.get('/sent', handlers.getSent);
9 | app.get('/login', handlers.login);
10 | app.get('/logout', handlers.logout);
11 | app.get('/oauth', handlers.completeOauth);
12 | app.get('/health-check', handlers.healthCheck);
13 | app.post('/messages', handlers.validateMessage(), handlers.postMessage);
14 |
15 | // listen for requests :)
16 | const listener = app.listen(process.env.PORT || 8000, process.env.HOST || '0.0.0.0', () => {
17 | logger.info(`Your app is listening on port ${listener.address().port}`);
18 | });
19 |
--------------------------------------------------------------------------------
/app/tests/app.test.js:
--------------------------------------------------------------------------------
1 | /* global describe, afterEach, beforeEach, test, jest, expect */
2 | const handlers = require('../lib/handlers');
3 | const Request = require('jest-express/lib/request').Request;
4 | const Response = require('jest-express/lib/response').Response;
5 | const Octokit = require('@octokit/rest');
6 |
7 | jest.mock('@octokit/rest');
8 | jest.mock('../lib/model');
9 |
10 | let request, response;
11 |
12 | describe('App server', () => {
13 | let getAuthenticated;
14 | let paginate;
15 |
16 | beforeEach(() => {
17 | getAuthenticated = jest.fn().mockReturnValueOnce({
18 | data: {
19 | id: 123,
20 | login: 'abc'
21 | }
22 | });
23 |
24 | paginate = jest.fn().mockImplementationOnce(async () => {
25 | return [];
26 | });
27 |
28 | const octokit = {
29 | users: {
30 | getAuthenticated,
31 | listFollowersForAuthenticatedUser: {
32 | endpoint: {
33 | merge: jest.fn()
34 | }
35 | }
36 | },
37 | paginate
38 | };
39 |
40 | Octokit.mockImplementationOnce(() => octokit);
41 | });
42 |
43 | afterEach(() => {
44 | request.resetMocked();
45 | response.resetMocked();
46 | });
47 |
48 | test('getRoot', async () => {
49 | request = new Request('/', {
50 | headers: {
51 | Accept: 'text/html'
52 | }
53 | });
54 |
55 | request.session = {
56 | token: 'abc',
57 | viewData: {
58 | user: {
59 | id: 123456789
60 | }
61 | }
62 | };
63 |
64 | response = new Response();
65 |
66 | await handlers.getRoot(request, response);
67 | // no error
68 | expect(response.render).toBeCalled();
69 | });
70 | });
71 |
--------------------------------------------------------------------------------
/app/views/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |