v0.21.2

WIP: Develop

Dockerfile

@@ -1,12 +1,12 @@
-FROM node:12.5.0-alpine as node
+FROM node:12.6.0-alpine as node
 RUN mkdir -p /src/app
 WORKDIR /src/app
 COPY package.json /src/app/package.json
 RUN npm install
 COPY . /src/app
 RUN npm run build
 
-FROM node:12.5.0-alpine
+FROM node:12.6.0-alpine
 RUN mkdir -p /app
 COPY package.json /app/package.json
 WORKDIR /app

README.md

@@ -6,13 +6,22 @@
 ![GitHub release](https://img.shields.io/github/release/dx-developerexperience/hygie.svg)
 ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/dx-developerexperience/hygie.svg)
 [![Website](https://img.shields.io/website/https/dx-developerexperience.github.io/hygie.svg)](https://dx-developerexperience.github.io/hygie/)
+[![Discord](https://img.shields.io/badge/discord-online-brightgreen.svg)](https://discord.gg/w5AE8vS)
 
 ## Motivation
 
 **_Hygie_** is an easy-to-use Open-Source REST API allowing you to interact with GIT events.
 
 This [NestJs](https://docs.nestjs.com/) API expose a set of customizable Rules to automate your project's life cycle.
 
+## Quick Getting Started
+
+To use our solution, just [register your application](https://dx-developerexperience.github.io/hygie/guide/registerToken.html): this will create a _webhook_ in your repository and an `Connected to Hygie!` issue, to ensure that everything worked fine.
+
+You can now create your configuration file to fit your needs, or continue working on your project without any changes and using our default configuration file, with our _good practices_.
+
+For more informations, read the [Getting Started section](https://dx-developerexperience.github.io/hygie/guide/gettingStarted.html).
+
 ## Documentation
 
 Check-out our [documentation website](https://dx-developerexperience.github.io/hygie/) for more informations.

docs/post-actions/customisablePostActions.md

@@ -50,9 +50,9 @@ constructor(private readonly myService: MyService)
 
 NestJs dependency injection will handle everything.
 
-### _mustache_ templating
+### _handlebars_ templating
 
-If you want to allow templating (you want to!), you need to use the `render()` method provide by _mustache_.
+If you want to allow templating (you want to!), you need to use the `render()` method provide by our _Utils_ class.
 
 Just have a look at the `LoggerRunnable` implementation:
 
@@ -69,4 +69,4 @@ run(ruleResult: RuleResult, args: LoggerArgs): void {
 }
 ```
 
-The `render()` method need the string containing the template (in the `args` object), and the data provider: `RuleResult` which is the return by the [`validate()` rule method](../rules/customisableRules.html#validate-method).
+The `render()` method need the string containing the template (in the `args` object), and the data provider: `RuleResult` which is the return by the [`validate()` rule method](../rules/customisableRules.md#validate-method).

docs/post-actions/existingRunnables.md

@@ -16,7 +16,7 @@ Be sure that the rule returned the `issueNumber` property in the `RuleResult` ob
 
 ### Usage
 
-This Post-Action only needs a string message. This string can contain _mustache_ templating.
+This Post-Action only needs a string message. This string can contain _handlebars_ templating.
 
 To use the `CommentIssueRunnable`, add the `callback` on your `.rulesrc` config file.
 
@@ -40,7 +40,7 @@ Be sure that the rule returned the `pullRequest.number` property in the `RuleRes
 
 ### Usage
 
-This Post-Action only needs a string message. This string can contain _mustache_ templating.
+This Post-Action only needs a string message. This string can contain _handlebars_ templating.
 
 To use the `CommentPullRequestRunnable`, add the `callback` on your `.rulesrc` config file.
 
@@ -188,7 +188,7 @@ This Post-Action need two args:
   ::: tip
   If you're in an `onSuccess` or `onBoth` statement, the default value will be `info`. On the other hand, if you're in an `onError` statement, it would be `error`.
   :::
-- `message`: a string that can contain _mustache_ templating.
+- `message`: a string that can contain _handlebars_ templating.
 
 To use the `LoggerRunnable`, simply add the `callback` on your `.rulesrc` config file.
 
@@ -389,7 +389,7 @@ This Post-Action need the following args:
 - `data`: the data you want to send (`any` type) _[optional]_,
 - `config`: the `AxiosRequestConfig` configuration _[optional]_.
 
-All of these parameters can contain _mustache_ templating.
+All of these parameters can contain _handlebars_ templating.
 
 To use the `WebhookRunnable`, simply add the `callback` on your `.rulesrc` config file.
 

docs/rules/customisableRules.md

@@ -44,39 +44,36 @@ The following properties are all needed :
 These `callback`s are called sequentially and do not return value (`void` type).
 :::
 
-### Templating with _mustache_
+### Templating with _handlebars_
 
-Post-actions `args` support templating: **_Hygie_** use [mustache js](https://github.com/janl/mustache.js).
+Post-actions `args` support templating: **_Hygie_** use [handlebars js](https://handlebarsjs.com).
 
 Consequently, you can inject data processed by the `validate()` method of the current rule (`name` attribute). You can see the [`validate()` method section](#validate-method) for more informations.
 
 For example, you can iterate over the `data.commits` array of `CommitMessageRule`, and display the commit's `sha` and the differents groups captured by the `regexp` options.
 
-```
-'{{#data.commits}}{{sha}} =
-Object: {{matches.1}} | Scope: {{matches.2}} | Issue: {{matches.3}}
-{{/data.commits}}'
-```
-
 You can also access the environment variables you've configured via the `env` prefix. More informations in the [Enviroment Variable section](./guide/useEnvVar.md).
 
-For examples:
-
-```
-callback: WebhookRunnable
-args:
-  url: 'https://webhook.site/0123-4567-89ab-cdef'
-  config: {
-    token: '{{env.API_KEY}}'
-  }
-  data: {
-    user: 'cron bot',
-    number: '{{data.number}}',
-    vulnerabilities: '{{{data.vulnerabilities}}}'
-  }
+```yaml
+onSuccess:
+  - callback: WebhookRunnable
+    args:
+      url: https://discordapp.com/api/webhooks/{{env.DISCORD_ISSUE_WEBHOOK}}/{{env.DISCORD_ISSUE_TOKEN}}
+      data: '{
+        "embeds": [
+          {{#foreach data.commits}}
+          {
+            "title": "Commit #{{sha}} = Object: {{matches.[1]}} | Scope: {{matches.[2]}} | Issue: {{matches.[3]}}",
+            "color": 1127128
+          }
+          {{/foreach}}
+        ]
+      }'
 ```
 
-For more examples, check out the [documentation](https://github.com/janl/mustache.js#templates) provide by mustache.
+::: tip
+The `foreach` keyword has been add to solve the trailing-comma's problem. When you use it, it will add a comma at the end of the pattern, except for the last one element of the array.
+:::
 
 ## Create your own rule
 
@@ -103,23 +100,27 @@ Each Rule, have a `validate()` method as follows:
 export class MyCustomRule extends Rule {
   // ...
 
-  validate(webhook: Webhook, ruleConfig: PullRequestTitleRule): RuleResult {
-    const ruleResult: RuleResult = new RuleResult(webhook.getGitApiInfos());
+  async validate(
+    webhook: Webhook,
+    ruleConfig: MyCustomRule,
+    ruleResults?: RuleResult[],
+  ): Promise<RuleResult> {
+    const ruleResult: RuleResult = new RuleResult(
+      webhook.getGitApiInfos(),
+      webhook.getCloneURL(),
+    );
+    this.googleAnalytics
+      .event('Rule', 'myCustom', webhook.getCloneURL())
+      .send();
+
+    // BUSINESS LOGIC
 
-    /**
-     * Your process
-     *
-     * You can call gitApi via `this.webhook.gitService`
-     **/
-
-    // Optional
-    // If you want to export data for callbacks, accessible with {{data}}
+    ruleResult.validated = true | false;
     ruleResult.data = {
       myData: 'this is some data',
       myArray: ['val1', 'val2', 'val3'],
     };
-    ruleResult.validated = true | false;
-    return ruleResult;
+    return Promise.resolve(ruleResult);
   }
 }
 ```

package.json

@@ -35,12 +35,12 @@
   "dependencies": {
     "@dxdeveloperexperience/hygie-database": "0.4.2",
     "@dxdeveloperexperience/nest-schedule": "0.4.6",
-    "@nestjs/common": "6.4.1",
-    "@nestjs/core": "6.4.1",
-    "@nestjs/microservices": "6.4.1",
-    "@nestjs/platform-express": "6.4.1",
-    "@nestjs/testing": "6.4.1",
-    "@nestjs/websockets": "6.4.1",
+    "@nestjs/common": "6.5.2",
+    "@nestjs/core": "6.5.2",
+    "@nestjs/microservices": "6.5.2",
+    "@nestjs/platform-express": "6.5.2",
+    "@nestjs/testing": "6.5.2",
+    "@nestjs/websockets": "6.5.2",
     "array-flat-polyfill": "1.0.1",
     "class-transformer": "0.2.3",
     "crypto-js": "3.1.9-1",
@@ -52,7 +52,6 @@
     "googleapis": "27.0.0",
     "hbs": "4.0.4",
     "js-yaml": "3.13.1",
-    "mustache": "3.0.1",
     "prom-client": "11.5.3",
     "reflect-metadata": "0.1.13",
     "rimraf": "2.6.3",
@@ -84,7 +83,7 @@
     "tsconfig-paths": "3.8.0",
     "tslint": "5.18.0",
     "typedoc": "0.14.2",
-    "typescript": "3.5.2",
+    "typescript": "3.5.3",
     "vuepress": "1.0.1",
     "vuetify": "1.5.16"
   },

src/controllers/webhook.controller.ts

@@ -51,6 +51,11 @@ export class WebhookController {
     ) {
       throw new PreconditionException();
     } else {
+      logger.info(
+        `=== ${webhook.getGitType()} - ${webhook.getGitEvent()} ===`,
+        { project: webhook.getCloneURL(), location: 'processWebhook' },
+      );
+
       const defaultBranch: string = webhook.getDefaultBranchName();
       let rulesBranch: string = defaultBranch;
       if (GitEventEnum.Push === webhook.getGitEvent()) {
@@ -103,11 +108,6 @@ export class WebhookController {
       // Set Envs Var
       await this.envVarService.setEnvs(remoteEnvs);
 
-      logger.info(
-        `=== ${webhook.getGitType()} - ${webhook.getGitEvent()} ===`,
-        { project: webhook.getCloneURL(), location: 'processWebhook' },
-      );
-
       // Process incoming cron files
       this.scheduleService.processCronFiles(webhook);
 

src/data_access/dataAccess.service.ts

@@ -97,6 +97,14 @@ export class DataAccessService {
     return this.dataProvider.checkIfExist(SourceEnum.Rules, path);
   }
 
+  /**
+   * Check if EnvVar object already exist
+   * @param path path location (file system)/key (database)/etc
+   */
+  checkIfEnvVarExist(path: string): Promise<boolean> {
+    return this.dataProvider.checkIfExist(SourceEnum.EnvsVar, path);
+  }
+
   /**
    * Connection with the dataProvider
    */

src/env-var/env-var.service.ts

@@ -46,11 +46,13 @@ export class EnvVarService {
   async setEnvs(repositoryName: string) {
     const path: string = `remote_envs_vars/${repositoryName}/env.yml`;
     try {
-      const data: KeyValueEnvFileInterface = await this.dataAccessService.readEnvsVar(
-        path,
-      );
-      const decryptedEnv = this.decryptData(data);
-      this.envVarAccessor.setAllEnvVar(decryptedEnv);
+      if (await this.dataAccessService.checkIfEnvVarExist(path)) {
+        const data: KeyValueEnvFileInterface = await this.dataAccessService.readEnvsVar(
+          path,
+        );
+        const decryptedEnv = this.decryptData(data);
+        this.envVarAccessor.setAllEnvVar(decryptedEnv);
+      }
     } catch (e) {
       logger.error(e, { location: 'setEnvs', project: repositoryName });
     }