Update CI scripts for dotenv management (#508)

* Replace DOTENV python script by TS script

* Add script to update .env.local locally

* add back secrets in actions flow

.github/workflows/deploy-release.yml

@@ -8,26 +8,21 @@ on:
 
 jobs:
   update-env:
-    name: "Update production environment config"
     runs-on: ubuntu-latest
+    timeout-minutes: 10
 
     steps:
-      - name: checkout repo content
-        uses: actions/checkout@v3 # checkout the repository content to github runner.
-      - name: setup python
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          python-version: 3.11 #install the python needed
-      - name: "Install dependencies"
-        run: |
-          python -m pip install --upgrade pip
-          pip install huggingface_hub
-      - name: Update .env.local # run file
+          node-version: "18"
+          cache: "npm"
+      - run: npm install ci
+      - name: "Update DOTENV_LOCAL in prod"
         env:
           HF_TOKEN: ${{ secrets.HF_TOKEN }}
           SECRET_CONFIG: ${{ secrets.SECRET_CONFIG }}
-        run: |
-          python update_env.py
+        run: npm run updateProdEnv
   sync-to-hub:
     runs-on: ubuntu-latest
     steps:

.gitignore

@@ -9,3 +9,4 @@ node_modules
 !.env.template
 vite.config.js.timestamp-*
 vite.config.ts.timestamp-*
+SECRET_CONFIG

package-lock.json

@@ -49,6 +49,7 @@
 				"prettier-plugin-tailwindcss": "^0.2.7",
 				"svelte": "^4.0.0",
 				"svelte-check": "^3.4.3",
+				"ts-node": "^10.9.1",
 				"tslib": "^2.4.1",
 				"typescript": "^5.0.0",
 				"unplugin-icons": "^0.16.1",
@@ -91,6 +92,28 @@
 				"url": "https://github.com/sponsors/antfu"
 			}
 		},
+		"node_modules/@cspotcode/source-map-support": {
+			"version": "0.8.1",
+			"resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz",
+			"integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==",
+			"devOptional": true,
+			"dependencies": {
+				"@jridgewell/trace-mapping": "0.3.9"
+			},
+			"engines": {
+				"node": ">=12"
+			}
+		},
+		"node_modules/@cspotcode/source-map-support/node_modules/@jridgewell/trace-mapping": {
+			"version": "0.3.9",
+			"resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz",
+			"integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==",
+			"devOptional": true,
+			"dependencies": {
+				"@jridgewell/resolve-uri": "^3.0.3",
+				"@jridgewell/sourcemap-codec": "^1.4.10"
+			}
+		},
 		"node_modules/@esbuild/android-arm": {
 			"version": "0.17.16",
 			"resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.17.16.tgz",
@@ -1007,6 +1030,30 @@
 				"node": ">= 10"
 			}
 		},
+		"node_modules/@tsconfig/node10": {
+			"version": "1.0.9",
+			"resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.9.tgz",
+			"integrity": "sha512-jNsYVVxU8v5g43Erja32laIDHXeoNvFEpX33OK4d6hljo3jDhCBDhx5dhCCTMWUojscpAagGiRkBKxpdl9fxqA==",
+			"devOptional": true
+		},
+		"node_modules/@tsconfig/node12": {
+			"version": "1.0.11",
+			"resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz",
+			"integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==",
+			"devOptional": true
+		},
+		"node_modules/@tsconfig/node14": {
+			"version": "1.0.3",
+			"resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz",
+			"integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==",
+			"devOptional": true
+		},
+		"node_modules/@tsconfig/node16": {
+			"version": "1.0.4",
+			"resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.4.tgz",
+			"integrity": "sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==",
+			"devOptional": true
+		},
 		"node_modules/@types/chai": {
 			"version": "4.3.5",
 			"resolved": "https://registry.npmjs.org/@types/chai/-/chai-4.3.5.tgz",
@@ -1435,7 +1482,7 @@
 			"version": "8.10.0",
 			"resolved": "https://registry.npmjs.org/acorn/-/acorn-8.10.0.tgz",
 			"integrity": "sha512-F0SAmZ8iUtS//m8DmCTA0jlh6TDKkHQyK6xc6V4KDTyZKA9dnvX9/3sRTVQrWm79glUAZbnmmNcdYwUIHWVybw==",
-			"dev": true,
+			"devOptional": true,
 			"bin": {
 				"acorn": "bin/acorn"
 			},
@@ -1456,7 +1503,7 @@
 			"version": "8.2.0",
 			"resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.2.0.tgz",
 			"integrity": "sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA==",
-			"dev": true,
+			"devOptional": true,
 			"engines": {
 				"node": ">=0.4.0"
 			}
@@ -2045,6 +2092,12 @@
 				"node": ">= 0.6"
 			}
 		},
