mihari 5.2.4 → 5.3.1

data/frontend/src/utils.ts

@@ -1,60 +1,54 @@
-import dayjs from "dayjs";
-import relativeTime from "dayjs/plugin/relativeTime";
-import timezone from "dayjs/plugin/timezone";
-import utc from "dayjs/plugin/utc";
-import { LocationQueryValue } from "vue-router";
+import dayjs from "dayjs"
+import relativeTime from "dayjs/plugin/relativeTime"
+import timezone from "dayjs/plugin/timezone"
+import utc from "dayjs/plugin/utc"
+import type { LocationQueryValue } from "vue-router"
 
-import { getCountryByCode } from "@/countries";
-import { GCS, IPInfo } from "@/types";
+import { getCountryByCode } from "@/countries"
+import type { GCS, IPInfo } from "@/types"
 
-dayjs.extend(relativeTime);
-dayjs.extend(timezone);
-dayjs.extend(utc);
+dayjs.extend(relativeTime)
+dayjs.extend(timezone)
+dayjs.extend(utc)
 
 export function getLocalDatetime(datetime: string): string {
-  return dayjs(datetime).local().format("YYYY-MM-DD HH:mm:ss");
+  return dayjs(datetime).local().format("YYYY-MM-DD HH:mm:ss")
 }
 
 export function getHumanizedRelativeTime(datetime: string): string {
-  return dayjs(datetime).local().fromNow();
+  return dayjs(datetime).local().fromNow()
 }
 
 export function getGCSByCountryCode(countryCode: string): GCS | undefined {
-  const country = getCountryByCode(countryCode);
+  const country = getCountryByCode(countryCode)
   if (country !== undefined) {
-    return { lat: country.lat, long: country.long };
+    return { lat: country.lat, long: country.long }
   }
 }
 
 export function getGCSByIPInfo(ipinfo: IPInfo): GCS | undefined {
   if (ipinfo.loc !== undefined) {
-    const numbers = ipinfo.loc.split(",");
+    const numbers = ipinfo.loc.split(",")
     if (numbers.length === 2) {
-      const lat = numbers[0];
-      const long = numbers[1];
+      const lat = numbers[0]
+      const long = numbers[1]
 
-      return { lat: parseFloat(lat), long: parseFloat(long) };
+      return { lat: parseFloat(lat), long: parseFloat(long) }
     }
   }
-  return getGCSByCountryCode(ipinfo.countryCode);
+  return getGCSByCountryCode(ipinfo.countryCode)
 }
 
 export function normalizeQueryParam(
-  param:
-    | undefined
-    | null
-    | string
-    | string[]
-    | LocationQueryValue
-    | LocationQueryValue[]
+  param: undefined | null | string | string[] | LocationQueryValue | LocationQueryValue[]
 ): string | undefined {
   if (param === undefined || param === null) {
-    return undefined;
+    return undefined
   }
 
   if (typeof param === "string") {
-    return param;
+    return param
   }
 
-  return param.toString();
+  return param.toString()
 }

data/frontend/src/views/Alerts.vue

@@ -3,18 +3,18 @@
 </template>
 
 <script lang="ts">
-import { useTitle } from "@vueuse/core";
-import { defineComponent } from "vue";
+import { useTitle } from "@vueuse/core"
+import { defineComponent } from "vue"
 
-import Alerts from "@/components/alert/AlertsWrapper.vue";
+import Alerts from "@/components/alert/AlertsWrapper.vue"
 
 export default defineComponent({
   name: "AlertsView",
   components: {
-    Alerts,
+    Alerts
   },
   setup() {
-    useTitle("Alerts - Mihari");
-  },
-});
+    useTitle("Alerts - Mihari")
+  }
+})
 </script>

data/frontend/src/views/Artifact.vue

@@ -3,42 +3,42 @@
 </template>
 
 <script lang="ts">
-import { useTitle } from "@vueuse/core";
-import { defineComponent, onMounted, ref, watch } from "vue";
+import { useTitle } from "@vueuse/core"
+import { defineComponent, onMounted, ref, watch } from "vue"
 
