@skyramp/skyramp 1.2.37 → 1.2.39

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyramp/skyramp",
-  "version": "1.2.37",
+  "version": "1.2.39",
   "description": "module for leveraging skyramp cli functionality",
   "scripts": {
     "lint": "eslint 'src/**/*.js' 'src/**/*.ts' --fix",

package/src/classes/SkyrampClient.js

@@ -33,8 +33,8 @@ const CONTAINER_PORT = 35142;
 const loginWrapper = lib.func('loginWrapper', 'string', []);
 const logoutWrapper = lib.func('logoutWrapper', 'string', []);
 
+const { createTestDescriptionFromScenario, getYamlBytes, readDataFromFile, checkForUpdate, SKYRAMP_YAML_VERSION } = require('../utils');
 // k8s related
-const { createTestDescriptionFromScenario, getYamlBytes, readDataFromFile, SKYRAMP_YAML_VERSION } = require('../utils');
 const applyLocalWrapper = lib.func('applyLocalWrapper', 'string', []);
 const addKubeconfigWrapper = lib.func('addKubeconfigWrapper', 'string', ['string', 'string', 'string']);
 const deleteSkyrampWorkerWrapper = lib.func('deleteSkyrampWorkerWrapper', 'string', ['string', 'string', 'string', 'string'])
@@ -101,6 +101,9 @@ class SkyrampClient {
   constructor(kubeconfigPathOrOptions, clusterName, context, userToken, directory = process.cwd()) {
     this.local_image = false;
     this.timestamp = Date.now();
+
+    checkForUpdate("npm")
+
     if (typeof kubeconfigPathOrOptions === 'object') {
       const options = kubeconfigPathOrOptions;
       this.workerNamespaces = [];

package/src/classes/SmartPlaywright.js

@@ -9,6 +9,7 @@ const responseType = koffi.struct({
   error: 'char*',
 });
 
+const { checkForUpdate } = require('../utils');
 const improvePlaywrightSelectorWrapper = lib.func('improvePlywrightSelectorWrapper', responseType, ['string']);
 const hasJavascriptWrapper = lib.func('hasJavascript', 'bool', ['string']);
 
@@ -658,6 +659,8 @@ class SkyrampPlaywrightLocator {
 
 class SkyrampPlaywrightPage {
     constructor(page, testInfo) {
+        checkForUpdate("npm")
+
         this._page = page;
         this._testInfo = testInfo; // Store testInfo for screenshot auto-baseline
         return new Proxy(this, {

package/src/index.js

@@ -17,7 +17,7 @@ const { AsyncScenario, AsyncRequest } = require('./classes/AsyncScenario');
 const { LoadTestConfig } = require('./classes/LoadTestConfig');
 const AsyncTestStatus = require('./classes/AsyncTestStatus');
 const MockV2 = require('./classes/MockV2');
-const { getValue, checkSchema, iterate } = require('./utils');
+const { getValue, checkSchema, iterate, pushToolEvent } = require('./utils');
 const { checkStatusCode } = require('./function');
 const { newSkyrampPlaywrightPage, expect } = require('./classes/SmartPlaywright');
 
@@ -46,6 +46,7 @@ module.exports = {
   checkStatusCode,
   checkSchema,
   iterate,
+  pushToolEvent,
   newSkyrampPlaywrightPage,
   expect,
 }

package/src/utils.d.ts

@@ -62,6 +62,20 @@ export function checkSchema(jsonInput: object, schema: object): boolean;
  */
 export function iterate(jsonInput: object): object;
 
+/**
+ * Send telemetry of tool event
+ * @param {string} entryPoint - entrypoint of event, either MCP or vscode
+ * @param {string} toolName - name of the tool
+ * @param {string} error - error message if it failed
+ * @param {Object} params - any parameters associated with the tool call. Disctionary
+ */
+export function pushToolEvent(entryPoint: string, toolName: string, err: string, params: object): void;
+
+/**
+ * check for update
+ */
+export function checkForUpdate(component: string): void;
+
 /**
  * The Skyramp YAML version constant.
  */

package/src/utils.js

@@ -13,6 +13,8 @@ const responseType = koffi.struct({
 const getJSONValueWrapper = lib.func('getJSONValueWrapper', responseType, ['string', 'string']);
 const checkSchemaWrapper = lib.func('checkSchemaWrapper', responseType, ['string', 'string']);
 const iterateWrapper = lib.func('generateJsonTreePathsFromBlob', 'string', ['string']);
+const pushToolEventWrapper = lib.func('pushToolEvent', 'void', ['string', 'string', 'string', 'string']);
+const checkForUpdateWrapper = lib.func('checkForUpdateWrapper', 'void', ['string']);
 
 function isJSONString(value) {
   if (typeof value !== "string") {
@@ -196,6 +198,29 @@ function iterate(fuzz_body) {
     return parsed
 }
 
+/**
+ * Send telemetry of tool event
+ *
+ * @param {string} entryPoint - entrypoint of event, either MCP or vscode
+ * @param {string} toolName - name of the tool
+ * @param {string} error - error message if it failed
+ * @param {Object} params - any parameters associated with the tool call. Disctionary
+ */
+function pushToolEvent(entryPoint, toolName, err, params) {
+    const paramsStr = JSON.stringify(params);
+
+    pushToolEventWrapper(entryPoint, toolName, err, paramsStr);
+}
+
+/**
+ * check if new library is available
+ *
+ * @param {string} component - NAme of component
+ */
+function checkForUpdate(component) {
+    checkForUpdateWrapper(component)
+}
+
 module.exports = {
   createTestDescriptionFromScenario,
   getYamlBytes,
@@ -203,5 +228,7 @@ module.exports = {
   getValue,
   checkSchema,
   iterate,
+  pushToolEvent,
+  checkForUpdate,
   SKYRAMP_YAML_VERSION
 }