+		"node_modules/create-require": {
+			"version": "1.1.1",
+			"resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz",
+			"integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==",
+			"devOptional": true
+		},
 		"node_modules/cross-spawn": {
 			"version": "7.0.3",
 			"resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz",
@@ -2269,6 +2322,15 @@
 			"resolved": "https://registry.npmjs.org/didyoumean/-/didyoumean-1.2.2.tgz",
 			"integrity": "sha512-gxtyfqMg7GKyhQmb056K7M3xszy/myH8w+B4RT+QXBQsvAOdc3XymqDDPHx1BgPgsdAA5SIifona89YtRATDzw=="
 		},
+		"node_modules/diff": {
+			"version": "4.0.2",
+			"resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz",
+			"integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==",
+			"devOptional": true,
+			"engines": {
+				"node": ">=0.3.1"
+			}
+		},
 		"node_modules/dir-glob": {
 			"version": "3.0.1",
 			"resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz",
@@ -3570,6 +3632,12 @@
 				"node": ">=12"
 			}
 		},
+		"node_modules/make-error": {
+			"version": "1.3.6",
+			"resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz",
+			"integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==",
+			"devOptional": true
+		},
 		"node_modules/marked": {
 			"version": "4.3.0",
 			"resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz",
@@ -5772,6 +5840,55 @@
 			"resolved": "https://registry.npmjs.org/ts-interface-checker/-/ts-interface-checker-0.1.13.tgz",
 			"integrity": "sha512-Y/arvbn+rrz3JCKl9C4kVNfTfSm2/mEp5FSz5EsZSANGPSlQrpRI5M4PKF+mJnE52jOO90PnPSc3Ur3bTQw0gA=="
 		},
+		"node_modules/ts-node": {
+			"version": "10.9.1",
+			"resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.1.tgz",
+			"integrity": "sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw==",
+			"devOptional": true,
+			"dependencies": {
+				"@cspotcode/source-map-support": "^0.8.0",
+				"@tsconfig/node10": "^1.0.7",
+				"@tsconfig/node12": "^1.0.7",
+				"@tsconfig/node14": "^1.0.0",
+				"@tsconfig/node16": "^1.0.2",
+				"acorn": "^8.4.1",
+				"acorn-walk": "^8.1.1",
+				"arg": "^4.1.0",
+				"create-require": "^1.1.0",
+				"diff": "^4.0.1",
+				"make-error": "^1.1.1",
+				"v8-compile-cache-lib": "^3.0.1",
+				"yn": "3.1.1"
+			},
+			"bin": {
+				"ts-node": "dist/bin.js",
+				"ts-node-cwd": "dist/bin-cwd.js",
+				"ts-node-esm": "dist/bin-esm.js",
+				"ts-node-script": "dist/bin-script.js",
+				"ts-node-transpile-only": "dist/bin-transpile.js",
+				"ts-script": "dist/bin-script-deprecated.js"
+			},
+			"peerDependencies": {
+				"@swc/core": ">=1.2.50",
+				"@swc/wasm": ">=1.2.50",
+				"@types/node": "*",
+				"typescript": ">=2.7"
+			},
+			"peerDependenciesMeta": {
+				"@swc/core": {
+					"optional": true
+				},
+				"@swc/wasm": {
+					"optional": true
+				}
+			}
+		},
+		"node_modules/ts-node/node_modules/arg": {
+			"version": "4.1.3",
+			"resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz",
+			"integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==",
+			"devOptional": true
+		},
 		"node_modules/tslib": {
 			"version": "2.5.0",
 			"resolved": "https://registry.npmjs.org/tslib/-/tslib-2.5.0.tgz",
@@ -5826,7 +5943,7 @@
 			"version": "5.2.2",
 			"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.2.2.tgz",
 			"integrity": "sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w==",
-			"dev": true,
+			"devOptional": true,
 			"bin": {
 				"tsc": "bin/tsc",
 				"tsserver": "bin/tsserver"
@@ -5970,6 +6087,12 @@
 			"resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",
 			"integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw=="
 		},
+		"node_modules/v8-compile-cache-lib": {
+			"version": "3.0.1",
+			"resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz",
+			"integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==",
+			"devOptional": true
+		},
 		"node_modules/varint": {
 			"version": "5.0.2",
 			"resolved": "https://registry.npmjs.org/varint/-/varint-5.0.2.tgz",
@@ -6308,6 +6431,15 @@
 				"node": ">= 6"
 			}
 		},
