Merge pull request #18 from cipherstash/chore/add-linting-and-formatting

Chore: add linting and formatting

Author: CDThomas

.github/workflows/test.yml

@@ -63,7 +63,7 @@ jobs:
       - name: Build
         shell: bash
         run: npm run debug
-      - name: Test (unit)
+      - name: Test (typecheck, lint, & Rust)
         shell: bash
         run: npm test
       - name: Install integration test dependencies

README.md

@@ -76,7 +76,11 @@ Initiate a dry run of a patch release of this library via GitHub Actions. This p
 
 #### `npm test`
 
-Runs the unit tests by calling `cargo test`. You can learn more about [adding tests to your Rust code](https://doc.rust-lang.org/book/ch11-01-writing-tests.html) from the [Rust book](https://doc.rust-lang.org/book/).
+Formats and lints Rust and TypeScript code.
+Also runs Rust tests.
+
+Note: `npm test` at project root does not run integration tests.
+For integration tests, see [below](#integration-tests).
 
 ## Project Layout
 
@@ -86,6 +90,7 @@ The directory structure of this project is:
 protect-ffi/
 ├── Cargo.toml
 ├── README.md
+├── integration-tests/
 ├── lib/
 ├── src/
 |   ├── index.mts
@@ -99,40 +104,65 @@ protect-ffi/
 └── target/
 ```
 
-| Entry          | Purpose                                                                                                                                  |
-|----------------|------------------------------------------------------------------------------------------------------------------------------------------|
-| `Cargo.toml`   | The Cargo [manifest file](https://doc.rust-lang.org/cargo/reference/manifest.html), which informs the `cargo` command.                   |
-| `README.md`    | This file.                                                                                                                               |
-| `lib/`         | The directory containing the generated output from [tsc](https://typescriptlang.org).                                                    |
-| `src/`         | The directory containing the TypeScript source files.                                                                                    |
-| `index.mts`    | Entry point for when this library is loaded via [ESM `import`](https://nodejs.org/api/esm.html#modules-ecmascript-modules) syntax.       |
-| `index.cts`    | Entry point for when this library is loaded via [CJS `require`](https://nodejs.org/api/modules.html#requireid).                          |
-| `crates/`      | The directory tree containing the Rust source code for the project.                                                                      |
-| `lib.rs`       | Entry point for the Rust source code.                                                                                                          |
-| `platforms/`   | The directory containing distributions of the binary addon backend for each platform supported by this library.                          |
-| `package.json` | The npm [manifest file](https://docs.npmjs.com/cli/v7/configuring-npm/package-json), which informs the `npm` command.                    |
-| `target/`      | Binary artifacts generated by the Rust build.                                                                                            |
+| Entry                | Purpose                                                                                                                            |
+| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+| `Cargo.toml`         | The Cargo [manifest file](https://doc.rust-lang.org/cargo/reference/manifest.html), which informs the `cargo` command.             |
+| `README.md`          | This file.                                                                                                                         |
+| `integration-tests/` | The directory containing integration tests.                                              |
+| `lib/`               | The directory containing the generated output from [tsc](https://typescriptlang.org).                                              |
+| `src/`               | The directory containing the TypeScript source files.                                                                              |
+| `index.mts`          | Entry point for when this library is loaded via [ESM `import`](https://nodejs.org/api/esm.html#modules-ecmascript-modules) syntax. |
+| `index.cts`          | Entry point for when this library is loaded via [CJS `require`](https://nodejs.org/api/modules.html#requireid).                    |
+| `crates/`            | The directory tree containing the Rust source code for the project.                                                                |
+| `lib.rs`             | Entry point for the Rust source code.                                                                                              |
+| `platforms/`         | The directory containing distributions of the binary addon backend for each platform supported by this library.                    |
+| `package.json`       | The npm [manifest file](https://docs.npmjs.com/cli/v7/configuring-npm/package-json), which informs the `npm` command.              |
+| `target/`            | Binary artifacts generated by the Rust build.                                                                                      |
+
+## Integration tests
+
+Integration tests live in the `./integration-tests` directory.
+These tests use the local build of Rust and JavaScript artifacts to test `@cipherstash/protect-ffi` as API consumers would.
+
+These tests rely on CipherStash to be configured (via `.toml` config or environment variables).
+
+Example environment variables to set:
+```
+CS_CLIENT_ID=
+CS_CLIENT_KEY=
+CS_CLIENT_ACCESS_KEY=
+CS_WORKSPACE_ID=
+```
+
+To run integration tests:
+```
+npm run debug
+cd integration-tests
+npm run test
+```
 
 ## Releasing
 
 Releases are handled by GitHub Actions using a `workflow_dispatch` event trigger.
 The [release workflow](./.github/workflows/release.yml) was generated by [Neon](https://neon-rs.dev/).
 
 The release workflow is responsible for:
+
 - Building and publishing the main `@cipherstash/protect-ffi` package as well as the native packages for each platform (e.g. `@cipherstash/protect-ffi-darwin-arm64`).
 - Creating the GitHub release.
 - Creating a Git tag for the version.
 
 To perform a release:
+
 1. Navigate to the ["Release" workflow page](https://github.com/cipherstash/protect-ffi/actions/workflows/release.yml) in GitHub.
 1. Click on "Run workflow".
 1. Select the branch to release from.
-Use the default of "main" unless you want to do a pre-release version or dry run from a branch.
+   Use the default of `main` unless you want to do a pre-release version or dry run from a branch.
 1. Select whether or not to do a dry run.
-Dry runs are useful for verifying that the build will succeed for all platforms before doing a full run with a publish.
+   Dry runs are useful for verifying that the build will succeed for all platforms before doing a full run with a publish.
 1. Choose a version to publish.
-The options are similar to [`npm version`](https://docs.npmjs.com/cli/v11/commands/npm-version).
-Select "custom" in the dropdown and fill in the "Custom version" text box if you want to use a semver string instead of the shorthand (patch, minor, major, etc.).
+   The options are similar to [`npm version`](https://docs.npmjs.com/cli/v11/commands/npm-version).
+   Select "custom" in the dropdown and fill in the "Custom version" text box if you want to use a semver string instead of the shorthand (patch, minor, major, etc.).
 1. Click "Run workflow".
 
 Note that we currently don't have any automation around release notes or a changelog.

biome.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
   "files": {
-    "ignore": ["**/package.json", ".turbo/", "dist"]
+    "ignore": ["**/package.json", ".turbo/", "lib", "target"]
   },
   "formatter": {
     "indentStyle": "space",

crates/protect-ffi/src/encrypt_config.rs

@@ -158,7 +158,7 @@ impl FromStr for EncryptConfig {
 }
 
 impl EncryptConfig {
-    pub fn to_config_map(self) -> HashMap<Identifier, ColumnConfig> {
+    pub fn into_config_map(self) -> HashMap<Identifier, ColumnConfig> {
         let mut map = HashMap::new();
         for (table_name, columns) in self.tables.into_iter() {
             for (column_name, column) in columns.into_iter() {
@@ -211,7 +211,7 @@ mod tests {
 
     fn parse(json: serde_json::Value) -> HashMap<Identifier, ColumnConfig> {
         serde_json::from_value::<EncryptConfig>(json)
-            .map(|config| config.to_config_map())
+            .map(|config| config.into_config_map())
             .unwrap()
     }
 

crates/protect-ffi/src/lib.rs

@@ -133,7 +133,7 @@ async fn new_client_inner(encrypt_config: EncryptConfig) -> Result<Client, Error
     Ok(Client {
         cipher: Arc::new(cipher),
         zerokms,
-        encrypt_config: Arc::new(encrypt_config.to_config_map()),
+        encrypt_config: Arc::new(encrypt_config.into_config_map()),
     })
 }
 

integration-tests/tests/index.test.ts

@@ -1,8 +1,8 @@
-import { expect, test } from "vitest";
+import { expect, test } from 'vitest'
 
-import { newClient, encrypt, decrypt } from "@cipherstash/protect-ffi"
+import { decrypt, encrypt, newClient } from '@cipherstash/protect-ffi'
 
-test("can round-trip encrypt and decrypt", async () => {
+test('can round-trip encrypt and decrypt', async () => {
   const encryptConfig = {
     v: 1,
     tables: {
@@ -16,15 +16,13 @@ test("can round-trip encrypt and decrypt", async () => {
         },
       },
     },
-  };
+  }
 
-  const client = await newClient(
-    JSON.stringify(encryptConfig)
-  );
+  const client = await newClient(JSON.stringify(encryptConfig))
 
-  const ciphertext = await encrypt(client, "abc", "email", "users");
+  const ciphertext = await encrypt(client, 'abc', 'email', 'users')
 
-  const plaintext = await decrypt(client, JSON.parse(ciphertext).c);
+  const plaintext = await decrypt(client, JSON.parse(ciphertext).c)
 
-  expect(plaintext).toBe("abc");
-});
+  expect(plaintext).toBe('abc')
+})

integration-tests/tsconfig.json

@@ -1,7 +1,7 @@
 {
-    "extends": "../tsconfig.json",
-    "compilerOptions": {
-      "noEmit": true,
-    },
-    "include": ["tests/**/*.ts"],
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true
+  },
+  "include": ["tests/**/*.ts"]
 }

package-lock.json

@@ -4,7 +4,15 @@
   "description": "",
   "main": "./lib/index.cjs",
   "scripts": {
-    "test": "tsc &&cargo test",
+    "test": "npm run test:typecheck && npm run test:lint && npm run test:format && npm run test:rust",
+    "test:typecheck": "tsc",
+    "test:rust": "cargo test",
+    "test:lint": "npm run test:lint:rust && npm run test:lint:ts",
+    "test:lint:ts": "biome lint",
+    "test:lint:rust": "cargo clippy --all --no-deps --all-targets --all-features -- -D warnings",
+    "test:format": "npm run test:format:rust && npm run test:format:ts",
+    "test:format:ts": "biome format",
+    "test:format:rust": "cargo fmt --check",
     "cargo-build": "tsc &&cargo build --message-format=json-render-diagnostics > cargo.log",
     "cross-build": "tsc &&cross build --message-format=json-render-diagnostics > cross.log",
     "postcargo-build": "neon dist < cargo.log",
@@ -43,6 +51,7 @@
     "prefix": "protect-ffi-"
   },
   "devDependencies": {
+    "@biomejs/biome": "1.9.4",
     "@neon-rs/cli": "^0.1.82",
     "@tsconfig/node20": "^20.1.4",
     "@types/node": "^20.11.16",