Skip to content

Commit f0472c2

Browse files
backspacebackspace
committed
Merge branch 'main' into realm/sentry-cs-6602
2 parents 557188f + 0f70f81 commit f0472c2

File tree

307 files changed

+3819
-6206
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

307 files changed

+3819
-6206
lines changed

‎.github/workflows/ci.yaml

+13-9
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,16 @@ jobs:
2929
# This addition to each step causes the job to proceed even if one lint job fails so we can see all errors
3030
if: always()
3131
run: pnpm run lint
32-
working-directory: packages/boxel-motion
33-
- name: Lint Boxel Motion Test App
32+
working-directory: packages/boxel-motion/addon
33+
- name: Build Boxel Motion
34+
# To faciliate linting of projects that depend on Boxel Motion
3435
if: always()
35-
run: pnpm run lint
36-
working-directory: packages/boxel-motion-test-app
37-
- name: Lint Boxel Motion Demo App
36+
run: pnpm run build
37+
working-directory: packages/boxel-motion/addon
38+
- name: Lint Boxel Motion Test App
3839
if: always()
3940
run: pnpm run lint
40-
working-directory: packages/boxel-motion-demo-app
41+
working-directory: packages/boxel-motion/test-app
4142
- name: Lint Boxel UI
4243
if: always()
4344
run: pnpm run lint
@@ -86,9 +87,12 @@ jobs:
8687
steps:
8788
- uses: actions/checkout@v3
8889
- uses: ./.github/actions/init
89-
- name: Run Tests
90-
run: pnpm run test:ember
91-
working-directory: packages/boxel-motion-test-app
90+
- name: Build boxel-motion
91+
run: pnpm build
92+
working-directory: packages/boxel-motion/addon
93+
- name: Run test suite
94+
run: pnpm test
95+
working-directory: packages/boxel-motion/test-app
9296

9397
boxel-ui-test:
9498
name: Boxel UI Tests

‎.vscode/settings.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@
99
"editor.defaultFormatter": "esbenp.prettier-vscode",
1010
"editor.formatOnSave": true
1111
},
12-
"prettier.documentSelectors": ["**/*.gjs", "**/*.gts"]
12+
"prettier.documentSelectors": ["**/*.gjs", "**/*.gts"],
13+
"search.followSymlinks": false
1314
}