+		"node_modules/yn": {
+			"version": "3.1.1",
+			"resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz",
+			"integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==",
+			"devOptional": true,
+			"engines": {
+				"node": ">=6"
+			}
+		},
 		"node_modules/yocto-queue": {
 			"version": "0.1.0",
 			"resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz",

package.json

@@ -11,7 +11,9 @@
 		"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
 		"lint": "prettier --plugin-search-dir . --check . && eslint .",
 		"format": "prettier --plugin-search-dir . --write .",
-		"test": "MONGODB_URL=mongodb://127.0.0.1:27017/ vitest"
+		"test": "MONGODB_URL=mongodb://127.0.0.1:27017/ vitest",
+		"updateLocalEnv": "npx ts-node --esm scripts/updateLocalEnv.ts",
+		"updateProdEnv": "npx ts-node --esm scripts/updateProdEnv.ts"
 	},
 	"devDependencies": {
 		"@iconify-json/carbon": "^1.1.16",
@@ -33,6 +35,7 @@
 		"prettier-plugin-tailwindcss": "^0.2.7",
 		"svelte": "^4.0.0",
 		"svelte-check": "^3.4.3",
+		"ts-node": "^10.9.1",
 		"tslib": "^2.4.1",
 		"typescript": "^5.0.0",
 		"unplugin-icons": "^0.16.1",

scripts/updateLocalEnv.ts

@@ -0,0 +1,20 @@
+import fs from "fs";
+
+const SECRET_CONFIG = fs.existsSync(".env.SECRET_CONFIG")
+	? fs.readFileSync(".env.SECRET_CONFIG", "utf8")
+	: process.env.SECRET_CONFIG;
+
+if (SECRET_CONFIG === "") {
+	throw new Error(
+		"SECRET_CONFIG is not defined. Please provide it either in a file or as an environment variable."
+	);
+}
+
+// Read the content of the file .env.template
+const PUBLIC_CONFIG = fs.readFileSync(".env.template", "utf8");
+
+// Prepend the content of the env variable SECRET_CONFIG
+const full_config = `${PUBLIC_CONFIG}\n${SECRET_CONFIG}`;
+
+// Write full_config to .env.local
+fs.writeFileSync(".env.local", full_config);

scripts/updateProdEnv.ts

@@ -0,0 +1,32 @@
+import fs from "fs";
+
+const HF_TOKEN = process.env.HF_TOKEN;
+const SECRET_CONFIG = fs.existsSync(".env.SECRET_CONFIG")
+	? fs.readFileSync(".env.SECRET_CONFIG", "utf8")
+	: process.env.SECRET_CONFIG;
+
+if (SECRET_CONFIG === "") {
+	throw new Error(
+		"SECRET_CONFIG is not defined. Please provide it either in a file or as an environment variable."
+	);
+}
+
+// Read the content of the file .env.template
+const PUBLIC_CONFIG = fs.readFileSync(".env.template", "utf8");
+
+// Prepend the content of the env variable SECRET_CONFIG
+const full_config = `${PUBLIC_CONFIG}\n${SECRET_CONFIG}`;
+
+// Make an HTTP POST request to add the space secre
+fetch(`https://huggingface.co/api/spaces/huggingchat/chat-ui/secrets`, {
+	method: "POST",
+	body: JSON.stringify({
+		key: "DOTENV_LOCAL",
+		value: full_config,
+		description: `Env variable for HuggingChat. Last updated ${new Date().toISOString()}`,
+	}),
+	headers: {
+		Authorization: `Bearer ${HF_TOKEN}`,
+		"Content-Type": "application/json",
+	},
+});

update_env.py

@@ -1,17 +0,0 @@
-import os
-from huggingface_hub import HfApi
-
-
-SECRET_CONFIG = os.environ["SECRET_CONFIG"]
-HF_TOKEN = os.environ["HF_TOKEN"]
-
-# Read the content of the file .env.template
-with open(".env.template", "r") as f:
-    PUBLIC_CONFIG = f.read()
-
-# Prepend the content of the env variable SECRET_CONFIG
-full_config = f"{PUBLIC_CONFIG}\n{SECRET_CONFIG}"
-
-api = HfApi()
-
-api.add_space_secret("huggingchat/chat-ui", "DOTENV_LOCAL", full_config, token=HF_TOKEN)