3.0.3

.gitlab-ci.yml

@@ -38,13 +38,25 @@ snyk:
 # test stage
 # ====================
 
-testLTS:
+testStable:
+  stage: test
+  script:
+  - npmci npm prepare
+  - npmci node install stable
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+  - docker
+  - priv
+
+testBuild:
   stage: test
   script:
   - npmci npm prepare
   - npmci node install lts
   - npmci npm install
-  - npmci npm test
+  - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
@@ -86,7 +98,9 @@ trigger:
   - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:stable-dind
   stage: metadata
   script:
     - npmci command npm install -g @gitzone/tsdoc

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojoio/slack",
-  "version": "2.0.7",
+  "version": "3.0.3",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -233,9 +233,9 @@
       "dev": true
     },
     "@pushrocks/smartpromise": {
-      "version": "3.0.2",
-      "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartpromise/-/smartpromise-3.0.2.tgz",
-      "integrity": "sha512-jmrJMUEmBCWChWK8CIcx4Vw3wv/8OgVNmkaxJrbs+WMaoRUfJtpWWJfrAwwHWt9ZXJbarJ+CwfwfYiiZXymndQ=="
+      "version": "3.0.5",
+      "resolved": "https://verdaccio.lossless.one/@pushrocks%2fsmartpromise/-/smartpromise-3.0.5.tgz",
+      "integrity": "sha512-9kHBWyDFjQ6cV1rseOfge02EH6huh/mrtqxlFoJoxnMaGWf5F8H3UEsskBBUGI6QKE1Bl8evr74AIKWwJ0r/bA=="
     },
     "@pushrocks/smartrequest": {
       "version": "1.1.23",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojoio/slack",
-  "version": "2.0.7",
+  "version": "3.0.3",
   "private": false,
   "description": "slack api abstraction for the mojo.io ecosystem",
   "main": "dist/index.js",
@@ -20,6 +20,7 @@
     "@types/node": "^12.7.4"
   },
   "dependencies": {
+    "@pushrocks/smartpromise": "^3.0.5",
     "@pushrocks/smartrequest": "^1.1.23"
   },
   "files": [
@@ -27,6 +28,7 @@
     "ts_web/*",
     "dist/*",
     "dist_web/*",
+    "dist_ts_web/*",
     "assets/*",
     "cli.js",
     "npmextra.json",

readme.md

@@ -101,6 +101,6 @@ mySlackMessage.sendToRoom('anotherroom')
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://mojoio.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -5,15 +5,15 @@ let testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit');
 
 import * as slackme from '../ts/index';
 
-let testSlackme: slackme.Slackme;
+let testSlackAccount: slackme.SlackAccount;
 let testSlackMessage: slackme.SlackMessage;
 
-tap.test('should create a valid slackme instance', async () => {
-  testSlackme = new slackme.Slackme(testQenv.getEnvVarOnDemand('SLACK_TOKEN'));
+tap.test('should create a valid slackme instance', async (tools) => {
+  testSlackAccount = new slackme.SlackAccount(testQenv.getEnvVarOnDemand('SLACK_TOKEN'));
 });
 
-tap.test('should send a message to Slack', async () => {
-  testSlackMessage = new slackme.SlackMessage({
+tap.test('should send a message to Slack', async (tools) => {
+  const messageOptions = {
     author_name: 'GitLab CI',
     author_link: 'https://gitlab.com/',
     pretext: '*Good News*: Build successfull!',
@@ -29,15 +29,40 @@ tap.test('should send a message to Slack', async () => {
         value: 'pushrocks',
         short: true
       }
-    ],
-    ts: new Date().getTime() / 1000
+    ]
+  };
+  await testSlackAccount.sendMessage({
+    channelArg: 'random',
+    messageOptions: messageOptions,
+    mode: 'new'
   });
-  await testSlackme.sendMessage(testSlackMessage.messageOptions, 'random');
-  await expect(testSlackMessage.sendToRoom('random')).to.eventually.be.rejected;
 });
 
-tap.test('should send a message to Slack by directly calling the message', async () => {
-  testSlackMessage = new slackme.SlackMessage({
+tap.test('should send a message to Slack by directly calling the message', async (tools) => {
+  testSlackMessage = new slackme.SlackMessage(
+    testSlackAccount,
+    {
+      author_name: 'GitLab CI',
+      author_link: 'https://gitlab.com/',
+      pretext: '*Good News*: Build successfull!',
+      color: '#3cb371',
+      fields: [
+        {
+          title: 'Branch',
+          value: 'Lossless Cloud',
+          short: true
+        },
+        {
+          title: 'Product ID',
+          value: 'pushrocks',
+          short: true
+        }
+      ]
+    }
+  );
+  await testSlackMessage.sendToRoom('random');
+  await tools.delayFor(1000);
+  await testSlackMessage.updateAndSend({
     author_name: 'GitLab CI',
     author_link: 'https://gitlab.com/',
     pretext: '*Good News*: Build successfull!',
@@ -45,7 +70,7 @@ tap.test('should send a message to Slack by directly calling the message', async
     fields: [
       {
         title: 'Branch',
-        value: 'Lossless Cloud',
+        value: 'Lossless Studio',
         short: true
       },
       {
@@ -53,10 +78,58 @@ tap.test('should send a message to Slack by directly calling the message', async
         value: 'pushrocks',
         short: true
       }
-    ],
-    ts: new Date().getTime() / 1000
-  }, testSlackme);
-  await testSlackMessage.sendToRoom('random');
+    ]
+  });
+  await testSlackMessage.updateAndSend({
+    author_name: 'GitLab CI',
+    author_link: 'https://gitlab.com/',
+    pretext: '*Good News*: Build successfull!',
+    color: '#3cb371',
+    fields: [
+      {
+        title: 'Branch',
+        value: 'Lossless Studio',
+        short: true
+      },
+      {
+        title: 'Product ID',
+        value: 'onboard.me',
+        short: true
+      }
+    ]
+  });
+  await testSlackMessage.startThread({
+    author_name: 'Lossless Compliance',
+    author_link: 'https://gitlab.com/',
+    pretext: '*Good News*: Build successfull!',
+    color: '#3cb371',
+    fields: [
+      {
+        title: 'Branch',
+        value: 'Lossless Studio',
+        short: true
+      },
+      {
+        title: 'Product ID',
+        value: 'pushrocks',
+        short: true
+      }
+    ]
+  })
 });
 
+tap.test('should send logs', async () => {
+  const slackLog = new slackme.SlackLog({
+    slackAccount: testSlackAccount,
+    channelName: 'random'
+  })
+  for (let i = 0; i < 30; i++) {
+    await slackLog.sendLogLine('hi there');
+    await slackLog.sendLogLine('so awesome');
+    await slackLog.sendLogLine('really');
+  }
+  
+  
+})
+
 tap.start();

ts/index.ts

@@ -1,2 +1,3 @@
-export * from './slack.classes.slackme';
+export * from './slack.classes.slackaccount';
 export * from './slack.classes.slackmessage';
+export * from './slack.classes.slacklog';

ts/slack.classes.slackaccount.ts

@@ -0,0 +1,66 @@
+import * as plugins from './slack.plugins';
+import { IMessageOptions } from './slack.classes.slackmessage';
+
+export class SlackAccount {
+  private postUrl = 'https://slack.com/api/chat.postMessage';
+  private updateUrl = 'https://slack.com/api/chat.update';
+  private slackToken: string;
+  constructor(slackTokenArg: string) {
+    this.slackToken = slackTokenArg;
+  }
+
+  async sendMessage(optionsArg: {
+    messageOptions: IMessageOptions;
+    channelArg: string;
+    ts?: string;
+    mode: 'new' | 'threaded' | 'update';
+  }) {
+
+    let requestBody: any = {
+      channel: optionsArg.channelArg,
+      text: optionsArg.messageOptions.text,
+    };
+
+    if (optionsArg.messageOptions.fields) {
+      requestBody = {
+        ...requestBody,
+        attachments: [{
+          pretext: optionsArg.messageOptions.pretext,
+          fields: optionsArg.messageOptions.fields,
+          ts: optionsArg.messageOptions.ts,
+          color: optionsArg.messageOptions.color
+        }]
+      }
+    }
+
+
+
+
+    let postUrl = this.postUrl;
+
+    switch (true) {
+      case optionsArg.ts && optionsArg.mode === 'update':
+        requestBody = {
+          ...requestBody,
+          ts: optionsArg.ts
+        };
+        postUrl = this.updateUrl;
+        break;
+      case optionsArg.ts && optionsArg.mode === 'threaded':
+        requestBody = {
+          ...requestBody,
+          thread_ts: optionsArg.ts
+
+        }
+        break;
+    }
+
+    const response = await plugins.smartrequest.postJson(postUrl, {
+      headers: {
+        Authorization: `Bearer ${this.slackToken}`
+      },
+      requestBody
+    });
+    return response;
+  }
+}

ts/slack.classes.slacklog.ts

@@ -0,0 +1,32 @@
+import { SlackAccount } from "./slack.classes.slackaccount";
+import { SlackMessage } from "./slack.classes.slackmessage";
+
+export class SlackLog {
+  public slackAccount: SlackAccount;
+  public slackMessage: SlackMessage;
+  public channelName: string;
+
+  public completeLog = ``;
+
+  constructor(optionsArg: {
+    slackAccount: SlackAccount;
+    channelName: string;
+  }) {
+    this.slackAccount = optionsArg.slackAccount;
+    this.channelName = optionsArg.channelName;
+  }
+  public async sendLogLine(logText: string) {
+    if (!this.slackMessage) {
+      this.slackMessage = new SlackMessage(this.slackAccount, {
+        text: '``` log is loading... ```'
+      });
+      await this.slackMessage.sendToRoom(this.channelName);
+    }
+    const date = new Date();
+    this.completeLog += `${date.getHours()}:${date.getMinutes()}:${date.getSeconds()} - ` + logText + '\n';
+    await this.slackMessage.updateAndSend({
+      text: '```\n' + this.completeLog + '\n```' 
+    })
+  }
+
+};

ts/slack.classes.slackme.ts

@@ -1,19 +0,0 @@
-import * as plugins from './slack.plugins';
-import { IMessageOptions } from './slack.classes.slackmessage';
-
-export class Slackme {
-  private baseUrl = 'https://hooks.slack.com/services/';
-  private postRoute: string;
-  constructor(postRouteArg: string) {
-    this.postRoute = postRouteArg;
-  }
-
-  async sendMessage(messageOptionsArg: IMessageOptions, channelArg: string = 'general') {
-    await plugins.smartrequest.postJson(`${this.baseUrl}${this.postRoute}`, {
-      requestBody: {
-        channel: channelArg,
-        attachments: [messageOptionsArg]
-      }
-    });
-  }
-}

ts/slack.classes.slackmessage.ts

@@ -1,5 +1,5 @@
 import * as plugins from './slack.plugins';
-import { Slackme } from './slack.classes.slackme';
+import { SlackAccount } from './slack.classes.slackaccount';
 
 export interface IAttachmentField {
   title: string;
@@ -49,24 +49,48 @@ export interface IMessageOptions {
   thumb_url?: string;
   footer?: string;
   footer_icon?: string;
-  /**
-   * timestamp as epoch time
-   */
   ts?: number;
 }
 
 export class SlackMessage {
-  slackmeRef: Slackme;
-  messageOptions: IMessageOptions;
-  constructor(messageOptionsArg: IMessageOptions, slackmeArg?: Slackme) {
-    if (slackmeArg) {
-      this.slackmeRef = slackmeArg;
+  public slackAccountRef: SlackAccount;
+  public messageOptions: IMessageOptions;
+  public channel: string;
+  public ts: string;
+
+  public requestRunning = plugins.smartpromise.defer();
+
+  constructor(slackAccountArg: SlackAccount, messageOptionsArg: IMessageOptions) {
+    if (slackAccountArg) {
+      this.slackAccountRef = slackAccountArg;
     }
     this.messageOptions = messageOptionsArg;
+    this.requestRunning.resolve();
   }
-  async sendToRoom(roomNameArg: string) {
-    if (this.slackmeRef) {
-      await this.slackmeRef.sendMessage(this.messageOptions, roomNameArg);
+
+  async updateAndSend(messageOptionsArg: IMessageOptions) {
+    this.messageOptions = messageOptionsArg;
+    await this.sendToRoom(this.channel, 'update');
+  }
+
+  async startThread(messageOptionsArg: IMessageOptions) {
+    this.messageOptions = messageOptionsArg;
+    this.sendToRoom(this.channel, 'threaded')
+  }
+
+  async sendToRoom(channelNameArg: string, modeArg: 'new' | 'update' | 'threaded' = 'new') {
+    this.channel = channelNameArg;
+    if (this.slackAccountRef) {
+      const response = await this.slackAccountRef.sendMessage({
+        channelArg: this.channel,
+        messageOptions: this.messageOptions,
+        mode: modeArg,
+        ts: this.ts
+      });
+      if (modeArg === 'new') {
+        this.ts = response.body.message.ts;
+        this.channel = response.body.channel;
+      }
     } else {
       throw new Error('you need to set a slackRef before sending the message!');
     }

ts/slack.plugins.ts

@@ -1,4 +1,5 @@
 // pushrocks scope
+import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartrequest from '@pushrocks/smartrequest';
 
-export { smartrequest };
+export { smartpromise, smartrequest };