@certik/skynet 0.18.0 → 0.18.1

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.18.1
+
+- BREAKING: opensearch feature has been replaced by elastic search
+- Fixed: s3 library listKeys function when search result is empty
+
 ## 0.18.0
 
 - BREAKING: remove dependencies on `SKYNET_AWS_ACCESS_KEY_ID` and `SKYNET_AWS_SECRET_ACCESS_KEY` and `SKYNET_AWS_REGION`

package/opsgenie.d.ts

@@ -3,5 +3,6 @@ export function postGenieMessage<T>(
     alias?: string;
     message: string;
   },
+  apiKey: string,
   verbose?: boolean,
 ): Promise<{ result: T }>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@certik/skynet",
-  "version": "0.18.0",
+  "version": "0.18.1",
   "description": "Skynet Shared JS library",
   "type": "module",
   "main": "index.js",
@@ -19,7 +19,7 @@
     "@aws-sdk/client-s3": "^3.478.0",
     "@aws-sdk/client-sqs": "^3.478.0",
     "@aws-sdk/lib-dynamodb": "^3.478.0",
-    "@opensearch-project/opensearch": "^2.4.0",
+    "@elastic/elasticsearch": "^8.14.0",
     "@slack/web-api": "^6.11.0",
     "bottleneck": "^2.19.5",
     "chalk": "^5.3.0",

package/s3.js

@@ -135,6 +135,10 @@ async function listKeys(bucketname, prefix, continuationToken) {
     throw `unable to list keys with prefix ${prefix}: ${err}`;
   }
 
+  if (!data.Contents) {
+    return { keys: [] };
+  }
+
   let res = { keys: data.Contents.map(({ Key }) => Key) };
   if (data.IsTruncated) {
     res.continuationToken = data.NextContinuationToken;

package/search.d.ts

@@ -0,0 +1,6 @@
+export function sendToSearch<T>(
+  appName: string,
+  indexPrefix: string,
+  record: string,
+  throws?: boolean,
+): Promise<{ status: string; result: T }>;

package/search.js

@@ -0,0 +1,29 @@
+import { isProduction } from "./env.js";
+import { inline } from "./log.js";
+import { Client } from "@elastic/elasticsearch";
+import osModule from "os";
+
+export async function sendToSearch(appName, indexPrefix, record, throws = false) {
+  const client = new Client({
+    cloud: { id: process.env.SKYNET_ELASTICSEARCH_CLOUD_ID },
+    auth: { apiKey: process.env.SKYNET_ELASTICSEARCH_API_KEY },
+  });
+
+  const now = new Date();
+  const indexName = [indexPrefix, isProduction() ? "prod" : "dev", now.toISOString().slice(0, 7)].join("-");
+
+  // best as possible delivery
+  // by default not throw
+  try {
+    await client.index({
+      index: indexName,
+      document: { app: appName, instance: osModule.hostname(), timestamp: now, record },
+    });
+  } catch (err) {
+    inline.error(err);
+
+    if (throws) {
+      throw err;
+    }
+  }
+}

package/opensearch.d.ts

@@ -1,16 +0,0 @@
-import { Client, ClientOptions } from "@opensearch-project/opensearch";
-
-export declare function newOpensearchClient(
-  endpoint: string,
-  key: string,
-  secret: string,
-  options?: ClientOptions,
-): Client;
-
-export declare async function sendToOpensearch<T>(
-  client: Client,
-  appName: string,
-  index: string,
-  record: string,
-  indexSuffixes?: string[],
-): Promise<{ status: string; result: T }>;

package/opensearch.js

@@ -1,34 +0,0 @@
-import { Client } from "@opensearch-project/opensearch";
-
-// newOpensearchClient creates a new opensearch client with the given endpoint, key, secret and extra opensearch client options.
-export function newOpensearchClient(endpoint, key, secret, options = {}) {
-  return new Client({
-    node: endpoint,
-    auth: {
-      username: key,
-      password: secret,
-    },
-    ...options,
-  });
-}
-
-// sendToOpensearch sends a record object to the given index using the given opensearch client. An appName is also attached to the record
-// as an identifier for who sends the record. The indexSuffixes is an array of strings that will be appended to the index name using `-`.
-// A typical usage of indexSuffixes could be the date e.g. ["2023", "08"] so that new indexes are created on the monthly basis to prevent
-// the index from growing too large.
-// Returns an object with status and result properties. The status is either "ok" or "error". The result is the response from opensearch
-// if the status is "ok" or the error message if the status is "error".
-export async function sendToOpensearch(client, appName, index, record, indexSuffixes = []) {
-  try {
-    const result = await client.index({
-      index: indexSuffixes ? [index, ...indexSuffixes].join("-") : index,
-      body: { app: appName, timestamp: new Date(), record },
-    });
-    if (result.statusCode === 201) {
-      return { status: "ok", result };
-    }
-    return { status: "error", result };
-  } catch (err) {
-    return { status: "error", result: err.stack ? err.stack : err };
-  }
-}