refactor: versioning and migration mechanism for public data structures (#3457)

Co-authored-by: jamesgeorge007 <jamesgeorge998001@gmail.com>

packages/hoppscotch-data/src/environment/index.ts

@@ -0,0 +1,103 @@
+import * as E from "fp-ts/Either"
+import { pipe } from "fp-ts/function"
+import { InferredEntity, createVersionedEntity } from "verzod"
+
+import V0_VERSION from "./v/0"
+
+export const Environment = createVersionedEntity({
+  latestVersion: 0,
+  versionMap: {
+    0: V0_VERSION
+  },
+  getVersion(x) {
+    return V0_VERSION.schema.safeParse(x).success
+      ? 0
+      : null
+  }
+})
+
+export type Environment = InferredEntity<typeof Environment>
+
+const REGEX_ENV_VAR = /<<([^>]*)>>/g // "<<myVariable>>"
+
+/**
+ * How much times can we expand environment variables
+ */
+const ENV_MAX_EXPAND_LIMIT = 10
+
+/**
+ * Error state when there is a suspected loop while
+ * recursively expanding variables
+ */
+const ENV_EXPAND_LOOP = "ENV_EXPAND_LOOP" as const
+
+export function parseBodyEnvVariablesE(
+  body: string,
+  env: Environment["variables"]
+) {
+  let result = body
+  let depth = 0
+
+  while (result.match(REGEX_ENV_VAR) != null && depth <= ENV_MAX_EXPAND_LIMIT) {
+    result = result.replace(REGEX_ENV_VAR, (key) => {
+      const found = env.find(
+        (envVar) => envVar.key === key.replace(/[<>]/g, "")
+      )
+      return found ? found.value : key
+    })
+
+    depth++
+  }
+
+  return depth > ENV_MAX_EXPAND_LIMIT
+    ? E.left(ENV_EXPAND_LOOP)
+    : E.right(result)
+}
+
+/**
+ * @deprecated Use `parseBodyEnvVariablesE` instead.
+ */
+export const parseBodyEnvVariables = (
+  body: string,
+  env: Environment["variables"]
+) =>
+  pipe(
+    parseBodyEnvVariablesE(body, env),
+    E.getOrElse(() => body)
+  )
+
+export function parseTemplateStringE(
+  str: string,
+  variables: Environment["variables"]
+) {
+  if (!variables || !str) {
+    return E.right(str)
+  }
+
+  let result = str
+  let depth = 0
+
+  while (result.match(REGEX_ENV_VAR) != null && depth <= ENV_MAX_EXPAND_LIMIT) {
+    result = decodeURI(encodeURI(result)).replace(
+      REGEX_ENV_VAR,
+      (_, p1) => variables.find((x) => x.key === p1)?.value || ""
+    )
+    depth++
+  }
+
+  return depth > ENV_MAX_EXPAND_LIMIT
+    ? E.left(ENV_EXPAND_LOOP)
+    : E.right(result)
+}
+
+/**
+ * @deprecated Use `parseTemplateStringE` instead
+ */
+export const parseTemplateString = (
+  str: string,
+  variables: Environment["variables"]
+) =>
+  pipe(
+    parseTemplateStringE(str, variables),
+    E.getOrElse(() => str)
+  )

packages/hoppscotch-data/src/environment/v/0.ts

@@ -0,0 +1,18 @@
+import { z } from "zod"
+import { defineVersion } from "verzod"
+
+export const V0_SCHEMA = z.object({
+  id: z.optional(z.string()),
+  name: z.string(),
+  variables: z.array(
+    z.object({
+      key: z.string(),
+      value: z.string(),
+    })
+  )
+})
+
+export default defineVersion({
+  initial: true,
+  schema: V0_SCHEMA
+})