adding email notification when deploying container

Totodore · Totodore · commit b48228bd78cc · 2021-01-10T22:16:58.000+01:00
diff --git a/Readme.md b/Readme.md
@@ -64,10 +64,10 @@ If you use Github or Dockerhub to send your webhooks you can protect them, it'll
 
 ## Mailing
 If you want to be notified when an error occurs when the container is redeployed you can add a mail
-|Name|Type|Description|
-|----|----|-----------|
-|`docker-ci.email`|`string (Optional)`|Set a specific user email to be notified only for this user when an error occurs|
-
+|Name|Description|
+|----|-----------|
+|`docker-ci.email`|Set a specific user email to be notified only for this user when an error occurs|
+|`docker-ci.email.notify`|Docker-ci will send email notification when container is redeployed|
 ## Example
 
 ### docker-compose.yml of docker-ci app
@@ -106,6 +106,9 @@ services:
       - "docker-ci.password=MyPasswordOrToken" #Registry Password or token 
       - "docker-ci.username=MyRegistryUsername"
       - "docker-ci.auth-server=MyRegistryURL" #Ex for Github Registry : https://ghcr.io or https://docker.pkg.github.com
+
+      - "docker-ci.email=prevottheodore@gmail.com" #Notify this email when errors occured when redeploying this container
+      - "docker-ci.email.notify=true" #Notify the above email when this container is redeployed
 ```
 
 ### docker-publish in the github repo :
@@ -168,12 +171,13 @@ jobs:
 ```
 
 ## All Labels :