-import Artifact from "@/components/artifact/ArtifactWrapper.vue";
+import Artifact from "@/components/artifact/ArtifactWrapper.vue"
 
 export default defineComponent({
   name: "ArtifactView",
   components: {
-    Artifact,
+    Artifact
   },
   props: {
     id: {
       type: String,
-      required: true,
-    },
+      required: true
+    }
   },
   setup(props) {
-    const artifactId = ref<string>(props.id);
+    const artifactId = ref<string>(props.id)
 
     const updateTitle = () => {
-      useTitle(`Artifact:${artifactId.value} - Mihari`);
-    };
+      useTitle(`Artifact:${artifactId.value} - Mihari`)
+    }
 
     onMounted(() => {
-      updateTitle();
-    });
+      updateTitle()
+    })
 
     watch(
       () => props.id,
       () => {
-        artifactId.value = props.id;
-        updateTitle();
+        artifactId.value = props.id
+        updateTitle()
       }
-    );
+    )
 
-    return { artifactId };
-  },
-});
+    return { artifactId }
+  }
+})
 </script>

data/frontend/src/views/Configs.vue

@@ -3,18 +3,18 @@
 </template>
 
 <script lang="ts">
-import { useTitle } from "@vueuse/core";
-import { defineComponent } from "vue";
+import { useTitle } from "@vueuse/core"
+import { defineComponent } from "vue"
 
-import Configs from "@/components/config/ConfigsWrapper.vue";
+import Configs from "@/components/config/ConfigsWrapper.vue"
 
 export default defineComponent({
   name: "ConfigView",
   components: {
-    Configs,
+    Configs
   },
   setup() {
-    useTitle("Config - Mihari");
-  },
-});
+    useTitle("Config - Mihari")
+  }
+})
 </script>

data/frontend/src/views/EditRule.vue

@@ -3,42 +3,42 @@
 </template>
 
 <script lang="ts">
-import { useTitle } from "@vueuse/core";
-import { defineComponent, onMounted, ref, watch } from "vue";
+import { useTitle } from "@vueuse/core"
+import { defineComponent, onMounted, ref, watch } from "vue"
 
-import EditRule from "@/components/rule/EditRuleWrapper.vue";
+import EditRule from "@/components/rule/EditRuleWrapper.vue"
 
 export default defineComponent({
   name: "EditRuleView",
   components: {
-    EditRule,
+    EditRule
   },
   props: {
     id: {
       type: String,
-      required: true,
-    },
+      required: true
+    }
   },
   setup(props) {
-    const ruleId = ref<string>(props.id);
+    const ruleId = ref<string>(props.id)
 
     const updateTitle = () => {
-      useTitle(`Edit rule:${ruleId.value} - Mihari`);
-    };
+      useTitle(`Edit rule:${ruleId.value} - Mihari`)
+    }
 
     onMounted(() => {
-      updateTitle();
-    });
+      updateTitle()
+    })
 
     watch(
       () => props.id,
       () => {
-        ruleId.value = props.id;
-        updateTitle();
+        ruleId.value = props.id
+        updateTitle()
       }
-    );
+    )
 
-    return { ruleId };
-  },
-});
+    return { ruleId }
+  }
+})
 </script>

data/frontend/src/views/NewRule.vue

@@ -3,24 +3,24 @@
 </template>
 
 <script lang="ts">
-import { useTitle } from "@vueuse/core";
-import { defineComponent, onMounted } from "vue";
+import { useTitle } from "@vueuse/core"
+import { defineComponent, onMounted } from "vue"
 
-import NewRule from "@/components/rule/NewRule.vue";
+import NewRule from "@/components/rule/NewRule.vue"
 
 export default defineComponent({
   name: "NewRuleView",
   components: {
-    NewRule,
+    NewRule
   },
   setup() {
     const updateTitle = () => {
-      useTitle(`New rule - Mihari`);
-    };
+      useTitle(`New rule - Mihari`)
+    }
 
     onMounted(() => {
-      updateTitle();
-    });
-  },
-});
+      updateTitle()
+    })
+  }
+})
 </script>

data/frontend/src/views/Rule.vue

@@ -3,42 +3,42 @@
 </template>
 
 <script lang="ts">
-import { useTitle } from "@vueuse/core";
-import { defineComponent, onMounted, ref, watch } from "vue";
+import { useTitle } from "@vueuse/core"
+import { defineComponent, onMounted, ref, watch } from "vue"
 
