Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add ToriiQueryBuilder and ClauseBuilder #378

Merged
merged 2 commits into from
Jan 20, 2025
Merged

feat: add ToriiQueryBuilder and ClauseBuilder #378

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f335d0
feat: add ToriiQueryBuilder and ClauseBuilder
MartianGreed Jan 17, 2025
2af1d00
feat: add experimental example
MartianGreed Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .changeset/witty-moons-care.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
"@dojoengine/sdk": patch
"@dojoengine/core": patch
"@dojoengine/create-burner": patch
"@dojoengine/create-dojo": patch
"@dojoengine/predeployed-connector": patch
"@dojoengine/react": patch
"@dojoengine/state": patch
"@dojoengine/torii-client": patch
"@dojoengine/torii-wasm": patch
"@dojoengine/utils": patch
"@dojoengine/utils-wasm": patch
---

Added experimental ToriiQueryBuilder and ClauseBuilder to be closer to how we should query ECS through torii
42 changes: 0 additions & 42 deletions examples/example-vite-react-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,45 +6,3 @@ Currently, two official plugins are available:

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

## Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

- Configure the top-level `parserOptions` property like this:

```js
export default tseslint.config({
languageOptions: {
// other options...
parserOptions: {
project: ["./tsconfig.node.json", "./tsconfig.app.json"],
tsconfigRootDir: import.meta.dirname,
},
},
});
```

- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
- Optionally add `...tseslint.configs.stylisticTypeChecked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:

```js
// eslint.config.js
import react from "eslint-plugin-react";

export default tseslint.config({
// Set the react version
settings: { react: { version: "18.3" } },
plugins: {
// Add the react plugin
react,
},
rules: {
// other rules...
// Enable its recommended rules
...react.configs.recommended.rules,
...react.configs["jsx-runtime"].rules,
},
});
```
22 changes: 21 additions & 1 deletion examples/example-vite-react-sdk/src/App.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,26 @@ function App() {
return BigInt(0);
}, [account]);

// This is experimental feature.
// Use those queries if you want to be closer to how you should query your ecs system with torii
// useEffect(() => {
// async function fetchToriiClause() {
// const res = await sdk.client.getEntities(
// new ToriiQueryBuilder()
// .withClause(
// new ClauseBuilder()
// .keys([], [undefined], "VariableLen")
// .build()
// )
// .withLimit(2)
// .addOrderBy(ModelsMapping.Moves, "remaining", "Desc")
// .build()
// );
// return res;
// }
// fetchToriiClause().then(console.log);
// });

useEffect(() => {
let unsubscribe: (() => void) | undefined;

Expand Down Expand Up @@ -248,7 +268,7 @@ function App() {
className="text-gray-300"
>
<td className="border border-gray-700 p-2">
{entityId}
{addAddressPadding(entityId)}
</td>
<td className="border border-gray-700 p-2">
{position?.player ?? "N/A"}
Expand Down
211 changes: 211 additions & 0 deletions packages/sdk/src/__tests__/clauseBuilder.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
import { describe, expect, it } from "vitest";
import { ClauseBuilder } from "../clauseBuilder";
import {
ComparisonOperator,
LogicalOperator,
PatternMatching,
} from "@dojoengine/torii-client";
import { SchemaType } from "../types";

// Test models interface
interface TestModels extends SchemaType {
dojo_starter: {
Moves: {
fieldOrder: string[];
remaining: number;
player: string;
};
Position: {
fieldOrder: string[];
x: number;
y: number;
};
GameState: {
fieldOrder: string[];
active: boolean;
score: number;
gameId: string;
};
};
}

describe("ClauseBuilder", () => {
describe("whereKeys", () => {
it("should create a Keys clause with default pattern matching", () => {
const builder = new ClauseBuilder<TestModels>();
const clause = builder
.keys(["dojo_starter-Moves"], ["player1"])
.build();

expect(clause).toEqual({
Keys: {
keys: ["player1"],
pattern_matching: "FixedLen" as PatternMatching,
models: ["dojo_starter-Moves"],
},
});
});

it("should create a Keys clause with custom pattern matching", () => {
const builder = new ClauseBuilder<TestModels>();
const clause = builder
.keys(["dojo_starter-Moves"], ["player1"], "VariableLen")
.build();

expect(clause).toEqual({
Keys: {
keys: ["player1"],
pattern_matching: "VariableLen" as PatternMatching,
models: ["dojo_starter-Moves"],
},
});
});
});

describe("where", () => {
it("should create a Member clause with number value", () => {
const builder = new ClauseBuilder<TestModels>();
const clause = builder
.where("dojo_starter-Moves", "remaining", "Gt", 10)
.build();

expect(clause).toEqual({
Member: {
model: "dojo_starter-Moves",
member: "remaining",
operator: "Gt" as ComparisonOperator,
value: { Primitive: { U32: 10 } },
},
});
});

it("should create a Member clause with string value", () => {
const builder = new ClauseBuilder<TestModels>();
const clause = builder
.where("dojo_starter-Moves", "player", "Eq", "player1")
.build();

expect(clause).toEqual({
Member: {
model: "dojo_starter-Moves",
member: "player",
operator: "Eq" as ComparisonOperator,
value: { String: "player1" },
},
});
});
});

describe("compose", () => {
it("should create a composite OR then AND clause", () => {
const clause = new ClauseBuilder<TestModels>()
.compose()
.or([
new ClauseBuilder<TestModels>().where(
"dojo_starter-Position",
"x",
"Gt",
0
),
new ClauseBuilder<TestModels>().where(
"dojo_starter-Position",
"y",
"Gt",
0
),
])
.and([
new ClauseBuilder<TestModels>().where(
"dojo_starter-GameState",
"active",
"Eq",
true
),
])
.build();

expect(clause).toEqual({
Composite: {
operator: "And",
clauses: [
{
Member: {
model: "dojo_starter-GameState",
member: "active",
operator: "Eq" as ComparisonOperator,
value: { Primitive: { Bool: true } },
},
},
{
Composite: {
operator: "Or",
clauses: [
{
Member: {
model: "dojo_starter-Position",
member: "x",
operator:
"Gt" as ComparisonOperator,
value: { Primitive: { U32: 0 } },
},
},
{
Member: {
model: "dojo_starter-Position",
member: "y",
operator:
"Gt" as ComparisonOperator,
value: { Primitive: { U32: 0 } },
},
},
],
},
},
],
},
});
});

it("should handle single composite operation", () => {
const builder = new ClauseBuilder<TestModels>();
const clauseA = new ClauseBuilder<TestModels>().where(
"dojo_starter-Position",
"x",
"Gt",
0
);
const clauseB = new ClauseBuilder<TestModels>().where(
"dojo_starter-Position",
"y",
"Gt",
0
);

const clause = builder.compose().or([clauseA, clauseB]).build();

expect(clause).toEqual({
Composite: {
operator: "Or",
clauses: [
{
Member: {
model: "dojo_starter-Position",
member: "x",
operator: "Gt" as ComparisonOperator,
value: { Primitive: { U32: 0 } },
},
},
{
Member: {
model: "dojo_starter-Position",
member: "y",
operator: "Gt" as ComparisonOperator,
value: { Primitive: { U32: 0 } },
},
},
],
},
});
});
});
});
Loading
Loading