feat(scripting-revamp): chai powered assertions and postman compatibility layer (hoppscotch#5417)

Co-authored-by: nivedin <[email protected]>

Author: jamesgeorge007

packages/hoppscotch-cli/src/__tests__/e2e/fixtures/collections/scripting-revamp-coll.json

@@ -68,23 +68,36 @@ export const preRequestScriptRunner = (
       const { selected, global } = updatedEnvs;
 
       return {
-        updatedEnvs: <Environment>{
+        // Keep the original updatedEnvs with separate global and selected arrays
+        preRequestUpdatedEnvs: updatedEnvs,
+        // Create Environment format for getEffectiveRESTRequest
+        envForEffectiveRequest: <Environment>{
           name: "Env",
           variables: [...(selected ?? []), ...(global ?? [])],
         },
         updatedRequest: updatedRequest ?? {},
       };
     }),
-    TE.chainW(({ updatedEnvs, updatedRequest }) => {
+    TE.chainW(({ preRequestUpdatedEnvs, envForEffectiveRequest, updatedRequest }) => {
       const finalRequest = { ...request, ...updatedRequest };
 
       return TE.tryCatch(
-        () =>
-          getEffectiveRESTRequest(
+        async () => {
+          const result = await getEffectiveRESTRequest(
             finalRequest,
-            updatedEnvs,
+            envForEffectiveRequest,
             collectionVariables
-          ),
+          );
+          // Replace the updatedEnvs from getEffectiveRESTRequest with the one from pre-request script
+          // This preserves the global/selected separation
+          if (E.isRight(result)) {
+            return E.right({
+              ...result.right,
+              updatedEnvs: preRequestUpdatedEnvs,
+            });
+          }
+          return result;
+        },
         (reason) => error({ code: "PRE_REQUEST_SCRIPT_ERROR", data: reason })
       );
     }),

packages/hoppscotch-cli/src/utils/pre-request.ts

@@ -686,6 +686,8 @@
     "from_postman": "Import from Postman",
     "from_postman_description": "Import from Postman collection",
     "from_postman_import_summary": "Collections, Requests and response examples will be imported.",
+    "import_scripts": "Import scripts",
+    "import_scripts_description": "Supports Postman Collection v2.0/v2.1.",
     "from_url": "Import from URL",
     "gist_url": "Enter Gist URL",
     "from_har": "Import from HAR",
@@ -712,6 +714,9 @@
     "import_summary_pre_request_scripts_title": "Pre-request scripts",
     "import_summary_post_request_scripts_title": "Post request scripts",
     "import_summary_not_supported_by_hoppscotch_import": "We do not support importing {featureLabel} from this source right now.",
+    "import_summary_script_found": "script found but not imported",
+    "import_summary_scripts_found": "scripts found but not imported",
+    "import_summary_enable_experimental_sandbox": "To import Postman scripts, enable 'Experimental scripting sandbox' in settings. Note: This feature is experimental.",
     "cors_error_modal": {
       "title": "CORS Error Detected",
       "description": "The import failed due to CORS (Cross-Origin Resource Sharing) restrictions imposed by the server.",
@@ -1314,6 +1319,7 @@
     "download_failed": "Download failed",
     "download_started": "Download started",
     "enabled": "Enabled",
+    "experimental": "Experimental",
     "file_imported": "File imported",
     "finished_in": "Finished in {duration} ms",
     "hide": "Hide",

packages/hoppscotch-common/locales/en.json

@@ -59,7 +59,6 @@ import { GistSource } from "~/helpers/import-export/import/import-sources/GistSo
 import { TeamWorkspace } from "~/services/workspace.service"
 import { invokeAction } from "~/helpers/actions"
 
-const isPostmanImporterInProgress = ref(false)
 const isInsomniaImporterInProgress = ref(false)
 const isOpenAPIImporterInProgress = ref(false)
 const isRESTImporterInProgress = ref(false)
@@ -171,6 +170,7 @@ const emit = defineEmits<{
 const isHoppMyCollectionExporterInProgress = ref(false)
 const isHoppTeamCollectionExporterInProgress = ref(false)
 const isHoppGistCollectionExporterInProgress = ref(false)
+const isPostmanImporterInProgress = ref(false)
 
 const isTeamWorkspace = computed(() => {
   return props.collectionsType.type === "team-collections"
@@ -179,19 +179,83 @@ const isTeamWorkspace = computed(() => {
 const currentImportSummary: Ref<{
   showImportSummary: boolean
   importedCollections: HoppCollection[] | null
+  scriptsImported?: boolean
+  originalScriptCounts?: { preRequest: number; test: number }
 }> = ref({
   showImportSummary: false,
   importedCollections: null,
+  scriptsImported: false,
+  originalScriptCounts: undefined,
 })
 
-const setCurrentImportSummary = (collections: HoppCollection[]) => {
+const setCurrentImportSummary = (
+  collections: HoppCollection[],
+  scriptsImported?: boolean,
+  originalScriptCounts?: { preRequest: number; test: number }
+) => {
   currentImportSummary.value.importedCollections = collections
   currentImportSummary.value.showImportSummary = true
+  currentImportSummary.value.scriptsImported = scriptsImported
+  currentImportSummary.value.originalScriptCounts = originalScriptCounts
 }
 
 const unsetCurrentImportSummary = () => {
   currentImportSummary.value.importedCollections = null
   currentImportSummary.value.showImportSummary = false
+  currentImportSummary.value.scriptsImported = false
+  currentImportSummary.value.originalScriptCounts = undefined
+}
+
+// Count scripts in raw Postman collection JSON (before import strips them)
+const countPostmanScripts = (
+  content: string[]
+): { preRequest: number; test: number } => {
+  let preRequestCount = 0
+  let testCount = 0
+
+  const countInItem = (item: any) => {
+    // Only count if this is a request (has request object), not a folder
+    const isRequest = item?.request !== undefined
+
+    if (isRequest && item?.event) {
+      const prerequest = item.event.find((e: any) => e.listen === "prerequest")
+      const test = item.event.find((e: any) => e.listen === "test")
+
+      if (
+        prerequest?.script?.exec &&
+        Array.isArray(prerequest.script.exec) &&
+        prerequest.script.exec.some((line: string) => line?.trim())
+      ) {
+        preRequestCount++
+      }
+
+      if (
+        test?.script?.exec &&
+        Array.isArray(test.script.exec) &&
+        test.script.exec.some((line: string) => line?.trim())
+      ) {
+        testCount++
+      }
+    }
+
+    // Recursively count in nested items (folders)
+    if (item?.item && Array.isArray(item.item)) {
+      item.item.forEach(countInItem)
+    }
+  }
+
+  content.forEach((fileContent) => {
+    try {
+      const collection = JSON.parse(fileContent)
+      if (collection?.item && Array.isArray(collection.item)) {
+        collection.item.forEach(countInItem)
+      }
+    } catch (e) {
+      // Invalid JSON, skip
+    }
+  })
+
+  return { preRequest: preRequestCount, test: testCount }
 }
 
 const HoppRESTImporter: ImporterOrExporter = {
@@ -379,15 +443,20 @@ const HoppPostmanImporter: ImporterOrExporter = {
     caption: "import.from_file",
     acceptedFileTypes: ".json",
     description: "import.from_postman_import_summary",
-    onImportFromFile: async (content) => {
+    showPostmanScriptOption: true,
+    onImportFromFile: async (content: string[], importScripts?: boolean) => {
       isPostmanImporterInProgress.value = true
 
-      const res = await hoppPostmanImporter(content)()
+      // Count scripts from raw Postman JSON before importing
+      const originalCounts =
+        importScripts === undefined ? countPostmanScripts(content) : undefined
+
+      const res = await hoppPostmanImporter(content, importScripts ?? false)()
 
       if (E.isRight(res)) {
         await handleImportToStore(res.right)
 
-        setCurrentImportSummary(res.right)
+        setCurrentImportSummary(res.right, importScripts, originalCounts)
 
         platform.analytics?.logEvent({
           platform: "rest",

packages/hoppscotch-common/src/components/collections/ImportExport.vue

@@ -202,6 +202,8 @@ props.importerModules.forEach((importer) => {
       props: () => ({
         collections: importSummary.value.importedCollections,
         importFormat: importer.metadata.format,
+        scriptsImported: importSummary.value.scriptsImported,
+        originalScriptCounts: importSummary.value.originalScriptCounts,
         "on-close": () => {
           emit("hide-modal")
         },

packages/hoppscotch-common/src/components/importExport/Base.vue

@@ -52,13 +52,41 @@
         }}
       </template>
     </p>
+
+    <!-- Postman-specific: Script import checkbox (only use case so far) -->
+    <div
+      v-if="showPostmanScriptOption && experimentalScriptingEnabled"
+      class="flex items-start space-x-3 px-1"
+    >
+      <HoppSmartCheckbox
+        :on="importScripts"
+        @change="importScripts = !importScripts"
+      />
+      <label
+        for="importScriptsCheckbox"
+        class="cursor-pointer select-none text-secondary flex flex-col space-y-0.5"
+      >
+        <span class="font-semibold flex space-x-1">
+          <span>
+            {{ t("import.import_scripts") }}
+          </span>
+          <span class="text-tiny text-secondaryLight">
+            ({{ t("state.experimental") }})
+          </span>
+        </span>
+        <span class="text-tiny text-secondaryLight">
+          {{ t("import.import_scripts_description") }}</span
+        >
+      </label>
+    </div>
+
     <div>
       <HoppButtonPrimary
         :disabled="disableImportCTA"
         :label="t('import.title')"
         :loading="loading"
         class="w-full"
-        @click="emit('importFromFile', fileContent)"
+        @click="handleImport"
       />
     </div>
   </div>
@@ -69,23 +97,32 @@ import { useI18n } from "@composables/i18n"
 import { useToast } from "@composables/toast"
 import { computed, ref } from "vue"
 import { platform } from "~/platform"
+import { useSetting } from "~/composables/settings"
 
 const props = withDefaults(
   defineProps<{
     caption: string
     acceptedFileTypes: string
     loading?: boolean
     description?: string
+    showPostmanScriptOption?: boolean
   }>(),
   {
     loading: false,
     description: undefined,
+    showPostmanScriptOption: false,
   }
 )
 
 const t = useI18n()
 const toast = useToast()
 
+// Postman-specific: Script import state (only use case so far)
+const importScripts = ref(false)
+const experimentalScriptingEnabled = useSetting(
+  "EXPERIMENTAL_SCRIPTING_SANDBOX"
+)
+
 const ALLOWED_FILE_SIZE_LIMIT = platform.limits?.collectionImportSizeLimit ?? 10 // Default to 10 MB
 
 const importFilesCount = ref(0)
@@ -97,7 +134,7 @@ const fileContent = ref<string[]>([])
 const inputChooseFileToImportFrom = ref<HTMLInputElement | any>()
 
 const emit = defineEmits<{
-  (e: "importFromFile", content: string[]): void
+  (e: "importFromFile", content: string[], ...additionalArgs: any[]): void
 }>()
 
 // Disable the import CTA if no file is selected, the file size limit is exceeded, or during an import action indicated by the `isLoading` prop
@@ -106,6 +143,16 @@ const disableImportCTA = computed(
     !hasFile.value || showFileSizeLimitExceededWarning.value || props.loading
 )
 
+const handleImport = () => {
+  // If Postman script option is enabled AND experimental sandbox is enabled, pass the importScripts value
+  // Otherwise, don't pass it (undefined) to indicate the feature wasn't available
+  if (props.showPostmanScriptOption && experimentalScriptingEnabled.value) {
+    emit("importFromFile", fileContent.value, importScripts.value)
+  } else {
+    emit("importFromFile", fileContent.value)
+  }
+}
+
 const onFileChange = async () => {
   // Reset the state on entering the handler to avoid any stale state
   if (showFileSizeLimitExceededWarning.value) {