-|Name|Type|Description|
-|----|----|-----------|
-| `docker-ci.enable`|`boolean`|Enable CI for this container, an endpoint will be created for this container and whenever it will be called the container image will be repulled and the container will be recreated (total update of the container)|
-| `docker-ci.repo-url`|`string`|Url of the image repo|
-| `docker-ci.name`|`string (Optional)`|Set a custom name for the endpoint, by default it is the name of the container|
-| `docker-ci.username`|`string (Optional)`|Set a username for the docker package registry auth|
-| `docker-ci.password`|`string (Optional)`|Set a password or a token for the docker package registry auth|
-| `docker-ci.auth-server`|`string (Optional)`|Set an auth server for the docker package registry auth|
-|`docker-ci.email`|`string (Optional)`|Set a specific user email to be notified only for this user when an error occurs|
+|Name|Description|
+|----|-----------|
+| `docker-ci.enable`|Enable CI for this container, an endpoint will be created for this container and whenever it will be called the container image will be repulled and the container will be recreated (total update of the container)|
+| `docker-ci.repo-url`|Url of the image repo|
+| `docker-ci.name`|Set a custom name for the endpoint, by default it is the name of the container|
+| `docker-ci.username`|Set a username for the docker package registry auth|
+| `docker-ci.password`|Set a password or a token for the docker package registry auth|
+| `docker-ci.auth-server`|Set an auth server for the docker package registry auth|
+|`docker-ci.email`|Set a specific user email to be notified only for this user when an error occurs|
+|`docker-ci.email.notify`|Notify the above email that the container has been updated|
diff --git a/src/docker.ts b/src/docker.ts
@@ -58,6 +58,9 @@ export class DockerManager {
   public async pruneImages(): Promise<void> {
     await this._docker.pruneImages();
   }
+  /**
+   * Get the combined length of all docker images
+   */
   public async getImageLength(): Promise<number> {
     return (await this._docker.listImages()).length;
   }
@@ -66,36 +69,31 @@ export class DockerManager {
    * Pull an image from its tag
    * @returns true in case of success
    */
-  public async pullImage(imageName: string, containerLabels: DockerCiLabels): Promise<boolean> {
-    try {
-      const imageInfos = await this.getImage(imageName).inspect();
-      this._logger.info("Pulling : ", ...imageInfos.RepoTags);
-      let authConf: DockerImagesModel.PullImageAuth | undefined;
-      if (containerLabels["docker-ci.username"] && containerLabels["docker-ci.password"] && containerLabels["docker-ci.auth-server"]) {
-        authConf = {
-          username: containerLabels["docker-ci.username"],
-          password: containerLabels["docker-ci.password"],
-          serveraddress: containerLabels["docker-ci.auth-server"]
-        }
+  public async pullImage(imageName: string, containerLabels: DockerCiLabels) {
+    const imageInfos = await this.getImage(imageName).inspect();
+    this._logger.info("Pulling : ", ...imageInfos.RepoTags);
+    let authConf: DockerImagesModel.PullImageAuth | undefined;
+    if (containerLabels["docker-ci.username"] && containerLabels["docker-ci.password"] && containerLabels["docker-ci.auth-server"]) {
+      authConf = {
+        username: containerLabels["docker-ci.username"],
+        password: containerLabels["docker-ci.password"],
+        serveraddress: containerLabels["docker-ci.auth-server"]
       }
-      let data: any[] = [];
-      for(const tag of imageInfos.RepoTags)
-        data.push(await this._docker.pull(tag, authConf && { authconfig: authConf }));
-      const message: IncomingMessage = data[0];
-      message?.on("data", (data) => {
-        try {
-          this._logger.log(JSON.parse(data));
-        } catch (e) {
-          this._logger.log(data.toString())
-        }
-      });
-      return new Promise<boolean>((resolve, reject) => {
-        message?.on("end", () => resolve(true)) || resolve(true); 
-      });
-    } catch (e) {
-      this._logger.error("Error pulling image", e);
-      return false;
     }
+    let data: any[] = [];
+    for(const tag of imageInfos.RepoTags)
+      data.push(await this._docker.pull(tag, authConf && { authconfig: authConf }));
+    const message: IncomingMessage = data[0];
+    message?.on("data", (data) => {
+      try {
+        this._logger.log(JSON.parse(data));
+      } catch (e) {
+        this._logger.log(data.toString())
+      }
+    });
+    return new Promise<boolean>((resolve, reject) => {
+      message?.on("end", () => resolve(true)) || resolve(true); 
+    });
   }
 
   /**
diff --git a/src/index.ts b/src/index.ts
@@ -93,13 +93,22 @@ class App {
    */
   private async _onUrlTriggered(id: string) {
     let containerInfos: ContainerInspectInfo;
-    const previousImageLength = await this._dockerManager.getImageLength();
+    let previousImageLength: number;
+    let labels: DockerCiLabels;
     try {
-      containerInfos = await this._dockerManager.getContainer(id).inspect();
-      if (!await this._dockerManager.pullImage(containerInfos.Image, containerInfos.Config.Labels))
-        throw "Error Pulling Image";
-      if (previousImageLength < await this._dockerManager.getImageLength())
+      previousImageLength = await this._dockerManager.getImageLength();
+      containerInfos = await this._dockerManager.getContainer(id).inspect();  
+      labels = containerInfos?.Config?.Labels;
+    } catch (e) {
+      this._sendErrorMail(null, "Impossible to get container infos " + id);
+      return;
+    }
+    try {
+      await this._dockerManager.pullImage(containerInfos.Image, containerInfos.Config.Labels);
+      if (previousImageLength < await this._dockerManager.getImageLength()) {
         await this._dockerManager.recreateContainer(id, containerInfos.Image);
+        labels?.['docker-ci.email.notify'] && this._mailer.sendNotifyMail(id, labels?.['docker-ci.email']);
+      }
       else
         this._logger.info("Image already updated, no container restart needed");
     } catch (e) {
@@ -113,7 +122,7 @@ class App {
     }
   }
 
-  private async _sendErrorMail(infos: ContainerInspectInfo, error: string) {
+  private async _sendErrorMail(infos: ContainerInspectInfo | null, error: string) {
     try {
       const labels: DockerCiLabels = infos?.Config?.Labels;
       if (labels?.['docker-ci.email']?.includes("@"))
diff --git a/src/models/docker-ci-labels.model.ts b/src/models/docker-ci-labels.model.ts
@@ -4,6 +4,7 @@ export interface DockerCiLabels {
   "docker-ci.repo-url"?: string;
   
   "docker-ci.email"?: string;
+  "docker-ci.email.notify"?: boolean;
 
   "docker-ci.password"?: string;
   "docker-ci.username"?: string;
diff --git a/src/utils/mailer.ts b/src/utils/mailer.ts
@@ -37,29 +37,44 @@ class MailerManager {
     return this;
   }
   
-  public async sendErrorMail(container: string, mailDest: string, ...error: any[]) {
+  public async sendErrorMail(container: string, mailDest?: string, ...error: any[]) {
     if (!this._healthy)
       this._logger.log("No email sent, email system disabled from conf");
     else 
       this._logger.log("Sending error email to :", mailDest, mailConf.mail_admin);
-    
-    await this._transporter.sendMail({
-      from: mailConf.mail_addr,
-      to: mailConf.mail_admin,
-      subject: `Erreur lors du déploiement de : ${container.substr(1)}`,
-      html: `
-        <h1 style='text-align: center'>Logs : </h1>
-        <p>${error.join(" ")}</p>
-      `
-    }).catch(e => this._logger.info("Error sending error mail"));
-
-    if (mailDest) {
+    try {
       await this._transporter.sendMail({
         from: mailConf.mail_addr,
-        to: mailDest,
+        to: mailConf.mail_admin,
         subject: `Erreur lors du déploiement de : ${container.substr(1)}`,
-        html: "Les administrateurs de ce serveur ont été notifiés",
-      }).catch(e => this._logger.info("Error sending error mail"));
+        html: `
+          <h1 style='text-align: center'>Logs : </h1>
+          <p>${error.join(" ")}</p>
+        `
+      });
+      if (mailDest)
+        await this._transporter.sendMail({
+          from: mailConf.mail_addr,
+          to: mailDest,
+          subject: `Erreur lors du déploiement de : ${container.substr(1)}`,
+          html: "Les administrateurs de ce serveur ont été notifiés",
+        });
+    } catch (e) {
+      this._logger.error("Error sending error mail", e)
+    }
+  }
+
+  public async sendNotifyMail(container: string, mailDest: string) {
+    try {
+      const date = new Date();
+      await this._transporter.sendMail({
+        from: mailConf.mail_addr,
+        to: mailConf.mail_admin,
+        subject: `Ton projet : ${container.substr(1)} s'est déployé avec succès !`,
+        html: `Ton projet : ${container.substr(1)} s'est déployé avec succès à ${date.getHours()}:${date.getMinutes()} le ${date.getDate()}/${date.getMonth()}/${date.getFullYear()} !`
+      });
+    } catch (e) {
+      this._logger.error("Error sending error mail", e)
     }
   }
 }