-import Rule from "@/components/rule/RuleWrapper.vue";
+import Rule from "@/components/rule/RuleWrapper.vue"
 
 export default defineComponent({
   name: "RuleView",
   components: {
-    Rule,
+    Rule
   },
   props: {
     id: {
       type: String,
-      required: true,
-    },
+      required: true
+    }
   },
   setup(props) {
-    const ruleId = ref<string>(props.id);
+    const ruleId = ref<string>(props.id)
 
     const updateTitle = () => {
-      useTitle(`Rule:${ruleId.value} - Mihari`);
-    };
+      useTitle(`Rule:${ruleId.value} - Mihari`)
+    }
 
     onMounted(() => {
-      updateTitle();
-    });
+      updateTitle()
+    })
 
     watch(
       () => props.id,
       () => {
-        ruleId.value = props.id;
-        updateTitle();
+        ruleId.value = props.id
+        updateTitle()
       }
-    );
+    )
 
-    return { ruleId };
-  },
-});
+    return { ruleId }
+  }
+})
 </script>

data/frontend/src/views/Rules.vue

@@ -3,18 +3,18 @@
 </template>
 
 <script lang="ts">
-import { useTitle } from "@vueuse/core";
-import { defineComponent } from "vue";
+import { useTitle } from "@vueuse/core"
+import { defineComponent } from "vue"
 
-import Rules from "@/components/rule/RulesWrapper.vue";
+import Rules from "@/components/rule/RulesWrapper.vue"
 
 export default defineComponent({
   name: "RulesView",
   components: {
-    Rules,
+    Rules
   },
   setup() {
-    useTitle("Rules - Mihari");
-  },
-});
+    useTitle("Rules - Mihari")
+  }
+})
 </script>

data/frontend/tests/utils.spec.ts

@@ -0,0 +1,9 @@
+import { describe, expect, it } from 'vitest'
+
+import { getHumanizedRelativeTime } from '@/utils'
+
+describe('getHumanizedRelativeTime', () => {
+  it('returns a relative time in humanized format', () => {
+    expect(getHumanizedRelativeTime('1970-01-01 00:00:00')).toContain('years')
+  })
+})

data/frontend/tsconfig.app.json

@@ -0,0 +1,21 @@
+{
+  "extends": "@vue/tsconfig/tsconfig.dom.json",
+  "include": [
+    "env.d.ts",
+    "src/**/*",
+    "src/**/*.vue",
+    "tests/**/*"
+  ],
+  "exclude": [
+    "src/**/__tests__/*"
+  ],
+  "compilerOptions": {
+    "composite": true,
+    "baseUrl": ".",
+    "paths": {
+      "@/*": [
+        "./src/*"
+      ]
+    }
+  }
+}

data/frontend/tsconfig.json

@@ -1,40 +1,14 @@
 {
-  "compilerOptions": {
-    "target": "esnext",
-    "module": "esnext",
-    "strict": true,
-    "jsx": "preserve",
-    "importHelpers": true,
-    "moduleResolution": "node",
-    "skipLibCheck": true,
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "sourceMap": true,
-    "baseUrl": ".",
-    "types": [
-      "webpack-env",
-      "jest"
-    ],
-    "paths": {
-      "@/*": [
-        "src/*"
-      ]
+  "files": [],
+  "references": [
+    {
+      "path": "./tsconfig.node.json"
     },
-    "lib": [
-      "esnext",
-      "dom",
-      "dom.iterable",
-      "scripthost"
-    ]
-  },
-  "include": [
-    "src/**/*.ts",
-    "src/**/*.tsx",
-    "src/**/*.vue",
-    "tests/**/*.ts",
-    "tests/**/*.tsx"
-  ],
-  "exclude": [
-    "node_modules"
+    {
+      "path": "./tsconfig.app.json"
+    },
+    {
+      "path": "./tsconfig.vitest.json"
+    }
   ]
 }

data/frontend/tsconfig.node.json

@@ -0,0 +1,13 @@
+{
+  "extends": "@tsconfig/node20/tsconfig.json",
+  "include": [
+    "vite.config.*",
+  ],
+  "compilerOptions": {
+    "composite": true,
+    "module": "ESNext",
+    "types": [
+      "node"
+    ]
+  }
+}

data/frontend/tsconfig.vitest.json

@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.app.json",
+  "exclude": [],
+  "compilerOptions": {
+    "composite": true,
+    "lib": [],
+    "types": [
+      "node",
+      "jsdom"
+    ]
+  }
+}

data/frontend/vite.config.ts

@@ -0,0 +1,24 @@
+import { fileURLToPath, URL } from "node:url"
+
+import vue from "@vitejs/plugin-vue"
+import { defineConfig } from "vite"
+
+const env = process.env
+const target = env.BACKEND_URL || "http://localhost:9292/"
+const port = parseInt(env.port || "8080")
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [vue()],
+  server: {
+    port,
+    proxy: {
+      "/api": target
+    }
+  },
+  resolve: {
+    alias: {
+      "@": fileURLToPath(new URL("./src", import.meta.url))
+    }
+  }
+})

