Multi-node client

.github/workflows/ci.yml

@@ -1,26 +1,40 @@
 name: CI
 
 on:
+  workflow_dispatch:
   push:
     branches:
       - main
+    paths-ignore:
+      - '**/*.md'
   pull_request:
     branches:
       - main
+    paths-ignore:
+      - '**/*.md'
 
 jobs:
   tests:
-    runs-on: "${{ matrix.platform.os }}-latest"
+    runs-on: '${{ matrix.platform.os }}-latest'
     strategy:
       matrix:
-        platform: [
-          { os: "ubuntu", target: "x86_64-unknown-linux-gnu" },
-          { os: "ubuntu", target: "wasm32-unknown-unknown" },
-        ]
-    env:
-      # used to connect to httpmock
-      URL: "http://localhost:5000"
-      API_KEY: "VerySecretKey"
+        platform:
+          [
+            { os: 'ubuntu', target: 'x86_64-unknown-linux-gnu' },
+            { os: 'ubuntu', target: 'wasm32-unknown-unknown' },
+          ]
+    services:
+      typesense:
+        image: typesense/typesense:30.0.rc10
+        ports:
+          - 8108:8108/tcp
+        volumes:
+          - /tmp/typesense-server-data:/data
+        env:
+          TYPESENSE_DATA_DIR: '/data'
+          TYPESENSE_API_KEY: 'xyz'
+          TYPESENSE_ENABLE_CORS: true
+          TYPESENSE_URL: 'http://localhost:8108'
     steps:
       - uses: actions/checkout@v4
       - name: Cache .cargo and target
@@ -38,16 +52,9 @@ jobs:
           target: ${{ matrix.platform.target }}
           profile: minimal
           default: true
-      - name: Install httpmock
-        uses: actions-rs/cargo@v1
-        with:
-          command: install
-          args: --features standalone -- httpmock
-      - name: Run httpmock
-        run: httpmock --expose --mock-files-dir=./mocks &
       - name: Install test runner for wasm
         if: matrix.platform.target == 'wasm32-unknown-unknown'
-        run:  curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
+        run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
       - name: Stable Build
         uses: actions-rs/cargo@v1
         with:

.github/workflows/lint.yml

@@ -1,16 +1,23 @@
 name: Lint checks
 
 on:
+  workflow_dispatch:
   push:
-    branches: [ main ]
+    branches:
+      - main
+    paths-ignore:
+      - '**/*.md'
   pull_request:
-    branches: [ main ]
+    branches:
+      - main
+    paths-ignore:
+      - '**/*.md'
 
 jobs:
   lint:
     runs-on: ubuntu-latest
     env:
-      TZ: "/usr/share/zoneinfo/your/location"
+      TZ: '/usr/share/zoneinfo/your/location'
     steps:
       - uses: actions/checkout@v4
       - name: Cache .cargo and target
@@ -28,11 +35,11 @@ jobs:
           profile: minimal
           default: true
       - run: rustup component add rustfmt
-      - name: Check formt
+      - name: Check format
         uses: actions-rs/cargo@v1
         with:
           command: fmt
-          args: --all -- --check
+          args: -- --check
       - run: rustup component add clippy
       - name: Run clippy
         uses: actions-rs/cargo@v1

Cargo.toml

@@ -16,6 +16,20 @@ repository = "https://github.com/typesense/typesense-rust"
 authors = ["Typesense  <contact@typesense.org>"]
 
 [workspace.dependencies]
-
-typesense_derive = { path = "./typesense_derive", version = "0.3.0" }
-typesense_codegen = { path = "./typesense_codegen", version = "0.25.0" }
+typesense_codegen = { path = "./typesense_codegen", version = "0.25" }
+typesense_derive = { path = "./typesense_derive", version = "0.3" }
+anyhow = "1"
+base64 = "0.22"
+bon = "3"
+clap = { version = "4", features = ["derive"] }
+debug_unsafe = "0.1"
+hmac = "0.12"
+reqwest-retry = "0.7"
+serde = { version = "1", features = ["derive"] }
+serde_json = "1.0"
+serde_repr = "0.1"
+serde_yaml = "0.9"
+sha2 = "0.10"
+thiserror = "2"
+url = "2"
+web-time = "=1.1.0"

