@linebridge/bootloader 1.0.0

package/LICENSE

@@ -0,0 +1,29 @@
+Comty License
+Version 1.0
+
+Issued on: 01/01/2024
+
+1. Grant of Rights
+Under this Comty License, permission is hereby granted, free of charge, to any person obtaining a copy of the software and associated documentation files (the "Software"), to use, copy, modify, merge, publish, and distribute copies of the Software, subject to the following conditions:
+
+2. Non-Commercial Use
+The use of the Software is restricted solely to non-commercial purposes. The sale, leasing, renting, sublicensing, or any other form of commercial exploitation of the Software or its derivatives is not permitted.
+
+3. Distribution
+a. You may redistribute the Software in its original form or with modifications, provided that you retain this copyright notice and this Comty License in all copies or substantial portions of the Software.
+
+b. If you distribute modified versions of the Software, you must include a clear notice indicating the changes you made and the date of those changes.
+
+4. Derivatives
+a. The creation of derivative works based on the Software is permitted, provided that these derivative works are distributed under this same Comty License.
+
+b. Derivative works must clearly indicate that they have been modified from the original Software.
+
+5. Limitation of Liability
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+6. Termination
+This license and the rights granted herein will terminate automatically if you breach any of the terms of this Comty License. Upon termination, you must cease all use of the Software and destroy all copies you possess, whether modified or unmodified.
+
+7. Governing Law
+This Comty License shall be governed by and construed in accordance with the laws of Spain, without regard to its conflict of law principles.

package/bin

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("./run.cjs")

package/boot.cjs

@@ -0,0 +1,70 @@
+require("dotenv").config({
+	quiet: true,
+})
+
+const path = require("node:path")
+const Module = require("node:module")
+const Aliases = require("./libs/aliases.cjs")
+
+// Override file execution arg
+process.argv.splice(1, 1)
+process.argv[1] = path.resolve(process.argv[1])
+
+// Expose to global
+global["paths"] = {
+	root: process.env.ROOT_PATH ?? process.cwd(),
+	__src: path.resolve(
+		process.env.ROOT_PATH ?? process.cwd(),
+		path.dirname(process.argv[1]),
+	),
+}
+
+global["aliases"] = {
+	// expose src
+	"@": global.paths.__src,
+
+	// expose shared resources
+	"@db": path.resolve(global.paths.root, "db"),
+	"@db_models": path.resolve(global.paths.root, "db_models"),
+	"@shared-classes": path.resolve(global.paths.root, "classes"),
+	"@shared-middlewares": path.resolve(global.paths.root, "middlewares"),
+	"@shared-utils": path.resolve(global.paths.root, "utils"),
+	"@shared-lib": path.resolve(global.paths.root, "lib"),
+
+	// expose internal resources
+	"@classes": path.resolve(global.paths.__src, "classes"),
+	"@middlewares": path.resolve(global.paths.__src, "middlewares"),
+	"@routes": path.resolve(global.paths.__src, "routes"),
+	"@models": path.resolve(global.paths.__src, "models"),
+	"@config": path.resolve(global.paths.__src, "config"),
+	"@utils": path.resolve(global.paths.__src, "utils"),
+	"@lib": path.resolve(global.paths.__src, "lib"),
+
+	"@services": path.resolve(global.paths.root, "services"),
+}
+
+try {
+	// try to read the package.json
+	const packageJson = require(path.resolve(global.paths.root, "package.json"))
+
+	if (packageJson) {
+		if (typeof packageJson.aliases === "object") {
+			for (const [key, value] of Object.entries(packageJson.aliases)) {
+				global["aliases"][key] = path.resolve(global.paths.root, value)
+			}
+		}
+	}
+
+	// apply global functions & patches
+	require("./globals.cjs")
+	// use sucrase transcompiler
+	require("sucrase/register")
+
+	// Apply aliases
+	Aliases.registerBase(global.paths.__src, global["aliases"])
+
+	// execute main
+	Module.runMain()
+} catch (error) {
+	console.error("[BOOT] ❌ Boot error: ", error)
+}