data/frontend/vitest.config.ts

@@ -0,0 +1,21 @@
+import { fileURLToPath } from "node:url"
+
+import { mergeConfig } from "vite"
+import { configDefaults, defineConfig } from "vitest/config"
+
+import viteConfig from "./vite.config"
+
+export default mergeConfig(
+  viteConfig,
+  defineConfig({
+    test: {
+      environment: "jsdom",
+      exclude: [...configDefaults.exclude, "e2e/*"],
+      root: fileURLToPath(new URL("./", import.meta.url)),
+      transformMode: {
+        web: [/\.[jt]sx$/]
+      },
+      include: ["**/__tests__/**/*.?(c|m)[jt]s?(x)", "**/?(*.){test,spec}.?(c|m)[jt]s?(x)"]
+    }
+  })
+)

data/lefthook.yml

@@ -3,8 +3,10 @@ pre-commit:
   commands:
     standard:
       glob: "*.rb"
-      run: bundle exec standardrb --fix {staged_files} && git add {staged_files}
+      run: bundle exec standardrb --fix {staged_files}
+      stage_fixed: true
     eslint:
       root: "frontend/"
       glob: "*.{js,ts,vue}"
-      run: npx eslint --fix {staged_files} && git add {staged_files}
+      run: npx eslint --fix {staged_files}
+      stage_fixed: true

data/lib/mihari/analyzers/base.rb

@@ -3,11 +3,45 @@
 module Mihari
   module Analyzers
     class Base
-      extend Dry::Initializer
-
       include Mixins::Configurable
       include Mixins::Retriable
 
+      # @return [String]
+      attr_reader :query
+
+      # @return [Hash]
+      attr_reader :options
+
+      #
+      # @param [String] query
+      # @param [Hash, nil] options
+      #
+      def initialize(query, options: nil)
+        @query = query
+        @options = options || {}
+      end
+
+      #
+      # @return [Integer, nil]
+      #
+      def interval
+        @interval = options[:interval]
+      end
+
+      #
+      # @return [Integer]
+      #
+      def retry_interval
+        @retry_interval ||= options[:retry_interval] || DEFAULT_RETRY_INTERVAL
+      end
+
+      #
+      # @return [Integer]
+      #
+      def retry_times
+        @retry_times ||= options[:retry_times] || DEFAULT_RETRY_TIMES
+      end
+
       # @return [Array<String>, Array<Mihari::Artifact>]
       def artifacts
         raise NotImplementedError, "You must implement #{self.class}##{__method__}"
@@ -21,17 +55,14 @@ module Mihari
       # @return [Array<Mihari::Artifact>]
       #
       def normalized_artifacts
-        retry_on_error do
+        retry_on_error(times: retry_times, interval: retry_interval) do
           @normalized_artifacts ||= artifacts.compact.sort.map do |artifact|
             # No need to set data_type manually
             # It is set automatically in #initialize
             artifact = artifact.is_a?(Artifact) ? artifact : Artifact.new(data: artifact)
-            artifact
-          end.select(&:valid?).uniq(&:data).map do |artifact|
-            # set source
             artifact.source = source
             artifact
-          end
+          end.select(&:valid?).uniq(&:data)
         end
       end
 
@@ -51,16 +82,19 @@ module Mihari
         # @return [Mihari::Analyzers::Base]
         #
         def from_query(params)
-          # get options and set default value as an empty hash
-          options = params[:options] || {}
+          copied = params.deep_dup
+
+          # convert params into arguments for initialization
+          query = copied[:query]
 
-          # set interval in the top level
-          interval = options[:interval]
-          params[:interval] = interval if interval
+          # delete analyzer and query
+          %i[analyzer query].each do |key|
+            copied.delete key
+          end
 
-          query = params[:query]
+          copied[:options] = copied[:options] || nil
 
-          new(query, **params)
+          new(query, **copied)
         end
 
         def inherited(child)