feat: add posthog (closes #220) (#221)

getmeli · Apr 2, 2021 · 5995fbb · 5995fbb
1 parent b14f1ab
commit 5995fbb
Show file tree

Hide file tree

Showing 34 changed files with 362 additions and 57 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -23,6 +23,7 @@ WORKDIR /app/server
 
 ENV MELI_URL_INTERNAL=http://localhost:3001
 ENV MELI_UI_DIR=/app/ui
+ENV MELI_POSTHOG_ENABLED="true"
 
 # Caddy defaults, copied from official Dockerfile
 # https://github.com/caddyserver/caddy-docker/blob/2093c4a571bfe356447008d229195eb7063232b2/2.3/alpine/Dockerfile

diff --git a/package.json b/package.json
@@ -16,7 +16,8 @@
     "build:ui": "npm run build --prefix ui",
     "test": "npm run test:ui",
     "test:ui": "npm run test --prefix server",
-    "lint": "npm run lint --prefix server"
+    "lint": "npm run lint --prefix server",
+    "lint:fix": "npm run lint:fix --prefix server"
   },
   "keywords": [
     "meli",

diff --git a/server/package-lock.json b/server/package-lock.json
diff --git a/server/package.json b/server/package.json
@@ -96,6 +96,7 @@
     "passport-custom": "^1.1.1",
     "passport-google-oauth20": "^2.0.0",
     "passport-oauth2": "^1.5.0",
+    "posthog-node": "^1.0.7",
     "prom-client": "^12.0.0",
     "qs": "^6.9.4",
     "queue": "^6.0.1",

diff --git a/server/src/auth/handlers/get-auth-methods.spec.ts b/server/src/auth/handlers/get-auth-methods.spec.ts
@@ -1,5 +1,5 @@
 import request from 'supertest';
-import { MeliServer } from '../../server';
+import { MeliServer } from '../../createServer';
 import { spyOnVerifyToken } from '../../../tests/utils/spyon-verifytoken';
 import { testServer } from '../../../tests/test-server';
 import { authMethods } from '../passport/auth-methods';

diff --git a/server/src/auth/handlers/sign-out.spec.ts b/server/src/auth/handlers/sign-out.spec.ts
@@ -1,5 +1,5 @@
 import request from 'supertest';
-import { MeliServer } from '../../server';
+import { MeliServer } from '../../createServer';
 import { spyOnVerifyToken } from '../../../tests/utils/spyon-verifytoken';
 import { testServer } from '../../../tests/test-server';
 

diff --git a/server/src/server.ts → server/src/createServer.ts b/server/src/server.ts → server/src/createServer.ts
@@ -7,7 +7,7 @@ import cors from 'cors';
 import express, { Express } from 'express';
 import rateLimit from 'express-rate-limit';
 import helmet from 'helmet';
-import { createServer, Server } from 'http';
+import { createServer as createHttpServer, Server } from 'http';
 import morgan from 'morgan';
 import passport from 'passport';
 import { Logger } from './commons/logger/logger';
@@ -24,6 +24,7 @@ import { authorizeApiReq } from './auth/handlers/authorize-api-req';
 import './auth/passport';
 import { createIoServer } from './socket/create-io-server';
 import { initSocketRooms } from './socket/socket-rooms';
+import { initPosthog } from './posthog/init-posthog';
 
 const logger = new Logger('meli.api:server');
 
@@ -50,8 +51,9 @@ export interface MeliServer {
   stop: () => void;
 }
 
-export async function server(): Promise<MeliServer> {
+export async function createServer(): Promise<MeliServer> {
   await AppDb.init();
+  await initPosthog();
   await migrate(AppDb.client, AppDb.db);
   setupDbIndexes().catch(err => logger.error('Could not setup indexes indexes', err));
   await configureCaddy();
@@ -89,7 +91,7 @@ export async function server(): Promise<MeliServer> {
   app.use(Sentry.Handlers.errorHandler());
   app.use(handleError);
 
-  const httpServer = createServer(app);
+  const httpServer = createHttpServer(app);
   createIoServer(httpServer);
 
   initSocketRooms();

diff --git a/server/src/entities/orgs/handlers/create-org.spec.ts b/server/src/entities/orgs/handlers/create-org.spec.ts
@@ -2,7 +2,7 @@ import { testServer } from '../../../../tests/test-server';
 import { spyOnCollection } from '../../../../tests/utils/spyon-collection';
 import { spyOnVerifyToken } from '../../../../tests/utils/spyon-verifytoken';
 import * as _emitEvent from '../../../events/emit-event';
-import { MeliServer } from '../../../server';
+import { MeliServer } from '../../../createServer';
 import { User } from '../../users/user';
 
 import request from 'supertest';
@@ -50,7 +50,7 @@ describe('createOrg', () => {
       .post('/api/v1/orgs')
       .set('Cookie', ['auth=testToken'])
       .send({
-        name: 'Test Organization'
+        name: 'Test Organization',
       });
 
 
@@ -75,7 +75,7 @@ describe('createOrg', () => {
       userId: 'authenticatedUserId',
       admin: true,
       name: 'Authenticated User',
-      email: 'authenticated@test.tst'
+      email: 'authenticated@test.tst',
     }));
 
     expect(teams.insertOne).toHaveBeenCalled();
@@ -93,7 +93,7 @@ describe('createOrg', () => {
       .post('/api/v1/orgs')
       .set('Cookie', ['auth=testToken'])
       .send({
-        name: 'Test Organization'
+        name: 'Test Organization',
       });
 
 

diff --git a/server/src/entities/orgs/handlers/teams/create-team.spec.ts b/server/src/entities/orgs/handlers/teams/create-team.spec.ts
@@ -5,7 +5,7 @@ import { spyOnCollection } from '../../../../../tests/utils/spyon-collection';
 import { spyOnIsAdminOrOwner } from '../../../../../tests/utils/spyon-isadminorowner';
 import { AUTHENTICATED_USER_ID, spyOnVerifyToken } from '../../../../../tests/utils/spyon-verifytoken';
 import * as _emitEvent from '../../../../events/emit-event';
-import { MeliServer } from '../../../../server';
+import { MeliServer } from '../../../../createServer';
 
 // jest.mock('../../../../env/env', () => ({ env: testEnv }));
 

diff --git a/server/src/entities/sites/handlers/branches/add-branch.spec.ts b/server/src/entities/sites/handlers/branches/add-branch.spec.ts
@@ -4,7 +4,7 @@ import { spyOnCollection } from '../../../../../tests/utils/spyon-collection';
 import { spyOnVerifyToken } from '../../../../../tests/utils/spyon-verifytoken';
 import * as _configureSiteBranchInCaddy from '../../../../caddy/configuration';
 import * as _emitEvent from '../../../../events/emit-event';
-import { MeliServer } from '../../../../server';
+import { MeliServer } from '../../../../createServer';
 import * as _linkBranchToRelease from '../../link-branch-to-release';
 import { linkBranchToRelease } from '../../link-branch-to-release';
 import { EventType } from '../../../../events/event-type';

diff --git a/server/src/entities/sites/handlers/branches/delete-branch.spec.ts b/server/src/entities/sites/handlers/branches/delete-branch.spec.ts
@@ -5,7 +5,7 @@ import { spyOnVerifyToken } from '../../../../../tests/utils/spyon-verifytoken';
 import * as _removeSiteBranchFromCaddy from '../../../../caddy/configuration';
 import { removeSiteBranchFromCaddy } from '../../../../caddy/configuration';
 import * as _emitEvent from '../../../../events/emit-event';
-import { MeliServer } from '../../../../server';
+import { MeliServer } from '../../../../createServer';
 import { EventType } from '../../../../events/event-type';
 import { canAdminSiteGuard } from '../../guards/can-admin-site-guard';
 import { branchExistsGuard } from '../../guards/branch-exists-guard';

diff --git a/server/src/entities/teams/handlers/sites/create-site.spec.ts b/server/src/entities/teams/handlers/sites/create-site.spec.ts
@@ -5,7 +5,7 @@ import { spyOnIsAdminOrOwner } from '../../../../../tests/utils/spyon-isadminoro
 import { AUTHENTICATED_USER_ID, spyOnVerifyToken } from '../../../../../tests/utils/spyon-verifytoken';
 import * as _configureSiteInCaddy from '../../../../caddy/configuration';
 import * as _emitEvent from '../../../../events/emit-event';
-import { MeliServer } from '../../../../server';
+import { MeliServer } from '../../../../createServer';
 
 // jest.mock('../../../../env/env', () => ({ env: testEnv }));
 
@@ -27,7 +27,7 @@ describe('createSite', () => {
   it('should create a site', async () => {
     const teams = spyOnCollection('Teams', {
       countDocuments: jest.fn().mockReturnValue(Promise.resolve(1)),
-      findOne: jest.fn().mockReturnValue(Promise.resolve({orgId: 'organization-id'})),
+      findOne: jest.fn().mockReturnValue(Promise.resolve({ orgId: 'organization-id' })),
     });
     const members = spyOnCollection('Members', {
       countDocuments: jest.fn().mockReturnValue(Promise.resolve(1)),
@@ -43,7 +43,7 @@ describe('createSite', () => {
       .post('/api/v1/teams/team-id/sites')
       .set('Cookie', ['auth=testToken'])
       .send({
-        name: 'test-site'
+        name: 'test-site',
       });
 
 
@@ -79,19 +79,19 @@ describe('createSite', () => {
       .post('/api/v1/teams/team-id/sites')
       .set('Cookie', ['auth=testToken'])
       .send({
-        name: 'test-site'
+        name: 'test-site',
       });
 
 
     expect(response.status).toEqual(404);
-    expect(teams.countDocuments).toHaveBeenCalledWith({_id: 'team-id'}, expect.anything());
+    expect(teams.countDocuments).toHaveBeenCalledWith({ _id: 'team-id' }, expect.anything());
   });
 
 
   it('should check if the user can administrate the team', async () => {
     const teams = spyOnCollection('Teams', {
       countDocuments: jest.fn().mockReturnValue(Promise.resolve(1)),
-      findOne: jest.fn().mockReturnValue(Promise.resolve({orgId: 'organization-id'})),
+      findOne: jest.fn().mockReturnValue(Promise.resolve({ orgId: 'organization-id' })),
     });
     const isAdminOrOwner = spyOnIsAdminOrOwner(false);
 
@@ -100,7 +100,7 @@ describe('createSite', () => {
       .post('/api/v1/teams/team-id/sites')
       .set('Cookie', ['auth=testToken'])
       .send({
-        name: 'test-site'
+        name: 'test-site',
       });
 
 
@@ -112,7 +112,7 @@ describe('createSite', () => {
   it('should validate the site', async () => {
     const teams = spyOnCollection('Teams', {
       countDocuments: jest.fn().mockReturnValue(Promise.resolve(1)),
-      findOne: jest.fn().mockReturnValue(Promise.resolve({orgId: 'organization-id'})),
+      findOne: jest.fn().mockReturnValue(Promise.resolve({ orgId: 'organization-id' })),
     });
     const isAdminOrOwner = spyOnIsAdminOrOwner(true);
 
@@ -121,7 +121,7 @@ describe('createSite', () => {
       .post('/api/v1/teams/team-id/sites')
       .set('Cookie', ['auth=testToken'])
       .send({
-        name: 'invalid site name'
+        name: 'invalid site name',
       });
 
     expect(response.status).toEqual(400);

diff --git a/server/src/entities/teams/handlers/sites/list-team-sites.spec.ts b/server/src/entities/teams/handlers/sites/list-team-sites.spec.ts
@@ -2,7 +2,7 @@ import request from 'supertest';
 import { testServer } from '../../../../../tests/test-server';
 import { spyOnCollection } from '../../../../../tests/utils/spyon-collection';
 import { spyOnVerifyToken } from '../../../../../tests/utils/spyon-verifytoken';
-import { MeliServer } from '../../../../server';
+import { MeliServer } from '../../../../createServer';
 import * as _teamExistsGuard from '../../guards/team-exists-guard';
 import * as _canReadTeamGuard from '../../guards/can-read-team-guard';
 import * as _serializeSite from '../../../sites/serialize-site';

diff --git a/server/src/env/env-spec.ts b/server/src/env/env-spec.ts
@@ -272,4 +272,7 @@ export const envSpec: EnvSpec<Env> = {
   MELI_GOOGLE_RECAPTCHA_SECRET_KEY: {
     schema: string().optional(),
   },
+  MELI_POSTHOG_ENABLED: {
+    schema: boolean().optional().default(false),
+  },
 };
diff --git a/server/src/env/env.ts b/server/src/env/env.ts
@@ -73,6 +73,7 @@ export interface Env {
   MELI_MULTER_FORM_LIMITS: MulterLimitOptions;
   MELI_GOOGLE_RECAPTCHA_SITE_KEY: string;
   MELI_GOOGLE_RECAPTCHA_SECRET_KEY: string;
+  MELI_POSTHOG_ENABLED: boolean;
 }
 
 export const env: Env = parseEnv(envSpec);

diff --git a/server/src/index.ts b/server/src/index.ts
@@ -11,7 +11,7 @@ require('source-map-support/register');
 require('dotenv/config');
 require('./commons/force-chalk-colors');
 
-const { server } = require('./server');
+const { createServer } = require('./createServer');
 
 // eslint-disable-next-line no-console
-server().catch(console.error);
+createServer().catch(console.error);