README.md

@@ -5,14 +5,40 @@
 
 Rust client library for Typesense | Work In Progress & Help Wanted!
 
-OpenAPI codegen folder was generated with:
+### Development
+
+When updating or adding new parameters and endpoints, make changes directly in the [Typesense API spec repository](https://github.com/typesense/typesense-api-spec).
+
+Once your changes are merged, you can update this project as follows (you can also run tasks individually):
+
+```bash
+cargo xtask fetch code-gen
+```
+
+This will:
+
+- Download the latest API spec.
+- Write it to our local [`openapi.yml`](./openapi.yml).
+- Preprocess it into [`preprocessed_openapi.yml`](./preprocessed_openapi.yml).
+- Regenerate the `/typesense_codegen` crate.
+
+The preprocessing step does two things:
+
+- Flatten the URL params defined as objects into individual URL parameters (in [`preprocess_openapi.rs`](xtask/src/preprocess_openapi.rs))
+- Inject OpenAPI vendor attributes (e.g., generic parameters, schema builders) into the spec before code generation (in [`add_vendor_attributes.rs`](./xtask/src/add_vendor_attributes.rs))
+
+You can also run `code-gen` directly through Docker:
 
 ```
 docker run --rm \
     -v $PWD:/local openapitools/openapi-generator-cli generate \
-    -i /local/openapi.yml \
+    -i /local/preprocessed_openapi.yml \
     -g rust \
-    -o /local/typesense_codegen_new
+    -o /local/typesense_codegen \
+    -t /local/openapi-generator-template \
+    --additional-properties library=reqwest \
+    --additional-properties supportMiddleware=true \
+    --additional-properties useSingleRequestParameter=true
 ```
 
-If you'd like to contribute, please join our [Slack Community](https://join.slack.com/t/typesense-community/shared_invite/zt-mx4nbsbn-AuOL89O7iBtvkz136egSJg) and say hello! 
+If you'd like to contribute, please join our [Slack Community](https://join.slack.com/t/typesense-community/shared_invite/zt-mx4nbsbn-AuOL89O7iBtvkz136egSJg) and say hello!

compose.yml

@@ -1,6 +1,6 @@
 services:
   typesense:
-    image: typesense/typesense:29.0
+    image: typesense/typesense:30.0.rc10
     restart: on-failure
     ports:
       - '8108:8108'

openapi-generator-template/README.mustache

@@ -0,0 +1,54 @@
+# Rust API client for {{{packageName}}}
+
+{{#appDescriptionWithNewLines}}
+{{{.}}}
+{{/appDescriptionWithNewLines}}
+
+{{#infoUrl}}
+For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
+{{/infoUrl}}
+
+## Overview
+
+This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
+
+- API version: {{{appVersion}}}
+- Package version: {{{packageVersion}}}
+{{^hideGenerationTimestamp}}
+- Build date: {{{generatedDate}}}
+{{/hideGenerationTimestamp}}
+- Generator version: {{generatorVersion}}
+- Build package: `{{{generatorClass}}}`
+
+## Installation
+
+Put the package under your project folder in a directory named `{{packageName}}` and add the following to `Cargo.toml` under `[dependencies]`:
+
+```
+{{{packageName}}} = { path = "./{{{packageName}}}" }
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *{{{basePath}}}*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{{classname}}}* | [**{{{operationId}}}**]({{{apiDocPath}}}{{classname}}.md#{{{operationIdLowerCase}}}) | **{{{httpMethod}}}** {{{path}}} | {{{summary}}}
+{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
+
+## Documentation For Models
+
+{{#models}}{{#model}} - [{{{classname}}}]({{{modelDocPath}}}{{{classname}}}.md)
+{{/model}}{{/models}}
+
+To get access to the crate's generated documentation, use:
+
+```
+cargo doc --open
+```
+
+## Author
+
+{{#apiInfo}}{{#apis}}{{#-last}}{{{infoEmail}}}
+{{/-last}}{{/apis}}{{/apiInfo}}