stackql · yunchengyang515 · Dec 9, 2023 · Nov 11, 2023 · Nov 11, 2023 · Nov 11, 2023
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,25 @@
+name: Test
+
+on:
+  push:
+
+jobs:
+  test:
+    name: Test on Multiple OS
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Set up Deno
+        uses: denoland/setup-deno@v1
+        with:
+          deno-version: v1.x
+      - name: setup StackQL
+        uses: stackql/setup-stackql@v2.0.0
+        with:
+          use_wrapper: false
+      - name: Run tests
+        run: deno test --allow-net --allow-read --allow-write --allow-env --allow-run
diff --git a/.gitignore b/.gitignore
@@ -33,4 +33,5 @@ yarn-error.log*
 
 # typescript
 *.tsbuildinfo
-next-env.d.ts
+next-env.d.ts
+.stackql*
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,7 @@
+{
+  "deno.enable": true,
+  "deno.lint": true,
+  "deno.unstable": true,
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "denoland.vscode-deno"
+}
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 
 # stackqljs
 
-[__StackQL__](https://github.com/stackql/stackql) client library for Deno and Node.js that exposes all features StackQL.  
+[**StackQL**](https://github.com/stackql/stackql) client library for Deno and Node.js that exposes all features StackQL.
 
 ## Requirements
 
@@ -14,8 +14,18 @@
 - No dependencies
 - Works in server mode (as a pg wire protocol server client) as well as local mode where it is a wrapper for the `stackql` binary for the target platform
 - Exposes methods analagous to [`pystackql`](https://pystackql.readthedocs.io/en/latest/), including:
-    - `connect` - connect to a StackQL server - if in server mode
-    - `upgrade` - if in local mode, upgrade the local stackql binary from the latest release
-    - `execute` - execute a query returns an array of rows (objects)
-    - `executeStmt` - executes a statement and returns a string (like `REGISTRY PULL` or `INSERT ...`)
-    - `executeQueriesAsync` - executes a list of queries and returns an array of rows (objects) - queries need to return the same columns/schema
+  - `connect` - connect to a StackQL server - if in server mode
+  - `upgrade` - if in local mode, upgrade the local stackql binary from the latest release
+  - `execute` - execute a query returns an array of rows (objects)
+  - `executeStmt` - executes a statement and returns a string (like `REGISTRY PULL` or `INSERT ...`)
+  - `executeQueriesAsync` - executes a list of queries and returns an array of rows (objects) - queries need to return the same columns/schema
+
+## Test
+
+### Requirement
+
+- To run the tests locally, [install StackQL](https://stackql.io/docs/installing-stackql) first.
+
+```
+deno task test <optional: test file path>
+```
diff --git a/deno.json b/deno.json
@@ -0,0 +1,24 @@
+{
+  "lint": {
+    "include": ["src/"],
+    "exclude": ["src/testing/", "src/**/*.test.ts", "src/*test.ts/"],
+    "rules": {
+      "tags": ["recommended"],
+      "include": [],
+      "exclude": ["no-unused-vars", "ban-untagged-todo"]
+    }
+  },
+  "fmt": {
+    "useTabs": true,
+    "lineWidth": 80,
+    "indentWidth": 4,
+    "semiColons": false,
+    "singleQuote": true,
+    "proseWrap": "preserve",
+    "include": ["src/"],
+    "exclude": ["src/testdata/", "data/fixtures/**/*.ts"]
+  },
+  "tasks": {
+    "test": "deno test --allow-net --allow-read --allow-write --allow-env --allow-run"
+  }
+}
diff --git a/deno.lock b/deno.lock
diff --git a/deps.ts b/deps.ts
@@ -1 +1 @@
-export { bold } from "https://deno.land/std@0.206.0/fmt/colors.ts";
+export { bold } from "https://deno.land/std/fmt/colors.ts"
diff --git a/mod.ts b/mod.ts
@@ -1,5 +1,3 @@
-import { bold } from "./deps.ts";
+import { StackQL } from "./src/stackql.ts";
 
-export function getHelloWorld(): string {
-    return bold("Hello World");
-  }
+export { StackQL };
diff --git a/src/services/downloader.test.ts b/src/services/downloader.test.ts
@@ -0,0 +1,49 @@
+import { assertExists } from 'https://deno.land/std@0.206.0/assert/assert_exists.ts'
+import { Downloader } from './downloader.ts'
+import { removeStackQLDownload } from '../../testing/utils.ts'
+import {
+	assertSpyCalls,
+	spy,
+} from 'https://deno.land/std@0.207.0/testing/mock.ts'
+
+Deno.test('Downloader setupStackQL and upgrade Test', async () => {
+	// Arrange
+	await removeStackQLDownload()
+	const downloader = new Downloader()
+	let binaryPath: string
+	const denoOpenSpy = spy(Deno, 'open')
+
+	// Act
+	const setupTest = async () => {
+		try {
+			binaryPath = await downloader.setupStackQL()
+
+			// Assert
+			assertExists(binaryPath)
+			assertSpyCalls(denoOpenSpy, 1)
+			// Check if the binary exists after setupStackQL is called
+
+			console.log(
+				'Test passed: setupStackQL completed without errors and binary exists.',
+			)
+		} catch (error) {
+			console.error('Test failed:', error)
+			throw error // This will cause the test to fail
+		}
+	}
+
+	const upgradeTest = async () => {
+		try {
+			binaryPath = await downloader.upgradeStackQL()
+
+			assertExists(binaryPath)
+			assertSpyCalls(denoOpenSpy, 2)
+		} catch (error) {
+			console.error('Test failed:', error)
+			throw error // This will cause the test to fail
+		}
+	}
+
+	await setupTest()
+	await upgradeTest()
+})
diff --git a/src/services/downloader.ts b/src/services/downloader.ts
@@ -0,0 +1,189 @@
+import { join } from 'https://deno.land/std@0.133.0/path/mod.ts'
+import { SupportedOs } from '../types/platforms.ts'
+import { darwinUnpack, unzip } from './unpacker.ts'
+import osUtils from '../utils/os.ts'
+
+export class Downloader {
+	private os: string
+	private arch: string
+	private urlMap: Record<string, string>
+	constructor() {
+		this.os = Deno.build.os // 'linux', 'darwin', or 'windows'
+		this.arch = Deno.build.arch // 'x86_64', 'arm64', etc.
+
+		this.urlMap = {
+			[SupportedOs.Linux]:
+				'https://releases.stackql.io/stackql/latest/stackql_linux_amd64.zip',
+			[SupportedOs.Windows]:
+				'https://releases.stackql.io/stackql/latest/stackql_windows_amd64.zip',
+			[SupportedOs.Darwin]:
+				'https://storage.googleapis.com/stackql-public-releases/latest/stackql_darwin_multiarch.pkg',
+			// Additional OS-architecture combinations can be added here
+		}
+	}
+
+	private async downloadFile(url: string, downloadDir: string) {
+		const res = await fetch(url)
+		// create dir if not exists
+
+		const file = await Deno.open(downloadDir, { create: true, write: true })
+
+		try {
+			await res.body?.pipeTo(file.writable).finally(
+				() => file.close(), //TODO: fix bad resource id when closing file
+			)
+		} catch (error) {
+			console.error(`ERROR: [downloadFile] ${error.message}`)
+		}
+
+		console.log('Closed file')
+	}
+
+	private getUrl(): string {
+		const key = `${this.os}`
+		const url = this.urlMap[key]
+
+		if (!url) {
+			throw new Error(`Unsupported OS type: ${this.os}`)
+		}
+
+		return url
+	}
+
+	/**
+	 * Gets binary name
+	 * @returns  binrary name
+	 */
+	private getBinaryName() {
+		const binaryMap: Record<SupportedOs, string> = {
+			[SupportedOs.Windows]: 'stackql.exe',
+			[SupportedOs.Darwin]: 'stackql/Payload/stackql',
+			[SupportedOs.Linux]: 'stackql', // Default case for Linux and other platforms
+		}
+		const os = Deno.build.os.toLowerCase()
+
+		if (!Object.values(SupportedOs).includes(os as SupportedOs)) {
+			throw new Error(`Unsupported OS type: ${os}`)
+		}
+
+		const binaryOs = os as SupportedOs
+		return binaryMap[binaryOs]
+	}
+
+	private async createDownloadDir(downloadDir: string) {
+		try {
+			const stat = await Deno.stat(downloadDir)
+			if (!stat.isDirectory) {
+				await Deno.mkdir(downloadDir, { recursive: true })
+			}
+		} catch (error) {
+			if (error instanceof Deno.errors.NotFound) {
+				await Deno.mkdir(downloadDir, { recursive: true })
+			} else {
+				throw error
+			}
+		}
+	}
+	/**
+	 * Gets download dir
+	 * @returns download dir
+	 */
+	private getDownloadDir(): string {
+		const projectDir = Deno.cwd()
+
+		if (!projectDir) {
+			throw new Error('Unable to determine the project directory.')
+		}
+
+		const downloadDir = join(projectDir, '.stackql')
+
+		return downloadDir
+	}
+
+	private binaryExists(binaryName: string, downloadDir: string): boolean {
+		const binPath = join(downloadDir, binaryName)
+		try {
+			Deno.statSync(binPath)
+			return true
+		} catch (error) {
+			if (error instanceof Deno.errors.NotFound) {
+				return false
+			}
+			throw error
+		}
+	}
+	private async installStackQL(downloadDir: string) {
+		const url = this.getUrl()
+
+		const archiveFileName = `${downloadDir}/${url.split('/').pop()}`
+		await this.downloadFile(url, archiveFileName)
+
+		console.log('Unpacking stackql binary')
+		const unpacker = Deno.build.os === 'darwin' ? darwinUnpack : unzip
+		await unpacker({ downloadDir, archiveFileName })
+	}
+
+	private async setExecutable(binaryPath: string) {
+		const allowExecOctal = 0o755
+		await osUtils.chomod(binaryPath, allowExecOctal)
+	}
+
+	private async downloadAndInstallStackQL({
+		downloadDir,
+		binaryName,
+	}: {
+		downloadDir: string
+		binaryName: string
+	}) {
+		const binaryPath = join(downloadDir, binaryName)
+		await this.installStackQL(downloadDir)
+		await this.setExecutable(binaryPath)
+		return binaryPath
+	}
+	/**
+	 * Setup stackql binary, check if binary exists, if not download it
+	 */
+	public async setupStackQL() {
+		try {
+			const binaryName = this.getBinaryName()
+			const downloadDir = this.getDownloadDir()
+			await this.createDownloadDir(downloadDir)
+
+			let binaryPath = join(downloadDir, binaryName)
+
+			if (this.binaryExists(binaryName, downloadDir)) {
+				await this.setExecutable(binaryPath)
+				return binaryPath
+			}
+
+			binaryPath = await this.downloadAndInstallStackQL({
+				downloadDir,
+				binaryName,
+			})
+			return binaryPath
+		} catch (error) {
+			console.error(`ERROR: [setup] ${error.message}`)
+			Deno.exit(1)
+		}
+	}
+
+	private async removeStackQL() {
+		const downloadDir = this.getDownloadDir()
+		await Deno.remove(join(downloadDir, '/'), { recursive: true })
+		console.log('stackql download dir removed')
+	}
+
+	public async upgradeStackQL() {
+		if (Deno.build.os === 'darwin') {
+			await this.removeStackQL()
+		}
+		const binaryName = this.getBinaryName()
+		const downloadDir = this.getDownloadDir()
+		await this.createDownloadDir(downloadDir)
+		const binaryPath = await this.downloadAndInstallStackQL({
+			downloadDir,
+			binaryName,
+		})
+		return binaryPath
+	}
+}
diff --git a/src/services/server.test.ts b/src/services/server.test.ts
@@ -0,0 +1,14 @@
+import { Server } from './server.ts'
+import { assert } from 'https://deno.land/std@0.207.0/assert/assert.ts'
+import { startStackQLServer } from '../../testing/utils.ts'
+
+Deno.test('Successful Connection', async () => {
+	const { closeProcess } = await startStackQLServer()
+	const server = new Server()
+	const pg = await server.connect(
+		'postgres://postgres:password@localhost:5444/postgres',
+	)
+	assert(pg)
+	await server.close()
+	await closeProcess()
+})
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		export { bold } from "https://deno.land/std@0.206.0/fmt/colors.ts";
		export { bold } from "https://deno.land/std/fmt/colors.ts"