Merge branch 'email_templates' of https://github.com/hackmcgill/hackerAPI into feature/180-email_templates

krubenok · krubenok · commit cddd7fb4c9b6 · 2018-12-02T19:59:21.000-05:00
diff --git a/.env.example b/.env.example
@@ -3,6 +3,10 @@ PORT=<Some Port such as 3000>
 #The address on which the server is being run:
 ADDRESS=<Some address such as 127.0.0.1>
 
+#front-end server
+FRONTEND_ADDRESS_DEV=localhost:1337
+FRONTEND_ADDRESS_DEPLOY=app.mchacks.ca
+
 #The info for the deployment database
 DB_ADDRESS_DEPLOY=<Deployment address>
 DB_USER_DEPLOY=<username for db connection>
diff --git a/.gitignore b/.gitignore
@@ -63,4 +63,8 @@ gcp_creds.json
 
 #certbot 
 certbot/
+
 assets/.DS_Store
+
+#secrets
+secret.yaml
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -4,5 +4,6 @@
         "node":true,
         "this":false,
         "bad_property":false
-    }
+    },
+    "search.usePCRE2": true
 }
diff --git a/Dockerfile b/Dockerfile
@@ -7,6 +7,9 @@ WORKDIR /usr/src/app
 COPY package*.json ./
 ADD VERSION .
 
+RUN npm install -g n
+RUN n 9.9.0
+RUN npm install npm -g
 RUN npm install
 
 COPY . .
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,38 @@
+# Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+# How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+
+- [ ] Test A
+- [ ] Test B
+
+**Test Configuration**:
+* Firmware version:
+* Hardware:
+* Toolchain:
+* SDK:
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.1.1
+1.0.3
diff --git a/app.js b/app.js
@@ -35,10 +35,16 @@ Services.db.connect(app);
 let corsOptions = {};
 
 if (!Services.env.isProduction()) {
-    corsOptions = { origin: ["http://localhost:1337", "http://localhost:8989"], credentials: true };
+    corsOptions = {
+        origin: [process.env.FRONTEND_ADDRESS_DEV],
+        credentials: true
+    };
 } else {
     // TODO: change this when necessary
-    corsOptions = { origin: ["https://mchacks.ca/"], credentials: true };
+    corsOptions = {
+        origin: [process.env.FRONTEND_ADDRESS_DEPLOY],
+        credentials: true
+    };
 }
 
 app.use(cors(corsOptions));
@@ -79,6 +85,7 @@ searchRouter.activate(apiRouter);
 Services.log.info("Search router activated");
 
 apiRouter.use("/", indexRouter);
+app.use("/", indexRouter);
 
 app.use("/api", apiRouter);
 
diff --git a/assets/email/AccountInvitation.hbs b/assets/email/AccountInvitation.hbs
@@ -439,4 +439,4 @@
     </center>
     </body>
 