package/boot_function.cjs

@@ -0,0 +1,48 @@
+const InfisicalLib = require("./libs/infisical.cjs")
+
+async function Boot(main) {
+	if (!main) {
+		throw new Error("main class is not defined")
+	}
+
+	console.log(
+		`[BOOT] Booting in [${global.isProduction ? "production" : "development"}] mode...`,
+	)
+
+	if (
+		InfisicalLib.client &&
+		process.env.INFISICAL_CLIENT_ID &&
+		process.env.INFISICAL_CLIENT_SECRET &&
+		typeof InfisicalLib.LoadFromEnv === "function"
+	) {
+		await InfisicalLib.LoadFromEnv()
+	}
+
+	const instance = new main()
+
+	process.on("exit", (code) => {
+		console.log(`[BOOT] Closing ...`)
+
+		instance._fireClose()
+	})
+
+	process.on("SIGTERM", () => {
+		process.exit(0)
+	})
+
+	process.on("SIGINT", () => {
+		process.exit(0)
+	})
+
+	await instance.run()
+
+	if (process.env.lb_service && process.send) {
+		process.send({
+			status: "ready",
+		})
+	}
+
+	return instance
+}
+
+module.exports = Boot

package/globals.cjs

@@ -0,0 +1,51 @@
+const { webcrypto: crypto } = require("node:crypto")
+const { Buffer } = require("node:buffer")
+
+global.isProduction = process.env.NODE_ENV === "production"
+
+global.b64Decode = (data) => {
+	return Buffer.from(data, "base64").toString("utf-8")
+}
+global.b64Encode = (data) => {
+	return Buffer.from(data, "utf-8").toString("base64")
+}
+
+global.nanoid = (t = 21) =>
+	crypto
+		.getRandomValues(new Uint8Array(t))
+		.reduce(
+			(t, e) =>
+				(t +=
+					(e &= 63) < 36
+						? e.toString(36)
+						: e < 62
+							? (e - 26).toString(36).toUpperCase()
+							: e > 62
+								? "-"
+								: "_"),
+			"",
+		)
+
+Array.prototype.updateFromObjectKeys = function (obj) {
+	this.forEach((value, index) => {
+		if (obj[value] !== undefined) {
+			this[index] = obj[value]
+		}
+	})
+
+	return this
+}
+
+global.ToBoolean = (value) => {
+	if (typeof value === "boolean") {
+		return value
+	}
+
+	if (typeof value === "string") {
+		return value.toLowerCase() === "true"
+	}
+
+	return false
+}
+
+global.Boot = require("./boot_function.cjs")

package/libs/aliases.cjs

@@ -0,0 +1,18 @@
+const path = require("node:path")
+const moduleAlias = require("module-alias")
+
+class Aliases {
+	static registerBase = (fromPath, customAliases = {}) => {
+		if (typeof fromPath === "undefined") {
+			if (module.parent.filename.includes("dist")) {
+				fromPath = path.resolve(process.cwd(), "dist")
+			} else {
+				fromPath = path.resolve(process.cwd(), "src")
+			}
+		}
+
+		moduleAlias.addAliases(customAliases)
+	}
+}
+
+module.exports = Aliases

package/libs/infisical.cjs

