@appscode/design-system 1.0.43-alpha.173 → 1.0.43-alpha.174

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appscode/design-system",
-  "version": "1.0.43-alpha.173",
+  "version": "1.0.43-alpha.174",
   "description": "A design system for Appscode websites and dashboards made using Bulma",
   "main": "main.scss",
   "scripts": {

package/vue-components/v3/long-running-tasks/LongRunningTaskItem.vue

@@ -0,0 +1,92 @@
+<template>
+  <span href="" class="task-item" :class="[statusClass]">
+    <i class="fa" :class="`fa-${statusIcon}`" />
+    {{ title }}
+  </span>
+</template>
+
+<script setup lang="ts">
+  import { computed, toRefs } from 'vue'
+  import { TaskStatus } from '../../typings/long-running-tasks'
+
+  const props = withDefaults(
+    defineProps<{ title: string; status: TaskStatus }>(),
+    {
+      title: '',
+      status: 'Pending',
+    }
+  )
+
+  const { status } = toRefs(props)
+  const statusClass = computed(() => `is-${status.value.toLowerCase()}`)
+  const statusIcon = computed(() => {
+    if (status.value === 'Running' || status.value === 'Started')
+      return 'circle-o-notch'
+    else if (status.value === 'Success') return 'check-circle'
+    else if (status.value === 'Failed') return 'times-circle'
+    else return 'spinner'
+  })
+</script>
+
+<style scoped lang="scss">
+  .task-item {
+    font-size: 14px;
+    display: block;
+    padding: 5px;
+    border-radius: 5px;
+    transition: all 0.3s ease-in-out;
+    &:hover {
+      background-color: var(--ac-white-light);
+      cursor: pointer;
+    }
+    &.is-active {
+      background-color: var(--ac-white-light);
+    }
+    &.is-pending {
+      color: var(--ac-gray-light);
+      i {
+        visibility: hidden;
+      }
+      &:hover {
+        background-color: transparent;
+        cursor: not-allowed;
+      }
+    }
+    &.is-aborted {
+      color: var(--ac-gray-light);
+      &:hover {
+        background-color: transparent;
+        cursor: not-allowed;
+      }
+    }
+    &.is-running,
+    &.is-started {
+      i {
+        color: var(--ac-primary);
+        animation-name: spin;
+        animation-duration: 1000ms;
+        animation-iteration-count: infinite;
+        animation-timing-function: linear;
+      }
+
+      @keyframes spin {
+        from {
+          transform: rotate(0deg);
+        }
+        to {
+          transform: rotate(360deg);
+        }
+      }
+    }
+    &.is-success {
+      i {
+        color: #158748;
+      }
+    }
+    &.is-failed {
+      i {
+        color: #ff3729;
+      }
+    }
+  }
+</style>

package/vue-components/v3/modals/LongRunningTasksModal.vue

@@ -0,0 +1,334 @@
+<template>
+  <modal
+    :open="open"
+    :title="title"
+    :is-close-option-disabled="!enableModalClose"
+    :ignore-outside-click="true"
+    :hide-action-footer="!enableModalFooter"
+    @closemodal="$emit('close')"
+  >
+    <div v-if="connectionError" class="task-simple-wrapper">
+      <div class="task-cogs-icon">
+        <i class="fa fa-times-circle has-text-danger fa-5x fa-fw"></i>
+      </div>
+      <div class="task-log">
+        <span class="task-title">
+          <i class="fa fa-times-circle mr-5 is-failed" />
+          <span> Connection error </span>
+        </span>
+        <span>{{ connectionError }}</span>
+      </div>
+    </div>
+    <div
+      v-else-if="isNatsConnectionLoading || !activeStep"
+      class="is-justify-content-center"
+      :class="simple ? 'task-simple-wrapper' : 'task-complex-wrapper'"
+    >
+      <preloader
+        :style="{ height: '100%' }"
+        class="is-fullheight"
+        message="Connecting..."
+      />
+    </div>
+    <div v-else-if="simple" class="task-simple-wrapper">
+      <div class="task-cogs-icon">
+        <i class="fa fa-cog fa-spin fa-5x fa-fw"></i>
+        <span class="is-flex is-flex-direction-column">
+          <i class="fa fa-cog fa-spin fa-3x fa-bw"></i>
+          <i class="fa fa-cog fa-spin fa-3x fa-bw"></i>
+        </span>
+      </div>
+      <div class="task-log">
+        <span class="task-title">
+          <i
+            v-if="activeTask?.status === 'Running'"
+            class="fa fa-circle-o-notch fa-spin mr-5"
+          />
+          <i
+            v-else-if="activeTask?.status === 'Success'"
+            class="fa fa-check-circle mr-5 is-success"
+          />
+          <i
+            v-else-if="activeTask?.status === 'Failed'"
+            class="fa fa-times-circle mr-5 is-failed"
+          />
+          <span>
+            {{ activeTask?.step }}
+          </span>
+        </span>
+        <span>{{ activeTask?.logs[activeTask?.logs.length - 1] }}</span>
+      </div>
+    </div>
+    <div v-else class="task-complex-wrapper">
+      <ul class="task-list">
+        <li v-for="task in tasks" :key="task.step">
+          <long-running-task-item
+            :title="task.step"
+            :status="task.status"
+            :class="{ 'is-active': activeStep === task.step }"
+          />
+        </li>
+      </ul>
+      <long-running-task-terminal
+        :key="activeTask?.step"
+        :logs="activeTask?.logs"
+        class="task-log"
+      />
+    </div>
+
+    <template #modal-footer-controls>
+      <ac-button
+        title="Close"
+        modifier-classes="is-outlined"
+        @click.stop="$emit('close')"
+      />
+      <ac-button
+        v-if="showSuccessButton"
+        :title="successCtx?.btnTitle"
+        :is-loader-active="successCtx?.isLoaderActive"
+        modifier-classes="is-primary"
+        icon-class="step-forward"
+        @click="successCtx.onSuccessBtnClick"
+      />
+      <ac-button
+        v-if="showReportButton"
+        title="Report Issue"
+        modifier-classes="is-danger"
+        icon-class="external-link"
+        @click="onReportIssueClick"
+      />
+    </template>
+  </modal>
+</template>
+<script setup lang="ts">
+import {
+  computed,
+  getCurrentInstance,
+  onBeforeUnmount,
+  Ref,
+  toRefs,
+  watch,
+  watchEffect,
+} from "vue";
+import { defineAsyncComponent, ref } from "vue";
+import { Task, TaskLog } from "../../typings/long-running-tasks";
+import { Subscription, StringCodec } from "nats.ws";
+
+const Modal = defineAsyncComponent(() => import("../modal/Modal.vue"));
+const LongRunningTaskItem = defineAsyncComponent(
+  () => import("../long-running-tasks/LongRunningTaskItem.vue")
+);
+const LongRunningTaskTerminal = defineAsyncComponent(
+  () => import("../terminal/LongRunningTaskTerminal.vue")
+);
+const Preloader = defineAsyncComponent(
+  () => import("../../v2/preloader/Preloader.vue")
+);
+const AcButton = defineAsyncComponent(() => import("../button/Button.vue"));
+
+defineEmits(["close"]);
+
+const props = withDefaults(
+  defineProps<{
+    open: boolean;
+    title: string;
+    simple: boolean;
+    natsSubject: string;
+    isNatsConnectionLoading: boolean;
+    errorCtx?: {
+      connectionError: string;
+      onError: (msg: string) => void;
+    };
+    successCtx?: {
+      btnTitle?: string;
+      isLoaderActive?: boolean;
+      onSuccess: () => void;
+      onSuccessBtnClick?: () => void;
+    };
+  }>(),
+  {
+    open: true,
+    simple: true,
+    title: "Sample title",
+    natsSubject: "",
+    isNatsConnectionLoading: false,
+    errorCtx: undefined,
+    successCtx: undefined,
+  }
+);
+
+const { natsSubject, open, errorCtx, successCtx } = toRefs(props);
+const connectionError = computed(() => errorCtx.value?.connectionError);
+const currentInstance = getCurrentInstance();
+const $nats = currentInstance?.appContext.config.globalProperties.$nc;
+let subscription: Subscription;
+
+const tasks: Ref<Array<Task>> = ref([]);
+const activeStep: Ref<string> = ref("");
+const activeTask = computed(() => {
+  const task = tasks.value.find((task) => task.step === activeStep.value);
+  return task;
+});
+
+function handleTaskLog(log: TaskLog) {
+  if (log.step) {
+    // log has a step
+    // so add new task
+    tasks.value.push({
+      ...log,
+      logs: [(log.msg && log.msg) || ""],
+    });
+    activeStep.value = log.step;
+  } else {
+    const task = tasks.value.find((task) => task.step === activeStep.value);
+    if (task) {
+      task.status = log.status;
+      if (log.status === "Failed") {
+        task.logs.push(log.error || "");
+      } else {
+        task.logs.push(log.msg || "");
+      }
+    }
+  }
+}
+
+async function subscribeToChannel(channelId: string) {
+  subscription = $nats?.subscribe(channelId);
+
+  console.log("Started listening", channelId);
+
+  if (subscription) {
+    // listen to channel events
+    for await (const msg of subscription) {
+      console.log("hi");
+      console.log({ data: StringCodec().decode(msg.data) });
+      const log: TaskLog = JSON.parse(StringCodec().decode(msg.data));
+      console.log({ log });
+      handleTaskLog(log);
+    }
+    console.log("Stopped listening", channelId);
+    console.log("Closed Channel", channelId);
+  }
+}
+
+watchEffect(() => {
+  if (natsSubject.value) {
+    subscribeToChannel(natsSubject.value);
+  }
+});
+
+watch(open, (n) => {
+  if (!n) {
+    subscription && subscription.unsubscribe();
+  }
+});
+onBeforeUnmount(() => {
+  subscription && subscription.unsubscribe();
+});
+
+// modal close / footer feature
+const enableModalClose = computed(() => {
+  return (
+    connectionError.value ||
+    activeTask.value?.status === "Failed" ||
+    activeTask.value?.status === "Success"
+  );
+});
+const enableModalFooter = computed(() => {
+  return showReportButton.value || showSuccessButton.value;
+});
+
+// report button
+const showReportButton = computed(() => activeTask.value?.status === "Failed");
+function onReportIssueClick() {
+  const url = `https://github.com/bytebuilders/community/issues/new?title=Chart Install: ${
+    activeStep.value
+  }&labels[]=bug&body=${window.location.href} %0A%0A %60%60%60 %0A  ${
+    activeTask.value?.logs[activeTask.value?.logs.length - 1 || 0]
+  } %0A %60%60%60`;
+  window.open(url, "_blank");
+}
+
+// success button
+const showSuccessButton = computed(
+  () => activeTask.value?.status === "Success" && successCtx.value?.btnTitle
+);
+
+// execute on success and on error functions
+watch(
+  () => activeTask.value?.status,
+  (n) => {
+    if (n === "Success") {
+      successCtx.value.onSuccess();
+    } else if (n === "Failed") {
+      errorCtx.value.onError(
+        activeTask.value?.logs[activeTask.value?.logs.length - 1 || 0] || ""
+      );
+    }
+  }
+);
+</script>
+
+<style scoped lang="scss">
+.task-simple-wrapper {
+  display: flex;
+  flex-direction: column;
+  justify-content: space-between;
+  width: 40vw;
+  height: 40vh;
+  .task-cogs-icon {
+    width: 100%;
+    height: 70%;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    font-size: 20px;
+    color: var(--ac-primary);
+  }
+  .task-log {
+    width: 100%;
+    height: 30%;
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+    justify-content: center;
+    .task-title {
+      span,
+      i {
+        font-size: 16px;
+      }
+      i {
+        color: var(--ac-primary);
+        &.is-success {
+          color: #158748;
+        }
+        &.is-failed {
+          color: #ff3729;
+        }
+      }
+      font-weight: 500;
+    }
+    span {
+      font-size: 14px;
+    }
+  }
+}
+.task-complex-wrapper {
+  display: flex;
+  flex-direction: row;
+  justify-content: space-between;
+  width: 60vw;
+  height: 60vh;
+
+  .task-list {
+    width: 25%;
+    height: 100%;
+  }
+  .task-log {
+    width: 70%;
+    height: 100%;
+    border-radius: 1rem;
+    font-size: 13px;
+  }
+}
+</style>

package/vue-components/v3/terminal/LongRunningTaskTerminal.vue

@@ -0,0 +1,76 @@
+<template>
+  <div ref="terminalRef" class="terminal-body"></div>
+</template>
+
+<script setup lang="ts">
+  import { computed, nextTick, ref, toRefs, watch, watchPostEffect } from 'vue'
+  import { Terminal } from 'xterm'
+  import { FitAddon } from 'xterm-addon-fit'
+  import { WebglAddon } from 'xterm-addon-webgl'
+  import { Material, MaterialDark } from 'xterm-theme' //https://github.com/ysk2014/xterm-theme/tree/master/src/iterm
+
+  const props = withDefaults(
+    defineProps<{
+      logs: string[]
+    }>(),
+    { logs: () => [] }
+  )
+  // terminal print logic
+  const { logs } = toRefs(props)
+  const lastPrintIdx = ref(0)
+  watch(
+    logs,
+    (n) => {
+      if (n.length > lastPrintIdx.value) {
+        nextTick(() => {
+          writeOnTerminal(n.slice(lastPrintIdx.value).join('\n'))
+          lastPrintIdx.value = n.length
+        })
+      }
+    },
+    { immediate: true, deep: true }
+  )
+
+  //theme
+  const theme = ref('light') // handle theme logic later, without the useStore function because they are different in console and kubedb ui
+  const bodyBgc = computed(() =>
+    theme.value === 'light' ? '#eaeaea' : '#232322'
+  )
+
+  // xterm component logic
+  const terminalRef = ref<HTMLElement>()
+  const terminal = new Terminal({
+    windowsMode: false,
+    theme: theme.value === 'light' ? Material : MaterialDark,
+  })
+  const fitAddon = new FitAddon()
+  terminal.loadAddon(fitAddon)
+  const webGlAddon = new WebglAddon()
+  webGlAddon.onContextLoss(() => {
+    webGlAddon.dispose()
+  })
+  watchPostEffect(() => {
+    if (terminalRef.value) {
+      terminal.open(terminalRef.value)
+      fitAddon.fit()
+      terminal.focus()
+      terminal.loadAddon(webGlAddon)
+    }
+  })
+  function writeOnTerminal(msg: string) {
+    const lines = msg.split('\n')
+    lines.forEach((line, index) => {
+      if (lines.length === 1 || index < lines.length - 1) terminal.writeln(line)
+      else terminal.write(line)
+    })
+  }
+</script>
+
+<style lang="scss">
+  .terminal-body {
+    width: 100%;
+    height: 100%;
+    background-color: v-bind(bodyBgc);
+    padding: 5px 0px 0px 10px;
+  }
+</style>