Compare commits

...
9 Commits
Author SHA1 Message Date
root-at-skic d02c331155 Merge pull request '0.10.0: Archify Sync, optional live collaboration on a model' (#31) from feature/archify-sync into main 2026-11-06 12:57:46 -08:00
root-at-skic c99f3e5fe8 0.10.0: Archify Sync, optional live collaboration on a model
Several people edit one model at once through a server you run yourself
(archify-vscode-ext-sync); the files stay ordinary files on each disk.
Sign-in through the browser, offline-first with later merge, teammates'
cursors in the Source view and text editors, and a Shared section on the
model page with people, versions, Compare and Restore.

Without a server nothing changes: the sync code is a separate bundle that
loads only when a model is shared, after a sign-in, or when a sync command
or invite link is used.
2026-11-06 22:55:01 +02:00
root-at-skic a9021312b0 Merge pull request '0.9.3: Graph from Source on main.archify works again' (#30) from fix/source-graph-switch into main 2026-11-04 03:34:35 -08:00
root-at-skic 2726a66113 0.9.3: Graph from Source on main.archify works again
On a main.archify page in Source, Graph built the Graph page but the
host held it back until Source closed, so nothing happened, and Model
then showed the held Graph page. Switching between the model and its
graph now leaves Source first, and the page forgets Source when Graph
replaces it, so Model on the Graph page comes back to the model.
2026-11-04 13:34:19 +02:00
root-at-skic a5a9f92e75 Merge pull request '0.9.2: Source view, schema checks without the YAML extension' (#29) from feat/source-view into main 2026-10-28 13:27:37 -07:00
root-at-skic 268c75cfae 0.9.2: fast-uri 3.1.9 and markdown-it 14.3.3 (npm audit)
fast-uri comes with ajv, which ships in extension.js from this release;
markdown-it is stubbed out of the Source bundle but was in the lockfile.
2026-10-27 23:47:50 +02:00
root-at-skic 27d4794ff8 0.9.2: Source view, schema checks without the YAML extension
Every Archify page can show its file's YAML in place. Diagrams get
Diagram | Graph | Source (Graph only inside a model), main.archify
Model | Graph | Source, registry and decision pages View | Source, and the
Graph page a Source segment. 2D | 3D moves left of that switch and hides
while Source shows.

The YAML opens in a CodeMirror editor inside the page (dist/source.js,
loaded on first use), themed with the page's colours. Edits go to the VS
Code document as WorkspaceEdits; outside changes come back to the page.
Undo and redo are the editor's own, since VS Code sends ⌘Z in a focused
webview to the webview; save and find stay VS Code's. Problems come from
the host only (what the Problems panel holds for the file) and are
counted on the Source segment; completion and hover come from the schema,
folded into one draft-07 document per diagram type.

The host now checks .archify files against the extension's schema with
ajv on the YAML as written, before archify validate, and checks
.archify-registry files against the registry schema for the first time.
Registry and decision pages become text editor providers. While Source
shows, new renders wait and appear when the picture comes back.

Show Source switches the page to Source; Open in Text Editor (the editor
title button) opens the text beside it, as Show Source did. The decision
schema is no longer given to the YAML extension. Fixed: YAML errors in
registry and decision files were reported on line 1; "Webview is
disposed" when a diagram closed mid-render; the model heading under the
toolbar in narrow editors.
2026-10-27 23:46:05 +02:00
root-at-skic 5bcd34b839 Merge pull request '0.9.1: republish for Open VSX' (#28) from rel/0.9.1 into main 2026-10-23 03:29:25 -07:00
root-at-skic 69b87833b7 0.9.1: republish so Open VSX carries the release 2026-10-23 13:29:14 +03:00
47 changed files with 5399 additions and 133 deletions

No files matched your search

+23
View File
@@ -1,5 +1,28 @@
# Changelog # Changelog
## 0.10.0 — 2026-11-06
- **Archify Sync (optional).** Several people edit one model at once through a server you run yourself ([archify-vscode-ext-sync](https://gitea.lego-cloud.eu/vscode-extensions/archify-vscode-ext-sync)); the files stay ordinary files on each disk. Commands: *Sign in to Sync Server…*, *Share Model…*, *Copy Invite Link*, *Join Shared Model…*, *Publish Version…*, *Versions…*, *Stop Syncing Model…*. Sign-in through the browser (PKCE), sessions in VS Code's secret storage, an *Archify Sync* account provider. Edits from editors, pages, Git and agents go out at once; others' edits arrive in open editors with undo intact. Everything is kept on the machine first, so work goes on offline and merges later. Teammates' cursors show as named carets in the Source view and in VS Code's text editors, and stay on their word while others type. The status bar shows who is here; the model page gets a **Shared** section with people, the file each has open, and the latest versions with **Compare** and **Restore**.
- Without a server nothing changes: the sync code is a separate bundle that loads only when a model in the workspace is shared, after a sign-in, or when a sync command or invite link is used.
## 0.9.3 — 2026-11-04
- Fixed: on a `main.archify` page in Source, **Graph** did nothing, and **Model** then showed the Graph page instead of the model. Graph now leaves Source and opens at once, and **Model** on the Graph page comes back to the model, not to Source.
## 0.9.2 — 2026-10-27
- **Source view.** Every Archify page can show its file's YAML in place: **Diagram | Graph | Source** on diagrams (the old **Diagram | Graph** switch, now on every diagram; Graph only inside a model), **Model | Graph | Source** on `main.archify`, **View | Source** on registry and decision pages, and Source on the Graph page too. The YAML opens in an editor inside the page, under its toolbar and heading, in the page's own colours: line numbers, folding, brackets, multiple cursors, undo and redo, ⌘S/Ctrl+S saves. Problems are underlined as you type, listed under the editor (click the count to go to the next one) and counted on the **Source** segment, also while the picture shows. Completion and hover come from the schema of the file, with nothing else installed. Edits go to the VS Code document, so the tab's dirty dot, save, Git and the text editor stay in step. **Diagram** (or **Model**, **View**) brings the picture back as it was left; anything rendered meanwhile shows then.
- **2D | 3D** now sits left of the view switch (it says how the picture is drawn, the switch what is shown) and hides while Source shows; the 3D stage stops drawing meanwhile.
- **Schema checks without the YAML extension.** `.archify` files are checked against the extension's schema on the YAML as written, at once and with readable messages (`Unknown key "lable" in connections[4].`) on the key or value concerned; `archify validate` runs once the schema is satisfied. `.archify-registry` files are checked against the registry schema for the first time (types, unknown keys, ids). The decision schema is no longer handed to the YAML extension: decision files use the `decision` key twice by design, which it reported as an error in every file.
- **Commands.** *Archify | Show Source* switches the focused page to its Source view. The old behaviour, the YAML in VS Code's text editor beside the page, is *Archify | Open in Text Editor*, which is now the editor-title button.
- Registry and decision pages are text editors of their files (as diagram pages already were), so edits made there make the tab dirty and save with it.
- Fixed: a YAML error in a registry or decision file was reported on its first line instead of where it is.
- Fixed: an unhandled "Webview is disposed" error when a diagram closed while it was rendering. On `main.archify` pages with a diagram, the model heading no longer runs under the toolbar in narrow editors.
## 0.9.1 — 2026-10-23
- No functional change. Republished so that Open VSX carries the release: the 0.9.0 upload there was held under review while the `root-at-skic` namespace was still unverified, and a held upload is not released by the later ownership grant.
## 0.9.0 — 2026-10-21 ## 0.9.0 — 2026-10-21
- **Model graph.** A **Model | Graph** switch on the `main.archify` page (next to **Export** when the file has a diagram, top right otherwise) replaces the page with the whole model as one graph: every element any diagram draws plus every registry element, every connection between them, each once, drawn with Cytoscape.js in Archify's type colours. Registry elements have a solid border, inline ones a dashed border. **Decisions** and **registry files** are nodes as well: a decision is a tag coloured by status with dotted links to the elements and connections it is about and dashed links to what it supersedes; a registry links to the elements it defines. Layered layout by type (clients left, data right, registries above, decisions below, orthogonal connections) or a force layout; hover lights up an element and its connections; the dotted decision and registry links are shown by default; **Links** switches them to the selected element only. Drag, zoom, **Fit**, **Labels**, a dark/light theme toggle of its own (remembered, and shared with the diagram pages' theme key), legend chips that hide a type (decisions and registries included), **Export PNG**. The choice is remembered per file; the graph updates in place as the model changes. - **Model graph.** A **Model | Graph** switch on the `main.archify` page (next to **Export** when the file has a diagram, top right otherwise) replaces the page with the whole model as one graph: every element any diagram draws plus every registry element, every connection between them, each once, drawn with Cytoscape.js in Archify's type colours. Registry elements have a solid border, inline ones a dashed border. **Decisions** and **registry files** are nodes as well: a decision is a tag coloured by status with dotted links to the elements and connections it is about and dashed links to what it supersedes; a registry links to the elements it defines. Layered layout by type (clients left, data right, registries above, decisions below, orthogonal connections) or a force layout; hover lights up an element and its connections; the dotted decision and registry links are shown by default; **Links** switches them to the selected element only. Drag, zoom, **Fit**, **Labels**, a dark/light theme toggle of its own (remembered, and shared with the diagram pages' theme key), legend chips that hide a type (decisions and registries included), **Export PNG**. The choice is remembered per file; the graph updates in place as the model changes.
+27 -11
View File
@@ -12,7 +12,7 @@ Free and open source. If it saves you time, you can [buy me a coffee](https://bu
| File | Format | What the extension does | | File | Format | What the extension does |
|---|---|---| |---|---|---|
| **`name.archify`** | **YAML** (the main format) | Opens as the interactive diagram. Show Source, live updates, validation, completion, templates. | | **`name.archify`** | **YAML** (the main format) | Opens as the interactive diagram, with a Source view for its YAML. Live updates, validation, completion, templates. |
| `name.architecture.json`, `name.workflow.json`, `name.sequence.json`, `name.dataflow.json`, `name.lifecycle.json` | JSON (Archify's own CLI format) | Opens as text, with a preview beside it and validation. For files produced by the Archify CLI or AI agents. | | `name.architecture.json`, `name.workflow.json`, `name.sequence.json`, `name.dataflow.json`, `name.lifecycle.json` | JSON (Archify's own CLI format) | Opens as text, with a preview beside it and validation. For files produced by the Archify CLI or AI agents. |
| Rendered Archify `.html` | HTML | Read-only viewer instead of a browser. | | Rendered Archify `.html` | HTML | Read-only viewer instead of a browser. |
@@ -44,7 +44,7 @@ To write one by hand:
``` ```
2. Click it in the Explorer: the diagram opens. 2. Click it in the Explorer: the diagram opens.
3. To edit, use **Show Source** in the editor title. The YAML opens beside the diagram, which re-renders as you type. 3. To edit, click **Source** in the diagram's toolbar (**Diagram | Graph | Source**). The YAML takes the picture's place, checked as you type; **Diagram** brings the picture back. To see the text and the picture side by side, use **Open in Text Editor** in the editor title instead: the diagram re-renders as you type.
The same file is in [examples/hello.archify](examples/hello.archify). The same file is in [examples/hello.archify](examples/hello.archify).
@@ -53,7 +53,7 @@ The same file is in [examples/hello.archify](examples/hello.archify).
A `.archify` file is an Archify diagram written in **YAML**. Its fields are those of Archify's diagram schema; the extension converts the YAML for the renderer, so you never handle JSON yourself. `diagram_type` selects the kind of diagram: `architecture`, `workflow`, `sequence`, `dataflow` or `lifecycle`. A `.archify` file is an Archify diagram written in **YAML**. Its fields are those of Archify's diagram schema; the extension converts the YAML for the renderer, so you never handle JSON yourself. `diagram_type` selects the kind of diagram: `architecture`, `workflow`, `sequence`, `dataflow` or `lifecycle`.
- **Opening:** the **Archify Diagram** editor is the default for `.archify`. Use *Reopen Editor With… → Text Editor* to edit the YAML full-screen. - **Opening:** the **Archify Diagram** editor is the default for `.archify`. Use *Reopen Editor With… → Text Editor* to edit the YAML full-screen.
- **Completion:** with the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) (`redhat.vscode-yaml`) installed, `.archify` files get completion and hover from Archify's schemas. The schema follows `diagram_type`. - **Completion:** in the Source view, `.archify` and `.archify-registry` files get completion and hover from Archify's schemas, with nothing else installed; the schema follows `diagram_type`. In VS Code's text editor the same comes from the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) (`redhat.vscode-yaml`), if installed.
`.archify` files from extension version 0.2.0 were written in JSON. They still open, because JSON is valid YAML, but new files should use YAML. `.archify` files from extension version 0.2.0 were written in JSON. They still open, because JSON is valid YAML, but new files should use YAML.
@@ -66,19 +66,19 @@ The Archify CLI and the AI agents that use it write diagrams as JSON, named `nam
- **New diagram from a template**: *Archify | New Diagram…* creates a starter `.archify` file for any of the five diagram kinds, or an everyday plan, in the chosen folder. - **New diagram from a template**: *Archify | New Diagram…* creates a starter `.archify` file for any of the five diagram kinds, or an everyday plan, in the chosen folder.
- **New model from an example**: *Archify | New Model…* creates a complete model folder from a C4 example (Standard Web App, E-Shop, Event-Based Integration). - **New model from an example**: *Archify | New Model…* creates a complete model folder from a C4 example (Standard Web App, E-Shop, Event-Based Integration).
- **Model graph**: the **Graph** switch on any page of a model shows the whole model as one graph, with a query box (`type:database`, `uses:api`, `from:web to:db`, …), a side panel per element and PNG export. See [Models](#models). - **Model graph**: the **Graph** switch on any page of a model shows the whole model as one graph, with a query box (`type:database`, `uses:api`, `from:web to:db`, …), a side panel per element and PNG export. See [Models](#models).
- **Diagram editor**: `.archify` files open as the rendered diagram. **Show Source** opens the YAML beside it, and edits re-render live. - **Diagram editor**: `.archify` files open as the rendered diagram. **Source** shows the YAML in its place, in an editor inside the page: problems underlined as you type and counted on the switch, completion and hover from the schema, undo, and ⌘S/Ctrl+S to save. **Open in Text Editor** opens the YAML beside the diagram instead, and edits re-render live.
- **Live updates**: the diagram re-renders as you edit, and keeps the focus and route you selected (`#focus=…`, `#route=…`). - **Live updates**: the diagram re-renders as you edit, and keeps the focus and route you selected (`#focus=…`, `#route=…`).
- **HTML viewer**: right-click a rendered `.html` file and choose **Archify | Open in HTML Viewer**, or use *Reopen Editor With… → Archify HTML Viewer*. For Archify HTML already open as text, a button appears in the editor title. The viewer reloads when the file changes on disk. - **HTML viewer**: right-click a rendered `.html` file and choose **Archify | Open in HTML Viewer**, or use *Reopen Editor With… → Archify HTML Viewer*. For Archify HTML already open as text, a button appears in the editor title. The viewer reloads when the file changes on disk.
- **Problems**: YAML syntax errors, plus `archify validate`'s schema, layout and evidence problems, appear at the matching line of the `.archify` file. - **Problems**: YAML syntax errors, schema problems (unknown keys, wrong types, missing fields, checked with the extension's own schema check on the YAML as written) and `archify validate`'s layout and evidence problems appear at the matching place in the `.archify` file. Registries are checked against their schema too.
- **Brand logos**: after `brand:` the editor suggests Archify's built-in brand IDs (PostgreSQL, Redis, Kafka, Docker, …). Typing an alias or product name finds them too, so `kafka` offers `apache-kafka`. An unknown brand is reported on its own line. - **Brand logos**: after `brand:` the editor suggests Archify's built-in brand IDs (PostgreSQL, Redis, Kafka, Docker, …). Typing an alias or product name finds them too, so `kafka` offers `apache-kafka`. An unknown brand is reported on its own line.
- **Schema help**: completion and hover from Archify's own schemas, through the YAML extension for `.archify` files. - **Schema help**: completion and hover from Archify's own schemas: in the Source view built in, in the text editor through the YAML extension.
- **Source links**: in source-backed diagrams, clicking a source reference opens that file and line range in the editor. If the file is not in the workspace, the web link opens instead. - **Source links**: in source-backed diagrams, clicking a source reference opens that file and line range in the editor. If the file is not in the workspace, the web link opens instead.
- **Export**: the diagram's own Export menu (PNG, SVG, share card, …) saves through a VS Code save dialog. - **Export**: the diagram's own Export menu (PNG, SVG, share card, …) saves through a VS Code save dialog.
- **Commands**: *Archify | New Model…*, *Archify | New Registry…*, *Archify | New Diagram…*, *Archify | New Decision…*, *Archify | Open Model*, *Archify | Open Model Graph*, *Archify | Render to HTML File…*, *Archify | Open in Browser*, *Archify | Refresh Preview*, *Archify | Show Source*. - **Commands**: *Archify | New Model…*, *Archify | New Registry…*, *Archify | New Diagram…*, *Archify | New Decision…*, *Archify | Open Model*, *Archify | Open Model Graph*, *Archify | Render to HTML File…*, *Archify | Open in Browser*, *Archify | Refresh Preview*, *Archify | Show Source* (switches the page to its Source view), *Archify | Open in Text Editor*.
## 3D view ## 3D view
Every diagram can also be seen in 3D. The **2D | 3D** switch next to **Export** in the diagram's toolbar shows which view you are in; click it to flip. Every diagram can also be seen in 3D. The **2D | 3D** switch in the diagram's toolbar, left of **Diagram | Graph | Source**, shows which view you are in; click it to flip. It hides while Source shows, and **Diagram** returns to the 2D or 3D you left.
![The same diagram in the 3D view](docs/preview-3d.png) ![The same diagram in the 3D view](docs/preview-3d.png)
@@ -124,16 +124,32 @@ online-shop/
- **Links.** A registry element (or a component) with `diagram: 0300-components/api.archify` points at the diagram that explains it: double-click the node in the 2D view to open it. - **Links.** A registry element (or a component) with `diagram: 0300-components/api.archify` points at the diagram that explains it: double-click the node in the 2D view to open it.
- **Descriptions.** Under a model diagram, hovering a row of the **Elements** panel shows the registry description of that element. - **Descriptions.** Under a model diagram, hovering a row of the **Elements** panel shows the registry description of that element.
- **Decisions.** One `*.archify-decision` file per architecture decision: id, title, status, date, the registry elements and diagrams it is about, and prose for context, decision and consequences. Diagrams point at decisions with `decisions: [<id>]` on the diagram, a component or a connection. They show as a **Decisions** panel on the `main.archify` page, a **Decisions** rail panel under each diagram (hover lights up what the decision is attached to), on element cards and in the element dialog, and a decision opens as its own page. *Archify | New Decision…* creates one; links are checked in Problems. - **Decisions.** One `*.archify-decision` file per architecture decision: id, title, status, date, the registry elements and diagrams it is about, and prose for context, decision and consequences. Diagrams point at decisions with `decisions: [<id>]` on the diagram, a component or a connection. They show as a **Decisions** panel on the `main.archify` page, a **Decisions** rail panel under each diagram (hover lights up what the decision is attached to), on element cards and in the element dialog, and a decision opens as its own page. *Archify | New Decision…* creates one; links are checked in Problems.
- **Registry view.** A `.archify-registry` file opens as its elements, as cards. Click one and a dialog shows its description, where it is defined and the diagrams that use it; click a diagram to open it. **Show Source** opens the YAML beside it. - **Registry view.** A `.archify-registry` file opens as its elements, as cards. Click one and a dialog shows its description, where it is defined and the diagrams that use it; click a diagram to open it. **View | Source** at the top right switches to the YAML, checked against the registry schema as you type.
- **Elements and Connectors.** Under every diagram, Archify's node index is titled **Elements**, and a **Connectors** panel next to it lists every connection as "from → to" with its label. Hovering highlights the connector in the diagram; clicking keeps it highlighted and scrolls to it. - **Elements and Connectors.** Under every diagram, Archify's node index is titled **Elements**, and a **Connectors** panel next to it lists every connection as "from → to" with its label. Hovering highlights the connector in the diagram; clicking keeps it highlighted and scrolls to it.
- **Starting one.** *Archify | New Model…* (right-click a folder) copies one of the shipped examples into a new folder, named as you choose: **C4 - Standard Web App** (single-page app, API, database, cache, storage, identity provider), **C4 - E-Shop** (web shop, API, worker, queue, payment and email providers) or **C4 - Event-Based Integration** (event bus, router, dead-letter queue, event store, consumers). Each has a registry and context, container and component diagrams. For an empty model, *Archify | New Diagram… → Model* creates just a `main.archify`. - **Starting one.** *Archify | New Model…* (right-click a folder) copies one of the shipped examples into a new folder, named as you choose: **C4 - Standard Web App** (single-page app, API, database, cache, storage, identity provider), **C4 - E-Shop** (web shop, API, worker, queue, payment and email providers) or **C4 - Event-Based Integration** (event bus, router, dead-letter queue, event store, consumers). Each has a registry and context, container and component diagrams. For an empty model, *Archify | New Diagram… → Model* creates just a `main.archify`.
- **The graph.** The **Model | Graph** switch at the top of the `main.archify` page (next to **Export** when the file has a diagram) replaces the page with the whole model as one graph: every element any diagram draws plus every registry element, every connection between them, each once. Registry elements have a solid border, inline ones a dashed border; colours are Archify's type colours and the legend chips at the bottom hide or show a type. **Decisions** are nodes too (tags coloured by status, dotted links to the elements they are about, dashed links to what they supersede), and so are **registries** (one node per file, dotted links to the elements it defines); their chips hide them when the picture gets busy. The layout is **Layered** by default, like Archify's stack: clients on the left, data on the right, registries in a row above, decisions in a row below, connections drawn orthogonally; click the button for a **Force** layout instead. Drag nodes, scroll to zoom, **Fit** (or <kbd>0</kbd>) frames what matches, **Labels** toggles connection labels, the dotted **Links** from decisions and registries to their elements are on by default and can be switched off, in which case only the selected element's show (hovering an element lights up its connections), the sun/moon button switches the page between its dark and light theme (remembered, shared with the diagram pages' theme choice), **Export PNG** saves the picture. On a diagram page the switch reads **Diagram | Graph** and opens the graph already narrowed to that diagram. *Archify | Open Model Graph* does the same from the Command Palette or Explorer. - **The graph.** The **Model | Graph | Source** switch at the top of the `main.archify` page (next to **Export** when the file has a diagram) replaces the page with the whole model as one graph: every element any diagram draws plus every registry element, every connection between them, each once. Registry elements have a solid border, inline ones a dashed border; colours are Archify's type colours and the legend chips at the bottom hide or show a type. **Decisions** are nodes too (tags coloured by status, dotted links to the elements they are about, dashed links to what they supersede), and so are **registries** (one node per file, dotted links to the elements it defines); their chips hide them when the picture gets busy. The layout is **Layered** by default, like Archify's stack: clients on the left, data on the right, registries in a row above, decisions in a row below, connections drawn orthogonally; click the button for a **Force** layout instead. Drag nodes, scroll to zoom, **Fit** (or <kbd>0</kbd>) frames what matches, **Labels** toggles connection labels, the dotted **Links** from decisions and registries to their elements are on by default and can be switched off, in which case only the selected element's show (hovering an element lights up its connections), the sun/moon button switches the page between its dark and light theme (remembered, shared with the diagram pages' theme choice), **Export PNG** saves the picture. On a diagram page the switch reads **Diagram | Graph | Source** and Graph opens the graph already narrowed to that diagram; **Source** on the graph page goes back to `main.archify` in its Source view. *Archify | Open Model Graph* does the same from the Command Palette or Explorer.
- **Queries.** Type a few words in the box (<kbd>/</kbd> focuses it); matches stay bright, the rest dims, the count shows "9 of 14 elements". Terms combine with AND and a leading `-` excludes: `database` (id, label, sublabel, brand or type contain it), `type:backend`, `diagram:0200-*` (what those diagrams draw), `decision:<id>` (what a decision is about or is attached to), `uses:api` (an element and its neighbours), `near:api,2` (within two steps), `from:web to:db` (the shortest path, following the arrows first), `unused` (registry elements no diagram draws), `shared` and `-shared` (registry or inline elements only), `type:decision` and `type:registry` for the decision and registry nodes. Decisions and registries follow the elements they are attached to into a result; `-type:decision` or `-type:registry` leaves them out. Walks and paths follow the diagrams' connections only, so a registry is never a shortcut between its elements. The **?** button lists them; clicking an example runs it. - **Queries.** Type a few words in the box (<kbd>/</kbd> focuses it); matches stay bright, the rest dims, the count shows "9 of 14 elements". Terms combine with AND and a leading `-` excludes: `database` (id, label, sublabel, brand or type contain it), `type:backend`, `diagram:0200-*` (what those diagrams draw), `decision:<id>` (what a decision is about or is attached to), `uses:api` (an element and its neighbours), `near:api,2` (within two steps), `from:web to:db` (the shortest path, following the arrows first), `unused` (registry elements no diagram draws), `shared` and `-shared` (registry or inline elements only), `type:decision` and `type:registry` for the decision and registry nodes. Decisions and registries follow the elements they are attached to into a result; `-type:decision` or `-type:registry` leaves them out. Walks and paths follow the diagrams' connections only, so a registry is never a shortcut between its elements. The **?** button lists them; clicking an example runs it.
- **Side panel.** Click an element for its description, type, where it is defined (**Registry** opens the file at the line), the diagrams that draw it (click to open), its connections and its decisions (click to open). **Neighbours** runs `uses:` for it. Click a connection for its labels, the diagrams that draw it and its decisions. Click a decision node for its status, context and decision text, the elements and connections it is about, and **Open decision**; a registry node for the elements it defines, the ones no diagram draws yet, and **Open registry**. - **Side panel.** Click an element for its description, type, where it is defined (**Registry** opens the file at the line), the diagrams that draw it (click to open), its connections and its decisions (click to open). **Neighbours** runs `uses:` for it. Click a connection for its labels, the diagrams that draw it and its decisions. Click a decision node for its status, context and decision text, the elements and connections it is about, and **Open decision**; a registry node for the elements it defines, the ones no diagram draws yet, and **Open registry**.
- **Commands.** *Archify | Open Model* opens the model page of the current file, from the editor title, the Command Palette or the Explorer menu of a `.archify` or `.archify-registry` file; *Archify | Open Model Graph* opens the graph. - **Commands.** *Archify | Open Model* opens the model page of the current file, from the editor title, the Command Palette or the Explorer menu of a `.archify` or `.archify-registry` file; *Archify | Open Model Graph* opens the graph.
Formats in detail: [docs/model.md](docs/model.md). A full example: [examples/online-shop](examples/online-shop). Formats in detail: [docs/model.md](docs/model.md). A full example: [examples/online-shop](examples/online-shop).
## Working together (Archify Sync)
Optional. Without a sync server the extension works exactly as described above and loads none of this.
[Archify Sync](https://gitea.lego-cloud.eu/vscode-extensions/archify-vscode-ext-sync) is a small server you run yourself (one container and PostgreSQL; a Helm chart is included). With it, a model is edited by several people at once, like a shared document, and its files stay ordinary files on each person's disk, so Git, agents and every page of this extension keep working.
- **Sign in.** *Archify | Sign in to Sync Server…* asks for the server's address and signs in through the browser; the session is kept in VS Code's secret storage and shows under **Accounts** as *Archify Sync*. A new server is set up first on its `/setup` page with the code from its log.
- **Share.** *Archify | Share Model…* (also on `main.archify` in the Explorer) puts the model on the server and writes a small `.archify-sync` file next to `main.archify`: the server and the model's id, no secrets. Commit it, and everyone who clones the repository and is a member opens the shared model.
- **Invite and join.** *Archify | Copy Invite Link* copies a link for the model; send it any way you like. Opening it (or *Archify | Join Shared Model…*) signs the person in, or up, and puts the files in an empty folder of their choice.
- **Live.** Edits in any editor, page, Source view, by Git or by an agent reach the others within a moment. Their edits arrive in your open editors with undo intact and are saved to disk; your own unsaved work stays unsaved. The status bar shows **Archify live · 3 here**; the model page gets a **Shared** section with who is here and in which file, and each diagram card says who has it open. In the Source view and in text editors, teammates' cursors show as coloured carets with their names.
- **Offline.** Every edit is kept on your machine first. Without a connection you keep working; edits on both sides merge when it is back, also after a restart, and also edits made while VS Code was closed.
- **Versions.** The server takes a snapshot after a pause in editing (0.1, 0.2, …). *Archify | Publish Version…* names the current state as a major version (1.0 "Q4 baseline"). The model page lists the latest versions with **Compare** (a diff per changed file) and **Restore** (brings the files back for everyone, as a new version; nothing is lost); *Archify | Versions…* lists them all.
- **Stop.** *Archify | Stop Syncing Model…* removes `.archify-sync` here and leaves the files as they are.
Only model files (`.archify`, `.archify-registry`, `.archify-decision`) are shared, and only below `main.archify`.
## Source evidence ## Source evidence
A diagram that declares `meta.repository` and `sources` is verified against a local Git checkout whose `origin` and pinned commit match. The extension uses the Git top-level directory of the diagram file, or `archify.repoRoot` when set. A diagram that declares `meta.repository` and `sources` is verified against a local Git checkout whose `origin` and pinned commit match. The extension uses the Git top-level directory of the diagram file, or `archify.repoRoot` when set.
@@ -156,7 +172,7 @@ When verification fails, the default (`archify.sourceEvidence: "fallback"`) stil
## Security ## Security
Diagrams run in a webview with a strict content security policy. Only the page's own inline scripts and the extension's bundled 3D viewer run (via a per-render nonce), there is no network access for scripts or fetches, and links open through VS Code. Diagrams run in a webview with a strict content security policy. Only the page's own inline scripts and the extension's bundled 3D viewer run (via a per-render nonce), there is no network access for scripts or fetches, and links open through VS Code. The extension itself talks to a network only for Archify Sync, and only to a server you sign in to or a model's `.archify-sync` file names, over HTTPS (plain HTTP only to this machine).
## Development ## Development
+29
View File
@@ -18,6 +18,17 @@ const common = {
mainFields: ['module', 'main'], mainFields: ['module', 'main'],
}; };
// codemirror-json-schema formats schema descriptions with markdown-it and
// shiki (about 400 KB); a small stub does what our descriptions need.
const stubMarkdown = {
name: 'stub-markdown',
setup(build) {
build.onResolve({ filter: /utils\/markdown(\.js)?$/ }, (args) =>
args.importer.includes('codemirror-json-schema') ? { path: path.resolve('src/webview/source/markdownStub.ts') } : undefined,
);
},
};
if (tests) { if (tests) {
// Unit tests cover the modules that do not import 'vscode'; the // Unit tests cover the modules that do not import 'vscode'; the
// integration suite runs inside VS Code, which provides it. // integration suite runs inside VS Code, which provides it.
@@ -40,6 +51,14 @@ if (tests) {
outfile: 'dist/extension.js', outfile: 'dist/extension.js',
external: ['vscode'], external: ['vscode'],
}), }),
// Archify Sync, loaded only when a model is shared (src/sync/loader.ts).
// ws's native speed-ups are optional and not shipped.
esbuild.context({
...common,
entryPoints: ['src/sync/index.ts'],
outfile: 'dist/sync.js',
external: ['vscode', 'bufferutil', 'utf-8-validate'],
}),
// Runs inside the Archify page in the webview; three.js is bundled in. // Runs inside the Archify page in the webview; three.js is bundled in.
esbuild.context({ esbuild.context({
...common, ...common,
@@ -58,6 +77,16 @@ if (tests) {
entryPoints: ['src/graph/index.ts'], entryPoints: ['src/graph/index.ts'],
outfile: 'dist/graph.js', outfile: 'dist/graph.js',
}), }),
// The Source view; CodeMirror is bundled in. Loaded the first time Source is chosen.
esbuild.context({
...common,
format: 'iife',
platform: 'browser',
target: 'es2022',
entryPoints: ['src/webview/source/index.ts'],
outfile: 'dist/source.js',
plugins: [stubMarkdown],
}),
]); ]);
if (watch) { if (watch) {
await Promise.all(contexts.map((ctx) => ctx.watch())); await Promise.all(contexts.map((ctx) => ctx.watch()));
+1082 -23
View File
File diff suppressed because it is too large. Load diff
+105 -8
View File
@@ -2,7 +2,7 @@
"name": "archify-vscode-ext", "name": "archify-vscode-ext",
"displayName": "Archify Diagram Viewer", "displayName": "Archify Diagram Viewer",
"description": "Archify diagrams in VS Code. Write diagrams as .archify files in YAML: they open as the interactive diagram, with live updates, validation, templates and completion. Also previews Archify's own JSON files (*.architecture.json, …) and opens rendered Archify HTML.", "description": "Archify diagrams in VS Code. Write diagrams as .archify files in YAML: they open as the interactive diagram, with live updates, validation, templates and completion. Also previews Archify's own JSON files (*.architecture.json, …) and opens rendered Archify HTML.",
"version": "0.9.0", "version": "0.10.0",
"publisher": "root-at-skic", "publisher": "root-at-skic",
"license": "MIT", "license": "MIT",
"sponsor": { "sponsor": {
@@ -45,7 +45,8 @@
"workspaceContains:**/*.{archify,architecture.json,workflow.json,sequence.json,dataflow.json,lifecycle.json}", "workspaceContains:**/*.{archify,architecture.json,workflow.json,sequence.json,dataflow.json,lifecycle.json}",
"onWebviewPanel:archify.preview", "onWebviewPanel:archify.preview",
"workspaceContains:**/*.archify-registry", "workspaceContains:**/*.archify-registry",
"workspaceContains:**/*.archify-decision" "workspaceContains:**/*.archify-decision",
"onUri"
], ],
"contributes": { "contributes": {
"commands": [ "commands": [
@@ -102,6 +103,11 @@
{ {
"command": "archify.showSource", "command": "archify.showSource",
"title": "Archify | Show Source", "title": "Archify | Show Source",
"icon": "$(code)"
},
{
"command": "archify.openInTextEditor",
"title": "Archify | Open in Text Editor",
"icon": "$(go-to-file)" "icon": "$(go-to-file)"
}, },
{ {
@@ -113,6 +119,51 @@
"command": "archify.openModelGraph", "command": "archify.openModelGraph",
"title": "Archify | Open Model Graph", "title": "Archify | Open Model Graph",
"icon": "$(type-hierarchy)" "icon": "$(type-hierarchy)"
},
{
"command": "archify.sync.signIn",
"title": "Archify | Sign in to Sync Server…",
"icon": "$(account)"
},
{
"command": "archify.sync.signOut",
"title": "Archify | Sign out of Sync Server",
"icon": "$(sign-out)"
},
{
"command": "archify.sync.share",
"title": "Archify | Share Model…",
"icon": "$(live-share)"
},
{
"command": "archify.sync.invite",
"title": "Archify | Copy Invite Link",
"icon": "$(person-add)"
},
{
"command": "archify.sync.join",
"title": "Archify | Join Shared Model…",
"icon": "$(link)"
},
{
"command": "archify.sync.publish",
"title": "Archify | Publish Version…",
"icon": "$(tag)"
},
{
"command": "archify.sync.versions",
"title": "Archify | Versions…",
"icon": "$(history)"
},
{
"command": "archify.sync.stop",
"title": "Archify | Stop Syncing Model…",
"icon": "$(debug-disconnect)"
},
{
"command": "archify.sync.menu",
"title": "Archify | Sync…",
"icon": "$(broadcast)"
} }
], ],
"menus": { "menus": {
@@ -145,6 +196,10 @@
"command": "archify.showSource", "command": "archify.showSource",
"when": "archifyPreviewFocus || activeCustomEditorId == 'archify.htmlViewer' || activeCustomEditorId == 'archify.diagram' || activeCustomEditorId == 'archify.registry' || activeCustomEditorId == 'archify.decision'" "when": "archifyPreviewFocus || activeCustomEditorId == 'archify.htmlViewer' || activeCustomEditorId == 'archify.diagram' || activeCustomEditorId == 'archify.registry' || activeCustomEditorId == 'archify.decision'"
}, },
{
"command": "archify.openInTextEditor",
"when": "archifyPreviewFocus || activeCustomEditorId == 'archify.htmlViewer' || activeCustomEditorId == 'archify.diagram' || activeCustomEditorId == 'archify.registry' || activeCustomEditorId == 'archify.decision'"
},
{ {
"command": "archify.openModel", "command": "archify.openModel",
"when": "archify.isDiagramSource || archifyPreviewFocus || activeCustomEditorId == 'archify.diagram' || activeCustomEditorId == 'archify.registry' || activeCustomEditorId == 'archify.decision'" "when": "archify.isDiagramSource || archifyPreviewFocus || activeCustomEditorId == 'archify.diagram' || activeCustomEditorId == 'archify.registry' || activeCustomEditorId == 'archify.decision'"
@@ -152,6 +207,26 @@
{ {
"command": "archify.openModelGraph", "command": "archify.openModelGraph",
"when": "archify.isDiagramSource || archifyPreviewFocus || activeCustomEditorId == 'archify.diagram' || activeCustomEditorId == 'archify.registry' || activeCustomEditorId == 'archify.decision'" "when": "archify.isDiagramSource || archifyPreviewFocus || activeCustomEditorId == 'archify.diagram' || activeCustomEditorId == 'archify.registry' || activeCustomEditorId == 'archify.decision'"
},
{
"command": "archify.sync.invite",
"when": "archify.sync.active"
},
{
"command": "archify.sync.publish",
"when": "archify.sync.active"
},
{
"command": "archify.sync.versions",
"when": "archify.sync.active"
},
{
"command": "archify.sync.stop",
"when": "archify.sync.active"
},
{
"command": "archify.sync.menu",
"when": "archify.sync.active"
} }
], ],
"editor/title": [ "editor/title": [
@@ -171,7 +246,7 @@
"group": "navigation" "group": "navigation"
}, },
{ {
"command": "archify.showSource", "command": "archify.openInTextEditor",
"when": "archifyPreviewFocus || activeCustomEditorId == 'archify.htmlViewer' || activeCustomEditorId == 'archify.diagram' || activeCustomEditorId == 'archify.registry' || activeCustomEditorId == 'archify.decision'", "when": "archifyPreviewFocus || activeCustomEditorId == 'archify.htmlViewer' || activeCustomEditorId == 'archify.diagram' || activeCustomEditorId == 'archify.registry' || activeCustomEditorId == 'archify.decision'",
"group": "navigation" "group": "navigation"
}, },
@@ -241,6 +316,11 @@
"command": "archify.openModelGraph", "command": "archify.openModelGraph",
"when": "resourceFilename =~ /\\.archify(-registry|-decision)?$/", "when": "resourceFilename =~ /\\.archify(-registry|-decision)?$/",
"group": "zzz_archify@9" "group": "zzz_archify@9"
},
{
"command": "archify.sync.share",
"when": "resourceFilename == main.archify",
"group": "archify@9"
} }
], ],
"editor/title/context": [ "editor/title/context": [
@@ -454,10 +534,12 @@
{ {
"fileMatch": "*.archify-registry", "fileMatch": "*.archify-registry",
"url": "./schemas/archify-registry.schema.json" "url": "./schemas/archify-registry.schema.json"
}, }
],
"authentication": [
{ {
"fileMatch": "*.archify-decision", "id": "archify-sync",
"url": "./schemas/archify-decision.schema.json" "label": "Archify Sync"
} }
] ]
}, },
@@ -477,9 +559,9 @@
"@types/node": "^22.0.0", "@types/node": "^22.0.0",
"@types/three": "^0.186.0", "@types/three": "^0.186.0",
"@types/vscode": "~1.100.0", "@types/vscode": "~1.100.0",
"@types/ws": "^8.18.2",
"@vscode/test-electron": "^3.1.0", "@vscode/test-electron": "^3.1.0",
"@vscode/vsce": "^3.0.0", "@vscode/vsce": "^3.0.0",
"ajv": "^8.20.0",
"esbuild": "^0.25.0", "esbuild": "^0.25.0",
"jsonc-parser": "^3.3.1", "jsonc-parser": "^3.3.1",
"typescript": "^5.8.0" "typescript": "^5.8.0"
@@ -489,9 +571,24 @@
}, },
"homepage": "https://gitea.lego-cloud.eu/vscode-extensions/archify-vscode-ext#readme", "homepage": "https://gitea.lego-cloud.eu/vscode-extensions/archify-vscode-ext#readme",
"dependencies": { "dependencies": {
"@codemirror/autocomplete": "^6.20.4",
"@codemirror/commands": "^6.11.1",
"@codemirror/lang-yaml": "^6.1.3",
"@codemirror/language": "^6.13.1",
"@codemirror/lint": "^6.9.7",
"@codemirror/state": "^6.7.6",
"@codemirror/view": "^6.43.15",
"@lezer/highlight": "^1.2.5",
"ajv": "^8.20.0",
"codemirror": "^6.0.2",
"codemirror-json-schema": "^0.8.1",
"cytoscape": "^3.34.4", "cytoscape": "^3.34.4",
"cytoscape-fcose": "^2.2.0", "cytoscape-fcose": "^2.2.0",
"lib0": "^0.2.119",
"three": "^0.186.1", "three": "^0.186.1",
"yaml": "^2.9.1" "ws": "^8.22.1",
"y-protocols": "^1.0.7",
"yaml": "^2.9.1",
"yjs": "^13.6.33"
} }
} }
+10
View File
@@ -39,7 +39,17 @@ export function viewCommands(ctx: CommandContext): vscode.Disposable[] {
vscode.commands.registerCommand('archify.refreshPreview', () => ctx.views.activePreview?.update(true)), vscode.commands.registerCommand('archify.refreshPreview', () => ctx.views.activePreview?.update(true)),
// On a page that has a Source view, show it; elsewhere open the text.
vscode.commands.registerCommand('archify.showSource', async () => { vscode.commands.registerCommand('archify.showSource', async () => {
const session = ctx.views.activePreview?.source ?? ctx.registry.activeView?.source ?? ctx.decision.activeView?.source;
if (session) {
session.reveal();
return;
}
await vscode.commands.executeCommand('archify.openInTextEditor');
}),
vscode.commands.registerCommand('archify.openInTextEditor', async () => {
const preview = ctx.views.activePreview; const preview = ctx.views.activePreview;
if (preview?.isEditor) { if (preview?.isEditor) {
// The diagram is the editor; open the YAML text beside it. // The diagram is the editor; open the YAML text beside it.
+4 -2
View File
@@ -15,6 +15,7 @@ import { DiagramViewManager } from './views/diagramView';
import { RegistryViewProvider } from './views/registryView'; import { RegistryViewProvider } from './views/registryView';
import { DecisionViewProvider } from './views/decisionView'; import { DecisionViewProvider } from './views/decisionView';
import { DECISION_SELECTOR, DecisionLanguage } from './language/decisionLanguage'; import { DECISION_SELECTOR, DecisionLanguage } from './language/decisionLanguage';
import { registerSync } from './sync/loader';
export function activate(context: vscode.ExtensionContext): void { export function activate(context: vscode.ExtensionContext): void {
const models = new ModelService(); const models = new ModelService();
@@ -22,8 +23,8 @@ export function activate(context: vscode.ExtensionContext): void {
extension: context, extension: context,
views: new DiagramViewManager(context, models), views: new DiagramViewManager(context, models),
htmlViewer: new HtmlViewerProvider(context.extensionUri), htmlViewer: new HtmlViewerProvider(context.extensionUri),
registry: new RegistryViewProvider(models), registry: new RegistryViewProvider(context, models),
decision: new DecisionViewProvider(models), decision: new DecisionViewProvider(context, models),
models, models,
}; };
const refs = new RefLanguage(models); const refs = new RefLanguage(models);
@@ -47,6 +48,7 @@ export function activate(context: vscode.ExtensionContext): void {
...newDiagramCommands(ctx), ...newDiagramCommands(ctx),
...renderCommands(ctx), ...renderCommands(ctx),
...modelCommands(ctx), ...modelCommands(ctx),
...registerSync(context, models),
); );
registerContextKeys(context, models); registerContextKeys(context, models);
} }
+21 -6
View File
@@ -226,12 +226,27 @@ class GraphPage {
this.nameEl.textContent = this.graph.meta.name || this.graph.meta.id || 'Untitled model'; this.nameEl.textContent = this.graph.meta.name || this.graph.meta.id || 'Untitled model';
titles.append(this.kickerEl, this.nameEl); titles.append(this.kickerEl, this.nameEl);
const actions = el('div', 'ag-actions'); const actions = el('div', 'ag-actions');
const sw = el('button', 'ag-switch'); // Model | Graph | Source, as on the model page. Source goes back to the
sw.type = 'button'; // model page and opens it in Source (the page reads sourceView on load).
sw.title = 'Back to the model page'; const sw = el('div', 'ag-switch');
sw.setAttribute('aria-label', 'Graph view on; switch to the model page'); sw.setAttribute('role', 'group');
sw.append(el('span', 'ag-seg', 'Model'), el('span', 'ag-seg on', 'Graph')); sw.setAttribute('aria-label', 'View');
sw.addEventListener('click', () => this.host.post({ type: 'showModel' })); const segment = (label: string, title: string, on: boolean, action?: () => void) => {
const button = el('button', `ag-seg${on ? ' on' : ''}`, label);
button.type = 'button';
button.title = title;
button.setAttribute('aria-pressed', String(on));
if (action) button.addEventListener('click', action);
return button;
};
sw.append(
segment('Model', 'Back to the model page', false, () => this.host.post({ type: 'showModel' })),
segment('Graph', 'The model as one graph', true),
segment('Source', 'Edit the YAML of main.archify, checked as you type', false, () => {
this.host.setState({ sourceView: true });
this.host.post({ type: 'showModel' });
}),
);
const exportButton = el('button', 'ag-button ag-primary', 'Export PNG'); const exportButton = el('button', 'ag-button ag-primary', 'Export PNG');
exportButton.type = 'button'; exportButton.type = 'button';
exportButton.title = 'Save the graph as it is on screen, as a PNG'; exportButton.title = 'Save the graph as it is on screen, as a PNG';
+5 -4
View File
@@ -20,13 +20,14 @@ html, body { margin: 0; height: 100%; overflow: hidden; background: var(--ag-bg)
.ag-actions { margin-left: auto; display: flex; align-items: center; gap: 0.5rem; } .ag-actions { margin-left: auto; display: flex; align-items: center; gap: 0.5rem; }
.ag-bar .ag-button { min-height: 2rem; } .ag-bar .ag-button { min-height: 2rem; }
/* Toolbar controls follow Archify's: quiet pills (0.5rem) inside 0.5625rem buttons, one filled primary action (0.6875rem), the 2D | 3D switch's twin. */ /* Toolbar controls follow Archify's: quiet pills (0.5rem) inside 0.5625rem buttons, one filled primary action (0.6875rem), the 2D | 3D switch's twin. */
.ag-switch { position: relative; isolation: isolate; display: inline-flex; padding: 0 0.25rem; border: 0; border-radius: 0.5625rem; background: transparent; color: var(--ag-muted); font: inherit; cursor: pointer; } .ag-switch { position: relative; isolation: isolate; display: inline-flex; padding: 0 0.25rem; border: 0; border-radius: 0.5625rem; background: transparent; color: var(--ag-muted); font: inherit; }
.ag-switch::before { content: ""; position: absolute; z-index: -1; inset: 0.25rem 0; border-radius: 0.6875rem; background: color-mix(in srgb, var(--ag-panel) 78%, transparent); box-shadow: inset 0 0 0 1px color-mix(in srgb, var(--ag-border) 85%, transparent), 0 1px 2px rgba(15, 23, 42, 0.04); } .ag-switch::before { content: ""; position: absolute; z-index: -1; inset: 0.25rem 0; border-radius: 0.6875rem; background: color-mix(in srgb, var(--ag-panel) 78%, transparent); box-shadow: inset 0 0 0 1px color-mix(in srgb, var(--ag-border) 85%, transparent), 0 1px 2px rgba(15, 23, 42, 0.04); }
.ag-switch:hover::before { box-shadow: inset 0 0 0 1px color-mix(in srgb, var(--ag-fg) 22%, transparent), 0 1px 2px rgba(15, 23, 42, 0.04); } .ag-switch:hover::before { box-shadow: inset 0 0 0 1px color-mix(in srgb, var(--ag-fg) 22%, transparent), 0 1px 2px rgba(15, 23, 42, 0.04); }
.ag-switch:focus-visible { outline: 2px solid var(--ag-accent); outline-offset: -4px; } .ag-seg { display: inline-flex; align-items: center; height: 1.75rem; margin: 0.25rem 0; padding: 0 0.7rem; border: 0; border-radius: 0.5rem; background: transparent; color: inherit; font: inherit; font-weight: 550; font-size: 0.8125rem; cursor: pointer; transition: background 0.15s, color 0.15s; }
.ag-seg { display: inline-flex; align-items: center; height: 1.75rem; margin: 0.25rem 0; padding: 0 0.7rem; border-radius: 0.5rem; font-weight: 550; font-size: 0.8125rem; transition: background 0.15s, color 0.15s; } .ag-seg.on { cursor: default; }
.ag-seg:focus-visible { outline: 2px solid var(--ag-accent); outline-offset: 1px; }
.ag-seg.on { color: var(--ag-bg); background: var(--ag-fg); box-shadow: 0 1px 2px rgba(15, 23, 42, 0.12), 0 6px 16px -8px rgba(15, 23, 42, 0.4); } .ag-seg.on { color: var(--ag-bg); background: var(--ag-fg); box-shadow: 0 1px 2px rgba(15, 23, 42, 0.12), 0 6px 16px -8px rgba(15, 23, 42, 0.4); }
.ag-switch:hover .ag-seg:not(.on) { color: var(--ag-fg); } .ag-seg:hover:not(.on) { color: var(--ag-fg); }
.ag-button { position: relative; isolation: isolate; display: inline-flex; align-items: center; gap: 0.4rem; font: inherit; font-size: 0.8125rem; font-weight: 500; min-height: 2.25rem; padding: 0.25rem 0.58rem; border-radius: 0.5625rem; border: 0; background: transparent; color: var(--ag-muted); cursor: pointer; white-space: nowrap; transition: color 0.15s; } .ag-button { position: relative; isolation: isolate; display: inline-flex; align-items: center; gap: 0.4rem; font: inherit; font-size: 0.8125rem; font-weight: 500; min-height: 2.25rem; padding: 0.25rem 0.58rem; border-radius: 0.5625rem; border: 0; background: transparent; color: var(--ag-muted); cursor: pointer; white-space: nowrap; transition: color 0.15s; }
.ag-button::before { content: ""; position: absolute; z-index: -1; inset: 0.25rem 0; border-radius: 0.5rem; background: transparent; transition: background 0.15s, box-shadow 0.15s; } .ag-button::before { content: ""; position: absolute; z-index: -1; inset: 0.25rem 0; border-radius: 0.5rem; background: transparent; transition: background 0.15s, box-shadow 0.15s; }
.ag-button:hover { color: var(--ag-fg); } .ag-button:hover { color: var(--ag-fg); }
+37 -1
View File
@@ -10,6 +10,7 @@ import { isArchifyFile } from '../sources/detect';
import { log } from '../util/log'; import { log } from '../util/log';
import path from 'node:path'; import path from 'node:path';
import { diagnosticPointer, rangeForPointer, rangeForPointerYaml, yamlSyntaxProblems } from './jsonPointer'; import { diagnosticPointer, rangeForPointer, rangeForPointerYaml, yamlSyntaxProblems } from './jsonPointer';
import { DIAGRAM_SCHEMA, REGISTRY_SCHEMA, SchemaChecker, SchemaProblem, readSchemas } from './schemaCheck';
const JSON_LANGUAGES = new Set(['json', 'jsonc']); const JSON_LANGUAGES = new Set(['json', 'jsonc']);
@@ -33,6 +34,7 @@ export class DiagnosticsController implements vscode.Disposable {
private readonly timers = new Map<string, NodeJS.Timeout>(); private readonly timers = new Map<string, NodeJS.Timeout>();
private readonly sequence = new Map<string, number>(); private readonly sequence = new Map<string, number>();
private readonly disposables: vscode.Disposable[]; private readonly disposables: vscode.Disposable[];
private checker: SchemaChecker | undefined;
constructor( constructor(
private readonly context: vscode.ExtensionContext, private readonly context: vscode.ExtensionContext,
@@ -54,6 +56,22 @@ export class DiagnosticsController implements vscode.Disposable {
this.revalidateAll(); this.revalidateAll();
} }
/** Our schemas, compiled on first use. */
private schemas(): SchemaChecker {
this.checker ??= new SchemaChecker(readSchemas(vscode.Uri.joinPath(this.context.extensionUri, 'schemas').fsPath));
return this.checker;
}
private schemaDiagnostic(doc: vscode.TextDocument, problem: SchemaProblem): vscode.Diagnostic {
const diagnostic = new vscode.Diagnostic(
new vscode.Range(doc.positionAt(problem.from), doc.positionAt(problem.to)),
problem.message,
vscode.DiagnosticSeverity.Error,
);
diagnostic.source = 'archify';
return diagnostic;
}
private enabled(uri: vscode.Uri): boolean { private enabled(uri: vscode.Uri): boolean {
return vscode.workspace.getConfiguration('archify', uri).get<boolean>('validation.enabled', true); return vscode.workspace.getConfiguration('archify', uri).get<boolean>('validation.enabled', true);
} }
@@ -136,6 +154,17 @@ export class DiagnosticsController implements vscode.Disposable {
} }
} }
if (isArchifyFile(doc.fileName)) {
// The schema check sees the source as written and answers at once; a
// file that fails it would fail archify validate the same way, so that
// runs only on files the schema accepts.
const schemaProblems = this.schemas().check(text, DIAGRAM_SCHEMA);
if (schemaProblems.length) {
this.collection.set(doc.uri, [...modelDiagnostics, ...schemaProblems.map((problem) => this.schemaDiagnostic(doc, problem))]);
return;
}
}
try { try {
const runtime = await runtimeFor(this.context, doc.uri); const runtime = await runtimeFor(this.context, doc.uri);
const result = await validate(runtime, source.type, source.json); const result = await validate(runtime, source.type, source.json);
@@ -210,6 +239,10 @@ export class DiagnosticsController implements vscode.Disposable {
const root = await this.models.rootOf(doc.uri); const root = await this.models.rootOf(doc.uri);
const rel = root ? path.relative(root.fsPath, doc.uri.fsPath) : path.basename(doc.uri.fsPath); const rel = root ? path.relative(root.fsPath, doc.uri.fsPath) : path.basename(doc.uri.fsPath);
const problems: ModelProblem[] = [...parseRegistry(text, rel).problems]; const problems: ModelProblem[] = [...parseRegistry(text, rel).problems];
// The schema adds what the parser does not check (types, unknown keys,
// ids); a file the parser already rejects as a whole gets no second opinion.
const shapeless = problems.some((p) => /not valid YAML|must be a mapping|needs an "elements" mapping/.test(p.message));
const schemaProblems = shapeless ? [] : this.schemas().check(text, REGISTRY_SCHEMA);
if (root) { if (root) {
try { try {
const index = await this.models.index(root); const index = await this.models.index(root);
@@ -223,7 +256,10 @@ export class DiagnosticsController implements vscode.Disposable {
problems.push({ message: `This registry is not inside a model: no main.archify above ${path.basename(doc.uri.fsPath)}.`, severity: 'warning', line: 0 }); problems.push({ message: `This registry is not inside a model: no main.archify above ${path.basename(doc.uri.fsPath)}.`, severity: 'warning', line: 0 });
} }
if (seq !== this.sequence.get(doc.uri.toString()) || doc.isClosed) return; if (seq !== this.sequence.get(doc.uri.toString()) || doc.isClosed) return;
this.collection.set(doc.uri, problems.map((problem) => this.modelDiagnostic(doc, text, 'yaml', problem))); this.collection.set(doc.uri, [
...problems.map((problem) => this.modelDiagnostic(doc, text, 'yaml', problem)),
...schemaProblems.map((problem) => this.schemaDiagnostic(doc, problem)),
]);
} }
dispose(): void { dispose(): void {
+85
View File
@@ -0,0 +1,85 @@
import { DIAGRAM_SCHEMA, REGISTRY_SCHEMA } from './schemaCheck';
type Json = null | boolean | number | string | Json[] | { [key: string]: Json };
/**
* Schemas for completion and hover in the Source view. The editor's schema
* library reads one draft-07 document, while ours are 2020-12 files that
* refer to each other; so the referenced files are folded into `$defs` and
* 2020-12 tuples become draft-07 ones. Problems never come from these
* copies (the host checks with the originals), only suggestions.
*/
export class EditorSchemas {
private readonly cache = new Map<string, object>();
constructor(private readonly schemas: Record<string, object>) {}
/** The schema for a file kind; for diagrams the one of its diagram_type. */
forSource(kind: 'diagram' | 'registry' | 'decision', text: string): { key: string; schema: object } | undefined {
if (kind === 'decision') return undefined;
if (kind === 'registry') return this.get(REGISTRY_SCHEMA);
const type = /^diagram_type:\s*["']?([a-z]+)/m.exec(text)?.[1];
const name = type && this.schemas[`${type}.schema.json`] ? `${type}.schema.json` : DIAGRAM_SCHEMA;
return this.get(name);
}
private get(name: string): { key: string; schema: object } | undefined {
if (!this.schemas[name]) return undefined;
if (!this.cache.has(name)) this.cache.set(name, bundleSchema(this.schemas, name));
return { key: name, schema: this.cache.get(name)! };
}
}
const defKey = (file: string) => `file:${file}`;
/** One self-contained draft-07 shaped schema for `root` and every file it refers to. */
export function bundleSchema(schemas: Record<string, object>, root: string): object {
const files = new Set<string>([root]);
const queue = [root];
while (queue.length) {
const file = queue.shift()!;
for (const ref of refsOf(schemas[file] as Json)) {
const target = ref.split('#')[0];
if (target && !files.has(target) && schemas[target]) {
files.add(target);
queue.push(target);
}
}
}
const base = (file: string) => (file === root ? '#' : `#/$defs/${defKey(file)}`);
const rewrite = (node: Json, file: string): Json => {
if (Array.isArray(node)) return node.map((item) => rewrite(item, file));
if (!node || typeof node !== 'object') return node;
const out: { [key: string]: Json } = {};
for (const [key, value] of Object.entries(node)) {
if (key === '$ref' && typeof value === 'string') {
const [target, pointer = ''] = value.split('#');
out.$ref = `${base(target || file)}${pointer}`;
} else if (key !== '$schema' && key !== '$id') {
out[key] = rewrite(value, file);
}
}
if (out.prefixItems) {
if (out.items === false) out.additionalItems = false;
else if (out.items !== undefined) out.additionalItems = out.items;
out.items = out.prefixItems;
delete out.prefixItems;
}
return out;
};
const bundled = rewrite(schemas[root] as Json, root) as { [key: string]: Json };
const defs = { ...((bundled.$defs as { [key: string]: Json } | undefined) ?? {}) };
for (const file of files) if (file !== root) defs[defKey(file)] = rewrite(schemas[file] as Json, file);
return { ...bundled, $defs: defs };
}
function refsOf(node: Json, out: string[] = []): string[] {
if (Array.isArray(node)) node.forEach((item) => refsOf(item, out));
else if (node && typeof node === 'object') {
for (const [key, value] of Object.entries(node)) {
if (key === '$ref' && typeof value === 'string') out.push(value);
else refsOf(value, out);
}
}
return out;
}
+148
View File
@@ -0,0 +1,148 @@
import fs from 'node:fs';
import path from 'node:path';
import Ajv2020, { ErrorObject, ValidateFunction } from 'ajv/dist/2020';
import { LineCounter, Node, isMap, isScalar, isSeq, parseDocument } from 'yaml';
/** A schema problem placed on the YAML node it is about; offsets into the text. */
export interface SchemaProblem {
from: number;
to: number;
message: string;
/** 'yaml' for a syntax error (only the first is reported), 'schema' otherwise. */
kind: 'yaml' | 'schema';
}
/** Schema file names in schemas/ that a file kind is checked against. */
export const DIAGRAM_SCHEMA = 'archify.schema.json';
export const REGISTRY_SCHEMA = 'archify-registry.schema.json';
/** Reads every *.schema.json of a folder: file name → schema. */
export function readSchemas(folder: string): Record<string, object> {
return Object.fromEntries(
fs
.readdirSync(folder)
.filter((name) => name.endsWith('.schema.json'))
.map((name) => [name, JSON.parse(fs.readFileSync(path.join(folder, name), 'utf8')) as object]),
);
}
/**
* Checks YAML text against our JSON Schemas (draft 2020-12, with ajv), so the
* Source view and the Problems panel see the same problems whether or not a
* YAML extension is installed. Schemas refer to each other by file name.
*/
export class SchemaChecker {
private readonly ajv = new Ajv2020({ allErrors: true, strict: false });
private readonly compiled = new Map<string, ValidateFunction | undefined>();
constructor(schemas: Record<string, object>) {
for (const [name, schema] of Object.entries(schemas)) this.ajv.addSchema(schema, name);
}
private validator(name: string): ValidateFunction | undefined {
if (!this.compiled.has(name)) this.compiled.set(name, this.ajv.getSchema(name));
return this.compiled.get(name);
}
check(text: string, schema: string): SchemaProblem[] {
const doc = parseDocument(text, { lineCounter: new LineCounter(), prettyErrors: false, uniqueKeys: false });
if (doc.errors.length) {
// Later syntax errors are usually echoes of the first.
const error = doc.errors[0];
return [{ from: error.pos[0], to: Math.max(error.pos[1], error.pos[0] + 1), message: `YAML: ${error.message.split('\n')[0]}`, kind: 'yaml' }];
}
const validate = this.validator(schema);
if (!validate || validate(doc.toJS())) return [];
return collapse(validate.errors ?? []).map((error) => {
const [from, to] = rangeFor(doc.contents, error, text.length);
return { from, to, message: describe(error), kind: 'schema' as const };
});
}
}
/** oneOf/anyOf/if produce a cascade; keep the errors a person can act on. */
function collapse(errors: ErrorObject[]): ErrorObject[] {
const seen = new Set<string>();
return errors
.filter((e) => !['if', 'oneOf', 'anyOf', 'allOf'].includes(e.keyword))
.filter((e) => {
const key = `${e.instancePath}|${e.keyword}|${JSON.stringify(e.params)}`;
if (seen.has(key)) return false;
seen.add(key);
return true;
});
}
/** "/connections/4/label" → "connections[4].label". */
export function readablePointer(pointer: string): string {
if (!pointer) return 'the file';
return pointer
.split('/')
.slice(1)
.map((part) => (/^\d+$/.test(part) ? `[${part}]` : `.${part.replace(/~1/g, '/').replace(/~0/g, '~')}`))
.join('')
.replace(/^\./, '');
}
function describe(e: ErrorObject): string {
const where = readablePointer(e.instancePath);
const params = e.params as Record<string, unknown>;
switch (e.keyword) {
case 'additionalProperties':
return `Unknown key "${params.additionalProperty}" in ${where}.`;
case 'required':
return `"${params.missingProperty}" is required in ${where}.`;
case 'enum':
return `${where} must be one of: ${(params.allowedValues as unknown[]).join(', ')}.`;
case 'const':
return `${where} must be ${JSON.stringify(params.allowedValue)}.`;
case 'type': {
const type = String(params.type);
return `${where} must be ${type === 'array' ? 'a list' : type === 'object' ? 'a mapping' : `a ${type}`}.`;
}
case 'minItems':
case 'maxItems': {
const limit = Number(params.limit);
return `${where} needs ${e.keyword === 'minItems' ? 'at least' : 'at most'} ${limit} item${limit === 1 ? '' : 's'}.`;
}
case 'propertyNames':
return `"${params.propertyName}" in ${where} is not a valid id: start with a letter; letters, digits, - and _ after.`;
default:
return `${where} ${e.message ?? 'is not valid'}.`;
}
}
function keyText(key: unknown): string {
return isScalar(key) ? String(key.value) : String(key);
}
/** The node an error is about: the offending key for unknown keys, else the value. */
function rangeFor(root: Node | null, error: ErrorObject, length: number): [number, number] {
const parts = error.instancePath.split('/').slice(1).map((p) => p.replace(/~1/g, '/').replace(/~0/g, '~'));
let node: unknown = root;
let keyNode: Node | null = null;
for (const part of parts) {
if (isMap(node)) {
const pair = node.items.find((p) => keyText(p.key) === part);
if (!pair) break;
keyNode = pair.key as Node;
node = pair.value;
} else if (isSeq(node)) {
keyNode = null;
node = node.items[Number(part)];
} else break;
}
const params = error.params as Record<string, unknown>;
const extra = params.additionalProperty ?? params.propertyName;
if (extra !== undefined && isMap(node)) {
const pair = node.items.find((p) => keyText(p.key) === String(extra));
const range = (pair?.key as Node | undefined)?.range;
if (range) return [range[0], range[1]];
}
if (error.keyword === 'required' && keyNode?.range) return [keyNode.range[0], keyNode.range[1]];
const target = (node as Node | undefined)?.range ? (node as Node) : keyNode;
if (!target?.range) return [0, Math.min(1, length)];
// A block mapping or list spans many lines; mark its first character only.
if ((isMap(target) || isSeq(target)) && !target.flow) return [target.range[0], target.range[0] + 1];
return [target.range[0], Math.max(target.range[1], target.range[0] + 1)];
}
+5 -3
View File
@@ -1,4 +1,4 @@
import { isMap, isScalar, isSeq, parseDocument } from 'yaml'; import { LineCounter, isMap, isScalar, isSeq, parseDocument } from 'yaml';
import { ModelProblem, Registry } from './format'; import { ModelProblem, Registry } from './format';
/** /**
@@ -46,9 +46,11 @@ export function slugify(title: string): string {
/** Parses one decision file. Problems carry 0-based lines. */ /** Parses one decision file. Problems carry 0-based lines. */
export function parseDecision(text: string, file: string): { decision?: Decision; problems: ModelProblem[] } { export function parseDecision(text: string, file: string): { decision?: Decision; problems: ModelProblem[] } {
const problems: ModelProblem[] = []; const problems: ModelProblem[] = [];
const doc = parseDocument(text, { prettyErrors: false, uniqueKeys: false }); // prettyErrors would put line numbers into the messages; the line counter gives them without.
const lines = new LineCounter();
const doc = parseDocument(text, { prettyErrors: false, uniqueKeys: false, lineCounter: lines });
for (const error of doc.errors) { for (const error of doc.errors) {
problems.push({ message: `Decision is not valid YAML: ${error.message.split('\n')[0]}`, severity: 'error', file, line: error.linePos?.[0].line ? error.linePos[0].line - 1 : 0 }); problems.push({ message: `Decision is not valid YAML: ${error.message.split('\n')[0]}`, severity: 'error', file, line: lines.linePos(error.pos[0]).line - 1 });
} }
if (doc.errors.length) return { problems }; if (doc.errors.length) return { problems };
const lineOf = (offset: number | undefined) => (offset === undefined ? 0 : text.slice(0, offset).split('\n').length - 1); const lineOf = (offset: number | undefined) => (offset === undefined ? 0 : text.slice(0, offset).split('\n').length - 1);
+5 -3
View File
@@ -1,4 +1,4 @@
import { isMap, isScalar, parseDocument, parse as parseYaml } from 'yaml'; import { LineCounter, isMap, isScalar, parse as parseYaml, parseDocument } from 'yaml';
/** /**
* The model file formats (see docs/model.md): `main.archify` with a `model` * The model file formats (see docs/model.md): `main.archify` with a `model`
@@ -83,9 +83,11 @@ export function hasDiagramBody(doc: unknown): boolean {
export function parseRegistry(text: string, file: string): { elements: RegistryElement[]; problems: ModelProblem[] } { export function parseRegistry(text: string, file: string): { elements: RegistryElement[]; problems: ModelProblem[] } {
const problems: ModelProblem[] = []; const problems: ModelProblem[] = [];
const elements: RegistryElement[] = []; const elements: RegistryElement[] = [];
const doc = parseDocument(text, { prettyErrors: false, uniqueKeys: false }); // prettyErrors would put line numbers into the messages; the line counter gives them without.
const lines = new LineCounter();
const doc = parseDocument(text, { prettyErrors: false, uniqueKeys: false, lineCounter: lines });
for (const error of doc.errors) { for (const error of doc.errors) {
problems.push({ message: `Registry is not valid YAML: ${error.message.split('\n')[0]}`, severity: 'error', file, line: error.linePos?.[0].line ? error.linePos[0].line - 1 : 0 }); problems.push({ message: `Registry is not valid YAML: ${error.message.split('\n')[0]}`, severity: 'error', file, line: lines.linePos(error.pos[0]).line - 1 });
} }
if (doc.errors.length) return { elements, problems }; if (doc.errors.length) return { elements, problems };
const lineOf = (offset: number | undefined) => (offset === undefined ? 0 : text.slice(0, offset).split('\n').length - 1); const lineOf = (offset: number | undefined) => (offset === undefined ? 0 : text.slice(0, offset).split('\n').length - 1);
+102
View File
@@ -0,0 +1,102 @@
import {
ApiError,
Invite,
JoinResponse,
Member,
PROTOCOL_VERSION,
ServerInfo,
Space,
TokenResponse,
Version,
VersionFiles,
} from './protocol';
export class SyncApiError extends Error {
constructor(readonly status: number, readonly code: string, message: string) {
super(message);
}
}
const LOOPBACK = new Set(['localhost', '127.0.0.1', '[::1]']);
/**
* The server address as the extension keeps it: http(s), no trailing slash.
* Plain http is refused except on this machine; tokens travel on it.
*/
export function checkServerUrl(raw: string): { url?: string; problem?: string } {
let url: URL;
try {
url = new URL(raw.trim());
} catch {
return { problem: 'Enter the server address, for example https://archify.example.com' };
}
if (url.protocol !== 'https:' && url.protocol !== 'http:') return { problem: 'The address starts with https://' };
if (url.protocol === 'http:' && !LOOPBACK.has(url.hostname)) return { problem: 'Use https://. Plain http:// is only for a server on this machine.' };
return { url: `${url.origin}${url.pathname.replace(/\/+$/, '')}` };
}
export function syncSocketUrl(server: string, space: string): string {
return `${server.replace(/^http/, 'ws')}/v1/spaces/${space}/sync?v=${PROTOCOL_VERSION}`;
}
/** Reads `server` and `invite` from an invite link: `https://…/join/<token>` or the extension's `…/join?server=&invite=`. */
export function parseInviteLink(raw: string): { server: string; invite: string } | undefined {
try {
const url = new URL(raw.trim());
const server = url.searchParams.get('server');
const invite = url.searchParams.get('invite');
if (server && invite) return { server: server.replace(/\/+$/, ''), invite };
const match = /^(.*)\/join\/([A-Za-z0-9_-]{20,})\/?$/.exec(url.pathname);
if (match && (url.protocol === 'https:' || url.protocol === 'http:')) return { server: `${url.origin}${match[1]}`, invite: match[2] };
} catch {
// not a URL
}
return undefined;
}
/** The server's HTTP API. `token` gives a fresh access token for calls that need one. */
export class SyncApi {
constructor(readonly server: string, private readonly token?: (force?: boolean) => Promise<string | undefined>) {}
private async request<T>(method: string, path: string, body?: unknown, signedIn = true): Promise<T> {
const send = async (force: boolean) => {
const headers: Record<string, string> = { accept: 'application/json' };
if (body !== undefined) headers['content-type'] = 'application/json';
if (signedIn) {
const token = await this.token?.(force);
if (!token) throw new SyncApiError(401, 'unauthorized', 'Sign in to the sync server first.');
headers.authorization = `Bearer ${token}`;
}
return fetch(`${this.server}${path}`, { method, headers, body: body === undefined ? undefined : JSON.stringify(body) });
};
let response = await send(false);
// The access token may have expired between the check and the call.
if (response.status === 401 && signedIn) response = await send(true);
const text = await response.text();
if (!response.ok) {
let error: Partial<ApiError> = {};
try {
error = JSON.parse(text) as ApiError;
} catch {
// not JSON
}
throw new SyncApiError(response.status, error.error ?? 'http', error.message ?? `The server answered ${response.status}.`);
}
return (text ? JSON.parse(text) : undefined) as T;
}
info = () => this.request<ServerInfo>('GET', '/v1/info', undefined, false);
exchangeCode = (code: string, codeVerifier: string, redirectUri: string) =>
this.request<TokenResponse>('POST', '/v1/auth/token', { grant_type: 'authorization_code', code, code_verifier: codeVerifier, redirect_uri: redirectUri }, false);
refresh = (refreshToken: string) => this.request<TokenResponse>('POST', '/v1/auth/token', { grant_type: 'refresh_token', refresh_token: refreshToken }, false);
logout = (refreshToken: string) => this.request<void>('POST', '/v1/auth/logout', { refresh_token: refreshToken }, false);
spaces = () => this.request<Space[]>('GET', '/v1/spaces');
createSpace = (name: string) => this.request<Space>('POST', '/v1/spaces', { name });
members = (space: string) => this.request<Member[]>('GET', `/v1/spaces/${space}/members`);
invite = (space: string) => this.request<Invite>('POST', `/v1/spaces/${space}/invites`, {});
acceptInvite = (token: string) => this.request<JoinResponse>('POST', `/v1/invites/${encodeURIComponent(token)}/accept`);
versions = (space: string) => this.request<Version[]>('GET', `/v1/spaces/${space}/versions`);
publish = (space: string, name: string) => this.request<Version>('POST', `/v1/spaces/${space}/versions`, { name });
versionFiles = (space: string, version: number) => this.request<VersionFiles>('GET', `/v1/spaces/${space}/versions/${version}/files`);
restore = (space: string, version: number) => this.request<Version>('POST', `/v1/spaces/${space}/versions/${version}/restore`);
}
+206
View File
@@ -0,0 +1,206 @@
import * as crypto from 'node:crypto';
import * as vscode from 'vscode';
import { SyncApi, SyncApiError } from './api';
import { Account, TokenResponse } from './protocol';
export const AUTH_PROVIDER_ID = 'archify-sync';
const SECRET_KEY = 'archifySync.sessions';
const SIGN_IN_TIMEOUT_MS = 5 * 60_000;
interface StoredSession {
id: string;
server: string;
accessToken: string;
/** Epoch ms. */
expiresAt: number;
refreshToken: string;
account: Account;
}
interface PendingSignIn {
resolve: (code: string) => void;
reject: (error: Error) => void;
}
/**
* "Archify Sync" in the Accounts menu: one session per server. Sign-in runs
* in the browser and comes back through the extension's URI handler with a
* one-time code, exchanged with a PKCE verifier. Tokens live in SecretStorage.
* Refresh tokens are single use, so refreshes are serialised per server and
* read the latest stored session first (another window may have refreshed).
*/
export class SyncAuth implements vscode.AuthenticationProvider, vscode.Disposable {
private readonly changed = new vscode.EventEmitter<vscode.AuthenticationProviderAuthenticationSessionsChangeEvent>();
readonly onDidChangeSessions = this.changed.event;
private readonly pending = new Map<string, PendingSignIn>();
private readonly refreshing = new Map<string, Promise<string | undefined>>();
private readonly disposables: vscode.Disposable[];
constructor(private readonly context: vscode.ExtensionContext, private readonly log: vscode.LogOutputChannel) {
this.disposables = [
vscode.authentication.registerAuthenticationProvider(AUTH_PROVIDER_ID, 'Archify Sync', this, { supportsMultipleAccounts: true }),
// Another window signed in or out.
context.secrets.onDidChange((e) => {
if (e.key === SECRET_KEY) this.changed.fire({ added: [], removed: [], changed: [] });
}),
];
}
private async load(): Promise<StoredSession[]> {
try {
return JSON.parse((await this.context.secrets.get(SECRET_KEY)) ?? '[]') as StoredSession[];
} catch {
return [];
}
}
private async save(sessions: StoredSession[]): Promise<void> {
await this.context.secrets.store(SECRET_KEY, JSON.stringify(sessions));
}
private toSession(s: StoredSession): vscode.AuthenticationSession {
return {
id: s.id,
accessToken: s.accessToken,
account: { id: s.account.id, label: `${s.account.display_name} (${new URL(s.server).host})` },
scopes: [s.server],
};
}
async getSessions(scopes?: readonly string[]): Promise<vscode.AuthenticationSession[]> {
const server = scopes?.[0];
return (await this.load()).filter((s) => !server || s.server === server).map((s) => this.toSession(s));
}
async createSession(scopes: readonly string[]): Promise<vscode.AuthenticationSession> {
const server = scopes[0];
if (!server) throw new Error('Archify Sync: say which server to sign in to.');
return this.toSession(await this.signIn(server));
}
async removeSession(id: string): Promise<void> {
const sessions = await this.load();
const gone = sessions.find((s) => s.id === id);
if (!gone) return;
await this.save(sessions.filter((s) => s.id !== id));
new SyncApi(gone.server).logout(gone.refreshToken).catch(() => undefined);
this.changed.fire({ added: [], removed: [this.toSession(gone)], changed: [] });
}
async session(server: string): Promise<StoredSession | undefined> {
return (await this.load()).find((s) => s.server === server);
}
async servers(): Promise<string[]> {
return [...new Set((await this.load()).map((s) => s.server))];
}
/** Signs in through the browser; with an invite, the page also offers to make an account. */
async signIn(server: string, invite?: string): Promise<StoredSession> {
const verifier = crypto.randomBytes(32).toString('base64url');
const challenge = crypto.createHash('sha256').update(verifier).digest('base64url');
const state = crypto.randomBytes(16).toString('base64url');
const callback = await vscode.env.asExternalUri(vscode.Uri.parse(`${vscode.env.uriScheme}://${this.context.extension.id}/auth`));
const redirectUri = callback.toString(true);
const query = new URLSearchParams({
response_type: 'code',
redirect_uri: redirectUri,
state,
code_challenge: challenge,
code_challenge_method: 'S256',
});
if (invite) query.set('invite', invite);
const code = await vscode.window.withProgress(
{ location: vscode.ProgressLocation.Notification, title: `Archify: signing in to ${new URL(server).host} in the browser…`, cancellable: true },
(_progress, cancel) =>
new Promise<string>((resolve, reject) => {
const timer = setTimeout(() => reject(new Error('The sign-in took too long. Try again.')), SIGN_IN_TIMEOUT_MS);
const done = () => {
clearTimeout(timer);
this.pending.delete(state);
};
this.pending.set(state, {
resolve: (c) => (done(), resolve(c)),
reject: (e) => (done(), reject(e)),
});
cancel.onCancellationRequested(() => this.pending.get(state)?.reject(new Error('Sign-in cancelled.')));
void vscode.env.openExternal(vscode.Uri.parse(`${server}/authorize?${query}`, true)).then((opened) => {
if (!opened) this.pending.get(state)?.reject(new Error('The browser did not open.'));
});
}),
);
const tokens = await new SyncApi(server).exchangeCode(code, verifier, redirectUri);
const session = await this.store(server, tokens);
await this.context.globalState.update('archifySync.used', true);
this.log.info(`sync: signed in to ${server} as ${tokens.account.name}`);
return session;
}
/** The browser came back: `…/auth?code=&state=`. */
handleAuthUri(uri: vscode.Uri): void {
const query = new URLSearchParams(uri.query);
const state = query.get('state') ?? '';
const code = query.get('code');
const pending = this.pending.get(state);
if (!pending) {
this.log.warn('sync: a sign-in came back that this window did not start');
return;
}
if (code) pending.resolve(code);
else pending.reject(new Error(query.get('error_description') ?? 'The sign-in was not completed.'));
}
private async store(server: string, tokens: TokenResponse, id?: string): Promise<StoredSession> {
const session: StoredSession = {
id: id ?? crypto.randomUUID(),
server,
accessToken: tokens.access_token,
expiresAt: Date.now() + tokens.expires_in * 1000,
refreshToken: tokens.refresh_token,
account: tokens.account,
};
const others = (await this.load()).filter((s) => s.server !== server);
await this.save([...others, session]);
const event = id ? { added: [], removed: [], changed: [this.toSession(session)] } : { added: [this.toSession(session)], removed: [], changed: [] };
this.changed.fire(event);
return session;
}
/** A valid access token for the server, refreshed when close to expiry; undefined without a session. */
accessToken(server: string, force = false): Promise<string | undefined> {
const running = this.refreshing.get(server);
if (running) return running;
const work = this.freshToken(server, force).finally(() => this.refreshing.delete(server));
this.refreshing.set(server, work);
return work;
}
private async freshToken(server: string, force: boolean): Promise<string | undefined> {
const session = await this.session(server);
if (!session) return undefined;
if (!force && session.expiresAt - 60_000 > Date.now()) return session.accessToken;
try {
const tokens = await new SyncApi(server).refresh(session.refreshToken);
return (await this.store(server, tokens, session.id)).accessToken;
} catch (error) {
if (error instanceof SyncApiError && error.status === 401) {
// Expired, or signed out elsewhere: the person signs in again.
const latest = await this.session(server);
if (latest && latest.refreshToken !== session.refreshToken) return latest.accessToken;
await this.removeSession(session.id);
this.log.warn(`sync: the session for ${server} ended; sign in again`);
return undefined;
}
// Offline: keep the old token; the connection waits and tries again.
this.log.info(`sync: could not refresh the token for ${server} (${String(error)})`);
return session.accessToken;
}
}
dispose(): void {
for (const pending of this.pending.values()) pending.reject(new Error('Closed.'));
for (const d of this.disposables) d.dispose();
this.changed.dispose();
}
}
+197
View File
@@ -0,0 +1,197 @@
import WebSocket from 'ws';
import * as Y from 'yjs';
import * as awarenessProtocol from 'y-protocols/awareness';
import * as syncProtocol from 'y-protocols/sync';
import * as decoding from 'lib0/decoding';
import * as encoding from 'lib0/encoding';
const MESSAGE_SYNC = 0;
const MESSAGE_AWARENESS = 1;
const MESSAGE_QUERY_AWARENESS = 3;
export type ConnectionState =
| 'connecting'
| 'online'
| 'offline'
/** No session for the server, or the server refused it. */
| 'signed-out'
/** The server no longer lets this account in (removed from the space). */
| 'forbidden'
/** The server speaks another protocol version. */
| 'outdated';
export interface ConnectionOptions {
url: string;
/** A fresh access token; `force` after the server refused the last one. */
token: (force: boolean) => Promise<string | undefined>;
doc: Y.Doc;
awareness: awarenessProtocol.Awareness;
onState: (state: ConnectionState) => void;
/** After the first full exchange of each connection. */
onSynced: () => void;
log: (message: string) => void;
}
/**
* One space's WebSocket to the server: the y-websocket protocol (sync step 1
* and 2, updates, awareness), reconnecting with backoff. Edits made while
* offline go out on reconnect through the state-vector exchange.
*/
export class LiveConnection {
state: ConnectionState = 'connecting';
synced = false;
private socket?: WebSocket;
private attempt = 0;
private timer?: NodeJS.Timeout;
private closed = false;
private forceToken = false;
constructor(private readonly options: ConnectionOptions) {
options.doc.on('update', this.onDocUpdate);
options.awareness.on('update', this.onAwarenessUpdate);
void this.connect();
}
/** Connects at once, e.g. after signing in. */
reconnectNow(): void {
if (this.closed || this.state === 'online' || this.state === 'connecting') return;
clearTimeout(this.timer);
this.attempt = 0;
void this.connect();
}
private setState(state: ConnectionState): void {
if (this.state === state) return;
this.state = state;
this.options.onState(state);
}
private async connect(): Promise<void> {
if (this.closed) return;
this.setState('connecting');
let token: string | undefined;
try {
token = await this.options.token(this.forceToken);
} catch (error) {
this.options.log(`sync: no token (${String(error)})`);
}
this.forceToken = false;
if (this.closed) return;
if (!token) {
this.setState('signed-out');
return;
}
const socket = new WebSocket(this.options.url, { headers: { authorization: `Bearer ${token}` }, handshakeTimeout: 10_000 });
socket.binaryType = 'arraybuffer';
this.socket = socket;
let refused = false;
socket.on('open', () => {
const step1 = encoding.createEncoder();
encoding.writeVarUint(step1, MESSAGE_SYNC);
syncProtocol.writeSyncStep1(step1, this.options.doc);
this.send(encoding.toUint8Array(step1));
if (this.options.awareness.getLocalState() !== null) this.sendAwareness([this.options.doc.clientID]);
});
socket.on('message', (data: ArrayBuffer) => this.receive(new Uint8Array(data)));
socket.on('unexpected-response', (_request, response) => {
refused = true;
const status = response.statusCode ?? 0;
this.options.log(`sync: the server refused the connection (${status})`);
if (status === 401) {
// Try once more with a refreshed token; without a session, stop.
this.forceToken = true;
this.setState('signed-out');
this.schedule(true);
} else if (status === 403 || status === 404) {
this.setState('forbidden');
} else if (status === 426) {
this.setState('outdated');
} else {
this.setState('offline');
this.schedule();
}
socket.terminate();
});
socket.on('error', (error) => this.options.log(`sync: ${error.message}`));
socket.on('close', () => {
if (this.socket !== socket) return;
this.socket = undefined;
this.synced = false;
const others = [...this.options.awareness.getStates().keys()].filter((id) => id !== this.options.doc.clientID);
awarenessProtocol.removeAwarenessStates(this.options.awareness, others, this);
if (this.closed || refused) return;
this.setState('offline');
this.schedule();
});
}
/** Backoff: 0.5 s doubling to 30 s, with jitter. */
private schedule(once = false): void {
if (this.closed) return;
clearTimeout(this.timer);
if (once && this.attempt > 0) return;
const delay = Math.min(30_000, 500 * 2 ** this.attempt) * (0.75 + Math.random() / 2);
this.attempt++;
this.timer = setTimeout(() => void this.connect(), delay);
}
private receive(bytes: Uint8Array): void {
const decoder = decoding.createDecoder(bytes);
const type = decoding.readVarUint(decoder);
if (type === MESSAGE_SYNC) {
const reply = encoding.createEncoder();
encoding.writeVarUint(reply, MESSAGE_SYNC);
const sub = syncProtocol.readSyncMessage(decoder, reply, this.options.doc, this);
if (encoding.length(reply) > 1) this.send(encoding.toUint8Array(reply));
if (sub === syncProtocol.messageYjsSyncStep2 && !this.synced) {
this.synced = true;
this.attempt = 0;
this.setState('online');
this.options.onSynced();
}
} else if (type === MESSAGE_AWARENESS) {
awarenessProtocol.applyAwarenessUpdate(this.options.awareness, decoding.readVarUint8Array(decoder), this);
} else if (type === MESSAGE_QUERY_AWARENESS) {
this.sendAwareness([...this.options.awareness.getStates().keys()]);
}
}
private send(bytes: Uint8Array): void {
if (this.socket?.readyState === WebSocket.OPEN) this.socket.send(bytes);
}
private sendAwareness(clients: number[]): void {
const message = encoding.createEncoder();
encoding.writeVarUint(message, MESSAGE_AWARENESS);
encoding.writeVarUint8Array(message, awarenessProtocol.encodeAwarenessUpdate(this.options.awareness, clients));
this.send(encoding.toUint8Array(message));
}
private readonly onDocUpdate = (update: Uint8Array, origin: unknown) => {
if (origin === this) return;
const message = encoding.createEncoder();
encoding.writeVarUint(message, MESSAGE_SYNC);
syncProtocol.writeUpdate(message, update);
this.send(encoding.toUint8Array(message));
};
private readonly onAwarenessUpdate = (
{ added, updated, removed }: { added: number[]; updated: number[]; removed: number[] },
origin: unknown,
) => {
if (origin === this) return;
this.sendAwareness([...added, ...updated, ...removed]);
};
dispose(): void {
this.closed = true;
clearTimeout(this.timer);
// Tell the others this editor left before closing.
awarenessProtocol.removeAwarenessStates(this.options.awareness, [this.options.doc.clientID], 'dispose');
this.options.doc.off('update', this.onDocUpdate);
this.options.awareness.off('update', this.onAwarenessUpdate);
this.socket?.close();
this.socket = undefined;
}
}
+140
View File
@@ -0,0 +1,140 @@
import * as vscode from 'vscode';
import { normalizeEol, offsetOf, positionOf } from '../util/textDiff';
import type { LiveCursor, LiveSelection } from './liveBridge';
/** One colour per person, the same in every window. */
const COLORS = ['#e5534b', '#57ab5a', '#539bf5', '#c69026', '#b083f0', '#39c5cf', '#e0823d', '#d16d9e'];
export function colorFor(id: string): string {
let hash = 0;
for (let i = 0; i < id.length; i++) hash = (hash * 31 + id.charCodeAt(i)) >>> 0;
return COLORS[hash % COLORS.length];
}
/** What the text-editor side needs from the shared models. */
export interface CursorSource {
cursors(file: vscode.Uri): LiveCursor[];
setCursor(file: vscode.Uri, selection: LiveSelection | undefined): boolean;
}
interface Styles {
caret: vscode.TextEditorDecorationType;
selection: vscode.TextEditorDecorationType;
}
/**
* Cursors in VS Code's text editors: yours go to the others as you move, and
* theirs are drawn as a coloured caret with their name and a tinted selection.
*/
export class EditorCursors implements vscode.Disposable {
private readonly styles = new Map<string, Styles>();
private readonly disposables: vscode.Disposable[] = [];
private timer: ReturnType<typeof setTimeout> | undefined;
private pending: vscode.TextEditor | undefined;
constructor(private readonly source: CursorSource) {
this.disposables.push(
vscode.window.onDidChangeTextEditorSelection((event) => this.moved(event.textEditor)),
vscode.window.onDidChangeActiveTextEditor((editor) => editor && this.moved(editor)),
vscode.window.onDidChangeVisibleTextEditors(() => this.render()),
vscode.workspace.onDidChangeTextDocument((event) => {
if (vscode.window.visibleTextEditors.some((e) => e.document === event.document)) this.render();
}),
);
}
/** Sent at most every 80 ms; the last position wins. */
private moved(editor: vscode.TextEditor): void {
if (editor.document.uri.scheme !== 'file') return;
this.pending = editor;
if (this.timer) return;
this.timer = setTimeout(() => {
this.timer = undefined;
const e = this.pending;
this.pending = undefined;
if (!e || e.document.isClosed) return;
const text = normalizeEol(e.document.getText());
const { anchor, active } = e.selection;
this.source.setCursor(e.document.uri, {
anchor: offsetOf(text, anchor.line, anchor.character),
head: offsetOf(text, active.line, active.character),
});
}, 80);
}
private stylesFor(color: string): Styles {
let found = this.styles.get(color);
if (!found) {
found = {
caret: vscode.window.createTextEditorDecorationType({
rangeBehavior: vscode.DecorationRangeBehavior.ClosedClosed,
// A zero-width caret and the name above it; the CSS rides in textDecoration,
// the usual way to place a decoration without moving the text.
before: {
contentText: '',
textDecoration: `none; position: absolute; display: inline-block; height: 1.25em; border-left: 2px solid ${color}; margin-left: -1px; z-index: 1;`,
},
}),
selection: vscode.window.createTextEditorDecorationType({
backgroundColor: `${color}38`,
rangeBehavior: vscode.DecorationRangeBehavior.ClosedClosed,
}),
};
this.styles.set(color, found);
}
return found;
}
/** Draws everyone's cursors in the visible editors of shared files. */
render(): void {
for (const editor of vscode.window.visibleTextEditors) {
if (editor.document.uri.scheme !== 'file') continue;
const cursors = this.source.cursors(editor.document.uri);
const text = normalizeEol(editor.document.getText());
const at = (offset: number) => {
const { line, character } = positionOf(text, Math.max(0, Math.min(offset, text.length)));
return new vscode.Position(line, character);
};
const byColor = new Map<string, { carets: vscode.DecorationOptions[]; selections: vscode.Range[] }>();
for (const c of cursors) {
let group = byColor.get(c.color);
if (!group) byColor.set(c.color, (group = { carets: [], selections: [] }));
const head = at(c.head);
group.carets.push({
range: new vscode.Range(head, head),
hoverMessage: new vscode.MarkdownString(`**${c.name.replace(/[\\`*_[\]<>]/g, '')}** is here`),
renderOptions: {
after: {
contentText: c.name,
color: '#fff',
backgroundColor: c.color,
fontWeight: '500',
textDecoration: 'none; position: absolute; transform: translateY(-1.15em); font-size: 0.75em; padding: 0 4px; border-radius: 3px; white-space: nowrap; pointer-events: none; z-index: 2; opacity: 0.9;',
},
},
});
if (c.anchor !== c.head) {
const [from, to] = c.anchor < c.head ? [c.anchor, c.head] : [c.head, c.anchor];
group.selections.push(new vscode.Range(at(from), at(to)));
}
}
for (const color of byColor.keys()) this.stylesFor(color);
// Every colour is set, so a person who left or moved away disappears.
for (const [color, styles] of this.styles) {
const group = byColor.get(color);
editor.setDecorations(styles.caret, group?.carets ?? []);
editor.setDecorations(styles.selection, group?.selections ?? []);
}
}
}
dispose(): void {
clearTimeout(this.timer);
for (const styles of this.styles.values()) {
styles.caret.dispose();
styles.selection.dispose();
}
this.styles.clear();
for (const d of this.disposables.splice(0)) d.dispose();
}
}
+230
View File
@@ -0,0 +1,230 @@
import * as vscode from 'vscode';
import * as Y from 'yjs';
import { normalizeEol, positionOf } from '../util/textDiff';
import { FILES_MAP } from './protocol';
import { applyToYText, safeChange } from './textSync';
const MODEL_GLOB = '**/*.{archify,archify-registry,archify-decision}';
const SKIP_GLOB = '{**/node_modules/**,**/.git/**}';
const MODEL_FILE = /\.(archify|archify-registry|archify-decision)$/i;
/** A model-root-relative path the bridge accepts: POSIX, no `..`, a model file. */
export function isSafeModelPath(path: string): boolean {
if (!MODEL_FILE.test(path) || path.startsWith('/') || path.includes('\\')) return false;
return path.split('/').every((part) => part !== '' && part !== '.' && part !== '..' && part !== '.git' && part !== 'node_modules');
}
/**
* Keeps a model's files and the space's Y.Text per file the same.
*
* Local edits (any editor, the Source view, a drag on a diagram, git, an
* agent) become minimal Y.Text edits. Remote edits go back as WorkspaceEdits
* for open documents, so undo, dirty state and the pages stay right, and as
* file writes for closed ones. Each side compares texts before writing, so
* an edit coming back from the other side ends as a no-op instead of an echo.
*/
export class FileBridge implements vscode.Disposable {
readonly files: Y.Map<Y.Text>;
private readonly disposables: vscode.Disposable[] = [];
private queue: Promise<void> = Promise.resolve();
private listening = false;
/**
* Text the bridge last wrote per file. Its own write comes back as a change
* event, possibly after the document moved on; pushing it then would undo
* the newer edit, so it is skipped once.
*/
private readonly written = new Map<string, string>();
constructor(
private readonly root: vscode.Uri,
private readonly doc: Y.Doc,
/** Transaction origin of edits made here. */
private readonly origin: object,
private readonly log: vscode.LogOutputChannel,
) {
this.files = doc.getMap<Y.Text>(FILES_MAP);
}
/** The model-relative path of a file in this model, else undefined. */
relative(uri: vscode.Uri): string | undefined {
if (uri.scheme !== this.root.scheme) return undefined;
const base = this.root.path.endsWith('/') ? this.root.path : `${this.root.path}/`;
if (!uri.path.startsWith(base)) return undefined;
const rel = uri.path.slice(base.length);
return isSafeModelPath(rel) ? rel : undefined;
}
uriOf(rel: string): vscode.Uri {
return vscode.Uri.joinPath(this.root, ...rel.split('/'));
}
/** Remote edits start going to disk; with `local`, local edits start going out. */
start(local: boolean): void {
if (!this.disposables.length) {
const observer = (events: Y.YEvent<Y.AbstractType<unknown>>[], txn: Y.Transaction) => {
if (txn.origin === this.origin) return;
const paths = new Set<string>();
for (const event of events) {
if (event.target === this.files) for (const key of event.changes.keys.keys()) paths.add(key);
else if (typeof event.path[0] === 'string') paths.add(event.path[0]);
}
for (const path of paths) this.enqueue(() => this.writeOut(path));
};
this.files.observeDeep(observer);
this.disposables.push({ dispose: () => this.files.unobserveDeep(observer) });
}
if (local && !this.listening) {
this.listening = true;
const watcher = vscode.workspace.createFileSystemWatcher(new vscode.RelativePattern(this.root, MODEL_GLOB));
this.disposables.push(
vscode.workspace.onDidChangeTextDocument((e) => {
const rel = this.relative(e.document.uri);
if (rel && e.contentChanges.length) this.pushLocal(rel, normalizeEol(e.document.getText()));
}),
watcher,
watcher.onDidCreate((uri) => this.enqueue(() => this.pushFromDisk(uri))),
watcher.onDidChange((uri) => this.enqueue(() => this.pushFromDisk(uri))),
watcher.onDidDelete((uri) => {
const rel = this.relative(uri);
if (rel && this.files.has(rel)) this.enqueue(async () => {
// Gone for good, not an editor's save-by-rename.
if (!(await exists(uri))) this.doc.transact(() => this.files.delete(rel), this.origin);
});
}),
);
}
}
private pushLocal(rel: string, text: string): void {
if (this.written.get(rel) === text) {
this.written.delete(rel);
return;
}
this.push(rel, text);
}
/** One file's text into the document. */
push(rel: string, text: string): void {
const existing = this.files.get(rel);
if (existing instanceof Y.Text) {
if (existing.toString() !== text) this.doc.transact(() => applyToYText(existing, text), this.origin);
return;
}
this.doc.transact(() => {
const created = new Y.Text();
created.insert(0, text);
this.files.set(rel, created);
}, this.origin);
}
private async pushFromDisk(uri: vscode.Uri): Promise<void> {
const rel = this.relative(uri);
// Open documents report through their change events.
if (!rel || vscode.workspace.textDocuments.some((d) => d.uri.toString() === uri.toString())) return;
const text = await readDisk(uri);
if (text !== undefined) this.pushLocal(rel, normalizeEol(text));
}
/** The model files as they are now: open editors' text, else the disk. */
async scan(): Promise<Map<string, string>> {
const found = await vscode.workspace.findFiles(new vscode.RelativePattern(this.root, MODEL_GLOB), SKIP_GLOB);
const out = new Map<string, string>();
for (const uri of found) {
const rel = this.relative(uri);
if (!rel) continue;
const open = vscode.workspace.textDocuments.find((d) => d.uri.toString() === uri.toString());
const text = open ? open.getText() : await readDisk(uri);
if (text !== undefined) out.set(rel, normalizeEol(text));
}
return out;
}
/**
* Brings changes made while the extension was not running into the
* document (git pull, an edit in another tool). With `deleteMissing`,
* files in the document but gone from disk are removed.
*/
async pushAll(deleteMissing: boolean): Promise<void> {
const local = await this.scan();
for (const [rel, text] of local) this.push(rel, text);
if (deleteMissing) {
const gone = [...this.files.keys()].filter((rel) => !local.has(rel));
if (gone.length) this.doc.transact(() => gone.forEach((rel) => this.files.delete(rel)), this.origin);
}
}
/** Writes every file of the document to disk; then sends local files the document lacks. */
async pullAll(): Promise<void> {
for (const rel of this.files.keys()) await this.enqueue(() => this.writeOut(rel));
const local = await this.scan();
for (const [rel, text] of local) if (!this.files.has(rel)) this.push(rel, text);
}
private enqueue(work: () => Promise<void>): Promise<void> {
this.queue = this.queue.then(work).catch((error) => this.log.error(`sync: ${error instanceof Error ? error.message : String(error)}`));
return this.queue;
}
/** The document's text of one file onto disk or into its open editor. */
private async writeOut(rel: string): Promise<void> {
if (!isSafeModelPath(rel)) {
this.log.warn(`sync: ignored a file outside the model: ${rel}`);
return;
}
const uri = this.uriOf(rel);
const value = this.files.get(rel);
if (!(value instanceof Y.Text)) {
if (await exists(uri)) await vscode.workspace.fs.delete(uri, { useTrash: true });
return;
}
const text = value.toString();
const open = vscode.workspace.textDocuments.find((d) => d.uri.toString() === uri.toString());
if (open) {
const current = normalizeEol(open.getText());
const change = safeChange(current, text);
if (!change) return;
const wasDirty = open.isDirty;
const from = positionOf(current, change.from);
const to = positionOf(current, change.to);
this.written.set(rel, text);
const edit = new vscode.WorkspaceEdit();
edit.replace(uri, new vscode.Range(from.line, from.character, to.line, to.character), change.insert);
if (!(await vscode.workspace.applyEdit(edit))) {
this.log.warn(`sync: could not apply a teammate's edit to ${rel}`);
return;
}
// Teammates' edits land on disk, where git sees them; the person's own unsaved work stays unsaved.
if (!wasDirty) await open.save();
return;
}
const disk = await readDisk(uri);
const eol = disk?.includes('\r\n') ? '\r\n' : '\n';
const out = eol === '\n' ? text : text.replace(/\n/g, '\r\n');
if (disk === out) return;
this.written.set(rel, text);
await vscode.workspace.fs.createDirectory(vscode.Uri.joinPath(uri, '..'));
await vscode.workspace.fs.writeFile(uri, new TextEncoder().encode(out));
}
dispose(): void {
for (const d of this.disposables.splice(0)) d.dispose();
this.listening = false;
}
}
async function exists(uri: vscode.Uri): Promise<boolean> {
try {
await vscode.workspace.fs.stat(uri);
return true;
} catch {
return false;
}
}
async function readDisk(uri: vscode.Uri): Promise<string | undefined> {
try {
return new TextDecoder('utf-8').decode(await vscode.workspace.fs.readFile(uri));
} catch {
return undefined;
}
}
+569
View File
@@ -0,0 +1,569 @@
// Archify Sync in the extension: live, shared models. Bundled on its own
// (dist/sync.js) and loaded only when a model is shared or a sync command
// runs, so the extension without a server works exactly as before.
import * as vscode from 'vscode';
import { MAIN_FILE } from '../model/format';
import type { ModelService } from '../model/service';
import { SyncApi, SyncApiError, checkServerUrl, parseInviteLink } from './api';
import { SyncAuth } from './auth';
import { LiveSpace, StartMode } from './liveSpace';
import { LINK_FILE, Link, PROTOCOL_VERSION, Version, formatLink, parseLink, versionLabel } from './protocol';
import { EditorCursors } from './cursors';
import type { LiveAction, LiveBridge, LiveCursor, LivePanel, LiveProvider, LiveSelection } from './liveBridge';
import { VERSION_SCHEME, VersionContent, compareVersion, restoreVersion, showVersions } from './versions';
export const SYNC_COMMANDS = [
'archify.sync.signIn',
'archify.sync.signOut',
'archify.sync.share',
'archify.sync.invite',
'archify.sync.join',
'archify.sync.publish',
'archify.sync.versions',
'archify.sync.stop',
'archify.sync.menu',
] as const;
const SKIP = '{**/node_modules/**,**/.git/**}';
/** How long the model page's list of versions is reused before it is asked for again. */
const VERSIONS_TTL_MS = 20_000;
export class SyncFeature implements vscode.Disposable, LiveProvider {
private readonly auth: SyncAuth;
private readonly spaces = new Map<string, LiveSpace>();
private readonly status = vscode.window.createStatusBarItem('archify.sync', vscode.StatusBarAlignment.Left, 50);
private readonly content: VersionContent;
private readonly disposables: vscode.Disposable[] = [];
private readonly versionCache = new Map<string, { at: number; versions: Promise<Version[]> }>();
private readonly editorCursors: EditorCursors;
private cursorTimer: ReturnType<typeof setTimeout> | undefined;
constructor(
private readonly context: vscode.ExtensionContext,
private readonly models: ModelService,
private readonly log: vscode.LogOutputChannel,
private readonly bridge?: LiveBridge,
) {
this.auth = new SyncAuth(context, log);
this.content = new VersionContent((space) => {
const live = [...this.spaces.values()].find((s) => s.link.space === space);
return live ? this.api(live.link.server) : undefined;
});
this.status.name = 'Archify Sync';
this.status.command = 'archify.sync.menu';
const links = vscode.workspace.createFileSystemWatcher(`**/${LINK_FILE}`);
this.disposables.push(
this.auth,
this.status,
links,
links.onDidCreate((uri) => void this.open(uri, 'open')),
links.onDidDelete((uri) => this.close(vscode.Uri.joinPath(uri, '..'), false)),
vscode.workspace.registerTextDocumentContentProvider(VERSION_SCHEME, this.content),
this.auth.onDidChangeSessions(() => {
for (const space of this.spaces.values()) space.reconnect();
this.render();
}),
);
this.editorCursors = new EditorCursors({ cursors: (file) => this.cursors(file), setCursor: (file, selection) => this.setCursorIn(file, selection) });
this.disposables.push(this.editorCursors);
bridge?.setProvider(this);
}
/** Opens every shared model in the workspace. */
async start(): Promise<void> {
const found = await vscode.workspace.findFiles(`**/${LINK_FILE}`, SKIP, 50);
await Promise.all(found.map((uri) => this.open(uri, 'open')));
this.render();
}
private api(server: string): SyncApi {
return new SyncApi(server, (force) => this.auth.accessToken(server, force));
}
private async open(linkUri: vscode.Uri, mode: StartMode): Promise<LiveSpace | undefined> {
const root = vscode.Uri.joinPath(linkUri, '..');
if (this.spaces.has(root.toString())) return this.spaces.get(root.toString());
let link: Link | undefined;
try {
link = parseLink(new TextDecoder().decode(await vscode.workspace.fs.readFile(linkUri)));
} catch {
return undefined;
}
if (!link) {
this.log.warn(`sync: ${vscode.workspace.asRelativePath(linkUri)} is not a valid link file`);
return undefined;
}
if (!checkServerUrl(link.server).url) {
this.log.warn(`sync: ${vscode.workspace.asRelativePath(linkUri)} names a server that is not https: ${link.server}`);
return undefined;
}
const space = new LiveSpace(root, link, mode, {
context: this.context,
auth: this.auth,
log: this.log,
onChange: () => this.render(),
onCursors: () => this.cursorsMoved(),
});
this.spaces.set(root.toString(), space);
try {
await space.start();
} catch (error) {
this.log.error(`sync: ${link.name ?? root.fsPath} did not start: ${String(error)}`);
}
this.render();
return space;
}
private close(root: vscode.Uri, forget: boolean): void {
const space = this.spaces.get(root.toString());
if (!space) return;
this.spaces.delete(root.toString());
if (forget) space.forget();
else space.dispose();
this.render();
}
private render(): void {
const spaces = [...this.spaces.values()];
if (!spaces.length) {
this.status.hide();
void vscode.commands.executeCommand('setContext', 'archify.sync.active', false);
return;
}
void vscode.commands.executeCommand('setContext', 'archify.sync.active', true);
const signedOut = spaces.filter((s) => s.state === 'signed-out');
const offline = spaces.filter((s) => s.state !== 'online' && s.state !== 'signed-out');
const people = new Set(spaces.flatMap((s) => s.people().map((p) => p.user.id)));
if (signedOut.length) {
this.status.text = '$(account) Archify: sign in';
this.status.backgroundColor = new vscode.ThemeColor('statusBarItem.warningBackground');
} else if (offline.length) {
this.status.text = offline.some((s) => s.state === 'connecting') ? '$(sync~spin) Archify connecting' : '$(cloud-offline) Archify offline';
this.status.backgroundColor = undefined;
} else {
this.status.text = `$(broadcast) Archify live · ${people.size} here`;
this.status.backgroundColor = undefined;
}
const tooltip = new vscode.MarkdownString(undefined, true);
for (const s of spaces) {
const who = s.people().map((p) => `${p.user.name}${p.file ? ` (${p.file})` : ''}`).join(', ');
tooltip.appendMarkdown(`**${s.name}**: ${s.state}${who ? ` \n${who}` : ''}\n\n`);
}
tooltip.appendMarkdown('Edits are kept on this machine first and sent when online.');
this.status.tooltip = tooltip;
this.status.show();
this.bridge?.changed();
}
// ------------------------------------------------- the model page's Live section
private versionsOf(space: LiveSpace, fresh = false): Promise<Version[]> {
const cached = this.versionCache.get(space.link.space);
if (!fresh && cached && Date.now() - cached.at < VERSIONS_TTL_MS) return cached.versions;
const versions = this.api(space.link.server).versions(space.link.space);
this.versionCache.set(space.link.space, { at: Date.now(), versions });
versions.catch(() => this.versionCache.delete(space.link.space));
return versions;
}
/** After a publish or a restore: the page shows the new version. */
private versionsChanged(space: LiveSpace): void {
this.versionCache.delete(space.link.space);
this.bridge?.changed(space.root);
}
async panel(root: vscode.Uri): Promise<LivePanel | undefined> {
const space = this.spaces.get(root.toString());
if (!space) return undefined;
const me = (space.awareness.getLocalState() as { user?: { id?: string } } | null)?.user?.id;
const panel: LivePanel = {
name: space.name,
host: new URL(space.link.server).host,
state: space.state,
people: space.people().map((p) => ({ name: p.user.name, file: p.file, me: p.user.id === me })),
};
if (space.state === 'signed-out' || space.state === 'forbidden') return panel;
try {
const versions = await this.versionsOf(space);
const label = new Map(versions.map((v) => [v.id, versionLabel(v)]));
panel.versions = versions.map((v) => ({
id: v.id,
label: versionLabel(v),
kind: v.kind,
name: v.name ?? undefined,
at: v.created_at,
restoredFrom: v.restored_from !== null ? label.get(v.restored_from) : undefined,
}));
} catch (error) {
panel.versionsProblem = space.state === 'online' ? `Versions could not be loaded: ${error instanceof Error ? error.message : String(error)}` : 'Versions show when the server can be reached.';
}
return panel;
}
/** Cursors drawn at most every 50 ms, however many people move. */
private cursorsMoved(): void {
if (this.cursorTimer) return;
this.cursorTimer = setTimeout(() => {
this.cursorTimer = undefined;
this.bridge?.cursorsChanged();
this.editorCursors.render();
}, 50);
}
private spaceOf(file: vscode.Uri): LiveSpace | undefined {
for (const space of this.spaces.values()) {
const root = space.root.path.endsWith('/') ? space.root.path : `${space.root.path}/`;
if (file.scheme === space.root.scheme && file.path.startsWith(root)) return space;
}
return undefined;
}
cursors(file: vscode.Uri): LiveCursor[] {
return this.spaceOf(file)?.cursors(file) ?? [];
}
setCursor(file: vscode.Uri, selection: LiveSelection | undefined): void {
this.setCursorIn(file, selection);
}
private setCursorIn(file: vscode.Uri, selection: LiveSelection | undefined): boolean {
return this.spaceOf(file)?.setCursor(file, selection) ?? false;
}
async act(root: vscode.Uri, action: LiveAction): Promise<void> {
const space = this.spaces.get(root.toString());
if (!space) return;
try {
switch (action.kind) {
case 'publish':
await this.publish(space);
break;
case 'invite':
await this.invite(space);
break;
case 'signIn':
if (await this.checkServer(space.link.server)) await this.auth.signIn(space.link.server);
break;
case 'versions':
await showVersions(space, this.api(space.link.server), this.content);
this.versionsChanged(space);
break;
case 'compare':
case 'restore': {
const version = (await this.versionsOf(space)).find((v) => v.id === action.version);
if (!version) throw new Error('That version is no longer listed.');
if (action.kind === 'compare') await compareVersion(space, version, this.content);
else if (await restoreVersion(space, this.api(space.link.server), version)) this.versionsChanged(space);
break;
}
}
} catch (error) {
this.report(error);
}
}
// ------------------------------------------------------------- commands
async run(command: (typeof SYNC_COMMANDS)[number], ...args: unknown[]): Promise<void> {
try {
switch (command) {
case 'archify.sync.signIn':
await this.signInCommand();
break;
case 'archify.sync.signOut':
await this.signOut();
break;
case 'archify.sync.share':
await this.share(args[0]);
break;
case 'archify.sync.invite':
await this.invite(args[0]);
break;
case 'archify.sync.join':
await this.join(typeof args[0] === 'string' ? args[0] : undefined);
break;
case 'archify.sync.publish':
await this.publish(args[0]);
break;
case 'archify.sync.versions': {
const space = await this.pickSpace(args[0]);
if (space) {
await showVersions(space, this.api(space.link.server), this.content);
this.versionsChanged(space);
}
break;
}
case 'archify.sync.stop':
await this.stop(args[0]);
break;
case 'archify.sync.menu':
await this.menu();
break;
}
} catch (error) {
this.report(error);
}
}
private report(error: unknown): void {
const message = error instanceof Error ? error.message : String(error);
if (/cancelled/i.test(message)) return;
this.log.error(`sync: ${message}`);
void vscode.window.showErrorMessage(`Archify Sync: ${message}`);
}
/** The invite and sign-in links: `…/auth?code=&state=`, `…/join?server=&invite=`. */
async handleUri(uri: vscode.Uri): Promise<void> {
if (uri.path === '/auth') this.auth.handleAuthUri(uri);
else if (uri.path === '/join') await this.run('archify.sync.join', uri.toString(true));
}
private async askServer(): Promise<string | undefined> {
const last = this.context.globalState.get<string>('archifySync.lastServer');
const value = await vscode.window.showInputBox({
title: 'Archify | Sync server',
prompt: 'The address of the Archify Sync server',
placeHolder: 'https://archify.example.com',
value: last,
ignoreFocusOut: true,
validateInput: (v) => checkServerUrl(v).problem,
});
return value === undefined ? undefined : checkServerUrl(value).url;
}
/** Checks the server answers and speaks this protocol; offers its setup page when it is new. */
private async checkServer(server: string): Promise<boolean> {
const info = await new SyncApi(server).info();
if (info.protocol !== PROTOCOL_VERSION) {
throw new Error(`${info.name} speaks protocol ${info.protocol}; this extension speaks ${PROTOCOL_VERSION}. Update ${info.protocol > PROTOCOL_VERSION ? 'the extension' : 'the server'}.`);
}
if (!info.set_up) {
const open = await vscode.window.showInformationMessage(
`${info.name} is new: its first admin sets it up with the first-start code from the server's log.`,
'Open setup page',
);
if (open) await vscode.env.openExternal(vscode.Uri.parse(`${server}/setup`));
return false;
}
await this.context.globalState.update('archifySync.lastServer', server);
return true;
}
private async signInCommand(): Promise<void> {
const server = await this.askServer();
if (!server || !(await this.checkServer(server))) return;
const session = await this.auth.signIn(server);
vscode.window.showInformationMessage(`Archify: signed in to ${new URL(server).host} as ${session.account.display_name}.`);
}
private async signOut(): Promise<void> {
const servers = await this.auth.servers();
if (!servers.length) {
vscode.window.showInformationMessage('Archify: not signed in to a sync server.');
return;
}
const server = servers.length === 1 ? servers[0] : await vscode.window.showQuickPick(servers, { title: 'Archify | Sign out of' });
const session = server ? await this.auth.session(server) : undefined;
if (session) await this.auth.removeSession(session.id);
}
/** A server with a session: the only one, a picked one, or a new sign-in. */
private async serverWithSession(): Promise<string | undefined> {
const servers = await this.auth.servers();
if (servers.length === 1) return servers[0];
if (servers.length > 1) {
const pick = await vscode.window.showQuickPick([...servers, '$(add) Another server…'], { title: 'Archify | Share to which server?' });
if (pick && !pick.startsWith('$(add)')) return pick;
if (!pick) return undefined;
}
const server = await this.askServer();
if (!server || !(await this.checkServer(server))) return undefined;
await this.auth.signIn(server);
return server;
}
/** The model root a command applies to: the argument, the active file, or a pick. */
private async modelRoot(arg: unknown): Promise<vscode.Uri | undefined> {
const uri = arg instanceof vscode.Uri ? arg : vscode.window.activeTextEditor?.document.uri ?? activeTabUri();
const root = uri ? await this.models.rootOf(uri) : undefined;
if (root) return root;
const mains = await vscode.workspace.findFiles(`**/${MAIN_FILE}`, SKIP, 50);
if (mains.length === 1) return vscode.Uri.joinPath(mains[0], '..');
const pick = await vscode.window.showQuickPick(
mains.map((m) => ({ label: vscode.workspace.asRelativePath(vscode.Uri.joinPath(m, '..')), root: vscode.Uri.joinPath(m, '..') })),
{ title: 'Archify | Which model?' },
);
return pick?.root;
}
private async pickSpace(arg: unknown): Promise<LiveSpace | undefined> {
if (arg instanceof LiveSpace) return arg;
const spaces = [...this.spaces.values()];
if (!spaces.length) {
vscode.window.showInformationMessage('Archify: no model in this workspace is shared. Share one with "Archify: Share Model…".');
return undefined;
}
const uri = arg instanceof vscode.Uri ? arg : vscode.window.activeTextEditor?.document.uri ?? activeTabUri();
const root = uri ? await this.models.rootOf(uri) : undefined;
const here = root && this.spaces.get(root.toString());
if (here) return here;
if (spaces.length === 1) return spaces[0];
const pick = await vscode.window.showQuickPick(spaces.map((s) => ({ label: s.name, description: new URL(s.link.server).host, space: s })), {
title: 'Archify | Which shared model?',
});
return pick?.space;
}
private async share(arg: unknown): Promise<void> {
const root = await this.modelRoot(arg);
if (!root) return;
if (this.spaces.has(root.toString())) {
await this.invite(root);
return;
}
const server = await this.serverWithSession();
if (!server) return;
const index = await this.models.index(root).catch(() => undefined);
const name = await vscode.window.showInputBox({
title: 'Archify | Share Model',
prompt: `Name of the shared model on ${new URL(server).host}`,
value: index?.meta.name ?? root.path.split('/').pop(),
validateInput: (v) => (v.trim() ? undefined : 'Give it a name.'),
});
if (!name) return;
const space = await this.api(server).createSpace(name.trim());
const linkUri = vscode.Uri.joinPath(root, LINK_FILE);
await vscode.workspace.fs.writeFile(linkUri, new TextEncoder().encode(formatLink({ server, space: space.id, name: space.name })));
await this.open(linkUri, 'share');
const next = await vscode.window.showInformationMessage(
`Archify: ${space.name} is shared. Edits now go to everyone you invite.`,
'Copy invite link',
);
if (next) await this.invite(root);
}
private async invite(arg: unknown): Promise<void> {
const space = await this.pickSpace(arg);
if (!space) return;
const invite = await this.api(space.link.server).invite(space.link.space);
await vscode.env.clipboard.writeText(invite.url);
vscode.window.showInformationMessage(
`Archify: invite link for ${space.name} copied. It works until ${new Date(invite.expires_at).toLocaleDateString()}; send it through any channel.`,
);
}
private async join(raw?: string): Promise<void> {
const text =
raw ??
(await vscode.window.showInputBox({
title: 'Archify | Join Shared Model',
prompt: 'Paste the invite link',
ignoreFocusOut: true,
validateInput: (v) => (parseInviteLink(v) ? undefined : 'This is not an Archify invite link.'),
}));
if (!text) return;
const parsed = parseInviteLink(text);
const server = parsed && checkServerUrl(parsed.server).url;
if (!parsed || !server) throw new Error('This is not an Archify invite link.');
if (!(await this.checkServer(server))) return;
const folder = await vscode.window.showOpenDialog({
title: 'Archify | Folder for the shared model',
openLabel: 'Put the model here',
canSelectFiles: false,
canSelectFolders: true,
defaultUri: vscode.workspace.workspaceFolders?.[0]?.uri,
});
const root = folder?.[0];
if (!root) return;
const existing = await vscode.workspace.findFiles(new vscode.RelativePattern(root, '**/*.{archify,archify-registry,archify-decision}'), SKIP, 1);
if (existing.length) {
throw new Error('That folder already holds Archify files. Pick an empty folder for the shared model.');
}
if (!(await this.auth.session(server))) await this.auth.signIn(server, parsed.invite);
const joined = await this.api(server).acceptInvite(parsed.invite);
const linkUri = vscode.Uri.joinPath(root, LINK_FILE);
await vscode.workspace.fs.writeFile(linkUri, new TextEncoder().encode(formatLink({ server, space: joined.space.id, name: joined.space.name })));
const inWorkspace = vscode.workspace.getWorkspaceFolder(root);
if (inWorkspace) {
await this.open(linkUri, 'join');
vscode.window.showInformationMessage(`Archify: you joined ${joined.space.name}. Its files are arriving in ${vscode.workspace.asRelativePath(root)}.`);
return;
}
const open = await vscode.window.showInformationMessage(
`Archify: you joined ${joined.space.name}. Open its folder to start working together.`,
'Open folder',
'Open in new window',
);
if (open) await vscode.commands.executeCommand('vscode.openFolder', root, { forceNewWindow: open === 'Open in new window' });
}
private async publish(arg: unknown): Promise<void> {
const space = await this.pickSpace(arg);
if (!space) return;
const name = await vscode.window.showInputBox({
title: `Archify | Publish ${space.name}`,
prompt: 'Name this version, for example "Q4 baseline"',
validateInput: (v) => (v.trim() ? undefined : 'Give the version a name.'),
});
if (!name) return;
const version = await this.api(space.link.server).publish(space.link.space, name.trim());
this.versionsChanged(space);
vscode.window.showInformationMessage(`Archify: published ${version.major}.${version.minor} "${version.name}" of ${space.name}.`);
}
private async stop(arg: unknown): Promise<void> {
const space = await this.pickSpace(arg);
if (!space) return;
const ok = await vscode.window.showWarningMessage(
`Stop syncing ${space.name} here?`,
{ modal: true, detail: `The files stay as they are. ${LINK_FILE} is removed, and edits here no longer go to the others. The model stays on the server.` },
'Stop syncing',
);
if (ok !== 'Stop syncing') return;
this.close(space.root, true);
await vscode.workspace.fs.delete(vscode.Uri.joinPath(space.root, LINK_FILE)).then(undefined, () => undefined);
}
private async menu(): Promise<void> {
const spaces = [...this.spaces.values()];
const signedOut = spaces.find((s) => s.state === 'signed-out');
const items: (vscode.QuickPickItem & { run: () => Promise<void> })[] = [];
if (signedOut) {
items.push({
label: `$(account) Sign in to ${new URL(signedOut.link.server).host}`,
run: async () => {
if (await this.checkServer(signedOut.link.server)) await this.auth.signIn(signedOut.link.server);
},
});
}
items.push(
{ label: '$(person-add) Copy invite link…', run: () => this.invite(undefined) },
{ label: '$(tag) Publish version…', run: () => this.publish(undefined) },
{ label: '$(history) Versions…', run: () => this.run('archify.sync.versions') },
{ label: '$(output) Show log', run: async () => this.log.show() },
{ label: '$(debug-disconnect) Stop syncing a model…', run: () => this.stop(undefined) },
);
const pick = await vscode.window.showQuickPick(items, { title: 'Archify Sync' });
await pick?.run();
}
dispose(): void {
clearTimeout(this.cursorTimer);
this.bridge?.setProvider(undefined);
for (const space of this.spaces.values()) space.dispose();
this.spaces.clear();
for (const d of this.disposables) d.dispose();
}
}
/** The file behind the active tab when it is a custom editor (the Archify pages). */
function activeTabUri(): vscode.Uri | undefined {
const input = vscode.window.tabGroups.activeTabGroup.activeTab?.input;
return input instanceof vscode.TabInputCustom || input instanceof vscode.TabInputText ? input.uri : undefined;
}
export { SyncApiError };
+110
View File
@@ -0,0 +1,110 @@
import * as vscode from 'vscode';
// What the model page shows of a shared model. Lives in the main bundle; the
// sync bundle plugs in as the provider once it loads. Without it, the model
// page has no Live section and nothing else changes.
export interface LivePerson {
name: string;
/** Model-relative path of the file the person has open. */
file?: string;
me?: boolean;
}
export interface LiveVersion {
id: number;
label: string;
kind: 'snapshot' | 'publish' | 'restore';
name?: string;
/** ISO time. */
at: string;
restoredFrom?: string;
}
export interface LivePanel {
name: string;
host: string;
state: 'connecting' | 'online' | 'offline' | 'signed-out' | 'forbidden' | 'outdated';
people: LivePerson[];
versions?: LiveVersion[];
versionsProblem?: string;
}
/** Someone else's cursor in a file, as offsets into its "\n" text. */
export interface LiveCursor {
name: string;
color: string;
anchor: number;
head: number;
}
/** A selection as offsets into a file's "\n" text. */
export interface LiveSelection {
anchor: number;
head: number;
}
export type LiveAction =
| { kind: 'publish' }
| { kind: 'invite' }
| { kind: 'signIn' }
| { kind: 'versions' }
| { kind: 'compare'; version: number }
| { kind: 'restore'; version: number };
export interface LiveProvider {
panel(root: vscode.Uri): Promise<LivePanel | undefined>;
act(root: vscode.Uri, action: LiveAction): Promise<void>;
/** Others' cursors in a shared file; empty when the file is not shared. */
cursors(file: vscode.Uri): LiveCursor[];
/** This person's cursor in a page's Source view; undefined when it closes. */
setCursor(file: vscode.Uri, selection: LiveSelection | undefined): void;
}
class LiveBridge implements vscode.Disposable {
private provider: LiveProvider | undefined;
private readonly emitter = new vscode.EventEmitter<vscode.Uri | undefined>();
/** A model root whose Live section changed; undefined for all of them. */
readonly onDidChange = this.emitter.event;
private readonly cursorEmitter = new vscode.EventEmitter<void>();
/** Someone's cursor moved somewhere; ask `cursors` for the file you show. */
readonly onDidChangeCursors = this.cursorEmitter.event;
setProvider(provider: LiveProvider | undefined): void {
this.provider = provider;
this.emitter.fire(undefined);
this.cursorEmitter.fire();
}
changed(root?: vscode.Uri): void {
this.emitter.fire(root);
}
async panel(root: vscode.Uri): Promise<LivePanel | undefined> {
return this.provider?.panel(root);
}
async act(root: vscode.Uri, action: LiveAction): Promise<void> {
await this.provider?.act(root, action);
}
cursorsChanged(): void {
this.cursorEmitter.fire();
}
cursors(file: vscode.Uri): LiveCursor[] {
return this.provider?.cursors(file) ?? [];
}
setCursor(file: vscode.Uri, selection: LiveSelection | undefined): void {
this.provider?.setCursor(file, selection);
}
dispose(): void {
this.emitter.dispose();
this.cursorEmitter.dispose();
}
}
export const liveBridge = new LiveBridge();
export type { LiveBridge };
+231
View File
@@ -0,0 +1,231 @@
import * as path from 'node:path';
import * as vscode from 'vscode';
import * as Y from 'yjs';
import { Awareness } from 'y-protocols/awareness';
import { syncSocketUrl } from './api';
import { SyncAuth } from './auth';
import { ConnectionState, LiveConnection } from './connection';
import { FileBridge } from './fileBridge';
import { OfflineStore } from './offlineStore';
import { colorFor } from './cursors';
import type { LiveCursor, LiveSelection } from './liveBridge';
import { Link } from './protocol';
/** How a space starts: as found in the workspace, just shared from here, or just joined. */
export type StartMode = 'open' | 'share' | 'join';
/** Edits loaded from the offline copy; not stored again. */
const FROM_COPY = Symbol('offline copy');
const COMPACT_AFTER = 200;
export interface Presence {
user: { id: string; name: string };
/** Model-relative path of the file the person has in front of them. */
file?: string;
/** Where the person's cursor is: Yjs relative positions, so it stays put while others type. */
cursor?: { file: string; anchor: unknown; head: unknown };
}
/**
* One shared model in this window: the Yjs document, its offline copy, the
* connection to the server, the bridge to the files, and presence.
*/
export class LiveSpace implements vscode.Disposable {
readonly doc = new Y.Doc();
readonly awareness = new Awareness(this.doc);
private readonly store: OfflineStore;
private readonly local = { origin: 'local' };
private readonly bridge: FileBridge;
private connection?: LiveConnection;
private readonly disposables: vscode.Disposable[] = [];
private hadCopy = false;
private firstSync = true;
constructor(
readonly root: vscode.Uri,
readonly link: Link,
private readonly mode: StartMode,
private readonly services: {
context: vscode.ExtensionContext;
auth: SyncAuth;
log: vscode.LogOutputChannel;
onChange: () => void;
/** Someone's cursor moved. */
onCursors?: () => void;
},
) {
const dir = path.join(services.context.globalStorageUri.fsPath, 'sync');
this.store = new OfflineStore(dir, link.space);
this.bridge = new FileBridge(root, this.doc, this.local, services.log);
}
get state(): ConnectionState {
return this.connection?.state ?? 'connecting';
}
get name(): string {
return this.link.name ?? path.basename(this.root.fsPath);
}
/** Distinct people in the space, this one included. */
people(): Presence[] {
const seen = new Map<string, Presence>();
for (const state of this.awareness.getStates().values()) {
const p = state as Partial<Presence>;
if (p.user?.id) seen.set(p.user.id, { user: p.user, file: p.file });
}
return [...seen.values()];
}
/** Puts this person's cursor in a shared file; false when the file is not part of this model. */
setCursor(uri: vscode.Uri, selection: LiveSelection | undefined): boolean {
const rel = this.bridge.relative(uri);
if (!rel) return false;
const current = this.awareness.getLocalState() as Presence | null;
if (!current) return true;
if (!selection) {
// Only the file the cursor is in can take it away.
if (current.cursor?.file === rel) this.awareness.setLocalStateField('cursor', undefined);
return true;
}
const text = this.doc.getMap<Y.Text>('files').get(rel);
if (!(text instanceof Y.Text)) return true;
const at = (offset: number) => Y.relativePositionToJSON(Y.createRelativePositionFromTypeIndex(text, Math.max(0, Math.min(offset, text.length))));
this.awareness.setLocalStateField('cursor', { file: rel, anchor: at(selection.anchor), head: at(selection.head) });
return true;
}
/** Other people's cursors in a file, as offsets into its text here. */
cursors(uri: vscode.Uri): LiveCursor[] {
const rel = this.bridge.relative(uri);
if (!rel) return [];
const found: LiveCursor[] = [];
for (const [client, state] of this.awareness.getStates()) {
if (client === this.doc.clientID) continue;
const p = state as Partial<Presence>;
if (!p.user?.id || p.cursor?.file !== rel) continue;
const index = (json: unknown) => {
try {
return Y.createAbsolutePositionFromRelativePosition(Y.createRelativePositionFromJSON(json), this.doc)?.index;
} catch {
return undefined;
}
};
const anchor = index(p.cursor.anchor);
const head = index(p.cursor.head);
if (anchor === undefined || head === undefined) continue;
found.push({ name: p.user.name, color: colorFor(p.user.id), anchor, head });
}
return found;
}
async start(): Promise<void> {
const { log } = this.services;
this.hadCopy = this.store.exists();
for (const update of this.store.load()) Y.applyUpdate(this.doc, update, FROM_COPY);
// Registered before the connection's listener, so every edit is on disk before it is sent.
this.doc.on('update', (update: Uint8Array, origin: unknown) => {
if (origin === FROM_COPY) return;
this.store.append(update);
if (this.store.pending >= COMPACT_AFTER) this.compact();
});
if (this.hadCopy) {
// Edits made while the extension was not running (git pull, another tool).
await this.bridge.pushAll(true);
} else if (this.mode === 'share') {
await this.bridge.pushAll(false);
}
// Without a copy, local edits wait for the server's files, so a file
// does not start twice (once here, once there) and lose one side.
this.bridge.start(this.hadCopy || this.mode === 'share');
const session = await this.services.auth.session(this.link.server);
if (session) this.awareness.setLocalState({ user: { id: session.account.id, name: session.account.display_name } } satisfies Presence);
this.disposables.push(
vscode.window.onDidChangeActiveTextEditor(() => this.updateFile()),
vscode.window.tabGroups.onDidChangeTabs(() => this.updateFile()),
{ dispose: () => this.awareness.destroy() },
);
this.updateFile();
let people = '';
this.awareness.on('change', () => {
// Cursors move all the time; the status bar and pages only care who is where.
const now = JSON.stringify(this.people());
if (now !== people) {
people = now;
this.services.onChange();
}
this.services.onCursors?.();
});
this.connection = new LiveConnection({
url: syncSocketUrl(this.link.server, this.link.space),
token: (force) => this.services.auth.accessToken(this.link.server, force),
doc: this.doc,
awareness: this.awareness,
onState: (state) => {
log.info(`sync: ${this.name} is ${state}`);
this.services.onChange();
},
onSynced: () => void this.synced(),
log: (message) => log.info(message),
});
}
private async synced(): Promise<void> {
if (!this.firstSync) return;
this.firstSync = false;
if (!this.hadCopy && this.mode !== 'share') {
// First time here: the server's files come to disk, then local-only files go up.
await this.bridge.pullAll();
this.bridge.start(true);
this.hadCopy = true;
}
this.compact();
}
private compact(): void {
try {
this.store.compact(Y.encodeStateAsUpdate(this.doc));
} catch (error) {
this.services.log.warn(`sync: could not compact the offline copy (${String(error)})`);
}
}
private updateFile(): void {
const current = this.awareness.getLocalState() as Presence | null;
if (!current) return;
// The text editor, or the tab of an Archify page (the model page, a diagram, a registry).
const input = vscode.window.tabGroups.activeTabGroup.activeTab?.input;
const tab = input instanceof vscode.TabInputCustom || input instanceof vscode.TabInputText ? input.uri : undefined;
const uri = vscode.window.activeTextEditor?.document.uri ?? tab;
const file = uri ? this.bridge.relative(uri) : undefined;
if (current.file !== file) this.awareness.setLocalState({ ...current, file });
}
/** After signing in again. */
reconnect(): void {
void this.services.auth.session(this.link.server).then((session) => {
if (session && !this.awareness.getLocalState()) {
this.awareness.setLocalState({ user: { id: session.account.id, name: session.account.display_name } } satisfies Presence);
}
this.connection?.reconnectNow();
});
}
/** Stops syncing this model here and forgets the offline copy. */
forget(): void {
this.dispose();
this.store.remove();
}
dispose(): void {
this.connection?.dispose();
this.connection = undefined;
this.bridge.dispose();
for (const d of this.disposables.splice(0)) d.dispose();
if (this.store.pending) this.compact();
this.doc.destroy();
}
}
+53
View File
@@ -0,0 +1,53 @@
import * as path from 'node:path';
import * as vscode from 'vscode';
import type { ModelService } from '../model/service';
import { log } from '../util/log';
import type { SyncFeature } from './index';
import { liveBridge } from './liveBridge';
// Kept in step with SYNC_COMMANDS in ./index (which lives in the other bundle).
const COMMANDS = [
'archify.sync.signIn',
'archify.sync.signOut',
'archify.sync.share',
'archify.sync.invite',
'archify.sync.join',
'archify.sync.publish',
'archify.sync.versions',
'archify.sync.stop',
'archify.sync.menu',
] as const;
/**
* Archify Sync is optional. This registers its commands and the URI handler,
* and loads dist/sync.js (Yjs, the WebSocket) only when it is needed: a model
* in the workspace is shared, someone signed in on this machine, or a sync
* command or link runs. Without that, nothing else happens.
*/
export function registerSync(context: vscode.ExtensionContext, models: ModelService): vscode.Disposable[] {
let feature: Promise<SyncFeature> | undefined;
const load = (): Promise<SyncFeature> =>
(feature ??= (async () => {
// A runtime path, so esbuild leaves the sync bundle out of this one.
const bundle = path.join(__dirname, 'sync.js');
const mod = require(bundle) as typeof import('./index');
const sync = new mod.SyncFeature(context, models, log(), liveBridge);
context.subscriptions.push(sync);
await sync.start();
return sync;
})());
void (async () => {
const used = context.globalState.get<boolean>('archifySync.used') === true;
const shared = used || (await vscode.workspace.findFiles('**/.archify-sync', '{**/node_modules/**,**/.git/**}', 1)).length > 0;
if (shared) load().catch((error) => log().error(`sync: did not start: ${String(error)}`));
})();
return [
liveBridge,
...COMMANDS.map((id) =>
vscode.commands.registerCommand(id, async (...args: unknown[]) => (await load()).run(id, ...args)),
),
vscode.window.registerUriHandler({ handleUri: async (uri) => (await load()).handleUri(uri) }),
];
}
+68
View File
@@ -0,0 +1,68 @@
import * as fs from 'node:fs';
import * as path from 'node:path';
/**
* The offline copy of one shared model: the last compacted Yjs state and a
* log of every update since, each written before it is sent. Lets people
* keep working while the server is away and catch up afterwards.
*/
export class OfflineStore {
private readonly statePath: string;
private readonly logPath: string;
private logged = 0;
constructor(dir: string, id: string) {
fs.mkdirSync(dir, { recursive: true });
this.statePath = path.join(dir, `${id}.state`);
this.logPath = path.join(dir, `${id}.log`);
}
exists(): boolean {
return fs.existsSync(this.statePath) || fs.existsSync(this.logPath);
}
/** Updates to apply in order: the state, then the log. A torn last entry is skipped. */
load(): Uint8Array[] {
const out: Uint8Array[] = [];
if (fs.existsSync(this.statePath)) out.push(new Uint8Array(fs.readFileSync(this.statePath)));
if (fs.existsSync(this.logPath)) {
const log = fs.readFileSync(this.logPath);
let at = 0;
while (at + 4 <= log.length) {
const length = log.readUInt32LE(at);
if (at + 4 + length > log.length) break;
out.push(new Uint8Array(log.subarray(at + 4, at + 4 + length)));
at += 4 + length;
this.logged++;
}
}
return out;
}
/** Appends one update; synchronous, so it is on disk before the caller sends it. */
append(update: Uint8Array): void {
const head = Buffer.alloc(4);
head.writeUInt32LE(update.length);
fs.appendFileSync(this.logPath, Buffer.concat([head, update]));
this.logged++;
}
/** Updates in the log since the last compaction. */
get pending(): number {
return this.logged;
}
/** Replaces state and log with one encoded state. */
compact(state: Uint8Array): void {
const tmp = `${this.statePath}.tmp`;
fs.writeFileSync(tmp, state);
fs.renameSync(tmp, this.statePath);
fs.rmSync(this.logPath, { force: true });
this.logged = 0;
}
remove(): void {
fs.rmSync(this.statePath, { force: true });
fs.rmSync(this.logPath, { force: true });
}
}
+60
View File
@@ -0,0 +1,60 @@
// What the extension and the Archify Sync server agree on. Mirrors
// `packages/protocol` (generated from Rust) in archify-vscode-ext-sync; keep
// both in step when the protocol changes.
export const PROTOCOL_VERSION = 1;
/** Root map of a space's Yjs document: model-root-relative POSIX path → Y.Text. */
export const FILES_MAP = 'files';
/** The link file in a model root: names server and space, holds no secrets. */
export const LINK_FILE = '.archify-sync';
export type OrgRole = 'admin' | 'member';
export type SpaceRole = 'owner' | 'editor';
export type VersionKind = 'snapshot' | 'publish' | 'restore';
export interface ApiError { error: string; message: string }
export interface Account { id: string; organisation_id: string; name: string; display_name: string; role: OrgRole }
export interface TokenResponse { access_token: string; expires_in: number; refresh_token: string; account: Account }
export interface ServerInfo { name: string; version: string; protocol: number; set_up: boolean }
export interface Space { id: string; name: string; role: SpaceRole; created_at: string }
export interface Member { account_id: string; name: string; display_name: string; role: SpaceRole }
export interface Invite { token: string; url: string; expires_at: string }
export interface JoinResponse { space: Space }
export interface Version {
id: number;
major: number;
minor: number;
kind: VersionKind;
name: string | null;
created_by: string | null;
created_at: string;
restored_from: number | null;
}
export interface VersionFiles { version: Version; files: { path: string; text: string }[] }
/** The contents of `.archify-sync`. */
export interface Link {
server: string;
space: string;
name?: string;
}
export function parseLink(text: string): Link | undefined {
try {
const value = JSON.parse(text) as Partial<Link>;
if (typeof value.server === 'string' && typeof value.space === 'string' && /^[0-9a-f-]{36}$/i.test(value.space)) {
return { server: value.server.replace(/\/+$/, ''), space: value.space, name: typeof value.name === 'string' ? value.name : undefined };
}
} catch {
// not a link
}
return undefined;
}
export function formatLink(link: Link): string {
return `${JSON.stringify({ server: link.server, space: link.space, name: link.name }, null, 2)}\n`;
}
export function versionLabel(v: Version): string {
return `${v.major}.${v.minor}`;
}
+33
View File
@@ -0,0 +1,33 @@
import * as Y from 'yjs';
import { TextChange, minimalChange } from '../util/textDiff';
const isHigh = (code: number) => code >= 0xd800 && code <= 0xdbff;
const isLow = (code: number) => code >= 0xdc00 && code <= 0xdfff;
/**
* `minimalChange`, widened so it never splits a surrogate pair: Yjs would
* replace half a pair with U+FFFD, and every copy would get the broken text.
*/
export function safeChange(before: string, after: string): TextChange | undefined {
const change = minimalChange(before, after);
if (!change) return undefined;
let { from, to } = change;
let endAfter = after.length - (before.length - to);
// A common start ending in a high surrogate, or a common end starting with
// a low one, would split a pair: take the whole character into the change.
if (from > 0 && isHigh(before.charCodeAt(from - 1))) from--;
if (to < before.length && isLow(before.charCodeAt(to))) {
to++;
endAfter++;
}
return { from, to, insert: after.slice(from, endAfter) };
}
/** Makes the Y.Text read `after` with one minimal edit; false when it already does. */
export function applyToYText(text: Y.Text, after: string): boolean {
const change = safeChange(text.toString(), after);
if (!change) return false;
if (change.to > change.from) text.delete(change.from, change.to - change.from);
if (change.insert) text.insert(change.from, change.insert);
return true;
}
+100
View File
@@ -0,0 +1,100 @@
import * as vscode from 'vscode';
import { SyncApi } from './api';
import { LiveSpace } from './liveSpace';
import { Version, VersionFiles, versionLabel } from './protocol';
export const VERSION_SCHEME = 'archify-sync-version';
/** Read-only documents of a version's files: `archify-sync-version:/<space>/<version>/<path>`. */
export class VersionContent implements vscode.TextDocumentContentProvider {
private readonly cache = new Map<string, Promise<VersionFiles>>();
constructor(private readonly api: (space: string) => SyncApi | undefined) {}
files(space: string, version: number): Promise<VersionFiles> {
const key = `${space}/${version}`;
let found = this.cache.get(key);
if (!found) {
const api = this.api(space);
if (!api) return Promise.reject(new Error('This model is not shared from here.'));
found = api.versionFiles(space, version);
found.catch(() => this.cache.delete(key));
this.cache.set(key, found);
}
return found;
}
async provideTextDocumentContent(uri: vscode.Uri): Promise<string> {
const [, space, version, ...rest] = uri.path.split('/');
const files = await this.files(space, Number(version));
return files.files.find((f) => f.path === rest.join('/'))?.text ?? '';
}
}
function describe(v: Version): vscode.QuickPickItem & { version: Version } {
const when = new Date(v.created_at).toLocaleString();
const kind = v.kind === 'publish' ? 'published' : v.kind === 'restore' ? `restored ${v.restored_from ?? ''}`.trim() : 'snapshot';
return {
label: `${v.kind === 'publish' ? '$(tag)' : v.kind === 'restore' ? '$(history)' : '$(circle-small)'} ${versionLabel(v)}${v.name ? ` ${v.name}` : ''}`,
description: kind,
detail: when,
version: v,
};
}
/** Versions of a space: pick one, then compare with the files here or restore it. */
export async function showVersions(space: LiveSpace, api: SyncApi, content: VersionContent): Promise<void> {
const versions = await api.versions(space.link.space);
if (!versions.length) {
vscode.window.showInformationMessage(`Archify: ${space.name} has no versions yet. One is taken on its own after a pause in editing.`);
return;
}
const picked = await vscode.window.showQuickPick(versions.map(describe), { title: `Archify | Versions of ${space.name}`, placeHolder: 'Pick a version' });
if (!picked) return;
const v = picked.version;
const action = await vscode.window.showQuickPick(
[
{ label: '$(diff) Compare with the files here', id: 'compare' },
{ label: '$(history) Restore this version', id: 'restore', detail: 'Brings these files back for everyone, as a new version. Nothing is lost.' },
],
{ title: `Archify | ${versionLabel(v)}${v.name ? ` ${v.name}` : ''}` },
);
if (action?.id === 'compare') await compareVersion(space, v, content);
if (action?.id === 'restore') await restoreVersion(space, api, v);
}
/** Asks, then brings back a version's files for everyone as a new version. */
export async function restoreVersion(space: LiveSpace, api: SyncApi, v: Version): Promise<boolean> {
const ok = await vscode.window.showWarningMessage(
`Restore ${versionLabel(v)} of ${space.name} for everyone?`,
{ modal: true, detail: 'The files go back to this version for everyone in the space. It becomes a new version; the history stays.' },
'Restore',
);
if (ok !== 'Restore') return false;
const restored = await api.restore(space.link.space, v.id);
vscode.window.showInformationMessage(`Archify: restored ${versionLabel(v)} as ${versionLabel(restored)}.`);
return true;
}
/** Lists the files that differ from a version and opens the diff of the one picked. */
export async function compareVersion(space: LiveSpace, v: Version, content: VersionContent): Promise<void> {
const files = await content.files(space.link.space, v.id);
const here = new Map<string, string>();
for (const [rel, text] of space.doc.getMap<{ toString(): string }>('files').entries()) here.set(rel, text.toString());
const paths = [...new Set([...files.files.map((f) => f.path), ...here.keys()])].sort();
const changed = paths
.map((p) => ({ path: p, then: files.files.find((f) => f.path === p)?.text, now: here.get(p) }))
.filter((f) => f.then !== f.now);
if (!changed.length) {
vscode.window.showInformationMessage(`Archify: the files here are the same as ${versionLabel(v)}.`);
return;
}
const pick = await vscode.window.showQuickPick(
changed.map((f) => ({ label: f.path, description: f.then === undefined ? 'added since' : f.now === undefined ? 'removed since' : 'changed', path: f.path })),
{ title: `Archify | Changes since ${versionLabel(v)}`, placeHolder: `${changed.length} file(s) differ` },
);
if (!pick) return;
const left = vscode.Uri.from({ scheme: VERSION_SCHEME, path: `/${space.link.space}/${v.id}/${pick.path}` });
const right = vscode.Uri.joinPath(space.root, ...pick.path.split('/'));
await vscode.commands.executeCommand('vscode.diff', left, right, `${pick.path} (${versionLabel(v)} ↔ here)`);
}
+64
View File
@@ -0,0 +1,64 @@
// Text helpers shared by the host and the Source view in the page. The page's
// editor always works in "\n" text; documents may use "\r\n".
export interface TextChange {
from: number;
to: number;
insert: string;
}
/** The text with "\r\n" turned into "\n". */
export function normalizeEol(text: string): string {
return text.replace(/\r\n/g, '\n');
}
/**
* The smallest single change that turns `before` into `after`: the common
* start and end are kept, so a cursor outside the change stays put.
*/
export function minimalChange(before: string, after: string): TextChange | undefined {
if (before === after) return undefined;
let start = 0;
const max = Math.min(before.length, after.length);
while (start < max && before.charCodeAt(start) === after.charCodeAt(start)) start++;
let endBefore = before.length;
let endAfter = after.length;
while (endBefore > start && endAfter > start && before.charCodeAt(endBefore - 1) === after.charCodeAt(endAfter - 1)) {
endBefore--;
endAfter--;
}
return { from: start, to: endBefore, insert: after.slice(start, endAfter) };
}
/** Line and character of an offset into "\n" text. */
export function positionOf(text: string, offset: number): { line: number; character: number } {
const clamped = Math.max(0, Math.min(offset, text.length));
let line = 0;
let lineStart = 0;
for (let i = text.indexOf('\n'); i !== -1 && i < clamped; i = text.indexOf('\n', i + 1)) {
line++;
lineStart = i + 1;
}
return { line, character: clamped - lineStart };
}
/** Offset into "\n" text of a line and character (clamped to the line). */
export function offsetOf(text: string, line: number, character: number): number {
let start = 0;
for (let l = 0; l < line; l++) {
const next = text.indexOf('\n', start);
if (next === -1) return text.length;
start = next + 1;
}
const end = text.indexOf('\n', start);
return Math.min(start + Math.max(0, character), end === -1 ? text.length : end);
}
/** Applies changes given in the coordinates of `text` (as one editor transaction reports them). */
export function applyChanges(text: string, changes: TextChange[]): string {
let out = text;
for (const change of [...changes].sort((a, b) => b.from - a.from)) {
out = out.slice(0, change.from) + change.insert + out.slice(change.to);
}
return out;
}
+11 -4
View File
@@ -58,13 +58,20 @@ class Viewer3D {
this.interceptViewerControls(); this.interceptViewerControls();
if (this.saved.active ?? host.defaultView === '3d') this.setActive(true); if (this.saved.active ?? host.defaultView === '3d') this.setActive(true);
else this.syncButtons(); else this.syncButtons();
// The Source view hides the picture; the stage stops drawing meanwhile.
window.addEventListener('archify-source', (event) => {
if (!this.active || !this.stage) return;
if ((event as CustomEvent<{ on: boolean }>).detail.on) this.stage.stop();
else this.stage.start();
});
} }
// -------------------------------------------------------------- chrome // -------------------------------------------------------------- chrome
/** /**
* The 2D | 3D switch: Export's twin in the toolbar. Both states are always * The 2D | 3D switch in the toolbar, left of Diagram | Graph | Source (it
* visible, the filled half is the current one, a click flips it. * says how the picture is drawn, that one what is shown). Both states are
* always visible, the filled half is the current one, a click flips it.
*/ */
private buildSwitch(): HTMLButtonElement { private buildSwitch(): HTMLButtonElement {
const button = document.createElement('button'); const button = document.createElement('button');
@@ -79,8 +86,8 @@ class Viewer3D {
event.stopPropagation(); event.stopPropagation();
this.setActive(!this.active); this.setActive(!this.active);
}); });
const exportWrap = document.querySelector('.toolbar .export-wrap'); const anchor = document.querySelector('.toolbar #archify-mode-switch') ?? document.querySelector('.toolbar .export-wrap');
if (exportWrap?.parentElement) exportWrap.parentElement.insertBefore(button, exportWrap); if (anchor?.parentElement) anchor.parentElement.insertBefore(button, anchor);
else document.querySelector('.toolbar')?.appendChild(button); else document.querySelector('.toolbar')?.appendChild(button);
return button; return button;
} }
+34 -13
View File
@@ -6,31 +6,41 @@ import { DecisionPanel, decisionPanelFromIndex, decisionPanelStandalone } from '
import { ModelService } from '../model/service'; import { ModelService } from '../model/service';
import { readText } from '../util/files'; import { readText } from '../util/files';
import { log } from '../util/log'; import { log } from '../util/log';
import { sourceScriptUri } from '../webview/viewer3d';
import { SourceSession } from './sourceSession';
import { handleWebviewMessage, WebviewMessage } from '../webview/messages'; import { handleWebviewMessage, WebviewMessage } from '../webview/messages';
import { decisionPage, makeNonce } from '../webview/page'; import { decisionPage, makeNonce } from '../webview/page';
import { DECISION_VIEW_TYPE, DIAGRAM_EDITOR_VIEW_TYPE, REGISTRY_VIEW_TYPE } from './viewTypes'; import { DECISION_VIEW_TYPE, DIAGRAM_EDITOR_VIEW_TYPE, REGISTRY_VIEW_TYPE } from './viewTypes';
export { DECISION_VIEW_TYPE }; export { DECISION_VIEW_TYPE };
class DecisionDocument implements vscode.CustomDocument {
constructor(readonly uri: vscode.Uri) {}
dispose(): void {}
}
class DecisionView implements vscode.Disposable { class DecisionView implements vscode.Disposable {
private seq = 0; private seq = 0;
private timer: NodeJS.Timeout | undefined; private timer: NodeJS.Timeout | undefined;
private last: string | undefined; private last: string | undefined;
root: vscode.Uri | undefined; root: vscode.Uri | undefined;
private readonly disposables: vscode.Disposable[] = []; private readonly disposables: vscode.Disposable[] = [];
/** The Source view; while it shows, a new page waits in `heldHtml`. */
readonly source: SourceSession;
private heldHtml: string | undefined;
constructor( constructor(
private readonly context: vscode.ExtensionContext,
private readonly models: ModelService, private readonly models: ModelService,
readonly panel: vscode.WebviewPanel, readonly panel: vscode.WebviewPanel,
readonly uri: vscode.Uri, readonly uri: vscode.Uri,
) { ) {
this.source = new SourceSession(context, panel, uri, 'decision', (shown) => {
if (!shown && this.heldHtml !== undefined) {
const html = this.heldHtml;
this.heldHtml = undefined;
this.panel.webview.html = html;
}
});
this.disposables.push( this.disposables.push(
this.source,
panel.webview.onDidReceiveMessage((message: WebviewMessage) => { panel.webview.onDidReceiveMessage((message: WebviewMessage) => {
if (this.source.handle(message)) return;
if (message.type === 'openDiagram') return void this.openInModel(message.path, DIAGRAM_EDITOR_VIEW_TYPE); if (message.type === 'openDiagram') return void this.openInModel(message.path, DIAGRAM_EDITOR_VIEW_TYPE);
if (message.type === 'openRegistry') return void this.openRegistryLine(message.file, message.line); if (message.type === 'openRegistry') return void this.openRegistryLine(message.file, message.line);
if (message.type === 'openDecision') return void this.openInModel(message.file, DECISION_VIEW_TYPE); if (message.type === 'openDecision') return void this.openInModel(message.file, DECISION_VIEW_TYPE);
@@ -86,7 +96,12 @@ class DecisionView implements vscode.Disposable {
const fingerprint = JSON.stringify(decision); const fingerprint = JSON.stringify(decision);
if (fingerprint === this.last) return; if (fingerprint === this.last) return;
this.last = fingerprint; this.last = fingerprint;
this.panel.webview.html = decisionPage({ cspSource: this.panel.webview.cspSource, nonce: makeNonce() }, decision); const html = decisionPage(
{ cspSource: this.panel.webview.cspSource, nonce: makeNonce(), source: { scriptUri: sourceScriptUri(this.panel.webview, this.context.extensionUri), left: 'View' } },
decision,
);
if (this.source.shown) this.heldHtml = html;
else this.panel.webview.html = html;
} }
dispose(): void { dispose(): void {
@@ -95,13 +110,16 @@ class DecisionView implements vscode.Disposable {
} }
} }
/** Read-only custom editor for .archify-decision files: the decision as a page, with its elements and diagrams. */ /** Custom editor for .archify-decision files: the decision as a page, with its elements and diagrams. */
export class DecisionViewProvider implements vscode.CustomReadonlyEditorProvider<DecisionDocument>, vscode.Disposable { export class DecisionViewProvider implements vscode.CustomTextEditorProvider, vscode.Disposable {
private readonly views = new Set<DecisionView>(); private readonly views = new Set<DecisionView>();
private active: DecisionView | undefined; private active: DecisionView | undefined;
private readonly disposables: vscode.Disposable[]; private readonly disposables: vscode.Disposable[];
constructor(private readonly models: ModelService) { constructor(
private readonly context: vscode.ExtensionContext,
private readonly models: ModelService,
) {
this.disposables = [ this.disposables = [
vscode.window.registerCustomEditorProvider(DECISION_VIEW_TYPE, this, { vscode.window.registerCustomEditorProvider(DECISION_VIEW_TYPE, this, {
webviewOptions: { retainContextWhenHidden: true, enableFindWidget: true }, webviewOptions: { retainContextWhenHidden: true, enableFindWidget: true },
@@ -122,13 +140,16 @@ export class DecisionViewProvider implements vscode.CustomReadonlyEditorProvider
return this.active?.uri; return this.active?.uri;
} }
openCustomDocument(uri: vscode.Uri): DecisionDocument { /** The view of the focused page, if any. */
return new DecisionDocument(uri); get activeView(): { source: SourceSession } | undefined {
return this.active;
} }
async resolveCustomEditor(document: DecisionDocument, panel: vscode.WebviewPanel): Promise<void> { // A text editor provider: the page edits the file's own TextDocument (in
// its Source view), so dirty state, save and undo are VS Code's.
async resolveCustomTextEditor(document: vscode.TextDocument, panel: vscode.WebviewPanel): Promise<void> {
panel.webview.options = { enableScripts: true }; panel.webview.options = { enableScripts: true };
const view = new DecisionView(this.models, panel, document.uri); const view = new DecisionView(this.context, this.models, panel, document.uri);
this.views.add(view); this.views.add(view);
const onViewState = () => { const onViewState = () => {
if (panel.active) this.active = view; if (panel.active) this.active = view;
+79 -8
View File
@@ -13,7 +13,9 @@ import { log } from '../util/log';
import { viewerTheme } from '../util/settings'; import { viewerTheme } from '../util/settings';
import { handleWebviewMessage, WebviewMessage } from '../webview/messages'; import { handleWebviewMessage, WebviewMessage } from '../webview/messages';
import { graphPage, makeNonce, messagePage, modelPage, prepareDiagramHtml } from '../webview/page'; import { graphPage, makeNonce, messagePage, modelPage, prepareDiagramHtml } from '../webview/page';
import { graphScriptUri, viewer3dOption, viewerRoots } from '../webview/viewer3d'; import { graphScriptUri, sourceScriptUri, viewer3dOption, viewerRoots } from '../webview/viewer3d';
import { liveBridge } from '../sync/liveBridge';
import { SourceSession } from './sourceSession';
import { DECISION_VIEW_TYPE, DIAGRAM_EDITOR_VIEW_TYPE, PREVIEW_VIEW_TYPE, REGISTRY_VIEW_TYPE } from './viewTypes'; import { DECISION_VIEW_TYPE, DIAGRAM_EDITOR_VIEW_TYPE, PREVIEW_VIEW_TYPE, REGISTRY_VIEW_TYPE } from './viewTypes';
@@ -50,6 +52,12 @@ class DiagramPreview implements vscode.Disposable {
private graphQuery: string | undefined; private graphQuery: string | undefined;
/** True while the webview shows the Graph page, which takes model updates as messages. */ /** True while the webview shows the Graph page, which takes model updates as messages. */
private graphShown = false; private graphShown = false;
/** The Source view of a .archify file; while it shows, new HTML waits in `heldHtml`. */
readonly source: SourceSession | undefined;
private heldHtml: string | undefined;
private disposed = false;
/** main.archify: the model page has its Live slot and takes `live` messages. */
private liveShown = false;
constructor( constructor(
private readonly context: vscode.ExtensionContext, private readonly context: vscode.ExtensionContext,
@@ -69,9 +77,23 @@ class DiagramPreview implements vscode.Disposable {
panel.title = `Preview ${path.basename(uri.path)}`; panel.title = `Preview ${path.basename(uri.path)}`;
} }
if (isArchifyFile(uri.path)) {
this.source = new SourceSession(context, panel, uri, 'diagram', (shown) => {
// Back from Source: show what was rendered meanwhile.
if (!shown && this.heldHtml !== undefined) {
const html = this.heldHtml;
this.heldHtml = undefined;
this.liveShown = false;
this.panel.webview.html = html;
}
});
this.disposables.push(this.source);
}
this.disposables.push( this.disposables.push(
panel.onDidDispose(() => this.dispose()), panel.onDidDispose(() => this.dispose()),
panel.webview.onDidReceiveMessage((message: WebviewMessage) => { panel.webview.onDidReceiveMessage((message: WebviewMessage) => {
if (this.source?.handle(message)) return;
if (message.type === 'hash') { if (message.type === 'hash') {
this.hash = message.hash; this.hash = message.hash;
return; return;
@@ -97,10 +119,25 @@ class DiagramPreview implements vscode.Disposable {
this.setGraph(false); this.setGraph(false);
return; return;
} }
if (message.type === 'liveReady') {
this.liveShown = true;
void this.postLive();
return;
}
if (message.type === 'liveAction') {
if (this.root) void liveBridge.act(this.root, message.action);
return;
}
void handleWebviewMessage(message, this.uri, this.panel); void handleWebviewMessage(message, this.uri, this.panel);
}), }),
); );
if (isMainFile(uri.path)) {
this.disposables.push(liveBridge.onDidChange((root) => {
if (!root || (this.root && root.toString() === this.root.toString())) void this.postLive();
}));
}
if (uri.scheme === 'file') { if (uri.scheme === 'file') {
const watcher = vscode.workspace.createFileSystemWatcher( const watcher = vscode.workspace.createFileSystemWatcher(
new vscode.RelativePattern(vscode.Uri.file(path.dirname(uri.fsPath)), path.basename(uri.fsPath)), new vscode.RelativePattern(vscode.Uri.file(path.dirname(uri.fsPath)), path.basename(uri.fsPath)),
@@ -116,11 +153,35 @@ class DiagramPreview implements vscode.Disposable {
void this.update(); void this.update();
} }
/** The Live section of a shared model's page; nothing when the model is not shared. */
private async postLive(): Promise<void> {
if (!this.liveShown || !this.root || this.disposed) return;
const live = await liveBridge.panel(this.root).catch(() => undefined);
if (this.liveShown) this.post({ type: 'live', live });
}
/** Posts to the webview; a panel closed mid-update is not an error. */ /** Posts to the webview; a panel closed mid-update is not an error. */
private post(message: unknown): void { private post(message: unknown): void {
Promise.resolve(this.panel.webview.postMessage(message)).catch(() => undefined); Promise.resolve(this.panel.webview.postMessage(message)).catch(() => undefined);
} }
/** Replaces the page, unless Source is open in it: then the page waits until it closes. */
private setHtml(html: string): void {
if (this.disposed) return;
if (this.source?.shown) {
this.heldHtml = html;
return;
}
this.heldHtml = undefined;
this.liveShown = false;
this.panel.webview.html = html;
}
/** Page option for the Source view, on .archify files. */
private sourceOption(left: 'Model' | 'Diagram'): { scriptUri: string; left: 'Model' | 'Diagram' } | undefined {
return this.source ? { scriptUri: sourceScriptUri(this.panel.webview, this.context.extensionUri), left } : undefined;
}
private state(): PreviewState { private state(): PreviewState {
return { uri: this.uri.toString(), hash: this.hash, graph: this.graph }; return { uri: this.uri.toString(), hash: this.hash, graph: this.graph };
} }
@@ -131,6 +192,10 @@ class DiagramPreview implements vscode.Disposable {
/** Switches a main.archify editor between its model page and the Graph page. */ /** Switches a main.archify editor between its model page and the Graph page. */
setGraph(on: boolean, query?: string): void { setGraph(on: boolean, query?: string): void {
// Leaving Source for another page: drop what it held, or that page would
// wait for a sourceClose that never comes and show up later instead.
this.heldHtml = undefined;
this.source?.leave();
this.graph = on; this.graph = on;
this.graphQuery = query; this.graphQuery = query;
const modes = this.graphModes(); const modes = this.graphModes();
@@ -156,21 +221,21 @@ class DiagramPreview implements vscode.Disposable {
return; return;
} }
this.graphShown = true; this.graphShown = true;
this.panel.webview.html = graphPage( this.setHtml(graphPage(
{ cspSource: this.panel.webview.cspSource, nonce: makeNonce(), state: this.state() }, { cspSource: this.panel.webview.cspSource, nonce: makeNonce(), state: this.state() },
{ graph, query: this.graphQuery, scriptUri: graphScriptUri(this.panel.webview, this.context.extensionUri) }, { graph, query: this.graphQuery, scriptUri: graphScriptUri(this.panel.webview, this.context.extensionUri) },
); ));
this.graphQuery = undefined; this.graphQuery = undefined;
} }
private showMessage(title: string, body: string, detail?: string): void { private showMessage(title: string, body: string, detail?: string): void {
this.lastHtml = undefined; this.lastHtml = undefined;
this.panel.webview.html = messagePage( this.setHtml(messagePage(
{ cspSource: this.panel.webview.cspSource, nonce: makeNonce(), state: this.state() }, { cspSource: this.panel.webview.cspSource, nonce: makeNonce(), state: this.state(), source: this.sourceOption('Diagram') },
title, title,
body, body,
detail, detail,
); ));
} }
/** Opens a diagram of the model, given its path relative to the model root. */ /** Opens a diagram of the model, given its path relative to the model root. */
@@ -192,7 +257,7 @@ class DiagramPreview implements vscode.Disposable {
this.lastHtml = fingerprint; this.lastHtml = fingerprint;
this.rendered = false; this.rendered = false;
this.graphShown = false; this.graphShown = false;
this.panel.webview.html = modelPage({ cspSource: this.panel.webview.cspSource, nonce: makeNonce(), state: this.state() }, model); this.setHtml(modelPage({ cspSource: this.panel.webview.cspSource, nonce: makeNonce(), state: this.state(), source: this.sourceOption('Model') }, model));
} }
scheduleUpdate(): void { scheduleUpdate(): void {
@@ -203,6 +268,7 @@ class DiagramPreview implements vscode.Disposable {
async update(force = false): Promise<void> { async update(force = false): Promise<void> {
clearTimeout(this.timer); clearTimeout(this.timer);
if (this.disposed) return;
const seq = ++this.seq; const seq = ++this.seq;
let text: string; let text: string;
try { try {
@@ -285,6 +351,7 @@ class DiagramPreview implements vscode.Disposable {
decisions: prepared.decisions, decisions: prepared.decisions,
model, model,
graphSwitch: main ? { left: 'Model' } : prepared.root ? { left: 'Diagram', query: `diagram:${path.relative(prepared.root.fsPath, this.uri.fsPath).split(path.sep).join('/')}` } : undefined, graphSwitch: main ? { left: 'Model' } : prepared.root ? { left: 'Diagram', query: `diagram:${path.relative(prepared.root.fsPath, this.uri.fsPath).split(path.sep).join('/')}` } : undefined,
source: this.sourceOption(main ? 'Model' : 'Diagram'),
}); });
// Nonces differ per render, so compare the renderer output instead. // Nonces differ per render, so compare the renderer output instead.
const fingerprint = `${viewerTheme()}\u0000${result.evidenceNotice ?? ''}\u0000${JSON.stringify([model ?? null, [...prepared.links], [...prepared.descriptions], prepared.decisions])}\u0000${result.html}`; const fingerprint = `${viewerTheme()}\u0000${result.evidenceNotice ?? ''}\u0000${JSON.stringify([model ?? null, [...prepared.links], [...prepared.descriptions], prepared.decisions])}\u0000${result.html}`;
@@ -294,10 +361,14 @@ class DiagramPreview implements vscode.Disposable {
} }
this.lastHtml = fingerprint; this.lastHtml = fingerprint;
this.rendered = true; this.rendered = true;
this.panel.webview.html = html; this.setHtml(html);
} }
dispose(): void { dispose(): void {
if (this.disposed) return;
this.disposed = true;
// Renders in flight check the sequence after every await; this ends them.
this.seq++;
clearTimeout(this.timer); clearTimeout(this.timer);
this.onDisposeEmitter.fire(); this.onDisposeEmitter.fire();
this.onDisposeEmitter.dispose(); this.onDisposeEmitter.dispose();
+33 -12
View File
@@ -5,31 +5,41 @@ import { RegistryPanel, registryPanelFromIndex, registryPanelStandalone } from '
import { ModelService } from '../model/service'; import { ModelService } from '../model/service';
import { readText } from '../util/files'; import { readText } from '../util/files';
import { log } from '../util/log'; import { log } from '../util/log';
import { sourceScriptUri } from '../webview/viewer3d';
import { SourceSession } from './sourceSession';
import { handleWebviewMessage, WebviewMessage } from '../webview/messages'; import { handleWebviewMessage, WebviewMessage } from '../webview/messages';
import { makeNonce, registryPage } from '../webview/page'; import { makeNonce, registryPage } from '../webview/page';
import { DECISION_VIEW_TYPE, DIAGRAM_EDITOR_VIEW_TYPE, REGISTRY_VIEW_TYPE } from './viewTypes'; import { DECISION_VIEW_TYPE, DIAGRAM_EDITOR_VIEW_TYPE, REGISTRY_VIEW_TYPE } from './viewTypes';
export { REGISTRY_VIEW_TYPE }; export { REGISTRY_VIEW_TYPE };
class RegistryDocument implements vscode.CustomDocument {
constructor(readonly uri: vscode.Uri) {}
dispose(): void {}
}
class RegistryView implements vscode.Disposable { class RegistryView implements vscode.Disposable {
private seq = 0; private seq = 0;
private timer: NodeJS.Timeout | undefined; private timer: NodeJS.Timeout | undefined;
private last: string | undefined; private last: string | undefined;
root: vscode.Uri | undefined; root: vscode.Uri | undefined;
private readonly disposables: vscode.Disposable[] = []; private readonly disposables: vscode.Disposable[] = [];
/** The Source view; while it shows, a new page waits in `heldHtml`. */
readonly source: SourceSession;
private heldHtml: string | undefined;
constructor( constructor(
private readonly context: vscode.ExtensionContext,
private readonly models: ModelService, private readonly models: ModelService,
readonly panel: vscode.WebviewPanel, readonly panel: vscode.WebviewPanel,
readonly uri: vscode.Uri, readonly uri: vscode.Uri,
) { ) {
this.source = new SourceSession(context, panel, uri, 'registry', (shown) => {
if (!shown && this.heldHtml !== undefined) {
const html = this.heldHtml;
this.heldHtml = undefined;
this.panel.webview.html = html;
}
});
this.disposables.push( this.disposables.push(
this.source,
panel.webview.onDidReceiveMessage((message: WebviewMessage) => { panel.webview.onDidReceiveMessage((message: WebviewMessage) => {
if (this.source.handle(message)) return;
if (message.type === 'openDiagram') return void this.openInModel(message.path, DIAGRAM_EDITOR_VIEW_TYPE); if (message.type === 'openDiagram') return void this.openInModel(message.path, DIAGRAM_EDITOR_VIEW_TYPE);
if (message.type === 'openRegistry') return void this.openRegistryLine(message.file, message.line); if (message.type === 'openRegistry') return void this.openRegistryLine(message.file, message.line);
if (message.type === 'openDecision') return void this.openInModel(message.file, DECISION_VIEW_TYPE); if (message.type === 'openDecision') return void this.openInModel(message.file, DECISION_VIEW_TYPE);
@@ -84,7 +94,12 @@ class RegistryView implements vscode.Disposable {
const fingerprint = JSON.stringify(registry); const fingerprint = JSON.stringify(registry);
if (fingerprint === this.last) return; if (fingerprint === this.last) return;
this.last = fingerprint; this.last = fingerprint;
this.panel.webview.html = registryPage({ cspSource: this.panel.webview.cspSource, nonce: makeNonce() }, registry); const html = registryPage(
{ cspSource: this.panel.webview.cspSource, nonce: makeNonce(), source: { scriptUri: sourceScriptUri(this.panel.webview, this.context.extensionUri), left: 'View' } },
registry,
);
if (this.source.shown) this.heldHtml = html;
else this.panel.webview.html = html;
} }
dispose(): void { dispose(): void {
@@ -93,12 +108,15 @@ class RegistryView implements vscode.Disposable {
} }
} }
export class RegistryViewProvider implements vscode.CustomReadonlyEditorProvider<RegistryDocument>, vscode.Disposable { export class RegistryViewProvider implements vscode.CustomTextEditorProvider, vscode.Disposable {
private readonly views = new Set<RegistryView>(); private readonly views = new Set<RegistryView>();
private active: RegistryView | undefined; private active: RegistryView | undefined;
private readonly disposables: vscode.Disposable[]; private readonly disposables: vscode.Disposable[];
constructor(private readonly models: ModelService) { constructor(
private readonly context: vscode.ExtensionContext,
private readonly models: ModelService,
) {
this.disposables = [ this.disposables = [
vscode.window.registerCustomEditorProvider(REGISTRY_VIEW_TYPE, this, { vscode.window.registerCustomEditorProvider(REGISTRY_VIEW_TYPE, this, {
webviewOptions: { retainContextWhenHidden: true, enableFindWidget: true }, webviewOptions: { retainContextWhenHidden: true, enableFindWidget: true },
@@ -121,13 +139,16 @@ export class RegistryViewProvider implements vscode.CustomReadonlyEditorProvider
return this.active?.uri; return this.active?.uri;
} }
openCustomDocument(uri: vscode.Uri): RegistryDocument { /** The view of the focused page, if any. */
return new RegistryDocument(uri); get activeView(): { source: SourceSession } | undefined {
return this.active;
} }
async resolveCustomEditor(document: RegistryDocument, panel: vscode.WebviewPanel): Promise<void> { // A text editor provider: the page edits the file's own TextDocument (in
// its Source view), so dirty state, save and undo are VS Code's.
async resolveCustomTextEditor(document: vscode.TextDocument, panel: vscode.WebviewPanel): Promise<void> {
panel.webview.options = { enableScripts: true }; panel.webview.options = { enableScripts: true };
const view = new RegistryView(this.models, panel, document.uri); const view = new RegistryView(this.context, this.models, panel, document.uri);
this.views.add(view); this.views.add(view);
const onViewState = () => { const onViewState = () => {
if (panel.active) this.active = view; if (panel.active) this.active = view;
+229
View File
@@ -0,0 +1,229 @@
import * as vscode from 'vscode';
import { EditorSchemas } from '../language/editorSchemas';
import { readSchemas } from '../language/schemaCheck';
import { liveBridge } from '../sync/liveBridge';
import { log } from '../util/log';
import { TextChange, normalizeEol, offsetOf, positionOf } from '../util/textDiff';
/** Page → host messages of the Source view. */
export type SourceMessage =
| { type: 'sourceReady' }
| { type: 'sourceOpen' }
| { type: 'sourceClose' }
| { type: 'sourceEdit'; base: string; text: string; changes: TextChange[] }
| { type: 'sourceSelection'; anchor: number; head: number };
export type SourceKind = 'diagram' | 'registry' | 'decision';
const CHECKS: Record<SourceKind, string> = {
diagram: 'YAML · checked against the Archify schema and the model',
registry: 'YAML · checked against the registry schema and the model',
decision: 'YAML · checked as a decision of the model',
};
let editorSchemas: EditorSchemas | undefined;
function schemasFor(context: vscode.ExtensionContext): EditorSchemas {
editorSchemas ??= new EditorSchemas(readSchemas(vscode.Uri.joinPath(context.extensionUri, 'schemas').fsPath));
return editorSchemas;
}
export function isSourceMessage(message: { type?: string }): message is SourceMessage {
return (
message.type === 'sourceReady' ||
message.type === 'sourceOpen' ||
message.type === 'sourceClose' ||
message.type === 'sourceEdit' ||
message.type === 'sourceSelection'
);
}
/**
* The host half of a page's Source view. The document stays VS Code's: page
* edits become WorkspaceEdits (so dirty state, save, undo and Git work as
* for any file), and changes from anywhere else (undo, the text editor, git)
* go back to the page. Problems are whatever the Problems panel holds for the
* file, sent as offsets; the page shows their count on the Source switch even
* while the picture is shown.
*/
export class SourceSession implements vscode.Disposable {
/** True while the page shows Source; the view must not replace its HTML then. */
shown = false;
/** Texts our own edits will produce, oldest first; their change events are not echoed. */
private readonly expected: string[] = [];
private queue: Promise<void> = Promise.resolve();
private schemaKey: string | undefined;
private readonly disposables: vscode.Disposable[];
constructor(
private readonly context: vscode.ExtensionContext,
private readonly panel: vscode.WebviewPanel,
readonly uri: vscode.Uri,
readonly kind: SourceKind,
/** Called when Source opens or closes, so the view can hold or apply its HTML. */
private readonly onShown: (shown: boolean) => void,
) {
const same = (uri: vscode.Uri) => uri.toString() === this.uri.toString();
this.disposables = [
vscode.languages.onDidChangeDiagnostics((event) => {
if (event.uris.some(same)) void this.postDiagnostics();
}),
vscode.workspace.onDidChangeTextDocument((event) => {
if (!same(event.document.uri) || !event.contentChanges.length) return;
this.post({ type: 'sourceDirty', dirty: event.document.isDirty });
if (this.shown) this.syncFrom(event.document);
}),
vscode.workspace.onDidSaveTextDocument((doc) => {
if (same(doc.uri)) this.post({ type: 'sourceDirty', dirty: false });
}),
// Teammates' cursors, when the model is shared (Archify Sync); nothing otherwise.
liveBridge.onDidChangeCursors(() => this.postCursors()),
];
}
/** Asks the page to show its Source view (Archify | Show Source). */
reveal(): void {
this.post({ type: 'setView', view: 'source' });
}
/** The page is being replaced by another one (the Graph page): Source is no longer shown. */
leave(): void {
this.setShown(false);
}
/** Handles a Source message from the page; false for any other message. */
handle(message: { type?: string }): boolean {
if (!isSourceMessage(message)) return false;
switch (message.type) {
case 'sourceReady':
void this.postDiagnostics();
break;
case 'sourceOpen':
this.setShown(true);
void this.sendText(true);
break;
case 'sourceClose':
this.setShown(false);
liveBridge.setCursor(this.uri, undefined);
break;
case 'sourceEdit':
this.edit(message);
break;
case 'sourceSelection':
liveBridge.setCursor(this.uri, { anchor: message.anchor, head: message.head });
break;
}
return true;
}
private setShown(shown: boolean): void {
if (this.shown === shown) return;
this.shown = shown;
this.onShown(shown);
}
private lastCursors = '[]';
private postCursors(): void {
if (!this.shown) return;
const cursors = liveBridge.cursors(this.uri);
const key = JSON.stringify(cursors);
if (key === this.lastCursors) return;
this.lastCursors = key;
this.post({ type: 'sourceCursors', cursors });
}
private post(message: unknown): void {
Promise.resolve(this.panel.webview.postMessage(message)).catch(() => undefined);
}
private document(): Promise<vscode.TextDocument> {
return Promise.resolve(vscode.workspace.openTextDocument(this.uri));
}
private async sendText(withDiagnostics: boolean): Promise<void> {
const doc = await this.document();
const text = normalizeEol(doc.getText());
this.expected.length = 0;
this.schemaKey = undefined;
this.post({ type: 'sourceText', text, schema: this.schemaChange(text), checks: CHECKS[this.kind] });
this.post({ type: 'sourceDirty', dirty: doc.isDirty });
this.lastCursors = '';
this.postCursors();
if (withDiagnostics) await this.postDiagnostics();
}
/** The editor schema when it differs from the one the page has (a diagram's type may change), else undefined. */
private schemaChange(text: string): { key: string; schema: object } | null | undefined {
const next = schemasFor(this.context).forSource(this.kind, text);
const key = next?.key ?? '';
if (key === this.schemaKey) return undefined;
this.schemaKey = key;
return next ?? null;
}
private syncFrom(doc: vscode.TextDocument): void {
const text = normalizeEol(doc.getText());
const index = this.expected.indexOf(text);
if (index !== -1) {
// Our own edit coming back; anything older is settled too.
this.expected.splice(0, index + 1);
return;
}
this.post({ type: 'sourceText', text, schema: this.schemaChange(text), checks: CHECKS[this.kind] });
}
private edit(message: Extract<SourceMessage, { type: 'sourceEdit' }>): void {
this.expected.push(message.text);
const schema = this.schemaChange(message.text);
if (schema !== undefined) this.post({ type: 'sourceSchema', schema });
this.queue = this.queue.then(async () => {
try {
const doc = await this.document();
const current = normalizeEol(doc.getText());
if (current === message.text) return;
const edit = new vscode.WorkspaceEdit();
// Positions come from "\n" text; VS Code turns inserted text into the document's line endings.
const at = (text: string, offset: number) => {
const { line, character } = positionOf(text, offset);
return new vscode.Position(line, character);
};
if (current === message.base) {
for (const change of message.changes) edit.replace(this.uri, new vscode.Range(at(current, change.from), at(current, change.to)), change.insert);
} else {
// The document moved on under the page (rare): the page's text wins.
edit.replace(this.uri, new vscode.Range(at(current, 0), at(current, current.length)), message.text);
}
if (!(await vscode.workspace.applyEdit(edit))) {
log().warn(`Source edit was not applied to ${this.uri.fsPath}`);
void this.sendText(false);
}
} catch (error) {
log().error(`Source edit failed for ${this.uri.fsPath}: ${error instanceof Error ? error.message : String(error)}`);
}
});
}
/** Problems of the file as offsets into its "\n" text, and their count for the switch. */
async postDiagnostics(): Promise<void> {
const diagnostics = vscode.languages.getDiagnostics(this.uri);
let items: unknown[] = [];
if (this.shown && diagnostics.length) {
const text = normalizeEol((await this.document()).getText());
items = diagnostics.map((d) => ({
from: offsetOf(text, d.range.start.line, d.range.start.character),
to: offsetOf(text, d.range.end.line, d.range.end.character),
severity: d.severity === vscode.DiagnosticSeverity.Error ? 'error' : d.severity === vscode.DiagnosticSeverity.Warning ? 'warning' : 'info',
message: d.message,
source: d.source,
}));
}
const count = diagnostics.filter((d) => d.severity === vscode.DiagnosticSeverity.Error || d.severity === vscode.DiagnosticSeverity.Warning).length;
this.post({ type: 'sourceDiagnostics', items, count });
}
dispose(): void {
if (this.shown) liveBridge.setCursor(this.uri, undefined);
for (const d of this.disposables.splice(0)) d.dispose();
}
}
+5
View File
@@ -2,6 +2,7 @@ import path from 'node:path';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import { repoRootFor } from '../archify/runtime'; import { repoRootFor } from '../archify/runtime';
import { log } from '../util/log'; import { log } from '../util/log';
import type { LiveAction } from '../sync/liveBridge';
export type WebviewMessage = export type WebviewMessage =
| { type: 'hash'; hash: string } | { type: 'hash'; hash: string }
@@ -14,6 +15,8 @@ export type WebviewMessage =
| { type: 'openDecision'; file: string } | { type: 'openDecision'; file: string }
| { type: 'showGraph'; query?: string } | { type: 'showGraph'; query?: string }
| { type: 'showModel' } | { type: 'showModel' }
| { type: 'liveReady' }
| { type: 'liveAction'; action: LiveAction }
| { type: 'error'; message: string }; | { type: 'error'; message: string };
/** Column for opening files next to a webview without covering it. */ /** Column for opening files next to a webview without covering it. */
@@ -100,6 +103,8 @@ export async function handleWebviewMessage(
case 'openDiagram': case 'openDiagram':
case 'showGraph': case 'showGraph':
case 'showModel': case 'showModel':
case 'liveReady':
case 'liveAction':
// Handled by the view, which knows the model root. // Handled by the view, which knows the model root.
break; break;
} }
+240 -31
View File
@@ -28,6 +28,8 @@ export interface PageOptions {
decisions?: DiagramDecision[]; decisions?: DiagramDecision[];
/** Pages inside a model get a switch to the model's Graph page; `left` names the page they are on. */ /** Pages inside a model get a switch to the model's Graph page; `left` names the page they are on. */
graphSwitch?: { left: 'Model' | 'Diagram'; query?: string }; graphSwitch?: { left: 'Model' | 'Diagram'; query?: string };
/** Pages of a file that can be edited in place: the Source view's script, and the name of the page's own view. */
source?: { scriptUri: string; left: 'Model' | 'Diagram' | 'View' };
/** The Graph page: the model as one graph, the bundled script that draws it, and the query to start with. */ /** The Graph page: the model as one graph, the bundled script that draws it, and the query to start with. */
graph?: { graph: ModelGraph; query?: string; scriptUri: string }; graph?: { graph: ModelGraph; query?: string; scriptUri: string };
} }
@@ -93,6 +95,7 @@ function bridgeScript(options: PageOptions): string {
decisions: options.decisions || [], decisions: options.decisions || [],
descriptions: options.descriptions || {}, descriptions: options.descriptions || {},
graphSwitch: options.graphSwitch, graphSwitch: options.graphSwitch,
source: options.source,
graph: options.graph ? { graph: options.graph.graph, query: options.graph.query } : undefined, graph: options.graph ? { graph: options.graph.graph, query: options.graph.query } : undefined,
}; };
return `(function () { return `(function () {
@@ -615,6 +618,11 @@ function bridgeScript(options: PageOptions): string {
if (anchor && anchor.parentNode) anchor.parentNode.insertBefore(head, anchor); else document.body.appendChild(head); if (anchor && anchor.parentNode) anchor.parentNode.insertBefore(head, anchor); else document.body.appendChild(head);
var body = el('section', 'archify-model archify-model-body'); var body = el('section', 'archify-model archify-model-body');
// Live: filled by the host when the model is shared (Archify Sync); hidden otherwise.
var live = el('div', 'archify-live');
live.id = 'archify-live';
live.hidden = true;
body.appendChild(live);
var count = model.groups.reduce(function (n, g) { return n + g.diagrams.length; }, 0); var count = model.groups.reduce(function (n, g) { return n + g.diagrams.length; }, 0);
var diagramsPanel = panel('diagrams', 'archify-model-diagrams', 'Diagrams', count, true); var diagramsPanel = panel('diagrams', 'archify-model-diagrams', 'Diagrams', count, true);
body.appendChild(diagramsPanel); body.appendChild(diagramsPanel);
@@ -632,6 +640,7 @@ function bridgeScript(options: PageOptions): string {
var button = el('button', 'archify-model-open'); var button = el('button', 'archify-model-open');
button.type = 'button'; button.type = 'button';
button.title = diagram.path; button.title = diagram.path;
button.setAttribute('data-path', diagram.path);
button.appendChild(el('span', 'archify-model-item-title', diagram.title || diagram.path.split('/').pop())); button.appendChild(el('span', 'archify-model-item-title', diagram.title || diagram.path.split('/').pop()));
button.appendChild(el('span', 'archify-model-item-meta', diagram.parseError ? 'does not parse: ' + diagram.parseError : (diagram.kind || 'diagram') + ' · ' + diagram.path)); button.appendChild(el('span', 'archify-model-item-meta', diagram.parseError ? 'does not parse: ' + diagram.parseError : (diagram.kind || 'diagram') + ' · ' + diagram.path));
button.addEventListener('click', function () { post({ type: 'openDiagram', path: diagram.path }); }); button.addEventListener('click', function () { post({ type: 'openDiagram', path: diagram.path }); });
@@ -674,37 +683,198 @@ function bridgeScript(options: PageOptions): string {
decisionsPanel.appendChild(decisionList); decisionsPanel.appendChild(decisionList);
} }
if (anchor && anchor.parentNode) anchor.parentNode.insertBefore(body, anchor.nextSibling); else document.body.appendChild(body); if (anchor && anchor.parentNode) anchor.parentNode.insertBefore(body, anchor.nextSibling); else document.body.appendChild(body);
post({ type: 'liveReady' });
} }
// Model | Graph (or Diagram | Graph): Export's twin in Archify's toolbar, var LIVE_STATE = {
// or at the top of the model page. Graph opens the model's Graph page. online: 'Live',
connecting: 'Connecting\u2026',
offline: 'Offline \u00b7 edits are kept here and sent when the server is back',
'signed-out': 'Signed out \u00b7 edits are kept here until you sign in',
forbidden: 'No access \u00b7 you are no longer a member of this model',
outdated: 'The server needs a newer extension',
};
var KIND_LABEL = { snapshot: 'snapshot', publish: 'published', restore: 'restored' };
function liveButton(label, title, action) {
var button = el('button', 'archify-model-used-link archify-live-action', label);
button.type = 'button';
button.title = title;
button.addEventListener('click', function (event) { event.preventDefault(); event.stopPropagation(); post({ type: 'liveAction', action: action }); });
return button;
}
function when(iso) {
var date = new Date(iso);
if (isNaN(date.getTime())) return '';
var seconds = (Date.now() - date.getTime()) / 1000;
if (seconds < 60) return 'just now';
if (seconds < 3600) return Math.floor(seconds / 60) + ' min ago';
if (seconds < 86400) return Math.floor(seconds / 3600) + ' h ago';
return date.toLocaleDateString();
}
// The Live section of a shared model: who is here, the state, and versions.
function renderLive(info) {
var holder = document.getElementById('archify-live');
if (!holder) return;
holder.textContent = '';
document.querySelectorAll('.archify-live-here').forEach(function (n) { n.remove(); });
if (!info) { holder.hidden = true; return; }
holder.hidden = false;
var others = info.people.filter(function (p) { return !p.me; });
var livePanel = panel('live', 'archify-model-live is-' + info.state, 'Shared \u00b7 ' + info.name, others.length ? others.length + 1 + ' here' : info.host, true);
var status = el('div', 'archify-live-status');
status.appendChild(el('span', 'archify-live-dot'));
status.appendChild(el('span', 'archify-live-state', (LIVE_STATE[info.state] || info.state) + (info.state === 'online' ? ' on ' + info.host : '')));
if (info.state === 'signed-out') status.appendChild(liveButton('Sign in', 'Sign in to ' + info.host, { kind: 'signIn' }));
var actions = el('span', 'archify-live-actions');
actions.appendChild(liveButton('Publish version', 'Name the current state as a version', { kind: 'publish' }));
actions.appendChild(liveButton('Copy invite link', 'Copy a link that lets someone join this model', { kind: 'invite' }));
status.appendChild(actions);
livePanel.appendChild(status);
var people = el('ul', 'archify-live-people');
info.people.forEach(function (person) {
var item = el('li', 'archify-live-person' + (person.me ? ' is-me' : ''));
item.appendChild(el('strong', '', person.me ? person.name + ' (you)' : person.name));
if (person.file) item.appendChild(el('small', '', person.file));
people.appendChild(item);
});
livePanel.appendChild(people);
// Who is in which diagram, on the diagram rows.
others.forEach(function (person) {
if (!person.file) return;
document.querySelectorAll('.archify-model-open[data-path]').forEach(function (button) {
if (button.getAttribute('data-path') !== person.file) return;
var meta = button.querySelector('.archify-live-here');
if (!meta) { meta = el('span', 'archify-live-here', ''); button.appendChild(meta); }
meta.textContent = (meta.textContent ? meta.textContent.replace(/ here$/, '') + ', ' : '') + person.name + ' here';
});
});
var versions = info.versions || [];
var head = el('div', 'archify-live-versions-head');
head.appendChild(el('span', 'archify-model-summary-title', 'Versions'));
if (versions.length > 8) head.appendChild(liveButton('All ' + versions.length + '\u2026', 'Pick from every version', { kind: 'versions' }));
livePanel.appendChild(head);
if (info.versionsProblem) livePanel.appendChild(el('p', 'archify-model-empty archify-live-note', info.versionsProblem));
else if (!versions.length) livePanel.appendChild(el('p', 'archify-model-empty archify-live-note', 'No versions yet. One is taken on its own after a pause in editing.'));
var list = el('ul', 'archify-live-versions');
versions.slice(0, 8).forEach(function (v) {
var item = el('li', 'archify-live-version is-' + v.kind);
item.appendChild(el('strong', 'archify-live-version-label', v.label));
item.appendChild(el('span', 'archify-decision-status archify-live-kind', KIND_LABEL[v.kind] + (v.restoredFrom ? ' ' + v.restoredFrom : '')));
if (v.name) item.appendChild(el('span', 'archify-live-version-name', v.name));
item.appendChild(el('small', 'archify-live-version-when', when(v.at)));
var buttons = el('span', 'archify-live-actions');
buttons.appendChild(liveButton('Compare', 'Compare ' + v.label + ' with the files here', { kind: 'compare', version: v.id }));
buttons.appendChild(liveButton('Restore', 'Bring back ' + v.label + ' for everyone, as a new version', { kind: 'restore', version: v.id }));
item.appendChild(buttons);
list.appendChild(item);
});
livePanel.appendChild(list);
holder.appendChild(livePanel);
}
// What the page shows: Diagram | Graph | Source (Model | Graph | Source on
// main.archify, View | Source on registry and decision pages). It sits
// left of Export in Archify's toolbar, after 2D | 3D, which only says how
// the picture is drawn; on our own pages it sits top right. Graph opens the
// model's Graph page; Source puts the file's YAML in place of the picture.
var sourceOn = false;
var syncModeSwitch = function () {};
function renderModeSwitch() { function renderModeSwitch() {
var sw = config.graphSwitch; var sw = config.graphSwitch;
if (!sw || document.getElementById('archify-mode-switch')) return; var src = config.source;
var button = el('button', 'archify-mode-switch'); if ((!sw && !src) || document.getElementById('archify-mode-switch')) return;
button.id = 'archify-mode-switch'; var group = el('div', 'archify-mode-switch');
group.id = 'archify-mode-switch';
group.setAttribute('role', 'group');
group.setAttribute('aria-label', 'View');
function segment(label, title, action) {
var button = el('button', 'archify-mode-seg', label);
button.type = 'button'; button.type = 'button';
button.title = 'Open the model as one graph, with a query box'; button.title = title;
button.setAttribute('aria-label', sw.left + ' view; switch to the model graph'); button.addEventListener('click', function (event) { event.stopPropagation(); action(); });
button.appendChild(el('span', 'archify-mode-seg on', sw.left)); group.appendChild(button);
button.appendChild(el('span', 'archify-mode-seg', 'Graph')); return button;
button.addEventListener('click', function (event) { }
event.stopPropagation(); var name = (src && src.left) || sw.left;
var left = segment(name, name === 'View' ? 'Show the page' : 'Show the ' + name.toLowerCase(), function () { setSource(false); });
if (sw) segment('Graph', 'Open the model as one graph, with a query box', function () {
// On main.archify the Graph page replaces this one; coming back must
// show the model, not Source. Other pages open the graph beside them.
if (sourceOn && config.model) vscode.setState(Object.assign({}, vscode.getState() || {}, { sourceView: false }));
post({ type: 'showGraph', query: sw.query }); post({ type: 'showGraph', query: sw.query });
}); });
var source = src ? segment('Source', 'Edit the YAML of this file, checked as you type', function () { setSource(true); }) : null;
if (source) {
var badge = el('span', 'archify-source-badge');
badge.id = 'archify-source-badge';
badge.hidden = true;
source.appendChild(badge);
}
syncModeSwitch = function () {
left.classList.toggle('on', !sourceOn);
left.setAttribute('aria-pressed', String(!sourceOn));
if (source) {
source.classList.toggle('on', sourceOn);
source.setAttribute('aria-pressed', String(sourceOn));
}
};
syncModeSwitch();
var exportWrap = document.querySelector('.toolbar .export-wrap'); var exportWrap = document.querySelector('.toolbar .export-wrap');
var head = document.querySelector('.archify-model-head'); var head = document.querySelector('.archify-model-head');
if (exportWrap && exportWrap.parentNode) exportWrap.parentNode.insertBefore(button, exportWrap); if (exportWrap && exportWrap.parentNode) exportWrap.parentNode.insertBefore(group, exportWrap);
else if (head) { else {
var row = el('div', 'archify-model-switch-row'); var row = el('div', 'archify-model-switch-row');
row.appendChild(button); row.appendChild(group);
head.insertBefore(row, head.firstChild); if (head) head.insertBefore(row, head.firstChild);
} else document.body.appendChild(button); else document.body.insertBefore(row, document.body.firstChild);
}
}
// The Source view lives in dist/source.js, loaded the first time it is chosen.
function setSource(on) {
if (!config.source || on === sourceOn) return;
sourceOn = on;
vscode.setState(Object.assign({}, vscode.getState() || {}, { sourceView: on }));
syncModeSwitch();
if (!on) {
if (window.__archifySource) window.__archifySource.close();
return;
}
if (window.__archifySource) {
window.__archifySource.open();
return;
}
var script = document.createElement('script');
script.src = config.source.scriptUri;
script.onload = function () { if (sourceOn && window.__archifySource) window.__archifySource.open(); };
script.onerror = function () {
sourceOn = false;
syncModeSwitch();
post({ type: 'error', message: 'The Source view could not be loaded.' });
};
document.head.appendChild(script);
}
function showProblemCount(count) {
var badge = document.getElementById('archify-source-badge');
if (!badge) return;
badge.hidden = !count;
badge.textContent = count ? String(count) : '';
badge.title = count ? count + (count === 1 ? ' problem' : ' problems') + ' in the source' : '';
} }
window.addEventListener('message', function (event) { window.addEventListener('message', function (event) {
var message = event.data || {}; var message = event.data || {};
if (message.type === 'notice') showNotice(message.notice); if (message.type === 'notice') showNotice(message.notice);
if (message.type === 'sourceDiagnostics') showProblemCount(message.count);
if (message.type === 'setView') setSource(message.view === 'source');
if (message.type === 'live') renderLive(message.live);
}); });
function onReady(fn) { function onReady(fn) {
if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', fn); if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', fn);
@@ -717,6 +887,11 @@ function bridgeScript(options: PageOptions): string {
onReady(renderDecisionsRail); onReady(renderDecisionsRail);
onReady(describeElements); onReady(describeElements);
onReady(renderModeSwitch); onReady(renderModeSwitch);
if (config.source) {
// The host answers with the problem count for the Source badge.
post({ type: 'sourceReady' });
if ((vscode.getState() || {}).sourceView) onReady(function () { setSource(true); });
}
if (config.notice) { if (config.notice) {
if (document.readyState === 'loading') { if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function () { showNotice(config.notice); }); document.addEventListener('DOMContentLoaded', function () { showNotice(config.notice); });
@@ -731,6 +906,8 @@ const MODEL_STYLE = `
.archify-model { --m-text: var(--text, var(--vscode-foreground, CanvasText)); --m-muted: var(--text-muted, var(--vscode-descriptionForeground, GrayText)); --m-panel: var(--panel, var(--vscode-editorWidget-background, Canvas)); --m-border: var(--panel-border, var(--vscode-editorWidget-border, rgba(128,128,128,.35))); --m-accent: var(--frontend-stroke, var(--vscode-textLink-foreground)); .archify-model { --m-text: var(--text, var(--vscode-foreground, CanvasText)); --m-muted: var(--text-muted, var(--vscode-descriptionForeground, GrayText)); --m-panel: var(--panel, var(--vscode-editorWidget-background, Canvas)); --m-border: var(--panel-border, var(--vscode-editorWidget-border, rgba(128,128,128,.35))); --m-accent: var(--frontend-stroke, var(--vscode-textLink-foreground));
max-width: 1400px; margin: 0 auto; padding: 1.25rem 2rem; color: var(--m-text); font-family: var(--vscode-font-family, system-ui, sans-serif); } max-width: 1400px; margin: 0 auto; padding: 1.25rem 2rem; color: var(--m-text); font-family: var(--vscode-font-family, system-ui, sans-serif); }
.archify-model-head { padding-top: 1.5rem; } .archify-model-head { padding-top: 1.5rem; }
/* Under Archify's fixed toolbar (diagram pages of main.archify), start below it. */
.toolbar ~ .archify-model-head { padding-top: 4.25rem; }
.archify-model-kicker { font-size: 0.6875rem; font-weight: 700; letter-spacing: 0.12em; text-transform: uppercase; color: var(--m-accent); } .archify-model-kicker { font-size: 0.6875rem; font-weight: 700; letter-spacing: 0.12em; text-transform: uppercase; color: var(--m-accent); }
.archify-model-name { margin: 0.25rem 0 0.5rem; font-size: 1.5rem; font-weight: 700; letter-spacing: -0.02em; } .archify-model-name { margin: 0.25rem 0 0.5rem; font-size: 1.5rem; font-weight: 700; letter-spacing: -0.02em; }
.archify-model-description { margin: 0; max-width: 72ch; font-size: 0.9375rem; line-height: 1.55; color: var(--m-muted); white-space: pre-line; } .archify-model-description { margin: 0; max-width: 72ch; font-size: 0.9375rem; line-height: 1.55; color: var(--m-muted); white-space: pre-line; }
@@ -777,6 +954,26 @@ const MODEL_STYLE = `
.archify-modal-defined { margin: 0.75rem 0 0; font-size: 0.8125rem; color: var(--m-muted); display: flex; flex-wrap: wrap; align-items: center; gap: 0.35rem; } .archify-modal-defined { margin: 0.75rem 0 0; font-size: 0.8125rem; color: var(--m-muted); display: flex; flex-wrap: wrap; align-items: center; gap: 0.35rem; }
.archify-modal .archify-model-title { margin: 1.25rem 0 0.6rem; } .archify-modal .archify-model-title { margin: 1.25rem 0 0.6rem; }
.archify-modal .archify-model-list { grid-template-columns: repeat(auto-fill, minmax(220px, 1fr)); } .archify-modal .archify-model-list { grid-template-columns: repeat(auto-fill, minmax(220px, 1fr)); }
/* Live: a shared model's state, people and versions. */
.archify-live-status { display: flex; flex-wrap: wrap; align-items: center; gap: 0.5rem; margin: 0 0.9rem; font-size: 0.8125rem; }
.archify-live-dot { width: 0.55rem; height: 0.55rem; border-radius: 50%; background: var(--m-muted); flex: none; }
.archify-model-live.is-online .archify-live-dot { background: var(--vscode-testing-iconPassed, #3fb950); }
.archify-model-live.is-signed-out .archify-live-dot, .archify-model-live.is-forbidden .archify-live-dot, .archify-model-live.is-outdated .archify-live-dot { background: var(--vscode-editorWarning-foreground, #d29922); }
.archify-live-actions { display: inline-flex; flex-wrap: wrap; gap: 0.35rem; margin-left: auto; }
.archify-live .archify-live-action { font-family: var(--vscode-font-family, system-ui, sans-serif); }
.archify-live-people { list-style: none; display: flex; flex-wrap: wrap; gap: 0.4rem; margin: 0.6rem 0.9rem 0; padding: 0; }
.archify-live-person { display: inline-flex; align-items: baseline; gap: 0.4rem; padding: 0.2rem 0.6rem; border: 1px solid var(--m-border); border-radius: 999px; font-size: 0.8125rem; }
.archify-live-person small { color: var(--m-muted); font-family: ui-monospace, Menlo, monospace; font-size: 0.6875rem; }
.archify-live-person.is-me { opacity: 0.75; }
.archify-live-here { font-size: 0.6875rem; color: var(--m-accent); font-weight: 600; }
.archify-live-versions-head { display: flex; align-items: center; gap: 0.5rem; margin: 0.9rem 0.9rem 0.35rem; font-size: 0.8125rem; font-weight: 600; }
.archify-live-note { margin: 0 0.9rem; font-size: 0.8125rem; }
.archify-live-versions { list-style: none; margin: 0 0.9rem; padding: 0; display: grid; gap: 0.3rem; }
.archify-live-version { display: flex; flex-wrap: wrap; align-items: center; gap: 0.5rem; padding: 0.4rem 0.7rem; border: 1px solid var(--m-border); border-radius: 0.5rem; font-size: 0.8125rem; }
.archify-live-version-label { font-family: ui-monospace, Menlo, monospace; }
.archify-live-version.is-publish .archify-live-version-label { color: var(--m-accent); }
.archify-live-version-name { font-weight: 600; }
.archify-live-version-when { color: var(--m-muted); }
/* Decisions: rows, chips and status badges. */ /* Decisions: rows, chips and status badges. */
.archify-decision-list { grid-template-columns: 1fr; gap: 0.35rem; } .archify-decision-list { grid-template-columns: 1fr; gap: 0.35rem; }
.archify-decision-open { padding: 0.55rem 0.85rem; } .archify-decision-open { padding: 0.55rem 0.85rem; }
@@ -815,15 +1012,19 @@ const MODEL_STYLE = `
/* The Model | Graph switch: in Archify's toolbar it is the 2D | 3D switch's twin; on the model page it sits top right. */ /* The Model | Graph switch: in Archify's toolbar it is the 2D | 3D switch's twin; on the model page it sits top right. */
const SWITCH_STYLE = ` const SWITCH_STYLE = `
.archify-mode-switch { display: inline-flex; align-items: center; padding: 0 0.25rem; gap: 0; border: 0; background: transparent; color: var(--text-muted, var(--vscode-descriptionForeground)); font: inherit; cursor: pointer; position: relative; } .archify-mode-switch { display: inline-flex; align-items: center; padding: 0 0.25rem; gap: 0; color: var(--text-muted, var(--vscode-descriptionForeground)); position: relative; }
.toolbar .archify-mode-switch::before { content: ""; position: absolute; inset: 0.25rem 0; border-radius: 0.6875rem; background: color-mix(in srgb, var(--panel) 78%, transparent); box-shadow: inset 0 0 0 1px color-mix(in srgb, var(--panel-border) 85%, transparent), 0 1px 2px rgba(15, 23, 42, 0.04); backdrop-filter: blur(12px); } .toolbar .archify-mode-switch::before { content: ""; position: absolute; inset: 0.25rem 0; border-radius: 0.6875rem; background: color-mix(in srgb, var(--panel) 78%, transparent); box-shadow: inset 0 0 0 1px color-mix(in srgb, var(--panel-border) 85%, transparent), 0 1px 2px rgba(15, 23, 42, 0.04); backdrop-filter: blur(12px); }
.toolbar .archify-mode-switch:hover::before { box-shadow: inset 0 0 0 1px color-mix(in srgb, var(--text) 22%, transparent), 0 1px 2px rgba(15, 23, 42, 0.04); } .toolbar .archify-mode-switch:hover::before { box-shadow: inset 0 0 0 1px color-mix(in srgb, var(--text) 22%, transparent), 0 1px 2px rgba(15, 23, 42, 0.04); }
.archify-mode-seg { position: relative; display: inline-flex; align-items: center; height: 1.75rem; padding: 0 0.7rem; border-radius: 0.5rem; font-weight: 550; font-size: 0.8125rem; transition: background 0.15s, color 0.15s; } /* Anchored on the id: Archify's .toolbar button rules (one of them with :not(#btn-theme)) would win otherwise. */
.archify-mode-seg.on { color: var(--bg, var(--vscode-editor-background)); background: var(--text, var(--vscode-foreground)); box-shadow: 0 1px 2px rgba(15, 23, 42, 0.12), 0 6px 16px -8px rgba(15, 23, 42, 0.4); } #archify-mode-switch .archify-mode-seg { position: relative; display: inline-flex; align-items: center; height: 1.75rem; padding: 0 0.7rem; border: 0; border-radius: 0.5rem; background: transparent; color: inherit; font: inherit; font-weight: 550; font-size: 0.8125rem; cursor: pointer; transition: background 0.15s, color 0.15s; }
.archify-mode-switch:hover .archify-mode-seg:not(.on) { color: var(--text, var(--vscode-foreground)); } #archify-mode-switch .archify-mode-seg.on[aria-pressed="true"] { color: var(--bg, var(--vscode-editor-background)); background: var(--text, var(--vscode-foreground)); box-shadow: 0 1px 2px rgba(15, 23, 42, 0.12), 0 6px 16px -8px rgba(15, 23, 42, 0.4); }
.archify-mode-switch:focus-visible { outline: 2px solid var(--frontend-stroke, var(--vscode-focusBorder)); outline-offset: 2px; border-radius: 0.75rem; } #archify-mode-switch .archify-mode-seg:hover:not(.on) { color: var(--text, var(--vscode-foreground)); }
#archify-mode-switch .archify-mode-seg:focus-visible { outline: 2px solid var(--frontend-stroke, var(--vscode-focusBorder)); outline-offset: 1px; }
.archify-source-badge { display: inline-block; min-width: 1rem; margin-left: 0.35rem; padding: 0 0.3rem; border-radius: 999px; background: var(--security-stroke, var(--vscode-editorError-foreground, #f14c4c)); color: var(--bg, #fff); font-size: 0.6875rem; font-weight: 700; line-height: 1rem; text-align: center; }
.archify-source-badge[hidden] { display: none; }
.archify-model-switch-row { float: right; margin: 1.5rem 0 0 1rem; } .archify-model-switch-row { float: right; margin: 1.5rem 0 0 1rem; }
.archify-model-switch-row .archify-mode-switch { border: 1px solid var(--m-border); border-radius: 0.75rem; background: var(--m-panel); padding: 0.1rem 0.25rem; } body > .archify-model-switch-row { position: relative; z-index: 2; margin: 1rem 1.25rem 0 1rem; }
.archify-model-switch-row .archify-mode-switch { border: 1px solid var(--m-border, var(--vscode-editorWidget-border, rgba(128,128,128,.35))); border-radius: 0.75rem; background: var(--m-panel, var(--vscode-editorWidget-background)); padding: 0.1rem 0.25rem; }
`; `;
/* Connectors rail panel: highlight of the hovered or selected edge in the SVG. */ /* Connectors rail panel: highlight of the hovered or selected edge in the SVG. */
@@ -895,8 +1096,8 @@ export function prepareDiagramHtml(html: string, options: PageOptions): string {
} }
/** The model page for a main.archify without a diagram of its own. */ /** The model page for a main.archify without a diagram of its own. */
export function modelPage(options: Pick<PageOptions, 'cspSource' | 'nonce' | 'state'>, model: ModelPanel): string { export function modelPage(options: Pick<PageOptions, 'cspSource' | 'nonce' | 'state' | 'source'>, model: ModelPanel): string {
const bridge = bridgeScript({ cspSource: options.cspSource, nonce: options.nonce, theme: undefined, state: options.state, model, links: {}, graphSwitch: { left: 'Model' } }); const bridge = bridgeScript({ cspSource: options.cspSource, nonce: options.nonce, theme: undefined, state: options.state, model, links: {}, graphSwitch: { left: 'Model' }, source: options.source });
return `<!DOCTYPE html> return `<!DOCTYPE html>
<html lang="en"> <html lang="en">
<head> <head>
@@ -935,8 +1136,8 @@ export function graphPage(options: Pick<PageOptions, 'cspSource' | 'nonce' | 'st
} }
/** The registry page for one .archify-registry file. */ /** The registry page for one .archify-registry file. */
export function registryPage(options: Pick<PageOptions, 'cspSource' | 'nonce' | 'state'>, registry: RegistryPanel): string { export function registryPage(options: Pick<PageOptions, 'cspSource' | 'nonce' | 'state' | 'source'>, registry: RegistryPanel): string {
const bridge = bridgeScript({ cspSource: options.cspSource, nonce: options.nonce, theme: undefined, state: options.state, registry, links: {} }); const bridge = bridgeScript({ cspSource: options.cspSource, nonce: options.nonce, theme: undefined, state: options.state, registry, links: {}, source: options.source });
return `<!DOCTYPE html> return `<!DOCTYPE html>
<html lang="en"> <html lang="en">
<head> <head>
@@ -947,6 +1148,8 @@ export function registryPage(options: Pick<PageOptions, 'cspSource' | 'nonce' |
<style> <style>
body { margin: 0; color: var(--vscode-foreground); background: var(--vscode-editor-background); } body { margin: 0; color: var(--vscode-foreground); background: var(--vscode-editor-background); }
${MODEL_STYLE} ${MODEL_STYLE}
${SWITCH_STYLE}
${NOTICE_STYLE}
</style> </style>
</head> </head>
<body></body> <body></body>
@@ -954,8 +1157,8 @@ export function registryPage(options: Pick<PageOptions, 'cspSource' | 'nonce' |
} }
/** The decision page for one .archify-decision file. */ /** The decision page for one .archify-decision file. */
export function decisionPage(options: Pick<PageOptions, 'cspSource' | 'nonce' | 'state'>, decision: DecisionPanel): string { export function decisionPage(options: Pick<PageOptions, 'cspSource' | 'nonce' | 'state' | 'source'>, decision: DecisionPanel): string {
const bridge = bridgeScript({ cspSource: options.cspSource, nonce: options.nonce, theme: undefined, state: options.state, decision, links: {} }); const bridge = bridgeScript({ cspSource: options.cspSource, nonce: options.nonce, theme: undefined, state: options.state, decision, links: {}, source: options.source });
return `<!DOCTYPE html> return `<!DOCTYPE html>
<html lang="en"> <html lang="en">
<head> <head>
@@ -966,28 +1169,34 @@ export function decisionPage(options: Pick<PageOptions, 'cspSource' | 'nonce' |
<style> <style>
body { margin: 0; color: var(--vscode-foreground); background: var(--vscode-editor-background); } body { margin: 0; color: var(--vscode-foreground); background: var(--vscode-editor-background); }
${MODEL_STYLE} ${MODEL_STYLE}
${SWITCH_STYLE}
${NOTICE_STYLE}
</style> </style>
</head> </head>
<body></body> <body></body>
</html>`; </html>`;
} }
/** A small VS Code-styled page for loading and error states. */ /** A small VS Code-styled page for loading and error states; with `source`, the YAML can be fixed in place. */
export function messagePage( export function messagePage(
options: Pick<PageOptions, 'cspSource' | 'nonce' | 'state'>, options: Pick<PageOptions, 'cspSource' | 'nonce' | 'state' | 'source'>,
title: string, title: string,
body: string, body: string,
detail?: string, detail?: string,
): string { ): string {
const script = options.source
? bridgeScript({ cspSource: options.cspSource, nonce: options.nonce, theme: undefined, state: options.state, links: {}, source: options.source })
: `(function () { var vscode = acquireVsCodeApi(); var state = ${scriptJson(options.state)}; if (state) vscode.setState(state); })();`;
return `<!DOCTYPE html> return `<!DOCTYPE html>
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="Content-Security-Policy" content="${escapeHtml(contentSecurityPolicy(options.cspSource, options.nonce))}"> <meta http-equiv="Content-Security-Policy" content="${escapeHtml(contentSecurityPolicy(options.cspSource, options.nonce))}">
<script nonce="${options.nonce}">(function () { var vscode = acquireVsCodeApi(); var state = ${scriptJson(options.state)}; if (state) vscode.setState(state); })();</script> <script nonce="${options.nonce}">${script}</script>
<style> <style>
body { font-family: var(--vscode-font-family); color: var(--vscode-foreground); background: var(--vscode-editor-background); padding: 24px 28px; } body { font-family: var(--vscode-font-family); color: var(--vscode-foreground); background: var(--vscode-editor-background); padding: 24px 28px; }
${options.source ? SWITCH_STYLE + NOTICE_STYLE : ''}
h2 { font-weight: 600; font-size: 15px; margin: 0 0 8px; } h2 { font-weight: 600; font-size: 15px; margin: 0 0 8px; }
p { margin: 0 0 12px; color: var(--vscode-descriptionForeground); } p { margin: 0 0 12px; color: var(--vscode-descriptionForeground); }
pre { font-family: var(--vscode-editor-font-family); font-size: 12px; white-space: pre-wrap; word-break: break-word; pre { font-family: var(--vscode-editor-font-family); font-size: 12px; white-space: pre-wrap; word-break: break-word;
+5
View File
@@ -0,0 +1,5 @@
// The package's "./yaml" export needs "bundler" module resolution; this
// repository resolves like Node 10, so point at its types directly.
declare module 'codemirror-json-schema/yaml' {
export * from 'codemirror-json-schema/dist/yaml/index';
}
+258
View File
@@ -0,0 +1,258 @@
import { autocompletion, closeBrackets, closeBracketsKeymap, completionKeymap } from '@codemirror/autocomplete';
import { defaultKeymap, history, historyKeymap, indentWithTab } from '@codemirror/commands';
import { yaml, yamlLanguage } from '@codemirror/lang-yaml';
import { HighlightStyle, bracketMatching, foldGutter, foldKeymap, indentOnInput, indentUnit, syntaxHighlighting } from '@codemirror/language';
import { lintGutter, lintKeymap, nextDiagnostic, setDiagnostics } from '@codemirror/lint';
import { Annotation, EditorState, Range, StateEffect, StateField, Transaction } from '@codemirror/state';
import {
Decoration,
DecorationSet,
EditorView,
WidgetType,
drawSelection,
dropCursor,
highlightActiveLine,
highlightActiveLineGutter,
highlightSpecialChars,
hoverTooltip,
keymap,
lineNumbers,
rectangularSelection,
} from '@codemirror/view';
import { tags as t } from '@lezer/highlight';
import { stateExtensions, updateSchema } from 'codemirror-json-schema';
import { yamlCompletion, yamlSchemaHover } from 'codemirror-json-schema/yaml';
import type { TextChange } from '../../util/textDiff';
/** A problem from the host, as offsets into the "\n" text it checked. */
export interface SourceDiagnostic {
from: number;
to: number;
severity: 'error' | 'warning' | 'info';
message: string;
source?: string;
}
/** A teammate's cursor (Archify Sync), as offsets into the editor's text. */
export interface RemoteCursor {
name: string;
color: string;
anchor: number;
head: number;
}
const setRemoteCursors = StateEffect.define<RemoteCursor[]>();
class RemoteCaret extends WidgetType {
constructor(
readonly name: string,
readonly color: string,
) {
super();
}
eq(other: RemoteCaret): boolean {
return other.name === this.name && other.color === this.color;
}
toDOM(): HTMLElement {
const caret = document.createElement('span');
caret.className = 'cm-remote-caret';
caret.style.borderLeftColor = this.color;
const label = document.createElement('span');
label.className = 'cm-remote-label';
label.textContent = this.name;
label.style.backgroundColor = this.color;
caret.appendChild(label);
return caret;
}
ignoreEvent(): boolean {
return true;
}
}
function remoteDecorations(cursors: RemoteCursor[], length: number): DecorationSet {
const ranges: Range<Decoration>[] = [];
const clamp = (n: number) => Math.max(0, Math.min(n, length));
for (const c of cursors) {
const anchor = clamp(c.anchor);
const head = clamp(c.head);
if (anchor !== head) {
ranges.push(
Decoration.mark({ class: 'cm-remote-selection', attributes: { style: `background-color: color-mix(in srgb, ${c.color} 22%, transparent)` } }).range(Math.min(anchor, head), Math.max(anchor, head)),
);
}
ranges.push(Decoration.widget({ widget: new RemoteCaret(c.name, c.color), side: 1 }).range(head));
}
return Decoration.set(ranges, true);
}
/** Teammates' carets and selections; they move with the text as anyone types. */
const remoteCursors = StateField.define<DecorationSet>({
create: () => Decoration.none,
update(decorations, tr) {
decorations = decorations.map(tr.changes);
for (const effect of tr.effects) if (effect.is(setRemoteCursors)) decorations = remoteDecorations(effect.value, tr.state.doc.length);
return decorations;
},
provide: (field) => EditorView.decorations.from(field),
});
/** Marks transactions that carry text from the host, so they are not sent back. */
const fromHost = Annotation.define<boolean>();
// The page's own variables (Archify's, or ours on model pages), so the
// editor follows the page theme, light or dark.
const theme = EditorView.theme({
'&': { height: '100%', color: 'var(--text, var(--vscode-editor-foreground))', backgroundColor: 'transparent', fontSize: '12.5px' },
'.cm-scroller': { fontFamily: 'var(--vscode-editor-font-family, ui-monospace, Menlo, "SF Mono", monospace)', lineHeight: '1.6' },
'.cm-content': { caretColor: 'var(--frontend-stroke, var(--vscode-editorCursor-foreground))' },
'.cm-cursor, .cm-dropCursor': { borderLeftColor: 'var(--frontend-stroke, var(--vscode-editorCursor-foreground))' },
'.cm-gutters': { backgroundColor: 'transparent', color: 'var(--text-muted, var(--vscode-editorLineNumber-foreground))', border: 'none' },
'.cm-activeLine, .cm-activeLineGutter': { backgroundColor: 'color-mix(in srgb, var(--text, var(--vscode-editor-foreground)) 5%, transparent)' },
'&.cm-focused .cm-selectionBackground, .cm-selectionBackground, .cm-content ::selection': {
backgroundColor: 'color-mix(in srgb, var(--frontend-stroke, var(--vscode-editor-selectionBackground)) 28%, transparent) !important',
},
'&.cm-focused': { outline: 'none' },
'.cm-tooltip': {
backgroundColor: 'var(--panel, var(--vscode-editorHoverWidget-background))',
color: 'var(--text, var(--vscode-editorHoverWidget-foreground))',
border: '1px solid var(--panel-border, var(--vscode-editorHoverWidget-border))',
borderRadius: '8px',
maxWidth: '440px',
},
'.cm-tooltip code': { fontFamily: 'var(--vscode-editor-font-family, ui-monospace, Menlo, monospace)', color: 'var(--frontend-stroke, var(--vscode-textPreformat-foreground))' },
'.cm-tooltip-autocomplete ul li[aria-selected]': { backgroundColor: 'var(--frontend-stroke, var(--vscode-list-activeSelectionBackground))', color: 'var(--bg, var(--vscode-list-activeSelectionForeground))' },
'.cm-diagnostic': { padding: '4px 8px' },
'.cm-remote-caret': { position: 'relative', borderLeft: '2px solid', marginLeft: '-1px', marginRight: '-1px', pointerEvents: 'none' },
'.cm-remote-label': {
position: 'absolute',
bottom: '100%',
left: '-2px',
padding: '0 4px',
borderRadius: '3px 3px 3px 0',
color: '#fff',
fontSize: '10px',
lineHeight: '1.5',
fontFamily: 'var(--vscode-font-family, system-ui, sans-serif)',
whiteSpace: 'nowrap',
zIndex: '5',
opacity: '0.9',
},
'.cm-line:first-child .cm-remote-label': { bottom: 'auto', top: '100%', borderRadius: '0 3px 3px 3px' },
'.cm-foldPlaceholder': { backgroundColor: 'transparent', border: '1px solid var(--panel-border, var(--vscode-editorWidget-border))', color: 'inherit' },
});
const highlight = HighlightStyle.define([
{ tag: [t.propertyName, t.definition(t.propertyName)], color: 'var(--frontend-stroke, var(--vscode-symbolIcon-propertyForeground, #22d3ee))' },
{ tag: [t.number, t.bool, t.null, t.atom], color: 'var(--cloud-stroke, var(--vscode-debugTokenExpression-number, #fbbf24))' },
{ tag: [t.comment, t.lineComment], color: 'var(--text-muted, var(--vscode-descriptionForeground))', fontStyle: 'italic' },
{ tag: [t.punctuation, t.separator, t.squareBracket, t.brace], color: 'var(--text-muted, var(--vscode-descriptionForeground))' },
{ tag: [t.keyword, t.typeName, t.labelName, t.meta], color: 'var(--database-stroke, var(--vscode-symbolIcon-keywordForeground, #a78bfa))' },
]);
export class SourceEditor {
readonly view: EditorView;
private schemaKey: string | undefined;
constructor(
parent: HTMLElement,
text: string,
onEdit: (changes: TextChange[], text: string) => void,
/** The main selection moved (or the editor got focus); offsets into the text. */
onSelection: (anchor: number, head: number) => void = () => undefined,
) {
this.view = new EditorView({
parent,
state: EditorState.create({
doc: text,
extensions: [
// Undo and redo are the editor's own: VS Code sends ⌘Z in a focused
// webview to the webview, not to the document. Every step still
// reaches the document as an edit. Save and find stay VS Code's
// (no search panel here).
history(),
lineNumbers(),
highlightActiveLineGutter(),
highlightSpecialChars(),
foldGutter(),
drawSelection(),
dropCursor(),
EditorState.allowMultipleSelections.of(true),
indentOnInput(),
bracketMatching(),
closeBrackets(),
autocompletion(),
rectangularSelection(),
highlightActiveLine(),
keymap.of([...closeBracketsKeymap, ...defaultKeymap, ...historyKeymap, ...foldKeymap, ...completionKeymap, ...lintKeymap, indentWithTab]),
EditorState.tabSize.of(2),
indentUnit.of(' '),
yaml(),
theme,
syntaxHighlighting(highlight),
lintGutter(),
stateExtensions(undefined as never),
yamlLanguage.data.of({ autocomplete: yamlCompletion() }),
hoverTooltip(yamlSchemaHover()),
remoteCursors,
EditorView.updateListener.of((update) => {
if (update.selectionSet || update.docChanged || (update.focusChanged && update.view.hasFocus)) {
const main = update.state.selection.main;
onSelection(main.anchor, main.head);
}
if (!update.docChanged || update.transactions.some((tr) => tr.annotation(fromHost))) return;
const changes: TextChange[] = [];
update.changes.iterChanges((fromA, toA, _fromB, _toB, inserted) => changes.push({ from: fromA, to: toA, insert: inserted.toString() }));
onEdit(changes, update.state.doc.toString());
}),
],
}),
});
}
get text(): string {
return this.view.state.doc.toString();
}
/** Text from the host (an edit elsewhere, git): one change, cursor kept, not undoable here. */
applyFromHost(change: TextChange): void {
this.view.dispatch({ changes: change, annotations: [fromHost.of(true), Transaction.addToHistory.of(false)] });
}
/** Teammates' cursors, from the host; they replace the ones shown. */
setRemoteCursors(cursors: RemoteCursor[]): void {
this.view.dispatch({ effects: setRemoteCursors.of(cursors) });
}
/** The schema that completion and hover read; `undefined` turns them off. */
setSchema(key: string | undefined, schema: object | undefined): void {
if (key === this.schemaKey) return;
this.schemaKey = key;
updateSchema(this.view, schema as never);
}
/** The host's problems for the text it checked; the editor maps them through later typing. */
setDiagnostics(items: SourceDiagnostic[]): void {
const length = this.view.state.doc.length;
const diagnostics = items
.filter((d) => d.from <= length)
.map((d) => ({ from: d.from, to: Math.min(Math.max(d.to, d.from), length), severity: d.severity, message: d.message, source: d.source }));
this.view.dispatch(setDiagnostics(this.view.state, diagnostics));
}
/** Moves the cursor to the next problem and opens its message. */
nextProblem(): void {
this.view.focus();
nextDiagnostic(this.view);
}
focus(): void {
this.view.focus();
}
requestMeasure(): void {
this.view.requestMeasure();
}
}
+219
View File
@@ -0,0 +1,219 @@
import type { ArchifyHost } from '../host';
import { TextChange, minimalChange } from '../../util/textDiff';
import { RemoteCursor, SourceDiagnostic, SourceEditor } from './editor';
/**
* The Source view of an Archify page: the file's YAML in an editor, in the
* page under its toolbar and heading, in place of the picture. The bridge
* script (page.ts) loads this file the first time Source is chosen and calls
* window.__archifySource.open(); the document itself stays in the host, which
* applies every edit to it and sends back problems and outside changes.
*/
/** Host → page. */
type HostMessage =
| { type: 'sourceText'; text: string; schema?: { key: string; schema: object } | null; checks: string }
| { type: 'sourceDiagnostics'; items: SourceDiagnostic[]; count: number }
| { type: 'sourceSchema'; schema: { key: string; schema: object } | null }
| { type: 'sourceDirty'; dirty: boolean }
| { type: 'sourceCursors'; cursors: RemoteCursor[] };
const STYLE = `
html.archify-source-on .container > :not(.header):not(#archify-source),
html.archify-source-on body > :not(.toolbar):not(.container):not(.archify-model-head):not(.archify-model-switch-row):not(#archify-source):not(script):not(style):not(.archify-modal-backdrop),
html.archify-source-on #btn-3d,
html.archify-source-on .archify-vscode-notice { display: none !important; }
.archify-source { display: flex; flex-direction: column; box-sizing: border-box; min-height: 260px; margin: 0.75rem 0 1rem; }
body > .archify-source { max-width: 1400px; margin: 0.75rem auto 1rem; padding: 0 2rem; }
.archify-source-editor { flex: 1; min-height: 0; overflow: hidden; border: 1px solid var(--panel-border, var(--vscode-editorWidget-border, rgba(128,128,128,.35))); border-radius: 0.75rem;
background: color-mix(in srgb, var(--panel, var(--vscode-editor-background)) 70%, transparent); }
.archify-source-editor .cm-editor { height: 100%; }
.archify-source-strip { display: flex; flex-wrap: wrap; gap: 0.35rem 1rem; align-items: center; padding: 0.45rem 0.25rem 0; font-size: 0.75rem;
color: var(--text-muted, var(--vscode-descriptionForeground)); font-family: var(--vscode-font-family, system-ui, sans-serif); }
.archify-source-strip .is-ok { color: var(--backend-stroke, var(--vscode-testing-iconPassed, #34d399)); }
.archify-source-strip .is-bad { color: var(--security-stroke, var(--vscode-editorError-foreground, #fb7185)); }
.archify-source-strip button { font: inherit; color: inherit; background: none; border: 0; padding: 0; cursor: pointer; }
.archify-source-strip button:hover { text-decoration: underline; }
.archify-source-strip .archify-source-hint { margin-left: auto; }
.archify-source-strip kbd { font: inherit; font-size: 0.6875rem; padding: 0 0.3rem; border: 1px solid currentColor; border-radius: 0.25rem; opacity: 0.8; }
`;
const MAC = /Mac|iPhone|iPad/.test(navigator.platform);
function isUndoRedo(event: KeyboardEvent): boolean {
const key = event.key.toLowerCase();
return (event.metaKey || event.ctrlKey) && !event.altKey && (key === 'z' || key === 'y');
}
class SourcePane {
private root: HTMLElement | undefined;
private editorHost!: HTMLElement;
private stateEl!: HTMLElement;
private countEl!: HTMLButtonElement;
private checksEl!: HTMLElement;
private editor: SourceEditor | undefined;
/** The text the host last knew the page to have; edits are sent against it. */
private text = '';
private diagnostics: SourceDiagnostic[] = [];
private cursors: RemoteCursor[] = [];
private shown = false;
private selectionTimer: ReturnType<typeof setTimeout> | undefined;
private selection: { anchor: number; head: number } | undefined;
constructor(private readonly host: ArchifyHost) {
window.addEventListener('message', (event) => this.onMessage(event.data as HostMessage));
window.addEventListener('resize', () => this.fit());
}
open(): void {
this.build();
this.shown = true;
document.documentElement.classList.add('archify-source-on');
window.dispatchEvent(new CustomEvent('archify-source', { detail: { on: true } }));
this.fit();
this.host.post({ type: 'sourceOpen' });
this.editor?.focus();
}
close(): void {
this.shown = false;
document.documentElement.classList.remove('archify-source-on');
window.dispatchEvent(new CustomEvent('archify-source', { detail: { on: false } }));
this.host.post({ type: 'sourceClose' });
}
private build(): void {
if (this.root) return;
const style = document.createElement('style');
style.textContent = STYLE;
document.head.appendChild(style);
const root = document.createElement('section');
root.id = 'archify-source';
root.className = 'archify-source';
root.setAttribute('aria-label', 'Source');
this.editorHost = document.createElement('div');
this.editorHost.className = 'archify-source-editor';
const strip = document.createElement('div');
strip.className = 'archify-source-strip';
this.stateEl = document.createElement('span');
this.countEl = document.createElement('button');
this.countEl.type = 'button';
this.countEl.title = 'Go to the next problem';
this.countEl.addEventListener('click', () => this.editor?.nextProblem());
this.checksEl = document.createElement('span');
const hint = document.createElement('span');
hint.className = 'archify-source-hint';
hint.innerHTML = 'Completion as you type, or <kbd>Ctrl</kbd>+<kbd>Space</kbd> · hover a key for its description';
strip.append(this.stateEl, this.countEl, this.checksEl, hint);
root.append(this.editorHost, strip);
this.renderState(false);
this.renderCount();
// Archify's page has single-key shortcuts; typing here must not reach
// them. Keys with ⌘ or Ctrl go on to VS Code (save, find, quick open),
// except undo and redo, which the editor has handled already.
for (const type of ['keydown', 'keypress', 'keyup'] as const) {
root.addEventListener(type, (event) => {
if (!event.metaKey && !event.ctrlKey) event.stopPropagation();
else if (isUndoRedo(event)) event.stopPropagation();
});
}
const header = document.querySelector('.container > .header');
const modelHead = document.querySelector('.archify-model-head');
if (header?.parentElement) header.parentElement.insertBefore(root, header.nextSibling);
else if (modelHead?.parentElement) modelHead.parentElement.insertBefore(root, modelHead.nextSibling);
else document.body.appendChild(root);
this.root = root;
}
/** The editor fills the window below where it starts. */
private fit(): void {
if (!this.root || !this.shown) return;
const top = this.root.getBoundingClientRect().top;
this.root.style.height = `${Math.max(260, window.innerHeight - Math.max(top, 0) - 12)}px`;
this.editor?.requestMeasure();
}
private onMessage(message: HostMessage): void {
if (!message || typeof message !== 'object') return;
switch (message.type) {
case 'sourceText':
this.build();
if (!this.editor) {
this.text = message.text;
this.editor = new SourceEditor(
this.editorHost,
message.text,
(changes, text) => this.onEdit(changes, text),
(anchor, head) => this.onSelection(anchor, head),
);
this.editor.setDiagnostics(this.diagnostics);
this.editor.setRemoteCursors(this.cursors);
this.fit();
if (this.shown) this.editor.focus();
} else {
const change = minimalChange(this.editor.text, message.text);
if (change) this.editor.applyFromHost(change);
this.text = message.text;
}
if (message.schema !== undefined) this.editor.setSchema(message.schema?.key, message.schema?.schema);
this.checksEl.textContent = message.checks;
return;
case 'sourceDiagnostics':
this.diagnostics = message.items;
this.editor?.setDiagnostics(message.items);
this.renderCount();
return;
case 'sourceSchema':
this.editor?.setSchema(message.schema?.key, message.schema?.schema);
return;
case 'sourceDirty':
this.renderState(message.dirty);
return;
case 'sourceCursors':
this.cursors = message.cursors;
this.editor?.setRemoteCursors(message.cursors);
return;
}
}
/** Teammates see where you are; sent at most every 80 ms, after the edit it follows. */
private onSelection(anchor: number, head: number): void {
this.selection = { anchor, head };
if (this.selectionTimer) return;
this.selectionTimer = setTimeout(() => {
this.selectionTimer = undefined;
if (this.selection && this.shown) this.host.post({ type: 'sourceSelection', ...this.selection });
}, 80);
}
private onEdit(changes: TextChange[], text: string): void {
const base = this.text;
this.text = text;
this.host.post({ type: 'sourceEdit', base, text, changes });
}
private renderState(dirty: boolean): void {
if (!this.stateEl) return;
this.stateEl.innerHTML = dirty ? `● Unsaved · <kbd>${MAC ? '⌘' : 'Ctrl+'}S</kbd> saves` : 'Saved';
}
private renderCount(): void {
if (!this.countEl) return;
const problems = this.diagnostics.filter((d) => d.severity !== 'info').length;
this.countEl.className = problems ? 'is-bad' : 'is-ok';
this.countEl.textContent = problems ? `✕ ${problems} problem${problems === 1 ? '' : 's'}` : '✓ No problems';
this.countEl.disabled = !problems;
}
}
declare global {
interface Window {
__archifySource?: { open(): void; close(): void };
}
}
const host = window.__archifyHost;
if (host) window.__archifySource = new SourcePane(host);
+10
View File
@@ -0,0 +1,10 @@
// Stands in for codemirror-json-schema's utils/markdown, which brings
// markdown-it and shiki (about 400 KB) to format schema descriptions. Ours
// only use `code` spans: escape the text and keep those. esbuild.mjs swaps
// this file in.
const escape = (s: string) => s.replace(/[&<>"]/g, (c) => ({ '&': '&amp;', '<': '&lt;', '>': '&gt;', '"': '&quot;' })[c]!);
export function renderMarkdown(markdown: string, inline = true): string {
const html = escape(String(markdown)).replace(/`([^`]+)`/g, '<code>$1</code>');
return inline ? html : `<p>${html.replace(/\n{2,}/g, '</p><p>')}</p>`;
}
+5
View File
@@ -18,3 +18,8 @@ export function viewer3dOption(webview: vscode.Webview, extensionUri: vscode.Uri
export function graphScriptUri(webview: vscode.Webview, extensionUri: vscode.Uri): string { export function graphScriptUri(webview: vscode.Webview, extensionUri: vscode.Uri): string {
return webview.asWebviewUri(vscode.Uri.joinPath(extensionUri, 'dist', 'graph.js')).toString(); return webview.asWebviewUri(vscode.Uri.joinPath(extensionUri, 'dist', 'graph.js')).toString();
} }
/** The Source view script (a webview URI), loaded by the page the first time Source is chosen. */
export function sourceScriptUri(webview: vscode.Webview, extensionUri: vscode.Uri): string {
return webview.asWebviewUri(vscode.Uri.joinPath(extensionUri, 'dist', 'source.js')).toString();
}
+53
View File
@@ -0,0 +1,53 @@
import assert from 'node:assert/strict';
import path from 'node:path';
import { test } from 'node:test';
import { EditorSchemas, bundleSchema } from '../src/language/editorSchemas';
import { readSchemas } from '../src/language/schemaCheck';
const schemas = readSchemas(path.resolve(__dirname, '..', '..', 'schemas'));
/** Every "$ref" in a bundled schema must point inside it. */
function resolveAll(schema: object): void {
const visit = (node: unknown): void => {
if (Array.isArray(node)) return node.forEach(visit);
if (!node || typeof node !== 'object') return;
for (const [key, value] of Object.entries(node)) {
if (key === '$ref') {
assert.match(String(value), /^#/, `local ref: ${value}`);
let target: unknown = schema;
for (const part of String(value).slice(1).split('/').filter(Boolean)) {
target = (target as Record<string, unknown>)[part.replace(/~1/g, '/').replace(/~0/g, '~')];
assert.ok(target !== undefined, `${value} resolves`);
}
} else visit(value);
}
};
visit(schema);
}
test('each schema bundles into one self-contained document', () => {
for (const name of Object.keys(schemas)) {
const bundled = bundleSchema(schemas, name);
resolveAll(bundled);
const text = JSON.stringify(bundled);
assert.ok(!text.includes('"prefixItems"'), `${name}: no prefixItems`);
assert.ok(!text.includes('"$schema"'), `${name}: no $schema`);
}
});
test('points become draft-07 tuples', () => {
const architecture = bundleSchema(schemas, 'architecture.schema.json') as { $defs: Record<string, { $defs: Record<string, unknown> }> };
const point = architecture.$defs['file:common.schema.json'].$defs.point as Record<string, unknown>;
assert.deepEqual(point.items, [{ type: 'number' }, { type: 'number' }]);
assert.equal(point.additionalItems, false);
});
test('a diagram gets the schema of its diagram_type, a decision none', () => {
const editor = new EditorSchemas(schemas);
assert.equal(editor.forSource('diagram', 'schema_version: 1\ndiagram_type: sequence\n')?.key, 'sequence.schema.json');
assert.equal(editor.forSource('diagram', 'diagram_type: "workflow"\n')?.key, 'workflow.schema.json');
assert.equal(editor.forSource('diagram', 'meta:\n title: x\n')?.key, 'archify.schema.json');
assert.equal(editor.forSource('diagram', 'diagram_type: poster\n')?.key, 'archify.schema.json');
assert.equal(editor.forSource('registry', '')?.key, 'archify-registry.schema.json');
assert.equal(editor.forSource('decision', ''), undefined);
});
+216 -3
View File
@@ -1,6 +1,10 @@
import assert from 'node:assert/strict'; import assert from 'node:assert/strict';
import path from 'node:path'; import path from 'node:path';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import * as Y from 'yjs';
import { FileBridge } from '../../src/sync/fileBridge';
import { LiveSpace } from '../../src/sync/liveSpace';
import type { SyncAuth } from '../../src/sync/auth';
const EXTENSION_ID = 'root-at-skic.archify-vscode-ext'; const EXTENSION_ID = 'root-at-skic.archify-vscode-ext';
@@ -61,9 +65,18 @@ export async function run(): Promise<void> {
assert.equal(vscode.window.activeTextEditor?.document.uri.toString() === uri.toString(), false, 'no text editor was opened for it'); assert.equal(vscode.window.activeTextEditor?.document.uri.toString() === uri.toString(), false, 'no text editor was opened for it');
}); });
await check('.archify files are YAML and Show Source opens the text beside the diagram', async () => { await check('Show Source keeps the diagram in its one tab (the page switches to Source)', async () => {
const uri = workspaceFile('web-platform.archify'); const uri = workspaceFile('web-platform.archify');
await vscode.commands.executeCommand('archify.showSource'); await vscode.commands.executeCommand('archify.showSource');
await new Promise((resolve) => setTimeout(resolve, 1000));
assert.equal(vscode.window.visibleTextEditors.some((e) => e.document.uri.toString() === uri.toString()), false, 'no text editor was opened');
const tabs = vscode.window.tabGroups.all.flatMap((g) => g.tabs).filter((t) => t.input instanceof vscode.TabInputCustom && t.input.uri.toString() === uri.toString());
assert.equal(tabs.length, 1);
});
await check('.archify files are YAML and Open in Text Editor opens the text beside the diagram', async () => {
const uri = workspaceFile('web-platform.archify');
await vscode.commands.executeCommand('archify.openInTextEditor');
const editor = await waitFor('source text editor', () => const editor = await waitFor('source text editor', () =>
vscode.window.visibleTextEditors.find((e) => e.document.uri.toString() === uri.toString()), vscode.window.visibleTextEditors.find((e) => e.document.uri.toString() === uri.toString()),
); );
@@ -333,14 +346,14 @@ export async function run(): Promise<void> {
await new Promise((resolve) => setTimeout(resolve, 500)); await new Promise((resolve) => setTimeout(resolve, 500));
}); });
await check('a .archify-registry file opens as the registry view and Show Source opens the YAML', async () => { await check('a .archify-registry file opens as the registry view and Open in Text Editor opens the YAML', async () => {
const registry = workspaceFile('model/registry/people.archify-registry'); const registry = workspaceFile('model/registry/people.archify-registry');
await vscode.commands.executeCommand('vscode.open', registry); await vscode.commands.executeCommand('vscode.open', registry);
const tab = await waitFor('registry view tab', () => const tab = await waitFor('registry view tab', () =>
vscode.window.tabGroups.all.flatMap((g) => g.tabs).find((t) => t.isActive && t.input instanceof vscode.TabInputCustom && t.input.viewType === 'archify.registry' && t.input.uri.toString() === registry.toString()), vscode.window.tabGroups.all.flatMap((g) => g.tabs).find((t) => t.isActive && t.input instanceof vscode.TabInputCustom && t.input.viewType === 'archify.registry' && t.input.uri.toString() === registry.toString()),
); );
assert.ok(tab); assert.ok(tab);
await vscode.commands.executeCommand('archify.showSource'); await vscode.commands.executeCommand('archify.openInTextEditor');
const editor = await waitFor('registry text editor', () => vscode.window.visibleTextEditors.find((e) => e.document.uri.toString() === registry.toString())); const editor = await waitFor('registry text editor', () => vscode.window.visibleTextEditors.find((e) => e.document.uri.toString() === registry.toString()));
assert.equal(editor.document.languageId, 'yaml'); assert.equal(editor.document.languageId, 'yaml');
}); });
@@ -459,4 +472,204 @@ export async function run(): Promise<void> {
const errors = vscode.languages.getDiagnostics(containers.uri).filter((d) => d.severity === vscode.DiagnosticSeverity.Error); const errors = vscode.languages.getDiagnostics(containers.uri).filter((d) => d.severity === vscode.DiagnosticSeverity.Error);
assert.deepEqual(errors.map((d) => d.message), []); assert.deepEqual(errors.map((d) => d.message), []);
}); });
await check('a registry is checked against its schema without a YAML extension', async () => {
const target = workspaceFile('model/registry/typo.archify-registry');
await vscode.workspace.fs.writeFile(target, new TextEncoder().encode('schema_version: 1\nelements:\n billing:\n typ: backend\n label: Billing\n'));
const doc = await vscode.workspace.openTextDocument(target);
await vscode.window.showTextDocument(doc);
const unknown = await waitFor('unknown key diagnostic', () =>
vscode.languages.getDiagnostics(doc.uri).find((d) => d.source === 'archify' && /Unknown key "typ" in elements\.billing/.test(d.message)),
);
assert.equal(doc.getText(unknown.range), 'typ');
assert.ok(vscode.languages.getDiagnostics(doc.uri).some((d) => /"type" is required in elements\.billing/.test(d.message)));
await vscode.commands.executeCommand('workbench.action.closeActiveEditor');
await vscode.workspace.fs.delete(target);
});
await check('without a shared model, sync stays unloaded and its commands are there', async () => {
const commands = await vscode.commands.getCommands(true);
for (const id of ['archify.sync.signIn', 'archify.sync.share', 'archify.sync.join']) assert.ok(commands.includes(id), `${id} is registered`);
// The extension host's module cache: dist/sync.js (Yjs, the WebSocket) is not loaded.
const loaded = Object.keys(require.cache).filter((file) => file.endsWith(`${path.sep}dist${path.sep}sync.js`));
assert.deepEqual(loaded, [], 'the sync bundle is not loaded');
});
await check('sync file bridge: local edits reach the document, teammates\' edits reach files and editors', async () => {
const root = workspaceFile('shared');
const file = (rel: string) => vscode.Uri.joinPath(root, ...rel.split('/'));
const write = (rel: string, text: string) => vscode.workspace.fs.writeFile(file(rel), new TextEncoder().encode(text));
const read = async (rel: string) => new TextDecoder().decode(await vscode.workspace.fs.readFile(file(rel)));
const exists = (rel: string) => Promise.resolve(vscode.workspace.fs.stat(file(rel))).then(() => true, () => false);
await write('main.archify', 'model:\n id: shared\n');
await write('0100-context/a.archify', 'schema_version: 1\r\nmeta:\r\n title: A\r\n');
await write('notes.txt', 'not a model file');
const doc = new Y.Doc();
const teammate = new Y.Doc();
// The server in between: every update reaches the other side.
doc.on('update', (u: Uint8Array, origin: unknown) => origin !== 'remote' && Y.applyUpdate(teammate, u, 'remote'));
teammate.on('update', (u: Uint8Array, origin: unknown) => origin !== 'remote' && Y.applyUpdate(doc, u, 'remote'));
const quiet = { info() {}, warn() {}, error() {}, debug() {}, trace() {} } as unknown as vscode.LogOutputChannel;
const bridge = new FileBridge(root, doc, { origin: 'local' }, quiet);
const theirs = () => teammate.getMap<Y.Text>('files');
try {
await bridge.pushAll(false);
bridge.start(true);
assert.deepEqual([...theirs().keys()].sort(), ['0100-context/a.archify', 'main.archify'], 'only model files are shared');
assert.equal(theirs().get('0100-context/a.archify')!.toString(), 'schema_version: 1\nmeta:\n title: A\n', 'line endings travel as \\n');
// A local edit in an open editor.
const main = await vscode.workspace.openTextDocument(file('main.archify'));
const edit = new vscode.WorkspaceEdit();
edit.insert(main.uri, new vscode.Position(2, 0), ' name: Shared\n');
assert.ok(await vscode.workspace.applyEdit(edit));
await waitFor('local edit at the teammate', () => theirs().get('main.archify')!.toString() === 'model:\n id: shared\n name: Shared\n');
await main.save();
// The teammate types twice in a row into the open file: both land, nothing is undone by an echo.
theirs().get('main.archify')!.insert(0, '# one\n');
theirs().get('main.archify')!.insert(0, '# two\n');
await waitFor('teammate edits in the open editor', () => main.getText() === '# two\n# one\nmodel:\n id: shared\n name: Shared\n');
await waitFor('saved, so git sees it', () => !main.isDirty);
await new Promise((r) => setTimeout(r, 500));
assert.equal(theirs().get('main.archify')!.toString(), main.getText(), 'no echo changed it back');
// The teammate edits a closed file, keeping its CRLF on disk.
const a = theirs().get('0100-context/a.archify')!;
a.insert(a.length, ' output: a.html\n');
const deadline = Date.now() + 10_000;
while ((await read('0100-context/a.archify')) !== 'schema_version: 1\r\nmeta:\r\n title: A\r\n output: a.html\r\n' && Date.now() < deadline) await new Promise((r) => setTimeout(r, 200));
assert.equal(await read('0100-context/a.archify'), 'schema_version: 1\r\nmeta:\r\n title: A\r\n output: a.html\r\n');
// A new file and a deletion from the teammate.
teammate.transact(() => {
const t = new Y.Text();
t.insert(0, 'schema_version: 1\n');
theirs().set('registry/people.archify-registry', t);
theirs().set('../escape.archify', new Y.Text('nope'));
});
const until = async (what: string, probe: () => Promise<boolean>) => {
const end = Date.now() + 10_000;
while (!(await probe())) {
if (Date.now() > end) throw new Error(`Timed out waiting for ${what}`);
await new Promise((r) => setTimeout(r, 200));
}
};
await until('new file on disk', () => exists('registry/people.archify-registry'));
assert.ok(!(await exists('../escape.archify')), 'a path outside the model is never written');
teammate.transact(() => theirs().delete('0100-context/a.archify'));
await until('deleted file gone', async () => !(await exists('0100-context/a.archify')));
// A change on disk by another tool (git, an agent) to a closed file.
await write('registry/people.archify-registry', 'schema_version: 1\nelements: {}\n');
await waitFor('disk change at the teammate', () => theirs().get('registry/people.archify-registry')?.toString() === 'schema_version: 1\nelements: {}\n');
} finally {
bridge.dispose();
await vscode.commands.executeCommand('workbench.action.closeAllEditors');
await vscode.workspace.fs.delete(root, { recursive: true });
}
});
// Opt-in: a running Archify Sync server, a space on it and an access token.
const syncServer = process.env.ARCHIFY_SYNC_TEST_URL;
if (syncServer) await check('two shared copies of a model stay the same through the sync server', async () => {
const space = process.env.ARCHIFY_SYNC_TEST_SPACE!;
const token = process.env.ARCHIFY_SYNC_TEST_TOKEN!;
const storage = workspaceFile('.sync-storage');
const auth = {
session: async () => ({ account: { id: 'it', display_name: 'Integration' } }),
accessToken: async () => token,
} as unknown as SyncAuth;
const quiet = { info() {}, warn() {}, error() {}, debug() {}, trace() {} } as unknown as vscode.LogOutputChannel;
const services = (dir: string) => ({ context: { globalStorageUri: vscode.Uri.joinPath(storage, dir) } as vscode.ExtensionContext, auth, log: quiet, onChange() {} });
const link = { server: syncServer, space, name: 'IT' };
const mine = workspaceFile('live-mine');
const theirs = workspaceFile('live-theirs');
const read = async (root: vscode.Uri, rel: string) => {
try {
return new TextDecoder().decode(await vscode.workspace.fs.readFile(vscode.Uri.joinPath(root, ...rel.split('/'))));
} catch {
return undefined;
}
};
const until = async (what: string, probe: () => Promise<boolean>) => {
const end = Date.now() + 15_000;
while (!(await probe())) {
if (Date.now() > end) throw new Error(`Timed out waiting for ${what}`);
await new Promise((r) => setTimeout(r, 200));
}
};
await vscode.workspace.fs.writeFile(vscode.Uri.joinPath(mine, 'main.archify'), new TextEncoder().encode('model:\n id: it\n'));
await vscode.workspace.fs.writeFile(vscode.Uri.joinPath(mine, 'registry', 'people.archify-registry'), new TextEncoder().encode('schema_version: 1\n'));
await vscode.workspace.fs.createDirectory(theirs);
const a = new LiveSpace(mine, link, 'share', services('a'));
let b: LiveSpace | undefined;
try {
await a.start();
await until('shared copy online', async () => a.state === 'online');
b = new LiveSpace(theirs, link, 'join', services('b'));
await b.start();
await until('joined copy gets the files', async () => (await read(theirs, 'main.archify')) === 'model:\n id: it\n' && (await read(theirs, 'registry/people.archify-registry')) === 'schema_version: 1\n');
// Typing in one copy's editor shows up in the other copy's file.
const doc = await vscode.workspace.openTextDocument(vscode.Uri.joinPath(mine, 'main.archify'));
const edit = new vscode.WorkspaceEdit();
edit.insert(doc.uri, new vscode.Position(2, 0), ' name: Live 🚀\n');
assert.ok(await vscode.workspace.applyEdit(edit));
await until('edit arrives in the other copy', async () => (await read(theirs, 'main.archify')) === 'model:\n id: it\n name: Live 🚀\n');
// A file written by another tool in the other copy comes back.
await vscode.workspace.fs.writeFile(vscode.Uri.joinPath(theirs, '0100-context', 'c.archify'), new TextEncoder().encode('schema_version: 1\n'));
await until('new file arrives back', async () => (await read(mine, '0100-context/c.archify')) === 'schema_version: 1\n');
await until('presence shows one person in both', async () => a.people().length === 1 && b!.people().length === 1);
// A cursor in one copy shows in the other, and stays on its word while text is typed above it.
const at = 'model:\n id: it\n name: '.length;
assert.ok(a.setCursor(vscode.Uri.joinPath(mine, 'main.archify'), { anchor: at, head: at + 4 }));
const theirsMain = vscode.Uri.joinPath(theirs, 'main.archify');
await until('cursor arrives in the other copy', async () => b!.cursors(theirsMain).length === 1);
const cursor = b.cursors(theirsMain)[0];
assert.deepEqual([cursor.name, cursor.anchor, cursor.head], ['Integration', at, at + 4]);
assert.equal(a.cursors(vscode.Uri.joinPath(mine, 'main.archify')).length, 0, 'your own cursor is not drawn for you');
const above = new vscode.WorkspaceEdit();
above.insert(theirsMain, new vscode.Position(0, 0), '# top\n');
assert.ok(await vscode.workspace.applyEdit(above));
await until('cursor moves with the text', async () => b!.cursors(theirsMain)[0]?.anchor === at + '# top\n'.length);
a.setCursor(vscode.Uri.joinPath(mine, 'main.archify'), undefined);
await until('cursor goes away', async () => b!.cursors(theirsMain).length === 0);
} finally {
a.dispose();
b?.dispose();
await vscode.commands.executeCommand('workbench.action.revertAndCloseActiveEditor');
for (const uri of [mine, theirs, storage]) await vscode.workspace.fs.delete(uri, { recursive: true }).then(undefined, () => undefined);
}
});
await check('registry and decision pages own their document: edits make it dirty and VS Code undo reverts them', async () => {
for (const [file, viewType] of [
['model/registry/containers.archify-registry', 'archify.registry'],
['model/decisions/0001-postgres-as-source-of-truth.archify-decision', 'archify.decision'],
] as const) {
const uri = workspaceFile(file);
await vscode.commands.executeCommand('vscode.openWith', uri, viewType);
await waitFor(`${viewType} tab`, () =>
vscode.window.tabGroups.activeTabGroup.activeTab?.input instanceof vscode.TabInputCustom &&
(vscode.window.tabGroups.activeTabGroup.activeTab.input as vscode.TabInputCustom).uri.toString() === uri.toString(),
);
const doc = await vscode.workspace.openTextDocument(uri);
const before = doc.getText();
// What the Source view does with a keystroke: a WorkspaceEdit on the document.
const edit = new vscode.WorkspaceEdit();
edit.insert(uri, new vscode.Position(0, 0), '# edited in Source\n');
assert.ok(await vscode.workspace.applyEdit(edit));
assert.ok(doc.isDirty, `${file} is dirty`);
const tab = vscode.window.tabGroups.activeTabGroup.activeTab;
assert.ok(tab?.isDirty, 'the page tab shows the dirty dot');
// ⌘Z in the page reaches VS Code as the undo command.
await vscode.commands.executeCommand('undo');
await waitFor('undo', () => doc.getText() === before);
await vscode.commands.executeCommand('workbench.action.revertAndCloseActiveEditor');
}
});
} }
+7
View File
@@ -141,3 +141,10 @@ test('summaries and groups: root first, then folders', () => {
assert.deepEqual(groups.map((g) => g.group), ['', '0100-context', '0300-components']); assert.deepEqual(groups.map((g) => g.group), ['', '0100-context', '0300-components']);
assert.deepEqual(groups[0].diagrams.map((d) => d.relativePath), ['broken.archify', 'checkout.archify']); assert.deepEqual(groups[0].diagrams.map((d) => d.relativePath), ['broken.archify', 'checkout.archify']);
}); });
test('a registry YAML error is reported at its line, not the first', () => {
const { problems } = parseRegistry('schema_version: 1\nelements:\n api:\n type: backend\n sub\n label: API\n', 'r.archify-registry');
const yaml = problems.find((p) => /not valid YAML/.test(p.message));
assert.ok(yaml, 'a YAML problem');
assert.ok((yaml.line ?? 0) >= 3, `reported on line ${(yaml.line ?? 0) + 1}`);
});
+27 -1
View File
@@ -1,6 +1,6 @@
import assert from 'node:assert/strict'; import assert from 'node:assert/strict';
import { test } from 'node:test'; import { test } from 'node:test';
import { prepareDiagramHtml } from '../src/webview/page'; import { decisionPage, messagePage, prepareDiagramHtml, registryPage } from '../src/webview/page';
const page = `<!DOCTYPE html><html><head> const page = `<!DOCTYPE html><html><head>
<meta http-equiv="Content-Security-Policy" content="default-src *"> <meta http-equiv="Content-Security-Policy" content="default-src *">
@@ -61,3 +61,29 @@ test('saved view state is merged, not replaced, when the hash changes', () => {
const html = prepareDiagramHtml(page, { cspSource: 'x', nonce: 'n', theme: 'dark', state: { uri: 'file:///a.archify' } }); const html = prepareDiagramHtml(page, { cspSource: 'x', nonce: 'n', theme: 'dark', state: { uri: 'file:///a.archify' } });
assert.match(html, /vscode\.setState\(Object\.assign\(\{\}, vscode\.getState\(\) \|\| \{\}, config\.state, \{ hash: location\.hash \}\)\)/); assert.match(html, /vscode\.setState\(Object\.assign\(\{\}, vscode\.getState\(\) \|\| \{\}, config\.state, \{ hash: location\.hash \}\)\)/);
}); });
test('a page with Source carries its script and the name of its own view', () => {
const html = prepareDiagramHtml(page, {
cspSource: 'x',
nonce: 'n',
theme: 'dark',
graphSwitch: { left: 'Diagram', query: 'diagram:a.archify' },
source: { scriptUri: 'https://file+.vscode-resource/ext/dist/source.js', left: 'Diagram' },
});
assert.match(html, /"source":\{"scriptUri":"https:\/\/file\+\.vscode-resource\/ext\/dist\/source\.js","left":"Diagram"\}/);
// Loaded on first use, not with the page.
assert.ok(!/<script[^>]+source\.js/.test(html));
assert.match(html, /post\(\{ type: 'sourceReady' \}\)/);
});
test('registry, decision and message pages offer View | Source when given the script', () => {
const source = { scriptUri: 'https://x/dist/source.js', left: 'View' as const };
const registry = registryPage({ cspSource: 'x', nonce: 'n', source }, { file: 'r.archify-registry', inModel: false, problems: [], elements: [] } as never);
const decision = decisionPage({ cspSource: 'x', nonce: 'n', source }, { file: 'd.archify-decision', inModel: false, problems: [], supersededBy: [] } as never);
const message = messagePage({ cspSource: 'x', nonce: 'n', source: { ...source, left: 'Diagram' } }, 'Archify could not render this diagram', 'Fix it');
for (const html of [registry, decision, message]) {
assert.match(html, /"source":\{"scriptUri":"https:\/\/x\/dist\/source\.js"/);
assert.match(html, /\.archify-mode-seg/, 'switch styles');
}
assert.ok(!messagePage({ cspSource: 'x', nonce: 'n' }, 'Rendering…', '').includes('"source"'), 'no Source without the option');
});
+77
View File
@@ -0,0 +1,77 @@
import assert from 'node:assert/strict';
import fs from 'node:fs';
import path from 'node:path';
import { test } from 'node:test';
import { DIAGRAM_SCHEMA, REGISTRY_SCHEMA, SchemaChecker, readSchemas, readablePointer } from '../src/language/schemaCheck';
const root = path.resolve(__dirname, '..', '..');
const checker = new SchemaChecker(readSchemas(path.join(root, 'schemas')));
function walk(dir: string, out: string[] = []): string[] {
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
const full = path.join(dir, entry.name);
if (entry.isDirectory()) walk(full, out);
else if (/\.archify(-registry)?$/.test(entry.name)) out.push(full);
}
return out;
}
const schemaFor = (file: string) => (file.endsWith('-registry') ? REGISTRY_SCHEMA : DIAGRAM_SCHEMA);
test('every shipped .archify and registry file passes the schema check', () => {
const files = ['examples', 'templates', path.join('test', 'fixtures')].flatMap((dir) => walk(path.join(root, dir)));
assert.ok(files.length > 30, `found ${files.length} files`);
for (const file of files) {
const problems = checker.check(fs.readFileSync(file, 'utf8'), schemaFor(file));
assert.deepEqual(problems.map((p) => p.message), [], path.relative(root, file));
}
});
function problemsAfter(file: string, from: string, to: string) {
const original = fs.readFileSync(path.join(root, file), 'utf8');
assert.ok(original.includes(from), `${file} contains ${from}`);
const text = original.replace(from, to);
return checker.check(text, schemaFor(file)).map((p) => ({ ...p, text: text.slice(p.from, p.to) }));
}
const DIAGRAM = 'templates/models/c4-standard-web-app/0200-containers/web-app.archify';
const REGISTRY = 'templates/models/c4-standard-web-app/registry/containers.archify-registry';
test('an unknown key is placed on the key', () => {
const [problem, ...rest] = problemsAfter(DIAGRAM, 'label: SQL', 'lable: SQL');
assert.equal(rest.length, 0);
assert.equal(problem.text, 'lable');
assert.match(problem.message, /^Unknown key "lable" in connections\[\d+\]\.$/);
});
test('a point with one number is placed on the whole flow list', () => {
const problems = problemsAfter(DIAGRAM, 'pos: [690, 160]', 'pos: [690]');
assert.equal(problems.length, 1);
assert.equal(problems[0].text, '[690]');
assert.match(problems[0].message, /pos needs at least 2 items\.$/);
});
test('registry: a misspelt type key, a bad type, a bad id', () => {
const typo = problemsAfter(REGISTRY, ' type: database', ' typ: database');
assert.deepEqual(typo.map((p) => p.text).sort(), ['db', 'typ']);
assert.ok(typo.some((p) => p.text === 'typ' && /Unknown key "typ"/.test(p.message)));
assert.ok(typo.some((p) => p.text === 'db' && /"type" is required in elements\.db/.test(p.message)));
const bad = problemsAfter(REGISTRY, ' type: cloud', ' type: bucket');
assert.equal(bad.length, 1);
assert.equal(bad[0].text, 'bucket');
assert.match(bad[0].message, /must be one of: frontend, backend, database, cloud, security, messagebus, external\.$/);
});
test('a YAML syntax error is reported once, as YAML', () => {
const problems = problemsAfter(REGISTRY, 'label: API', 'label: [API');
assert.equal(problems.length, 1);
assert.equal(problems[0].kind, 'yaml');
assert.match(problems[0].message, /^YAML: /);
});
test('pointers read like paths', () => {
assert.equal(readablePointer('/connections/4/label'), 'connections[4].label');
assert.equal(readablePointer('/elements/db'), 'elements.db');
assert.equal(readablePointer(''), 'the file');
});
+101
View File
@@ -0,0 +1,101 @@
import assert from 'node:assert/strict';
import * as fs from 'node:fs';
import * as os from 'node:os';
import * as path from 'node:path';
import { test } from 'node:test';
import * as Y from 'yjs';
import { checkServerUrl, parseInviteLink, syncSocketUrl } from '../src/sync/api';
import { OfflineStore } from '../src/sync/offlineStore';
import { formatLink, parseLink } from '../src/sync/protocol';
import { applyToYText, safeChange } from '../src/sync/textSync';
import { applyChanges } from '../src/util/textDiff';
test('safeChange never splits a surrogate pair', () => {
const cases: [string, string][] = [
['x😀y', 'x😃y'],
['😀', '😃'],
['a😀', 'a😀b'],
['😀b', 'a😀b'],
['label: 🚀 API', 'label: 🛰 API'],
['plain', 'plainer'],
];
for (const [before, after] of cases) {
const change = safeChange(before, after)!;
assert.equal(applyChanges(before, [change]), after, `${before} → ${after}`);
for (const at of [change.from, change.to]) {
const code = before.charCodeAt(at);
assert.ok(!(code >= 0xdc00 && code <= 0xdfff), `change edge ${at} lands inside a pair in ${before}`);
}
}
assert.equal(safeChange('same', 'same'), undefined);
});
test('applyToYText reaches the text and syncs between copies', () => {
const a = new Y.Doc();
const b = new Y.Doc();
a.on('update', (u: Uint8Array) => Y.applyUpdate(b, u));
const text = a.getMap<Y.Text>('files');
const t = new Y.Text();
text.set('main.archify', t);
applyToYText(t, 'model:\n id: shop\n');
applyToYText(t, '# 😀\nmodel:\n id: shop\n');
applyToYText(t, '# 😃\nmodel:\n id: shop2\n');
assert.equal(b.getMap<Y.Text>('files').get('main.archify')!.toString(), '# 😃\nmodel:\n id: shop2\n');
assert.equal(applyToYText(t, '# 😃\nmodel:\n id: shop2\n'), false);
});
test('the offline copy keeps every update and survives a torn write', () => {
const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'archify-sync-'));
try {
const doc = new Y.Doc();
const store = new OfflineStore(dir, 'space');
assert.equal(store.exists(), false);
doc.on('update', (u: Uint8Array) => store.append(u));
doc.getText('t').insert(0, 'one ');
doc.getText('t').insert(4, 'two');
assert.equal(store.pending, 2);
// A crash in the middle of the next append.
fs.appendFileSync(path.join(dir, 'space.log'), Buffer.from([200, 0, 0, 0, 1, 2]));
const again = new Y.Doc();
for (const u of new OfflineStore(dir, 'space').load()) Y.applyUpdate(again, u);
assert.equal(again.getText('t').toString(), 'one two');
store.compact(Y.encodeStateAsUpdate(doc));
assert.equal(store.pending, 0);
const compacted = new Y.Doc();
for (const u of new OfflineStore(dir, 'space').load()) Y.applyUpdate(compacted, u);
assert.equal(compacted.getText('t').toString(), 'one two');
store.remove();
assert.equal(store.exists(), false);
} finally {
fs.rmSync(dir, { recursive: true, force: true });
}
});
test('server addresses: https, or http only on this machine', () => {
assert.equal(checkServerUrl('https://archify.example.com/').url, 'https://archify.example.com');
assert.equal(checkServerUrl('http://localhost:8080').url, 'http://localhost:8080');
assert.equal(checkServerUrl('http://127.0.0.1:8080/sync/').url, 'http://127.0.0.1:8080/sync');
assert.ok(checkServerUrl('http://archify.example.com').problem);
assert.ok(checkServerUrl('ftp://x').problem);
assert.ok(checkServerUrl('nonsense').problem);
assert.equal(syncSocketUrl('https://a.example', 'id'), 'wss://a.example/v1/spaces/id/sync?v=1');
});
test('invite links in both forms', () => {
const token = 'AbCdEfGhIjKlMnOpQrStUvWxYz0123456789_-abcde';
assert.deepEqual(parseInviteLink(`https://sync.example/join/${token}`), { server: 'https://sync.example', invite: token });
assert.deepEqual(parseInviteLink(`https://example.com/archify/join/${token}`), { server: 'https://example.com/archify', invite: token });
const ext = `vscode://root-at-skic.archify-vscode-ext/join?server=${encodeURIComponent('https://sync.example/')}&invite=${token}`;
assert.deepEqual(parseInviteLink(ext), { server: 'https://sync.example', invite: token });
assert.equal(parseInviteLink('https://example.com/other'), undefined);
assert.equal(parseInviteLink('not a link'), undefined);
});
test('link files round-trip and refuse junk', () => {
const link = { server: 'https://sync.example', space: '0198f3a2-1b2c-7d3e-8f40-123456789abc', name: 'Shop' };
assert.deepEqual(parseLink(formatLink(link)), link);
assert.equal(parseLink('{"server":"https://x","space":"../../etc"}'), undefined);
assert.equal(parseLink('not json'), undefined);
});
+41
View File
@@ -0,0 +1,41 @@
import assert from 'node:assert/strict';
import { test } from 'node:test';
import { applyChanges, minimalChange, normalizeEol, offsetOf, positionOf } from '../src/util/textDiff';
test('minimalChange keeps the common start and end', () => {
assert.equal(minimalChange('abc', 'abc'), undefined);
assert.deepEqual(minimalChange('label: SQL', 'lable: SQL'), { from: 3, to: 5, insert: 'le' });
assert.deepEqual(minimalChange('a\nb\n', 'a\nx\nb\n'), { from: 2, to: 2, insert: 'x\n' });
assert.deepEqual(minimalChange('aaa', 'aa'), { from: 2, to: 3, insert: '' });
assert.deepEqual(minimalChange('', 'new'), { from: 0, to: 0, insert: 'new' });
});
test('minimalChange round-trips through applyChanges', () => {
const pairs = [['schema_version: 1\nmeta:\n title: A\n', 'schema_version: 1\nmeta:\n title: B\n output: b.html\n'], ['x', ''], ['', 'y'], ['abab', 'ab']];
for (const [before, after] of pairs) {
const change = minimalChange(before, after)!;
assert.equal(applyChanges(before, [change]), after);
}
});
test('applyChanges takes several changes in the coordinates of the original text', () => {
assert.equal(applyChanges('one two three', [{ from: 0, to: 3, insert: '1' }, { from: 8, to: 13, insert: '3' }]), '1 two 3');
});
test('positions and offsets in "\\n" text', () => {
const text = 'ab\ncde\n\nf';
assert.deepEqual(positionOf(text, 0), { line: 0, character: 0 });
assert.deepEqual(positionOf(text, 4), { line: 1, character: 1 });
assert.deepEqual(positionOf(text, 7), { line: 2, character: 0 });
assert.deepEqual(positionOf(text, 99), { line: 3, character: 1 });
for (let offset = 0; offset <= text.length; offset++) {
const { line, character } = positionOf(text, offset);
assert.equal(offsetOf(text, line, character), offset);
}
assert.equal(offsetOf(text, 0, 50), 2, 'clamped to the end of the line');
assert.equal(offsetOf(text, 9, 0), text.length);
});
test('normalizeEol', () => {
assert.equal(normalizeEol('a\r\nb\nc\r\n'), 'a\nb\nc\n');
});