@@ -0,0 +1,51 @@
+class InfisicalLib {
+	static get client() {
+		try {
+			const mod = require("@infisical/sdk")
+
+			return mod.InfisicalSDK
+		} catch (e) {
+			return null
+		}
+	}
+
+	static LoadFromEnv = async () => {
+		if (!InfisicalLib.client) {
+			console.warn(
+				"WARN: Infisical client not found, skipping env injection...",
+			)
+			return null
+		}
+
+		const envMode =
+			(global.FORCE_ENV ?? global.isProduction) ? "prod" : "dev"
+
+		console.log(
+			`[BOOT] 🔑 Injecting env variables from INFISICAL in [${envMode}] mode...`,
+		)
+
+		const client = new InfisicalLib.client()
+
+		await client.auth().universalAuth.login({
+			clientId: process.env.INFISICAL_CLIENT_ID,
+			clientSecret: process.env.INFISICAL_CLIENT_SECRET,
+		})
+
+		const list = await client.secrets().listSecrets({
+			environment: envMode,
+			projectId: process.env.INFISICAL_PROJECT_ID ?? null,
+			secretPath: process.env.INFISICAL_PATH ?? "/",
+			includeImports: false,
+			attachToProcessEnv: false,
+		})
+
+		//inject to process.env
+		list.secrets.forEach((secret) => {
+			if (!process.env[secret.secretKey]) {
+				process.env[secret.secretKey] = secret.secretValue
+			}
+		})
+	}
+}
+
+module.exports = InfisicalLib

package/libs/watcher.cjs

@@ -0,0 +1,33 @@
+const chokidar = require("chokidar")
+const { minimatch } = require("minimatch")
+
+const defaultIgnored = [
+	"**/.cache/**",
+	"**/node_modules/**",
+	"**/dist/**",
+	"**/build/**",
+]
+
+class Watcher {
+	static create = async (fromPath, { onReload }) => {
+		console.log("[WATCHER] Starting watching path >", fromPath)
+
+		global._watcher = chokidar.watch(fromPath, {
+			ignored: (path) =>
+				defaultIgnored.some((pattern) => minimatch(path, pattern)),
+			persistent: true,
+			ignoreInitial: true,
+			awaitWriteFinish: true,
+		})
+
+		global._watcher.on("all", (event, filePath) => {
+			console.log(`[WATCHER] Event [${event}] > ${filePath}`)
+
+			if (typeof onReload === "function") {
+				onReload()
+			}
+		})
+	}
+}
+
+module.exports = Watcher

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@linebridge/bootloader",
+  "version": "1.0.0",
+  "type": "commonjs",
+  "main": "./run.cjs",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "linebridge-boot": "./bin"
+  },
+  "dependencies": {
+    "chokidar": "^5.0.0",
+    "dotenv": "^17.4.2",
+    "minimatch": "^10.2.6",
+    "module-alias": "^2.3.4",
+    "sucrase": "^3.35.1"
+  },
+  "peerDependencies": {
+    "@infisical/sdk": "^5.0.2"
+  },
+  "peerDependenciesMeta": {
+    "@infisical/sdk": {
+      "optional": true
+    }
+  }
+}

package/run.cjs

@@ -0,0 +1,56 @@
+const path = require("node:path")
+const childProcess = require("node:child_process")
+const Watcher = require("./libs/watcher.cjs")
+
+const bootloaderPath = path.resolve(__dirname, "boot.cjs")
+const mainModulePath = process.argv[2]
+
+if (!mainModulePath) {
+	console.error("[BOOT] No main script provided")
+	process.exit(1)
+}
+
+const mainModuleSrc = path.resolve(process.cwd(), path.dirname(mainModulePath))
+
+let childProcessInstance = null
+let reloadTimeout = null
+
+function selfReload() {
+	if (!childProcessInstance) {
+		console.error(
+			"[BOOT] Cannot self-reload. Missing childProcessInstance.",
+		)
+		return process.exit(0)
+	}
+
+	console.log("[BOOT] Reloading...")
+
+	childProcessInstance.kill()
+
+	runFork()
+}
+
+function selfReloadDebounce() {
+	if (reloadTimeout) {
+		clearTimeout(reloadTimeout)
+	}
+
+	reloadTimeout = setTimeout(selfReload, 300)
+}
+
+function runFork() {
+	childProcessInstance = childProcess.fork(bootloaderPath, [mainModulePath], {
+		stdio: "inherit",
+	})
+}
+
+// if --watch flag exist, start file watcher
+if (process.argv.includes("--watch")) {
+	Watcher.create(mainModuleSrc, {
+		onReload: selfReloadDebounce,
+	})
+
+	runFork()
+} else {
+	require(bootloaderPath)
+}