-</html>
+</html>
diff --git a/deployment.yaml b/deployment.yaml
@@ -0,0 +1,24 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: hackboard
+spec:
+  selector:
+    matchLabels:
+      run: hackboard
+  replicas: 1
+  template:
+    metadata:
+      labels:
+        run: hackboard
+    spec:
+      volumes:
+      - name: secret-volume
+        secret:
+          secretName: hackboard-secret
+      containers:
+      - name: hackboard
+        image: gcr.io/mchacks-api/hackboard:1.0.2
+        ports:
+        # - containerPort: 443
+        - containerPort: 8080
diff --git a/ingress.yaml b/ingress.yaml
@@ -0,0 +1,16 @@
+apiVersion: extensions/v1beta1
+kind: Ingress
+metadata:
+  name: hackboard-ingress
+  annotations:
+    kubernetes.io/ingress.global-static-ip-name: hackboard-ingress-static-ip
+spec:
+  # tls:
+  # - secretName: hackboard-secret
+  # rules:
+  # - http:
+  #     paths:
+  #     - path: /*
+  backend:
+    serviceName: hackboard-service
+    servicePort: 80
diff --git a/middlewares/account.middleware.js b/middlewares/account.middleware.js
@@ -7,7 +7,8 @@ const Services = {
     Logger: require("../services/logger.service"),
     Account: require("../services/account.service"),
     AccountConfirmation: require("../services/accountConfirmation.service"),
-    Email: require("../services/email.service")
+    Email: require("../services/email.service"),
+    Env: require("../services/env.service")
 };
 
 const Middleware = {
@@ -149,8 +150,9 @@ async function inviteAccount(req, res, next) {
     const accountType = req.body.accountType;
     const confirmationObj = await Services.AccountConfirmation.create(accountType, email);
     const confirmationToken = Services.AccountConfirmation.generateToken(confirmationObj.id);
+    const address = Services.Env.isProduction() ? process.env.FRONTEND_ADDRESS_DEPLOY : process.env.FRONTEND_ADDRESS_DEV;
 
-    const mailData = Services.AccountConfirmation.generateAccountInvitationEmail(req.hostname, email, accountType, confirmationToken);
+    const mailData = Services.AccountConfirmation.generateAccountInvitationEmail(address, email, accountType, confirmationToken);
     if (mailData !== undefined) {
         Services.Email.send(mailData, (err) => {
             if (err) {
diff --git a/middlewares/auth.middleware.js b/middlewares/auth.middleware.js
@@ -9,7 +9,8 @@ const Services = {
     Email: require("../services/email.service"),
     AccountConfirmation: require("../services/accountConfirmation.service"),
     Role: require("../services/role.service"),
-    RoleBinding: require("../services/roleBinding.service")
+    RoleBinding: require("../services/roleBinding.service"),
+    Env: require("../services/env.service")
 };
 
 const Middleware = {
@@ -140,7 +141,8 @@ async function sendResetPasswordEmailMiddleware(req, res, next) {
         const ResetPasswordTokenModel = await Services.ResetPasswordToken.findByAccountId(user.id);
         //generate email
         const token = Services.ResetPasswordToken.generateToken(ResetPasswordTokenModel.id, user.id);
-        const mailData = Services.ResetPasswordToken.generateResetPasswordEmail(req.hostname, req.body.email, token);
+        const address = Services.Env.isProduction() ? process.env.FRONTEND_ADDRESS_DEPLOY : process.env.FRONTEND_ADDRESS_DEV;
+        const mailData = Services.ResetPasswordToken.generateResetPasswordEmail(address, req.body.email, token);
         if (mailData !== undefined) {
             Services.Email.send(mailData, (err) => {
                 if (err) {
@@ -176,7 +178,8 @@ async function sendConfirmAccountEmailMiddleware(req, res, next) {
     await Services.AccountConfirmation.create(Constants.General.HACKER, account.email, account.id);
     const accountConfirmationToken = await Services.AccountConfirmation.findByAccountId(account.id);
     const token = Services.AccountConfirmation.generateToken(accountConfirmationToken.id, account.id);
-    const mailData = Services.AccountConfirmation.generateAccountConfirmationEmail(req.hostname, account.email, Constants.General.HACKER, token);
+    const address = Services.Env.isProduction() ? process.env.FRONTEND_ADDRESS_DEPLOY : process.env.FRONTEND_ADDRESS_DEV;
+    const mailData = Services.AccountConfirmation.generateAccountConfirmationEmail(address, account.email, Constants.General.HACKER, token);
     if (mailData !== undefined) {
         Services.Email.send(mailData, (err) => {
             if (err) {
@@ -214,7 +217,8 @@ async function resendConfirmAccountEmail(req, res, next) {
         });
     }
     const token = Services.AccountConfirmation.generateToken(accountConfirmationToken.id, account.id);
-    const mailData = Services.AccountConfirmation.generateAccountConfirmationEmail(req.hostname, account.email, accountConfirmationToken.accountType, token);
+    const address = Services.Env.isProduction() ? process.env.FRONTEND_ADDRESS_DEPLOY : process.env.FRONTEND_ADDRESS_DEV;
+    const mailData = Services.AccountConfirmation.generateAccountConfirmationEmail(address, account.email, accountConfirmationToken.accountType, token);
     if (mailData !== undefined) {
         Services.Email.send(mailData, (err) => {
             if (err) {
diff --git a/service.yaml b/service.yaml
@@ -0,0 +1,23 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: hackboard-service
+  labels:
+    run: hackboard # because that's the label on the deployment (not sure what labels do tho)
+  # annotations:
+  #   cloud.google.com/app-protocols: '{"hackboard-https-port":"HTTPS","hackboard-http-port":"HTTP"}'
+spec:
+  selector: 
+    run: hackboard # because that's the selector on the deployment (not sure what labels do tho)
+  ports:
+    - name: http #hackboard-http-port
+      protocol: TCP
+      port: 80
+      targetPort: 8080 # because the deployment port is 80/TCP
+    # - name: hackboard-https-port
+    #   protocol: TCP
+    #   port: 443
+  type: LoadBalancer
+
+# endpoint of service same as ip of pods -> means communication between service and pod (direction?)
+# can talk to this service with cluster-ip:port from any other node on cluster
diff --git a/services/accountConfirmation.service.js b/services/accountConfirmation.service.js
@@ -95,21 +95,20 @@ function generateConfirmTokenLink(httpOrHttps, domain, type, token) {
 /**
  * Generates the mailData for the account confirmation Email. This really only applies to
  * hackers as all other accounts are intrinsically confirmed via the email they recieve to invite them
- * @param {string} hostname The hostname that this service is running on
+ * @param {string} address The hostname that this service is running on
  * @param {string} receiverEmail The receiver of the email
  * @param {string} type the user type
  * @param {string} token The account confirmation token
  */
-function generateAccountConfirmationEmail(hostname, receiverEmail, type, token) {
-    const httpOrHttps = (hostname === "localhost") ? "http" : "https";
-    const address = (hostname === "localhost") ? `localhost:${process.env.PORT}` : hostname;
+function generateAccountConfirmationEmail(address, receiverEmail, type, token) {
+    const httpOrHttps = (address.includes("localhost")) ? "http" : "https";
     const tokenLink = generateConfirmTokenLink(httpOrHttps, address, type, token);
     var emailSubject = "";
     if (token === undefined || tokenLink === undefined) {
         return undefined;
     }
     if (type === Constants.HACKER) {
-        emailSubject = Constants.CONFIRM_ACC_EMAIL_SUBJECT
+        emailSubject = Constants.CONFIRM_ACC_EMAIL_SUBJECT;
     }
     const handlebarPath = path.join(__dirname, `../assets/email/AccountConfirmation.hbs`);
 
@@ -125,30 +124,26 @@ function generateAccountConfirmationEmail(hostname, receiverEmail, type, token)
 }
 
 /*
-* Generates the mailData for the account invitation Email.
-* @param {string} hostname The hostname that this service is running on
-* @param {string} receiverEmail The receiver of the email
-* @param {string} type The user type
-* @param {string} token The account confirmation token
+ * Generates the mailData for the account invitation Email.
+ * @param {string} address The hostname that this service is running on
+ * @param {string} receiverEmail The receiver of the email
+ * @param {string} type The user type
+ * @param {string} token The account confirmation token
  */
-function generateAccountInvitationEmail(hostname, receiverEmail, type, token) {
-    const httpOrHttps = (hostname === "localhost") ? "http" : "https";
-    const address = (hostname === "localhost") ? `localhost:${process.env.PORT}` : hostname;
+function generateAccountInvitationEmail(address, receiverEmail, type, token) {
+    const httpOrHttps = (address.includes("localhost")) ? "http" : "https";
     const tokenLink = generateCreateAccountTokenLink(httpOrHttps, address, type, token);
     var emailSubject = "";
     if (token === undefined || tokenLink === undefined) {
         return undefined;
     }
     if (type === Constants.HACKER) {
         emailSubject = Constants.CREATE_ACC_EMAIL_SUBJECTS[Constants.HACKER];
-    }
-    else if(type === Constants.VOLUNTEER){
+    } else if (type === Constants.VOLUNTEER) {
         emailSubject = Constants.CREATE_ACC_EMAIL_SUBJECTS[Constants.VOLUNTEER];
-    }
-    else if(Constants.SPONSOR_TIERS.includes(type)){
+    } else if (Constants.SPONSOR_TIERS.includes(type)) {
         emailSubject = Constants.CREATE_ACC_EMAIL_SUBJECTS[Constants.SPONSOR];
-    }
-    else if(type === Constants.STAFF){
+    } else if (type === Constants.STAFF) {
         emailSubject = Constants.CREATE_ACC_EMAIL_SUBJECTS[Constants.STAFF];
     }
     const handlebarPath = path.join(__dirname, `../assets/email/AccountInvitation.hbs`);
diff --git a/services/resetPassword.service.js b/services/resetPassword.service.js
@@ -87,13 +87,12 @@ function generateTokenLink(httpOrHttps, domain, token) {
 
 /**
  * Generates the mailData for the resetPassword Email.
- * @param {string} hostname The hostname that this service is running on
+ * @param {string} address The web address that the front-end service is running on
  * @param {string} receiverEmail The receiver of the email
  * @param {string} token The resetPassword token
  */
-function generateResetPasswordEmail(hostname, receiverEmail, token) {
-    const httpOrHttps = (hostname === "localhost") ? "http" : "https";
-    const address = (hostname === "localhost") ? `localhost:${process.env.PORT}` : hostname;
+function generateResetPasswordEmail(address, receiverEmail, token) {
+    const httpOrHttps = (address.includes("localhost")) ? "http" : "https";
     const tokenLink = generateTokenLink(httpOrHttps, address, token);
     if (token === undefined || tokenLink === undefined) {
         return undefined;
diff --git a/tests/email.service.spec.js b/tests/email.service.spec.js
@@ -47,9 +47,10 @@ describe("Email Service", function () {
     it("It should compile a handlebars email", (done) => {
         const handlebarPath = path.join(__dirname, `../assets/email/test.hbs`);
         const rendered = EmailService.renderEmail(handlebarPath, {
-            TEST: "TESTTEST"
+            TEST: "TESTTEST",
+            NOT_ESCAPED: "localhost:1337/reset?token=lala"
         });
-        assert.equal("<div>This is used for testing email service. DO NOT REMOVE.TESTTEST</div>", rendered);
+        assert.equal('<div>This is used for testing email service. DO NOT REMOVE.TESTTEST. <a href="localhost:1337/reset?token=lala">link</a></div>', rendered);
         done();
     });
 });

Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,6 @@`
`4`	`4`	`"node":true,`
`5`	`5`	`"this":false,`
`6`	`6`	`"bad_property":false`
`7`		`- }`
	`7`	`+ },`
	`8`	`+ "search.usePCRE2": true`
`8`	`9`	`}`
-Original file line number
+Diff line change
     </center>
     </body>
 -</html>
 +</html>