‎QUICKSTART.md

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Building the Repository
2+
3+
To build the entire repository and run the application, follow these steps:
4+
5+
1. The 2 main system dependencies to install are:
6+
7+
- [volta](https://docs.volta.sh/guide/getting-started)
8+
- [docker](https://docs.docker.com/get-docker/)
9+
- [pnpm](https://docs.volta.sh/advanced/pnpm) Note: If you don't have pnpm already on your system, **DON'T** install pnpm manually (volta will install it for you when you call `pnpm install`).
10+
11+
2. Clone the repo:
12+
13+
```zsh
14+
git clone https://github.com/cardstack/boxel.git
15+
```
16+
17+
3. Install the package dependencies:
18+
19+
```zsh
20+
echo 'export VOLTA_FEATURE_PNPM=1"' >> ~/.profile && source ~/.profile
21+
pnpm install
22+
```
23+
24+
4. Build the boxel-ui:
25+
26+
```zsh
27+
cd ./packages/boxel-ui/addon
28+
pnpm rebuild:icons
29+
pnpm build
30+
```
31+
32+
5. Build the host:
33+
34+
```zsh
35+
cd ./packages/host
36+
pnpm start
37+
```
38+
39+
6. Run the realm server:
40+
41+
```zsh
42+
cd ./packages/realm-server
43+
pnpm start:all
44+
```
45+
46+
Note: Ensure that the realm-server is completely started by looking out for tor the test-realm indexing output.
47+
48+
```zsh
49+
Realm http://localhost:4202/test/ has started ({
50+
"instancesIndexed": 8,
51+
"instanceErrors": 0,
52+
"moduleErrors": 0
53+
})
54+
```
55+
56+
7. Register ALL:
57+
58+
```zsh
59+
cd ./packages/matrix
60+
pnpm register-all
61+
```
62+
63+
8. Verify registration:
64+
65+
```zsh
66+
cd ./packages/matrix
67+
pnpm start:admin
68+
```
69+
70+
Visit http://localhost:8080. Type in Username = "admin", Password: "password" Homeserver URL: http://localhost:8008
71+
72+
9. Host App
73+
- Visit http://localhost:4201/
74+
- Enter the registration flow and create a Boxel Account
75+
- When prompted for an authentication token, type in "dev-token"
76+
77+
10. Validate email for login
78+
- Visit SMTP UI at http://localhost:5001/
79+
- Validate email
80+
- Go back to Host and login
81+
82+
11. Validate email for login
83+
- Visit SMTP UI at http://localhost:5001/
84+
- Validate email
85+
- Go back to Host and login
86+
87+
13. Run ai bot (Optional):
88+
89+
```zsh
90+
cd ./packages/ai-bot
91+
OPENAI_API_KEY=*** pnpm start
92+
```
93+
94+
## Cleanup command
95+
96+
If you experience issues, you can start from scratch by running this command
97+
98+
```
99+
pnpm clear-caches
100+
rm -rf ./packages/matrix/synapse-data
101+
docker ps -a --format '{{.Names}}' | grep -E 'boxel-smtp|boxel-synapse|synapse-admin' | xargs -r docker stop
102+
docker ps -a --format '{{.Names}}' | grep -E 'boxel-smtp|boxel-synapse|synapse-admin' | xargs -r docker rm -v
103+
```

‎README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Boxel Runtime
22

3+
For a quickstart, see [here](./QUICKSTART.md)
4+
35
## Setup
46

57
- you will want the [Glint](https://marketplace.visualstudio.com/items?itemName=typed-ember.glint-vscode) vscode extension
@@ -23,12 +25,14 @@
2325

2426
`packages/boxel-motion-test-app` is the test suite for boxel-motion
2527

26-
`packages/boxel-motion-demo-app` is the demo app for boxel-motion
28+
`packages/boxel-motion/test-app` is the demo app for boxel-motion
2729

2830
`packages/matrix` is the docker container for running the matrix server: synapse, as well as tests that involve running a matrix client.
2931

3032
`packages/ai-bot` is a node app that runs a matrix client session and an OpenAI session. Matrix message queries sent to the AI bot are packaged with an OpenAI system prompt and operator mode context and sent to OpenAI. The ai bot enriches the OpenAI response and posts the response back into the matrix room.
3133

34+
To learn more about Boxel and Cards, see our [documentation](./docs/README.md)
35+
3236
## Running the Host App
3337

3438
There exists a "dev" mode in which we can use ember-cli to host the card runtime host application which includes live reloads. Additionally, you can also use the realm server to host the app, which is how it will be served in production.
@@ -81,7 +85,6 @@ Instead of running `pnpm start:base`, you can alternatively use `pnpm start:all`
8185
| :5001 | Mail user interface for viewing emails sent to local SMTP | ✅ | 🚫 |
8286
| :8008 | Matrix synapse server | ✅ | 🚫 |
8387

84-
8588
#### Using `start:development`
8689

8790
You can also use `start:development` if you want the functionality of `start:all`, but without running the test realms. `start:development` will enable you to open http://localhost:4201 and allow to select between the cards in the /base and /drafts realm.
@@ -136,12 +139,8 @@ First you must create an administrative user:
136139
docker exec -it boxel-synapse register_new_matrix_user http://localhost:8008 -c /data/homeserver.yaml -u admin -p your_admin_password --admin
137140
```
138141
Alternatively, you can execute `pnpm register-test-admin` and utilize the following credentials: `user: admin` and `password: password`.
139-
3. Run the docker container:
140-
```
141-
docker run --name synapse-admin -p 8080:80 -d awesometechnologies/synapse-admin
142-
```
143142

144-
After you have created an administrative user and have created the docker container you can start the admin console by executing the following in the packages/matrix workspace:
143+
After you have created an administrative user and can start the admin console by executing the following in the packages/matrix workspace:
145144

146145
```
147146
pnpm start:admin
@@ -173,7 +172,7 @@ There is a ember-freestyle component explorer available to assist with developme
173172

174173
In order to run the boxel-motion demo app:
175174

176-
1. `cd packages/boxel-motion-demo-app`
175+
1. `cd packages/boxel-motion/test-app`
177176
2. `pnpm start`
178177
3. Visit http://localhost:4200 in your browser
179178

‎docs/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
2+
# Documentation about Boxel
3+
4+
## Prerequisites
5+
16
The following VS Code addon helps to visualize a .mermaid file: https://marketplace.visualstudio.com/items?itemName=tomoyukim.vscode-mermaid-editor
27

38
It also has a feature to save an .svg image, which be opened in Chrome for a decent pan and zoom experience.
9+
10+
## Concepts
11+
12+
The following are important concepts:
13+
14+
- [Card and Field Definition Relationships](card-def-field-def-relationships.md): There is a subtle distinction between card and fields to consider when creating cards.
15+
- [Inheritance](card-inheritance.md): Cards can be extended based upon user's custom needs -- no reinventing the wheel.
16+
- [Rendering](card-rendering.md): Cards can be rendered easily in the browser. Each card renders differently based upon how it is related and what context it exists in.
17+
- [Serialization and Deserialization](card-serialization-deserialization.md): Cards have to be adapted to a consistent JSON format before being sent over-the-wire to other consumers.
18+
- [Computed Fields](computed-fields.md): Computed fields work too! We can compute on the data that is already contained in a card to build more complex logic.
19+
- [Indexing](indexing.md): Indexing powers the re-rendering of cards when it's dependencies get updated.
20+
- [Realm](realm.md): Realms are storage for cards that have their own underlying permissions and indexer.
21+
- [Search](search.md): Every Card is searchable within and across realms.

‎docs/card-serialization-deserialization.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ flowchart TB
88
E[LooseCardResource] -->|createFromSerialized| A
99
C[JSON Storage on Realm Server] --> E
1010
11-
style A fill:#58D68D
11+
style A fill:#63a45b
1212
style B fill:#3498DB
13-
style C fill:#F5B041
13+
style C fill:#cc3e33
1414
style E fill:#3498DB
1515
```
1616

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
"hcl2-parser": "^1.0.3",
5959
"prettier": "^2.7.1",
6060
"prettier-plugin-ember-template-tag": "^1.1.0",
61-
"typescript": "^5.1.6"
61+
"typescript": "~5.1.6"
6262
},
6363
"engines": {
6464
"pnpm": "^8"

‎packages/ai-bot/helpers.ts

+16-21
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,6 @@ export function constructHistory(history: IRoomEvent[]) {
6969
serializedCardFromFragments(id, fragments),
7070
);
7171
}
72-
if (
73-
event.content.data.context.openCardsEventIds &&
74-
event.content.data.context.openCardsEventIds.length > 0
75-
) {
76-
event.content.data.context.openCards =
77-
event.content.data.context.openCardsEventIds.map((id) =>
78-
serializedCardFromFragments(id, fragments),
79-
);
80-
}
8172
}
8273

8374
if (event.content['m.relates_to']?.rel_type === 'm.replace') {
@@ -112,19 +103,23 @@ function serializedCardFromFragments(
112103
`No card fragment found in fragments cache for event id ${eventId}`,
113104
);
114105
}
115-
if (fragment.data.totalParts === 1) {
116-
return JSON.parse(fragment.data.cardFragment) as LooseSingleCardDocument;
117-
}
106+
let cardFragments: CardFragmentContent[] = [];
107+
let currentFragment: string | undefined = eventId;
108+
do {
109+
let fragment = fragments.get(currentFragment);
110+
if (!fragment) {
111+
throw new Error(
112+
`No card fragment found in cache for event id ${eventId}`,
113+
);
114+
}
115+
cardFragments.push(fragment);
116+
currentFragment = fragment.data.nextFragment;
117+
} while (currentFragment);
118118

119-
let cardFragments = [
120-
fragment,
121-
...[...fragments.values()]
122-
.filter((f) => f.data.firstFragment && f.data.firstFragment === eventId)
123-
.sort((a, b) => (a.data.index = b.data.index)),
124-
];
125-
if (cardFragments.length !== fragment.data.totalParts) {
119+
cardFragments.sort((a, b) => (a.data.index = b.data.index));
120+
if (cardFragments.length !== cardFragments[0].data.totalParts) {
126121
throw new Error(
127-
`Expected to find ${fragment.data.totalParts} fragments for fragment of event id ${eventId} but found ${cardFragments.length} fragments`,
122+
`Expected to find ${cardFragments[0].data.totalParts} fragments for fragment of event id ${eventId} but found ${cardFragments.length} fragments`,
128123
);
129124
}
130125
return JSON.parse(
@@ -241,7 +236,7 @@ export function getStartOfConversation(
241236
) {
242237
/**
243238
* Get just the start of the conversation
244-
* useful for summarising while limiting the context
239+
* useful for summarizing while limiting the context
245240
*/
246241
let messages: OpenAIPromptMessage[] = [];
247242
let totalLength = 0;

‎packages/ai-bot/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"stream-chain": "^2.2.5",
1313
"stream-json": "^1.8.0",
1414
"ts-node": "^10.9.1",
15-
"typescript": "^5.1.6"
15+
"typescript": "~5.1.6"
1616
},
1717
"devDependencies": {
1818
"qunit": "^2.18.0"

0 commit comments

Comments
 (0)